Jump to

• Request
• Response

Create recalled lot numbers

post

/fscmRestApi/resources/11.13.18.05/captureAndValidateRecallNotices/{HeaderId}/child/captureAndValidateRecallLines/{LineId}/child/recalledLotNumbers

Request

Path Parameters

• HeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• LineId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

• ExpirationDate: string (date)
  Expiration date for the recalled lot provided by the source of recall.
• HeaderId(required): integer (int64)
  Recall header identifier to which the recalled lots are associated.
• LineId(required): integer (int64)
  Recall line identifier to which the recalled lots are associated.
• LotId: integer (int64)
  Recall notice lot identifier.
• MfgLotNumber: string
  Maximum Length: 80

  Recalled lot number provided by the source of recall.
• recalledLotSerialNumbers: array Recall Lot Serial Numbers
  Title: Recall Lot Serial Numbers

  Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.

{
    "required":[
        "HeaderId",
        "LineId"
    ],
    "type":"object",
    "properties":{
        "HeaderId":{
            "type":"integer",
            "description":"Recall header identifier to which the recalled lots are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MfgLotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Recalled lot number provided by the source of recall.",
            "nullable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date for the recalled lot provided by the source of recall.",
            "format":"date",
            "nullable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Recall line identifier to which the recalled lots are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "recalledLotSerialNumbers":{
            "title":"Recall Lot Serial Numbers",
            "type":"array",
            "description":"Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-recalledLotSerialNumbers-item-post-request"
            }
        },
        "LotId":{
            "type":"integer",
            "description":"Recall notice lot identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Nested Schema : Recall Lot Serial Numbers

Type: array

Title: Recall Lot Serial Numbers

Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.

Show Source

• Array of: object schema

{
    "title":"Recall Lot Serial Numbers",
    "type":"array",
    "description":"Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.",
    "items":{
        "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-recalledLotSerialNumbers-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• HeaderId: integer (int64)
  Recall header identifier to which the recalled lot serial numbers are associated.
• LineId: integer (int64)
  Recall line identifier to which the recalled lot serial numbers are associated.
• LotId: integer (int64)
  Recall lot identifier to which the recalled serial numbers are associated.
• MfgFromSerialNumber: string
  Maximum Length: 80

  Starting serial number pertaining to specific lot that's recalled as provided by the source of recall.
• MfgToSerialNumber: string
  Maximum Length: 80

  Ending serial number pertaining to specific lot that's recalled as provided by the source of recall.
• Quantity: number
  Quantity of serial numbers that are recalled for a given recalled lot.
• SerialId: integer (int64)
  Recall notice lot serial identifier.

{
    "type":"object",
    "properties":{
        "LineId":{
            "type":"integer",
            "description":"Recall line identifier to which the recalled lot serial numbers are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MfgFromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number pertaining to specific lot that's recalled as provided by the source of recall.",
            "nullable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Recall header identifier to which the recalled lot serial numbers are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of serial numbers that are recalled for a given recalled lot.",
            "nullable":true
        },
        "SerialId":{
            "type":"integer",
            "description":"Recall notice lot serial identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "MfgToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number pertaining to specific lot that's recalled as provided by the source of recall.",
            "nullable":true
        },
        "LotId":{
            "type":"integer",
            "description":"Recall lot identifier to which the recalled serial numbers are associated.",
            "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:
  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 : captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-item-response

Type: object

Show Source

• ExpirationDate: string (date)
  Expiration date for the recalled lot provided by the source of recall.
• HeaderId: integer (int64)
  Recall header identifier to which the recalled lots are associated.
• LineId: integer (int64)
  Recall line identifier to which the recalled lots are associated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotId: integer (int64)
  Recall notice lot identifier.
• MfgLotNumber: string
  Maximum Length: 80

  Recalled lot number provided by the source of recall.
• recalledLotSerialNumbers: array Recall Lot Serial Numbers
  Title: Recall Lot Serial Numbers

  Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.

{
    "type":"object",
    "properties":{
        "MfgLotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Recalled lot number provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date for the recalled lot provided by the source of recall.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Recall line identifier to which the recalled lots are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "recalledLotSerialNumbers":{
            "title":"Recall Lot Serial Numbers",
            "type":"array",
            "description":"Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-recalledLotSerialNumbers-item-response"
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Recall header identifier to which the recalled lots are associated.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "LotId":{
            "type":"integer",
            "description":"Recall notice lot identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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 : Recall Lot Serial Numbers

Type: array

Title: Recall Lot Serial Numbers

Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.

Show Source

• Array of: object captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-recalledLotSerialNumbers-item-response

{
    "title":"Recall Lot Serial Numbers",
    "type":"array",
    "description":"Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.",
    "items":{
        "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-recalledLotSerialNumbers-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 : captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-recalledLotSerialNumbers-item-response

Type: object

Show Source

• HeaderId: integer (int64)
  Recall header identifier to which the recalled lot serial numbers are associated.
• LineId: integer (int64)
  Recall line identifier to which the recalled lot serial numbers are associated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotId: integer (int64)
  Recall lot identifier to which the recalled serial numbers are associated.
• MfgFromSerialNumber: string
  Maximum Length: 80

  Starting serial number pertaining to specific lot that's recalled as provided by the source of recall.
• MfgToSerialNumber: string
  Maximum Length: 80

  Ending serial number pertaining to specific lot that's recalled as provided by the source of recall.
• Quantity: number
  Quantity of serial numbers that are recalled for a given recalled lot.
• SerialId: integer (int64)
  Recall notice lot serial identifier.

{
    "type":"object",
    "properties":{
        "LineId":{
            "type":"integer",
            "description":"Recall line identifier to which the recalled lot serial numbers are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MfgFromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number pertaining to specific lot that's recalled as provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Recall header identifier to which the recalled lot serial numbers are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of serial numbers that are recalled for a given recalled lot.",
            "nullable":true,
            "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":"Recall notice lot serial identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MfgToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number pertaining to specific lot that's recalled as provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "LotId":{
            "type":"integer",
            "description":"Recall lot identifier to which the recalled serial numbers are associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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

recalledLotSerialNumbers

Operation: /fscmRestApi/resources/11.13.18.05/captureAndValidateRecallNotices/{HeaderId}/child/captureAndValidateRecallLines/{LineId}/child/recalledLotNumbers/{LotId}/child/recalledLotSerialNumbers

Parameters:

• HeaderId: $request.path.HeaderId
• LineId: $request.path.LineId
• LotId: $request.path.LotId

Recalled serial numbers pertaining to specific lots of the recalled parts on the recall notices.

Back to Top