Jump to

• Request
• Response
• Examples

Update one lot serial number

patch

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

Request

Path Parameters

• TransactionInterfaceId(required): integer(int64)
  Interface identifier for the pick-confirm transaction.
• lotSerialsUniqID(required): string
  This is the hash key of the attributes which make up the composite key 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 in order to navigate to a specific instance of Lot Serials to get the hash key.
• lotsUniqID(required): string
  This is the hash key of the attributes which make up the composite key 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 in order to navigate to a specific instance of Lots 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

• 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:
  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 : 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"
    }
}

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

Back to Top

Examples

This example describes how to update one lot serial number.

Example cURL Command

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

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

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.

{
    "FromSerialNumber": "SS1021",
    "ToSerialNumber": "SS1030"
}

Example Response Body

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

{
    "FromSerialNumber": "SS1021",
    "ToSerialNumber": "SS1030",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/interfacedPickTransactions/300100581347552/child/lots/00020000000EACED00057708000110F09C8C50E00000000641414C4F5431/child/lotSerials/00020000000EACED00057708000110F09C8C50E100000006535331303231",
            "name": "lotSerials",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/interfacedPickTransactions/300100581347552/child/lots/00020000000EACED00057708000110F09C8C50E00000000641414C4F5431/child/lotSerials/00020000000EACED00057708000110F09C8C50E100000006535331303231",
            "name": "lotSerials",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/interfacedPickTransactions/300100581347552/child/lots/00020000000EACED00057708000110F09C8C50E00000000641414C4F5431",
            "name": "lots",
            "kind": "item"
        }
    ]
}

Back to Top