Jump to

• Request
• Response
• Examples

Update one detail

patch

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

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=
• additionalInformationUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Details resource and used to uniquely identify an instance of Details. The client should not generate the hash key value. Instead, the client should query on the Details collection resource in order to navigate to a specific instance of Details to get the hash key.

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.

Supported Media Types

• application/json

Request Body - 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-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-patch-request"
        }
    ],
    "x-base-schema":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffCategoriesVO-patch-item"
}

Match One Schema

Show Source

• DOO_HEADERS_ADD_INFO - object oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-patch-request

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

Nested Schema : oracle_apps_scm_doo_processOrder_flex_headerCategories_view_j__HeaderEffDooHeadersAddInfoprivateVO-item-patch-request

Type: object

Show Source

• Category: string
  Maximum Length: 240

  Default Value: DOO_HEADERS_ADD_INFO
• 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"
        },
        "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
        }
    }
}

Back to Top

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.

Body ()

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."
        }
    }
}

Back to Top

Examples

This example describes how to update a cost adjustment detail.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/additionalInformation/additionalInformationUniqID"

For example, use the following command. To patch EFF data, we need to go to the EFF context level to update specific segments in the context.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_HdrEff_01/child/additionalInformation/300100185406568/child/HeaderEffBComplianceDetailsprivateVO/300100185406571"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. To patch EFF data, you must go to the EFF context level to update specific segments in the context.

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 update child resource in the existing order.

{ 
	"_ComplianceInfo":"Compliance info updated - 11/27/2019",
	"_ComplianceValue":301
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
}

Back to Top