Jump to

• Request
• Response

Update a lot serial number

patch

/fscmRestApi/resources/11.13.18.05/recallNotices/{HeaderId}/child/recallLines/{LineId}/child/recallLotNumbers/{LotId}/child/recallLotSerialNumbers/{SerialId}

Request

Path Parameters

• HeaderId(required): integer(int64)
  Value that uniquely identifies the recall notice header.
• LineId(required): integer(int64)
  Value that uniquely identifies the recall notice line.
• LotId(required): integer(int64)
  Value that uniquely identifies the recalled lot.
• SerialId(required): integer(int64)
  Value that uniquely identifies the recalled lot serial number.

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

• HeaderId: integer (int64)
  Value that uniquely identifies the recall notice header.
• LineId: integer (int64)
  Value that uniquely identifies the recall notice line.
• LotId: integer (int64)
  Value that uniquely identifies the recalled lot.
• MfgFromSerialNumber: string
  Title: From Serial Number

  Maximum Length: 80

  Starting serial number as specified by the manufacturer in the recall notice.
• MfgToSerialNumber: string
  Title: To Serial Number

  Maximum Length: 80

  Ending serial number as specified by the manufacturer in the recall notice.
• ObjectVersionNumber: integer (int32)
  Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
• Quantity: number
  Title: Quantity

  Quantity of the recalled serial number. This is an optional value that is used to calculate ToSerialNumber when the quantity is added to FromSerialNumber.
• SerialEntryMode: string
  Maximum Length: 60

  Default Value: ByRange

  Mode whether or not to enter an individual serial or a serial in range.

{
    "type":"object",
    "properties":{
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MfgFromSerialNumber":{
            "title":"From Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number as specified by the manufacturer in the recall notice.",
            "nullable":true
        },
        "SerialEntryMode":{
            "maxLength":60,
            "type":"string",
            "description":"Mode whether or not to enter an individual serial or a serial in range.",
            "nullable":true,
            "default":"ByRange"
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the recalled serial number. This is an optional value that is used to calculate ToSerialNumber when the quantity is added to FromSerialNumber.",
            "nullable":true
        },
        "MfgToSerialNumber":{
            "title":"To Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number as specified by the manufacturer in the recall notice.",
            "nullable":true
        },
        "LotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled lot.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : recallNotices-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• HeaderId: integer (int64)
  Value that uniquely identifies the recall notice header.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the document.
• LineId: integer (int64)
  Value that uniquely identifies the recall notice line.
• LineNumber: integer (int64)
  Title: Line Number

  Read Only: true

  Number that identifies the recall notice line entered by the user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotId: integer (int64)
  Value that uniquely identifies the recalled lot.
• MfgFromSerialNumber: string
  Title: From Serial Number

  Maximum Length: 80

  Starting serial number as specified by the manufacturer in the recall notice.
• MfgToSerialNumber: string
  Title: To Serial Number

  Maximum Length: 80

  Ending serial number as specified by the manufacturer in the recall notice.
• ObjectVersionNumber: integer (int32)
  Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
• Quantity: number
  Title: Quantity

  Quantity of the recalled serial number. This is an optional value that is used to calculate ToSerialNumber when the quantity is added to FromSerialNumber.
• SerialEntryMode: string
  Maximum Length: 60

  Default Value: ByRange

  Mode whether or not to enter an individual serial or a serial in range.
• SerialId: integer (int64)
  Value that uniquely identifies the recalled serial number.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the recalled serial number. This is an optional value that is used to calculate ToSerialNumber when the quantity is added to FromSerialNumber.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Number that identifies the recall notice line entered by the user.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled lot.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MfgFromSerialNumber":{
            "title":"From Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number as specified by the manufacturer in the recall notice.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialEntryMode":{
            "maxLength":60,
            "type":"string",
            "description":"Mode whether or not to enter an individual serial or a serial in range.",
            "nullable":true,
            "default":"ByRange",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SerialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recalled serial number.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MfgToSerialNumber":{
            "title":"To Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number as specified by the manufacturer in the recall notice.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "nullable":true,
            "readOnly":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