Jump to

• Request
• Response

Update one subinventory

patch

/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanOrganization/{TransactionId}/child/SubInventory/{SubInventoryUniqID}

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

  Description associated with the subinventory.
• DisableDate: string (date)
  Date when the subinventory is no longer valid.
• IncludeNonNettable: number
  Indicates whether to include nonnettable subinventory.
• InventoryATPCode: number
  Inventory available to promise code.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the plan.
• LastUpdatedBy: string
  Maximum Length: 64

  User who performed the most recent update on the plan.
• LastUpdateLogin: string
  Maximum Length: 32

  Last time the user logged into the system.
• NettingType: integer (int64)
  Identifies the subinventory netting code, which are Nettable inventory and Nonnettable inventory.
• OrganizationId: integer (int64)
  Organization with which the subinventory is associated.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• RefreshNumber: number
  Name of a column on the Collected Measure Data page. This column is populated by the collection program and stores the internal ID of the collection or import process.
• SubInventoryCode: string
  Maximum Length: 10

  Code of the subinventory.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan.",
            "nullable":false
        },
        "IncludeNonNettable":{
            "type":"number",
            "description":"Indicates whether to include nonnettable subinventory.",
            "nullable":true
        },
        "Description":{
            "maxLength":50,
            "type":"string",
            "description":"Description associated with the subinventory.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RefreshNumber":{
            "type":"number",
            "description":"Name of a column on the Collected Measure Data page. This column is populated by the collection program and stores the internal ID of the collection or import process.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization with which the subinventory is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NettingType":{
            "type":"integer",
            "description":"Identifies the subinventory netting code, which are Nettable inventory and Nonnettable inventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubInventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Code of the subinventory.",
            "nullable":false
        },
        "DisableDate":{
            "type":"string",
            "description":"Date when the subinventory is no longer valid.",
            "format":"date",
            "nullable":true
        },
        "InventoryATPCode":{
            "type":"number",
            "description":"Inventory available to promise code.",
            "nullable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan.",
            "format":"date-time",
            "nullable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "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:
  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 : planOptions-PlanOrganization-SubInventory-item-response

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  Name of the user who created the plan subinventory.
• CreationDate: string (date-time)
  Date when the plan subinventory was originally created.
• Description: string
  Maximum Length: 50

  Description associated with the subinventory.
• DisableDate: string (date)
  Date when the subinventory is no longer valid.
• IncludeNonNettable: number
  Indicates whether to include nonnettable subinventory.
• InventoryATPCode: number
  Inventory available to promise code.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the plan.
• LastUpdatedBy: string
  Maximum Length: 64

  User who performed the most recent update on the plan.
• LastUpdateLogin: string
  Maximum Length: 32

  Last time the user logged into the system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NettingType: integer (int64)
  Identifies the subinventory netting code, which are Nettable inventory and Nonnettable inventory.
• OrganizationId: integer (int64)
  Organization with which the subinventory is associated.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• RefreshNumber: number
  Name of a column on the Collected Measure Data page. This column is populated by the collection program and stores the internal ID of the collection or import process.
• SubInventoryCode: string
  Maximum Length: 10

  Code of the subinventory.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the plan subinventory was originally created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "IncludeNonNettable":{
            "type":"number",
            "description":"Indicates whether to include nonnettable subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the plan subinventory.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":50,
            "type":"string",
            "description":"Description associated with the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RefreshNumber":{
            "type":"number",
            "description":"Name of a column on the Collected Measure Data page. This column is populated by the collection program and stores the internal ID of the collection or import process.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization with which the subinventory is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NettingType":{
            "type":"integer",
            "description":"Identifies the subinventory netting code, which are Nettable inventory and Nonnettable inventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubInventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Code of the subinventory.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisableDate":{
            "type":"string",
            "description":"Date when the subinventory is no longer valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryATPCode":{
            "type":"number",
            "description":"Inventory available to promise code.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "nullable":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