Jump to

• Request
• Response

Update one order preference

patch

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/orderPreferences/{orderPreferencesUniqID}

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
• orderPreferencesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Order Preferences resource and used to uniquely identify an instance of Order Preferences. The client should not generate the hash key value. Instead, the client should query on the Order Preferences collection resource in order to navigate to a specific instance of Order Preferences to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CreateCustomerInformationFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application creates the customer related information even if the customer, site, or contacts don't exist in the customer model while creating the order. If false, then the application doesn't create the customer related information if there is no matching customer, site, or contact and order validation will fail. The default value is false.
• SubmitFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application validates and submits the sales order. If false, then the application doesn't validate and submit and the sales order is in the draft status. The default value is false.

{
    "type":"object",
    "properties":{
        "CreateCustomerInformationFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application creates the customer related information even if the customer, site, or contacts don't exist in the customer model while creating the order. If false, then the application doesn't create the customer related information if there is no matching customer, site, or contact and order validation will fail. The default value is false.",
            "nullable":true
        },
        "SubmitFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application validates and submits the sales order. If false, then the application doesn't validate and submit and the sales order is in the draft status. The default value is false.",
            "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 : salesOrdersForOrderHubRequests-orderPreferences-item-response

Type: object

Show Source

• CreateCustomerInformationFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application creates the customer related information even if the customer, site, or contacts don't exist in the customer model while creating the order. If false, then the application doesn't create the customer related information if there is no matching customer, site, or contact and order validation will fail. The default value is false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SubmitFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application validates and submits the sales order. If false, then the application doesn't validate and submit and the sales order is in the draft status. The default value is false.

{
    "type":"object",
    "properties":{
        "CreateCustomerInformationFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application creates the customer related information even if the customer, site, or contacts don't exist in the customer model while creating the order. If false, then the application doesn't create the customer related information if there is no matching customer, site, or contact and order validation will fail. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmitFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application validates and submits the sales order. If false, then the application doesn't validate and submit and the sales order is in the draft status. The default value is false.",
            "nullable":true,
            "x-queryable":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