ProJob - Get a single operation
API Url
Use it for returning a specific operation for an order.
http://localhost:16010/ProMarkREST/rest/ProJob/orders/{order_id}/operations/{operation_id}
Permissions: user
Request headers
| Field | Type | Description |
|---|---|---|
Accept-Languageoptional | String | =en-GB Language use for localization. |
X-Clientoptional | String | =Client type. "Portal""Mobile""Admin" |
X-Roleoptional | Number | ProMark role (1: Employee, 2: User). {12} |
X-WebPart-Idoptional | Number | Unique web-part identifier. |
Path parameters
| Field | Type | Description |
|---|---|---|
| operation_id | String | The id of the operation. |
| order_id | String | The id of the order. |
Success 200
| Field | Type | Description |
|---|---|---|
| barcode | String | Operation barcode. |
| plantId | String | Plant Id. |
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| operations | Object[] | Collection of operations. |
| departmentDescription | String | Department description. |
| departmentId | String | Department id. |
| description | String | The description of the operation. |
| id | String | The id of the operation. |
| jobType | Number | The type of the operation 012 |
| plannedEnd | Datetime | Planned end date and time. |
| plannedStart | Datetime | Planned start date and time. |
| regProfileDescription | String | Registration profile description. |
| regProfileId | String | Registration profile id. |
| responsibleUser | String | Responsible user. |
| sequence | String | The Operation sequence number. |
| workcenterDescription | String | Workcenter description. |
| workcenterId | String | Primary id of workcenter. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
HTTP/1.1 200 OK{"response": {"data": {"operations": [{"id": "JSW1","description": "description1","sequence ": "1","regProfileId": "JSW","regProfileDescription": "Jon Snow","workcenterId": "JSW","plannedStart": "2012-10-08T00:00:00.000","plannedEnd": "2012-10-13T00:00:00.000","departmentId": "JSW1","departmentDescription": "Jon 1","jobType": 1,"responsibleUser ": "JSW","barcode": "1"}]},"errorCode": 0,"errorMessage": ""}}
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data (empty). |
| errorCode | Number | Error code. |
| errorMessage | String | Error description. |
Error example:
HTTP/1.1 404 Not found{"response": {"data": {},"errorCode": 79,"errorMessage": "Operation CF89P1 not found"}}