Jump to

• Request
• Response

GET action not supported

get

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

Request

Path Parameters

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

  • ComplSubinventoryCode; string; Abbreviation that identifies the subinventory in which the product will be stored during product completion.
  • CompletionLocator; string; Inventory locator where the products are completed to.
  • CountryOfOriginCode; string; Abbreviation that identifies the country of origin associated with the product.
  • ErrorMessageNames; string; Name of the error message, if any, when the transaction processing fails. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separate each message name.
  • ErrorMessages; string; Text of the error message, if any, when processing this transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separate each message.
  • FromDispatchState; string; State of the transaction quantity for the operation at the beginning of processing.
  • InspectionEventId; integer; Value that uniquely identifies the inspection event that this operation references. It is a primary key that the application generates when it starts an inspection for this operation.
  • OrganizationCode; string; Abbreviation that identifies the organization where fulfillment performs the operation transaction.
  • POLineNumber; number; Number that uniquely identifies the purchase order.
  • PONumber; string; Number of the purchase order. Use the PONumber attribute only if the plant is a contract manufacturing plant.
  • ReasonCode; string; Abbreviation that identifies the reason for the operation scrap transactions. This is a user-specified reason code. This is one of the additional attributes used by costing to determine the accounts for scrap and return from scrap. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Production Lookups task.
  • SecondaryTransactionQuantity; number; Secondary quantity transacted for the operation. This attribute is associated with a feature that requires opt in.
  • SoldToLegalEntityName; string; Name of the sold-to organization in the purchase order. Use this attribute only if the plant is a contract manufacturing plant.
  • SourceSystemCode; string; Abbreviation that identifies the source application that started the operation transaction.
  • ToDispatchState; string; State of the transaction quantity for the operation at the end of processing.
  • TransactionDate; string; Date and time when the transaction was executed.
  • TransactionNote; string; Notes that describe the operation transaction.
  • TransactionQuantity; number; Quantity transacted for the operation.
  • TransactionUOMCode; string; Abbreviation that identifies the unit of measure for the transaction quantity.
  • TransactionUnitOfMeasure; string; Unit of measure for the transaction quantity.
  • UnderCompleteFlag; boolean; Contains one of the following values: true or false. If true, then the work order is undercompleted. If false, then the work order is not undercompleted.This attribute is associated with a feature that requires opt in.
  • WoOperationSequenceNumber; number; Number that identifies the sequence of the operation as defined in the work order operations. This attribute can take only whole numbers.
  • WoOperationTransactionId; integer; 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.
  • WorkOrderNumber; string; Number that identifies the work order that the operation transaction references.
  • WorkstationId; integer; Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
• 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

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-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

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

Type: object

Show Source

• CompletionLocator: string
  Maximum Length: 800

  Inventory locator where the products are completed to.
• ComplSubinventoryCode: string
  Title: Completion Subinventory Code

  Maximum Length: 18

  Abbreviation that identifies the subinventory in which the product will be stored during product completion.
• CountryOfOriginCode: string
  Title: Country of Origin

  Maximum Length: 2

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

  Maximum Length: 255

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

  Maximum Length: 2000

  Text of the error message, if any, when processing this transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separate each message.
• FromDispatchState: string
  Title: From Dispatch State

  Maximum Length: 30

  State of the transaction quantity for the operation at the beginning of processing.
• InspectionEventId: integer (int64)
  Value that uniquely identifies the inspection event that this operation references. It is a primary key that the application generates when it starts an inspection for this operation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationTransactionDFF: array Flexfields for Operation Transactions
  Title: Flexfields for Operation Transactions

  The Flexfields for Operation Transactions resource manages descriptive flexfields that contain details about the operation transaction.
• OrganizationCode: string
  Title: Organization Code

  Maximum Length: 30

  Abbreviation that identifies the organization where fulfillment performs the operation transaction.
• POLineNumber: number
  Title: Purchase Order Line Number

  Number that uniquely identifies the purchase order.
• PONumber: string
  Title: Purchase Order Header Number

  Maximum Length: 30

  Number of the purchase order. Use the PONumber attribute only if the plant is a contract manufacturing plant.
• ReasonCode: string
  Title: Reason Code

  Maximum Length: 30

  Abbreviation that identifies the reason for the operation scrap transactions. This is a user-specified reason code. This is one of the additional attributes used by costing to determine the accounts for scrap and return from scrap. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Production Lookups task.
• SecondaryTransactionQuantity: number
  Title: Secondary Transaction Quantity

  Secondary quantity transacted for the operation. This attribute is associated with a feature that requires opt in.
• SoldToLegalEntityName: string
  Title: Sold-to Legal Entity Name

  Maximum Length: 240

  Name of the sold-to organization in the purchase order. Use this attribute only if the plant is a contract manufacturing plant.
• SourceSystemCode: string
  Title: Source System Code

  Maximum Length: 30

  Abbreviation that identifies the source application that started the operation transaction.
• ToDispatchState: string
  Title: To Dispatch State

  Maximum Length: 30

  State of the transaction quantity for the operation at the end of processing.
• TransactionDate: string (date-time)
  Title: Transaction Date

  Date and time when the transaction was executed.
• TransactionLot: array Transaction Lots
  Title: Transaction Lots

  The Transaction Lots resource manages details of the product lot.
• TransactionNote: string
  Title: Transaction Note

  Maximum Length: 4000

  Notes that describe the operation transaction.
• TransactionQuantity: number
  Title: Transaction Quantity

  Quantity transacted for the operation.
• TransactionSerial: array Transaction Serials
  Title: Transaction Serials

  The Transaction Serials resource manages details of the product serial.
• TransactionUnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 25

  Unit of measure for the transaction quantity.
• TransactionUOMCode: string
  Title: Unit of Measure

  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the transaction quantity.
• UnderCompleteFlag: boolean
  Title: Undercomplete

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the work order is undercompleted. If false, then the work order is not undercompleted.This attribute is associated with a feature that requires opt in.
• WoOperationSequenceNumber: number
  Title: Operation Sequence

  Number that identifies the sequence of the operation as defined in the work order operations. This attribute can take only whole numbers.
• WoOperationTransactionId: integer (int64)
  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.
• WorkOrderNumber: string
  Title: Work Order

  Maximum Length: 120

  Number that identifies the work order that the operation transaction references.
• WorkstationId: integer (int64)
  Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.

{
    "type":"object",
    "properties":{
        "PONumber":{
            "title":"Purchase Order Header Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number of the purchase order. Use the PONumber attribute only if the plant is a contract manufacturing plant.",
            "nullable":true,
            "x-queryable":true
        },
        "WoOperationTransactionId":{
            "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,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionNote":{
            "title":"Transaction Note",
            "maxLength":"4000",
            "type":"string",
            "description":"Notes that describe the operation transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionUnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the transaction quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "FromDispatchState":{
            "title":"From Dispatch State",
            "maxLength":"30",
            "type":"string",
            "description":"State of the transaction quantity for the operation at the beginning of processing.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "title":"Transaction Quantity",
            "type":"number",
            "description":"Quantity transacted for the operation.",
            "nullable":false,
            "x-queryable":true
        },
        "InspectionEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event that this operation references. It is a primary key that the application generates when it starts an inspection for this operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationTransactionDFF":{
            "title":"Flexfields for Operation Transactions",
            "type":"array",
            "description":"The Flexfields for Operation Transactions resource manages descriptive flexfields that contain details about the operation transaction.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-OperationTransactionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "WorkstationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionUOMCode":{
            "title":"Unit of Measure",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the transaction quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryTransactionQuantity":{
            "title":"Secondary Transaction Quantity",
            "type":"number",
            "description":"Secondary quantity transacted for the operation. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the organization where fulfillment performs the operation transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "WoOperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"Number that identifies the sequence of the operation as defined in the work order operations. This attribute can take only whole numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Date and time when the transaction was executed.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionSerial":{
            "title":"Transaction Serials",
            "type":"array",
            "description":"The Transaction Serials resource manages details of the product serial.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-TransactionSerial-item-response"
            }
        },
        "CompletionLocator":{
            "maxLength":"800",
            "type":"string",
            "description":"Inventory locator where the products are completed to.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplSubinventoryCode":{
            "title":"Completion Subinventory Code",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the subinventory in which the product will be stored during product completion.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the error message, if any, when the transaction processing fails. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separate each message name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnderCompleteFlag":{
            "title":"Undercomplete",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the work order is undercompleted. If false, then the work order is not undercompleted.This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "ToDispatchState":{
            "title":"To Dispatch State",
            "maxLength":"30",
            "type":"string",
            "description":"State of the transaction quantity for the operation at the end of processing.",
            "nullable":false,
            "x-queryable":true
        },
        "ReasonCode":{
            "title":"Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the reason for the operation scrap transactions. This is a user-specified reason code. This is one of the additional attributes used by costing to determine the accounts for scrap and return from scrap. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Production Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the error message, if any, when processing this transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separate each message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionLot":{
            "title":"Transaction Lots",
            "type":"array",
            "description":"The Transaction Lots resource manages details of the product lot.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-TransactionLot-item-response"
            }
        },
        "CountryOfOriginCode":{
            "title":"Country of Origin",
            "maxLength":"2",
            "type":"string",
            "description":"Abbreviation that identifies the country of origin associated with the product.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":"120",
            "type":"string",
            "description":"Number that identifies the work order that the operation transaction references.",
            "nullable":true,
            "x-queryable":true
        },
        "SoldToLegalEntityName":{
            "title":"Sold-to Legal Entity Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the sold-to organization in the purchase order. Use this attribute only if the plant is a contract manufacturing plant.",
            "nullable":true,
            "x-queryable":true
        },
        "POLineNumber":{
            "title":"Purchase Order Line Number",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemCode":{
            "title":"Source System Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the source application that started the 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"
    }
}

Nested Schema : Flexfields for Operation Transactions

Type: array

Title: Flexfields for Operation Transactions

The Flexfields for Operation Transactions resource manages descriptive flexfields that contain details about the operation transaction.

Show Source

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

{
    "title":"Flexfields for Operation Transactions",
    "type":"array",
    "description":"The Flexfields for Operation Transactions resource manages descriptive flexfields that contain details about the operation transaction.",
    "items":{
        "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-OperationTransactionDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Transaction Lots

Type: array

Title: Transaction Lots

The Transaction Lots resource manages details of the product lot.

Show Source

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

{
    "title":"Transaction Lots",
    "type":"array",
    "description":"The Transaction Lots resource manages details of the product lot.",
    "items":{
        "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-TransactionLot-item-response"
    }
}

Nested Schema : Transaction Serials

Type: array

Title: Transaction Serials

The Transaction Serials resource manages details of the product serial.

Show Source

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

{
    "title":"Transaction Serials",
    "type":"array",
    "description":"The Transaction Serials resource manages details of the product serial.",
    "items":{
        "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-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 : operationTransactions-OperationTransactionDetail-OperationTransactionDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for resource transactions.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• Discriminator: string
• InterfaceRowId: integer (int64)
  Value that uniquely identifies the operation transaction detail that a descriptive flexfield references. This attribute should not be included in the request payload. The value of this attribute in the response payload includes the primary key of the operation transaction detail.
• 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 operation transaction detail that a descriptive flexfield references. This attribute should not be included in the request payload. The value of this attribute in the response payload includes the primary key of the operation transaction detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "Discriminator":{
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"80",
            "type":"string",
            "description":"Descriptive flexfield context name for resource transactions.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "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 : operationTransactions-OperationTransactionDetail-TransactionLot-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

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

  Maximum Length: 2000

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

  The link relations associated with the resource instance.
• LotExpirationDate: string (date-time)
  Title: Lot Expiration Date

  Date and time when the lot expires.
• LotHoldUntilDate: string (date-time)
  Title: Hold Until Date

  Date when the hold expires for the lot number. This attribute is associated with a feature that requires opt in.
• LotNumber: string
  Title: Lot Number

  Maximum Length: 80

  Lot number for the transaction quantity.
• LotOriginationDate: string (date-time)
  Title: Lot Origination Date

  Date and time when the lot originated.
• LotOriginationType: string
  Title: Lot Origination Type

  Maximum Length: 30

  Origin of the lot. The application determines the lot origination type when you create the lot.
• ParentLotNumber: string
  Title: Parent Lot Number

  Maximum Length: 80

  Number that identifies the parent lot of the lot number used for the work order material. This attribute is applicable if the material is lot controlled. This attribute is associated with a feature that requires opt in.
• SecondaryTransactionQuantity: number
  Secondary quantity of the product lot transacted for the work order. This attribute is associated with a feature that requires opt in.
• TransactionLotDFF: array Flexfields for Operation Transaction Lots
  Title: Flexfields for Operation Transaction Lots

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

  Quantity of the product lot transacted for the work order.

{
    "type":"object",
    "properties":{
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the error message, if any, when processing this operation transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separate each message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotOriginationDate":{
            "title":"Lot Origination Date",
            "type":"string",
            "description":"Date and time when the lot originated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LotHoldUntilDate":{
            "title":"Hold Until Date",
            "type":"string",
            "description":"Date when the hold expires for the lot number. This attribute is associated with a feature that requires opt in.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "title":"Transaction Quantity",
            "type":"number",
            "description":"Quantity of the product lot transacted for the work order.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the error message, if any, when processing this operation transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separate each message name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotOriginationType":{
            "title":"Lot Origination Type",
            "maxLength":"30",
            "type":"string",
            "description":"Origin of the lot. The application determines the lot origination type when you create the lot.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryTransactionQuantity":{
            "type":"number",
            "description":"Secondary quantity of the product lot transacted for the work order. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionLotDFF":{
            "title":"Flexfields for Operation Transaction Lots",
            "type":"array",
            "description":"The Flexfields for Operation Transaction Lots resource manages descriptive flexfields that contain details about the transaction lot.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-TransactionLot-TransactionLotDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ParentLotNumber":{
            "title":"Parent Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the parent lot of the lot number used for the work order material. This attribute is applicable if the material is lot controlled. 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"
            }
        },
        "LotExpirationDate":{
            "title":"Lot Expiration Date",
            "type":"string",
            "description":"Date and time when the lot expires.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Lot number for the transaction quantity.",
            "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 Operation Transaction Lots

Type: array

Title: Flexfields for Operation Transaction Lots

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

Show Source

• Array of: object operationTransactions-OperationTransactionDetail-TransactionLot-TransactionLotDFF-item-response

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

Nested Schema : operationTransactions-OperationTransactionDetail-TransactionLot-TransactionLotDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for transaction lots.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield context display value for transaction lots.
• InterfaceRowId: integer (int64)
  Value that uniquely identifies the transaction lot that uses the descriptive flexfields. Make sure your request payload does not include a value for this attribute. The response payload includes the primary key of the transaction lot.
• 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 transaction lot that uses the descriptive flexfields. Make sure your request payload does not include a value for this attribute. The response payload includes the primary key of the transaction lot.",
            "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",
            "description":"Descriptive flexfield context display value for transaction lots.",
            "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
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for transaction lots.",
            "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_IsDiscriminator":"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 : operationTransactions-OperationTransactionDetail-TransactionSerial-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

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

  Maximum Length: 2000

  Text of the error messages, if any, when processing this serial in the operation transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separate 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 serial of the component that fulfillment issues for the work order. The LotNumber attribute is optional.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Serial number of the product where fulfillment performs the operation transaction.
• TransactionSerialDFF: array Flexfields for Operation Transaction Serials
  Title: Flexfields for Operation Transaction Serials

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

{
    "type":"object",
    "properties":{
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the error messages, if any, when processing this serial in the operation transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separate each message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the error message, if any, when processing this serial in the operation transaction. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separate each message name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionSerialDFF":{
            "title":"Flexfields for Operation Transaction Serials",
            "type":"array",
            "description":"The Flexfields for Operation Transaction Serials resource manages descriptive flexfields that contain details about the transaction serial.",
            "items":{
                "$ref":"#/components/schemas/operationTransactions-OperationTransactionDetail-TransactionSerial-TransactionSerialDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "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":"Serial number of the product where fulfillment performs the operation transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Lot number of the serial of the component that fulfillment issues for the work order. The LotNumber 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"
    }
}

Nested Schema : Flexfields for Operation Transaction Serials

Type: array

Title: Flexfields for Operation Transaction Serials

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

Show Source

• Array of: object operationTransactions-OperationTransactionDetail-TransactionSerial-TransactionSerialDFF-item-response

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

Nested Schema : operationTransactions-OperationTransactionDetail-TransactionSerial-TransactionSerialDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for transaction serials.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield context display value for transaction serials.
• InterfaceRowId: integer (int64)
  Value that uniquely identifies the transaction serial that uses the descriptive flexfields. This attribute should not be included in the request payload. The value of this attribute in the response payload includes the primary key of the transaction serial.
• 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 transaction serial that uses the descriptive flexfields. This attribute should not be included in the request payload. The value of this attribute in the response payload includes the primary key of the transaction serial.",
            "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",
            "description":"Descriptive flexfield context display value for transaction serials.",
            "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
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for transaction serials.",
            "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_IsDiscriminator":"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"
    }
}

Back to Top