Jump to

• Request
• Response

Update an item parameter

patch

/fscmRestApi/resources/11.13.18.05/productionSchedulingOrganizations/{OrganizationId}/child/itemParameters/{itemParametersUniqID}

Request

Path Parameters

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

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

• ApplySupplyToleranceFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then apply supply tolerance to the inventory item. If false, then don't apply supply tolerance to the inventory item. This attribute doesn't have a default value.
• ConsumptionTime: number
  Consumption time target of the inventory item.
• ConsumptionTimeUnit: string
  Maximum Length: 30

  Time unit of measure for the consumption time. The format is seconds|minutes|hours|days|shifts|weeks|months.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the part, item, or product.
• ItemCode: string
  Maximum Length: 300

  Abbreviation that identifies the part, item, or product.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
• RelaxedMaximumLevelFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then maintain maximum level of the inventory item. If false, then don't maintain maximum level of the inventory item. This attribute doesn't have a default value.
• RelaxedMinimumLevelFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then maintain minimum level of the inventory item. If false, then don't maintain minimum level of the inventory item. This attribute doesn't have a default value.
• UseConsumptionTimeFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the item should have a consumption time target for scheduling. If false, then the item should not have a consumption time target for scheduling. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "RelaxedMaximumLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then maintain maximum level of the inventory item. If false, then don't maintain maximum level of the inventory item. This attribute doesn't have a default value.",
            "nullable":true
        },
        "RelaxedMinimumLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then maintain minimum level of the inventory item. If false, then don't maintain minimum level of the inventory item. This attribute doesn't have a default value.",
            "nullable":true
        },
        "ItemCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the part, item, or product.",
            "nullable":false
        },
        "ConsumptionTimeUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Time unit of measure for the consumption time. The format is seconds|minutes|hours|days|shifts|weeks|months.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the part, item, or product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UseConsumptionTimeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item should have a consumption time target for scheduling. If false, then the item should not have a consumption time target for scheduling. This attribute doesn't have a default value.",
            "nullable":true
        },
        "ApplySupplyToleranceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then apply supply tolerance to the inventory item. If false, then don't apply supply tolerance to the inventory item. This attribute doesn't have a default value.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ConsumptionTime":{
            "type":"number",
            "description":"Consumption time target of the inventory item.",
            "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(required):
  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(required):
  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 : productionSchedulingOrganizations-itemParameters-item-response

Type: object

Show Source

• ApplySupplyToleranceFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then apply supply tolerance to the inventory item. If false, then don't apply supply tolerance to the inventory item. This attribute doesn't have a default value.
• ConsumptionTime: number
  Consumption time target of the inventory item.
• ConsumptionTimeUnit: string
  Maximum Length: 30

  Time unit of measure for the consumption time. The format is seconds|minutes|hours|days|shifts|weeks|months.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• InventoryItemId: integer (int64)
  Value that uniquely identifies the part, item, or product.
• ItemCode: string
  Maximum Length: 300

  Abbreviation that identifies the part, item, or product.
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

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

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
• RelaxedMaximumLevelFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then maintain maximum level of the inventory item. If false, then don't maintain maximum level of the inventory item. This attribute doesn't have a default value.
• RelaxedMinimumLevelFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then maintain minimum level of the inventory item. If false, then don't maintain minimum level of the inventory item. This attribute doesn't have a default value.
• UseConsumptionTimeFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the item should have a consumption time target for scheduling. If false, then the item should not have a consumption time target for scheduling. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelaxedMaximumLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then maintain maximum level of the inventory item. If false, then don't maintain maximum level of the inventory item. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelaxedMinimumLevelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then maintain minimum level of the inventory item. If false, then don't maintain minimum level of the inventory item. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the part, item, or product.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the part, item, or product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UseConsumptionTimeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item should have a consumption time target for scheduling. If false, then the item should not have a consumption time target for scheduling. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConsumptionTime":{
            "type":"number",
            "description":"Consumption time target of the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "ConsumptionTimeUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Time unit of measure for the consumption time. The format is seconds|minutes|hours|days|shifts|weeks|months.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplySupplyToleranceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then apply supply tolerance to the inventory item. If false, then don't apply supply tolerance to the inventory item. 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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":false,
            "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