Jump to

• Request
• Response
• Examples

Update one detail

patch

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

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

• AttributeChar1: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the first user descriptive flexfield.
• AttributeChar10: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the tenth user descriptive flexfield.
• AttributeChar11: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the eleventh user descriptive flexfield.
• AttributeChar12: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the twelfth user descriptive flexfield.
• AttributeChar13: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the thirteenth user descriptive flexfield.
• AttributeChar14: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the fourteenth user descriptive flexfield.
• AttributeChar15: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the fifteenth user descriptive flexfield.
• AttributeChar16: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the sixteenth user descriptive flexfield.
• AttributeChar17: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the seventeenth user descriptive flexfield.
• AttributeChar18: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the eighteenth user descriptive flexfield.
• AttributeChar19: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the nineteenth user descriptive flexfield.
• AttributeChar2: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the second user descriptive flexfield.
• AttributeChar20: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the twentieth user descriptive flexfield.
• AttributeChar3: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the third user descriptive flexfield.
• AttributeChar4: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.
• AttributeChar5: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.
• AttributeChar6: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the sixth user descriptive flexfield.
• AttributeChar7: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the seventh user descriptive flexfield.
• AttributeChar8: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the eighth user descriptive flexfield.
• AttributeChar9: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the ninth user descriptive flexfield.
• AttributeDate1: string (date)
  Date that indicates the descriptive flexfield segment of the first user descriptive flexfield.
• AttributeDate2: string (date)
  Date that indicates the descriptive flexfield segment of the second user descriptive flexfield.
• AttributeDate3: string (date)
  Date that indicates the descriptive flexfield segment of the third user descriptive flexfield.
• AttributeDate4: string (date)
  Date that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.
• AttributeDate5: string (date)
  Date that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.
• AttributeNumber1: number
  Number that indicates the descriptive flexfield segment of the first user descriptive flexfield.
• AttributeNumber10: number
  Number that indicates the descriptive flexfield segment of the tenth user descriptive flexfield.
• AttributeNumber2: number
  Number that indicates the descriptive flexfield segment of the second user descriptive flexfield.
• AttributeNumber3: number
  Number that indicates the descriptive flexfield segment of the third user descriptive flexfield.
• AttributeNumber4: number
  Number that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.
• AttributeNumber5: number
  Number that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.
• AttributeNumber6: number
  Number that indicates the descriptive flexfield segment of the sixth user descriptive flexfield.
• AttributeNumber7: number
  Number that indicates the descriptive flexfield segment of the seventh user descriptive flexfield.
• AttributeNumber8: number
  Number that indicates the descriptive flexfield segment of the eighth user descriptive flexfield.
• AttributeNumber9: number
  Number that indicates the descriptive flexfield segment of the ninth user descriptive flexfield.
• AttributeTimestamp1: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the first user descriptive flexfield.
• AttributeTimestamp2: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the second user descriptive flexfield.
• AttributeTimestamp3: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the third user descriptive flexfield.
• AttributeTimestamp4: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.
• AttributeTimestamp5: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.
• ContextCode: string
  Maximum Length: 80

  Abbreviation that identifies the context of the affected object.

{
    "type":"object",
    "properties":{
        "AttributeTimestamp3":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the third user descriptive flexfield.",
            "format":"date-time",
            "nullable":true
        },
        "AttributeTimestamp2":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the second user descriptive flexfield.",
            "format":"date-time",
            "nullable":true
        },
        "AttributeTimestamp5":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.",
            "format":"date-time",
            "nullable":true
        },
        "AttributeTimestamp4":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.",
            "format":"date-time",
            "nullable":true
        },
        "AttributeChar8":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the eighth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar9":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the ninth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar6":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the sixth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar7":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the seventh user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar20":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the twentieth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar4":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar5":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar2":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the second user descriptive flexfield.",
            "nullable":true
        },
        "AttributeTimestamp1":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the first user descriptive flexfield.",
            "format":"date-time",
            "nullable":true
        },
        "AttributeChar3":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the third user descriptive flexfield.",
            "nullable":true
        },
        "AttributeNumber10":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the tenth user descriptive flexfield.",
            "nullable":true
        },
        "ContextCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the context of the affected object.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AttributeChar19":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the nineteenth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar18":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the eighteenth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar17":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the seventeenth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar12":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the twelfth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeNumber8":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the eighth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar11":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the eleventh user descriptive flexfield.",
            "nullable":true
        },
        "AttributeNumber7":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the seventh user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar10":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the tenth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeNumber6":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the sixth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeNumber5":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar16":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the sixteenth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar15":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the fifteenth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar14":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the fourteenth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar13":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the thirteenth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeNumber9":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the ninth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeDate3":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the third user descriptive flexfield.",
            "format":"date",
            "nullable":true
        },
        "AttributeChar1":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the first user descriptive flexfield.",
            "nullable":true
        },
        "AttributeDate2":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the second user descriptive flexfield.",
            "format":"date",
            "nullable":true
        },
        "AttributeDate5":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.",
            "format":"date",
            "nullable":true
        },
        "AttributeDate4":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.",
            "format":"date",
            "nullable":true
        },
        "AttributeNumber4":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.",
            "nullable":true
        },
        "AttributeNumber3":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the third user descriptive flexfield.",
            "nullable":true
        },
        "AttributeNumber2":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the second user descriptive flexfield.",
            "nullable":true
        },
        "AttributeNumber1":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the first user descriptive flexfield.",
            "nullable":true
        },
        "AttributeDate1":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the first user descriptive flexfield.",
            "format":"date",
            "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-additionalInformation-item-response

Type: object

Show Source

• AttributeChar1: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the first user descriptive flexfield.
• AttributeChar10: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the tenth user descriptive flexfield.
• AttributeChar11: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the eleventh user descriptive flexfield.
• AttributeChar12: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the twelfth user descriptive flexfield.
• AttributeChar13: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the thirteenth user descriptive flexfield.
• AttributeChar14: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the fourteenth user descriptive flexfield.
• AttributeChar15: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the fifteenth user descriptive flexfield.
• AttributeChar16: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the sixteenth user descriptive flexfield.
• AttributeChar17: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the seventeenth user descriptive flexfield.
• AttributeChar18: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the eighteenth user descriptive flexfield.
• AttributeChar19: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the nineteenth user descriptive flexfield.
• AttributeChar2: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the second user descriptive flexfield.
• AttributeChar20: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the twentieth user descriptive flexfield.
• AttributeChar3: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the third user descriptive flexfield.
• AttributeChar4: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.
• AttributeChar5: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.
• AttributeChar6: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the sixth user descriptive flexfield.
• AttributeChar7: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the seventh user descriptive flexfield.
• AttributeChar8: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the eighth user descriptive flexfield.
• AttributeChar9: string
  Maximum Length: 150

  Value that indicates the descriptive flexfield segment of the ninth user descriptive flexfield.
• AttributeDate1: string (date)
  Date that indicates the descriptive flexfield segment of the first user descriptive flexfield.
• AttributeDate2: string (date)
  Date that indicates the descriptive flexfield segment of the second user descriptive flexfield.
• AttributeDate3: string (date)
  Date that indicates the descriptive flexfield segment of the third user descriptive flexfield.
• AttributeDate4: string (date)
  Date that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.
• AttributeDate5: string (date)
  Date that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.
• AttributeNumber1: number
  Number that indicates the descriptive flexfield segment of the first user descriptive flexfield.
• AttributeNumber10: number
  Number that indicates the descriptive flexfield segment of the tenth user descriptive flexfield.
• AttributeNumber2: number
  Number that indicates the descriptive flexfield segment of the second user descriptive flexfield.
• AttributeNumber3: number
  Number that indicates the descriptive flexfield segment of the third user descriptive flexfield.
• AttributeNumber4: number
  Number that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.
• AttributeNumber5: number
  Number that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.
• AttributeNumber6: number
  Number that indicates the descriptive flexfield segment of the sixth user descriptive flexfield.
• AttributeNumber7: number
  Number that indicates the descriptive flexfield segment of the seventh user descriptive flexfield.
• AttributeNumber8: number
  Number that indicates the descriptive flexfield segment of the eighth user descriptive flexfield.
• AttributeNumber9: number
  Number that indicates the descriptive flexfield segment of the ninth user descriptive flexfield.
• AttributeTimestamp1: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the first user descriptive flexfield.
• AttributeTimestamp2: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the second user descriptive flexfield.
• AttributeTimestamp3: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the third user descriptive flexfield.
• AttributeTimestamp4: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.
• AttributeTimestamp5: string (date-time)
  Date and time that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.
• ContextCode: string
  Maximum Length: 80

  Abbreviation that identifies the context of the affected object.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AttributeTimestamp3":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the third user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeTimestamp2":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the second user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeTimestamp5":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeTimestamp4":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar8":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the eighth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar9":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the ninth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar6":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the sixth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar7":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the seventh user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar20":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the twentieth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar4":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar5":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar2":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the second user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeTimestamp1":{
            "type":"string",
            "description":"Date and time that indicates the descriptive flexfield segment of the first user descriptive flexfield.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar3":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the third user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeNumber10":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the tenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the context of the affected object.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AttributeChar19":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the nineteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar18":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the eighteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar17":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the seventeenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar12":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the twelfth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber8":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the eighth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar11":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the eleventh user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber7":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the seventh user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar10":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the tenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber6":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the sixth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber5":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar16":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the sixteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar15":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the fifteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar14":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the fourteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar13":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the thirteenth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber9":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the ninth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate3":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the third user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar1":{
            "maxLength":"150",
            "type":"string",
            "description":"Value that indicates the descriptive flexfield segment of the first user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate2":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the second user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate5":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the fifth user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate4":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber4":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the fourth user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber3":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the third user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber2":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the second user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber1":{
            "type":"number",
            "description":"Number that indicates the descriptive flexfield segment of the first user descriptive flexfield.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate1":{
            "type":"string",
            "description":"Date that indicates the descriptive flexfield segment of the first user descriptive flexfield.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 one detail.

Example cURL Command

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

curl -i -X PATCH \
-H "Content-Type:application/json" \
-H "Authorization:Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==" \
-H "REST-Framework-Version:4" \
-H "prefer:return=representation" \
-d \
'request payload' \
'https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/additionalInformation/0004000000115231335F526573745F73746167655F303100000003475052000000135061636B53686970496E737472756374696F6E0000000EACED00057708000001764CC49C2A'

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.

{
	"ContextCode":"HeaderPackShipInstruction",
	"AttributeChar1":"Pack 2 12/10/20 - 2",
	"AttributeChar2":"Ship 2  12/10/20 - 1",
	"AttributeNumber1":13
}

Example Response Body

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

{
	"ContextCode" : "HeaderPackShipInstruction",
	"AttributeChar1" : "Pack 2 12/10/20 - 2",
	"AttributeChar2" : "Ship 2  12/10/20 - 1",
	"AttributeChar3" : null,
	"AttributeChar4" : null,
	"AttributeChar5" : null,
	"AttributeChar6" : null,
	"AttributeChar7" : null,
	"AttributeChar8" : null,
	"AttributeChar9" : null,
	"AttributeChar10" : null,
	"AttributeChar11" : null,
	"AttributeChar12" : null,
	"AttributeChar13" : null,
	"AttributeChar14" : null,
	"AttributeChar15" : null,
	"AttributeChar16" : null,
	"AttributeChar17" : null,
	"AttributeChar18" : null,
	"AttributeChar19" : null,
	"AttributeChar20" : null,
	"AttributeNumber1" : 13,
	"AttributeNumber2" : null,
	"AttributeNumber3" : null,
	"AttributeNumber4" : null,
	"AttributeNumber5" : null,
	"AttributeNumber6" : null,
	"AttributeNumber7" : null,
	"AttributeNumber8" : null,
	"AttributeNumber9" : null,
	"AttributeNumber10" : null,
	"AttributeDate1" : null,
	"AttributeDate2" : null,
	"AttributeDate3" : null,
	"AttributeDate4" : null,
	"AttributeDate5" : null,
	"AttributeTimestamp1" : null,
	"AttributeTimestamp2" : null,
	"AttributeTimestamp3" : null,
	"AttributeTimestamp4" : null,
	"AttributeTimestamp5" : null,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/additionalInformation/0004000000115231335F526573745F73746167655F303100000003475052000000194865616465725061636B53686970496E737472756374696F6E0000000EACED00057708000001764CC49C2A",
		"name" : "additionalInformation",
		"kind" : "item",
		"properties" : {
			"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	}, {
		"rel" : "canonical",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/additionalInformation/0004000000115231335F526573745F73746167655F303100000003475052000000194865616465725061636B53686970496E737472756374696F6E0000000EACED00057708000001764CC49C2A",
		"name" : "additionalInformation",
		"kind" : "item"
	}, {
		"rel" : "parent",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01",
		"name" : "salesOrdersForOrderHubRequests",
		"kind" : "item"
	} ]
}

Back to Top