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

Get all headers

get

/fscmRestApi/resources/11.13.18.05/recallNotices

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find recall headers according to the header identifier.
      Finder Variables:
      • HeaderId; integer; Value that uniquely identifies the recall notice header.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BpaManufacturerLineId; integer; Value that uniquely identifies the blanket purchase order line defined in the recall notice header.
    • BusinessUnitId; integer; Value that uniquely identifies the business unit in which the recall notice is created.
    • BusinessUnitName; string; Name of the business unit.
    • Comments; string; Comments on withdrawal of a recall notice.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • DupValidationFlag; boolean; Contains one of the following values: true or false. If true, then duplication validation has happened. If false, then duplication validation has not happened. The default value is false.
    • HeaderId; integer; Value that uniquely identifies the recall notice header.
    • IsWithdrawEligibleFlag; boolean; 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 is not eligible for withdrawal. The value is derived, so does not have a default value.
    • ItemsNotFoundFlag; boolean; Contains one of the following values: true or false. If true, then locate could not trace the part. If false, then locate traced the part. The default value is true.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdateLogin; string; Login that the user used when updating the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • LocateRequestId; integer; Value that uniquely identifies the locate request. This attribute is application generated when the locate parts job is submitted.
    • LocateStatus; string; 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 has not been taken on the recall notice. The default value is false.
    • ManufacturerId; integer; Value that uniquely identifies the trading partner.
    • ManufacturerName; string; Name of the business partner.
    • ManufacturerNumber; string; Number that uniquely identifies the manufacturer.
    • ManufacturerURL; string; URL (Uniform Resource Locator) of the manufacturing firm.
    • NumberOfLinesClosed; string; Number of line items in the closed status for a recall notice.
    • NumberOfLinesFound; string; Number of line items located in a recall notice.
    • NumberOfLinesInProgress; string; Number of line items in the in-progress status for a recall notice.
    • ObjectVersionNumber; integer; 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.
    • OriginalHeaderId; integer; Value that uniquely identifies the original recall notice header that gets updated for a recall notice marked as duplicate.
    • PotentialRisk; string; Text that provides details about the risk factors of the recalled product.
    • RecallClassificationType; string; 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 for FND_LOOKUP.
    • RecallClassificationTypeCode; string; 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.
    • RecallClosingDate; string; Date when the expected recall notice closes.
    • RecallHeaderStatus; string; Status of recall notice header. It identifies the meaning for FND_LOOKUP. It identifies the meaning for FND_LOOKUP.
    • RecallHeaderStatusCode; string; Abbreviation that identifies the status of recall notice header.
    • RecallInitiationDate; string; Date when the recall notice is initiated by the source.
    • RecallInstruction; string; Text that provides special instructions on taking disposition actions for recalled parts.
    • RecallNoticeNumber; string; Number that identifies the recall notice. This attribute is used for internal tracking within the enterprise that gets generated based on the document sequencing setup.
    • RecallNoticeType; string; Classification of recall notice. A list of accepted values is defined in the lookup type ORA_SCH_NOTICE_TYPE. It identifies the meaning for FND_LOOKUP.
    • RecallNoticeTypeCode; string; Abbreviation that identifies the classification of a recall notice. A list of accepted values is defined in the lookup type ORA_SCH_NOTICE_TYPE.
    • RecallReason; string; Text that provides details about the recall reasons.
    • RecallReferenceNumber; string; Number that references the recall. This value is provided by the source that initiated the recall.
    • RecallSourceId; integer; Value that uniquely identifies the recall source.
    • RecallSourceName; string; Name of the recall source that initiated the recall notice. When the recall source type is supplier, this attribute displays the supplier defined in the supplier master with the Spend Authorized business relationship type, when the recall source type is regulatory authority, this attribute displays the regulatory authority, when the recall source type is internal, this attribute displays the business unit, and when the recall source type is manufacturer, this attribute displays the party name.
    • RecallSourceType; string; Type of source that initiated the recall. Values include Manufacturer, Regulatory Authority, and so on. It identifies the meaning for FND_LOOKUP.
    • RecallSourceTypeCode; string; Abbreviation that identifies the type of source that initiated the recall. Values include Manufacturer, Regulatory Authority, and so on.
    • RecallTrackEndDate; string; Date when the recall track ends. This attribute is used to locate the part that is not associated with batch or serial.
    • RecallTrackStartDate; string; Date when the recall track starts. This attribute is used to locate the part that is not associated with batch or serial.
    • ReplacementType; string; 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 for FND_LOOKUP.
    • ReplacementTypeCode; string; 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.
    • TasksAssigned; number; Value that identifies the total number of assigned tasks.
    • TasksCompleted; number; Value that identifies the percentage of the tasks in completed and withdrawn status to the total number of tasks in a recall notice.
    • TotalTasksCompleted; integer; Total number of tasks in completed and withdrawn status in a recall notice.
    • TotalTraceabilityStatus; integer; Total number of distinct traceability statuses that exist.
    • TraceabilityStatusFound; number; Value that identifies the number of distinct traceability statuses found.
    • TrackEndDate; string; Date when the recall track ends. This attribute is entered by the user when submitting the job for locate parts.
    • TrackStartDate; string; Date when the recall track starts. This attribute is entered by the user when submitting the job for locate parts.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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 : recallNotices
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recallNotices-item-response
Type: object
Show Source
  • 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 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 has not happened. The default value is false.
  • 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 is not eligible for withdrawal. The value is derived, so does not have a default value.
  • Read Only: true
    Contains one of the following values: true or false. If true, then locate could not 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 has not been taken on the recall notice. The default value is false.
  • Title: Manufacturer
    Value that uniquely identifies the trading partner.
  • Title: Manufacturer
    Maximum Length: 255
    Name of the business partner.
  • Title: Registry ID
    Maximum Length: 30
    Number that uniquely identifies the manufacturer.
  • Title: URL
    Maximum Length: 2000
    URL (Uniform Resource Locator) of the manufacturing firm.
  • 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: Classification
    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 for 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.
  • Title: Expected Closure Date
    Date when the expected recall notice closes.
  • Recall Contacts
    Title: Recall Contacts
    The Recall Contacts resource manages the contact details of person in the recalling organization. The contact information includes name, position, phone, and email.
  • Title: Meaning
    Maximum Length: 80
    Status of recall notice header. It identifies the meaning for FND_LOOKUP. It identifies the meaning for FND_LOOKUP.
  • Maximum Length: 30
    Abbreviation that identifies the status of recall notice header.
  • Title: Initiation Date
    Date when the recall notice is initiated by the source.
  • Title: Recall Instructions
    Maximum Length: 2000
    Text that provides special instructions on taking disposition actions for recalled parts.
  • Recall Lines
    Title: Recall Lines
    The Recall Lines resource manages the information about a recall notice line, which includes details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category. The line identifier is a unique application-generated primary key and is invisible to the user.
  • Title: Notice Number
    Maximum Length: 60
    Number that identifies the recall notice. This attribute is used for internal tracking within the enterprise that gets generated based on the document sequencing setup.
  • Title: Notice Type
    Maximum Length: 80
    Classification of recall notice. A list of accepted values is defined in the lookup type ORA_SCH_NOTICE_TYPE. It identifies the meaning for 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: 2000
    Text that provides details about the recall reasons.
  • Title: Source Document Reference
    Maximum Length: 60
    Number that references the recall. This value is provided by the source that initiated the recall.
  • Title: Source
    Value that uniquely identifies the recall source.
  • Title: Source
    Maximum Length: 255
    Name of the recall source that initiated the recall notice. When the recall source type is supplier, this attribute displays the supplier defined in the supplier master with the Spend Authorized business relationship type, when the recall source type is regulatory authority, this attribute displays the regulatory authority, when the recall source type is internal, this attribute displays the business unit, and when the recall source type is manufacturer, this attribute displays the party name.
  • Title: Source Type
    Maximum Length: 80
    Type of source that initiated the recall. Values include Manufacturer, Regulatory Authority, and so on. It identifies the meaning for 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 is not associated with batch or serial.
  • Title: Track Start Date
    Date when the recall track starts. This attribute is used to locate the part that is not associated with batch or serial.
  • Title: Replacement Type
    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 for 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.
  • 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
    Value that gives number of lines count for the header record.
  • 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.
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 Recall Contacts resource manages the contact details of person in the recalling organization. The contact information includes name, position, phone, and email.
Show Source
Nested Schema : Recall Lines
Type: array
Title: Recall Lines
The Recall Lines resource manages the information about a recall notice line, which includes details such as manufacturer part number, part description, recall quantity, model, brand, internal master item number, item description, and item category. The line identifier is a unique application-generated primary key and is invisible to the user.
Show Source
Nested Schema : recallNotices-recallBusinessUnits-item-response
Type: object
Show Source
Nested Schema : recallNotices-recallContacts-item-response
Type: object
Show Source
Nested Schema : recallNotices-recallLines-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments for the recall notice line.
Show Source
Nested Schema : Recall Lot Numbers
Type: array
Title: Recall Lot Numbers
The Recall Lot Numbers resource manages the lot details of each recall notice line. The information includes the manufacturer lot number, quantity, manufactured date, expiry date, and shelf life.
Show Source
Nested Schema : Recall Serial Numbers
Type: array
Title: Recall Serial Numbers
The Recall Serial Numbers resource manages the serial details of each recall notice line. This information includes the manufacturer serial numbers, quantity, range of serial numbers, serial entry mode as range, and single serials.
Show Source
Nested Schema : recallNotices-recallLines-attachments-item-response
Type: object
Show Source
Nested Schema : recallNotices-recallLines-recallLotNumbers-item-response
Type: object
Show Source
Nested Schema : Recall Lot Serial Numbers
Type: array
Title: Recall Lot Serial Numbers
The Recall Lot Serial Numbers resource manages the serials within a lot for each recall notice line. This information includes the manufacturer serial numbers, range of serial numbers, serial entry mode as range, and single serials.
Show Source
Nested Schema : recallNotices-recallLines-recallLotNumbers-recallLotSerialNumbers-item-response
Type: object
Show Source
Nested Schema : recallNotices-recallLines-recallSerialNumbers-item-response
Type: object
Show Source
Links
cancelLocatePartsEss
Cancels the Locate Recalled Parts scheduled process according to the request identifier.
findDuplicates
Validates the recall notices and finds the duplicate recall notices according to the header identifier of the recall notice, business unit name, and recall notice number.
raiseBusinessEvent
Raises a business event to send notifications using a business process management task flow according to the header identifier of the recall notice, the recall notice number, and the action identifier of the task.
submitLocatePartsEss
Submits the Locate Recalled Parts scheduled process according to the header identifier, start date, and end date.
Back to Top

Examples

This example describes how to get all headers.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/recallNotices/"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"HeaderId": 300100208556044,
	"RecallNoticeNumber": "RND1023",
	"BusinessUnitId": 300100200125593,
	"BusinessUnitName": "Vision Healthcare USA",
	"DupValidationFlag": true,
	"LocateStatus": "COMPLETED",
	"ManufacturerId": 300100208073403,
	"BpaManufacturerLineId": null,
	"ManufacturerName": "PennyPack Systems",
	"ManufacturerNumber": "CDRM_908696",
	"ManufacturerURL": null,
	"ObjectVersionNumber": 6,
	"OriginalHeaderId": null,
	"PotentialRisk": "Test Risk",
	"RecallClassificationTypeCode": "Class 1",
	"RecallClassificationType": "High Risk",
	"RecallNoticeTypeCode": "ORA_ADVISORY",
	"RecallNoticeType": "Advisory",
	"RecallSourceTypeCode": "ORA_REG_AUTHORITY",
	"RecallSourceType": "Regulatory Authority",
	"ReplacementTypeCode": "ORA_SCH_CREDIT_ONLY",
	"ReplacementType": "Request a credit without product return",
	"RecallHeaderStatusCode": "ORA_OPEN",
	"RecallHeaderStatus": "Open",
	"RecallClosingDate": null,
	"RecallInitiationDate": "2020-08-01T00:00:00+00:00",
	"RecallInstruction": "Test Instructions",
	"RecallReason": "Test Reason",
	"RecallReferenceNumber": "nmmtest_001",
	"RecallSourceId": 300100207948453,
	"RecallSourceName": "ABC2906",
	"CreatedBy": "User1",
	"CreationDate": "2020-08-13T11:56:27+00:00",
	"LastUpdateDate": "2020-08-13T12:21:07+00:00",
	"LastUpdatedBy": "User1",
	"LastUpdateLogin": "AC4B83762CEA24EDE053CC5AF00A1A5E",
	"TotalNoOfLines": "1",
	"RecallTrackStartDate": null,
	"RecallTrackEndDate": null,
	"NumberOfLinesFound": "1",
	"NumberOfLinesInProgress": "1",
	"NumberOfLinesClosed": "0",
	"TasksAssigned": 4,
	"TraceabilityStatusFound": 2,
	"TasksCompleted": 0,
	"ItemsNotFoundFlag": "false",
	"IsWithdrawEligibleFlag": "false",
	"TotalTraceabilityStatus": 4,
	"TotalTasksCompleted": 0,
	"LocateRequestId": 35366,
	"TrackStartDate": "2020-08-01",
	"TrackEndDate": "2020-08-13",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/recallNotices/300100208556044",
		"name": "recallNotices",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/recallNotices/300100208556044",
		"name": "recallNotices",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/recallNotices/300100208556044/child/recallContacts",
		"name": "recallContacts",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/recallNotices/300100208556044/child/recallLines",
		"name": "recallLines",
		"kind": "collection"
	}
	]
}
Back to Top