Jump to

• Request
• Response
• Examples

Create one lot number

post

/fscmRestApi/resources/11.13.18.05/interfacedPickTransactions/{TransactionInterfaceId}/child/lots

Request

Path Parameters

• TransactionInterfaceId(required): integer(int64)
  Interface identifier for the pick-confirm transaction.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• LotNumber(required): string
  Maximum Length: 80

  Lot number for the item.
• lotSerials: array Lot Serials
  Title: Lot Serials

  The Lot Serials resource manages the serials for a lot of an interfaed pick transaction when an item is both lot and serial-controlled.
• PrimaryQuantity: number
  Transaction quantity in the primary unit of measure that the item uses.
• SecondaryTransactionQuantity: number
  Transaction quantity of an item in its secondary unit of measure.
• TransactionQuantity(required): number
  Transaction quantity of the item.

{
    "required":[
        "LotNumber",
        "TransactionQuantity"
    ],
    "type":"object",
    "properties":{
        "PrimaryQuantity":{
            "type":"number",
            "description":"Transaction quantity in the primary unit of measure that the item uses.",
            "nullable":true
        },
        "SecondaryTransactionQuantity":{
            "type":"number",
            "description":"Transaction quantity of an item in its secondary unit of measure.",
            "nullable":true
        },
        "lotSerials":{
            "title":"Lot Serials",
            "type":"array",
            "description":"The Lot Serials resource manages the serials for a lot of an interfaed pick transaction when an item is both lot and serial-controlled.",
            "items":{
                "$ref":"#/components/schemas/interfacedPickTransactions-lots-lotSerials-item-post-request"
            }
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"Transaction quantity of the item.",
            "nullable":false
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Lot number for the item.",
            "nullable":false
        }
    }
}

Nested Schema : Lot Serials

Type: array

Title: Lot Serials

The Lot Serials resource manages the serials for a lot of an interfaed pick transaction when an item is both lot and serial-controlled.

Show Source

• Array of: object interfacedPickTransactions-lots-lotSerials-item-post-request

{
    "title":"Lot Serials",
    "type":"array",
    "description":"The Lot Serials resource manages the serials for a lot of an interfaed pick transaction when an item is both lot and serial-controlled.",
    "items":{
        "$ref":"#/components/schemas/interfacedPickTransactions-lots-lotSerials-item-post-request"
    }
}

Nested Schema : interfacedPickTransactions-lots-lotSerials-item-post-request

Type: object

Show Source

• FromSerialNumber: string
  Maximum Length: 80

  Starting serial number in a range of serial numbers for a serial-controlled item.
• ToSerialNumber: string
  Maximum Length: 80

  Ending serial number in a range of serial numbers for a serial-controlled item.

{
    "type":"object",
    "properties":{
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number in a range of serial numbers for a serial-controlled item.",
            "nullable":false
        },
        "ToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number in a range of serial numbers for a serial-controlled item.",
            "nullable":true
        }
    }
}

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 : interfacedPickTransactions-lots-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotNumber: string
  Maximum Length: 80

  Lot number for the item.
• lotSerials: array Lot Serials
  Title: Lot Serials

  The Lot Serials resource manages the serials for a lot of an interfaed pick transaction when an item is both lot and serial-controlled.
• PrimaryQuantity: number
  Transaction quantity in the primary unit of measure that the item uses.
• SecondaryTransactionQuantity: number
  Transaction quantity of an item in its secondary unit of measure.
• TransactionQuantity: number
  Transaction quantity of the item.

{
    "type":"object",
    "properties":{
        "PrimaryQuantity":{
            "type":"number",
            "description":"Transaction quantity in the primary unit of measure that the item uses.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryTransactionQuantity":{
            "type":"number",
            "description":"Transaction quantity of an item in its secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "lotSerials":{
            "title":"Lot Serials",
            "type":"array",
            "description":"The Lot Serials resource manages the serials for a lot of an interfaed pick transaction when an item is both lot and serial-controlled.",
            "items":{
                "$ref":"#/components/schemas/interfacedPickTransactions-lots-lotSerials-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"Transaction quantity of the item.",
            "nullable":false,
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Lot number for the item.",
            "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 : Lot Serials

Type: array

Title: Lot Serials

The Lot Serials resource manages the serials for a lot of an interfaed pick transaction when an item is both lot and serial-controlled.

Show Source

• Array of: object interfacedPickTransactions-lots-lotSerials-item-response

{
    "title":"Lot Serials",
    "type":"array",
    "description":"The Lot Serials resource manages the serials for a lot of an interfaed pick transaction when an item is both lot and serial-controlled.",
    "items":{
        "$ref":"#/components/schemas/interfacedPickTransactions-lots-lotSerials-item-response"
    }
}

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 : interfacedPickTransactions-lots-lotSerials-item-response

Type: object

Show Source

• FromSerialNumber: string
  Maximum Length: 80

  Starting serial number in a range of serial numbers for a serial-controlled item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ToSerialNumber: string
  Maximum Length: 80

  Ending serial number in a range of serial numbers for a serial-controlled item.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number in a range of serial numbers for a serial-controlled item.",
            "nullable":false,
            "x-queryable":true
        },
        "ToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number in a range of serial numbers for a serial-controlled item.",
            "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"
    }
}

Links

lotSerials

Operation: /fscmRestApi/resources/11.13.18.05/interfacedPickTransactions/{TransactionInterfaceId}/child/lots/{lotsUniqID}/child/lotSerials

Parameters:

• TransactionInterfaceId: $request.path.TransactionInterfaceId
• lotsUniqID: $request.path.lotsUniqID

The Lot Serials resource manages the serials for a lot of an interfaed pick transaction when an item is both lot and serial-controlled.

Back to Top

Examples

This example describes how to create one lot number.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/interfacedPickTransactions/TransactionInterfaceId/child/lots"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "LotNumber": "MFGLOT3",
    "TransactionQuantity": 10
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "LotNumber": "MFGLOT3",
    "PrimaryQuantity": null,
    "TransactionQuantity": 10,
    "SecondaryTransactionQuantity": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/interfacedPickTransactions/300100581351504/child/lots/00020000000EACED00057708000110F09C8C6050000000074D46474C4F5433",
            "name": "lots",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/interfacedPickTransactions/300100581351504/child/lots/00020000000EACED00057708000110F09C8C6050000000074D46474C4F5433",
            "name": "lots",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/interfacedPickTransactions/300100581351504",
            "name": "interfacedPickTransactions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/interfacedPickTransactions/300100581351504/child/lots/00020000000EACED00057708000110F09C8C6050000000074D46474C4F5433/child/lotSerials",
            "name": "lotSerials",
            "kind": "collection"
        }
    ]
}

Back to Top