Jump to

• Request
• Response

GET action not supported

get

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

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.
• TransactionLotUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Transaction Lots resource and used to uniquely identify an instance of Transaction Lots. The client should not generate the hash key value. Instead, the client should query on the Transaction Lots collection resource in order to navigate to a specific instance of Transaction Lots to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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 : maintenanceMaterialTransactions-MaterialTransactionDetail-TransactionLot-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

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

  Maximum Length: 2000

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

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

  Maximum Length: 80

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

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

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

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Flexfields for Transaction Lots

Type: array

Title: Flexfields for Transaction Lots

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

Show Source

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

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

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

  The link relations associated with the resource instance.

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

Parameters:

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

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

Back to Top