Get one request
get
/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}/child/requests/{ActionRequestId2}
Request
Path Parameters
-
ActionRequestId(required): integer(int64)
Unique identifier for the master action request.
-
ActionRequestId2(required): integer(int64)
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
-
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).
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-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 : 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-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
Links
- 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. - ActionRequestId:
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" }