Jump to

• Request
• Response

Create details

post

/fscmRestApi/resources/11.13.18.05/operationTransactions/{operationTransactionsUniqID}/child/OperationTransactionDetail/{OperationTransactionDetailUniqID}/child/MaterialTransactionDetail

Request

Path Parameters

• OperationTransactionDetailUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Operation Transaction Details resource and used to uniquely identify an instance of Operation Transaction Details. The client should not generate the hash key value. Instead, the client should query on the Operation Transaction Details collection resource in order to navigate to a specific instance of Operation Transaction Details to get the hash key.
• operationTransactionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Order Operation Transactions resource and used to uniquely identify an instance of Work Order Operation Transactions. The client should not generate the hash key value. Instead, the client should query on the Work Order Operation Transactions collection resource in order to navigate to a specific instance of Work Order Operation Transactions 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CountryOfOriginCode: string
  Maximum Length: 2

  Abbreviation that identifies the country of origin of the material.
• InventoryItemNumber: string
  Maximum Length: 300

  Number that identifies the component.
• ItemRevision: string
  Maximum Length: 18

  Revision of the component issued.
• Locator: string
  Maximum Length: 255

  Locator where the material is issued from or returned to.
• MaterialTransactionLot: array Material Transaction Lots
  Title: Material Transaction Lots

  Lot of the component issued to or returned from a work order during an operation transaction.
• MaterialTransactionSerial: array Material Transaction Serials
  Title: Material Transaction Serials

  Serial of the component issued to or returned from a work order during an operation transaction.
• SecondaryTransactionQuantity: number
  Secondary quantity of the material transacted for the work order.
• SubinventoryCode: string
  Maximum Length: 18

  Abbreviation that identifies the subinventory to issue the component.
• TransactionQuantity(required): number
  Quantity of the material issued.
• TransactionUnitOfMeasure: string
  Maximum Length: 25

  Unit of measure to use when reporting the transacted quantity.
• TransactionUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the transacted quantity.
• UseCommonInventoryFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then material should be issued from or returned to the common inventory. If false, then material should be issued from or returned to the project associated with the work order. This attribute doesn't have a default value. This attribute is associated with a feature that requires opt in.
• WoOperationSequenceNumber: number
  Operation sequence number of the work order. The application issues the component according to this sequence.

{
    "required":[
        "TransactionQuantity"
    ],
    "type":"object",
    "properties":{
        "InventoryItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the component.",
            "nullable":true
        },
        "TransactionUnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure to use when reporting the transacted quantity.",
            "nullable":true
        },
        "MaterialTransactionSerial":{
            "title":"Material Transaction Serials",
            "type":"array",
            "description":"Serial of the component issued to or returned from a work order during an operation transaction.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionSerial-item-post-request"
            }
        },
        "SubinventoryCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the subinventory to issue the component.",
            "nullable":true
        },
        "UseCommonInventoryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then material should be issued from or returned to the common inventory. If false, then material should be issued from or returned to the project associated with the work order. This attribute doesn't have a default value. This attribute is associated with a feature that requires opt in.",
            "nullable":true
        },
        "MaterialTransactionLot":{
            "title":"Material Transaction Lots",
            "type":"array",
            "description":"Lot of the component issued to or returned from a work order during an operation transaction.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionLot-item-post-request"
            }
        },
        "Locator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator where the material is issued from or returned to.",
            "nullable":true
        },
        "CountryOfOriginCode":{
            "maxLength":"2",
            "type":"string",
            "description":"Abbreviation that identifies the country of origin of the material.",
            "nullable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"Quantity of the material issued.",
            "nullable":false
        },
        "TransactionUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the transacted quantity.",
            "nullable":true
        },
        "SecondaryTransactionQuantity":{
            "type":"number",
            "description":"Secondary quantity of the material transacted for the work order.",
            "nullable":true
        },
        "WoOperationSequenceNumber":{
            "type":"number",
            "description":"Operation sequence number of the work order. The application issues the component according to this sequence.",
            "nullable":true
        },
        "ItemRevision":{
            "maxLength":"18",
            "type":"string",
            "description":"Revision of the component issued.",
            "nullable":true
        }
    }
}

Nested Schema : Material Transaction Lots

Type: array

Title: Material Transaction Lots

Lot of the component issued to or returned from a work order during an operation transaction.

Show Source

• Array of: object schema

{
    "title":"Material Transaction Lots",
    "type":"array",
    "description":"Lot of the component issued to or returned from a work order during an operation transaction.",
    "items":{
        "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionLot-item-post-request"
    }
}

Nested Schema : Material Transaction Serials

Type: array

Title: Material Transaction Serials

Serial of the component issued to or returned from a work order during an operation transaction.

Show Source

• Array of: object operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionSerial-item-post-request

{
    "title":"Material Transaction Serials",
    "type":"array",
    "description":"Serial of the component issued to or returned from a work order during an operation transaction.",
    "items":{
        "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionSerial-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• LotNumber: string
  Title: Lot Number

  Maximum Length: 80

  Lot number of the component issued.
• SecondaryTransactionQuantity: number
  Secondary quantity of the material lot transacted for the work order.
• TransactionQuantity: number
  Title: Transaction Quantity

  Quantity of the material lot transacted for the work order.

{
    "type":"object",
    "properties":{
        "SecondaryTransactionQuantity":{
            "type":"number",
            "description":"Secondary quantity of the material lot transacted for the work order.",
            "nullable":true
        },
        "TransactionQuantity":{
            "title":"Transaction Quantity",
            "type":"number",
            "description":"Quantity of the material lot transacted for the work order.",
            "nullable":false
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Lot number of the component issued.",
            "nullable":false
        }
    }
}

Nested Schema : operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionSerial-item-post-request

Type: object

Show Source

• LotNumber: string
  Title: Lot Number

  Maximum Length: 80

  Lot number of the serial for the component issued to the product.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Starting serial number of the component issued during an operation transaction.
• SerialNumberTo: string
  Maximum Length: 80

  Ending serial number of the component issued during operation transaction.

{
    "type":"object",
    "properties":{
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Starting serial number of the component issued during an operation transaction.",
            "nullable":false
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Lot number of the serial for the component issued to the product.",
            "nullable":true
        },
        "SerialNumberTo":{
            "maxLength":"80",
            "type":"string",
            "description":"Ending serial number of the component issued during operation transaction.",
            "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 : operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-item-response

Type: object

Show Source

• CountryOfOriginCode: string
  Maximum Length: 2

  Abbreviation that identifies the country of origin of the material.
• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Name of the error message, if any, when processing the component issue in an operation transaction.
• ErrorMessages: string
  Read Only: true

  Maximum Length: 255

  Text of the error message, if any, when processing the component issue in an operation transaction.
• InventoryItemNumber: string
  Maximum Length: 300

  Number that identifies the component.
• ItemRevision: string
  Maximum Length: 18

  Revision of the component issued.
• links: array Links
  Title: Links

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

  Locator where the material is issued from or returned to.
• MaterialTransactionLot: array Material Transaction Lots
  Title: Material Transaction Lots

  Lot of the component issued to or returned from a work order during an operation transaction.
• MaterialTransactionSerial: array Material Transaction Serials
  Title: Material Transaction Serials

  Serial of the component issued to or returned from a work order during an operation transaction.
• SecondaryTransactionQuantity: number
  Secondary quantity of the material transacted for the work order.
• SubinventoryCode: string
  Maximum Length: 18

  Abbreviation that identifies the subinventory to issue the component.
• TransactionQuantity: number
  Quantity of the material issued.
• TransactionUnitOfMeasure: string
  Maximum Length: 25

  Unit of measure to use when reporting the transacted quantity.
• TransactionUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the transacted quantity.
• UseCommonInventoryFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then material should be issued from or returned to the common inventory. If false, then material should be issued from or returned to the project associated with the work order. This attribute doesn't have a default value. This attribute is associated with a feature that requires opt in.
• WoOperationSequenceNumber: number
  Operation sequence number of the work order. The application issues the component according to this sequence.

{
    "type":"object",
    "properties":{
        "InventoryItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the component.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the error message, if any, when processing the component issue in an operation transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionUnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure to use when reporting the transacted quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "MaterialTransactionSerial":{
            "title":"Material Transaction Serials",
            "type":"array",
            "description":"Serial of the component issued to or returned from a work order during an operation transaction.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionSerial-item-response"
            }
        },
        "SubinventoryCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the subinventory to issue the component.",
            "nullable":true,
            "x-queryable":true
        },
        "UseCommonInventoryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then material should be issued from or returned to the common inventory. If false, then material should be issued from or returned to the project associated with the work order. This attribute doesn't have a default value. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "MaterialTransactionLot":{
            "title":"Material Transaction Lots",
            "type":"array",
            "description":"Lot of the component issued to or returned from a work order during an operation transaction.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionLot-item-response"
            }
        },
        "ErrorMessages":{
            "maxLength":"255",
            "type":"string",
            "description":"Text of the error message, if any, when processing the component issue in an operation transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator where the material is issued from or returned to.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryOfOriginCode":{
            "maxLength":"2",
            "type":"string",
            "description":"Abbreviation that identifies the country of origin of the material.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"Quantity of the material issued.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the transacted quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryTransactionQuantity":{
            "type":"number",
            "description":"Secondary quantity of the material transacted for the work order.",
            "nullable":true,
            "x-queryable":true
        },
        "WoOperationSequenceNumber":{
            "type":"number",
            "description":"Operation sequence number of the work order. The application issues the component according to this sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "maxLength":"18",
            "type":"string",
            "description":"Revision of the component issued.",
            "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 : Material Transaction Lots

Type: array

Title: Material Transaction Lots

Lot of the component issued to or returned from a work order during an operation transaction.

Show Source

• Array of: object operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionLot-item-response

{
    "title":"Material Transaction Lots",
    "type":"array",
    "description":"Lot of the component issued to or returned from a work order during an operation transaction.",
    "items":{
        "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionLot-item-response"
    }
}

Nested Schema : Material Transaction Serials

Type: array

Title: Material Transaction Serials

Serial of the component issued to or returned from a work order during an operation transaction.

Show Source

• Array of: object operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionSerial-item-response

{
    "title":"Material Transaction Serials",
    "type":"array",
    "description":"Serial of the component issued to or returned from a work order during an operation transaction.",
    "items":{
        "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionSerial-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 : operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionLot-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Name of the error message, if any, when processing the transaction lot.
• ErrorMessages: string
  Read Only: true

  Maximum Length: 255

  Text of the error message, if any, when processing the material transaction lot.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotNumber: string
  Title: Lot Number

  Maximum Length: 80

  Lot number of the component issued.
• SecondaryTransactionQuantity: number
  Secondary quantity of the material lot transacted for the work order.
• TransactionQuantity: number
  Title: Transaction Quantity

  Quantity of the material lot transacted for the work order.

{
    "type":"object",
    "properties":{
        "ErrorMessages":{
            "maxLength":"255",
            "type":"string",
            "description":"Text of the error message, if any, when processing the material transaction lot.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the error message, if any, when processing the transaction lot.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryTransactionQuantity":{
            "type":"number",
            "description":"Secondary quantity of the material lot transacted for the work order.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactionQuantity":{
            "title":"Transaction Quantity",
            "type":"number",
            "description":"Quantity of the material lot transacted for the work order.",
            "nullable":false,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Lot number of the component issued.",
            "nullable":false,
            "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 : operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-MaterialTransactionSerial-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Name of the error message, if any, when processing the material transaction.
• ErrorMessages: string
  Read Only: true

  Maximum Length: 255

  Text of the error message, if any, when processing the material transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotNumber: string
  Title: Lot Number

  Maximum Length: 80

  Lot number of the serial for the component issued to the product.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Starting serial number of the component issued during an operation transaction.
• SerialNumberTo: string
  Maximum Length: 80

  Ending serial number of the component issued during operation transaction.

{
    "type":"object",
    "properties":{
        "ErrorMessages":{
            "maxLength":"255",
            "type":"string",
            "description":"Text of the error message, if any, when processing the material transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the error message, if any, when processing the material transaction.",
            "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"
            }
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Starting serial number of the component issued during an operation transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Lot number of the serial for the component issued to the product.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumberTo":{
            "maxLength":"80",
            "type":"string",
            "description":"Ending serial number of the component issued during operation transaction.",
            "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"
    }
}

Links

MaterialTransactionLot

Operation: /fscmRestApi/resources/11.13.18.05/operationTransactions/{operationTransactionsUniqID}/child/OperationTransactionDetail/{OperationTransactionDetailUniqID}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/MaterialTransactionLot

Parameters:

• MaterialTransactionDetailUniqID: $request.path.MaterialTransactionDetailUniqID
• OperationTransactionDetailUniqID: $request.path.OperationTransactionDetailUniqID
• operationTransactionsUniqID: $request.path.operationTransactionsUniqID

Lot of the component issued to or returned from a work order during an operation transaction.

MaterialTransactionSerial

Operation: /fscmRestApi/resources/11.13.18.05/operationTransactions/{operationTransactionsUniqID}/child/OperationTransactionDetail/{OperationTransactionDetailUniqID}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/MaterialTransactionSerial

Parameters:

• MaterialTransactionDetailUniqID: $request.path.MaterialTransactionDetailUniqID
• OperationTransactionDetailUniqID: $request.path.OperationTransactionDetailUniqID
• operationTransactionsUniqID: $request.path.operationTransactionsUniqID

Serial of the component issued to or returned from a work order during an operation transaction.

Back to Top