REST API for Oracle Supply Chain Management Cloud

Get one lot serial number

get

/fscmRestApi/resources/11.13.18.05/inventoryStagedTransactions/{TransactionInterfaceId}/child/lots/{lotsUniqID}/child/lotSerials/{lotSerialsUniqID}

Request

Path Parameters

TransactionInterfaceId(required): integer(int64)

Value that uniquely identifies the transaction.
lotSerialsUniqID(required): string

This is the hash key of the attributes which make up the composite key--- TransactionInterfaceId and FmSerialNumber ---for the Lot Serials resource and used to uniquely identify an instance of Lot Serials. The client should not generate the hash key value. Instead, the client should query on the Lot Serials collection resource with a filter on the primary key values in order to navigate to a specific instance of Lot Serials.

For example: lotSerials?q=TransactionInterfaceId=<value1>;FmSerialNumber=<value2>
lotsUniqID(required): string

This is the hash key of the attributes which make up the composite key--- TransactionInterfaceId and LotNumber ---for the Lots resource and used to uniquely identify an instance of Lots. The client should not generate the hash key value. Instead, the client should query on the Lots collection resource with a filter on the primary key values in order to navigate to a specific instance of Lots.

For example: lots?q=TransactionInterfaceId=<value1>;LotNumber=<value2>

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.

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.

Root Schema : inventoryStagedTransactions-lots-lotSerials-item-response

Type: object

Show Source

ErrorCode: string

Maximum Length: 240

Abbreviation that identifies the error.
FmSerialNumber: string

Maximum Length: 80

Starting serial number in a range of serial numbers.
links: array Links

Title: Links

The link relations associated with the resource instance.
OriginationDate: string (date)

Date when this lot serial originated.
serialAttributeDFFs: array Flexfields for Serial Attributes

Title: Flexfields for Serial Attributes

A flexible data field that includes details about serial attributes. Use this resource only when the item is serial-controlled.
serialStandardDFFs: array Flexfields for Serials

Title: Flexfields for Serials

A flexible data field that includes details about serials. Use this resource only when the item is serial-controlled.
SourceCode: string

Maximum Length: 30

Abbreviation that identifies the source.
SourceLineId: integer (int64)

Value that uniquely identifies the source line.
StatusCode: string

Maximum Length: 80

Abbreviation that identifies the status.
StatusId: integer (int64)

Value that uniquely identifies the status.
StatusName: string

Maximum Length: 30

Description of the status.
ToSerialNumber: string

Maximum Length: 80

Ending serial number in a range of serial numbers.
TransactionInterfaceId: integer (int64)

Value that uniquely identifies the transaction.
VendorSerialNumber: string

Maximum Length: 80

Vendor serial number corresponding to a serial number for an item.

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "serialStandardDFFs":{
            "title":"Flexfields for Serials",
            "type":"array",
            "description":"A flexible data field that includes details about serials. Use this resource only when the item is serial-controlled.",
            "items":{
                "$ref":"#/components/schemas/inventoryStagedTransactions-lots-lotSerials-serialStandardDFFs-item-response"
            },
            "x-cardinality":"1"
        },
        "SourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the source.",
            "nullable":true,
            "x-queryable":true
        },
        "ToSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Ending serial number in a range of serial numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusName":{
            "maxLength":"30",
            "type":"string",
            "description":"Description of the status.",
            "nullable":true,
            "x-queryable":true
        },
        "serialAttributeDFFs":{
            "title":"Flexfields for Serial Attributes",
            "type":"array",
            "description":"A flexible data field that includes details about serial attributes. Use this resource only when the item is serial-controlled.",
            "items":{
                "$ref":"#/components/schemas/inventoryStagedTransactions-lots-lotSerials-serialAttributeDFFs-item-response"
            },
            "x-cardinality":"1"
        },
        "SourceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the status.",
            "nullable":true,
            "x-queryable":true
        },
        "VendorSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Vendor serial number corresponding to a serial number for an item.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginationDate":{
            "type":"string",
            "description":"Date when this lot serial originated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ErrorCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the error.",
            "nullable":true,
            "x-queryable":true
        },
        "FmSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Starting serial number in a range of serial numbers.",
            "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 Serial Attributes

Type: array

Title: Flexfields for Serial Attributes

A flexible data field that includes details about serial attributes. Use this resource only when the item is serial-controlled.

Show Source

Array of: object inventoryStagedTransactions-lots-lotSerials-serialAttributeDFFs-item-response

{
    "title":"Flexfields for Serial Attributes",
    "type":"array",
    "description":"A flexible data field that includes details about serial attributes. Use this resource only when the item is serial-controlled.",
    "items":{
        "$ref":"#/components/schemas/inventoryStagedTransactions-lots-lotSerials-serialAttributeDFFs-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Flexfields for Serials

Type: array

Title: Flexfields for Serials

A flexible data field that includes details about serials. Use this resource only when the item is serial-controlled.

Show Source

Array of: object inventoryStagedTransactions-lots-lotSerials-serialStandardDFFs-item-response

{
    "title":"Flexfields for Serials",
    "type":"array",
    "description":"A flexible data field that includes details about serials. Use this resource only when the item is serial-controlled.",
    "items":{
        "$ref":"#/components/schemas/inventoryStagedTransactions-lots-lotSerials-serialStandardDFFs-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 : inventoryStagedTransactions-lots-lotSerials-serialAttributeDFFs-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Value

Maximum Length: 30

Descriptive flexfield context name for serial attributes.
__FLEX_Context_DisplayValue: string

Title: Context Value

Descriptive flexfield context display value for serial attributes.
FromSerialNumber: string

Maximum Length: 80
links: array Links

Title: Links

The link relations associated with the resource instance.
TransactionInterfaceId: integer (int64)

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for serial attributes.",
            "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 serial attributes.",
            "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 : inventoryStagedTransactions-lots-lotSerials-serialStandardDFFs-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Value

Maximum Length: 30

Descriptive flexfield context name for serial standards.
__FLEX_Context_DisplayValue: string

Title: Context Value

Descriptive flexfield context display value for serial standards.
FromSerialNumber: string

Maximum Length: 80
links: array Links

Title: Links

The link relations associated with the resource instance.
TransactionInterfaceId: integer (int64)

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for serial standards.",
            "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 serial standards.",
            "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

serialAttributeDFFs

Operation: /fscmRestApi/resources/11.13.18.05/inventoryStagedTransactions/{TransactionInterfaceId}/child/lots/{lotsUniqID}/child/lotSerials/{lotSerialsUniqID}/child/serialAttributeDFFs

Parameters:

TransactionInterfaceId: $request.path.TransactionInterfaceId
lotSerialsUniqID: $request.path.lotSerialsUniqID
lotsUniqID: $request.path.lotsUniqID

A flexible data field that includes details about serial attributes. Use this resource only when the item is serial-controlled.

serialStandardDFFs

Operation: /fscmRestApi/resources/11.13.18.05/inventoryStagedTransactions/{TransactionInterfaceId}/child/lots/{lotsUniqID}/child/lotSerials/{lotSerialsUniqID}/child/serialStandardDFFs

Parameters:

TransactionInterfaceId: $request.path.TransactionInterfaceId
lotSerialsUniqID: $request.path.lotSerialsUniqID
lotsUniqID: $request.path.lotsUniqID

A flexible data field that includes details about serials. Use this resource only when the item is serial-controlled.