Get all sales order action requests
get
/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests
Request
Query Parameters
-
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 -
finder: string
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:- MassActionsFilter: Finds all sales order action requests for mass actions
Finder Variables: - PrimaryKey: Finds sales order action request by primary key.
Finder Variables:- ActionRequestId; integer; Unique identifier for the action request.
- MassActionsFilter: Finds all sales order action requests for mass actions
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- Action; string; Value attribute for the action. Submit etc.
- ActionCode; string; Code to identify the action. ORA_FOM_SUBMIT_ORDER, etc.
- ActionRequestId; integer; Unique identifier for the master action request.
- ActionRequestTrackingId; integer; Identifier to track action requests.
- CreatedBy; string; User who created the action request.
- CreationDate; string; 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; Uniquer identifier for fulfilment line.
- HeaderId; integer; Unique identifier for the saler order header.
- LastUpdateDate; string; Date on which action request was last updated.
- MassActionFlag; boolean; Indicates that the action is a mass action.
- OutcomeCode; string; Code to indicate the outcome of the master action request. These can be SUCCESS, ERROR.
- ProcessId; integer; Unique identifier for the process to initiate the Process in the request resource.
- ProcessStatus; string; 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.
- StatusCode; string; Code to indicate the status of the master action request. COMPLETE, PRE_PROCESSING, PROCESSING etc.
- TotalFailed; integer; Total number of records failed to process by the action reqiest.
- TotalPassed; integer; Total number of records successfully processed the action.
- TotalRecords; integer; Total number of records processed by the action request.
-
totalResults: boolean
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
-
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
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : salesOrderActionRequests
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesOrderActionRequests-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Requests
Type:
array
Title:
Requests
The request executes the action performed on the sales order. It is child of the action request.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : salesOrderActionRequests-requests-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : OrderDetails
Type:
array
Title:
OrderDetails
Order Details resource fetches the order details of the sales order processed by the request.
Show Source
Nested Schema : salesOrderActionRequests-requests-orderDetails-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get details of all sales order action requests.
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"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "ActionCode" : "ORA_FOM_SUBMIT_ORDER", "ActionRequestId" : 300100582712043, "ActionRequestTrackingId" : 270717, "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2023-09-15T05:42:46.002+00:00", "FulfillLineId" : null, "HeaderId" : -1, "LastUpdateDate" : "2023-09-15T05:42:46.150+00:00", "MassActionFlag" : true, "OutcomeCode" : "ERROR", "StatusCode" : "COMPLETE", "Action" : "Submit Order", "ProcessId" : 41510, "TotalRecords" : 1, "TotalFailed" : 1, "TotalPassed" : 0, "ProcessStatus" : "COMPLETED_WITH_ERRORS", "FilterCriteria" : null, "Comments" : null, "CancelReasonCode" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712043", "name" : "salesOrderActionRequests", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712043", "name" : "salesOrderActionRequests", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712043/child/requests", "name" : "requests", "kind" : "collection" } ] }, { "ActionCode" : "ORA_FOM_SUBMIT_ORDER", "ActionRequestId" : 300100582712044, "ActionRequestTrackingId" : 270717, "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2023-09-15T05:42:46.147+00:00", "FulfillLineId" : null, "HeaderId" : 300100582710255, "LastUpdateDate" : "2023-09-15T05:43:03+00:00", "MassActionFlag" : false, "OutcomeCode" : "ERROR", "StatusCode" : "COMPLETE", "Action" : "Submit Order", "ProcessId" : null, "TotalRecords" : null, "TotalFailed" : null, "TotalPassed" : null, "ProcessStatus" : null, "FilterCriteria" : null, "Comments" : null, "CancelReasonCode" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712044", "name" : "salesOrderActionRequests", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712044", "name" : "salesOrderActionRequests", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712044/child/requests", "name" : "requests", "kind" : "collection" } ] }, .... .... { "ActionCode" : "ORA_FOM_SUBMIT_ORDER", "ActionRequestId" : 300100587379652, "ActionRequestTrackingId" : 307774, "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2023-09-22T16:26:01.003+00:00", "FulfillLineId" : null, "HeaderId" : 300100159179760, "LastUpdateDate" : "2023-09-22T16:26:10+00:00", "MassActionFlag" : false, "OutcomeCode" : "ERROR", "StatusCode" : "COMPLETE", "Action" : "Submit Order", "ProcessId" : null, "TotalRecords" : null, "TotalFailed" : null, "TotalPassed" : null, "ProcessStatus" : null, "FilterCriteria" : null, "Comments" : null, "CancelReasonCode" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379652", "name" : "salesOrderActionRequests", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379652", "name" : "salesOrderActionRequests", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379652/child/requests", "name" : "requests", "kind" : "collection" } ] }, { "ActionCode" : "ORA_FOM_SUBMIT_ORDER", "ActionRequestId" : 300100587379653, "ActionRequestTrackingId" : 307774, "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2023-09-22T16:26:01.004+00:00", "FulfillLineId" : null, "HeaderId" : 300100152676621, "LastUpdateDate" : "2023-09-22T16:26:09+00:00", "MassActionFlag" : false, "OutcomeCode" : "ERROR", "StatusCode" : "COMPLETE", "Action" : "Submit Order", "ProcessId" : null, "TotalRecords" : null, "TotalFailed" : null, "TotalPassed" : null, "ProcessStatus" : null, "FilterCriteria" : null, "Comments" : null, "CancelReasonCode" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379653", "name" : "salesOrderActionRequests", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379653", "name" : "salesOrderActionRequests", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379653/child/requests", "name" : "requests", "kind" : "collection" } ] }, { "ActionCode" : "ORA_FOM_SUBMIT_ORDER", "ActionRequestId" : 300100587379654, "ActionRequestTrackingId" : 307774, "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2023-09-22T16:26:01.005+00:00", "FulfillLineId" : null, "HeaderId" : 300100152859477, "LastUpdateDate" : "2023-09-22T16:26:09+00:00", "MassActionFlag" : false, "OutcomeCode" : "ERROR", "StatusCode" : "COMPLETE", "Action" : "Submit Order", "ProcessId" : null, "TotalRecords" : null, "TotalFailed" : null, "TotalPassed" : null, "ProcessStatus" : null, "FilterCriteria" : null, "Comments" : null, "CancelReasonCode" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379654", "name" : "salesOrderActionRequests", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379654", "name" : "salesOrderActionRequests", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379654/child/requests", "name" : "requests", "kind" : "collection" } ] }, { "ActionCode" : "ORA_FOM_SUBMIT_ORDER", "ActionRequestId" : 300100587379655, "ActionRequestTrackingId" : 307774, "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2023-09-22T16:26:01.007+00:00", "FulfillLineId" : null, "HeaderId" : 300100151165022, "LastUpdateDate" : "2023-09-22T16:26:10+00:00", "MassActionFlag" : false, "OutcomeCode" : "ERROR", "StatusCode" : "COMPLETE", "Action" : "Submit Order", "ProcessId" : null, "TotalRecords" : null, "TotalFailed" : null, "TotalPassed" : null, "ProcessStatus" : null, "FilterCriteria" : null, "Comments" : null, "CancelReasonCode" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379655", "name" : "salesOrderActionRequests", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379655", "name" : "salesOrderActionRequests", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379655/child/requests", "name" : "requests", "kind" : "collection" } ] } ], "count" : 25, "hasMore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests", "name" : "salesOrderActionRequests", "kind" : "collection" } ] }