Jump to

• Request
• Response

Update one inventory slow-moving item record.

patch

/fscmRestApi/resources/11.13.18.05/invSlowMovingItems/{invSlowMovingItemsUniqID}

Request

Path Parameters

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

{
    "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 : invSlowMovingItems-item-response

Type: object

Show Source

• AveragePastConsumption: number
  Read Only: true

  Indicates the average past consumption of inventory for slow-moving items.
• ConsumedQuantity: number
  Read Only: true

  Indicates the consumed quantity for inventory slow-moving items.
• InventoryItemId: integer (int64)
  Read Only: true

  Unique value identifying the inventory item associated with slow-moving item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Value that uniquely identifies the item number for slow-moving items.
• links: array Links
  Title: Links

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

  Maximum Length: 18

  Abbreviation for the inventory organization associated with slow-moving items.
• OrganizationId: integer (int64)
  Read Only: true

  Unique value identifying the inventory organization associated with slow-moving items.
• Period: string
  Read Only: true

  Maximum Length: 255

  Indicates the period associated with slow-moving items.
• PrimaryOnhandQuantity: number
  Read Only: true

  Indicates the consumed quantity for inventory slow-moving items.
• TransactionsCount: number
  Read Only: true

  Indicates the transaction count associated with slow-moving items.

{
    "type":"object",
    "properties":{
        "TransactionsCount":{
            "type":"number",
            "description":"Indicates the transaction count associated with slow-moving items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumedQuantity":{
            "type":"number",
            "description":"Indicates the consumed quantity for inventory slow-moving items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Value that uniquely identifies the item number for slow-moving items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Unique value identifying the inventory item associated with slow-moving item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AveragePastConsumption":{
            "type":"number",
            "description":"Indicates the average past consumption of inventory for slow-moving items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryOnhandQuantity":{
            "type":"number",
            "description":"Indicates the consumed quantity for inventory slow-moving items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation for the inventory organization associated with slow-moving items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Period":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the period associated with slow-moving items.",
            "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"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique value identifying the inventory organization associated with slow-moving items.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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