Update Record Workflow Task

Updates the specified workflow task for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   update_record_workflow_task

App TypeAgency
Authorization TypeAccess token
URI /v4/records/{recordId}/workflowTasks/{id}?lang={lang}&fields={fields}
HTTP MethodPUT
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo 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
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
langStringNo Indicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2
actionbyDepartmentactionbyDepartment{}No Get All Departments The department responsible for the action.7.3.2
actionbyDepartment.textstringNo The localized display text.7.3.2
actionbyDepartment.valuestringNo The value for the specified parameter.7.3.2
actionbyUseractionbyUser{}No The individual responsible for the action.7.3.2
actionbyUser.textstringNo The localized display text.7.3.2
actionbyUser.valuestringNo The value for the specified parameter.7.3.2
approvalstringNo Used to indicate supervisory approval of an adhoc task.7.3.2
assignedDatedateTimeNo The date of the assigned action.7.3.2
assignedToDepartmentassignedToDepartment{}No Get All Departments The department responsible for the action.7.3.2
assignedToDepartment.textstringNo The localized display text.7.3.2
assignedToDepartment.valuestringNo The value for the specified parameter.7.3.2
assignedUserassignedUser{}No The staff member responsible for the action.7.3.2
assignedUser.textstringNo The localized display text.7.3.2
assignedUser.valuestringNo The value for the specified parameter.7.3.2
assignEmailDisplaystringNoY | NIndicates 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
billablestringNoY | NThis defines whether or not the item is billable.7.3.2
commentstringNo Comments or notes about the current context.7.3.2
commentDisplaystringNoY | NIndicates whether or not Accela Citizen Access users can view the inspection results comments.7.3.2
commentPublicVisible[]stringNo 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
currentTaskIdstringNo The ID of the current workflow task.7.3.2
daysDuelongNo The amount of time to complete a task (measured in days).7.3.2
descriptionstringNo The description of the record or item.7.3.2
dispositionNotestringNo A note describing the disposition of the current task.7.3.2
dueDatedateTimeNo The desired completion date of the task.7.3.2
endTimedateTimeNo The time the inspection was completed.7.3.2
estimatedDueDatedateTimeNo The estimated date of completion.7.3.2
estimatedHoursDoubleNo The estimated hours necessary to complete this task.7.3.2
hoursSpentDoubleNo Number of hours used for a workflow or workflow task. 7.3.2
idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
inPossessionTimeDoubleNo The application level in possession time of the time tracking feature.7.3.2
isActivestringNoY | NIndicates the status of the task (active or not active). 7.3.2
isCompletedstringNoY | NIndicates whether the task is completed or not.7.3.2
lastModifiedDatedateTimeNo The date when the task item was last changed.7.3.2
nextTaskIdstringNo The unique Id generated for the next task in a workflow.7.3.2
overTimestringNo A labor cost factor that indicates time worked beyond a worker's regular working hours.7.3.2
processCodestringNo The process code for the next task in a workflow.7.3.2
recordIdrecordId{}No Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2
recordId.customIdstringNo 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.idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
recordId.serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
recordId.trackingIdlongNo The application tracking number (IVR tracking number).7.3.2
recordId.valuestringNo The value for the specified parameter.7.3.2
serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
startTimedateTimeNo The time when you started the inspection.7.3.2
statusstatus{}No Get All Statuses for Workflow Task The task item status.7.3.2
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
statusDatedateTimeNo The date when the current status changed.7.3.2
trackStartDatedateTimeNo The date that time tracking is set to begin. 7.3.2

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.2
result.actionbyDepartmentresult.actionbyDepartment{}The department responsible for the action.7.3.2
result.actionbyDepartment.textstringThe localized display text.7.3.2
result.actionbyDepartment.valuestringThe value for the specified parameter.7.3.2
result.actionbyUserresult.actionbyUser{}The individual responsible for the action.7.3.2
result.actionbyUser.textstringThe localized display text.7.3.2
result.actionbyUser.valuestringThe value for the specified parameter.7.3.2
result.approvalstringUsed to indicate supervisory approval of an adhoc task.7.3.2
result.assignedDatedateTimeThe date of the assigned action.7.3.2
result.assignedToDepartmentresult.assignedToDepartment{}The department responsible for the action.7.3.2
result.assignedToDepartment.textstringThe localized display text.7.3.2
result.assignedToDepartment.valuestringThe value for the specified parameter.7.3.2
result.assignedUserresult.assignedUser{}The staff member responsible for the action.7.3.2
result.assignedUser.textstringThe localized display text.7.3.2
result.assignedUser.valuestringThe value for the specified parameter.7.3.2
result.assignEmailDisplaystringIndicates 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.billablestringThis defines whether or not the item is billable.7.3.2
result.commentstringComments or notes about the current context.7.3.2
result.commentDisplaystringIndicates whether or not Accela Citizen Access users can view the inspection results comments.7.3.2
result.commentPublicVisible[]stringSpecifies 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.currentTaskIdstringThe ID of the current workflow task.7.3.2
result.daysDuelongThe amount of time to complete a task (measured in days).7.3.2
result.descriptionstringThe description of the record or item.7.3.2
result.dispositionNotestringA note describing the disposition of the current task.7.3.2
result.dueDatedateTimeThe desired completion date of the task.7.3.2
result.endTimedateTimeThe time the inspection was completed.7.3.2
result.estimatedDueDatedateTimeThe estimated date of completion.7.3.2
result.estimatedHoursDoubleThe estimated hours necessary to complete this task.7.3.2
result.hoursSpentDoubleNumber of hours used for a workflow or workflow task. 7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.inPossessionTimeDoubleThe application level in possession time of the time tracking feature.7.3.2
result.isActivestringIndicates the status of the task (active or not active). 7.3.2
result.isCompletedstringIndicates whether the task is completed or not.7.3.2
result.lastModifiedDatedateTimeThe date when the task item was last changed.7.3.2
result.nextTaskIdstringThe unique Id generated for the next task in a workflow.7.3.2
result.overTimestringA labor cost factor that indicates time worked beyond a worker's regular working hours.7.3.2
result.processCodestringThe process code for the next task in a workflow.7.3.2
result.recordIdresult.recordId{}The unique ID associated with a record.7.3.2
result.recordId.customIdstringAn 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.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.recordId.valuestringThe value for the specified parameter.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.startTimedateTimeThe time when you started the inspection.7.3.2
result.statusresult.status{}The task item status.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.statusDatedateTimeThe date when the current status changed.7.3.2
result.trackStartDatedateTimeThe date that time tracking is set to begin. 7.3.2
statusintegerThe record status.7.3.3