Get one sales order action request
/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}
Request
-
ActionRequestId(required): integer(int64)
Unique identifier for the master action request.
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
- application/json
Default Response
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
object
-
Action: string
Read Only:
true
Maximum Length:255
Value attribute for the action. Submit etc. -
ActionCode: string
Maximum Length:
30
Code to identify the action. ORA_FOM_SUBMIT_ORDER, etc. -
ActionRequestId: integer
(int64)
Unique identifier for the master action request.
-
ActionRequestTrackingId: integer
(int64)
Identifier to track action requests.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the action request. -
CreationDate: string
(date-time)
Read Only:
true
Date on which action request is created. -
FilterCriteria: string
Contains the filter criterion of the sales orders to be submitted for the 'Select All'. This criteria is used to get the sales order numbers as specific sales order numbers are not sent.
-
FulfillLineId: integer
(int64)
Uniquer identifier for fulfilment line.
-
HeaderId: integer
(int64)
Unique identifier for the saler order header.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which action request was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that the action is a mass action. -
OutcomeCode: string
Maximum Length:
30
Code to indicate the outcome of the master action request. These can be SUCCESS, ERROR. -
ProcessId: integer
Read Only:
true
Unique identifier for the process to initiate the Process in the request resource. -
ProcessStatus: string
Read Only:
true
Maximum Length:255
Status of the process initiated by action request to process the action. These can be COMPLETED, IN_QUEUE, COMPLETED WITH ERROR, COMPLETED WITH WARNING, FAILED etc. -
requests: array
Requests
Title:
Requests
The request executes the action performed on the sales order. It is child of the action request. -
StatusCode: string
Maximum Length:
30
Default Value:PRE_PROCESSING
Code to indicate the status of the master action request. COMPLETE, PRE_PROCESSING, PROCESSING etc. -
TotalFailed: integer
Read Only:
true
Total number of records failed to process by the action reqiest. -
TotalPassed: integer
Read Only:
true
Total number of records successfully processed the action. -
TotalRecords: integer
Read Only:
true
Total number of records processed by the action request.
array
Links
array
Requests
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
ActionCode: string
Maximum Length:
30
Code to identify the action. -
ActionRequestId: integer
(int64)
Unique identifier for the child action request.
-
ActionRequestTrackingId: integer
(int64)
Identifier to track action requests in the request resource.
-
FulfillLineId: integer
(int64)
Uniquer identifier for fulfilment line.
-
HeaderId: integer
(int64)
Unique identifier for the saler order header.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that the action is a mass action. -
orderDetails: array
OrderDetails
Title:
OrderDetails
Order Details resource fetches the order details of the sales order processed by the request. -
OutcomeCode: string
Maximum Length:
30
Code to indicate the outcome of the child action request. These can be SUCCESS, ERROR. -
RequestStatus: string
Read Only:
true
Maximum Length:255
Contains status of the order submission child request. -
StatusCode: string
Maximum Length:
30
Default Value:PRE_PROCESSING
Code to indicate the status of the child action request. COMPLETE, PRE_PROCESSING, PROCESSING etc. -
SummaryMessageText: string
Read Only:
true
Maximum Length:1000
Contains errors, warnings, information messages on the sales order or on process.
array
Links
array
OrderDetails
object
-
BuyingPartyName: string
Read Only:
true
Maximum Length:255
Sold to party name of the customer on the sales order. -
CustomerPONumber: string
Title:
Purchase Order
Read Only:true
Maximum Length:50
Code to identify the customer purchase order of the sales order processed by the action request. -
HeaderId: integer
(int64)
Read Only:
true
Unique identifier for the saler order header. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Title:
Orchestration Order
Read Only:true
Maximum Length:50
Default Value:-1
Identifer of the sales order number. -
SoldToPartyId: integer
(int64)
Read Only:
true
Unique identifier of the customer These can be DRAFT, PROCESSING etc. -
SourceOrderNumber: string
Title:
Source Order
Read Only:true
Maximum Length:50
Unique identifier for the saler order in the source system. -
Status: string
Read Only:
true
Maximum Length:255
Status of the sales order. -
StatusCode: string
Read Only:
true
Maximum Length:30
Default Value:OPEN
Code to identify status of the sales order. These can be DRAFT, PROCESSING etc.
array
Links
- requests
-
Operation: /fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}/child/requestsParameters:
- ActionRequestId:
$request.path.ActionRequestId
The request executes the action performed on the sales order. It is child of the action request. - ActionRequestId:
Examples
This example describes how to get details of one master action request.
We can see the details of the master action request ID 300100608436027. ActionCode denotes that the request is for the order submission. This master request displays TotalRecords 3, TotalFailed 2 and TotalPassed 1, indicating that it processed 3 child requests out of which 2 failed and one has passed.
StatusCode displays that the process has completed and OutcomeCode denotes that some child action requests may be in ERROR. Based on this the ProcessStatus indicates the status of the master action request is set as COMPLETED WITH ERRORS.
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"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027"
Example Response Body
{ "ActionCode": "ORA_FOM_SUBMIT_ORDER", "ActionRequestId": 300100608436027, "ActionRequestTrackingId": 427736, "CreatedBy": "SCMOPERATIONS", "CreationDate": "2023-10-20T06:19:28.001+00:00", "FulfillLineId": null, "HeaderId": -1, "LastUpdateDate": "2023-10-20T06:19:28.102+00:00", "MassActionFlag": true, "OutcomeCode": "ERROR", "StatusCode": "COMPLETE", "Action": "Submit Order", "ProcessId": 474122, "TotalRecords": 3, "TotalFailed": 2, "TotalPassed": 1, "ProcessStatus": "COMPLETED_WITH_ERRORS", "FilterCriteria": null }