Jump to

• Request
• Response

PATCH action not supported

patch

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/coveredProductReferences/{coveredProductReferencesUniqID}

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

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : salesOrdersForOrderHub-lines-coveredProductReferences-item-response

Type: object

Show Source

• CoveredFulfillLineId: integer
  Value that uniquely identifies the fulfillment line that fulfills the covered item.
• CoveredItemNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the covered item.
• DisplayLineNumber: string
  Read Only: true

  Maximum Length: 255

  Number that the order management work area displays to identify the order line that contains the covered item.
• HeaderId: integer
  Read Only: true

  Value that uniquely identifies the sales order head that contains the covered item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderNumber: string
  Maximum Length: 150

  Number that identifies the sales order that contains the covered item.
• SourceLineId: string
  Maximum Length: 255

  Value that uniquely identifies the source order line from order capture.
• SourceLineNumber: string
  Maximum Length: 255

  Value that uniquely identifies the transaction in the source application that contains the order line for the covered item.
• SourceOrderId: string
  Maximum Length: 255

  Value that uniquely identifies the source order from order capture.
• SourceOrderNumber: string
  Maximum Length: 255

  Number that identifies the source application that contains the covered item.
• SourceOrderSystem: string
  Maximum Length: 255

  Value that references to the order capture application that the source order came from.

{
    "type":"object",
    "properties":{
        "CoveredFulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fulfillment line that fulfills the covered item.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the covered item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that the order management work area displays to identify the order line that contains the covered item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order head that contains the covered item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the sales order that contains the covered item.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLineId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the source order line from order capture.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLineNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the transaction in the source application that contains the order line for the covered item.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrderId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the source order from order capture.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the source application that contains the covered item.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrderSystem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that references to the order capture application that the source order came from.",
            "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