Jump to

• Request
• Response

Get all recall notices

get

/fscmRestApi/resources/11.13.18.05/captureAndValidateRecallNotices

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  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 Finds the recall header based on the primary key.
    Finder Variables
    • HeaderId; integer; Value that uniquely identifies the recall notice header.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • AdditionalInformation; string; Additional information related to the recall notice.
  • Comments; string; Comments in the recall notice.
  • CreatedBy; string; User who created the record.
  • CreationDate; string; Date on which the user created the recall notice.
  • DispositionType; string; Lookup meaning for the disposition type as instructed by the source of recall.
  • DispositionTypeCode; string; Lookup code for the disposition type as instructed by the source of recall.
  • DistributionEndDate; string; Distribution end date provided by the source of recall.
  • DistributionStartDate; string; Distribution start date provided by the source of recall.
  • HeaderId; integer; Recall notice header identifier.
  • InitiationDate; string; Date on which the recall was initiated.
  • LastUpdatedBy; string; User who last updated the record.
  • ModeOfCapture; string; Lookup meaning for the mode of capture of recall notice indicating whether it's manually created or ingested by providers or by Oracle curation service.
  • ModeOfCaptureCode; string; Lookup code for the mode of capture of recall notice indicating whether it's manually created or ingested by providers or by Oracle curation service.
  • PotentialRisk; string; Potential risk involved on consuming the recalled part as informed by the source of recall.
  • ProviderRecallAssociationNumber; string; Original provider recall number passed by the provider in the subsequent recall notice to make any revision to the existing recall data.
  • ProviderRecallNumber; string; Unique recall number passed by the provider.
  • RecallDeviceClass; string; Device classification lookup meaning provided by the source of recall.
  • RecallDeviceClassCode; string; Device classification lookup code provided by the source of recall.
  • RecallInstruction; string; Recall instructions provided by the source of recall.
  • RecallNoticeType; string; Recall notice type lookup meaning provided by the source of recall.
  • RecallNoticeTypeCode; string; Recall notice type lookup code provided by the source of recall.
  • RecallReason; string; Recall reason provided by the source of recall.
  • RecallReceivedFrom; string; The party who communicated the recall. It can be manufacturer name or distributor name or even the regulatory authority.
  • RecallingFirm; string; The party who initiated the recall.
  • RegAuthClsfType; string; Classification lookup meaning for a recall notice as per regulatory authority.
  • RegAuthClsfTypeCode; string; Classification lookup code for a recall notice as per regulatory authority.
  • ReportedDate; string; The date on which the recall was communicated by the manufacturer or distributor.
  • SourceReferenceNumber; string; Recall number given by the source of recall.
  • Status; string; Lookup meaning for the status of the recall notice.
  • StatusCode; string; Lookup code for the status of the recall notice.
  • WithdrawReason; string; Lookup meaning for the withdrawal reason code provided by the end user to withdraw a recall notice.
  • WithdrawReasonCode; string; Reason code provided by the end user to withdraw a recall notice.
• totalResults: boolean
  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

• 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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object captureAndValidateRecallNotices-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/captureAndValidateRecallNotices-item-response"
    }
}

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-item-response

Type: object

Show Source

• AdditionalInformation: string
  Read Only: true

  Maximum Length: 4000

  Additional information related to the recall notice.
• AttachmentEntityName: string
  Attachment entity in the recall notice.
• captureAndValidateRecallLines: array Recall Lines
  Title: Recall Lines

  Recalled parts on the recall notices.
• Comments: string
  Read Only: true

  Maximum Length: 2000

  Comments in the recall notice.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date on which the user created the recall notice.
• DispositionType: string
  Title: Meaning

  Maximum Length: 80

  Lookup meaning for the disposition type as instructed by the source of recall.
• DispositionTypeCode: string
  Maximum Length: 30

  Lookup code for the disposition type as instructed by the source of recall.
• DistributionEndDate: string (date)
  Distribution end date provided by the source of recall.
• DistributionStartDate: string (date)
  Distribution start date provided by the source of recall.
• HeaderId: integer (int64)
  Recall notice header identifier.
• InitiationDate: string (date-time)
  Date on which the recall was initiated.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which the recall notice was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModeOfCapture: string
  Title: Meaning

  Lookup meaning for the mode of capture of recall notice indicating whether it's manually created or ingested by providers or by Oracle curation service.
• ModeOfCaptureCode: string
  Lookup code for the mode of capture of recall notice indicating whether it's manually created or ingested by providers or by Oracle curation service.
• PotentialRisk: string
  Maximum Length: 2000

  Potential risk involved on consuming the recalled part as informed by the source of recall.
• ProviderRecallAssociationNumber: string
  Maximum Length: 60

  Original provider recall number passed by the provider in the subsequent recall notice to make any revision to the existing recall data.
• ProviderRecallNumber: string
  Maximum Length: 60

  Unique recall number passed by the provider.
• RecallAssociationNumber: string
  Original source document reference number passed in the expansion recall notice to indicate that it's an expansion recall.
• RecallDeviceClass: string
  Title: Meaning

  Maximum Length: 80

  Device classification lookup meaning provided by the source of recall.
• RecallDeviceClassCode: string
  Maximum Length: 80

  Device classification lookup code provided by the source of recall.
• recallHeaderAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• RecallingFirm: string
  Maximum Length: 360

  The party who initiated the recall.
• RecallInstruction: string
  Maximum Length: 4000

  Recall instructions provided by the source of recall.
• recallNoticeAssociationEntities: array Recall Notice Association Entities
  Title: Recall Notice Association Entities

  Entities associated with a recall notice.
• recallNoticeContacts: array Recall Contacts
  Title: Recall Contacts

  Contact information on the recall notices.
• RecallNoticeType: string
  Title: Meaning

  Maximum Length: 80

  Recall notice type lookup meaning provided by the source of recall.
• RecallNoticeTypeCode: string
  Maximum Length: 360

  Recall notice type lookup code provided by the source of recall.
• RecallReason: string
  Maximum Length: 4000

  Recall reason provided by the source of recall.
• RecallReceivedFrom: string
  Maximum Length: 360

  The party who communicated the recall. It can be manufacturer name or distributor name or even the regulatory authority.
• RegAuthClsfType: string
  Title: Meaning

  Maximum Length: 80

  Classification lookup meaning for a recall notice as per regulatory authority.
• RegAuthClsfTypeCode: string
  Maximum Length: 80

  Classification lookup code for a recall notice as per regulatory authority.
• ReportedDate: string (date-time)
  The date on which the recall was communicated by the manufacturer or distributor.
• SourceReferenceNumber: string
  Maximum Length: 60

  Recall number given by the source of recall.
• Status: string
  Maximum Length: 255

  Lookup meaning for the status of the recall notice.
• StatusCode: string
  Maximum Length: 255

  Lookup code for the status of the recall notice.
• WithdrawReason: string
  Read Only: true

  Maximum Length: 255

  Lookup meaning for the withdrawal reason code provided by the end user to withdraw a recall notice.
• WithdrawReasonCode: string
  Read Only: true

  Maximum Length: 255

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which the user created the recall notice.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProviderRecallAssociationNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Original provider recall number passed by the provider in the subsequent recall notice to make any revision to the existing recall data.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportedDate":{
            "type":"string",
            "description":"The date on which the recall was communicated by the manufacturer or distributor.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionStartDate":{
            "type":"string",
            "description":"Distribution start date provided by the source of recall.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Recall notice header identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RecallNoticeType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Recall notice type lookup meaning provided by the source of recall.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "captureAndValidateRecallLines":{
            "title":"Recall Lines",
            "type":"array",
            "description":"Recalled parts on the recall notices.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-item-response"
            }
        },
        "StatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Lookup code for the status of the recall notice.",
            "nullable":true,
            "x-queryable":true
        },
        "RecallingFirm":{
            "maxLength":360,
            "type":"string",
            "description":"The party who initiated the recall.",
            "nullable":true,
            "x-queryable":true
        },
        "InitiationDate":{
            "type":"string",
            "description":"Date on which the recall was initiated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "recallHeaderAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-recallHeaderAttachments-item-response"
            }
        },
        "ModeOfCapture":{
            "title":"Meaning",
            "type":"string",
            "description":"Lookup meaning for the mode of capture of recall notice indicating whether it's manually created or ingested by providers or by Oracle curation service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DispositionType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Lookup meaning for the disposition type as instructed by the source of recall.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecallReason":{
            "maxLength":4000,
            "type":"string",
            "description":"Recall reason provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecallNoticeTypeCode":{
            "maxLength":360,
            "type":"string",
            "description":"Recall notice type lookup code provided by the source of recall.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecallReceivedFrom":{
            "maxLength":360,
            "type":"string",
            "description":"The party who communicated the recall. It can be manufacturer name or distributor name or even the regulatory authority.",
            "nullable":true,
            "x-queryable":true
        },
        "ProviderRecallNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Unique recall number passed by the provider.",
            "nullable":true,
            "x-queryable":true
        },
        "RecallDeviceClassCode":{
            "maxLength":80,
            "type":"string",
            "description":"Device classification lookup code provided by the source of recall.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalInformation":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional information related to the recall notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Lookup meaning for the status of the recall notice.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModeOfCaptureCode":{
            "type":"string",
            "description":"Lookup code for the mode of capture of recall notice indicating whether it's manually created or ingested by providers or by Oracle curation service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments in the recall notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecallDeviceClass":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Device classification lookup meaning provided by the source of recall.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WithdrawReasonCode":{
            "maxLength":255,
            "type":"string",
            "description":"Reason code provided by the end user to withdraw a recall notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecallInstruction":{
            "maxLength":4000,
            "type":"string",
            "description":"Recall instructions provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionEndDate":{
            "type":"string",
            "description":"Distribution end date provided by the source of recall.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceReferenceNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Recall number given by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "RegAuthClsfType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Classification lookup meaning for a recall notice as per regulatory authority.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "recallNoticeContacts":{
            "title":"Recall Contacts",
            "type":"array",
            "description":"Contact information on the recall notices.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-recallNoticeContacts-item-response"
            }
        },
        "DispositionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup code for the disposition type as instructed by the source of recall.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RegAuthClsfTypeCode":{
            "maxLength":80,
            "type":"string",
            "description":"Classification lookup code for a recall notice as per regulatory authority.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecallAssociationNumber":{
            "type":"string",
            "description":"Original source document reference number passed in the expansion recall notice to indicate that it's an expansion recall.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "PotentialRisk":{
            "maxLength":2000,
            "type":"string",
            "description":"Potential risk involved on consuming the recalled part as informed by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "WithdrawReason":{
            "maxLength":255,
            "type":"string",
            "description":"Lookup meaning for the withdrawal reason code provided by the end user to withdraw a recall notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"Attachment entity in the recall notice.",
            "nullable":true,
            "x-queryable":false
        },
        "recallNoticeAssociationEntities":{
            "title":"Recall Notice Association Entities",
            "type":"array",
            "description":"Entities associated with a recall notice.",
            "items":{
                "$ref":"#/components/schemas/captureAndValidateRecallNotices-recallNoticeAssociationEntities-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the recall notice was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Recall Lines

Type: array

Title: Recall Lines

Recalled parts on the recall notices.

Show Source

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

{
    "title":"Recall Lines",
    "type":"array",
    "description":"Recalled parts on the recall notices.",
    "items":{
        "$ref":"#/components/schemas/captureAndValidateRecallNotices-captureAndValidateRecallLines-item-response"
    }
}

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 : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object captureAndValidateRecallNotices-recallHeaderAttachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/captureAndValidateRecallNotices-recallHeaderAttachments-item-response"
    }
}

Nested Schema : Recall Notice Association Entities

Type: array

Title: Recall Notice Association Entities

Entities associated with a recall notice.

Show Source

• Array of: object captureAndValidateRecallNotices-recallNoticeAssociationEntities-item-response

{
    "title":"Recall Notice Association Entities",
    "type":"array",
    "description":"Entities associated with a recall notice.",
    "items":{
        "$ref":"#/components/schemas/captureAndValidateRecallNotices-recallNoticeAssociationEntities-item-response"
    }
}

Nested Schema : Recall Contacts

Type: array

Title: Recall Contacts

Contact information on the recall notices.

Show Source

• Array of: object captureAndValidateRecallNotices-recallNoticeContacts-item-response

{
    "title":"Recall Contacts",
    "type":"array",
    "description":"Contact information on the recall notices.",
    "items":{
        "$ref":"#/components/schemas/captureAndValidateRecallNotices-recallNoticeContacts-item-response"
    }
}

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

Nested Schema : captureAndValidateRecallNotices-recallHeaderAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "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 : captureAndValidateRecallNotices-recallNoticeAssociationEntities-item-response

Type: object

Show Source

• AssociationEntityId: integer (int64)
  Primary key identifier for the recall notice association entity.
• AssociationEntityName: string
  Title: Business Unit

  Maximum Length: 240

  Association entity name in the recall notice.
• EntityId: integer (int64)
  Recall notice association entity identifier.
• HeaderId: integer (int64)
  Recall header identifier to which the association entities belong to.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AssociationEntityName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Association entity name in the recall notice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Recall notice association entity identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Recall header identifier to which the association entities belong to.",
            "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"
            }
        },
        "AssociationEntityId":{
            "type":"integer",
            "description":"Primary key identifier for the recall notice association entity.",
            "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 : captureAndValidateRecallNotices-recallNoticeContacts-item-response

Type: object

Show Source

• ContactId: integer (int64)
  Recall notice contact identifier.
• ContactName: string
  Maximum Length: 360

  Contact name provided by the source of recall.
• Email: string
  Maximum Length: 240

  Contact email provided by the source of recall.
• HeaderId: integer (int64)
  Recall header identifier to which the recall contacts are associated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Phone: string
  Maximum Length: 60

  Contact phone number provided by the source of recall.

{
    "type":"object",
    "properties":{
        "HeaderId":{
            "type":"integer",
            "description":"Recall header identifier to which the recall contacts 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"
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"Recall notice contact identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Email":{
            "maxLength":240,
            "type":"string",
            "description":"Contact email provided by the source of recall.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":360,
            "type":"string",
            "description":"Contact name provided by the source of recall.",
            "nullable":false,
            "x-queryable":true
        },
        "Phone":{
            "maxLength":60,
            "type":"string",
            "description":"Contact phone number 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"
    }
}

Back to Top