Jump to

• Request
• Response

GET action not supported

get

/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.

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey
    Finder Variables:
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CountryOfOriginCode; string; Abbreviation that identifies the country of origin of the material.
  • ErrorMessageNames; string; Name of the error message, if any, when processing the component issue in an operation transaction.
  • ErrorMessages; string; Text of the error message, if any, when processing the component issue in an operation transaction.
  • InventoryItemNumber; string; Number that identifies the component.
  • ItemRevision; string; Revision of the component issued.
  • Locator; string; Locator where the material is issued from or returned to.
  • SecondaryTransactionQuantity; number; Secondary quantity of the material transacted for the work order.
  • SubinventoryCode; string; Abbreviation that identifies the subinventory to issue the component.
  • TransactionQuantity; number; Quantity of the material issued.
  • TransactionUOMCode; string; Abbreviation that identifies the unit of measure for the transacted quantity.
  • TransactionUnitOfMeasure; string; Unit of measure to use when reporting the transacted quantity.
  • UseCommonInventoryFlag; boolean; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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:
  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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-MaterialTransactionDetail-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 : 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"
    }
}

Back to Top