Create transactions

post

/fscmRestApi/resources/11.13.18.05/maintenanceOperationTransactions

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Operation Transaction Details
    Title: Operation Transaction Details
    The Operation Transaction Details resource manages details that describe the maintenance operation transaction.
  • Title: Source System Code
    Maximum Length: 30
    Abbreviation that identifies the source system that started this operation transaction. This code must be registered in Oracle Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view.
  • Title: Source System Type
    Maximum Length: 30
    Type of source system that started this operation transaction. Values include INTERNAL or EXTERNAL.
Nested Schema : Operation Transaction Details
Type: array
Title: Operation Transaction Details
The Operation Transaction Details resource manages details that describe the maintenance operation transaction.
Show Source
Nested Schema : maintenanceOperationTransactions-OperationTransactionDetail-item-post-request
Type: object
Show Source
  • Title: From Dispatch State
    Maximum Length: 30
    Value that reflects the state of the operation in the maintenance work order before operation transaction. Valid values for maintenance operation from operation transaction perspective are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.
  • Flexfields for Operation Transactions
    Title: Flexfields for Operation Transactions
    The Flexfields for Operation Transactions resource manages details about the descriptive flexfields that the maintenance operation transaction uses.
  • Title: Organization Code
    Maximum Length: 30
    Abbreviation that identifies the organization where the operation transaction is performed. This organization will be same as the maintenance work order organization.
  • Title: Source System Code
    Maximum Length: 30
    Abbreviation that identifies the source application that started this operation transaction. This code must be registered in Oracle Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view.
  • Title: To Dispatch State
    Maximum Length: 30
    Value that reflects the to be state of the operation in the maintenance work order post operation transaction. Valid values for maintenance operation are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.
  • Title: Transaction Date
    Date an time when the operation transaction is performed. The valid date range is from the work order released date till the system date. Future date is not valid and the default value is system date.
  • Title: Transaction Note
    Maximum Length: 4000
    Text which reflects the details captured during the operation transaction. This is optional to perform the operation transaction.
  • Title: Operation Sequence
    Number that uniquely identifies the operation within the maintenance work orders. An operation transaction is performed against the same in the maintenance work order.
  • The value that uniquely identifies the operation transaction performed against the maintenance work order. If the transaction is succesfull the value will be a number, otherwise the value will be 0. This attribute is included in the response payload.
  • Title: Work Order
    Maximum Length: 120
    Number uniquely identifies the maintenance work order. The operation transaction is performed against the operation within the maintenance work order.
Nested Schema : Flexfields for Operation Transactions
Type: array
Title: Flexfields for Operation Transactions
The Flexfields for Operation Transactions resource manages details about the descriptive flexfields that the maintenance operation transaction uses.
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : maintenanceOperationTransactions-item-response
Type: object
Show Source
  • Read Only: true
    Contains one of the following values: true or false. If true, then an error occurred while processing the operation transaction. If false, then an error did not occur. This attribute does not have a default value. The response payload includes this attribute.
  • Links
  • Operation Transaction Details
    Title: Operation Transaction Details
    The Operation Transaction Details resource manages details that describe the maintenance operation transaction.
  • Title: Source System Code
    Maximum Length: 30
    Abbreviation that identifies the source system that started this operation transaction. This code must be registered in Oracle Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view.
  • Title: Source System Type
    Maximum Length: 30
    Type of source system that started this operation transaction. Values include INTERNAL or EXTERNAL.
Nested Schema : Operation Transaction Details
Type: array
Title: Operation Transaction Details
The Operation Transaction Details resource manages details that describe the maintenance operation transaction.
Show Source
Nested Schema : maintenanceOperationTransactions-OperationTransactionDetail-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Names of the error messages that occurred when processing the operation transaction. Each error message name corresponds to one text string that the ErrorMessages attribute contains. A comma ( , ) separates each message name.
  • Read Only: true
    Maximum Length: 2000
    Text of the error messages that occurred when processing the operation transaction. Each text string for each error message corresponds to one error message name that the ErrorMessageNames attribute contains. A double dollar sign ($$) separated each message.
  • Title: From Dispatch State
    Maximum Length: 30
    Value that reflects the state of the operation in the maintenance work order before operation transaction. Valid values for maintenance operation from operation transaction perspective are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.
  • Links
  • Flexfields for Operation Transactions
    Title: Flexfields for Operation Transactions
    The Flexfields for Operation Transactions resource manages details about the descriptive flexfields that the maintenance operation transaction uses.
  • Title: Organization Code
    Maximum Length: 30
    Abbreviation that identifies the organization where the operation transaction is performed. This organization will be same as the maintenance work order organization.
  • Title: Source System Code
    Maximum Length: 30
    Abbreviation that identifies the source application that started this operation transaction. This code must be registered in Oracle Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view.
  • Title: To Dispatch State
    Maximum Length: 30
    Value that reflects the to be state of the operation in the maintenance work order post operation transaction. Valid values for maintenance operation are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.
  • Title: Transaction Date
    Date an time when the operation transaction is performed. The valid date range is from the work order released date till the system date. Future date is not valid and the default value is system date.
  • Title: Transaction Note
    Maximum Length: 4000
    Text which reflects the details captured during the operation transaction. This is optional to perform the operation transaction.
  • Title: Operation Sequence
    Number that uniquely identifies the operation within the maintenance work orders. An operation transaction is performed against the same in the maintenance work order.
  • The value that uniquely identifies the operation transaction performed against the maintenance work order. If the transaction is succesfull the value will be a number, otherwise the value will be 0. This attribute is included in the response payload.
  • Title: Work Order
    Maximum Length: 120
    Number uniquely identifies the maintenance work order. The operation transaction is performed against the operation within the maintenance work order.
Nested Schema : Flexfields for Operation Transactions
Type: array
Title: Flexfields for Operation Transactions
The Flexfields for Operation Transactions resource manages details about the descriptive flexfields that the maintenance operation transaction uses.
Show Source
Nested Schema : maintenanceOperationTransactions-OperationTransactionDetail-OperationTransactionDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to create one maintenance operation transaction.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/maintenanceOperationTransactions"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
  "SourceSystemCode" : "SAP",
  "SourceSystemType" : "EXTERNAL",
  "OperationTransactionDetail" : [ {
  "OrganizationCode" : "M1",
  "WoOperationSequenceNumber" : 30,
  "TransactionDate" : "2017-08-28 01:55:49",
  "TransactionNote" : "REST Testing Maintenance Operation Txn",
  "WorkOrderNumber" : "M1-1089" ,
  "FromDispatchState" : "READY",
  "ToDispatchState" : "COMPLETE"
  } ]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "SourceSystemCode" : "SAP",
  "SourceSystemType" : "EXTERNAL",
  "ErrorsExistFlag" : "false",
  "OperationTransactionDetail" : [ {
    "FromDispatchState" : "READY",
    "OrganizationCode" : "M1",
    "SourceSystemCode" : "SAP",
    "ToDispatchState" : "COMPLETE",
    "TransactionDate" : "2017-08-27T18:55:49-07:00",
    "TransactionNote" : "REST Testing Maintenance Operation Txn",
    "WoOperationSequenceNumber" : 30,
    "WoOperationTransactionId" : 11621,
    "WorkOrderNumber" : "M1-1089",
    "ErrorMessages" : "",
    "ErrorMessageNames" : "",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/maintenanceOperationTransactions/300100093101741/child/OperationTransactionDetail/300100093101742",
      "name" : "OperationTransactionDetail",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/maintenanceOperationTransactions/300100093101741/child/OperationTransactionDetail/300100093101742",
      "name" : "OperationTransactionDetail",
      "kind" : "item"
    }, {
      "rel" : "parent",
      "href" : "https://servername/fscmRestApi/resources/version/maintenanceOperationTransactions/300100093101741",
      "name" : "maintenanceOperationTransactions",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/version/maintenanceOperationTransactions/300100093101741/child/OperationTransactionDetail/300100093101742/child/OperationTransactionDFF",
      "name" : "OperationTransactionDFF",
      "kind" : "collection"
    } ]
  } ],
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/maintenanceOperationTransactions/300100093101741",
    "name" : "maintenanceOperationTransactions",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/maintenanceOperationTransactions/300100093101741",
    "name" : "maintenanceOperationTransactions",
    "kind" : "item"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/maintenanceOperationTransactions/300100093101741/child/OperationTransactionDetail",
    "name" : "OperationTransactionDetail",
    "kind" : "collection"
  } ]
}
Back to Top