Get all information about workflow tasks and their associated application data
get
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTaskSearches
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 a record by the primary key criteria.
Finder Variables:- LoginUserId; string; The user ID of the user who can view the workflow task.
- TaskId; integer; The task ID for the workflow task.
- simpleSearchFinder: Finds a workflow task with a specified keyword.
Finder Variables:- value; string; The keyword used to find a workflow task.
- simpleSearchFinderForWorklist: Finds a workflow task with a specified keyword for the worklist display.
Finder Variables:- value; string; The keyword used to find a workflow task for the worklist display.
- PrimaryKey: Finds a record by the primary key criteria.
-
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:- ActionDetail; string; The action detail for the associated application.
- AssignedBy; string; The user name of the user who assigned this workflow task.
- AssignedDate; string; The date on which the workflow task was assigned.
- Assignee; string; The user name of the user to whom the workflow task has been currently assigned.
- AssignmentType; string; Indicates the assignment type for the workflow task. This determines whether the workflow task belongs to the user or to his group. Valid values are MY, MY_ONLY or GROUP.
- Classification; string; The classification for the associated application.
- LoginUserId; string; The user ID of the user who can view the workflow task.
- PrimaryFlag; string; Indicates whether the record is a primary record.
- PrimaryMeaning; string; Indicates if a transaction is the primary application within a parent-child relationship of applications.
- PrimaryRecordId; string; The primary record ID for a subrecord.
- PrimaryRecordKey; integer; The primary record key for a subrecord.
- ProcessId; integer; The workflow process ID to which the workflow task belongs.
- PropertyAddress1; string; The first line of property address for the associated application.
- PropertyAddress2; string; The other lines of property address for the associated application.
- PropertyCity; string; The city in the property address.
- PropertyPostalCode; string; The postal code in the property address.
- PropertyState; string; The state in the property address.
- PropertyStreetNameConcat; string; The street direction, street name, street type and street suffix in the property address.
- PropertyStreetNumber; string; The street number in the property address.
- PropertyStreetNumberAlpha; string; The street number if it is in alphabetic form in the property address.
- PropertyStreetNumberNumeric; integer; The street number if it is in numeric form in the property address.
- RecordDesc; string; The record description for the associated application.
- RecordId; string; The record ID for the associated application.
- RecordKey; integer; The record key for the associated application.
- RecordStatus; string; The record status for the associated application.
- RecordType; string; The record type for the associated application.
- SubClassification; string; The sub-classification for the associated application.
- SubapplicationFlag; string; Indicates whether the record is a subapplication.
- SubapplicationMeaning; string; Indicates if a transaction is the child application within a parent-child relationship of applications.
- TaskCreatedDate; string; The date on which the workflow task got created.
- TaskDueDate; string; The due date to complete the workflow task.
- TaskId; integer; The task ID for the workflow task.
- TaskName; string; The name for the workflow task.
- TaskPriority; integer; The priority for the workflow task.
- TaskStatus; string; The status of the workflow task.
- TaskUpdatedDate; string; The date on which the workflow task got updated.
-
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(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 : publicSectorWorklistTaskSearches
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 : publicSectorWorklistTaskSearches-item-response
Type:
Show Source
object
-
ActionDetail: string
Read Only:
true
Maximum Length:1000
The action detail for the associated application. -
AssignedBy: string
Read Only:
true
Maximum Length:100
The user name of the user who assigned this workflow task. -
AssignedDate: string
(date-time)
Read Only:
true
The date on which the workflow task was assigned. -
Assignee: string
Read Only:
true
Maximum Length:100
The user name of the user to whom the workflow task has been currently assigned. -
AssignmentType: string
Read Only:
true
Maximum Length:10
Indicates the assignment type for the workflow task. This determines whether the workflow task belongs to the user or to his group. Valid values are MY, MY_ONLY or GROUP. -
Classification: string
Read Only:
true
Maximum Length:10
The classification for the associated application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoginUserId: string
Read Only:
true
Maximum Length:255
The user ID of the user who can view the workflow task. -
PrimaryFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the record is a primary record. -
PrimaryMeaning: string
Read Only:
true
Maximum Length:80
Indicates if a transaction is the primary application within a parent-child relationship of applications. -
PrimaryRecordId: string
Read Only:
true
Maximum Length:100
The primary record ID for a subrecord. -
PrimaryRecordKey: integer
(int64)
Read Only:
true
The primary record key for a subrecord. -
ProcessId: integer
(int64)
Read Only:
true
The workflow process ID to which the workflow task belongs. -
PropertyAddress1: string
Read Only:
true
Maximum Length:1000
The first line of property address for the associated application. -
PropertyAddress2: string
Read Only:
true
Maximum Length:1000
The other lines of property address for the associated application. -
PropertyCity: string
Read Only:
true
Maximum Length:100
The city in the property address. -
PropertyPostalCode: string
Read Only:
true
Maximum Length:100
The postal code in the property address. -
PropertyState: string
Read Only:
true
Maximum Length:100
The state in the property address. -
PropertyStreetNameConcat: string
Read Only:
true
Maximum Length:500
The street direction, street name, street type and street suffix in the property address. -
PropertyStreetNumber: string
Read Only:
true
Maximum Length:100
The street number in the property address. -
PropertyStreetNumberAlpha: string
Read Only:
true
Maximum Length:100
The street number if it is in alphabetic form in the property address. -
PropertyStreetNumberNumeric: integer
Read Only:
true
The street number if it is in numeric form in the property address. -
RecordDesc: string
Read Only:
true
Maximum Length:1000
The record description for the associated application. -
RecordId: string
Read Only:
true
Maximum Length:100
The record ID for the associated application. -
RecordKey: integer
(int64)
Read Only:
true
The record key for the associated application. -
RecordStatus: string
Read Only:
true
Maximum Length:100
The record status for the associated application. -
RecordType: string
Read Only:
true
Maximum Length:100
The record type for the associated application. -
SubapplicationFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the record is a subapplication. -
SubapplicationMeaning: string
Read Only:
true
Maximum Length:80
Indicates if a transaction is the child application within a parent-child relationship of applications. -
SubClassification: string
Read Only:
true
Maximum Length:100
The sub-classification for the associated application. -
TaskCreatedDate: string
(date-time)
Read Only:
true
The date on which the workflow task got created. -
TaskDueDate: string
(date-time)
Read Only:
true
The due date to complete the workflow task. -
TaskId: integer
(int64)
Read Only:
true
The task ID for the workflow task. -
TaskName: string
Read Only:
true
Maximum Length:400
The name for the workflow task. -
TaskPriority: integer
(int32)
Read Only:
true
The priority for the workflow task. -
TaskStatus: string
Read Only:
true
Maximum Length:50
The status of the workflow task. -
TaskUpdatedDate: string
(date-time)
Read Only:
true
The date on which the workflow task got updated.
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.