Get information about a workflow task and its associated application data
get
/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTasks/{TaskId}
Request
Path Parameters
-
TaskId(required): integer(int64)
The task ID for the workflow task.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorWorklistTasks-item-response
Type:
Show Source
object
-
Classification: string
Maximum Length:
10
The classification for the associated application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: boolean
Maximum Length:
1
Indicates if a transaction is the primary application within a parent-child relationship of applications. -
PrimaryRecordId: string
Maximum Length:
100
The primary record ID for a subrecord. -
PrimaryRecordKey: integer
(int64)
The primary record key for a subrecord.
-
ProcessId: integer
(int64)
The workflow process ID to which the workflow task belongs.
-
PropertyAddress1: string
Maximum Length:
1000
The first line of property address for the associated application. -
PropertyAddress2: string
Maximum Length:
1000
The other lines of property address for the associated application. -
PropertyCity: string
Maximum Length:
100
The city in the property address. -
PropertyPostalCode: string
Maximum Length:
100
The postal code in the property address. -
PropertyState: string
Maximum Length:
100
The state in the property address. -
PropertyStreetNameConcat: string
Maximum Length:
500
The street direction, street name, street type and street suffix in the property address. -
PropertyStreetNumber: string
Maximum Length:
100
The street number in the property address. -
RecordDesc: string
Maximum Length:
1000
The record description for the associated application. -
RecordId: string
Maximum Length:
100
The record ID for the associated application. -
RecordKey: integer
(int64)
The record key for the associated application.
-
RecordStatus: string
Maximum Length:
100
The record status for the associated application. -
RecordType: string
Maximum Length:
100
The record type for the associated application. -
SubapplicationFlag: boolean
Maximum Length:
1
Indicates if a transaction is the child application within a parent-child relationship of applications. -
SubClassification: string
Maximum Length:
100
The sub-classification for the associated application. -
TaskCreatedDate: string
(date-time)
The date on which the workflow task got created.
-
TaskDueDate: string
(date-time)
The due date to complete the workflow task.
-
TaskId: integer
(int64)
The task ID for the workflow task.
-
TaskName: string
Maximum Length:
400
The name for the workflow task. -
TaskPriority: integer
(int32)
The priority for the workflow task.
-
TaskStatus: string
Maximum Length:
50
The status of the workflow task. -
TaskUpdatedDate: string
(date-time)
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.