Update Record Workflow Task

Updates the specified workflow task for the specified record.

Resource Information

Scope	records Deprecated scope name: update_record_workflow_task
App Type	Agency
Authorization Type	Access token
URI	/v4/records/{recordId}/workflowTasks/{id}?lang={lang}&fields={fields}
HTTP Method	PUT
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
fields	string	No	�	Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.	7.3.2
id	string	Yes	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2
recordId	string	Yes	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2
actionbyDepartment	actionbyDepartment{}	No	Get All Departments	The department responsible for the action.	7.3.2
actionbyDepartment.text	string	No	�	The localized display text.	7.3.2
actionbyDepartment.value	string	No	�	The value for the specified parameter.	7.3.2
actionbyUser	actionbyUser{}	No	�	The individual responsible for the action.	7.3.2
actionbyUser.text	string	No	�	The localized display text.	7.3.2
actionbyUser.value	string	No	�	The value for the specified parameter.	7.3.2
approval	string	No	�	Used to indicate supervisory approval of an adhoc task.	7.3.2
assignedDate	dateTime	No	�	The date of the assigned action.	7.3.2
assignedToDepartment	assignedToDepartment{}	No	Get All Departments	The department responsible for the action.	7.3.2
assignedToDepartment.text	string	No	�	The localized display text.	7.3.2
assignedToDepartment.value	string	No	�	The value for the specified parameter.	7.3.2
assignedUser	assignedUser{}	No	�	The staff member responsible for the action.	7.3.2
assignedUser.text	string	No	�	The localized display text.	7.3.2
assignedUser.value	string	No	�	The value for the specified parameter.	7.3.2
assignEmailDisplay	string	No	Y \| N	Indicates whether or not to display the agency employee’s email address in ACA. Public users can then click the e-mail hyperlink and send an e-mail to the agency employee. “Y” : display the email address. “N” : hide the email address.	7.3.2
billable	string	No	Y \| N	This defines whether or not the item is billable.	7.3.2
comment	string	No	�	Comments or notes about the current context.	7.3.2
commentDisplay	string	No	Y \| N	Indicates whether or not Accela Citizen Access users can view the inspection results comments.	7.3.2
commentPublicVisible[]	string	No	�	Specifies the type of user who can view the inspection result comments. "All ACA Users" - Both registered and anonymous Accela Citizen Access users can view the comments for inspection results. "Record Creator Only" - the user who created the record can see the comments for the inspection results. "Record Creator and Licensed Professional" - The user who created the record and the licensed professional associated with the record can see the comments for the inspection results.	7.3.2
currentTaskId	string	No	�	The ID of the current workflow task.	7.3.2
daysDue	long	No	�	The amount of time to complete a task (measured in days).	7.3.2
description	string	No	�	The description of the record or item.	7.3.2
dispositionNote	string	No	�	A note describing the disposition of the current task.	7.3.2
dueDate	dateTime	No	�	The desired completion date of the task.	7.3.2
endTime	dateTime	No	�	The time the inspection was completed.	7.3.2
estimatedDueDate	dateTime	No	�	The estimated date of completion.	7.3.2
estimatedHours	Double	No	�	The estimated hours necessary to complete this task.	7.3.2
hoursSpent	Double	No	�	Number of hours used for a workflow or workflow task.	7.3.2
id	string	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
inPossessionTime	Double	No	�	The application level in possession time of the time tracking feature.	7.3.2
isActive	string	No	Y \| N	Indicates the status of the task (active or not active).	7.3.2
isCompleted	string	No	Y \| N	Indicates whether the task is completed or not.	7.3.2
lastModifiedDate	dateTime	No	�	The date when the task item was last changed.	7.3.2
nextTaskId	string	No	�	The unique Id generated for the next task in a workflow.	7.3.2
overTime	string	No	�	A labor cost factor that indicates time worked beyond a worker's regular working hours.	7.3.2
processCode	string	No	�	The process code for the next task in a workflow.	7.3.2
recordId	recordId{}	No	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2
recordId.customId	string	No	�	An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.	7.3.2
recordId.id	string	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
recordId.serviceProviderCode	string	No	�	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
recordId.trackingId	long	No	�	The application tracking number (IVR tracking number).	7.3.2
recordId.value	string	No	�	The value for the specified parameter.	7.3.2
serviceProviderCode	string	No	�	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
startTime	dateTime	No	�	The time when you started the inspection.	7.3.2
status	status{}	No	Get All Statuses for Workflow Task	The task item status.	7.3.2
status.text	string	No	�	The localized display text.	7.3.2
status.value	string	No	�	The value for the specified parameter.	7.3.2
statusDate	dateTime	No	�	The date when the current status changed.	7.3.2
trackStartDate	dateTime	No	�	The date that time tracking is set to begin.	7.3.2

Response Information

Field	Type	Description	Automation Version
result	result{}	�	7.3.2
result.actionbyDepartment	result.actionbyDepartment{}	The department responsible for the action.	7.3.2
result.actionbyDepartment.text	string	The localized display text.	7.3.2
result.actionbyDepartment.value	string	The value for the specified parameter.	7.3.2
result.actionbyUser	result.actionbyUser{}	The individual responsible for the action.	7.3.2
result.actionbyUser.text	string	The localized display text.	7.3.2
result.actionbyUser.value	string	The value for the specified parameter.	7.3.2
result.approval	string	Used to indicate supervisory approval of an adhoc task.	7.3.2
result.assignedDate	dateTime	The date of the assigned action.	7.3.2
result.assignedToDepartment	result.assignedToDepartment{}	The department responsible for the action.	7.3.2
result.assignedToDepartment.text	string	The localized display text.	7.3.2
result.assignedToDepartment.value	string	The value for the specified parameter.	7.3.2
result.assignedUser	result.assignedUser{}	The staff member responsible for the action.	7.3.2
result.assignedUser.text	string	The localized display text.	7.3.2
result.assignedUser.value	string	The value for the specified parameter.	7.3.2
result.assignEmailDisplay	string	Indicates whether or not to display the agency employee’s email address in ACA. Public users can then click the e-mail hyperlink and send an e-mail to the agency employee. “Y” : display the email address. “N” : hide the email address.	7.3.2
result.billable	string	This defines whether or not the item is billable.	7.3.2
result.comment	string	Comments or notes about the current context.	7.3.2
result.commentDisplay	string	Indicates whether or not Accela Citizen Access users can view the inspection results comments.	7.3.2
result.commentPublicVisible[]	string	Specifies the type of user who can view the inspection result comments. "All ACA Users" - Both registered and anonymous Accela Citizen Access users can view the comments for inspection results. "Record Creator Only" - the user who created the record can see the comments for the inspection results. "Record Creator and Licensed Professional" - The user who created the record and the licensed professional associated with the record can see the comments for the inspection results.	7.3.2
result.currentTaskId	string	The ID of the current workflow task.	7.3.2
result.daysDue	long	The amount of time to complete a task (measured in days).	7.3.2
result.description	string	The description of the record or item.	7.3.2
result.dispositionNote	string	A note describing the disposition of the current task.	7.3.2
result.dueDate	dateTime	The desired completion date of the task.	7.3.2
result.endTime	dateTime	The time the inspection was completed.	7.3.2
result.estimatedDueDate	dateTime	The estimated date of completion.	7.3.2
result.estimatedHours	Double	The estimated hours necessary to complete this task.	7.3.2
result.hoursSpent	Double	Number of hours used for a workflow or workflow task.	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.inPossessionTime	Double	The application level in possession time of the time tracking feature.	7.3.2
result.isActive	string	Indicates the status of the task (active or not active).	7.3.2
result.isCompleted	string	Indicates whether the task is completed or not.	7.3.2
result.lastModifiedDate	dateTime	The date when the task item was last changed.	7.3.2
result.nextTaskId	string	The unique Id generated for the next task in a workflow.	7.3.2
result.overTime	string	A labor cost factor that indicates time worked beyond a worker's regular working hours.	7.3.2
result.processCode	string	The process code for the next task in a workflow.	7.3.2
result.recordId	result.recordId{}	The unique ID associated with a record.	7.3.2
result.recordId.customId	string	An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.	7.3.2
result.recordId.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.recordId.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.recordId.trackingId	long	The application tracking number (IVR tracking number).	7.3.2
result.recordId.value	string	The value for the specified parameter.	7.3.2
result.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.startTime	dateTime	The time when you started the inspection.	7.3.2
result.status	result.status{}	The task item status.	7.3.2
result.status.text	string	The localized display text.	7.3.2
result.status.value	string	The value for the specified parameter.	7.3.2
result.statusDate	dateTime	The date when the current status changed.	7.3.2
result.trackStartDate	dateTime	The date that time tracking is set to begin.	7.3.2
status	integer	The record status.	7.3.3