Get all task assignments
get
/fscmRestApi/resources/11.13.18.05/hedTaskAssignments
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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:- ByTaskAndKeywordFinder: Finds all task assignments that match the keyword specified.
Finder Variables:- Keyword; string; The keyword to search for task assignments, requiring a minimum length of 2 characters.
- TaskId; integer; The unique identifier for a task.
- DueTaskFinder: Finds the task assignments that have NotifyDueFlag = true, have a due date, and are not yet complete.
Finder Variables: - PrimaryKey: Finds the task assignment that matches the primary key criteria specified.
Finder Variables:- TaskAssignmentId; integer; The unique identifier for the task assignment.
- ByTaskAndKeywordFinder: Finds all task assignments that match the keyword 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:- AssigneeEmail; string; Preferred email of party assigned to the task.
- AssigneeFirstName; string; Indicates the first name of the person to whom a task or a checklist is assigned.
- AssigneeLastName; string; Indicates the last name of the person to whom a task or a checklist is assigned.
- AssigneeName; string; Indicates the person to whom a task or a checklist is assigned.
- AssigneePartyId; integer; The unique identifier of the person the higher education task is assigned to.
- AssociatedPartyId; integer; The identifier for the individual associated with the higher education task.
- AssociatedPersonFirstName; string; Indicates the first name of the person to whom a task or a checklist is related.
- AssociatedPersonLastName; string; Indicates the last name of the person to whom a task or a checklist is related.
- AssociatedPersonName; string; Indicates the person to whom a task or a checklist is related.
- AttachmentDescription; string; Indicates the description of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentDescription.
- AttachmentFileContents; string; The file contents of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileContents.
- AttachmentFileName; string; Indicates the file name of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileName. To delete an attachment, the consumer needs to send null to AttachmentFileName.
- AttachmentFileURL; string; Indicates the URL of the file.
- AttachmentId; integer; The unique attachment identifier for the higher education task.
- AttachmentMetadata; string; The attachment metadata that contains details of the attachment.
- AttachmentTitle; string; Indicates the title of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentTitle.
- AttachmentUploadedFileContentType; string; Indicates the content type of the uploaded file.
- CategoryId; integer; The unique identifier for the category where the higher education task is created.
- CategoryName; string; The name of the category where the higher education task is created.
- ChecklistAssignmentId; integer; The unique checklist instance identifier for the higher education checklist.
- ChecklistId; integer; The unique identifier for the higher education checklist.
- ChecklistName; string; The name that an administrator provides for the higher education checklist.
- CompleteFlag; boolean; Indicates whether the task is completed or not.
- CompletionDate; string; The date on which the task is completed.
- DaysUntilDue; integer; Number of days until the due date.
- DocumentTypeCode; string; The code for the document type, such as ORA_HEY_ESSAY.
- DocumentTypeMeaning; string; The meaning of the document type, such as "Essay".
- DueDate; string; The date on which the assigned task is due.
- EventDate; string; The event date of the higher education task.
- InstitutionId; integer; The unique identifier for the institution where the higher education task is created.
- InstitutionName; string; The name of the institution where the higher education task is created.
- InstructionText; string; The instruction that an administrator provides for the higher education task.
- LastUpdateDate; string; Last updated date.
- LastUpdatedBy; string; Last updated by.
- NotifyAssignedFlag; boolean; Indicates to the user whether the assignee should receive a communication when the task is assigned.
- NotifyCompletedFlag; boolean; Indicates to the user whether the assignee receives a communication upon completion of the task.
- NotifyDueFlag; boolean; Indicates to the user whether the assignee receives a communication when the task is due.
- ReassignmentFlag; boolean; Indicates whether the task allows reassignment.
- RecipientId; integer; The unique recipient identifier for the higher education task.
- SourceObjectCode; string; The unique code for the source object for which this checklist is assigned, for example a code of the admission application form.
- SourceObjectDisplay; string; Indicates the business process source display from which the checklist was assigned.
- SourceObjectId; integer; The unique identifier for the source object for which this checklist is assigned, for example an identifier of the admission application form.
- SourceObjectMeaning; string; Indicates the business process source from which the checklist was assigned.
- StarredFlag; boolean; Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later.
- StartDate; string; The date on which the task is started.
- StatusCode; string; The status code associated with the state of the task, for example ORA_HEY_ACTION_INPROGRESS, ORA_HEY_ACTION_COMPLETE.
- StatusMeaning; string; The status associated with the state of the task, for example in progress, complete, error, or waived state.
- StatusSchemeCode; string; The status scheme code, such as a code for a group of statuses for admissions.
- StatusSchemeId; integer; The unique identifier for a status scheme associated with the task.
- StatusSchemeName; string; The name of the status scheme, such as admissions statuses.
- StatusTypeCode; string; Code for status type.
- StatusTypeMeaning; string; Meaning of status type.
- TaskAssignmentId; integer; The unique task instance identifier for the higher education task.
- TaskDescription; string; The description that an administrator provides for the higher education task.
- TaskId; integer; The unique identifier for the higher education task.
- TaskName; string; The name that an administrator provides for the higher education task.
- TaskTypeCode; string; The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION.
- TaskTypeMeaning; string; The meaning of the type of task, such as a document submission task.
- TokenFive; string; Token number 5 placeholder used in communication templates.
- TokenFour; string; Token number 4 placeholder used in communication templates.
- TokenOne; string; Token number 1 placeholder used in communication templates.
- TokenThree; string; Token number 3 placeholder used in communication templates.
- TokenTwo; string; Token number 2 placeholder used in communication templates.
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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(required):
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(required):
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 : hedTaskAssignments
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 : hedTaskAssignments-item-response
Type:
Show Source
object
-
AssigneeEmail: string
Title:
Primary Email
Read Only:true
Maximum Length:320
Preferred email of party assigned to the task. -
AssigneeFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
Indicates the first name of the person to whom a task or a checklist is assigned. -
AssigneeLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Indicates the last name of the person to whom a task or a checklist is assigned. -
AssigneeName: string
Title:
Assignee
Read Only:true
Maximum Length:450
Indicates the person to whom a task or a checklist is assigned. -
AssigneePartyId: integer
(int64)
Title:
Task Assignee Party Identifier
The unique identifier of the person the higher education task is assigned to. -
AssociatedPartyId: integer
(int64)
Title:
Task Assignment Associated Party Identifier
The identifier for the individual associated with the higher education task. -
AssociatedPersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
Indicates the first name of the person to whom a task or a checklist is related. -
AssociatedPersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Indicates the last name of the person to whom a task or a checklist is related. -
AssociatedPersonName: string
Title:
Associated Person
Read Only:true
Maximum Length:450
Indicates the person to whom a task or a checklist is related. -
AttachmentDescription: string
Indicates the description of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentDescription.
-
AttachmentFileContents: string
(byte)
The file contents of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileContents.
-
AttachmentFileName: string
Indicates the file name of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentFileName. To delete an attachment, the consumer needs to send null to AttachmentFileName.
-
AttachmentFileURL: string
Read Only:
true
Indicates the URL of the file. -
AttachmentId: integer
(int64)
The unique attachment identifier for the higher education task.
-
AttachmentMetadata: string
Maximum Length:
4000
The attachment metadata that contains details of the attachment. -
AttachmentTitle: string
Indicates the title of the attachment. To create an attachment, the consumer needs to supply the information to AttachmentTitle.
-
AttachmentUploadedFileContentType: string
Read Only:
true
Indicates the content type of the uploaded file. -
CategoryId: integer
(int64)
Title:
Task Category Identifier
Read Only:true
The unique identifier for the category where the higher education task is created. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:50
The name of the category where the higher education task is created. -
ChecklistAssignmentId: integer
(int64)
Title:
Checklist Assignment Identifier
Read Only:true
The unique checklist instance identifier for the higher education checklist. -
ChecklistId: integer
(int64)
Title:
Checklist Setup Identifier
Read Only:true
The unique identifier for the higher education checklist. -
ChecklistName: string
Title:
Checklist Name
Read Only:true
Maximum Length:50
The name that an administrator provides for the higher education checklist. -
CompleteFlag: boolean
Title:
Task Complete
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether the task is completed or not. -
CompletionDate: string
(date-time)
Title:
Task Completion Date
Read Only:true
The date on which the task is completed. -
DaysUntilDue: integer
Read Only:
true
Number of days until the due date. -
DocumentTypeCode: string
Read Only:
true
Maximum Length:30
The code for the document type, such as ORA_HEY_ESSAY. -
DocumentTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The meaning of the document type, such as "Essay". -
DueDate: string
(date-time)
Title:
Task Assignment Due Date
The date on which the assigned task is due. -
EventDate: string
(date)
Read Only:
true
The event date of the higher education task. -
InstitutionId: integer
(int64)
The unique identifier for the institution where the higher education task is created.
-
InstitutionName: string
Title:
Institution
Maximum Length:50
The name of the institution where the higher education task is created. -
InstructionText: string
Title:
Task Instruction Text
Read Only:true
Maximum Length:255
The instruction that an administrator provides for the higher education task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Last updated date. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Last updated by. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotifyAssignedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates to the user whether the assignee should receive a communication when the task is assigned. -
NotifyCompletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates to the user whether the assignee receives a communication upon completion of the task. -
NotifyDueFlag: boolean
Maximum Length:
1
Default Value:false
Indicates to the user whether the assignee receives a communication when the task is due. -
ReassignmentFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the task allows reassignment. -
RecipientId: integer
Read Only:
true
The unique recipient identifier for the higher education task. -
SourceObjectCode: string
Title:
Business Process Source Code
Maximum Length:50
The unique code for the source object for which this checklist is assigned, for example a code of the admission application form. -
SourceObjectDisplay: string
Read Only:
true
Indicates the business process source display from which the checklist was assigned. -
SourceObjectId: integer
(int64)
Title:
Business Process Source Identifier
The unique identifier for the source object for which this checklist is assigned, for example an identifier of the admission application form. -
SourceObjectMeaning: string
Title:
Business Process Source
Read Only:true
Maximum Length:80
Indicates the business process source from which the checklist was assigned. -
StarredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later. -
StartDate: string
(date-time)
Title:
Task Start Date
Read Only:true
The date on which the task is started. -
StatusCode: string
Title:
Task Outcome Status Code
Maximum Length:30
Default Value:ORA_HEY_STATUS_IN_PROGRESS
The status code associated with the state of the task, for example ORA_HEY_ACTION_INPROGRESS, ORA_HEY_ACTION_COMPLETE. -
StatusMeaning: string
Title:
Task Outcome Status
Read Only:true
Maximum Length:80
The status associated with the state of the task, for example in progress, complete, error, or waived state. -
StatusSchemeCode: string
Read Only:
true
Maximum Length:30
The status scheme code, such as a code for a group of statuses for admissions. -
StatusSchemeId: integer
(int64)
The unique identifier for a status scheme associated with the task.
-
StatusSchemeName: string
Read Only:
true
Maximum Length:60
The name of the status scheme, such as admissions statuses. -
StatusTypeCode: string
Read Only:
true
Maximum Length:30
Code for status type. -
StatusTypeMeaning: string
Read Only:
true
Maximum Length:80
Meaning of status type. -
TaskAssignmentId: integer
(int64)
Title:
Task Assignment Identifier
Read Only:true
The unique task instance identifier for the higher education task. -
TaskAssignmentURL: string
Read Only:
true
The URL that can be used to directly access the task assignment drill down page. -
TaskDescription: string
Title:
Task Description
Read Only:true
Maximum Length:240
The description that an administrator provides for the higher education task. -
TaskId: integer
(int64)
Title:
Task Identifier
The unique identifier for the higher education task. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:50
The name that an administrator provides for the higher education task. -
TaskTypeCode: string
Read Only:
true
Maximum Length:30
The code for the type of task, such as a ORA_HEY_DOCUMENT_SUBMISSION. -
TaskTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The meaning of the type of task, such as a document submission task. -
TokenFive: string
Read Only:
true
Token number 5 placeholder used in communication templates. -
TokenFour: string
Read Only:
true
Token number 4 placeholder used in communication templates. -
TokenOne: string
Read Only:
true
Default Value:adf.object.getCommunicationToken(1)
Token number 1 placeholder used in communication templates. -
TokenThree: string
Read Only:
true
Token number 3 placeholder used in communication templates. -
TokenTwo: string
Read Only:
true
Token number 2 placeholder used in communication templates.
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.
Links
- processAdmissionApplicationTasks
-
Operation: /fscmRestApi/resources/11.13.18.05/hedTaskAssignments/action/processAdmissionApplicationTasksProcess the payload and update task statuses.