Get all allocated checklists
get
/hcmRestApi/resources/11.13.18.05/allocatedChecklists
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 all the allocated checklists that match the primary key specified.
Finder Variables- AllocatedChecklistId; integer; Unique identifier for the allocated checklist.
- findByChecklistCategory Finds all checklists by the specified category.
Finder Variables- pChecklistCategory; string; Name of the checklist category.
- findByChecklistCode Finds all checklists by the specified checklist code.
Finder Variables- pChecklistCode; string; Code for the checklist.
- findByChecklistName Finds all checklists by the specified checklist name.
Finder Variables- pChecklistInstance; string; Instance of the allocated checklist.
- pChecklistName; string; Name of the checklist.
- findByChecklistStatus Finds all checklists by the specified status.
Finder Variables- pChecklistStatus; string; Name of the checklist status.
- findByPersonNumber Finds all checklists for the specified person number.
Finder Variables- pPersonNumber; string; Unique identifier for the person.
- PrimaryKey Finds all the allocated checklists that match the primary key specified.
-
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:- ActionDate; string
- AllocatedChecklistId; integer; Unique identifier for the allocated checklist.
- AllocationDate; string; Date on which the checklist was allocated.
- AssignmentId; integer; Unique identifier for the assignment.
- BaseChecklistId; integer; Unique identifier for the base checklist.
- ChecklistCategory; string; Category of the checklist such as off boarding, onboarding and so on. Valid values are defined in the list CHECKLIST_CATEGORY LOV.
- ChecklistCode; string; Code for the checklist.
- ChecklistInstance; string; Instance of the allocated checklist.
- ChecklistName; string; Name of the checklist.
- ChecklistStatus; string; Status of the checklist such as Draft, Active, or Inactive.
- CompletionDate; string
- DisplayName; string; Display name of the checklist.
- FullName; string
- LegislationCode; string; Code for the country to which the checklist is applicable.
- PersonId; integer; Internal identifier for the person.
- PersonNumber; string; Number assigned to a person to identify the person uniquely.
-
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 TopResponse
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.
Root Schema : allocatedChecklists
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : allocatedChecklists-item-response
Type:
Show Source
object
-
ActionDate: string
(date)
Title:
Action Date
Read Only:true
-
AllocatedChecklistId: integer
(int64)
Title:
Allocated Checklist Identifier
Read Only:true
Unique identifier for the allocated checklist. -
allocatedTasks: array
Allocated Task
Title:
Allocated Task
The allocated tasks resource is a child of the allocated Checklists resource. It includes details of all the allocated tasks. -
AllocationDate: string
(date)
Title:
Allocation Date
Read Only:true
Date on which the checklist was allocated. -
AssignmentId: integer
(int64)
Unique identifier for the assignment.
-
BaseChecklistId: integer
(int64)
Read Only:
true
Unique identifier for the base checklist. -
ChecklistCategory: string
Title:
Category
Read Only:true
Maximum Length:60
Category of the checklist such as off boarding, onboarding and so on. Valid values are defined in the list CHECKLIST_CATEGORY LOV. -
ChecklistCode: string
Read Only:
true
Maximum Length:240
Code for the checklist. -
ChecklistInstance: string
Title:
Instance
Read Only:true
Maximum Length:20
Instance of the allocated checklist. -
ChecklistName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the checklist. -
ChecklistStatus: string
Title:
Status
Maximum Length:60
Status of the checklist such as Draft, Active, or Inactive. -
CompletionDate: string
(date)
Title:
Completion Date
-
DisplayName: string
Read Only:
true
Maximum Length:240
Display name of the checklist. -
FullName: string
Read Only:
true
Maximum Length:2000
-
LegislationCode: string
Title:
Legislation Code
Maximum Length:30
Code for the country to which the checklist is applicable. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Title:
Allocated Person Number
Internal identifier for the person. -
PersonNumber: string
Read Only:
true
Maximum Length:30
Number assigned to a person to identify the person uniquely.
Nested Schema : Allocated Task
Type:
array
Title:
Allocated Task
The allocated tasks resource is a child of the allocated Checklists resource. It includes details of all the allocated tasks.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-item-response
Type:
Show Source
object
-
AbsAllocatedChecklistId: integer
(int64)
Title:
Allocated Checklist Identifier
Read Only:true
Unique identifier for the parent checklist. -
ActionType: string
Read Only:
true
Maximum Length:30
Action type for the task specified in the checklist. -
ActionURL: string
Title:
URL
Maximum Length:1000
URL for the task action. -
ActualEndDate: string
(date)
Title:
Actual End Date
Date on which the allocated task ends. -
ActualStartDate: string
(date)
Title:
Actual Start Date
Date on which the allocated task starts. -
AllocatedChecklistId: integer
(int64)
Title:
Allocated Checklist Identifier
Read Only:true
Unique identifier for the allocated checklist. -
allocatedChecklistTaskFlex: array
allocatedChecklistTaskFlex
-
AllocatedTaskId: integer
(int64)
Title:
Allocated Task Identifier
Read Only:true
Unique identifier for the allocated task. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CompletedBy: string
Title:
Completed by Person Name
Maximum Length:64
User who completed the task. -
CompletionDate: string
(date)
Title:
Completion Date
Task completion date. -
DependentOnTasks: string
Title:
Dependent on Tasks
Maximum Length:4000
Preceding task that needs to be completed. -
Description: string
Title:
Task Description
Maximum Length:4000
Description of the task. -
DetailAllocChecklistId: integer
(int64)
Title:
Allocated Step Checklist Identifier
Read Only:true
Unique identifier for the allocated enterprise onboarding step checklist. -
documents: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
FlexContextCode: string
Read Only:
true
Maximum Length:80
Descriptive flexfield for task assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Required
Maximum Length:30
Indicates whether the task is mandatory or optional. Valid values are Yes and No. -
OwnerRespType: string
Title:
Owner Responsibility Type
Read Only:true
Maximum Length:30
Name of the owner responsibility type. -
OwnerRespTypeUsers: string
Title:
Owner Responsibility Type User
Read Only:true
Maximum Length:2000
User type for the owner responsibility. -
PerformerOrigSystem: string
Title:
Performer User Name
Read Only:true
Maximum Length:240
Name of system-generated performer. -
PerformerOrigSystemId: integer
(int64)
Title:
Performer Person Number
Read Only:true
System-generated identifier for the performer. -
ResponsibilityType: string
Title:
Responsibility Type
Read Only:true
Maximum Length:30
Name of the responsibility type assigned to the task. -
ResponsibilityTypeGUID: string
Title:
Responsible Person User Name
Read Only:true
Maximum Length:2000
Unique identifier for the responsibility type. -
Status: string
Title:
Status
Maximum Length:60
Status of the task. -
TargetDurationUOM: string
Title:
Target Duration UOM
Read Only:true
Maximum Length:30
Unit of measurement in days for task duration. -
TargetEndDate: string
(date)
Title:
Target End Date
End date for the task. -
TargetStartDate: string
(date)
Title:
Target Start Date
Start date for the task. -
TaskActionCode: string
Read Only:
true
Maximum Length:240
Code for the task action. -
TaskConfiguration: string
Title:
Task Configuration
Read Only:true
Maximum Length:400
Indicates whether comments and attachments are available for the task. Valid values are Yes and No. Default is No. -
TaskInChecklistId: integer
(int64)
Title:
Task Identifier
Read Only:true
Unique identifier for the task in a checklist. -
TaskName: string
Title:
Name
Maximum Length:240
Name of the task. -
TaskOwnerName: string
Title:
Owner
Read Only:true
Name of user who owns the task. -
TaskOwnerPersonId: integer
(int64)
Title:
Owner Person Number
Read Only:true
Unique identifier for the person who owns the task. -
TaskOwnerUsername: string
Title:
Owner User Name
Read Only:true
Maximum Length:240
User name of the person who owns the task. -
TaskSequence: integer
(int32)
Title:
Sequence
Read Only:true
Sequence in which the tasks are executed.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-allocatedChecklistTaskFlex-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
AllocatedTaskId: integer
(int64)
Title:
Allocated Task Identifier
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : allocatedChecklists-allocatedTasks-attachments-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-documents-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- allocateChecklist
-
Allocates a checklist to a person using the checklist identifier or checklist name, category, person identifier or person number, and allocation date.
Examples
The following example shows how to retrieve all the allocated checklists by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" GET http://<host>:<port>/hcmRestApi/resources/11.13.18.05/allocatedChecklists
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourcecollection+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "ActionDate": null, "AllocatedChecklistId": 300100016035072, "AllocationDate": null, "ChecklistCategory": "ONBOARD", "ChecklistInstance": "1", "ChecklistName": "Hire Checklist", "ChecklistStatus": "INI", "CompletionDate": null, "LegislationCode": null, "ChecklistCode": "HIRE_CHECKLIST", "BaseChecklistId": 300100013625538, "PersonNumber": "955160008172970", "PersonId": 300100016032225, "DisplayName": "Mitchell ZHRX-AU-W-2HB16", "FullName": "ZHRX-AU-W-2HB16, Mitchell", "links": [ { ...} ] }, { "ActionDate": null, "AllocatedChecklistId": 300100016082046, "AllocationDate": null, "ChecklistCategory": "ONBOARD", "ChecklistInstance": "1", "ChecklistName": "Hire Checklist", "ChecklistStatus": "INI", "CompletionDate": null, "LegislationCode": null, "ChecklistCode": "HIRE_CHECKLIST", "BaseChecklistId": 300100013625538, "PersonNumber": "955160008172996", "PersonId": 300100016077525, "DisplayName": "Mike ZPER_Gower", "FullName": "ZPER_Gower, Mike", "links": [ { ...} ] }, { "ActionDate": null, "AllocatedChecklistId": 300100016407315, "AllocationDate": null, "ChecklistCategory": "ONBOARD", "ChecklistInstance": "1", "ChecklistName": "Hire Checklist", "ChecklistStatus": "INI", "CompletionDate": null, "LegislationCode": null, "ChecklistCode": "HIRE_CHECKLIST", "BaseChecklistId": 300100013625538, "PersonNumber": "955160008173274", "PersonId": 300100016404581, "DisplayName": "Robbie ZHRX-AU-W-6HB8", "FullName": "ZHRX-AU-W-6HB8, Robbie", "links": [ { ...} ] }, { "ActionDate": null, "AllocatedChecklistId": 300100016408056, "AllocationDate": null, "ChecklistCategory": "ONBOARD", "ChecklistInstance": "1", "ChecklistName": "Hire Checklist", "ChecklistStatus": "INI", "CompletionDate": null, "LegislationCode": null, "ChecklistCode": "HIRE_CHECKLIST", "BaseChecklistId": 300100013625538, "PersonNumber": "955160008173275", "PersonId": 300100016407320, "DisplayName": "Cristina ZHRX-AU-W-6HB9", "FullName": "ZHRX-AU-W-6HB9, Cristina", "links": [ { ...} ] }, { "ActionDate": null, "AllocatedChecklistId": 300100016440153, "AllocationDate": null, "ChecklistCategory": "ONBOARD", "ChecklistInstance": "1", "ChecklistName": "Hire Checklist", "ChecklistStatus": "INI", "CompletionDate": null, "LegislationCode": null, "ChecklistCode": "HIRE_CHECKLIST", "BaseChecklistId": 300100013625538, "PersonNumber": "955160008173282", "PersonId": 300100016438399, "DisplayName": "Louise ZHRX-AU-W-6HB13", "FullName": "ZHRX-AU-W-6HB13, Louise Stacey", "links": [ { ...} ] ] }