Jump to

• Request
• Response

Update one item status

patch

/fscmRestApi/resources/11.13.18.05/itemStatuses/{InventoryItemStatusId}

Request

Path Parameters

• InventoryItemStatusId(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=

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

• Description: string
  Title: Description

  Maximum Length: 240

  Description of the item status.
• DisableDate: string (date)
  Title: Inactive Date

  Disable date of the item status.
• InventoryItemStatusName: string
  Title: Item Status

  Maximum Length: 240

  Name of the status.
• StatusAttributeValue: array Item Status Attribute Values
  Title: Item Status Attribute Values

  The value and usage of an item operational attribute for an item status. For example, if an item status is active, then the customer orderable attribute is set to true.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item status.",
            "nullable":true
        },
        "DisableDate":{
            "title":"Inactive Date",
            "type":"string",
            "description":"Disable date of the item status.",
            "format":"date",
            "nullable":true
        },
        "InventoryItemStatusName":{
            "title":"Item Status",
            "maxLength":240,
            "type":"string",
            "description":"Name of the status.",
            "nullable":false
        },
        "StatusAttributeValue":{
            "title":"Item Status Attribute Values",
            "type":"array",
            "description":"The value and usage of an item operational attribute for an item status. For example, if an item status is active, then the customer orderable attribute is set to true.",
            "items":{
                "$ref":"#/components/schemas/itemStatuses-StatusAttributeValue-item-patch-request"
            }
        }
    }
}

Nested Schema : Item Status Attribute Values

Type: array

Title: Item Status Attribute Values

The value and usage of an item operational attribute for an item status. For example, if an item status is active, then the customer orderable attribute is set to true.

Show Source

• Array of: object itemStatuses-StatusAttributeValue-item-patch-request

{
    "title":"Item Status Attribute Values",
    "type":"array",
    "description":"The value and usage of an item operational attribute for an item status. For example, if an item status is active, then the customer orderable attribute is set to true.",
    "items":{
        "$ref":"#/components/schemas/itemStatuses-StatusAttributeValue-item-patch-request"
    }
}

Nested Schema : itemStatuses-StatusAttributeValue-item-patch-request

Type: object

Show Source

• AttributeValue: string
  Maximum Length: 1

  Default Value: 0

  Indicates the value of the attribute for an item status.
• StatusControl: string
  Maximum Length: 255

  Uniquely identifies the control code for an item status.

{
    "type":"object",
    "properties":{
        "AttributeValue":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the value of the attribute for an item status.",
            "nullable":false,
            "default":"0"
        },
        "StatusControl":{
            "maxLength":255,
            "type":"string",
            "description":"Uniquely identifies the control code for an item status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : itemStatuses-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user that created the item status.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the item status.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the item status.
• DisableDate: string (date)
  Title: Inactive Date

  Disable date of the item status.
• InventoryItemStatusCode: string
  Title: Status Code

  Maximum Length: 10

  Uniquely identities the item status.
• InventoryItemStatusId: integer (int64)
  Value that uniquely identifies the status.
• InventoryItemStatusName: string
  Title: Item Status

  Maximum Length: 240

  Name of the status.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user updated the item status.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the item status.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Uniquely identifies the user who last updated the item status.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StatusAttributeValue: array Item Status Attribute Values
  Title: Item Status Attribute Values

  The value and usage of an item operational attribute for an item status. For example, if an item status is active, then the customer orderable attribute is set to true.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user that created the item status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the item status.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item status.",
            "nullable":true,
            "x-queryable":true
        },
        "DisableDate":{
            "title":"Inactive Date",
            "type":"string",
            "description":"Disable date of the item status.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemStatusCode":{
            "title":"Status Code",
            "maxLength":10,
            "type":"string",
            "description":"Uniquely identities the item status.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemStatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemStatusName":{
            "title":"Item Status",
            "maxLength":240,
            "type":"string",
            "description":"Name of the status.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user updated the item status.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Uniquely identifies the user who last updated the item status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the item status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusAttributeValue":{
            "title":"Item Status Attribute Values",
            "type":"array",
            "description":"The value and usage of an item operational attribute for an item status. For example, if an item status is active, then the customer orderable attribute is set to true.",
            "items":{
                "$ref":"#/components/schemas/itemStatuses-StatusAttributeValue-item-response"
            }
        },
        "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 : Item Status Attribute Values

Type: array

Title: Item Status Attribute Values

The value and usage of an item operational attribute for an item status. For example, if an item status is active, then the customer orderable attribute is set to true.

Show Source

• Array of: object itemStatuses-StatusAttributeValue-item-response

{
    "title":"Item Status Attribute Values",
    "type":"array",
    "description":"The value and usage of an item operational attribute for an item status. For example, if an item status is active, then the customer orderable attribute is set to true.",
    "items":{
        "$ref":"#/components/schemas/itemStatuses-StatusAttributeValue-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 : itemStatuses-StatusAttributeValue-item-response

Type: object

Show Source

• AttributeName: string
  Maximum Length: 50

  Uniquely identifies the name of the attribute for the item status.
• AttributeValue: string
  Maximum Length: 1

  Default Value: 0

  Indicates the value of the attribute for an item status.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who provided the item attribute value for an item status.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user provided the item attribute value for an item status.
• InventoryItemStatusCode: string
  Title: Status Code

  Maximum Length: 10

  Indicates the name of the attribute for an item status.
• InventoryItemStatusId: integer (int64)
  Indicates the name of the attribute for the item status.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user updated the item status.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the item status.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StatusControl: string
  Maximum Length: 255

  Uniquely identifies the control code for an item status.

{
    "type":"object",
    "properties":{
        "AttributeName":{
            "maxLength":50,
            "type":"string",
            "description":"Uniquely identifies the name of the attribute for the item status.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeValue":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the value of the attribute for an item status.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who provided the item attribute value for an item status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user provided the item attribute value for an item status.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemStatusCode":{
            "title":"Status Code",
            "maxLength":10,
            "type":"string",
            "description":"Indicates the name of the attribute for an item status.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemStatusId":{
            "type":"integer",
            "description":"Indicates the name of the attribute for the item status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user updated the item status.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the item status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusControl":{
            "maxLength":255,
            "type":"string",
            "description":"Uniquely identifies the control code for an item status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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

StatusAttributeValue

Operation: /fscmRestApi/resources/11.13.18.05/itemStatuses/{InventoryItemStatusId}/child/StatusAttributeValue

Parameters:

• InventoryItemStatusId: $request.path.InventoryItemStatusId

The value and usage of an item operational attribute for an item status. For example, if an item status is active, then the customer orderable attribute is set to true.

Back to Top