Jump to

• Request
• Response

Create recall lines

post

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

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=

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

• BrandName: string
  Maximum Length: 60

  Brand name of the recalled part provided by the source of recall.
• Comments: string
  Maximum Length: 2000

  Comments in the recall line.
• DeviceIdentifier: string
  Maximum Length: 255

  Device identifier for the recalled part provided by the source of recall.
• GTIN: string
  Maximum Length: 255

  Global Trade Identification Number for the recalled part provided by the source of recall.
• HeaderId(required): integer (int64)
  Recall header identifier to which the recall lines are associated.
• InventoryItemId: integer (int64)
• LineId: integer (int64)
  Recall notice line identifier.
• ManufacturerPartNumber: string
  Manufacturer part number derived based on the part details captured in the recall notice.
• ModelNumber: string
  Maximum Length: 255

  Model number for the recalled part provided by the source of recall.
• PartDescription: string
  Maximum Length: 4000

  Description of the recalled part provided by the source of recall.
• PartNumber: string
  Maximum Length: 700

  Recalled part number provided by the source of recall.
• ProviderLineNumber: string
  Maximum Length: 60

  Unique recall line number passed by the provider.
• recalledLotNumbers: array Recall Lot Numbers
  Title: Recall Lot Numbers

  Recalled lot numbers pertaining to the recalled parts on the recall notices.
• recalledSerialNumbers: array Recall Serial Numbers
  Title: Recall Serial Numbers

  Recalled serial numbers pertaining to the recalled parts on the recall notices.
• ReceiptExistenceFlag: string
  Indicates whether the recalled item was received during the recall period.
• SupplierPartNumber: string
  Supplier part number derived based on the part details captured in the recall notice.
• WithdrawReasonCode: string
  Maximum Length: 30

  Reason code provided by the end user to withdraw a recall line.

{
    "required":[
        "HeaderId"
    ],
    "type":"object",
    "properties":{
        "ModelNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Model number for the recalled part provided by the source of recall.",
            "nullable":true
        },
        "recalledLotNumbers":{
            "title":"Recall Lot Numbers",
            "type":"array",
            "description":"Recalled lot numbers pertaining to the recalled parts on the recall notices.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-item-post-request"
            }
        },
        "LineId":{
            "type":"integer",
            "description":"Recall notice line identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Recalled part number provided by the source of recall.",
            "nullable":true
        },
        "Comments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments in the recall line.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "HeaderId":{
            "type":"integer",
            "description":"Recall header identifier to which the recall lines are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ManufacturerPartNumber":{
            "type":"string",
            "description":"Manufacturer part number derived based on the part details captured in the recall notice.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "WithdrawReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason code provided by the end user to withdraw a recall line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProviderLineNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Unique recall line number passed by the provider.",
            "nullable":true
        },
        "ReceiptExistenceFlag":{
            "type":"string",
            "description":"Indicates whether the recalled item was received during the recall period.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "DeviceIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Device identifier for the recalled part provided by the source of recall.",
            "nullable":true
        },
        "BrandName":{
            "maxLength":60,
            "type":"string",
            "description":"Brand name of the recalled part provided by the source of recall.",
            "nullable":true
        },
        "GTIN":{
            "maxLength":255,
            "type":"string",
            "description":"Global Trade Identification Number for the recalled part provided by the source of recall.",
            "nullable":true
        },
        "PartDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the recalled part provided by the source of recall.",
            "nullable":true
        },
        "SupplierPartNumber":{
            "type":"string",
            "description":"Supplier part number derived based on the part details captured in the recall notice.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "recalledSerialNumbers":{
            "title":"Recall Serial Numbers",
            "type":"array",
            "description":"Recalled serial numbers pertaining to the recalled parts on the recall notices.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledSerialNumbers-item-post-request"
            }
        }
    }
}

Nested Schema : Recall Lot Numbers

Type: array

Title: Recall Lot Numbers

Recalled lot numbers pertaining to the recalled parts on the recall notices.

Show Source

• Array of: object schema

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

Nested Schema : Recall Serial Numbers

Type: array

Title: Recall Serial Numbers

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

Show Source

• Array of: object schema

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

Nested 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
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

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

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

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

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

Type: object

Show Source

• BrandName: string
  Maximum Length: 60

  Brand name of the recalled part provided by the source of recall.
• Comments: string
  Maximum Length: 2000

  Comments in the recall line.
• DeviceIdentifier: string
  Maximum Length: 255

  Device identifier for the recalled part provided by the source of recall.
• GTIN: string
  Maximum Length: 255

  Global Trade Identification Number for the recalled part provided by the source of recall.
• HeaderId: integer (int64)
  Recall header identifier to which the recall lines are associated.
• InventoryItemId: integer (int64)
• InventoryItemId1: integer (int64)
  Title: Item Number

  Read Only: true
• ItemCategory: string
  Read Only: true

  Purchasing category of the recalled item.
• ItemDescription: string
  Read Only: true

  Description of the recalled item.
• ItemMatchFlag: string
  Read Only: true

  Indicates whether an Oracle item number, supplier part number or manufacturer part number is identified for the recalled part.
• ItemNumber: string
  Read Only: true

  Oracle item number for the part that's captured in the recall notice.
• LineId: integer (int64)
  Recall notice line identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturerPartNumber: string
  Manufacturer part number derived based on the part details captured in the recall notice.
• ModelNumber: string
  Maximum Length: 255

  Model number for the recalled part provided by the source of recall.
• PartDescription: string
  Maximum Length: 4000

  Description of the recalled part provided by the source of recall.
• PartNumber: string
  Maximum Length: 700

  Recalled part number provided by the source of recall.
• ProviderLineNumber: string
  Maximum Length: 60

  Unique recall line number passed by the provider.
• recalledLotNumbers: array Recall Lot Numbers
  Title: Recall Lot Numbers

  Recalled lot numbers pertaining to the recalled parts on the recall notices.
• recalledSerialNumbers: array Recall Serial Numbers
  Title: Recall Serial Numbers

  Recalled serial numbers pertaining to the recalled parts on the recall notices.
• ReceiptExistenceFlag: string
  Indicates whether the recalled item was received during the recall period.
• Status: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Lookup meaning for the status of the recall line.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Lookup code for the status of the recall line.
• SupplierPartNumber: string
  Supplier part number derived based on the part details captured in the recall notice.
• WithdrawReasonCode: string
  Maximum Length: 30

  Reason code provided by the end user to withdraw a recall line.

{
    "type":"object",
    "properties":{
        "recalledLotNumbers":{
            "title":"Recall Lot Numbers",
            "type":"array",
            "description":"Recalled lot numbers pertaining to the recalled parts on the recall notices.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-item-response"
            }
        },
        "PartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Recalled part number provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Recall header identifier to which the recall lines are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup code for the status of the recall line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "type":"string",
            "description":"Description of the recalled item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReceiptExistenceFlag":{
            "type":"string",
            "description":"Indicates whether the recalled item was received during the recall period.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BrandName":{
            "maxLength":60,
            "type":"string",
            "description":"Brand name of the recalled part provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCategory":{
            "type":"string",
            "description":"Purchasing category of the recalled item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Oracle item number for the part that's captured in the recall notice.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InventoryItemId1":{
            "title":"Item Number",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierPartNumber":{
            "type":"string",
            "description":"Supplier part number derived based on the part details captured in the recall notice.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "recalledSerialNumbers":{
            "title":"Recall Serial Numbers",
            "type":"array",
            "description":"Recalled serial numbers pertaining to the recalled parts on the recall notices.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledSerialNumbers-item-response"
            }
        },
        "Status":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Lookup meaning for the status of the recall line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ModelNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Model number for the recalled part provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Recall notice line identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments in the recall line.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "type":"string",
            "description":"Manufacturer part number derived based on the part details captured in the recall notice.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "WithdrawReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason code provided by the end user to withdraw a recall line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProviderLineNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Unique recall line number passed by the provider.",
            "nullable":true,
            "x-queryable":true
        },
        "DeviceIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Device identifier for the recalled part provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "GTIN":{
            "maxLength":255,
            "type":"string",
            "description":"Global Trade Identification Number for the recalled part provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "PartDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the recalled part provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemMatchFlag":{
            "type":"string",
            "description":"Indicates whether an Oracle item number, supplier part number or manufacturer part number is identified for the recalled part.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 Numbers

Type: array

Title: Recall Lot Numbers

Recalled lot numbers pertaining to the recalled parts on the recall notices.

Show Source

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

{
    "title":"Recall Lot Numbers",
    "type":"array",
    "description":"Recalled lot numbers pertaining to the recalled parts on the recall notices.",
    "items":{
        "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledLotNumbers-item-response"
    }
}

Nested Schema : Recall Serial Numbers

Type: array

Title: Recall Serial Numbers

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

Show Source

• Array of: object captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledSerialNumbers-item-response

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

Nested Schema : captureAndValidateRecallNotices-captureAndValidateRecallLines-recalledSerialNumbers-item-response

Type: object

Show Source

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

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

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

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

{
    "type":"object",
    "properties":{
        "LineId":{
            "type":"integer",
            "description":"Recall line identifier to which the recalled serial numbers are associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MfgFromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number 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 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 part.",
            "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 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 that's recalled as provided by the source of recall.",
            "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

recalledLotNumbers

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

Parameters:

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

Recalled lot numbers pertaining to the recalled parts on the recall notices.

recalledSerialNumbers

Operation: /fscmRestApi/resources/11.13.18.05/captureAndValidateRecallNotices/{HeaderId}/child/captureAndValidateRecallLines/{LineId}/child/recalledSerialNumbers

Parameters:

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

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

Back to Top