Jump to

• Request
• Response

Update an item

patch

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/items/{itemsUniqID}

Request

Path Parameters

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

• ApplySupplyToleranceFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then apply supply tolerance on the inventory item. If N, then don't apply supply tolerance on the inventory item. This attribute doesn't have a default value.
• ConsumptionTime: number
  Target time of consumption of the inventory item.
• ConsumptionTimeUnit: string
  Maximum Length: 30

  Time unit of consumption. Valid values include seconds, minutes, hours, days, shifts, weeks, and months.
• Description: string
  Maximum Length: 500

  Description of the production schedule.
• EarliestShortageConsumeDate: string (date-time)
  Value that indicates the earliest date when the item is available if a work order operation is short of supply.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• ItemCode: string
  Maximum Length: 300

  Abbreviation that identifies the item.
• ItemType: string
  Maximum Length: 30

  Type of item. Valid values include Manufactured, Purchased, and Both.
• LeadTimeDays: number
  Value that indicates the lead time of the Make or Buy items.
• LeadTimeOverrideDays: number
  Value that indicates the lead time of the make or buy items. This attribute overrides the lead time value that??s inherited from the LeadTimeDays attribute.
• MaximumLevel: number
  Maximum level of the inventory item.
• MinimumLevel: number
  Minimum level of the inventory item.
• onHoldLots: array On Hold Lots
  Title: On Hold Lots

  The On Hold Lots resource manages the on-hand inventory that's on hold.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• PlanningMakeBuyValue: string
  Maximum Length: 80

  Value that indicates whether the item is a manufactured item or a purchased item. Valid values are Make and Buy.
• Precision: integer (int64)
  Display precision of the inventory item.
• RebuildableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the item is rebuildable. If N, then the item isn't rebuildable. This attribute doesn't have a default value.
• ReceivingCalendarId: integer (int64)
  Value that uniquely identifies the receiving calendar.
• RelaxedMaximumLevelFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then relax the maximum value. If N, then don't relax the maximum value. This attribute doesn't have a default value.
• RelaxedMinimumLevelFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then relax the minimum value. If N, then don't relax the minimum value. This attribute doesn't have a default value.
• SaleableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the item is available for sale. If N, then the item isn't available for sale. This attribute doesn't have a default value.
• ShortageQuantity: number
  The amount that the item is short for the plan.
• StartLevel: number
  Start level of on-hand inventory item.
• TotalOnHandReservedQuantity: number
  Total amount reserved to on-hand inventory.
• UnitOfMeasure: string
  Maximum Length: 25

  Name of the unit of measure.
• UOMCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure.
• UseConsumptionTimeFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then use consumption time. If N, then don't use consumption time. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "ApplySupplyToleranceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then apply supply tolerance on the inventory item. If N, then don't apply supply tolerance on the inventory item. This attribute doesn't have a default value.",
            "nullable":true
        },
        "ConsumptionTime":{
            "type":"number",
            "description":"Target time of consumption of the inventory item.",
            "nullable":true
        },
        "ConsumptionTimeUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Time unit of consumption. Valid values include seconds, minutes, hours, days, shifts, weeks, and months.",
            "nullable":true
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"Description of the production schedule.",
            "nullable":true
        },
        "EarliestShortageConsumeDate":{
            "type":"string",
            "description":"Value that indicates the earliest date when the item is available if a work order operation is short of supply.",
            "format":"date-time",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the item.",
            "nullable":false
        },
        "ItemType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of item. Valid values include Manufactured, Purchased, and Both.",
            "nullable":false
        },
        "LeadTimeDays":{
            "type":"number",
            "description":"Value that indicates the lead time of the Make or Buy items.",
            "nullable":true
        },
        "LeadTimeOverrideDays":{
            "type":"number",
            "description":"Value that indicates the lead time of the make or buy items. This attribute overrides the lead time value that??s inherited from the LeadTimeDays attribute.",
            "nullable":true
        },
        "MaximumLevel":{
            "type":"number",
            "description":"Maximum level of the inventory item.",
            "nullable":true
        },
        "MinimumLevel":{
            "type":"number",
            "description":"Minimum level of the inventory item.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningMakeBuyValue":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates whether the item is a manufactured item or a purchased item. Valid values are Make and Buy.",
            "nullable":true
        },
        "Precision":{
            "type":"integer",
            "description":"Display precision of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "RebuildableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the item is rebuildable. If N, then the item isn't rebuildable. This attribute doesn't have a default value.",
            "nullable":true
        },
        "ReceivingCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelaxedMaximumLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then relax the maximum value. If N, then don't relax the maximum value. This attribute doesn't have a default value.",
            "nullable":true
        },
        "RelaxedMinimumLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then relax the minimum value. If N, then don't relax the minimum value. This attribute doesn't have a default value.",
            "nullable":true
        },
        "SaleableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the item is available for sale. If N, then the item isn't available for sale. This attribute doesn't have a default value.",
            "nullable":false
        },
        "ShortageQuantity":{
            "type":"number",
            "description":"The amount that the item is short for the plan.",
            "nullable":true
        },
        "StartLevel":{
            "type":"number",
            "description":"Start level of on-hand inventory item.",
            "nullable":true
        },
        "TotalOnHandReservedQuantity":{
            "type":"number",
            "description":"Total amount reserved to on-hand inventory.",
            "nullable":true
        },
        "UOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true
        },
        "UseConsumptionTimeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then use consumption time. If N, then don't use consumption time. This attribute doesn't have a default value.",
            "nullable":true
        },
        "onHoldLots":{
            "title":"On Hold Lots",
            "type":"array",
            "description":"The On Hold Lots resource manages the on-hand inventory that's on hold.",
            "items":{
                "$ref":"#/components/schemas/productionSchedulingPlans-items-onHoldLots-item-patch-request"
            }
        }
    }
}

Nested Schema : On Hold Lots

Type: array

Title: On Hold Lots

The On Hold Lots resource manages the on-hand inventory that's on hold.

Show Source

• Array of: object productionSchedulingPlans-items-onHoldLots-item-patch-request

{
    "title":"On Hold Lots",
    "type":"array",
    "description":"The On Hold Lots resource manages the on-hand inventory that's on hold.",
    "items":{
        "$ref":"#/components/schemas/productionSchedulingPlans-items-onHoldLots-item-patch-request"
    }
}

Nested Schema : productionSchedulingPlans-items-onHoldLots-item-patch-request

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 : productionSchedulingPlans-items-item-response

Type: object

Show Source

• ApplySupplyToleranceFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then apply supply tolerance on the inventory item. If N, then don't apply supply tolerance on the inventory item. This attribute doesn't have a default value.
• ConsumptionTime: number
  Target time of consumption of the inventory item.
• ConsumptionTimeUnit: string
  Maximum Length: 30

  Time unit of consumption. Valid values include seconds, minutes, hours, days, shifts, weeks, and months.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• Description: string
  Maximum Length: 500

  Description of the production schedule.
• EarliestShortageConsumeDate: string (date-time)
  Value that indicates the earliest date when the item is available if a work order operation is short of supply.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• ItemCode: string
  Maximum Length: 300

  Abbreviation that identifies the item.
• ItemType: string
  Maximum Length: 30

  Type of item. Valid values include Manufactured, Purchased, and Both.
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• LeadTimeDays: number
  Value that indicates the lead time of the Make or Buy items.
• LeadTimeOverrideDays: number
  Value that indicates the lead time of the make or buy items. This attribute overrides the lead time value that??s inherited from the LeadTimeDays attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumLevel: number
  Maximum level of the inventory item.
• MinimumLevel: number
  Minimum level of the inventory item.
• onHoldLots: array On Hold Lots
  Title: On Hold Lots

  The On Hold Lots resource manages the on-hand inventory that's on hold.
• OnHoldQuantity: number
  Read Only: true

  The quantity of the lot that's on hold.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• PlanningMakeBuyValue: string
  Maximum Length: 80

  Value that indicates whether the item is a manufactured item or a purchased item. Valid values are Make and Buy.
• Precision: integer (int64)
  Display precision of the inventory item.
• RebuildableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the item is rebuildable. If N, then the item isn't rebuildable. This attribute doesn't have a default value.
• ReceivingCalendarId: integer (int64)
  Value that uniquely identifies the receiving calendar.
• RelaxedMaximumLevelFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then relax the maximum value. If N, then don't relax the maximum value. This attribute doesn't have a default value.
• RelaxedMinimumLevelFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then relax the minimum value. If N, then don't relax the minimum value. This attribute doesn't have a default value.
• SaleableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the item is available for sale. If N, then the item isn't available for sale. This attribute doesn't have a default value.
• ShortageQuantity: number
  The amount that the item is short for the plan.
• StartLevel: number
  Start level of on-hand inventory item.
• TotalOnHandReservedQuantity: number
  Total amount reserved to on-hand inventory.
• UnitOfMeasure: string
  Maximum Length: 25

  Name of the unit of measure.
• UOMCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure.
• UseConsumptionTimeFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then use consumption time. If N, then don't use consumption time. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "ApplySupplyToleranceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then apply supply tolerance on the inventory item. If N, then don't apply supply tolerance on the inventory item. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "ConsumptionTime":{
            "type":"number",
            "description":"Target time of consumption of the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "ConsumptionTimeUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Time unit of consumption. Valid values include seconds, minutes, hours, days, shifts, weeks, and months.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"Description of the production schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "EarliestShortageConsumeDate":{
            "type":"string",
            "description":"Value that indicates the earliest date when the item is available if a work order operation is short of supply.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the item.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of item. Valid values include Manufactured, Purchased, and Both.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadTimeDays":{
            "type":"number",
            "description":"Value that indicates the lead time of the Make or Buy items.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadTimeOverrideDays":{
            "type":"number",
            "description":"Value that indicates the lead time of the make or buy items. This attribute overrides the lead time value that??s inherited from the LeadTimeDays attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumLevel":{
            "type":"number",
            "description":"Maximum level of the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumLevel":{
            "type":"number",
            "description":"Minimum level of the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "OnHoldQuantity":{
            "type":"number",
            "description":"The quantity of the lot that's on hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningMakeBuyValue":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates whether the item is a manufactured item or a purchased item. Valid values are Make and Buy.",
            "nullable":true,
            "x-queryable":true
        },
        "Precision":{
            "type":"integer",
            "description":"Display precision of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "RebuildableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the item is rebuildable. If N, then the item isn't rebuildable. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceivingCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelaxedMaximumLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then relax the maximum value. If N, then don't relax the maximum value. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "RelaxedMinimumLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then relax the minimum value. If N, then don't relax the minimum value. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "SaleableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the item is available for sale. If N, then the item isn't available for sale. This attribute doesn't have a default value.",
            "nullable":false,
            "x-queryable":true
        },
        "ShortageQuantity":{
            "type":"number",
            "description":"The amount that the item is short for the plan.",
            "nullable":true,
            "x-queryable":true
        },
        "StartLevel":{
            "type":"number",
            "description":"Start level of on-hand inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalOnHandReservedQuantity":{
            "type":"number",
            "description":"Total amount reserved to on-hand inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "UseConsumptionTimeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then use consumption time. If N, then don't use consumption time. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "onHoldLots":{
            "title":"On Hold Lots",
            "type":"array",
            "description":"The On Hold Lots resource manages the on-hand inventory that's on hold.",
            "items":{
                "$ref":"#/components/schemas/productionSchedulingPlans-items-onHoldLots-item-response"
            }
        }
    }
}

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 : On Hold Lots

Type: array

Title: On Hold Lots

The On Hold Lots resource manages the on-hand inventory that's on hold.

Show Source

• Array of: object productionSchedulingPlans-items-onHoldLots-item-response

{
    "title":"On Hold Lots",
    "type":"array",
    "description":"The On Hold Lots resource manages the on-hand inventory that's on hold.",
    "items":{
        "$ref":"#/components/schemas/productionSchedulingPlans-items-onHoldLots-item-response"
    }
}

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

Nested Schema : productionSchedulingPlans-items-onHoldLots-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• Description: string
  Read Only: true

  Maximum Length: 500

  Description of the on-hold lot.
• HoldDate: string (date-time)
  Read Only: true

  Date when the hold expires.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory item.
• ItemCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotNumber: string
  Read Only: true

  Maximum Length: 80

  Number that identifies the inventory lot.
• OnHoldQuantity: number
  Read Only: true

  The quantity of the lot that's on hold.
• PlanId: integer (int64)
  Read Only: true

  Value that uniquely identifies the production schedule.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure.
• UOMCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"Description of the on-hold lot.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldDate":{
            "type":"string",
            "description":"Date when the hold expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the inventory lot.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OnHoldQuantity":{
            "type":"number",
            "description":"The quantity of the lot that's on hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "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"
            }
        }
    }
}

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

Links

onHoldLots

Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/items/{itemsUniqID}/child/onHoldLots

Parameters:

• PlanId: $request.path.PlanId
• itemsUniqID: $request.path.itemsUniqID

The On Hold Lots resource manages the on-hand inventory that's on hold.

Back to Top