1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Recall NoticesV2

Create recall headers

post

/fscmRestApi/resources/11.13.18.05/recallNoticesV2

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 4000
    Additional information related to the recall notice header.
  • Default Value: RECALL_NOTICE_HEADER
    Name of the attachment entity.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Value that uniquely identifies the blanket purchase order line defined in the recall notice header.
  • Title: Business Unit
    Value that uniquely identifies the business unit in which the recall notice is created.
  • Title: Business Unit
    Maximum Length: 240
    Name of the business unit.
  • Maximum Length: 2000
    Comments on the withdrawal of a recall notice.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then duplication validation has happened. If false, then duplication validation hasn't happened. The default value is false.
  • Unique identifier of the external source header of the recall notice.
  • Value that uniquely identifies the recall notice header.
  • Maximum Length: 30
    Contains one of the following values: true or false. If true, then locate action has been taken on the recall notice. If false, then locate action hasn't been taken on the recall notice. The default value is false.
  • Title: Manufacturer
    Value that uniquely identifies the trading partner.
  • Title: Registry ID
    Maximum Length: 30
    Manufacturer Number
  • Maximum Length: 30
    Value that indicates the code related to the mode of capture of a reall notice.
  • Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • Value that uniquely identifies the original recall notice header that gets updated for a recall notice marked as duplicate.
  • Title: Potential Risk
    Maximum Length: 2000
    Text that provides details about the risk factors of the recalled product.
  • Business Units
    Title: Business Units
    The Business Units resource manages the business units assigned to the recall notice.
  • Title: Meaning
    Maximum Length: 80
    Classification of recall notice based on the severity of impact it has on consumers. A list of accepted values is defined in the lookup type ORA_SCH_CLASSIFICATION. It identifies the meaning of FND_LOOKUP.
  • Title: Classification
    Maximum Length: 30
    Abbreviation that identifies the classification of a recall notice based on the severity of impact it has on consumers. A list of accepted values is defined in the lookup type ORA_SCH_CLASSIFICATION.
  • Indicates the date of closure of the recall notice.
  • Title: Expected Closure Date
    Indicates the date when the expected recall notice closes.
  • Recall Contacts
    Title: Recall Contacts
    The contact information includes name, position, phone, and email.
  • Title: Meaning
    Maximum Length: 80
    Status of the recall notice header. It identifies the meaning of FND_LOOKUP.
  • Maximum Length: 30
    Value that identifies the status of the recall notice header. A list of accepted values is defined in the lookup type ORA_SCH_RECALL_HEADER_STATUS. It identifies the meaning of FND_LOOKUP.
  • Maximum Length: 255
    Attribute that identifies the recalling firm that initiated the recall.
  • Title: Initiation Date
    Indicates the initiation date of the recall notice by the source.
  • Title: Recall Instructions
    Maximum Length: 4000
    Text that provides special instructions on taking disposition actions for recalled parts.
  • Recall Lines
    Title: Recall Lines
    Information about the recall notice line including details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category.
  • Title: Notice Number
    Maximum Length: 60
    Number that identifies the recall notice. This attribute is used for internal tracking within the enterprise and gets generated based on the document sequencing setup.
  • Title: Meaning
    Maximum Length: 80
    Classification of the recall notice. A list of accepted values is defined in the lookup type ORA_SCH_NOTICE_TYPE. It identifies the meaning of FND_LOOKUP.
  • Title: Notice Type
    Maximum Length: 30
    Abbreviation that identifies the classification of a recall notice. A list of accepted values is defined in the lookup type ORA_SCH_NOTICE_TYPE.
  • Title: Recall Reason
    Maximum Length: 4000
    Text that provides details about the recall reasons.
  • Maximum Length: 360
    Attribute that identifies the entity that initiated the recall notice.
  • Title: Meaning
    Maximum Length: 80
    Type of source that initiated the recall. Values include Manufacturer, Regulatory Authority, and so on. It identifies the meaning of FND_LOOKUP.
  • Title: Source Type
    Maximum Length: 30
    Abbreviation that identifies the type of source that initiated the recall. Values include Manufacturer, Regulatory Authority, and so on.
  • Title: Track End Date
    Date when the recall track ends. This attribute is used to locate the part that's not associated with a batch or serial.
  • Title: Track Start Date
    Date when the recall track starts. This attribute is used to locate the part that's not associated with a batch or serial.
  • Title: URL
    Maximum Length: 2000
    Value that provides the URL information provided in the recall notice.
  • Title: Meaning
    Maximum Length: 80
    Type of method by which the recalled parts can be disposed off. A list of accepted values is defined in the lookup type ORA_SCH_REPLACEMENT_TYPE. It identifies the meaning of FND_LOOKUP.
  • Title: Replacement Type
    Maximum Length: 30
    Abbreviation that identifies the type of method by which the recalled parts can be disposed off. A list of accepted values is defined in the lookup type ORA_SCH_REPLACEMENT_TYPE.
  • Title: Source Document Reference
    Maximum Length: 60
    Number that references the recall. This value is provided by the source that initiated the recall.
  • Value that uniquely identifies theSupplier.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Business Units
Type: array
Title: Business Units
The Business Units resource manages the business units assigned to the recall notice.
Show Source
Nested Schema : Recall Contacts
Type: array
Title: Recall Contacts
The contact information includes name, position, phone, and email.
Show Source
Nested Schema : Recall Lines
Type: array
Title: Recall Lines
Information about the recall notice line including details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : recallNoticesV2-recallBusinessUnits-item-post-request
Type: object
Show Source
Nested Schema : recallNoticesV2-recallContacts-item-post-request
Type: object
Show Source
  • Value that uniquely identifies the contact person in the recalling firm.
  • Maximum Length: 60
    Name of the contact person in the recalling firm.
  • Title: Email
    Maximum Length: 60
    Email information of the contact person in the recalling firm.
  • Value that uniquely identifies the recall notice header.
  • 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.
  • Title: Position
    Maximum Length: 60
    Value that indicates the position of the contact person in the recalling firm.
  • Maximum Length: 60
    Phone number of the contact person in the recalling firm.
Nested Schema : recallNoticesV2-recallLines-item-post-request
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Recall Lot Numbers
Type: array
Title: Recall Lot Numbers
Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.
Show Source
Nested Schema : Recall Serial Numbers
Type: array
Title: Recall Serial Numbers
Information about the serial number details including range and single serials.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Recall Serial Numbers
Type: array
Title: Recall Serial Numbers
Information about the serial number details including range and single serials.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Value that uniquely identifies the recall notice header.
  • Value that uniquely identifies the recall notice line.
  • Value that uniquely identifies the recalled lot.
  • Title: From Serial Number
    Maximum Length: 80
    Starting serial number as specified by the manufacturer in the recall notice.
  • Title: To Serial Number
    Maximum Length: 80
    Ending serial number as specified by the manufacturer in the recall notice.
  • 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.
  • Title: Quantity
    Quantity of the recalled serial number. This is an optional value that's used to calculate ToSerialNumber when the quantity is added to From Serial Number.
  • Maximum Length: 60
    Default Value: ByRange
    Mode whether to enter an individual serial or a serial in a range.
  • Value that uniquely identifies the recalled serial number.
Nested Schema : recallNoticesV2-recallLines-recallPartSerialNumbers-item-post-request
Type: object
Show Source
  • Value that uniquely identifies the recall notice header.
  • Value that uniquely identifies the recall notice line.
  • Value that uniquely identifies the recalled lot.
  • Title: From Serial Number
    Maximum Length: 80
    Starting serial number as specified by the manufacturer in the recall notice.
  • Title: To Serial Number
    Maximum Length: 80
    Ending serial number as specified by the manufacturer in the recall notice.
  • 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.
  • Title: Quantity
    Quantity of the recalled serial number. This is an optional value that's used to calculate ToSerialNumber when the quantity is added to From Serial Number.
  • Maximum Length: 60
    Default Value: ByRange
    Mode whether to enter an individual serial or a serial in a range.
  • Value that uniquely identifies the recalled serial number.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : recallNoticesV2-item-response
Type: object
Show Source
  • Maximum Length: 4000
    Additional information related to the recall notice header.
  • Default Value: RECALL_NOTICE_HEADER
    Name of the attachment entity.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Value that uniquely identifies the blanket purchase order line defined in the recall notice header.
  • Title: Business Unit
    Value that uniquely identifies the business unit in which the recall notice is created.
  • Title: Business Unit
    Maximum Length: 240
    Name of the business unit.
  • Maximum Length: 2000
    Comments on the withdrawal of a recall notice.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the record.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then duplication validation has happened. If false, then duplication validation hasn't happened. The default value is false.
  • Unique identifier of the external source header of the recall notice.
  • Value that uniquely identifies the recall notice header.
  • Read Only: true
    Maximum Length: 255
    Contains one of the following values: true or false. If true, then the recall notice is eligible for withdrawal. If false, then the recall notice isn't eligible for withdrawal. The value is derived, so it doesn't have a default value.
  • Read Only: true
    Contains one of the following values: true or false. If true, then locate couldn't trace the part. If false, then locate traced the part. The default value is true.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Read Only: true
    Maximum Length: 32
    Login that the user used when updating the record.
  • Links
  • Read Only: true
    Value that uniquely identifies the locate request. This attribute is application generated when the locate parts job is submitted.
  • Maximum Length: 30
    Contains one of the following values: true or false. If true, then locate action has been taken on the recall notice. If false, then locate action hasn't been taken on the recall notice. The default value is false.
  • Title: Manufacturer
    Value that uniquely identifies the trading partner.
  • Title: Registry ID
    Maximum Length: 30
    Manufacturer Number
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Value that indicates the mode of capture of a recall notice. A list of accepted values is defined in the lookup type ORA_SCH_PRM_MODE_OF_CAPTURE. It identifies the meaning of FND_LOOKUP.
  • Maximum Length: 30
    Value that indicates the code related to the mode of capture of a reall notice.
  • Read Only: true
    Maximum Length: 255
    Number of line items in the closed status for a recall notice.
  • Read Only: true
    Maximum Length: 255
    Number of line items located in a recall notice.
  • Read Only: true
    Maximum Length: 255
    Number of line items in the in-progress status for a recall notice.
  • Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • Value that uniquely identifies the original recall notice header that gets updated for a recall notice marked as duplicate.
  • Title: Potential Risk
    Maximum Length: 2000
    Text that provides details about the risk factors of the recalled product.
  • Business Units
    Title: Business Units
    The Business Units resource manages the business units assigned to the recall notice.
  • Title: Meaning
    Maximum Length: 80
    Classification of recall notice based on the severity of impact it has on consumers. A list of accepted values is defined in the lookup type ORA_SCH_CLASSIFICATION. It identifies the meaning of FND_LOOKUP.
  • Title: Classification
    Maximum Length: 30
    Abbreviation that identifies the classification of a recall notice based on the severity of impact it has on consumers. A list of accepted values is defined in the lookup type ORA_SCH_CLASSIFICATION.
  • Indicates the date of closure of the recall notice.
  • Title: Expected Closure Date
    Indicates the date when the expected recall notice closes.
  • Recall Contacts
    Title: Recall Contacts
    The contact information includes name, position, phone, and email.
  • Title: Meaning
    Maximum Length: 80
    Status of the recall notice header. It identifies the meaning of FND_LOOKUP.
  • Maximum Length: 30
    Value that identifies the status of the recall notice header. A list of accepted values is defined in the lookup type ORA_SCH_RECALL_HEADER_STATUS. It identifies the meaning of FND_LOOKUP.
  • Maximum Length: 255
    Attribute that identifies the recalling firm that initiated the recall.
  • Title: Initiation Date
    Indicates the initiation date of the recall notice by the source.
  • Title: Recall Instructions
    Maximum Length: 4000
    Text that provides special instructions on taking disposition actions for recalled parts.
  • Recall Lines
    Title: Recall Lines
    Information about the recall notice line including details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category.
  • Title: Notice Number
    Maximum Length: 60
    Number that identifies the recall notice. This attribute is used for internal tracking within the enterprise and gets generated based on the document sequencing setup.
  • Title: Meaning
    Maximum Length: 80
    Classification of the recall notice. A list of accepted values is defined in the lookup type ORA_SCH_NOTICE_TYPE. It identifies the meaning of FND_LOOKUP.
  • Title: Notice Type
    Maximum Length: 30
    Abbreviation that identifies the classification of a recall notice. A list of accepted values is defined in the lookup type ORA_SCH_NOTICE_TYPE.
  • Title: Recall Reason
    Maximum Length: 4000
    Text that provides details about the recall reasons.
  • Maximum Length: 360
    Attribute that identifies the entity that initiated the recall notice.
  • Title: Meaning
    Maximum Length: 80
    Type of source that initiated the recall. Values include Manufacturer, Regulatory Authority, and so on. It identifies the meaning of FND_LOOKUP.
  • Title: Source Type
    Maximum Length: 30
    Abbreviation that identifies the type of source that initiated the recall. Values include Manufacturer, Regulatory Authority, and so on.
  • Title: Track End Date
    Date when the recall track ends. This attribute is used to locate the part that's not associated with a batch or serial.
  • Title: Track Start Date
    Date when the recall track starts. This attribute is used to locate the part that's not associated with a batch or serial.
  • Title: Meaning
    Maximum Length: 80
    Type of method by which the recalled parts can be disposed off. A list of accepted values is defined in the lookup type ORA_SCH_REPLACEMENT_TYPE. It identifies the meaning of FND_LOOKUP.
  • Title: Replacement Type
    Maximum Length: 30
    Abbreviation that identifies the type of method by which the recalled parts can be disposed off. A list of accepted values is defined in the lookup type ORA_SCH_REPLACEMENT_TYPE.
  • Title: Source Document Reference
    Maximum Length: 60
    Number that references the recall. This value is provided by the source that initiated the recall.
  • Read Only: true
    Value that identifies the total number of assigned tasks.
  • Read Only: true
    Value that identifies the percentage of the tasks in completed and withdrawn status to the total number of tasks in a recall notice.
  • Read Only: true
    Total number of tasks in completed and withdrawn status in a recall notice.
  • Read Only: true
    Total number of distinct traceability statuses that exist.
  • Read Only: true
    Value that identifies the number of distinct traceability statuses found.
  • Read Only: true
    Date when the recall track ends. This attribute is entered by the user when submitting the job for locate parts.
  • Read Only: true
    Date when the recall track starts. This attribute is entered by the user when submitting the job for locate parts.
  • Value that uniquely identifies theSupplier.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Business Units
Type: array
Title: Business Units
The Business Units resource manages the business units assigned to the recall notice.
Show Source
Nested Schema : Recall Contacts
Type: array
Title: Recall Contacts
The contact information includes name, position, phone, and email.
Show Source
Nested Schema : Recall Lines
Type: array
Title: Recall Lines
Information about the recall notice line including details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category.
Show Source
Nested Schema : recallNoticesV2-attachments-item-response
Type: object
Show Source
Nested Schema : recallNoticesV2-recallBusinessUnits-item-response
Type: object
Show Source
Nested Schema : recallNoticesV2-recallContacts-item-response
Type: object
Show Source
Nested Schema : recallNoticesV2-recallLines-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Recall Lot Numbers
Type: array
Title: Recall Lot Numbers
Information about the lot details including the lot number, quantity, manufactured date, expiry date, and shelf life.
Show Source
Nested Schema : Recall Serial Numbers
Type: array
Title: Recall Serial Numbers
Information about the serial number details including range and single serials.
Show Source
Nested Schema : recallNoticesV2-recallLines-attachments-item-response
Type: object
Show Source
Nested Schema : recallNoticesV2-recallLines-recallLotNumbers-item-response
Type: object
Show Source
Nested Schema : Recall Serial Numbers
Type: array
Title: Recall Serial Numbers
Information about the serial number details including range and single serials.
Show Source
Nested Schema : recallNoticesV2-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response
Type: object
Show Source
Nested Schema : recallNoticesV2-recallLines-recallPartSerialNumbers-item-response
Type: object
Show Source
Links
RecallClassificationTypeVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SCH_CLASSIFICATION
The following properties are defined on the LOV link relation:
  • Source Attribute: RecallClassificationType; Target Attribute: Meaning
  • Display Attribute: Meaning
RecallNoticeTypeVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SCH_NOTICE_TYPE
The following properties are defined on the LOV link relation:
  • Source Attribute: RecallNoticeType; Target Attribute: Meaning
  • Display Attribute: Meaning
ReplacementTypeVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SCH_REPLACEMENT_TYPE
The following properties are defined on the LOV link relation:
  • Source Attribute: ReplacementType; Target Attribute: Meaning
  • Display Attribute: Meaning
attachments
Parameters:
  • HeaderId: $request.path.HeaderId
The attachments resource is used to view, create, and update attachments.
recallBusinessUnits
Parameters:
  • HeaderId: $request.path.HeaderId
The Business Units resource manages the business units assigned to the recall notice.
recallContacts
Parameters:
  • HeaderId: $request.path.HeaderId
The contact information includes name, position, phone, and email.
recallLines
Parameters:
  • HeaderId: $request.path.HeaderId
Information about the recall notice line including details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category.
Back to Top