Jump to

• Request
• Response

UPDATE action not supported

patch

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

Request

Path Parameters

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

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

  Maximum Length: 80

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

  Maximum Length: 80

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

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

{
    "required":[
        "SerialNumber"
    ],
    "type":"object",
    "properties":{
        "TransactionSerialDFF":{
            "title":"Flexfields for Transaction Serials",
            "type":"array",
            "description":"The Flexfields for Transaction Serials resource manages descriptive flexfields that contain details about the serial component transaction.",
            "items":{
                "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the serial number of the component item being issued or returned from a maintenance work order.",
            "nullable":false
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":18,
            "type":"string",
            "description":"Number that identifies the lot number of the serial controlled component item being issued or returned from a maintenance work order.",
            "nullable":true
        },
        "SerialNumberTo":{
            "title":"To Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that indicates the last serial number of the component items being issued or returned from a maintenance work order.",
            "nullable":true
        }
    }
}

Nested Schema : Flexfields for Transaction Serials

Type: array

Title: Flexfields for Transaction Serials

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

Show Source

• Array of: object maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-patch-request

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

Nested Schema : maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "InterfaceRowId":{
            "type":"integer",
            "description":"Primary key of the serial component transaction that references a descriptive flexfield. It is recommended that you not include this attribute in the request payload. The response payload contains the primary key of the serial component transaction that references the descriptive flexfield.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "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 the serial component transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Names of the error messages that occurred when processing the transaction serial. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separates each message name.
• ErrorMessages: string
  Read Only: true

  Maximum Length: 2000

  Text of the error messages that occurred when processing this transaction serial. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotNumber: string
  Title: Lot Number

  Maximum Length: 18

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

  Maximum Length: 80

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

  Maximum Length: 80

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

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

{
    "type":"object",
    "properties":{
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error messages that occurred when processing this transaction serial. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionSerialDFF":{
            "title":"Flexfields for Transaction Serials",
            "type":"array",
            "description":"The Flexfields for Transaction Serials resource manages descriptive flexfields that contain details about the serial component transaction.",
            "items":{
                "$ref":"#/components/schemas/maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionSerial-TransactionSerialDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the serial number of the component item being issued or returned from a maintenance work order.",
            "nullable":false,
            "x-queryable":true
        },
        "SerialNumberTo":{
            "title":"To Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that indicates the last serial number of the component items being issued or returned from a maintenance work order.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Names of the error messages that occurred when processing the transaction serial. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma ( , ) separates each message name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":18,
            "type":"string",
            "description":"Number that identifies the lot number of the serial controlled component item being issued or returned from a maintenance work order.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Flexfields for Transaction Serials

Type: array

Title: Flexfields for Transaction Serials

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

Show Source

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

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

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

  The link relations associated with the resource instance.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

TransactionSerialDFF

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

Parameters:

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

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

Back to Top