Jump to

• Request
• Response

Create serials

post

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

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

• LotNumber: string
  Title: Lot Number

  Maximum Length: 18

  Lot number of the serial of the component that the application issued for the work order. This attribute is optional.
• SerialNumber(required): string
  Title: Serial Number

  Maximum Length: 80

  Starting serial number that identifies the component that the application issued for the work order.
• SerialNumberTo: string
  Title: To Serial Number

  Maximum Length: 80

  Ending serial number that identifies the component that the application issued for the work order.
• TransactionSerialDFF: array Flexfields for Material Transaction Serials
  Title: Flexfields for Material Transaction Serials

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

{
    "required":[
        "SerialNumber"
    ],
    "type":"object",
    "properties":{
        "TransactionSerialDFF":{
            "title":"Flexfields for Material Transaction Serials",
            "type":"array",
            "description":"The Flexfields for Material Transaction Serials resource manages descriptive flexfields that contain details about the transaction serial.",
            "items":{
                "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Starting serial number that identifies the component that the application issued for the work order.",
            "nullable":false
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"18",
            "type":"string",
            "description":"Lot number of the serial of the component that the application issued for the work order. This attribute is optional.",
            "nullable":true
        },
        "SerialNumberTo":{
            "title":"To Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Ending serial number that identifies the component that the application issued for the work order.",
            "nullable":true
        }
    }
}

Nested Schema : Flexfields for Material Transaction Serials

Type: array

Title: Flexfields for Material Transaction Serials

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

Show Source

• Array of: object materialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-post-request

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

Nested Schema : materialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

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

  Descriptive flexfield context display value for transactions serials.
• 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 transaction lot 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 transaction lot.

{
    "type":"object",
    "properties":{
        "InterfaceRowId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction lot 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 transaction lot.",
            "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 context display value for transactions 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"
                }
            }
        },
        "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 transactions 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"
                }
            }
        }
    }
}

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-TransactionSerial-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 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 message, if any, 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

  Lot number of the serial of the component that the application issued for the work order. This attribute is optional.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Starting serial number that identifies the component that the application issued for the work order.
• SerialNumberTo: string
  Title: To Serial Number

  Maximum Length: 80

  Ending serial number that identifies the component that the application issued for the work order.
• TransactionSerialDFF: array Flexfields for Material Transaction Serials
  Title: Flexfields for Material Transaction Serials

  The Flexfields for Material 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 message, if any, 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 Material Transaction Serials",
            "type":"array",
            "description":"The Flexfields for Material Transaction Serials resource manages descriptive flexfields that contain details about the transaction serial.",
            "items":{
                "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Starting serial number that identifies the component that the application issued for the work order.",
            "nullable":false,
            "x-queryable":true
        },
        "SerialNumberTo":{
            "title":"To Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Ending serial number that identifies the component that the application issued for the work order.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the error message, if any, 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":"Lot number of the serial of the component that the application issued for the work order. This attribute is optional.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Flexfields for Material Transaction Serials

Type: array

Title: Flexfields for Material Transaction Serials

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

Show Source

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

{
    "title":"Flexfields for Material Transaction Serials",
    "type":"array",
    "description":"The Flexfields for Material Transaction Serials resource manages descriptive flexfields that contain details about the transaction serial.",
    "items":{
        "$ref":"#/components/schemas/materialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-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-TransactionSerial-TransactionSerialDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

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

  Descriptive flexfield context display value for transactions serials.
• 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 transaction lot 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 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 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 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 transactions 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
        },
        "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 transactions 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"
    }
}

Links

TransactionSerialDFF

Operation: /fscmRestApi/resources/11.13.18.05/materialTransactions/{materialTransactionsUniqID}/child/MaterialTransactionDetail/{MaterialTransactionDetailUniqID}/child/TransactionSerial/{TransactionSerialUniqID}/child/TransactionSerialDFF

Parameters:

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

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

Back to Top