REST API for Oracle Fusion Cloud SCM

Create one detail

post

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/additionalInformation

Request

Path Parameters

OrderKey(required): string

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=

Header Parameters

Metadata-Context: string

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: string

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: string

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

DOO_HEADERS_ADD_INFO

{
    "discriminator":{
        "propertyName":"Category",
        "mapping":{
            "DOO_HEADERS_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-post-request"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffCategoriesVO-post-item"
}

Match One Schema

Show Source

DOO_HEADERS_ADD_INFO - object oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-post-request

{
    "discriminator":{
        "propertyName":"Category",
        "mapping":{
            "DOO_HEADERS_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-post-request"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffCategoriesVO-post-item"
}

Nested Schema : oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-post-request

Type: object

Show Source

Category: string

Maximum Length: 240

Default Value: DOO_HEADERS_ADD_INFO
HeaderId: integer (int64)
ObjectVersionNumber: integer (int32)
SourceTransactionIdentifier: string

Maximum Length: 255
SourceTransactionSystem: string

Maximum Length: 255

{
    "type":"object",
    "properties":{
        "Category":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "default":"DOO_HEADERS_ADD_INFO"
        },
        "HeaderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SourceTransactionIdentifier":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "SourceTransactionSystem":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

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.

Root Schema : Discriminator: Category

Type: object

Discriminator: Category

Discriminator Values

DOO_HEADERS_ADD_INFO

{
    "discriminator":{
        "propertyName":"Category",
        "mapping":{
            "DOO_HEADERS_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffCategoriesVO-item"
}

Match One Schema

Show Source

DOO_HEADERS_ADD_INFO - object oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response

{
    "discriminator":{
        "propertyName":"Category",
        "mapping":{
            "DOO_HEADERS_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffCategoriesVO-item"
}

Nested Schema : oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-response

Type: object

Show Source

Category: string

Maximum Length: 240

Default Value: DOO_HEADERS_ADD_INFO
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64
CreationDate: string (date-time)

Title: Creation Date

Read Only: true
HeaderId: integer (int64)
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true
LastUpdatedBy: string

Title: Updated By

Read Only: true

Maximum Length: 64
LastUpdateLogin: string

Title: Last Updated Login

Read Only: true

Maximum Length: 32
links: array Links

Title: Links

The link relations associated with the resource instance.
ObjectVersionNumber: integer (int32)
SourceTransactionIdentifier: string

Maximum Length: 255
SourceTransactionSystem: string

Maximum Length: 255

{
    "type":"object",
    "properties":{
        "Category":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "default":"DOO_HEADERS_ADD_INFO"
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true
        },
        "HeaderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SourceTransactionIdentifier":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "SourceTransactionSystem":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"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"
  } ]
}