Jump to

• Request
• Response

Update details of one supplier exception

patch

/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans/{PlanId}/child/SupplierExceptions/{SupplierExceptionsUniqID}

Request

Path Parameters

• PlanId(required): integer
  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=
• SupplierExceptionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId and ExceptionDetailId ---for the Supplier Exceptions resource and used to uniquely identify an instance of Supplier Exceptions. The client should not generate the hash key value. Instead, the client should query on the Supplier Exceptions collection resource with a filter on the primary key values in order to navigate to a specific instance of Supplier Exceptions.
  
  For example: SupplierExceptions?q=PlanId=<value1>;ExceptionDetailId=<value2>

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

• Notes: integer (int64)
  Title: Notes

  Contains information created or updated for an exception detail represented as notes.

{
    "type":"object",
    "properties":{
        "Notes":{
            "title":"Notes",
            "type":"integer",
            "description":"Contains information created or updated for an exception detail represented as notes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : demandAndSupplyPlans-SupplierExceptions-item-response

Type: object

Show Source

• ActionTaken: integer (int64)
  Title: Action Taken

  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
• AdditionalCapacityRequiredByDateOfSupplierCapacityConstraint: number
  Title: Additional Capacity Required by Date of Supplier Capacity Constraint

  Read Only: true

  Additional capacity required by the item supplier and supplier site combination by date of the supplier capacity constraint in the supplier exception.
• AvailableCapacity: number
  Title: Available Capacity

  Read Only: true

  Available capacity of the item supplier and supplier site combination in the supplier exception.
• Category: string
  Title: Category

  Read Only: true

  Maximum Length: 4000

  Category of the item in the supplier exception.
• DateOfSupplierCapacityConstraint: string (date)
  Title: Date of Supplier Capacity Constraint

  Read Only: true

  Date of the supplier capacity constraint in the supplier exception.
• Exception: string
  Title: Exception

  Read Only: true

  Maximum Length: 29

  Name of an exception.
• ExceptionDetailId: integer
  Read Only: true

  Value that uniquely identifies the supplier exception detail.
• ExceptionId: integer
  Read Only: true

  Number that uniquely identifies an exception.
• ExceptionStoreId: integer (int64)
  Read Only: true

  Value that uniquely identifies the stored supplier exception.
• FromDate: string (date)
  Title: From Date

  Read Only: true

  From date of the supplier capacity overload in the supplier exception.
• InventoryItemId: integer
  Read Only: true

  Number that uniquely identifies the item in the supplier exception.
• Item: string
  Title: Item

  Read Only: true

  Maximum Length: 4000

  Name of the item in the supplier exception.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 4000

  Description of the item in the supplier exception.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the exception detail was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the exception detail.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: integer (int64)
  Title: Notes

  Contains information created or updated for an exception detail represented as notes.
• Organization: string
  Title: Organization

  Read Only: true

  Maximum Length: 4000

  Name of the organization of an item for which an exception was calculated by the plan.
• OrganizationId: integer
  Read Only: true

  Value that uniquely identifies the organization of an item in the exception
• OverloadPercent: number
  Title: Overload Percentage

  Read Only: true

  Percentage of supplier capacity overload in the supplier exception.
• PlanId: integer
  Read Only: true

  Value that uniquely identifies the plan in which exception is generated.
• Planner: string
  Title: Planner

  Read Only: true

  Maximum Length: 10

  Name of the planner associated with the item in the exception.
• PlannerDescription: string
  Title: Planner Description

  Read Only: true

  Maximum Length: 4000

  Description of the planner associated with the item in the exception.
• RequiredCapacity: number
  Title: Required Capacity

  Read Only: true

  Required supplier capacity of the item supplier and supplier site combination in the supplier exception.
• StoreKey: string
  Read Only: true

  Maximum Length: 240

  Name of the store key in the supply exception.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 4000

  Name of the supplier in the supplier exception.
• SupplierId: integer
  Read Only: true

  Number that uniquely identifies the supplier in the supplier exception.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 4000

  Name of the supplier site in the supplier exception.
• SupplierSiteId: integer
  Read Only: true

  Number that uniquely identifies the supplier site in the supplier exception.
• ToDate: string (date)
  Title: To Date

  Read Only: true

  To date of the supplier capacity overload in the supplier exception.

{
    "type":"object",
    "properties":{
        "Organization":{
            "title":"Organization",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the organization of an item for which an exception was calculated by the plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":4000,
            "type":"string",
            "description":"Category of the item in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of an item in the exception",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the item in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the item in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredCapacity":{
            "title":"Required Capacity",
            "type":"number",
            "description":"Required supplier capacity of the item supplier and supplier site combination in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Number that uniquely identifies the supplier site in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier exception detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the supplier in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionStoreId":{
            "type":"integer",
            "description":"Value that uniquely identifies the stored supplier exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "type":"integer",
            "description":"Contains information created or updated for an exception detail represented as notes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the exception detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailableCapacity":{
            "title":"Available Capacity",
            "type":"number",
            "description":"Available capacity of the item supplier and supplier site combination in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan in which exception is generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Number that uniquely identifies the item in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalCapacityRequiredByDateOfSupplierCapacityConstraint":{
            "title":"Additional Capacity Required by Date of Supplier Capacity Constraint",
            "type":"number",
            "description":"Additional capacity required by the item supplier and supplier site combination by date of the supplier capacity constraint in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Number that uniquely identifies an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannerDescription":{
            "title":"Planner Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the planner associated with the item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StoreKey":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the store key in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Exception":{
            "title":"Exception",
            "maxLength":29,
            "type":"string",
            "description":"Name of an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Number that uniquely identifies the supplier in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the supplier site in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Planner":{
            "title":"Planner",
            "maxLength":10,
            "type":"string",
            "description":"Name of the planner associated with the item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"From date of the supplier capacity overload in the supplier exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"To date of the supplier capacity overload in the supplier exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfSupplierCapacityConstraint":{
            "title":"Date of Supplier Capacity Constraint",
            "type":"string",
            "description":"Date of the supplier capacity constraint in the supplier exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionTaken":{
            "title":"Action Taken",
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OverloadPercent":{
            "title":"Overload Percentage",
            "type":"number",
            "description":"Percentage of supplier capacity overload in the supplier exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the exception detail was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":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