Jump to

• Request
• Response

Get action not supported

get

/fscmRestApi/resources/11.13.18.05/materialTransactions/{materialTransactionsUniqID}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/ComponentTransactionDetail/{ComponentTransactionDetailUniqID}

Request

Path Parameters

• ComponentTransactionDetailUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Component Transaction Details resource and used to uniquely identify an instance of Component Transaction Details. The client should not generate the hash key value. Instead, the client should query on the Component Transaction Details collection resource in order to navigate to a specific instance of Component Transaction Details to get the hash key.
• MaterialTransactionDetailUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Material Transaction Details resource and used to uniquely identify an instance of Material Transaction Details. The client should not generate the hash key value. Instead, the client should query on the Material Transaction Details collection resource in order to navigate to a specific instance of Material Transaction Details to get the hash key.
• materialTransactionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Order Material Transactions resource and used to uniquely identify an instance of Work Order Material Transactions. The client should not generate the hash key value. Instead, the client should query on the Work Order Material Transactions collection resource in order to navigate to a specific instance of Work Order Material Transactions to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : materialTransactions-MaterialTransactionDetail-ComponentTransactionDetail-item-response

Type: object

Show Source

• ComponentTransactionLot: array Lot Details for Component Transactions
  Title: Lot Details for Component Transactions

  The Lot Details for Component Transactions resource manages the component lot that the application issued to an assembly in an orderless transaction.
• ComponentTransactionSerial: array Serial Details for Component Transactions
  Title: Serial Details for Component Transactions

  The Serial Details for Component Transactions resource manages the component serial that the application issued to an assembly in an orderless transaction.
• CountryOfOriginCode: string
  Title: Country of Origin

  Maximum Length: 2

  Abbreviation that identifies the country of origin associated to the product.
• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Name of the error message, if any, when processing the component issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separates each message name.
• ErrorMessages: string
  Read Only: true

  Maximum Length: 2000

  Text of the error message, if any, when processing the component issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• InventoryItemNumber: string
  Title: Item

  Maximum Length: 300

  Number that identifies the component of the assembly. Use this attribute only for an orderless transaction.
• InvTransactionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transaction. If the transaction completes successfully, then this attribute contains a value that identifies the transaction. If the transaction does not complete successfully, then this attribute contains 0 (zero), the ErrorsExistFlag attribute contains true, and the ErrorMessages and ErrorMessageNames attributes contain error details.
• ItemRevision: string
  Title: Item Revision

  Maximum Length: 18

  Revision of the component that the application issued for the assembly in an orderless transaction.
• links: array Links
  Title: Links

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

  Locator that the application uses to issue the component to the assembly.
• SecondaryTransactionQuantity: number
  Title: Secondary Quantity

  Secondary quantity of the transacted material issued to the assembly in an orderless transaction. This attribute is associated with a feature that requires opt in.
• SubinventoryCode: string
  Title: Subinventory Code

  Maximum Length: 18

  Abbreviation that identifies the subinventory that the application uses to issue the component to the assembly.
• TransactionQuantity: number
  Title: Transaction Quantity

  Quantity of the transacted material issued to the assembly in an orderless transaction.
• TransactionUnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 25

  Unit of measure to use when reporting the transacted quantity.
• TransactionUOMCode: string
  Title: Unit of Measure

  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 does not have a default value. This attribute is associated with a feature that requires opt in.
• WoOperationSequenceNumber: number
  Title: Operation Sequence

  Operation sequence number of the work definition that the orderless transaction references. The application issues the component according to this sequence.

{
    "type":"object",
    "properties":{
        "InventoryItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the component of the assembly. Use this attribute only for an orderless transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentTransactionLot":{
            "title":"Lot Details for Component Transactions",
            "type":"array",
            "description":"The Lot Details for Component Transactions resource manages the component lot that the application issued to an assembly in an orderless transaction.",
            "items":{
                "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-ComponentTransactionDetail-ComponentTransactionLot-item-response"
            }
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the error message, if any, when processing the component issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separates each message name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentTransactionSerial":{
            "title":"Serial Details for Component Transactions",
            "type":"array",
            "description":"The Serial Details for Component Transactions resource manages the component serial that the application issued to an assembly in an orderless transaction.",
            "items":{
                "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-ComponentTransactionDetail-ComponentTransactionSerial-item-response"
            }
        },
        "TransactionUnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure to use when reporting the transacted quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "title":"Subinventory Code",
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the subinventory that the application uses to issue the component to the assembly.",
            "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 does not have a default value. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error message, if any, when processing the component issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":800,
            "type":"string",
            "description":"Locator that the application uses to issue the component to the assembly.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryOfOriginCode":{
            "title":"Country of Origin",
            "maxLength":2,
            "type":"string",
            "description":"Abbreviation that identifies the country of origin associated to the product.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "title":"Transaction Quantity",
            "type":"number",
            "description":"Quantity of the transacted material issued to the assembly in an orderless transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionUOMCode":{
            "title":"Unit of Measure",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the transacted quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryTransactionQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Secondary quantity of the transacted material issued to the assembly in an orderless transaction. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "InvTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction. If the transaction completes successfully, then this attribute contains a value that identifies the transaction. If the transaction does not complete successfully, then this attribute contains 0 (zero), the ErrorsExistFlag attribute contains true, and the ErrorMessages and ErrorMessageNames attributes contain error details.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WoOperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"Operation sequence number of the work definition that the orderless transaction references. 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":{
            "title":"Item Revision",
            "maxLength":18,
            "type":"string",
            "description":"Revision of the component that the application issued for the assembly in an orderless transaction.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Lot Details for Component Transactions

Type: array

Title: Lot Details for Component Transactions

The Lot Details for Component Transactions resource manages the component lot that the application issued to an assembly in an orderless transaction.

Show Source

• Array of: object materialTransactions-MaterialTransactionDetail-ComponentTransactionDetail-ComponentTransactionLot-item-response

{
    "title":"Lot Details for Component Transactions",
    "type":"array",
    "description":"The Lot Details for Component Transactions resource manages the component lot that the application issued to an assembly in an orderless transaction.",
    "items":{
        "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-ComponentTransactionDetail-ComponentTransactionLot-item-response"
    }
}

Nested Schema : Serial Details for Component Transactions

Type: array

Title: Serial Details for Component Transactions

The Serial Details for Component Transactions resource manages the component serial that the application issued to an assembly in an orderless transaction.

Show Source

• Array of: object materialTransactions-MaterialTransactionDetail-ComponentTransactionDetail-ComponentTransactionSerial-item-response

{
    "title":"Serial Details for Component Transactions",
    "type":"array",
    "description":"The Serial Details for Component Transactions resource manages the component serial that the application issued to an assembly in an orderless transaction.",
    "items":{
        "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-ComponentTransactionDetail-ComponentTransactionSerial-item-response"
    }
}

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 : materialTransactions-MaterialTransactionDetail-ComponentTransactionDetail-ComponentTransactionLot-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Name of the error message, if any, when processing the component lot issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separates each message name.
• ErrorMessages: string
  Read Only: true

  Maximum Length: 2000

  Text of the error message, if any, when processing the component lot issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• 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 that the application issued to the assembly in an orderless transaction.
• SecondaryTransactionQuantity: number
  Title: Secondary Transaction Quantity

  Secondary quantity of the material lot issued to the assembly in an orderless transaction. This attribute is associated with a feature that requires opt in.
• TransactionQuantity: number
  Title: Transaction Quantity

  Quantity of the material lot issued to the assembly in an orderless transaction.

{
    "type":"object",
    "properties":{
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error message, if any, when processing the component lot issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the error message, if any, when processing the component lot issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separates each message name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryTransactionQuantity":{
            "title":"Secondary Transaction Quantity",
            "type":"number",
            "description":"Secondary quantity of the material lot issued to the assembly in an orderless transaction. This attribute is associated with a feature that requires opt in.",
            "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 issued to the assembly in an orderless transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":80,
            "type":"string",
            "description":"Lot number of the component that the application issued to the assembly in an orderless transaction.",
            "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 : 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 : materialTransactions-MaterialTransactionDetail-ComponentTransactionDetail-ComponentTransactionSerial-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Name of the error message, if any, when processing the component serial issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separates each message name.
• ErrorMessages: string
  Read Only: true

  Maximum Length: 2000

  Text of the error message, if any, when processing the component serial issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• links: array Links
  Title: Links

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

  Maximum Length: 18

  Lot number of the serial for the component that the application issued to the assembly in an orderless transaction. This attribute is optional.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Starting serial number that identifies the component that the application issued to the assembly in an orderless transaction.
• SerialNumberTo: string
  Title: To Serial Number

  Maximum Length: 80

  Ending serial number that identifies the component that the application issued to the assembly in an orderless transaction. This attribute is optional.

{
    "type":"object",
    "properties":{
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error message, if any, when processing the component serial issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the error message, if any, when processing the component serial issue in an orderless transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separates each message name.",
            "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 that identifies the component that the application issued to the assembly in an orderless transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":18,
            "type":"string",
            "description":"Lot number of the serial for the component that the application issued to the assembly in an orderless transaction. This attribute is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumberTo":{
            "title":"To Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number that identifies the component that the application issued to the assembly in an orderless transaction. This attribute is optional.",
            "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

ComponentTransactionLot

Operation: /fscmRestApi/resources/11.13.18.05/materialTransactions/{materialTransactionsUniqID}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/ComponentTransactionDetail/{ComponentTransactionDetailUniqID}/child/ComponentTransactionLot

Parameters:

• ComponentTransactionDetailUniqID: $request.path.ComponentTransactionDetailUniqID
• MaterialTransactionDetailUniqID: $request.path.MaterialTransactionDetailUniqID
• materialTransactionsUniqID: $request.path.materialTransactionsUniqID

The Lot Details for Component Transactions resource manages the component lot that the application issued to an assembly in an orderless transaction.

ComponentTransactionSerial

Operation: /fscmRestApi/resources/11.13.18.05/materialTransactions/{materialTransactionsUniqID}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/ComponentTransactionDetail/{ComponentTransactionDetailUniqID}/child/ComponentTransactionSerial

Parameters:

• ComponentTransactionDetailUniqID: $request.path.ComponentTransactionDetailUniqID
• MaterialTransactionDetailUniqID: $request.path.MaterialTransactionDetailUniqID
• materialTransactionsUniqID: $request.path.materialTransactionsUniqID

The Serial Details for Component Transactions resource manages the component serial that the application issued to an assembly in an orderless transaction.

Back to Top