Jump to

• Request
• Response

Update one default line for an item-staged transaction

patch

/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/{TransactionDefaultsHeaderId}/child/ItemStagedTransactionDefaultsLine/{TransactionDefaultsLineId}

Request

Path Parameters

• TransactionDefaultsHeaderId(required): integer(int64)
  Value that uniquely identifies the default header of the item-staged transaction. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
• TransactionDefaultsLineId(required): integer(int64)
  Value that uniquely identifies the default line of the item-staged transaction. It's a primary key that the application generates when it creates the item-staged transaction default line.

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

• BatchId: integer (int64)
  Value that identifies the batch in which the record has been loaded into the table.
• DefaultType: string
  Maximum Length: 30

  Value that identifies the transaction type.
• DefaultTypeMeaning: string
  Maximum Length: 80

  Value that identifies the meaning of the transaction type.
• ErrorCode: string
  Maximum Length: 240

  Code that identifies the status of the staged transaction's default lines.
• ErrorExplanation: string
  Maximum Length: 240

  Explanation for the status of the staged transaction's default lines.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item in the inventory organization.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• NewLocatorId: integer (int64)
  Value that uniquely identifies the updated locator.
• NewLocatorName: string
  Maximum Length: 240

  Name of the updated locator in a subinventory where default lines of an item-staged transaction are created in the inventory organization.
• NewSubinventoryCode: string
  Maximum Length: 10

  Name of the updated subinventory where default lines of an item-staged transaction are created in the inventory organization.
• OldLocatorId: integer (int64)
  Value that uniquely identifies the locator prior to the update.
• OldLocatorName: string
  Maximum Length: 240

  Name of the locator in a subinventory prior to an update where default lines for an item-staged transaction are created in the inventory organization.
• OldSubinventoryCode: string
  Maximum Length: 10

  Name of the subinventory prior to the update in which default lines for item-staged transactions are created in the inventory organization.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization that's enabled for the default line of the item-staged transaction.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.
• OrganizationName: string
  Maximum Length: 240

  Name that identifies the inventory organization that's enabled for the default line of the item-staged transaction.
• StatusCode: string
  Maximum Length: 18

  Value that identifies if the status of the default lines of the staged transaction is valid.
• SubDefault: string
  Maximum Length: 11

  Name of the subinventory and locator where default lines for item-staged transactions are created in the inventory organization.
• TransactionDefaultsHeaderId: integer (int64)
  Value that uniquely identifies the item-staged transaction header. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
• TransactionDefaultsLineId: integer (int64)
  Value that uniquely identifies the default line of the item-staged transaction. It's a primary key that the application generates when it creates the item-staged transaction default line.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name that identifies the inventory organization that's enabled for the default line of the item-staged transaction.",
            "nullable":true
        },
        "DefaultType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the transaction type.",
            "nullable":true
        },
        "ErrorExplanation":{
            "maxLength":"240",
            "type":"string",
            "description":"Explanation for the status of the staged transaction's default lines.",
            "nullable":true
        },
        "NewLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the updated locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NewLocatorName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the updated locator in a subinventory where default lines of an item-staged transaction are created in the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ItemNumber",
                    "NewSubinventoryCode",
                    "OrganizationId"
                ]
            }
        },
        "BatchId":{
            "type":"integer",
            "description":"Value that identifies the batch in which the record has been loaded into the table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatusCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Value that identifies if the status of the default lines of the staged transaction is valid.",
            "nullable":true
        },
        "OldLocatorName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the locator in a subinventory prior to an update where default lines for an item-staged transaction are created in the inventory organization.",
            "nullable":true
        },
        "OldSubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory prior to the update in which default lines for item-staged transactions are created in the inventory organization.",
            "nullable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true
        },
        "TransactionDefaultsHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item-staged transaction header. It's a primary key that the application generates when it creates the  default header of the item-staged transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DefaultTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the meaning of the transaction type.",
            "nullable":true
        },
        "SubDefault":{
            "maxLength":"11",
            "type":"string",
            "description":"Name of the subinventory and locator where default lines for item-staged transactions are created in the inventory organization.",
            "nullable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that's enabled for the default line of the item-staged transaction.",
            "nullable":true
        },
        "ErrorCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code that identifies the status of the staged transaction's default lines.",
            "nullable":true
        },
        "OldLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator prior to the update.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NewSubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the updated subinventory where default lines of an item-staged transaction are created in the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ItemNumber",
                    "OrganizationId"
                ]
            }
        },
        "TransactionDefaultsLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default line of the item-staged transaction. It's a primary key that the application generates when it creates the item-staged transaction default line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : itemStagedTransactionDefaults-ItemStagedTransactionDefaultsLine-item-response

Type: object

Show Source

• BatchId: integer (int64)
  Value that identifies the batch in which the record has been loaded into the table.
• DefaultType: string
  Maximum Length: 30

  Value that identifies the transaction type.
• DefaultTypeMeaning: string
  Maximum Length: 80

  Value that identifies the meaning of the transaction type.
• ErrorCode: string
  Maximum Length: 240

  Code that identifies the status of the staged transaction's default lines.
• ErrorExplanation: string
  Maximum Length: 240

  Explanation for the status of the staged transaction's default lines.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item in the inventory organization.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewLocatorId: integer (int64)
  Value that uniquely identifies the updated locator.
• NewLocatorName: string
  Maximum Length: 240

  Name of the updated locator in a subinventory where default lines of an item-staged transaction are created in the inventory organization.
• NewSubinventoryCode: string
  Maximum Length: 10

  Name of the updated subinventory where default lines of an item-staged transaction are created in the inventory organization.
• OldLocatorId: integer (int64)
  Value that uniquely identifies the locator prior to the update.
• OldLocatorName: string
  Maximum Length: 240

  Name of the locator in a subinventory prior to an update where default lines for an item-staged transaction are created in the inventory organization.
• OldSubinventoryCode: string
  Maximum Length: 10

  Name of the subinventory prior to the update in which default lines for item-staged transactions are created in the inventory organization.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization that's enabled for the default line of the item-staged transaction.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.
• OrganizationName: string
  Maximum Length: 240

  Name that identifies the inventory organization that's enabled for the default line of the item-staged transaction.
• StatusCode: string
  Maximum Length: 18

  Value that identifies if the status of the default lines of the staged transaction is valid.
• SubDefault: string
  Maximum Length: 11

  Name of the subinventory and locator where default lines for item-staged transactions are created in the inventory organization.
• TransactionDefaultsHeaderId: integer (int64)
  Value that uniquely identifies the item-staged transaction header. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
• TransactionDefaultsLineId: integer (int64)
  Value that uniquely identifies the default line of the item-staged transaction. It's a primary key that the application generates when it creates the item-staged transaction default line.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name that identifies the inventory organization that's enabled for the default line of the item-staged transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorExplanation":{
            "maxLength":"240",
            "type":"string",
            "description":"Explanation for the status of the staged transaction's default lines.",
            "nullable":true,
            "x-queryable":true
        },
        "NewLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the updated locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NewLocatorName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the updated locator in a subinventory where default lines of an item-staged transaction are created in the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ItemNumber",
                    "NewSubinventoryCode",
                    "OrganizationId"
                ]
            },
            "x-queryable":true
        },
        "BatchId":{
            "type":"integer",
            "description":"Value that identifies the batch in which the record has been loaded into the table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Value that identifies if the status of the default lines of the staged transaction is valid.",
            "nullable":true,
            "x-queryable":true
        },
        "OldLocatorName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the locator in a subinventory prior to an update where default lines for an item-staged transaction are created in the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "OldSubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory prior to the update in which default lines for item-staged transactions are created in the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDefaultsHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item-staged transaction header. It's a primary key that the application generates when it creates the  default header of the item-staged transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DefaultTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the meaning of the transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "SubDefault":{
            "maxLength":"11",
            "type":"string",
            "description":"Name of the subinventory and locator where default lines for item-staged transactions are created in the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization that's enabled for the default line of the item-staged transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ErrorCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Code that identifies the status of the staged transaction's default lines.",
            "nullable":true,
            "x-queryable":true
        },
        "OldLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator prior to the update.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NewSubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the updated subinventory where default lines of an item-staged transaction are created in the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ItemNumber",
                    "OrganizationId"
                ]
            },
            "x-queryable":true
        },
        "TransactionDefaultsLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default line of the item-staged transaction. It's a primary key that the application generates when it creates the item-staged transaction default line.",
            "format":"int64",
            "nullable":false,
            "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."
        }
    }
}

Links

activeLocators

Operation: /fscmRestApi/resources/11.13.18.05/activeLocators

Parameters:

• finder: findByOrganizationSubinventory%3BbindOrgId%3D{OrganizationId}%2CbindSubinventory%3D{NewSubinventoryCode}%2CbindItem%3D{ItemNumber}

List of values that contains details of locators.

The following properties are defined on the LOV link relation:

• Source Attribute: NewLocatorName; Target Attribute: Locator
• Display Attribute: Locator

subinventories

Operation: /fscmRestApi/resources/11.13.18.05/subinventories

Parameters:

• finder: findByOrganizationId%3BBindOrganizationId%3D{OrganizationId}%2CBindItem%3D{ItemNumber}

List of values that contains details of subinventories.

The following properties are defined on the LOV link relation:

• Source Attribute: NewSubinventoryCode; Target Attribute: SecondaryInventoryName
• Display Attribute: SecondaryInventoryName

Back to Top