Update a workflow task and its associated application data
patch
/fscmRestApi/resources/11.13.18.05/publicSectorProcessWorklistTasks/{WorklistTaskId}
Request
Path Parameters
-
WorklistTaskId(required): integer(int64)
Auto-generated value.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActionDetail: string
Maximum Length:
1000
Detailed information about why OIC task action was initiated. -
Classification: string
Maximum Length:
10
The classification for the associated application. -
CustomTaskStatus: string
Maximum Length:
400
Customized Task status value after initiating OIC task action. -
OpaGenVersion: string
Maximum Length:
10
To identify that this row belongs to Generation 2 or Generation 3 task. -
PrimaryFlag: string
Maximum Length:
1
Indicates whether the record is a primary. -
PrimaryRecordId: string
Maximum Length:
100
The primary record id for a sub-record. -
PrimaryRecordKey: integer
(int64)
The primary record key for a sub-record.
-
ProcessId: string
Maximum Length:
100
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: string
Maximum Length:
1
Indicates whether the record is a sub application. -
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: string
Maximum Length:
100
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.
-
WorklistTaskId: integer
(int64)
Auto-generated value.
Response
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 : publicSectorProcessWorklistTasks-item-response
Type:
Show Source
object
-
ActionDetail: string
Maximum Length:
1000
Detailed information about why OIC task action was initiated. -
Classification: string
Maximum Length:
10
The classification for the associated application. -
CustomTaskStatus: string
Maximum Length:
400
Customized Task status value after initiating OIC task action. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OpaGenVersion: string
Maximum Length:
10
To identify that this row belongs to Generation 2 or Generation 3 task. -
PrimaryFlag: string
Maximum Length:
1
Indicates whether the record is a primary. -
PrimaryRecordId: string
Maximum Length:
100
The primary record id for a sub-record. -
PrimaryRecordKey: integer
(int64)
The primary record key for a sub-record.
-
ProcessId: string
Maximum Length:
100
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: string
Maximum Length:
1
Indicates whether the record is a sub application. -
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: string
Maximum Length:
100
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.
-
WorklistTaskId: integer
(int64)
Auto-generated value.
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.