1. REST API for Oracle Fusion Cloud SCMREST API for Oracle Fusion Cloud SCM
  2. Use Cases
  3. Order Management
  4. Release Hold on Large Volume of Sales Order Lines Across Orders

Release Hold on Large Volume of Sales Order Lines Across Orders

Oracle Order Management Fusion Cloud provides the ability to release hold on large volume of sales order lines across orders using a REST API. You can release hold that's applied on the fulfillment line entity, you can't release hold that's applied on the order line entity.

You can use REST API to request for releasing hold on multiple sales order lines, that's fulfillment lines across orders, and get the status of the request that's submitted to release line hold. For example, the required batches for the item AS54888 has been reviewed by a warehouse personnel and this is communicated to the order manager. The order manager releases the quality check hold on these lines, so they can be further processed.

Here's a typical application processing flow for the scenario:

  1. In this example, you have a list of Fulfill Line IDs that are on line hold. You want to release hold 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 hold. Alternatively, as described in the Submit Large Volume of Sales Order use case, you can also use filter criteria to release hold on the lines.
  2. You send a request payload using Sales Order Action Requests REST API to release line hold on the list of Fulfill Line IDs.
  3. The response payload includes details of the batch process that's submitted to release hold on the Fulfill Line IDs. As this is an offline process, so the immediate response is always shown as the “PRE_PROCESSING’.
  4. You can get the summarized status of the release line hold request by calling the GET service of the Sales Order Action Requests REST API for the request.
  5. 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 hold. You can get the status of release hold 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 Fulfill Line IDs submitted to release line hold. Two results 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 hold on three fulfillment lines with Fulfill Line IDs 300100608313952, 300100608314073, and 300100608314213. Specify ActionCode: ORA_FOM_RELEASE_LINE_HOLD and HoldCode: QUALITY_CHECK_HOLD and HOLD_INVOICE_CREATION to indicate that the sales order action request is to release the QUALITY_CHECK_HOLD and HOLD_INVOICE_CREATION holds on all the three fulfillment lines. You can specify comma separated HoldCode to release multiple holds on the lines in a request as illustrated in this example. You can also specify ReleaseReasonCode and Comments, if needed. If you must send a ReleaseReasonCode, then set the RequireReasonCodeFlag to true else it's optional for you to send a ReleaseReasonCode. The FulfillLineId attribute carries the unique identifier of the line for releasing the line hold. You can release hold that's applied on the fulfillment line entity, you can't release hold that's applied on the order line entity.

{
    "ActionCode":"ORA_FOM_RELEASE_LINE_HOLD",
    "HoldCode": "QUALITY_CHECK_HOLD,HOLD_INVOICE_CREATION",
    "Comments": "Item Lot Passed Quality Check.Ready to Ship and Invoice",
    "ReleaseReasonCode": "PASSED_QUALITY_CHECK",
    "RequireReasonCodeFlag": true,
    "requests": [
         {
            "FulfillLineId": 300100608313952
        },
        {
            "FulfillLineId": 300100608314073
        },
        {
            "FulfillLineId": 300100608314213
        }
    ]
}

Example Response

  • You can see one master request and three child action requests to release hold on three Fulfill Line IDs mentioned in the request payload. The master ActionRequestId is 300100611833564. The master action request spawned three child requests to handle processing of three individual Fulfill Line IDs:
    • ActionRequestId 300100611833569 for FulfillLineId 300100608313952
    • ActionRequestId 300100611833570 for FulfillLineId 300100608314073
    • ActionRequestId 300100611833571 for FulfillLineId 300100608314213
  • The hold is released on the lines 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:

    • TotalRecords: 3
    • TotalFailed: 0
    • TotalPassed: 0

Here's an example of the response body in JSON format.

{
    "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
    "ActionRequestId": 300100611833564,
    "ActionRequestTrackingId": 331049,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-29T09:29:14.126+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-29T09:29:14.469+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 316668,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Item Lot Passed Quality Check.Ready to Ship and Invoice",
    "CancelReasonCode": null,
    "HoldCode": "QUALITY_CHECK_HOLD,HOLD_INVOICE_CREATION",
    "ReleaseReasonCode": "PASSED_QUALITY_CHECK",
    "RequireReasonCodeFlag": "true",
    "requests": [
        {
            "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
            "ActionRequestId": 300100611833569,
            "ActionRequestTrackingId": 331049,
            "FulfillLineId": 300100608313952,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
            "ActionRequestId": 300100611833570,
            "ActionRequestTrackingId": 331049,
            "FulfillLineId": 300100608314073,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
            "ActionRequestId": 300100611833571,
            "ActionRequestTrackingId": 331049,
            "FulfillLineId": 300100608314213,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/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/300100611833564"

Example Response

You can review the summarized status of the release line hold request.

StatusCode indicates the status of the release line hold 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 line hold request. It's set to SUCCESS, if hold 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 line hold request has been processed for all the lines, and hold 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 line hold 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_LINE_HOLD",
    "ActionRequestId": 300100611833564,
    "ActionRequestTrackingId": 331049,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-29T09:29:14.126+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-29T09:29:14.469+00:00",
    "MassActionFlag": true,
    "OutcomeCode": "ERROR",
    "StatusCode": "COMPLETE",
    "Action": "Release Line Hold",
    "ProcessId": 316668,
    "TotalRecords": 3,
    "TotalFailed": 1,
    "TotalPassed": 2,
    "ProcessStatus": "COMPLETED_WITH_ERRORS",
    "FilterCriteria": null,
    "Comments": "Item Lot Passed Quality Check.Ready to Ship and Invoice",
    "CancelReasonCode": null,
    "HoldCode": "QUALITY_CHECK_HOLD,HOLD_INVOICE_CREATION",
    "ReleaseReasonCode": "PASSED_QUALITY_CHECK",
    "RequireReasonCodeFlag": "true",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/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/300100611833564/child/requests"

Example Response

If your release line hold request has completed with errors, then you can review the status of the release line hold request for each line along with the error or warning details.

StatusCode indicates the status of the release line hold 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 line hold request for each line. It's set to SUCCESS, if hold is released on the line successfully, otherwise it's set to ERROR.

  • You can see that for the FulfillLineId 300100608313952 and 300100608314213 associated with ActionRequestId 300100611833569 and 300100611833571 respectively, StatusCode = COMPLETE and OutcomeCode = SUCCESS, which means hold was released successfully on these lines.
  • For the FulfillLineId 300100608314073 associated with ActionRequestId 300100611833570, StatusCode = COMPLETE and OutcomeCode = ERROR. This means the request is completed but hold hasn't been released on the line. You see that the SummaryMessageText = "The selected holds don't exist on the Line level or were already released, so no hold was released. (FOM-4515739) Details: Select a hold that's applied on the Line level but not yet released, then apply Release Hold action to release the hold.". This indicates that the QUALITY_CHECK_HOLD and HOLD_INVOICE_CREATION holds that were selected to release aren't an active hold on the line, hence no hold was released on the line.

Here's an example of the response body in JSON format.

{
    "items": [
        {
            "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
            "ActionRequestId": 300100611833569,
            "ActionRequestTrackingId": 331049,
            "FulfillLineId": 300100608313952,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833569/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
            "ActionRequestId": 300100611833570,
            "ActionRequestTrackingId": 331049,
            "FulfillLineId": 300100608314073,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": "ERROR",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": "The selected holds don't exist on the Line level or were already released, so no hold was released. (FOM-4515739) Details: Select a hold that's applied on the Line level but not yet released, then apply Release Hold action to release the hold.",
            "RequestStatus": "FAILED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
            "ActionRequestId": 300100611833571,
            "ActionRequestTrackingId": 331049,
            "FulfillLineId": 300100608314213,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833571/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/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/300100611833564/child/requests/300100611833570/child/messageDetails"

Example Response

If your release line hold 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 300100611842863 has been logged for the ActionRequestId 300100611833570 that contains Fulfill LIne ID 300100608314073. 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": 300100611842863,
            "ActionRequestId": 300100611833570,
            "MessageType": "ERROR",
            "MessageText": "The selected holds don't exist on the Line level or were already released, so no hold was released. (FOM-4515739) Details: Select a hold that's applied on the Line level but not yet released, then apply Release Hold action to release the hold.",
            "LastUpdateDate": "2024-04-29T09:29:32.334+00:00",
            "EntityType": "LINE",
            "EntityDisplayNumber": "2",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/messageDetails/300100611842863",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/messageDetails/300100611842863",
                    "name": "messageDetails",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570",
                    "name": "requests",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/messageDetails",
            "name": "messageDetails",
            "kind": "collection"
        }
    ]
}