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

Get one request

get

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

Request

Path Parameters
  • Unique identifier for the master action request.
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-item-response
Type: object
Show Source
  • Maximum Length: 30
    Code to identify the action.
  • Unique identifier for the child action request.
  • Identifier to track action requests in the Requests resource.
  • Value that uniquely identifies the carrier responsible for delivering the item.
  • Maximum Length: 255
    Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute in the Setup and Maintenance work area using the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
  • Value that uniquely identifies the fulfillment line prior to the split.
  • Value that uniquely identifies the fulfillment instance.
  • Unique identifier for the fulfillment line.
  • Value that uniquely identifies the organization fulfilling the item. If the item is shippable, this value references the warehouse responsible for shipping it. A contract or agreement is an example of an item that isn't shippable.
  • Unique identifier for the sales order header.
  • Links
  • Maximum Length: 1
    Default Value: false
    Indicates that the action is a mass action.
  • Message Details
    Title: Message Details
    The Message Details resource fetches the details of the messages logged for the action request.
  • Order Details
    Title: Order Details
    Order Details resource fetches the order details of the sales order processed by the request.
  • Quantity of the item or service on the fulfillment line.
  • Order Line Details
    Title: Order Line Details
    The Order Line Details resource fetches the order line details of the sales order processed by the request.
  • Maximum Length: 30
    Code to indicate the outcome of the child action request. It can be SUCCESS or ERROR.
  • Read Only: true
    Maximum Length: 255
    Status of the request submitted for an order or line such as COMPLETED, FAILED, or IN_QUEUE
  • Maximum Length: 255
    Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
  • Maximum Length: 255
    Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute in the Setup and Maintenance work area using the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
  • Value that uniquely identifies the fulfillment line before the split.
  • Maximum Length: 30
    Default Value: PRE_PROCESSING
    Code to indicate the status of the child action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.
  • Read Only: true
    Maximum Length: 1000
    Contains errors, warnings, and information messages for the action request.
  • Value that uniquely identifies the supplier for the purchase order.
  • Value that uniquely identifies the supplier site for the purchase order.
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 sales order header.
  • Links
  • Title: Orchestration Order
    Read Only: true
    Maximum Length: 50
    Default Value: -1
    Identifier 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 sales 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
Links
messageDetails
Parameters:
  • ActionRequestId: $request.path.ActionRequestId
  • ActionRequestId2: $request.path.ActionRequestId2
The Message Details resource fetches the details of the messages logged for the action request.
orderDetails
Parameters:
  • ActionRequestId: $request.path.ActionRequestId
  • ActionRequestId2: $request.path.ActionRequestId2
Order Details resource fetches the order details of the sales order processed by the request.
orderLineDetails
Parameters:
  • ActionRequestId: $request.path.ActionRequestId
  • ActionRequestId2: $request.path.ActionRequestId2
The Order Line Details resource fetches the order line details of the sales order processed by the request.
Back to Top

Examples

This example describes how to get details of one child action request. We can see the details of the child action request ID 300100608436028. ActionCode denotes that the request is for the order submission. StatusCode displays that the process has completed and OutcomeCode denotes that the order submission was successful. Based on this RequestStatus of the child request is marked COMPLETED.

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/ActionRequestId2"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436028"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "ActionCode": "ORA_FOM_SUBMIT_ORDER",
    "ActionRequestId": 300100608436028,
    "ActionRequestTrackingId": 427736,
    "FulfillLineId": null,
    "HeaderId": 300100608434819,
    "MassActionFlag": false,
    "OutcomeCode": "SUCCESS",
    "StatusCode": "COMPLETE",
    "SummaryMessageText": null,
    "RequestStatus": "COMPLETED"
}
Back to Top