Jump to

• Request
• Response

GET action not supported

get

/fscmRestApi/resources/11.13.18.05/maintenanceMaterialTransactions/{InterfaceBatchId}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}

Request

Path Parameters

• InterfaceBatchId(required): integer(int64)
  Value that uniquely identifies the interface batch.
• MaterialTransactionDetailUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Details resource and used to uniquely identify an instance of Details. The client should not generate the hash key value. Instead, the client should query on the Details collection resource in order to navigate to a specific instance of Details 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 : maintenanceMaterialTransactions-MaterialTransactionDetail-item-response

Type: object

Show Source

• AssemblySerialNumber: string
  Maximum Length: 80

  Serial number that identifies the assembly where fulfillment issues the components. However, this is not applicable for maintenance work orders.
• CountryOfOriginCode: string
  Title: Country of Origin

  Maximum Length: 2

  Abbreviation that identifies the country of origin associated with the item. If an inventory attribute exception exists for the item then this attribute isn???t applicable for the transaction.
• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Name of the error messages that occurred when processing the item 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 that occurred when processing the item 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 uniquely identifies the item that is transacted against the maintenance work order.
• InvTransactionId: integer (int64)
  Value that uniquely identifies the respective transaction in the inventory application. If the transaction is successful, the value will be a number, else the value will be 0. This attribute value is included in the response payload.
• ItemRevision: string
  Title: Item Revision

  Maximum Length: 18

  Revision of the item that is transacted.
• links: array Links
  Title: Links

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

  Locator where fulfillment issues the item from or returns the item to. It is applicable when a locator controlled item is transacted.
• OrganizationCode: string
  Title: Organization Code

  Maximum Length: 30

  Abbreviation that identifies the maintenance organization where the material transaction is performed. The user who performs the transaction should have access to the maintenance organization and the item transacted should be assigned to the maintenance organization.
• ParentAssetId: integer (int64)
  Value that uniquely identifies the parent asset. For a removal (negative material issue) transaction, this attribute indicates the identifier of the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the identifier of the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.
• ParentAssetNumber: string
  Maximum Length: 255

  Number that uniquely identifies the parent asset. For a removal (negative material issue) transaction, this attribute indicates the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.
• ParentInventoryItemId: integer (int64)
  Value that uniquely identifies the item referenced in the parent asset. For a removal (negative material issue) transaction, this attribute indicates the identifier associated with the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the value associated with the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.
• ParentInventoryItemNumber: string
  Maximum Length: 255

  Number that uniquely identifies the item referenced in the parent asset. For a removal (negative material issue) transaction, this attribute indicates the item associated with the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the value associated with the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.
• ParentSerialNumber: string
  Maximum Length: 80

  Number that identifies the serial number of the parent asset. For a removal (negative material issue) transaction, this attribute indicates the serial number of the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the serial number of the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Number that identifies the project. This attribute is associated with a feature that requires opt in.
• RepairTransactionCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the repair transaction from the condition event.
• SecondaryTransactionQuantity: number
  Title: Secondary Transaction Quantity

  Secondary quantity of product that the asset references. If item is not defined as as dual unit of measure item or if conversion for the secondary unit of measure is set to fixed, this quantity is not required. If dual UOM conversion is set to default, this quantity will override the default quantity. If conversion is no default, this quantity is required. The default value of secondary unit of measure is from setup.
• SecondaryUnitOfMeasure: string
  Title: Secondary Unit of Measure

  Maximum Length: 25

  Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure is not required to create an asset. If provided it must be the same as the asset item secondary unit of measure. If not provided the value of the asset item secondary unit of measure is used by default.
• SourceHeaderReference: string
  Title: Source Header Reference

  Maximum Length: 240

  Reference to the object header in the source application.
• SourceHeaderReferenceId: integer (int64)
  Title: Source Header Reference ID

  Value that uniquely identifies the object header in the source application.
• SourceLineReference: string
  Title: Source Line Reference

  Maximum Length: 240

  Reference to the object line in the source application.
• SourceLineReferenceId: integer (int64)
  Title: Source Line Reference ID

  Value that uniquely identifies the object line in the source application.
• SourceSystemCode: string
  Title: Source System Code

  Maximum Length: 30

  Abbreviation that identifies the source application that started this operation transaction. This code must be registered in Oracle Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view.
• SubinventoryCode: string
  Title: Subinventory Code

  Maximum Length: 18

  Abbreviation that identifies the subinventory from or to which the item transaction is done. For an issue transaction, the item from the subinventory will be issued. For a return transaction, the item will be transacted to the subinventory.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Number that identifies the task. This attribute is associated with a feature that requires opt in.
• TransactedAsset: integer
  Abbreviation that identifies the transacted asset.
• TransactionDate: string (date-time)
  Title: Transaction Date

  Date and time when the transaction is performed. The valid date range is from the work order released date till the system date. Future date is not valid and the default value is the system date.
• TransactionGroupCode: string
  Maximum Length: 100

  Abbreviation that identifies the transaction group.
• TransactionLot: array Transaction Lots
  Title: Transaction Lots

  The Transaction Lots resource manages the details of the lot of the component issued to or returned from the work order.
• TransactionQuantity: number
  Title: Transaction Quantity

  Quantity of the item transacted against the maintenance work order.
• TransactionSerial: array Transaction Serials
  Title: Transaction Serials

  The Transaction Serials resource manages details of the serial of the component issued to or returned from the work order.
• TransactionTypeCode: string
  Title: Transaction Type Code

  Maximum Length: 30

  Abbreviation that describes the type of material transactions supported for a maintenance work order. Valid values for a maintenance work order are MATERIAL_RETURN, MATERIAL_ISSUE, MATERIAL_NEGATIVE_ISSUE, and MATERIAL_NEGATIVE_RETURN. A list of accepted values is defined in the lookup type ORA_WIE_MTL_TXN_TYPE.
• TransactionUnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 25

  Unit of measure to use during the item transaction. The primary unit of measure in the item definition should be used for the transaction.
• UseCommonInventoryFlag: boolean
  Title: Use Common Inventory

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then true. If N, then false. This attribute does not have a default value. This attribute is applicable only for work order component issue or reverse. If populated with any value for a work order without a project and task, it will be ignored. If populated for product completions or reverse or orderless transactions, it will be ignored.
• WoOperationSequenceNumber: number
  Title: Operation Sequence

  Number that uniquely identifies the operation within the maintenance work orders. Material is transacted against operation in the maintenance work order.
• WorkOrderNumber: string
  Title: Work Order

  Maximum Length: 120

  Number that uniquely identifies the maintenance work order. The material transaction is performed against this maintenance work order.

{
    "type":"object",
    "properties":{
        "ParentInventoryItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the item referenced in the parent asset. For a removal (negative material issue) transaction, this attribute indicates the item associated with the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the value associated with the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLineReference":{
            "title":"Source Line Reference",
            "maxLength":240,
            "type":"string",
            "description":"Reference to the object line in the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUnitOfMeasure":{
            "title":"Secondary Unit of Measure",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure is not required to create an asset. If provided it must be the same as the asset item secondary unit of measure. If not provided the value of the asset item secondary unit of measure is used by default.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionGroupCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the transaction group.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionUnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure to use during the item transaction. The primary unit of measure in the item definition should be used for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "title":"Subinventory Code",
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the subinventory from or to which the item transaction is done. For an issue transaction, the item from the subinventory will be issued. For a return transaction, the item will be transacted to the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "UseCommonInventoryFlag":{
            "title":"Use Common Inventory",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then true. If N, then false. This attribute does not have a default value. This attribute is applicable only for work order component issue or reverse. If populated with any value for a work order without a project and task, it will be ignored. If populated for product completions or reverse or orderless transactions, it will be ignored.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentInventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item referenced in the parent asset. For a removal (negative material issue) transaction, this attribute indicates the identifier associated with the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the value associated with the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceHeaderReference":{
            "title":"Source Header Reference",
            "maxLength":240,
            "type":"string",
            "description":"Reference to the object header in the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "AssemblySerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Serial number that identifies the assembly where fulfillment issues the components. However, this is not applicable for maintenance work orders.",
            "nullable":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":800,
            "type":"string",
            "description":"Locator where fulfillment issues the item from or returns the item to. It is applicable when a locator controlled item is transacted.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "title":"Transaction Quantity",
            "type":"number",
            "description":"Quantity of the item transacted against the maintenance work order.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactedAsset":{
            "type":"integer",
            "description":"Abbreviation that identifies the transacted asset.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTypeCode":{
            "title":"Transaction Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that describes the type of material transactions supported for a maintenance work order. Valid values for a maintenance work order are MATERIAL_RETURN, MATERIAL_ISSUE, MATERIAL_NEGATIVE_ISSUE, and MATERIAL_NEGATIVE_RETURN. A list of accepted values is defined in the lookup type ORA_WIE_MTL_TXN_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "SecondaryTransactionQuantity":{
            "title":"Secondary Transaction Quantity",
            "type":"number",
            "description":"Secondary quantity of product that the asset references. If item is not defined as as dual unit of measure item or if conversion for the secondary unit of measure is set to fixed, this quantity is not required. If dual UOM conversion is set to  default, this quantity will override the default quantity. If conversion is no default, this quantity is required. The default value of secondary unit of measure is from setup.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the maintenance organization where the material transaction is performed. The user who performs the transaction should have access to the maintenance organization and the item transacted should be assigned to the maintenance organization.",
            "nullable":true,
            "x-queryable":true
        },
        "WoOperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"Number that uniquely identifies the operation within the maintenance work orders. Material is transacted against operation in the maintenance 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"
            }
        },
        "ItemRevision":{
            "title":"Item Revision",
            "maxLength":18,
            "type":"string",
            "description":"Revision of the item that is transacted.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Date and time when the transaction is performed. The valid date range is from the work order released date till the system date. Future date is not valid and the default value is the system date.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionSerial":{
            "title":"Transaction Serials",
            "type":"array",
            "description":"The Transaction Serials resource manages details of the serial of the component issued to or returned from the work order.",
            "items":{
                "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-item-response"
            }
        },
        "InventoryItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the item that is transacted against the maintenance work order.",
            "nullable":true,
            "x-queryable":true
        },
        "RepairTransactionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the repair transaction from the condition event.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the project. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the error messages that occurred when processing the item 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
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"Number that identifies the task. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the serial number of the parent asset. For a removal (negative material issue) transaction, this attribute indicates the serial number of the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the serial number of the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceHeaderReferenceId":{
            "title":"Source Header Reference ID",
            "type":"integer",
            "description":"Value that uniquely identifies the object header in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error message that occurred when processing the item 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
        },
        "SourceLineReferenceId":{
            "title":"Source Line Reference ID",
            "type":"integer",
            "description":"Value that uniquely identifies the object line in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionLot":{
            "title":"Transaction Lots",
            "type":"array",
            "description":"The Transaction Lots resource manages the details of the lot of the component issued to or returned from the work order.",
            "items":{
                "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionLot-item-response"
            }
        },
        "CountryOfOriginCode":{
            "title":"Country of Origin",
            "maxLength":2,
            "type":"string",
            "description":"Abbreviation that identifies the country of origin associated with the item. If an inventory attribute exception exists for the item then this attribute isn???t applicable for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":120,
            "type":"string",
            "description":"Number that uniquely identifies the maintenance work order. The material transaction is performed against this maintenance work order.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent asset. For a removal (negative material issue) transaction, this attribute indicates the identifier of the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the identifier of the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the respective transaction in the inventory application. If the transaction is successful, the value will be a number, else the value will be 0. This attribute value is included in the response payload.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystemCode":{
            "title":"Source System Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the source application that started this operation transaction. This code must be registered in Oracle Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentAssetNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the parent asset. For a removal (negative material issue) transaction, this attribute indicates the actual parent of the removed asset. For an install (material issue) transaction, this attribute indicates the to-be parent asset. Use this attribute only when the material transaction is used for asset removal or install. If this value is not provided, then the work order asset is used as the parent asset.",
            "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 : Transaction Lots

Type: array

Title: Transaction Lots

The Transaction Lots resource manages the details of the lot of the component issued to or returned from the work order.

Show Source

• Array of: object maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionLot-item-response

{
    "title":"Transaction Lots",
    "type":"array",
    "description":"The Transaction Lots resource manages the details of the lot of the component issued to or returned from the work order.",
    "items":{
        "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionLot-item-response"
    }
}

Nested Schema : Transaction Serials

Type: array

Title: Transaction Serials

The Transaction Serials resource manages details of the serial of the component issued to or returned from the work order.

Show Source

• Array of: object maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-item-response

{
    "title":"Transaction Serials",
    "type":"array",
    "description":"The Transaction Serials resource manages details of the serial of the component issued to or returned from the work order.",
    "items":{
        "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-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 : maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionLot-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Name of the error messages that occurred when processing the transaction lot. 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 messages that occurred when processing this transaction lot. 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

  Number that identifies the lot number of the component item being issued or returned from a maintenance work order.
• SecondaryTransactionQuantity: number
  Title: Secondary Transaction Quantity

  Secondary quantity of the lot transaction of the component item transacted against the maintenance work order. If item is not defined as a dual unit of measure item or if conversion for the secondary unit of measure is set to fix, then this quantity is not required. If dual unit of measure conversion is set to default, then this quantity will override the defaulted quantity. If conversion is set to no default, then this quantity is required. The default value of secondary unit of measure is based on the setup.
• TransactionLotDFF: array Flexfields for Transaction Lots
  Title: Flexfields for Transaction Lots

  The Flexfields for Transaction Lots resource manages descriptive flexfields that contain details about the lot component transaction.
• TransactionQuantity: number
  Title: Transaction Quantity

  Lot quantity of the component item transacted against the maintenance work order.

{
    "type":"object",
    "properties":{
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error messages that occurred when processing this transaction lot. 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
        },
        "TransactionQuantity":{
            "title":"Transaction Quantity",
            "type":"number",
            "description":"Lot quantity of the component item transacted against the maintenance work order.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the error messages that occurred when processing the transaction lot. 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 lot transaction of the component item transacted against the maintenance work order. If item is not defined as a dual unit of measure item or if conversion for the secondary unit of measure is set to fix, then this quantity is not required. If dual unit of measure conversion is set to default, then this quantity will override the defaulted quantity. If conversion is set to no default, then this quantity is required. The default value of secondary unit of measure is based on the setup.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionLotDFF":{
            "title":"Flexfields for Transaction Lots",
            "type":"array",
            "description":"The Flexfields for Transaction Lots resource manages descriptive flexfields that contain details about the lot component transaction.",
            "items":{
                "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionLot-TransactionLotDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the lot number of the component item being issued or returned from a maintenance work order.",
            "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 : Flexfields for Transaction Lots

Type: array

Title: Flexfields for Transaction Lots

The Flexfields for Transaction Lots resource manages descriptive flexfields that contain details about the lot component transaction.

Show Source

• Array of: object maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionLot-TransactionLotDFF-item-response

{
    "title":"Flexfields for Transaction Lots",
    "type":"array",
    "description":"The Flexfields for Transaction Lots resource manages descriptive flexfields that contain details about the lot component transaction.",
    "items":{
        "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionLot-TransactionLotDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionLot-TransactionLotDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for the lot component transaction.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• Discriminator: string
  This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
• InterfaceRowId: integer (int64)
  Value that uniquely identifies the lot component transaction that references a descriptive flexfield. It is recommended that you not include this attribute in the request payload. The response payload contains the primary key of the lot component transaction that references the descriptive flexfield.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterfaceRowId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lot component transaction that references a descriptive flexfield. It is recommended that you not include this attribute in the request payload. The response payload contains the primary key of the lot component transaction that references the descriptive flexfield.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "Discriminator":{
            "type":"string",
            "description":"This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for the lot component transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Names of the error messages that occurred when processing the transaction serial. 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 messages that occurred when processing this transaction serial. 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

  Number that identifies the lot number of the serial controlled component item being issued or returned from a maintenance work order.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Number that identifies the serial number of the component item being issued or returned from a maintenance work order.
• SerialNumberTo: string
  Title: To Serial Number

  Maximum Length: 80

  Number that indicates the last serial number of the component items being issued or returned from a maintenance work order.
• TransactionSerialDFF: array Flexfields for Transaction Serials
  Title: Flexfields for Transaction Serials

  The Flexfields for Transaction Serials resource manages descriptive flexfields that contain details about the serial component transaction.

{
    "type":"object",
    "properties":{
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error messages that occurred when processing this transaction serial. 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
        },
        "TransactionSerialDFF":{
            "title":"Flexfields for Transaction Serials",
            "type":"array",
            "description":"The Flexfields for Transaction Serials resource manages descriptive flexfields that contain details about the serial component transaction.",
            "items":{
                "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the serial number of the component item being issued or returned from a maintenance work order.",
            "nullable":false,
            "x-queryable":true
        },
        "SerialNumberTo":{
            "title":"To Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that indicates the last serial number of the component items being issued or returned from a maintenance work order.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Names of the error messages that occurred when processing the transaction serial. 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"
            }
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":18,
            "type":"string",
            "description":"Number that identifies the lot number of the serial controlled component item being issued or returned from a maintenance work order.",
            "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 : Flexfields for Transaction Serials

Type: array

Title: Flexfields for Transaction Serials

The Flexfields for Transaction Serials resource manages descriptive flexfields that contain details about the serial component transaction.

Show Source

• Array of: object maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-response

{
    "title":"Flexfields for Transaction Serials",
    "type":"array",
    "description":"The Flexfields for Transaction Serials resource manages descriptive flexfields that contain details about the serial component transaction.",
    "items":{
        "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for the serial component transaction.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• Discriminator: string
  This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
• InterfaceRowId: integer (int64)
  Primary key of the serial component transaction that references a descriptive flexfield. It is recommended that you not include this attribute in the request payload. The response payload contains the primary key of the serial component transaction that references the descriptive flexfield.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterfaceRowId":{
            "type":"integer",
            "description":"Primary key of the serial component transaction that references a descriptive flexfield. It is recommended that you not include this attribute in the request payload. The response payload contains the primary key of the serial component transaction that references the descriptive flexfield.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "Discriminator":{
            "type":"string",
            "description":"This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for the serial component transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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

TransactionLot

Operation: /fscmRestApi/resources/11.13.18.05/maintenanceMaterialTransactions/{InterfaceBatchId}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/TransactionLot

Parameters:

• InterfaceBatchId: $request.path.InterfaceBatchId
• MaterialTransactionDetailUniqID: $request.path.MaterialTransactionDetailUniqID

The Transaction Lots resource manages the details of the lot of the component issued to or returned from the work order.

TransactionSerial

Operation: /fscmRestApi/resources/11.13.18.05/maintenanceMaterialTransactions/{InterfaceBatchId}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/TransactionSerial

Parameters:

• InterfaceBatchId: $request.path.InterfaceBatchId
• MaterialTransactionDetailUniqID: $request.path.MaterialTransactionDetailUniqID

The Transaction Serials resource manages details of the serial of the component issued to or returned from the work order.

Back to Top