1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Sales Order Action Requests
  5. Requests

Get all requests

get

/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}/child/requests

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a request by the primary key.
      Finder Variables:
      • ActionRequestId; integer; Unique identifier for the action request.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActionCode; string; Code to identify the action.
    • ActionRequestId; integer; Unique identifier for the child action request.
    • ActionRequestTrackingId; integer; Identifier to track action requests in the Requests resource.
    • FulfillLineId; integer; Uniquer identifier for the fulfilment line.
    • HeaderId; integer; Unique identifier for the saler order header.
    • MassActionFlag; boolean; Indicates that the action is a mass action.
    • OutcomeCode; string; Code to indicate the outcome of the child action request. It can be SUCCESS or ERROR.
    • RequestStatus; string; Status of the request submitted for an order or line such as COMPLETED, FAILED, or IN_QUEUE
    • StatusCode; string; Code to indicate the status of the child action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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 : salesOrderActionRequests-requests
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : salesOrderActionRequests-requests-item-response
Type: object
Show Source
Nested Schema : Message Details
Type: array
Title: Message Details
The Message Details resource fetches the details of the messages logged for the action request.
Show Source
Nested Schema : Order Details
Type: array
Title: Order Details
Order Details resource fetches the order details of the sales order processed by the request.
Show Source
Nested Schema : Order Line Details
Type: array
Title: Order Line Details
The Order Line Details resource fetches the order line details of the sales order processed by the request.
Show Source
Nested Schema : salesOrderActionRequests-requests-messageDetails-item-response
Type: object
Show Source
Nested Schema : salesOrderActionRequests-requests-orderDetails-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Sold-to party name of the customer on the sales order.
  • Read Only: true
    Maximum Length: 30
    Identifies the interface using which the order was captured such as OrderImport, REST_salesOrdersForOrderHub, REST_omSalesOrders, or UI.
  • Title: Purchase Order
    Read Only: true
    Maximum Length: 50
    Customer purchase order of the sales order processed by the action request.
  • Read Only: true
    Unique identifier for the saler order header.
  • Links
  • Title: Orchestration Order
    Read Only: true
    Maximum Length: 50
    Default Value: -1
    Identifer of the sales order number.
  • Read Only: true
    Value that identifies the revision number of the order.
  • Read Only: true
    Unique identifier of the sold-to party on the sales order.
  • Title: Source Order
    Read Only: true
    Maximum Length: 50
    Unique identifier for the saler order in the source system.
  • Read Only: true
    Maximum Length: 255
    Status of the sales order.
  • Read Only: true
    Maximum Length: 30
    Default Value: OPEN
    Code to identify the status of the sales order such as DRAFT, PROCESSING, or CLOSED.
Nested Schema : salesOrderActionRequests-requests-orderLineDetails-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get details of all the child action requests.

We can see the details of all the child action requests for the master action request ID 300100608436027. ActionCode denotes this request is for the order submission.

For child request ID 300100608436028 with Header Id 300100608434819 , StatusCode displays that the process has completed and OutcomeCode denotes that order submission was successful. Based on this, RequestStatus of the child request is marked COMPLETED.

For child request ID 300100608436029 with Header Id 300100608434932 , StatusCode displays that the process has completed and OutcomeCode denotes that order submission was in Error. Based on this, RequestStatus of the child request is marked FAILED.

For child request ID 300100608436030 with Header Id 300100608434934 , StatusCode displays that the process has completed and OutcomeCode denotes that order submission was in Error. Based on this, RequestStatus of the child request is marked FAILED.

Example cURL Command

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

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/300100608436027/child/requests"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "ActionCode": "ORA_FOM_SUBMIT_ORDER",
            "ActionRequestId": 300100608436028,
            "ActionRequestTrackingId": 427736,
            "FulfillLineId": null,
            "HeaderId": 300100608434819,
            "MassActionFlag": false,
            "OutcomeCode": "SUCCESS",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": null,
            "RequestStatus": "COMPLETED"
        },
        {
            "ActionCode": "ORA_FOM_SUBMIT_ORDER",
            "ActionRequestId": 300100608436029,
            "ActionRequestTrackingId": 427736,
            "FulfillLineId": null,
            "HeaderId": 300100608434932,
            "MassActionFlag": false,
            "OutcomeCode": "ERROR",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": "Order isn't in Draft status.",
            "RequestStatus": "FAILED"
        },
        {
            "ActionCode": "ORA_FOM_SUBMIT_ORDER",
            "ActionRequestId": 300100608436030,
            "ActionRequestTrackingId": 427736,
            "FulfillLineId": null,
            "HeaderId": 300100608434934,
            "MassActionFlag": false,
            "OutcomeCode": "ERROR",
            "StatusCode": "COMPLETE",
            "SummaryMessageText": "Didn't pass validation. Open the order to review issues.",
            "RequestStatus": "FAILED"
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}
Back to Top