Release Pause Task on Large Volume of Sales Order Lines Across Orders
Oracle Order Management Fusion Cloud provides the ability to release pause task on large volume of sales order lines across orders using a REST API.
You can use REST API to request for releasing a pause task on multiple sales order lines across orders and get the status of the request that's submitted to release the pause task. For example, order lines across orders could be on pause task to prevent billing until all contractual terms are fulfilled. After the contractual terms are fulfilled, order manager releases the pause task so that the lines can be billed.
Here's a typical application processing flow for the scenario:
- In this example, you have a list of Fulfill Line IDs that are on pause task. You want to release pause task on these Fulfill Line IDs. You can use the GET service of Sales Orders for Order Hub resource to get the Fulfill Line IDs from which you want to release pause task. Alternatively, as described in the Submit Large Volume of Sales Order use case, you can also use filter criteria to release pause task on the lines.
- You send a request payload using Sales Order Action Requests REST API to release pause task on the list of Fulfill Line IDs.
- The response payload includes details of the batch process that's submitted to release pause task on the Fulfill Line IDs. As this is an offline process, so the immediate response is always shown as PRE_PROCESSING.
- You can get the summarized status of the release pause task request by calling the GET service of the Sales Order Action Requests REST API for the request.
- The GET service of the Sales Order Action Requests REST API for the request also provides the unique request identifiers that are spawned for each Fulfill Line ID that you request to release pause task. You can get the status of release pause task on the line and error or warning details if any for each line using the request identifier of each Fulfill Line ID.
In this example, there are three order lines submitted to release pause task. Two result in success and one in error.
Create One Sales Action Request
Use this resource URL format.
POST
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrderActionRequests"
Example Request
Here's an example of the request body in JSON format. You plan to release the pause task on three lines with Fulfill Line IDs 300100611851727, 300100611851778, and 300100611851919. Specify ActionCode: ORA_FOM_RELEASE_PAUSE_TASK to indicate that the sales order action request is to release the pause task on all the three lines. The FulfillLineId attribute carries the unique identifier of the line for releasing the pause task.
{
"ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
"requests": [
{
"FulfillLineId": 300100611851727
},
{
"FulfillLineId": 300100611851778
},
{
"FulfillLineId": 300100611851919
}
]
}
Example Response
- You can see one master request and three child action requests to release
pause task on three Fulfill Line IDs mentioned in the request payload. The
master ActionRequestId is 300100611858237. The master action request spawned
three child requests to handle processing of three individual Fulfill Line
IDs:
- ActionRequestId 300100611858238 for FulfillLineId 300100611851727
- ActionRequestId 300100611858239 for FulfillLineId 300100611851778
- ActionRequestId 300100611858240 for FulfillLineId 300100611851919
- The pause task on the lines are released through a batch process, hence the
response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as
the batch process is yet to start processing. Note
the following:- TotalRecords: 3
- TotalFailed: 0
- TotalPassed: 0
{
"ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
"ActionRequestId": 300100611858237,
"ActionRequestTrackingId": 331058,
"CreatedBy": "SCMOPERATIONS",
"CreationDate": "2024-04-29T10:05:24.001+00:00",
"FulfillLineId": null,
"HeaderId": -1,
"LastUpdateDate": "2024-04-29T10:05:24.254+00:00",
"MassActionFlag": true,
"OutcomeCode": null,
"StatusCode": "PRE_PROCESSING",
"Action": null,
"ProcessId": 318216,
"TotalRecords": 3,
"TotalFailed": 0,
"TotalPassed": 0,
"ProcessStatus": "IN_QUEUE",
"FilterCriteria": null,
"Comments": null,
"CancelReasonCode": null,
"HoldCode": null,
"ReleaseReasonCode": null,
"RequireReasonCodeFlag": null,
"requests": [
{
"ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
"ActionRequestId": 300100611858238,
"ActionRequestTrackingId": 331058,
"FulfillLineId": 300100611851727,
"HeaderId": 300100611851702,
"MassActionFlag": false,
"OutcomeCode": null,
"StatusCode": "PRE_PROCESSING",
"SummaryMessageText": null,
"RequestStatus": "IN_QUEUE",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238",
"name": "requests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238",
"name": "requests",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238/child/messageDetails",
"name": "messageDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238/child/orderDetails",
"name": "orderDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238/child/orderLineDetails",
"name": "orderLineDetails",
"kind": "collection"
}
]
},
{
"ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
"ActionRequestId": 300100611858239,
"ActionRequestTrackingId": 331058,
"FulfillLineId": 300100611851778,
"HeaderId": 300100611851702,
"MassActionFlag": false,
"OutcomeCode": null,
"StatusCode": "PRE_PROCESSING",
"SummaryMessageText": null,
"RequestStatus": "IN_QUEUE",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239",
"name": "requests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239",
"name": "requests",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239/child/messageDetails",
"name": "messageDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239/child/orderDetails",
"name": "orderDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239/child/orderLineDetails",
"name": "orderLineDetails",
"kind": "collection"
}
]
},
{
"ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
"ActionRequestId": 300100611858240,
"ActionRequestTrackingId": 331058,
"FulfillLineId": 300100611851919,
"HeaderId": 300100611851917,
"MassActionFlag": false,
"OutcomeCode": null,
"StatusCode": "PRE_PROCESSING",
"SummaryMessageText": null,
"RequestStatus": "IN_QUEUE",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240",
"name": "requests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240",
"name": "requests",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/messageDetails",
"name": "messageDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/orderDetails",
"name": "orderDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/orderLineDetails",
"name": "orderLineDetails",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests",
"name": "requests",
"kind": "collection"
}
]
}
GET One Sales Order Action Request
Use this resource URL format.
GET
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/ActionRequestId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237"
Example Response
You can review the summarized status of the release pause task request.
StatusCode indicates the status of the release pause task request for all the Fulfill Line IDs. It can be COMPLETE, PRE_PROCESSING, or PROCESSING. Unless the StatusCode is COMPLETE, request is still being processed. Keep checking the status until the StatusCode is marked as COMPLETE. OutcomeCode indicates the outcome of the release pause task request. It's set to SUCCESS, if pause task is released on all the lines successfully, otherwise it's set to ERROR. In this example, notice that StatusCode is COMPLETE and OutcomeCode is ERROR. This means the release pause task request has been processed for all the lines, and pause task is not released on at least one line.
Note:
- TotalRecords: 3
- TotalFailed: 1
- TotalPassed: 2
ProcessStatus indicates the combined status of StatusCode and OutcomeCode. COMPLETED_WITH_ERRORS indicates that release pause task request is processed for all the lines but there are errors.
Here's an example of the response body in JSON format.
{
"ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
"ActionRequestId": 300100611858237,
"ActionRequestTrackingId": 331058,
"CreatedBy": "SCMOPERATIONS",
"CreationDate": "2024-04-29T10:05:24.001+00:00",
"FulfillLineId": null,
"HeaderId": -1,
"LastUpdateDate": "2024-04-29T10:05:24.254+00:00",
"MassActionFlag": true,
"OutcomeCode": "ERROR",
"StatusCode": "COMPLETE",
"Action": "Release Pause Task",
"ProcessId": 318216,
"TotalRecords": 3,
"TotalFailed": 1,
"TotalPassed": 2,
"ProcessStatus": "COMPLETED_WITH_ERRORS",
"FilterCriteria": null,
"Comments": null,
"CancelReasonCode": null,
"HoldCode": null,
"ReleaseReasonCode": null,
"RequireReasonCodeFlag": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests",
"name": "requests",
"kind": "collection"
}
]
}
GET All Requests
Use this resource URL format.
GET
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/ActionRequestId/child/requests"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests"
Example Response
If your release pause task request has completed with errors, then you can review the status of the release pause task request for each line along with the error or warning details.
StatusCode indicates the status of the release pause task request for each Fulfill Line ID. It can be COMPLETE, PRE_PROCESSING, or PROCESSING. Unless the StatusCode is COMPLETE, request is still being processed for the lines. Keep checking the status until the StatusCode is marked as COMPLETE. OutcomeCode indicates the outcome of the release pause task request for each line. It's set to SUCCESS, if pause task is released on the line successfully, otherwise it's set to ERROR.
- You can see that for the FulfillLineId 300100611851727 and 300100611851778 associated with ActionRequestId 300100611858238 and 300100611858239 respectively, StatusCode = COMPLETE and OutcomeCode = SUCCESS, which means pause task was released successfully on these lines.
- For the FulfillLineId 300100611851919 associated with ActionRequestId 300100611858240, StatusCode = COMPLETE and OutcomeCode = ERROR. This means the request is completed but pause task hasn't been released on the line. You see that the SummaryMessageText = "Order line isn't on a pause task. (FOM-4515749) Details: Select a line which is currently on a pause task in the orchestration process, then apply the Release Pause Task action to release the pause task.". This indicates the line is currently not a pause task, hence no pause task was released on the line.
Here's an example of the response body in JSON format.
{
"items": [
{
"ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
"ActionRequestId": 300100611858238,
"ActionRequestTrackingId": 331058,
"FulfillLineId": 300100611851727,
"HeaderId": 300100611851702,
"MassActionFlag": false,
"OutcomeCode": "SUCCESS",
"StatusCode": "COMPLETE",
"SummaryMessageText": null,
"RequestStatus": "COMPLETED",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238",
"name": "requests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238",
"name": "requests",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238/child/messageDetails",
"name": "messageDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238/child/orderDetails",
"name": "orderDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858238/child/orderLineDetails",
"name": "orderLineDetails",
"kind": "collection"
}
]
},
{
"ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
"ActionRequestId": 300100611858239,
"ActionRequestTrackingId": 331058,
"FulfillLineId": 300100611851778,
"HeaderId": 300100611851702,
"MassActionFlag": false,
"OutcomeCode": "SUCCESS",
"StatusCode": "COMPLETE",
"SummaryMessageText": null,
"RequestStatus": "COMPLETED",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239",
"name": "requests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239",
"name": "requests",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239/child/messageDetails",
"name": "messageDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239/child/orderDetails",
"name": "orderDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858239/child/orderLineDetails",
"name": "orderLineDetails",
"kind": "collection"
}
]
},
{
"ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
"ActionRequestId": 300100611858240,
"ActionRequestTrackingId": 331058,
"FulfillLineId": 300100611851919,
"HeaderId": 300100611851917,
"MassActionFlag": false,
"OutcomeCode": "ERROR",
"StatusCode": "COMPLETE",
"SummaryMessageText": "Order line isn't on a pause task. (FOM-4515749) Details: Select a line which is currently on a pause task in the orchestration process, then apply the Release Pause Task action to release the pause task.",
"RequestStatus": "FAILED",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240",
"name": "requests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240",
"name": "requests",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237",
"name": "salesOrderActionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/messageDetails",
"name": "messageDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/orderDetails",
"name": "orderDetails",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/orderLineDetails",
"name": "orderLineDetails",
"kind": "collection"
}
]
}
],
"count": 3,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests",
"name": "requests",
"kind": "collection"
}
]
}
GET Details of All Messages for an Action Request
Use this resource URL format.
GET
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/ActionRequestId/child/requests/ActionRequestId2/child/messageDetails"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/messageDetails"
Example Response
If your release pause task request for a line has completed with one or more errors, then you can get the details of all the errors logged for the line. You can see here that one message with MessageId 300100611861293 has been logged for the ActionRequestId 300100611858240 that contains Fulfill LIne ID 300100611851919. The MessageType indicates that the message is of type ERROR, MessageText contains the error message for the MessageId, LastUpdateDate shows when the error message was logged, EntityType LINE indicates that the error message is logged on the line, and EntityDisplayNumber indicates the line number on which the error is logged.
Here's an example of the response body in JSON format.
{
"items": [
{
"MessageId": 300100611861293,
"ActionRequestId": 300100611858240,
"MessageType": "ERROR",
"MessageText": "Order line isn't on a pause task. (FOM-4515749) Details: Select a line which is currently on a pause task in the orchestration process, then apply the Release Pause Task action to release the pause task.",
"LastUpdateDate": "2024-04-29T10:05:36.060+00:00",
"EntityType": "LINE",
"EntityDisplayNumber": "1",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/messageDetails/300100611861293",
"name": "messageDetails",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/messageDetails/300100611861293",
"name": "messageDetails",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240",
"name": "requests",
"kind": "item"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/messageDetails",
"name": "messageDetails",
"kind": "collection"
}
]
}