ProJob - Get a single operation

API Url

Use it for returning a specific operation for an order.

GET
http://localhost:16010/ProMarkREST/rest/ProJob/orders/{order_id}/operations/{operation_id}

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Path parameters

FieldTypeDescription
operation_idString

The id of the operation.

order_idString

The id of the order.

Success 200

FieldTypeDescription
      barcodeString

Operation barcode.

      plantIdString

Plant Id.

responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    operationsObject[]

Collection of operations.

      departmentDescriptionString

Department description.

      departmentIdString

Department id.

      descriptionString

The description of the operation.

      idString

The id of the operation.

      jobTypeNumber

The type of the operation 0 : Express operation 1 : Standard production 2 : IPO (Indirect Production)

Allowed values:012
      plannedEndDatetime

Planned end date and time.

      plannedStartDatetime

Planned start date and time.

      regProfileDescriptionString

Registration profile description.

      regProfileIdString

Registration profile id.

      responsibleUserString

Responsible user.

      sequenceString

The Operation sequence number.

      workcenterDescriptionString

Workcenter description.

      workcenterIdString

Primary id of workcenter.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"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

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example:

HTTP/1.1 404 Not found
{
"response": {
"data": {},
"errorCode": 79,
"errorMessage": "Operation CF89P1 not found"
}
}