Jump to

• Request
• Response

GET action not supported

get

/fscmRestApi/resources/11.13.18.05/inventoryBalanceTransactions/{inventoryBalanceTransactionsUniqID}/child/transactionLines/{transactionLinesUniqID}/child/itemSerials/{itemSerialsUniqID}

Request

Path Parameters

• inventoryBalanceTransactionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Inventory Balance Transactions resource and used to uniquely identify an instance of Inventory Balance Transactions. The client should not generate the hash key value. Instead, the client should query on the Inventory Balance Transactions collection resource in order to navigate to a specific instance of Inventory Balance Transactions to get the hash key.
• itemSerialsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Serial Details for Items resource and used to uniquely identify an instance of Serial Details for Items. The client should not generate the hash key value. Instead, the client should query on the Serial Details for Items collection resource in order to navigate to a specific instance of Serial Details for Items to get the hash key.
• transactionLinesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Transaction Lines resource and used to uniquely identify an instance of Transaction Lines. The client should not generate the hash key value. Instead, the client should query on the Transaction Lines collection resource in order to navigate to a specific instance of Transaction Lines 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(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 : inventoryBalanceTransactions-transactionLines-itemSerials-item-response

Type: object

Show Source

• dffForItemSerials: array Flexfields for Serials
  Title: Flexfields for Serials

  The Flexfields for Serials resource manages descriptive flexfields that contain details about the item when a serial controls the item.
• FromSerialNumber: string
  Title: From Serial Number

  Maximum Length: 80

  Starting serial number in a range of serial. This attribute is used when the warehouse places the item under serial control.
• FromVendorSerialNumber: string
  Title: Supplier Serial Number

  Maximum Length: 80

  Starting supplier serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginationDate: string (date)
  Title: Origination Date

  Date when the serial originated.
• StatusCode: string
  Title: Material Status

  Maximum Length: 80

  Abbreviation that identifies the serial status.
• StatusId: integer (int64)
  Value that uniquely identifies the serial status.
• StatusName: string
  Title: Description

  Maximum Length: 240

  Name of the serial status.
• TerritoryCode: string
  Maximum Length: 30

  Value that uniquely identifies the territory.
• TerritoryShortName: string
  Maximum Length: 80

  Name of the territory.
• ToSerialNumber: string
  Title: To Serial Number

  Maximum Length: 80

  Ending serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.
• ToVendorSerialNumber: string
  Title: Supplier Serial Number

  Maximum Length: 80

  Ending supplier serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.

{
    "type":"object",
    "properties":{
        "ToVendorSerialNumber":{
            "title":"Supplier Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Ending supplier serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.",
            "nullable":true,
            "x-queryable":true
        },
        "FromSerialNumber":{
            "title":"From Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number in a range of serial. This attribute is used when the warehouse places the item under serial control.",
            "nullable":false,
            "x-queryable":true
        },
        "FromVendorSerialNumber":{
            "title":"Supplier Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Starting supplier serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginationDate":{
            "title":"Origination Date",
            "type":"string",
            "description":"Date when the serial originated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ToSerialNumber":{
            "title":"To Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.",
            "nullable":false,
            "x-queryable":true
        },
        "TerritoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the serial 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"
            }
        },
        "StatusName":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Name of the serial status.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryShortName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Material Status",
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the serial status.",
            "nullable":true,
            "x-queryable":true
        },
        "dffForItemSerials":{
            "title":"Flexfields for Serials",
            "type":"array",
            "description":"The Flexfields for Serials resource manages descriptive flexfields that contain details about the item when a serial controls the item.",
            "items":{
                "$ref":"#/components/schemas/inventoryBalanceTransactions-transactionLines-itemSerials-dffForItemSerials-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Flexfields for Serials

Type: array

Title: Flexfields for Serials

The Flexfields for Serials resource manages descriptive flexfields that contain details about the item when a serial controls the item.

Show Source

• Array of: object inventoryBalanceTransactions-transactionLines-itemSerials-dffForItemSerials-item-response

{
    "title":"Flexfields for Serials",
    "type":"array",
    "description":"The Flexfields for Serials resource manages descriptive flexfields that contain details about the item when a serial controls the item.",
    "items":{
        "$ref":"#/components/schemas/inventoryBalanceTransactions-transactionLines-itemSerials-dffForItemSerials-item-response"
    },
    "x-cardinality":"1"
}

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 : inventoryBalanceTransactions-transactionLines-itemSerials-dffForItemSerials-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for serials when an item is under serial control.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield context display value for serials when an item is under serial control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SerialTxnInterfaceId: integer (int64)
  Value that uniquely identifies the serial balance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SerialTxnInterfaceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the serial balance.",
            "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 serials when an item is under serial control.",
            "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 serials when an item is under serial control.",
            "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"
    }
}

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."
        }
    }
}

Links

dffForItemSerials

Operation: /fscmRestApi/resources/11.13.18.05/inventoryBalanceTransactions/{inventoryBalanceTransactionsUniqID}/child/transactionLines/{transactionLinesUniqID}/child/itemSerials/{itemSerialsUniqID}/child/dffForItemSerials

Parameters:

• inventoryBalanceTransactionsUniqID: $request.path.inventoryBalanceTransactionsUniqID
• itemSerialsUniqID: $request.path.itemSerialsUniqID
• transactionLinesUniqID: $request.path.transactionLinesUniqID

The Flexfields for Serials resource manages descriptive flexfields that contain details about the item when a serial controls the item.

Back to Top