Documentation Powered by ReDoc

work-order-service (4.0)

Download OpenAPI specification:Download

A service for the creation and management of work orders.

Authentication

Implicit

Security Scheme Type OAuth2
implicit OAuth Flow
Authorization URL:
Scopes:
  • mes.workorders.execute -

    Permission to execute work orders

  • mes.workorders.skip -

    Permission to skip operations on work orders

  • mes.workorders.create -

    Permission to create work orders

  • mes.workorders.updatelotidentifier -

    Permission to update lot identifiers

  • mes.workorders.update -

    Permission to update work orders

  • mes.workorders.cancel -

    Permission to cancel work orders

  • mes.workorders.clockoffoperator -

    Permission to clock off other operators

  • mes.workorders.editsegments -

    Permission to update segments on work orders

  • mes.workorders.addmateriallot -

    Permission to add lots to work orders

  • mes.workorders.cancelnotstartedmateriallot -

    Permission to cancel lots that are not started on work orders

  • mes.workorders.manuallycompleteworkorder -

    Permission to manually complete work orders

OnBehalfOf

Use in combination with OAuth2 client credentials to pass user context. Value should be set to a JWT user token with a prefix of 'Bearer '.

Security Scheme Type API Key
Header parameter name: On-Behalf-Of

Authorization_Code

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL:
Token URL:
Scopes:
  • mes.workorders.execute -

    Permission to execute work orders

  • mes.workorders.skip -

    Permission to skip operations on work orders

  • mes.workorders.create -

    Permission to create work orders

  • mes.workorders.updatelotidentifier -

    Permission to update lot identifiers

  • mes.workorders.update -

    Permission to update work orders

  • mes.workorders.cancel -

    Permission to cancel work orders

  • mes.workorders.clockoffoperator -

    Permission to clock off other operators

  • mes.workorders.editsegments -

    Permission to update segments on work orders

  • mes.workorders.addmateriallot -

    Permission to add lots to work orders

  • mes.workorders.cancelnotstartedmateriallot -

    Permission to cancel lots that are not started on work orders

  • mes.workorders.manuallycompleteworkorder -

    Permission to manually complete work orders

Client_Credentials

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL:
Scopes:
  • mes.workorders.execute -

    Permission to execute work orders

  • mes.workorders.skip -

    Permission to skip operations on work orders

  • mes.workorders.create -

    Permission to create work orders

  • mes.workorders.updatelotidentifier -

    Permission to update lot identifiers

  • mes.workorders.update -

    Permission to update work orders

  • mes.workorders.cancel -

    Permission to cancel work orders

  • mes.workorders.clockoffoperator -

    Permission to clock off other operators

  • mes.workorders.editsegments -

    Permission to update segments on work orders

  • mes.workorders.addmateriallot -

    Permission to add lots to work orders

  • mes.workorders.cancelnotstartedmateriallot -

    Permission to cancel lots that are not started on work orders

  • mes.workorders.manuallycompleteworkorder -

    Permission to manually complete work orders

Resource_Owner_Password_Credentials

Security Scheme Type OAuth2
password OAuth Flow
Token URL:
Scopes:
  • mes.workorders.execute -

    Permission to execute work orders

  • mes.workorders.skip -

    Permission to skip operations on work orders

  • mes.workorders.create -

    Permission to create work orders

  • mes.workorders.updatelotidentifier -

    Permission to update lot identifiers

  • mes.workorders.update -

    Permission to update work orders

  • mes.workorders.cancel -

    Permission to cancel work orders

  • mes.workorders.clockoffoperator -

    Permission to clock off other operators

  • mes.workorders.editsegments -

    Permission to update segments on work orders

  • mes.workorders.addmateriallot -

    Permission to add lots to work orders

  • mes.workorders.cancelnotstartedmateriallot -

    Permission to cancel lots that are not started on work orders

  • mes.workorders.manuallycompleteworkorder -

    Permission to manually complete work orders

ClockOnRecords

Get a work order's clock on records collection.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

query Parameters
page
integer <int32> [ 0 .. 2147483647 ]

Page number to return (0...N).

size
integer <int32> [ 1 .. 2147483647 ]

Number of resources to return per page.

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "content": [
    ],
  • "page": {
    }
}

Get a clock on record.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

clockOnRecordId
required
integer <int64>

Id of the clock on record resource

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "id": 0,
  • "segmentActualId": 0,
  • "operator": "string",
  • "laborTypeId": 0,
  • "clockOnTime": "2019-08-24T14:15:22Z",
  • "clockOnBy": "string",
  • "clockOffTime": "2019-08-24T14:15:22Z",
  • "clockOffBy": "string"
}

CompleteQuantityRecords

Get a work order's complete quantity records collection.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

query Parameters
page
integer <int32> [ 0 .. 2147483647 ]

Page number to return (0...N).

size
integer <int32> [ 1 .. 2147483647 ]

Number of resources to return per page.

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "content": [
    ],
  • "page": {
    }
}

Get a complete quantity record.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

completeQuantityRecordId
required
integer <int64>

Id of the complete quantity record resource

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "id": 0,
  • "segmentActualId": 0,
  • "quantity": 0,
  • "quantityCompletedBy": "string",
  • "quantityCompletedTime": "2019-08-24T14:15:22Z"
}

HoldRecords

Get a work order's hold records collection.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

query Parameters
page
integer <int32> [ 0 .. 2147483647 ]

Page number to return (0...N).

size
integer <int32> [ 1 .. 2147483647 ]

Number of resources to return per page.

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "content": [
    ],
  • "page": {
    }
}

Get a hold record.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

holdRecordId
required
integer <int64>

Id of the hold record resource

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "id": 0,
  • "materialLotActualIds": [
    ],
  • "segmentIds": [
    ],
  • "reasonDescription": "string",
  • "active": true,
  • "holdType": "Lot",
  • "holdCreatedBy": "string",
  • "holdCreatedTime": "2019-08-24T14:15:22Z",
  • "holdReleasedBy": "string",
  • "holdReleasedTime": "2019-08-24T14:15:22Z"
}

MaterialLotActuals

Get a work order's material lot actuals collection.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

query Parameters
parentMaterialLotActualId
integer <int64>

ID for the parent material lot actual as a filter.

page
integer <int32> [ 0 .. 2147483647 ]

Page number to return (0...N).

size
integer <int32> [ 1 .. 2147483647 ]

Number of resources to return per page.

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "content": [
    ],
  • "page": {
    }
}

Get a material lot actual.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

materialLotActualId
required
integer <int64>

Id of the material lot actual resource

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "id": 0,
  • "parentIds": [
    ],
  • "workOrderId": 0,
  • "lotIdentifier": "string",
  • "status": "string",
  • "onHold": true,
  • "plannedQuantity": 0,
  • "initialPlannedQuantity": 0,
  • "productionEventId": 0,
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "cancelledOn": "2019-08-24T14:15:22Z",
  • "cancelledBy": "string"
}

Operations

Get a page of the operations collection.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
query Parameters
clockedOnOperator
string

Currently clocked on operator as a filter.

materialLotActualId
integer <int64>

ID of the material lot actual as a filter.

lotIdentifier
string

Lot identifier (e.g. Serial Number) as a filter.

operationName
string

Name of the operation as a filter. Note that operation names are unique only within a segment definition and not across segment definitions.

plannedUnitId
Array of integers <int64>

ID for the planned unit as a filter. The results contain all operations that have the ID in the planned unit set. The planned unit set is specified in the segment definition. Multiple values are supported and the result contains all the operations matching any of the values.

plannedOrStartedOnUnitId
Array of integers <int64>

ID for the unit that the operation is executing on OR planned to execute on if the operation is not started as a filter. Multiple values are supported and the result contains all the operations matching any of the values.

producedMaterialId
Array of integers <int64>

ID for the material produced as a filter. The material produced is defined by the segments definition for the work order. Multiple values are supported and the result contains all the operations matching any of the values.

productionLineId
Array of integers <int64>

ID for the production line as a filter. Multiple values are supported and the result contains all the operations matching any of the values.

workOrderPriority
integer <int32>

Relative priority of the work order as a filter.

segmentId
integer <int64>

ID for the segment as a filter. Note that segment IDs are unique only within a segment definition and not across segment definitions.

segmentActualId
Array of integers <int64>

ID for the segment actual as a filter. Multiple values are supported and the results contain all operations matching any of the values.

startedOnUnitId
Array of integers <int64>

ID for the unit that the segment is executing on as a filter. Multiple values are supported and the result contains all the operations matching any of the values.

status
Array of strings
Items Enum: "NotReady" "Ready" "InProgress" "Complete" "Cancelled" "Skipped"

Status of the operation as a filter. Multiple values are supported and the results contain all operations matching any of the values.

completedAfter
string <date-time>

Filter results to return operations completed on or after this time. Combines with CompletedBefore to define a time range.

completedBefore
string <date-time>

Filter results to return operations completed on or before this time. Combines with CompletedAfter to define a time range.

workOrderId
integer <int64>

ID for the work order as a filter.

workOrderName
string

Name of the work order as a filter.

onHold
boolean

Whether the operation is currently on hold as a filter. If set to true, query will only return operations with active hold records

orderBy
string
Enum: "SegmentActualId" "MaterialLotActualId" "LotIdentifier" "OperationName" "ProducedMaterialId" "SegmentId" "StartedOnUnitId" "WorkOrderId" "WorkOrderName" "WorkOrderPriority" "ReadyOn" "StartedOn" "CompletedOn" "SegmentActualIdDescending" "MaterialLotActualIdDescending" "LotIdentifierDescending" "OperationNameDescending" "ProducedMaterialIdDescending" "SegmentIdDescending" "StartedOnUnitIdDescending" "WorkOrderIdDescending" "WorkOrderNameDescending" "WorkOrderPriorityDescending" "ReadyOnDescending" "StartedOnDescending" "CompletedOnDescending"

Name of the operation property to sort the results by.

page
integer <int32> [ 0 .. 2147483647 ]

Page number to return (0...N).

size
integer <int32> [ 1 .. 2147483647 ]

Number of resources to return per page.

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "content": [
    ],
  • "page": {
    }
}

SegmentActuals

Get a work order's segment actuals collection.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

query Parameters
page
integer <int32> [ 0 .. 2147483647 ]

Page number to return (0...N).

size
integer <int32> [ 1 .. 2147483647 ]

Number of resources to return per page.

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "content": [
    ],
  • "page": {
    }
}

Get a segment actual.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

segmentActualId
required
integer <int64>

Id of the segment actual resource

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "id": 0,
  • "segmentId": 0,
  • "materialLotActualId": 0,
  • "workOrderId": 0,
  • "status": "string",
  • "startedOnUnitId": 0,
  • "onHold": true,
  • "readyOn": "2019-08-24T14:15:22Z",
  • "startedOn": "2019-08-24T14:15:22Z",
  • "startedBy": "string",
  • "completedOn": "2019-08-24T14:15:22Z",
  • "completedBy": "string",
  • "productionEventId": 0,
  • "userDefinedEventId": 0
}

Segments

Get a work order's segments.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
null

Create or update a work order's segments.

Authorizations:
Authorization_Code (mes.workorders.editsegments) Client_Credentials (mes.workorders.editsegments) Resource_Owner_Password_Credentials (mes.workorders.editsegments) Implicit (mes.workorders.editsegments) OnBehalfOfClient_Credentials (mes.workorders.editsegments)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

header Parameters
if-Match
string

Expected segments resource ETag value

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Segments definition

any

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
null

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
null

Modify a running work order's segments.

Authorizations:
Authorization_Code (mes.workorders.editsegments) Client_Credentials (mes.workorders.editsegments) Resource_Owner_Password_Credentials (mes.workorders.editsegments) Implicit (mes.workorders.editsegments) OnBehalfOfClient_Credentials (mes.workorders.editsegments)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

header Parameters
if-Match
required
string

Expected segments resource ETag value

Request Body schema: application/vnd.ge.mes.patch+json; version=4.0

Segments definition patch

Array ()
value
any
path
string
op
string
from
string

Responses

Request samples

Content type
application/vnd.ge.mes.patch+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
null

SegmentsDefinitionEditor

Create a patch to add a rework operation.

Creates a JSON patch that can be applied to a segments definition to add a rework operation to a work order. The rework operation is a copy of an existing complete or in-progress operation with the following changes:

  • The billOfMaterials field is set to an empty array.
  • The name field is set to the specified operation name (an integer suffix will be appended if necessary to make the name unique on the work order).
  • The id field is set to the next unused ID.

The rework operation will be sequenced in parallel with the current ready or in-progress operation(s).

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Entry containing the details for the rework operation to be created

workOrderId
required
integer <int64>

The ID of the work order to rework.

materialLotActualIds
required
Array of integers <int64> [ 1 .. 50 ] items

The IDs of the material lot actuals to create a rework operation on.

segmentId
required
integer <int64>

The ID of the segment to base the rework operation on. The description, property values, planned unit IDs, and documents will be copied from this segment.

operationName
required
string [ 1 .. 100 ] characters

The name of the rework operation to create.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "workOrderId": 0,
  • "materialLotActualIds": [
    ],
  • "segmentId": 0,
  • "operationName": "string"
}

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "patch": [
    ],
  • "eTagValue": "string"
}

WorkOrderCommands

Start segments on a work order.

Authorizations:
Authorization_Code (mes.workorders.execute) Client_Credentials (mes.workorders.execute) Resource_Owner_Password_Credentials (mes.workorders.execute) Implicit (mes.workorders.execute) OnBehalfOfClient_Credentials (mes.workorders.execute)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Start command details

Array ()
segmentActualId
integer <int64>

The ID of the segment actual to start.

unitId
integer <int64>

The ID of the unit to start the segment on.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Clock on the authenticated operator to the specified segment actuals.

Authorizations:
Authorization_Code (mes.workorders.execute) Client_Credentials (mes.workorders.execute) Resource_Owner_Password_Credentials (mes.workorders.execute) Implicit (mes.workorders.execute) OnBehalfOfClient_Credentials (mes.workorders.execute)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Segment actuals and labor types to clock on

Array ()
segmentActualId
required
integer <int64> >= 1

The ID of the segment actual to clock on.

laborTypeId
required
integer <int64>

Labor Type to clock on for the segment actual.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Clock off the authenticated operator from the specified segment actuals.

Authorizations:
Authorization_Code (mes.workorders.execute) Client_Credentials (mes.workorders.execute) Resource_Owner_Password_Credentials (mes.workorders.execute) Implicit (mes.workorders.execute) OnBehalfOfClient_Credentials (mes.workorders.execute)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Ids of the segment actuals to clock off

Array ()
integer <int64>

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • 0
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Clock off the specified operator from the specified segment actuals.

Authorizations:
Authorization_Code (mes.workorders.clockoffoperator) Client_Credentials (mes.workorders.clockoffoperator) Resource_Owner_Password_Credentials (mes.workorders.clockoffoperator) Implicit (mes.workorders.clockoffoperator) OnBehalfOfClient_Credentials (mes.workorders.clockoffoperator)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Segment actuals and operators to clock off

Array ()
segmentActualId
required
integer <int64> >= 1

The ID of the segment actual to clock off.

operatorName
required
string

Operator to clock off of the segment actual. May not be used when mode is AllOperators.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Clock off all clocked on operators from the specified segment actuals.

Authorizations:
Authorization_Code (mes.workorders.clockoffoperator) Client_Credentials (mes.workorders.clockoffoperator) Resource_Owner_Password_Credentials (mes.workorders.clockoffoperator) Implicit (mes.workorders.clockoffoperator) OnBehalfOfClient_Credentials (mes.workorders.clockoffoperator)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Ids of the segment actuals to clock off all operators from

Array ()
integer <int64>

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • 0
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Complete quantity for work order segments

Authorizations:
Authorization_Code (mes.workorders.execute) Client_Credentials (mes.workorders.execute) Resource_Owner_Password_Credentials (mes.workorders.execute) Implicit (mes.workorders.execute) OnBehalfOfClient_Credentials (mes.workorders.execute)
path Parameters
workOrderId
required
integer <int64>

Work order containing segments to complete quantity on

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Specification of segments and quantities to complete

Array ()
segmentActualId
required
integer <int64> >= 1

The ID of the segment actual to clock on.

quantity
required
integer <int32> [ 1 .. 2147483647 ]

Quantity to record for the segment actual.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Complete segments on a work order.

Authorizations:
Authorization_Code (mes.workorders.execute) Client_Credentials (mes.workorders.execute) Resource_Owner_Password_Credentials (mes.workorders.execute) Implicit (mes.workorders.execute) OnBehalfOfClient_Credentials (mes.workorders.execute)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Ids of segments to complete

Array ()
integer <int64>

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • 0
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Skip segments on a work order.

Authorizations:
Authorization_Code (mes.workorders.skip) Client_Credentials (mes.workorders.skip) Resource_Owner_Password_Credentials (mes.workorders.skip) Implicit (mes.workorders.skip) OnBehalfOfClient_Credentials (mes.workorders.skip)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Ids of segment actuals to skip

Array ()
integer <int64>

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • 0
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Create a hold record on the specified material lot actuals and segments.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Hold command details

Array ()
materialLotActualIds
required
Array of integers <int64> [ 1 .. 50 ] items

The IDs of the material lot actuals to create hold records on.

holdType
required
string
Enum: "Lot" "Operation"

Type of hold. If the type is "Lot", the hold is for an entire material lot. If the type is "Operation", the hold is for specific operations.

segmentIds
Array of integers <int64> <= 50 items

The IDs of the segments to create hold records on. Must be null/empty for a "Lot" hold. Must not be null/empty for a "Operation" hold.

reasonDescription
string <= 150 characters

A description of the reason the hold record is being created.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Release the specified hold records.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Ids of the hold records to release

Array ()
integer <int64>

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • 0
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Scrap material lots on a work order.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Details of each material lot being scrapped

Array ()
materialLotActualId
integer <int64>

The ID of the material lot actual to be scrapped.

reasonLevel1Id
integer <int32>

Reason Level 1 Id. This is the 1st level reason used to categorize the waste. It is the Id of the corresponding reason which must already exist in Plant Apps.

reasonLevel2Id
integer <int32>

Reason Level 2 Id. This is the 2nd level reason used to categorize the waste. It is the Id of the corresponding reason which must already exist in Plant Apps.

reasonLevel3Id
integer <int32>

Reason Level 3 Id. This is the 3rd level reason used to categorize the waste. It is the Id of the corresponding reason which must already exist in Plant Apps.

reasonLevel4Id
integer <int32>

Reason Level 4 Id. This is the 4th level reason used to categorize the waste. It is the Id of the corresponding reason which must already exist in Plant Apps.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Cancel a work order.

Authorizations:
Authorization_Code (mes.workorders.cancel) Client_Credentials (mes.workorders.cancel) Resource_Owner_Password_Credentials (mes.workorders.cancel) Implicit (mes.workorders.cancel) OnBehalfOfClient_Credentials (mes.workorders.cancel)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Complete a work order.

Authorizations:
Authorization_Code (mes.workorders.manuallycompleteworkorder) Client_Credentials (mes.workorders.manuallycompleteworkorder) Resource_Owner_Password_Credentials (mes.workorders.manuallycompleteworkorder) Implicit (mes.workorders.manuallycompleteworkorder) OnBehalfOfClient_Credentials (mes.workorders.manuallycompleteworkorder)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "id": 0,
  • "name": "string",
  • "routeDefinitionId": 0,
  • "productionLineId": 0,
  • "producedMaterialId": 0,
  • "processOrderId": 0,
  • "plannedQuantity": 0,
  • "priority": 0,
  • "plannedStartDate": "2019-08-24T14:15:22Z",
  • "plannedEndDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "readyOn": "2019-08-24T14:15:22Z",
  • "startedOn": "2019-08-24T14:15:22Z",
  • "completedOn": "2019-08-24T14:15:22Z",
  • "completedBy": "string",
  • "cancelledOn": "2019-08-24T14:15:22Z",
  • "lastModifiedOn": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "eTagValue": "string"
}

Update the material lot identifiers for a work order.

Authorizations:
Authorization_Code (mes.workorders.updatelotidentifier) Client_Credentials (mes.workorders.updatelotidentifier) Resource_Owner_Password_Credentials (mes.workorders.updatelotidentifier) Implicit (mes.workorders.updatelotidentifier) OnBehalfOfClient_Credentials (mes.workorders.updatelotidentifier)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Update lot identifiers command details

Array ()
materialLotActualId
integer <int64>

The ID of the material lot actual to update.

lotIdentifier
string

The new lot identifier.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Update the material lot planned quantity for a work order.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Update lot planned quantity command details

Array ()
materialLotActualId
required
integer <int64>

The ID of the material lot actual to update.

plannedQuantity
required
integer <int32> [ 1 .. 2147483647 ]

The updated planned quantity to produce with this material lot.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Split material lots on a work order.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Split lot command details

Array ()
materialLotActualId
required
integer <int64>

ID of the material lot actual to be split

newLotIdentifier
string [ 0 .. 100 ] characters

Optional new lot identifier name for the material lot being split. This allows using the existing lot identifier for one of the child lots. Set to null to keep existing lot identifier on the parent.

required
Array of objects (SplitLotChildLotEntry) non-empty

Child material lot details

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Add material lots to a work order.

Authorizations:
Authorization_Code (mes.workorders.addmateriallot) Client_Credentials (mes.workorders.addmateriallot) Resource_Owner_Password_Credentials (mes.workorders.addmateriallot) Implicit (mes.workorders.addmateriallot) OnBehalfOfClient_Credentials (mes.workorders.addmateriallot)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Add lot command details

Array ()
lotIdentifier
required
string

Identifier for this material lot

plannedQuantity
required
integer <int32> [ 1 .. 2147483647 ]

The planned quantity to produce with this material lot.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

Cancel material lots on a work order.

Authorizations:
Authorization_Code (mes.workorders.cancelnotstartedmateriallot) Client_Credentials (mes.workorders.cancelnotstartedmateriallot) Resource_Owner_Password_Credentials (mes.workorders.cancelnotstartedmateriallot) Implicit (mes.workorders.cancelnotstartedmateriallot) OnBehalfOfClient_Credentials (mes.workorders.cancelnotstartedmateriallot)
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Ids of material lot actuals to cancel

Array ()
integer <int64>

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • 0
]

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
[
  • {
    }
]

WorkOrders

Create a work order.

Authorizations:
Authorization_Code (mes.workorders.create) Client_Credentials (mes.workorders.create) Resource_Owner_Password_Credentials (mes.workorders.create) Implicit (mes.workorders.create) OnBehalfOfClient_Credentials (mes.workorders.create)
Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Details on the work order to create.

Array of objects (MaterialLotEntry)

Material lots to produce with this work order.

name
required
string <= 50 characters

Work Order name.

producedMaterialId
required
integer <int64>

Work order produced material ID.

productionLineId
integer <int64>

Work order production line ID.

routeDefinitionId
integer <int64>

Refers to the route used to execute the work order.

plannedQuantity
integer <int32> [ 0 .. 2147483647 ]

The planned quantity to produce with this work order.

priority
integer <int32> [ 0 .. 2147483647 ]

Relative priority of the work order.

plannedStartDate
string <date-time>

Planned start date for the work order.

plannedEndDate
string <date-time>

Planned end date for the work order.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "materialLots": [
    ],
  • "name": "string",
  • "producedMaterialId": 0,
  • "productionLineId": 0,
  • "routeDefinitionId": 0,
  • "plannedQuantity": 0,
  • "priority": 0,
  • "plannedStartDate": "2019-08-24T14:15:22Z",
  • "plannedEndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "id": 0,
  • "name": "string",
  • "routeDefinitionId": 0,
  • "productionLineId": 0,
  • "producedMaterialId": 0,
  • "processOrderId": 0,
  • "plannedQuantity": 0,
  • "priority": 0,
  • "plannedStartDate": "2019-08-24T14:15:22Z",
  • "plannedEndDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "readyOn": "2019-08-24T14:15:22Z",
  • "startedOn": "2019-08-24T14:15:22Z",
  • "completedOn": "2019-08-24T14:15:22Z",
  • "completedBy": "string",
  • "cancelledOn": "2019-08-24T14:15:22Z",
  • "lastModifiedOn": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "eTagValue": "string"
}

Get the work orders collection.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
query Parameters
productionLineId
Array of integers <int64>

Production line ID as a filter. Multiple values are supported and the result contains all the work orders matching any of the values

producedMaterialId
Array of integers <int64>

Produced material ID as a filter. Multiple values are supported and the result contains all the work orders matching any of the values

processOrderId
Array of integers <int64>

Process order ID as a filter. Multiple values are supported and the result contains all the work orders matching any of the values

name
string

Name of the work order as a filter.

status
Array of strings
Items Enum: "NotReady" "Ready" "InProgress" "Complete" "Cancelled"

Status of the work order as a filter. Multiple values are supported and the results contain all work orders matching any of the values.

priority
integer <int32>

Priority value as a filter.

completedAfter
string <date-time>

Filter results to return work orders completed on or after this time. Combines with CompletedBefore to define a time range.

completedBefore
string <date-time>

Filter results to return work orders completed on or before this time. Combines with CompletedAfter to define a time range.

producedLotIdentifier
Array of strings

Produced lot identifier as a filter. Multiple values are supported and the result contains all the work orders matching any of the values

orderBy
string
Enum: "Name" "PlannedStartDate" "Priority" "CompletedOn" "CompletedOnDescending"

Controls how the work order results are ordered.

page
integer <int32> [ 0 .. 2147483647 ]

Page number to return (0...N).

size
integer <int32> [ 1 .. 2147483647 ]

Number of resources to return per page.

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "content": [
    ],
  • "page": {
    }
}

Delete a work order.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

ID of the work order to delete.

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "error": {
    }
}

Get a work order.

Authorizations:
Authorization_CodeClient_CredentialsResource_Owner_Password_CredentialsImplicitOnBehalfOfClient_Credentials
path Parameters
workOrderId
required
integer <int64>

Id of the work order resource

Responses

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "id": 0,
  • "name": "string",
  • "routeDefinitionId": 0,
  • "productionLineId": 0,
  • "producedMaterialId": 0,
  • "processOrderId": 0,
  • "plannedQuantity": 0,
  • "priority": 0,
  • "plannedStartDate": "2019-08-24T14:15:22Z",
  • "plannedEndDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "readyOn": "2019-08-24T14:15:22Z",
  • "startedOn": "2019-08-24T14:15:22Z",
  • "completedOn": "2019-08-24T14:15:22Z",
  • "completedBy": "string",
  • "cancelledOn": "2019-08-24T14:15:22Z",
  • "lastModifiedOn": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "eTagValue": "string"
}

Update a work order.

Authorizations:
Authorization_Code (mes.workorders.update) Client_Credentials (mes.workorders.update) Resource_Owner_Password_Credentials (mes.workorders.update) Implicit (mes.workorders.update) OnBehalfOfClient_Credentials (mes.workorders.update)
path Parameters
workOrderId
required
integer <int64>

ID of the work order to update.

header Parameters
if-Match
required
string

Expected work order resource ETag value

Request Body schema: application/vnd.ge.mes.full+json; version=4.0

Details on the work order to update.

productionLineId
required
integer <int64>

Work order production line ID.

plannedQuantity
required
integer <int32>

The planned quantity to produce with this work order.

name
required
string <= 50 characters

Work Order name.

producedMaterialId
required
integer <int64>

Work order produced material ID.

routeDefinitionId
integer <int64>

Refers to the route used to execute the work order.

priority
integer <int32> [ 0 .. 2147483647 ]

Relative priority of the work order.

plannedStartDate
string <date-time>

Planned start date for the work order.

plannedEndDate
string <date-time>

Planned end date for the work order.

Responses

Request samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "productionLineId": 0,
  • "plannedQuantity": 0,
  • "name": "string",
  • "producedMaterialId": 0,
  • "routeDefinitionId": 0,
  • "priority": 0,
  • "plannedStartDate": "2019-08-24T14:15:22Z",
  • "plannedEndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/vnd.ge.mes.full+json; version=4.0
{
  • "id": 0,
  • "name": "string",
  • "routeDefinitionId": 0,
  • "productionLineId": 0,
  • "producedMaterialId": 0,
  • "processOrderId": 0,
  • "plannedQuantity": 0,
  • "priority": 0,
  • "plannedStartDate": "2019-08-24T14:15:22Z",
  • "plannedEndDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "readyOn": "2019-08-24T14:15:22Z",
  • "startedOn": "2019-08-24T14:15:22Z",
  • "completedOn": "2019-08-24T14:15:22Z",
  • "completedBy": "string",
  • "cancelledOn": "2019-08-24T14:15:22Z",
  • "lastModifiedOn": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "eTagValue": "string"
}