Jump to

• Request
• Response

Create lots

post

/fscmRestApi/resources/11.13.18.05/materialTransactions/{materialTransactionsUniqID}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/TransactionLot

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• LotExpirationDate: string (date)
  Title: Lot Expiration Date

  Date when the component of this lot expires. This attribute is required only for a new lot and is applicable only for orderless completions.
• 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(required): string
  Title: Lot Number

  Maximum Length: 80

  Lot number of the material (component) issued for the work order. This attribute is needed only if material is lot controlled.
• LotOriginationDate: string (date-time)
  Title: Lot Origination Date

  Date when the lot originated. This attribute is required only if the item is lot controlled and transaction type code is ORDERLESS_COMPLETION.
• 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
  Title: Secondary Transaction Quantity

  Secondary quantity of the material lot transacted for the work order. This attribute is associated with a feature that requires opt in.
• TransactionLotDFF: array Flexfields for Material Transaction Lots
  Title: Flexfields for Material Transaction Lots

  The Flexfields for Material Transaction Lots resource manages descriptive flexfields for process manufacturing work order output transactions. It doesn???t manage descriptive flexfields for work order component transactions.
• TransactionQuantity(required): number
  Title: Transaction Quantity

  Quantity of the material lot transacted for the work order.

{
    "required":[
        "LotNumber",
        "TransactionQuantity"
    ],
    "type":"object",
    "properties":{
        "TransactionQuantity":{
            "title":"Transaction Quantity",
            "type":"number",
            "description":"Quantity of the material lot transacted for the work order.",
            "nullable":false
        },
        "LotOriginationDate":{
            "title":"Lot Origination Date",
            "type":"string",
            "description":"Date when the lot originated. This attribute is required only if the item is lot controlled and transaction type code is ORDERLESS_COMPLETION.",
            "format":"date-time",
            "nullable":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
        },
        "SecondaryTransactionQuantity":{
            "title":"Secondary Transaction Quantity",
            "type":"number",
            "description":"Secondary quantity of the material lot transacted for the work order. This attribute is associated with a feature that requires opt in.",
            "nullable":true
        },
        "TransactionLotDFF":{
            "title":"Flexfields for Material Transaction Lots",
            "type":"array",
            "description":"The Flexfields for Material Transaction Lots resource manages descriptive flexfields for process manufacturing work order output transactions. It doesn???t manage descriptive flexfields for work order component transactions.",
            "items":{
                "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-TransactionLot-TransactionLotDFF-item-post-request"
            },
            "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
        },
        "LotExpirationDate":{
            "title":"Lot Expiration Date",
            "type":"string",
            "description":"Date when the component of this lot expires. This attribute is required only for a new lot and is applicable only for orderless completions.",
            "format":"date",
            "nullable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Lot number of the material (component) issued for the work order. This attribute is needed only if material is lot controlled.",
            "nullable":false
        }
    }
}

Nested Schema : Flexfields for Material Transaction Lots

Type: array

Title: Flexfields for Material Transaction Lots

The Flexfields for Material Transaction Lots resource manages descriptive flexfields for process manufacturing work order output transactions. It doesn???t manage descriptive flexfields for work order component transactions.

Show Source

• Array of: object schema

{
    "title":"Flexfields for Material Transaction Lots",
    "type":"array",
    "description":"The Flexfields for Material Transaction Lots resource manages descriptive flexfields for process manufacturing work order output transactions. It doesn???t manage descriptive flexfields for work order component transactions.",
    "items":{
        "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-TransactionLot-TransactionLotDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

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 display value for transaction lots.
• Discriminator: string
  This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
• InterfaceRowId: integer (int64)
  Value that identifies the transaction lot that a descriptive flexfield references. This attribute is a primary key. It is recommended that you not include this attribute in the request payload.

{
    "type":"object",
    "properties":{
        "InterfaceRowId":{
            "type":"integer",
            "description":"Value that identifies the transaction lot that a descriptive flexfield references. This attribute is a primary key. It is recommended that you not include this attribute in the request payload.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield 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"
                }
            }
        },
        "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"
            }
        },
        "__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"
                }
            }
        }
    }
}

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

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

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

  Maximum Length: 2000

  Text of the error message, if any, when processing 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.
• LotExpirationDate: string (date)
  Title: Lot Expiration Date

  Date when the component of this lot expires. This attribute is required only for a new lot and is applicable only for orderless completions.
• 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 of the material (component) issued for the work order. This attribute is needed only if material is lot controlled.
• LotOriginationDate: string (date-time)
  Title: Lot Origination Date

  Date when the lot originated. This attribute is required only if the item is lot controlled and transaction type code is ORDERLESS_COMPLETION.
• 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
  Title: Secondary Transaction Quantity

  Secondary quantity of the material lot transacted for the work order. This attribute is associated with a feature that requires opt in.
• TransactionLotDFF: array Flexfields for Material Transaction Lots
  Title: Flexfields for Material Transaction Lots

  The Flexfields for Material Transaction Lots resource manages descriptive flexfields for process manufacturing work order output transactions. It doesn???t manage descriptive flexfields for work order component transactions.
• TransactionQuantity: number
  Title: Transaction Quantity

  Quantity of the material 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 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":"Quantity of the material lot transacted for the work order.",
            "nullable":false,
            "x-queryable":true
        },
        "LotOriginationDate":{
            "title":"Lot Origination Date",
            "type":"string",
            "description":"Date when the lot originated. This attribute is required only if the item is lot controlled and transaction type code is ORDERLESS_COMPLETION.",
            "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
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the error message, if any, 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 material 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 Material Transaction Lots",
            "type":"array",
            "description":"The Flexfields for Material Transaction Lots resource manages descriptive flexfields for process manufacturing work order output transactions. It doesn???t manage descriptive flexfields for work order component transactions.",
            "items":{
                "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-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 when the component of this lot expires. This attribute is required only for a new lot and is applicable only for orderless completions.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Lot number of the material (component) issued for the work order. This attribute is needed only if material is lot controlled.",
            "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 Material Transaction Lots

Type: array

Title: Flexfields for Material Transaction Lots

The Flexfields for Material Transaction Lots resource manages descriptive flexfields for process manufacturing work order output transactions. It doesn???t manage descriptive flexfields for work order component transactions.

Show Source

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

{
    "title":"Flexfields for Material Transaction Lots",
    "type":"array",
    "description":"The Flexfields for Material Transaction Lots resource manages descriptive flexfields for process manufacturing work order output transactions. It doesn???t manage descriptive flexfields for work order component transactions.",
    "items":{
        "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-TransactionLot-TransactionLotDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : materialTransactions-MaterialTransactionDetail-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 display value for transaction lots.
• Discriminator: string
  This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
• InterfaceRowId: integer (int64)
  Value that identifies the transaction lot that a descriptive flexfield references. This attribute is a primary key. It is recommended that you not include this attribute in the request payload.
• 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 identifies the transaction lot that a descriptive flexfield references. This attribute is a primary key. It is recommended that you not include this attribute in the request payload.",
            "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 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
        },
        "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 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"
    }
}

Links

TransactionLotDFF

Operation: /fscmRestApi/resources/11.13.18.05/materialTransactions/{materialTransactionsUniqID}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/TransactionLot/{TransactionLotUniqID}/child/TransactionLotDFF

Parameters:

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

The Flexfields for Material Transaction Lots resource manages descriptive flexfields for process manufacturing work order output transactions. It doesn???t manage descriptive flexfields for work order component transactions.

Back to Top