Create one detail
post
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/additionalInformation
Request
Path Parameters
-
OrderKey(required): string
Value that uniquely identifies the sales order. It can have the following formats.
- Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
- Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : Discriminator: Category
Type:
object
Discriminator: Category
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-post-request
Type:
Show Source
object
-
Category: string
Maximum Length:
240
Default Value:DOO_HEADERS_ADD_INFO
Category of the flexfield. -
HeaderId: integer
(int64)
Value that uniquely identifies the sales order that contains the additional information.
-
ObjectVersionNumber: integer
(int32)
Number that determines whether some other session updated the row. The application increments this value every time it updates a row. It compares this number at the start and at the end of each transaction to determine whether another session updated the row since the last time the application queried the row.
-
SourceTransactionIdentifier: string
Maximum Length:
255
Value that uniquely identifies the transaction in the source application. -
SourceTransactionSystem: string
Maximum Length:
255
Source application that placed the request.
Response
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 : Discriminator: Category
Type:
object
Discriminator: Category
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response
Type:
Show Source
object
-
Category: string
Maximum Length:
240
Default Value:DOO_HEADERS_ADD_INFO
Category of the flexfield. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the additional information. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the additional information. -
HeaderId: integer
(int64)
Value that uniquely identifies the sales order that contains the additional information.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the order line. -
LastUpdatedBy: string
Title:
Updated By
Read Only:true
Maximum Length:64
User who most recently updated the additional information. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
Login that user used when updating the additional information. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number that determines whether some other session updated the row. The application increments this value every time it updates a row. It compares this number at the start and at the end of each transaction to determine whether another session updated the row since the last time the application queried the row.
-
SourceTransactionIdentifier: string
Maximum Length:
255
Value that uniquely identifies the transaction in the source application. -
SourceTransactionSystem: string
Maximum Length:
255
Source application that placed the request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Examples
The following example describe how to add a new detail.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/additionalInformation"
For example:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation"
Example Request Body
The following example includes the contents of the request body in JSON format to add a new order header extensible flexfield to an existing order.
You replace the request payload in the example cURL command with the contents of the example request body. The request payload specifies attribute values that the command uses in the record that it creates.
You can achieve the same result with Create sales orders using the upsert-mode header parameter. Refer to the examples in the Create sales orders section to see how to add new child resource to an existing order.
{ "Category":"DOO_HEADERS_ADD_INFO", "HeaderEffBComplianceDetailsprivateVO":[ { "ContextCode":"ComplianceDetails", "_ComplianceInfo":"Compliance info - ASP_0403_003 - 4/3/2018", "_ComplianceDate":null, "_CompleteCompliancedate":null, "_ComplianceReason":"Some reason - ASP_0403_003", "_ComplianceValue":201 } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "Category" : "DOO_HEADERS_ADD_INFO", "CreatedBy" : "SCMOPERATIONS", "CreationDate" : "2022-10-19T11:03:33+00:00", "HeaderId" : 300100569195081, "LastUpdateDate" : "2022-10-19T12:53:11.586+00:00", "LastUpdateLogin" : "EAC04E4F64A8231BE0533928F80AC581", "LastUpdatedBy" : "SCMOPERATIONS", "ObjectVersionNumber" : 6, "SourceTransactionIdentifier" : "300100569195081", "SourceTransactionSystem" : "DOO", "HeaderEffBComplianceDetailsprivateVO" : [ { } ], "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081", "name" : "additionalInformation", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081", "name" : "additionalInformation", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01", "name" : "salesOrdersForOrderHub", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081/child/HeaderEffB1NumHeaderprivateVO", "name" : "HeaderEffB1NumHeaderprivateVO", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081/child/HeaderEffBComplianceDetailsprivateVO", "name" : "HeaderEffBComplianceDetailsprivateVO", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081/child/HeaderEffBHeaderContext1privateVO", "name" : "HeaderEffBHeaderContext1privateVO", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081/child/HeaderEffBHeaderContext2privateVO", "name" : "HeaderEffBHeaderContext2privateVO", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081/child/HeaderEffBHeaderContext3privateVO", "name" : "HeaderEffBHeaderContext3privateVO", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081/child/HeaderEffBReseller__InformationprivateVO", "name" : "HeaderEffBReseller__InformationprivateVO", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081/child/HeaderEffBRevenue_5FManagement_5FInformation_5FHeaderprivateVO", "name" : "HeaderEffBRevenue_5FManagement_5FInformation_5FHeaderprivateVO", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/additionalInformation/300100569195081/child/HeaderEffBSite__Baded__PricingprivateVO", "name" : "HeaderEffBSite__Baded__PricingprivateVO", "kind" : "collection" } ] }