Jump to

• Request
• Response

Create a pack component

post

/fscmRestApi/resources/11.13.18.05/supplierProducts/{supplierProductsUniqID}/child/packs/{TransactionId}/child/packComponents

Request

Path Parameters

• TransactionId(required): integer(int64)
  Value that uniquely identifies the pack row in staging.
• supplierProductsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Products resource and used to uniquely identify an instance of Supplier Products. The client should not generate the hash key value. Instead, the client should query on the Supplier Products collection resource in order to navigate to a specific instance of Supplier Products to get the hash key.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssemblyItemNumber: string
  Maximum Length: 820

  Number that identifies the parent item of the component item of a pack.
• ComponentItemNumber: string
  Maximum Length: 820

  Number that identifies the component item of a pack.
• ComponentProductDescription: string
  Title: Component Product Description

  Maximum Length: 240

  Spoke item description of the component item of a pack.
• ComponentProductNumber: string
  Title: Component Product Number

  Maximum Length: 255

  Spoke item number of the component item of a pack.
• ComponentQuantity: number
  Quantity of the component item used in the pack.
• ItemTransactionId: integer (int64)
  Value that identifies the product row in staging.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• ParentProductNumber: string
  Title: Parent Product Number

  Maximum Length: 255

  Spoke item number of the parent item of the component item of a pack.
• SpokeSystemCode: string
  Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• SpokeSystemId: integer (int64)
  Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• SupplierName: string
  Title: Supplier

  Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• TransactionId: integer
  Value that uniquely identifies the pack component row in staging.

{
    "type":"object",
    "properties":{
        "AssemblyItemNumber":{
            "maxLength":"820",
            "type":"string",
            "description":"Number that identifies the parent item of the component item of a pack.",
            "nullable":true
        },
        "SpokeSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pack component row in staging.",
            "nullable":false
        },
        "ComponentProductNumber":{
            "title":"Component Product Number",
            "maxLength":"255",
            "type":"string",
            "description":"Spoke item number of the component item of a pack.",
            "nullable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ComponentQuantity":{
            "type":"number",
            "description":"Quantity of the component item used in the pack.",
            "nullable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "type":"string",
            "description":"Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "nullable":true
        },
        "SpokeSystemCode":{
            "type":"string",
            "description":"Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "nullable":true
        },
        "ItemTransactionId":{
            "type":"integer",
            "description":"Value that identifies the product row in staging.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "nullable":true
        },
        "ComponentItemNumber":{
            "maxLength":"820",
            "type":"string",
            "description":"Number that identifies the component item of a pack.",
            "nullable":true
        },
        "ComponentProductDescription":{
            "title":"Component Product Description",
            "maxLength":"240",
            "type":"string",
            "description":"Spoke item description of the component item of a pack.",
            "nullable":true
        },
        "ParentProductNumber":{
            "title":"Parent Product Number",
            "maxLength":"255",
            "type":"string",
            "description":"Spoke item number of the parent item of the component item of a pack.",
            "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 : supplierProducts-packs-packComponents-item-response

Type: object

Show Source

• AssemblyItemNumber: string
  Maximum Length: 820

  Number that identifies the parent item of the component item of a pack.
• ComponentItemNumber: string
  Maximum Length: 820

  Number that identifies the component item of a pack.
• ComponentProductDescription: string
  Title: Component Product Description

  Maximum Length: 240

  Spoke item description of the component item of a pack.
• ComponentProductNumber: string
  Title: Component Product Number

  Maximum Length: 255

  Spoke item number of the component item of a pack.
• ComponentQuantity: number
  Quantity of the component item used in the pack.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the application created the pack component.
• ItemTransactionId: integer (int64)
  Value that identifies the product row in staging.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the pack component was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the pack component.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• ParentProductNumber: string
  Title: Parent Product Number

  Maximum Length: 255

  Spoke item number of the parent item of the component item of a pack.
• SpokeSystemCode: string
  Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• SpokeSystemId: integer (int64)
  Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• SupplierName: string
  Title: Supplier

  Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• TransactionId: integer
  Value that uniquely identifies the pack component row in staging.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the pack component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the application created the pack component.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the pack component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssemblyItemNumber":{
            "maxLength":"820",
            "type":"string",
            "description":"Number that identifies the parent item of the component item of a pack.",
            "nullable":true,
            "x-queryable":true
        },
        "SpokeSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pack component row in staging.",
            "nullable":false,
            "x-queryable":true
        },
        "ComponentProductNumber":{
            "title":"Component Product Number",
            "maxLength":"255",
            "type":"string",
            "description":"Spoke item number of the component item of a pack.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ComponentQuantity":{
            "type":"number",
            "description":"Quantity of the component item used in the pack.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "type":"string",
            "description":"Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "nullable":true,
            "x-queryable":true
        },
        "SpokeSystemCode":{
            "type":"string",
            "description":"Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemTransactionId":{
            "type":"integer",
            "description":"Value that identifies the product row in staging.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ComponentItemNumber":{
            "maxLength":"820",
            "type":"string",
            "description":"Number that identifies the component item of a pack.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentProductDescription":{
            "title":"Component Product Description",
            "maxLength":"240",
            "type":"string",
            "description":"Spoke item description of the component item of a pack.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentProductNumber":{
            "title":"Parent Product Number",
            "maxLength":"255",
            "type":"string",
            "description":"Spoke item number of the parent item of the component item of a pack.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the pack component was most recently updated.",
            "format":"date-time",
            "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