Jump to

• Request
• Response
• Examples

Get all tasks

get

/fscmRestApi/resources/11.13.18.05/recallTaskHistory

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: Find recall task assignment details according to the task assignment identifier.
    Finder Variables:
    • ActionId; integer; Value that uniquely identifies the task assignment at product recall traceability header level or recall notice line level.
• 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:
  

  • ActionId; integer; Value that uniquely identifies task assignment at product recall traceability header level or disposition organization level.
  • AttachmentEntityName; string
  • Comments; string; Comments on completion of task or withdrawal of a task.
  • CompletionDate; string; Date when the task assigned is completed.
  • CreatedBy; string; User who created the record.
  • CreationDate; string; Date and time when the user created the record.
  • DispositionOrganizationCode; string; Abbreviation that identifies the disposition organization.
  • DispositionOrganizationId; integer; Value that uniquely identifies disposition organization.
  • DispositionOrganizationName; string; Name of disposition organization.
  • EstimatedQuantity; number; Estimated quantity to be recalled.
  • 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.
  • ManufacturerPartNumber; string; Number that identifies the part recalled by the manufacturer for which traceability is performed.
  • NotifiedFlag; boolean; Contains one of the following values: true or false. If true, then the notification has been sent to the user for the task assigned at the product traceability header and disposition organization level. If false, then the notification has not been sent to the user for the task assigned at the product traceability header and/or disposition organization level. The default value is false, until the locate program is run.
  • ObjectVersionNumber; integer; Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
  • OrganizationCode; string; Abbreviation that identifies the inventory organization or the disposition organization.
  • OrganizationId; integer; Value that uniquely identifies the inventory organization or the disposition organization.
  • OrganizationName; string; Name of the inventory organization or the disposition organization.
  • ProductTraceId; integer; Value that uniquely identifies product traceability header.
  • ProductTraceStatus; string; Status of the product traceability of a recalled product.
  • ProductTraceStatusCode; string; Abbreviation that identifies the product traceability status of a recalled product.
  • ProductTraceStatusInventoryItemDescription; string; Description of the inventory item.
  • ProductTraceStatusInventoryItemId; integer; Value that uniquely identifies inventory Item.
  • ProductTraceStatusInventoryItemNumber; string; Number that identifies the item.
  • ProductTraceStatusLocationId; integer; Value that uniquely identifies the deliver to location.
  • ProductTraceStatusLocationName; string; Name of deliver to location.
  • ProductTraceStatusOrganizationCode; string; Abbreviation that identifies the inventory organization.
  • ProductTraceStatusOrganizationId; integer; Value that uniquely identifies inventory organization.
  • ProductTraceStatusOrganizationName; string; Name of the inventory organization.
  • ProductTraceStatusRequesterId; integer; Value that uniquely identifies the requester, to whom recalled parts have been issued.
  • ProductTraceStatusRequesterName; string; Name of the requester.
  • ProductTraceStatusSubinventory; string; Name of the subinventory where the recalled parts reside.
  • RecallLineId; integer; Value that uniquely identifies recall notice line.
  • RecallLineNumber; integer; Number that identifies the recall notice line.
  • RecallNoticeId; integer; Value that uniquely identifies recall notice.
  • RecallNoticeNumber; string; Number that identifies the recall notice used for internal tracking within a business unit, which gets generated based on recall document number sequence setup.
  • StartDate; string; Date when the task is assigned.
  • TaskCode; string; Abbreviation that identifies the task.
  • TaskId; integer; Value that uniquely identifies task.
  • TaskName; string; Name of the task.
  • TaskStatus; string; Status of the task.
  • TaskStatusCode; string; Abbreviation that identifies the task status assigned to the product traceability header and disposition organization level.
  • VendorProductNumber; string; Supplier part number.
• 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:
  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.

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

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recallTaskHistory-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 : recallTaskHistory-item-response

Type: object

Show Source

• ActionId: integer (int64)
  Value that uniquely identifies task assignment at product recall traceability header level or disposition organization level.
• AttachmentEntityName: string
  Default Value: RECALL_TASK_HISTORY
• attachments: array Attachments
  Title: Attachments

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

  Comments on completion of task or withdrawal of a task.
• CompletionDate: string (date)
  Title: Completion Date

  Date when the task assigned is completed.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the record.
• DispositionOrganizationCode: string
  Title: Inventory Organization

  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the disposition organization.
• DispositionOrganizationId: integer (int64)
  Value that uniquely identifies disposition organization.
• DispositionOrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of disposition organization.
• EstimatedQuantity: number
  Read Only: true

  Estimated quantity to be recalled.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturerPartNumber: string
  Title: Manufacturer Part Number

  Read Only: true

  Maximum Length: 700

  Number that identifies the part recalled by the manufacturer for which traceability is performed.
• NotifiedFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the notification has been sent to the user for the task assigned at the product traceability header and disposition organization level. If false, then the notification has not been sent to the user for the task assigned at the product traceability header and/or disposition organization level. The default value is false, until the locate program is run.
• ObjectVersionNumber: integer (int32)
  Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
• OrganizationCode: string
  Title: Inventory Organization

  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the inventory organization or the disposition organization.
• OrganizationId: integer
  Read Only: true

  Value that uniquely identifies the inventory organization or the disposition organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 255

  Name of the inventory organization or the disposition organization.
• ProductTraceId: integer (int64)
  Value that uniquely identifies product traceability header.
• ProductTraceStatus: string
  Title: Traceability Status

  Read Only: true

  Maximum Length: 80

  Status of the product traceability of a recalled product.
• ProductTraceStatusCode: string
  Title: Traceability Status

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the product traceability status of a recalled product.
• ProductTraceStatusInventoryItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 255

  Description of the inventory item.
• ProductTraceStatusInventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies inventory Item.
• ProductTraceStatusInventoryItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Number that identifies the item.
• ProductTraceStatusLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the deliver to location.
• ProductTraceStatusLocationName: string
  Title: Location

  Read Only: true

  Maximum Length: 240

  Name of deliver to location.
• ProductTraceStatusOrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the inventory organization.
• ProductTraceStatusOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies inventory organization.
• ProductTraceStatusOrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the inventory organization.
• ProductTraceStatusRequesterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the requester, to whom recalled parts have been issued.
• ProductTraceStatusRequesterName: string
  Title: Requester

  Read Only: true

  Maximum Length: 240

  Name of the requester.
• ProductTraceStatusSubinventory: string
  Title: Subinventory

  Read Only: true

  Maximum Length: 60

  Name of the subinventory where the recalled parts reside.
• RecallLineId: integer (int64)
  Value that uniquely identifies recall notice line.
• RecallLineNumber: integer (int64)
  Title: Line Number

  Read Only: true

  Number that identifies the recall notice line.
• RecallNoticeId: integer (int64)
  Title: Header ID

  Read Only: true

  Value that uniquely identifies recall notice.
• RecallNoticeNumber: string
  Title: Notice Number

  Read Only: true

  Maximum Length: 60

  Number that identifies the recall notice used for internal tracking within a business unit, which gets generated based on recall document number sequence setup.
• StartDate: string (date)
  Title: Start Date

  Date when the task is assigned.
• TaskCode: string
  Read Only: true

  Maximum Length: 60

  Abbreviation that identifies the task.
• TaskId: integer (int64)
  Value that uniquely identifies task.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 60

  Name of the task.
• TaskStatus: string
  Title: Task Status

  Maximum Length: 80

  Status of the task.
• TaskStatusCode: string
  Title: Task Status

  Maximum Length: 30

  Abbreviation that identifies the task status assigned to the product traceability header and disposition organization level.
• VendorProductNumber: string
  Read Only: true

  Maximum Length: 300

  Supplier part number.
• WithdrawEligibleFlag: boolean
  Maximum Length: 80

  Contains one of the following values: true or false. If true, then the task is eligible for withdrawal. If false, then the task is not eligible for withdrawal. The value is derived, so does not have a default value.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the inventory organization or the disposition organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotifiedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the notification has been sent to the user for the task assigned at  the product traceability header and disposition organization level. If false, then the notification has not been sent to the user for the task assigned at  the product traceability header and/or disposition organization level. The default value is false, until the locate program is run.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecallLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies recall notice line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/recallTaskHistory-attachments-item-response"
            }
        },
        "DispositionOrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of disposition organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTraceStatusInventoryItemNumber":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTraceStatusInventoryItemDescription":{
            "title":"Item Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTraceStatus":{
            "title":"Traceability Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the product traceability of a recalled product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTraceStatusRequesterName":{
            "title":"Requester",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the requester.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization or the disposition organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the task is assigned.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TaskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ProductTraceStatusSubinventory":{
            "title":"Subinventory",
            "maxLength":"60",
            "type":"string",
            "description":"Name of the subinventory where the recalled parts reside.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Inventory Organization",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization or the disposition organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DispositionOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies disposition organization.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "ProductTraceId":{
            "type":"integer",
            "description":"Value that uniquely identifies product traceability header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"Date when the task assigned is completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProductTraceStatusLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the deliver to location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTraceStatusOrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "type":"number",
            "description":"Estimated quantity to be recalled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTraceStatusInventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies inventory Item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskStatusCode":{
            "title":"Task Status",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the task status assigned to the product traceability header and disposition organization level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "TaskStatus"
                ]
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":"2000",
            "type":"string",
            "description":"Comments on completion of task or withdrawal of a task.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductTraceStatusOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies inventory organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductTraceStatusLocationName":{
            "title":"Location",
            "maxLength":"240",
            "type":"string",
            "description":"Name of deliver to location.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "maxLength":"700",
            "type":"string",
            "description":"Number that identifies the part recalled by the manufacturer for which traceability is performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTraceStatusCode":{
            "title":"Traceability Status",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the product traceability status of a recalled product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskStatus":{
            "title":"Task Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecallNoticeId":{
            "title":"Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies recall notice.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "VendorProductNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Supplier part number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies task assignment at product recall traceability header level or disposition organization level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WithdrawEligibleFlag":{
            "maxLength":"80",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the task is eligible for withdrawal. If false, then the task is not eligible for withdrawal. The value is derived, so does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductTraceStatusRequesterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requester, to whom recalled parts have been issued.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"60",
            "type":"string",
            "description":"Name of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTraceStatusOrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecallLineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Number that identifies the recall notice line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DispositionOrganizationCode":{
            "title":"Inventory Organization",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the disposition organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "type":"string",
            "nullable":true,
            "default":"RECALL_TASK_HISTORY",
            "x-queryable":true
        },
        "RecallNoticeNumber":{
            "title":"Notice Number",
            "maxLength":"60",
            "type":"string",
            "description":"Number that identifies the recall notice used for internal tracking within a business unit, which gets generated based on recall document number sequence setup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object recallTaskHistory-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/recallTaskHistory-attachments-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 : recallTaskHistory-attachments-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 : 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."
        }
    }
}

Back to Top

Examples

This example describes how to get all tasks.

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/recallTaskHistory"

Example Response Body

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

{
	"ActionId": 100100189508804,
	"RecallLineId": 300100211076446,
	"RecallLineNumber": 1,
	"RecallNoticeId": 300100211076445,
	"RecallNoticeNumber": "RND1157",
	"ProductTraceId": 100100189508795,
	"ProductTraceStatusOrganizationId": 300100200296143,
	"ProductTraceStatusOrganizationCode": "HC01",
	"ProductTraceStatusOrganizationName": "Vision General Hospital",
	"ProductTraceStatusLocationId": null,
	"ProductTraceStatusLocationName": null,
	"ProductTraceStatusSubinventory": null,
	"ProductTraceStatusRequesterId": null,
	"ProductTraceStatusRequesterName": null,
	"ProductTraceStatusInventoryItemId": 300100203603610,
	"ProductTraceStatusInventoryItemNumber": "SCH1002",
	"ProductTraceStatusInventoryItemDescription": "Implantable Pacemaker Pulse-Generator",
	"ProductTraceStatusCode": "ORA_INBOUND",
	"ProductTraceStatus": "Inbound",
	"DispositionOrganizationId": null,
	"DispositionOrganizationCode": null,
	"DispositionOrganizationName": null,
	"TaskId": 300100207304020,
	"TaskCode": "ORA_DELIVER",
	"TaskName": "Deliver Recalled Parts to Quarantine Location",
	"NotifiedFlag": null,
	"TaskStatusCode": "ORA_IN_PROGRESS",
	"TaskStatus": "In Progress",
	"StartDate": "2020-08-19",
	"CompletionDate": null,
	"ObjectVersionNumber": 1,
	"CreationDate": "2020-08-19T04:24:23+00:00",
	"CreatedBy": "User1",
	"LastUpdateDate": "2020-08-19T04:24:23+00:00",
	"LastUpdatedBy": "User1",
	"LastUpdateLogin": "AC8C12FB609C0A79E050F00ACB5AC25B",
	"ManufacturerPartNumber": "MFG1002",
	"EstimatedQuantity": 0,
	"OrganizationId": 300100200296143,
	"OrganizationCode": "HC01",
	"OrganizationName": "Vision General Hospital",
	"WithdrawEligibleFlag": false,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/recallTaskHistory/100100189508804",
		"name": "recallTaskHistory",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/recallTaskHistory/100100189508804",
		"name": "recallTaskHistory",
		"kind": "item"
	}
	]
}

Back to Top