Update Record Approval Condition

Updates the condition of approvals for the specified record(s).

Resource Information

Scoperecords

Deprecated scope name:   update_record_condition_approval

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
actionbyDepartmentactionbyDepartment{}No Get All Departments The department responsible for the action.7.3.3.2
actionbyDepartment.textstringNoThe localized display text.7.3.2
actionbyDepartment.valuestringNoThe value for the specified parameter.7.3.2
actionbyUseractionbyUser{}NoThe individual responsible for the action.7.3.3.2
actionbyUser.textstringNoThe localized display text.7.3.2
actionbyUser.valuestringNoThe value for the specified parameter.7.3.2
activeStatusactiveStatus{}NoA | IIndicates whether or not the condition is active.7.3.3.2
activeStatus.textstringNoThe localized display text.7.3.2
activeStatus.valuestringNoThe value for the specified parameter.7.3.2
additionalInformationstringNoAn unlimited text field to use if other fields are filled.7.3.3.2
additionalInformationPlainTextstringNoAn unlimited text field to use if other fields are filled.7.3.3.2
appliedbyDepartmentappliedbyDepartment{}No Get All Departments The department responsible for applying a condition.7.3.3.2
appliedbyDepartment.textstringNoThe localized display text.7.3.2
appliedbyDepartment.valuestringNoThe value for the specified parameter.7.3.2
appliedbyUserappliedbyUser{}NoThe staff member responsible for applying a condition.7.3.3.2
appliedbyUser.textstringNoThe localized display text.7.3.2
appliedbyUser.valuestringNoThe value for the specified parameter.7.3.2
appliedDatedateTimeNoThe date to apply a condition.7.3.3.2
conditionNumberlongNo7.3.3.2
dispAdditionalInformationPlainTextstringNoAn unlimited text field to use if other fields are filled.7.3.3.2
displayNoticeInAgencyBooleanNotrue | falseIndicates whether or not to display the condition notice in Accela Automation when a condition to a record or parcel is applied.7.3.3.2
displayNoticeInCitizensBooleanNotrue | falseIndicates whether or not to display the condition notice in Accela Citizen Access when a condition to a record or parcel is applied.7.3.3.2
displayNoticeInCitizensFeeBooleanNotrue | falseIndicates whether or not to display the condition notice in Accela Citizen Access Fee Estimate page when a condition to a record or parcel is applied.7.3.3.2
displayOrderlongNoThe order of the item in comparison to the other items.7.3.3.2
effectiveDatedateTimeNoThe date when you want the condition to become effective.7.3.3.2
expirationDatedateTimeNoThe date when the condition expires.7.3.3.2
groupgroup{}NoThis is the condition group. The condition group is an attribute of a condition that organizes condition types. Your agency defines these groups.7.3.3.2
group.textstringNoThe localized display text.7.3.2
group.valuestringNoThe value for the specified parameter.7.3.2
inheritableinheritable{}NoIndicates whether or not Accela Automation checks for inheritable conditions when a user associates a child record with a parent record.7.3.3.2
inheritable.textstringNoThe localized display text.7.3.2
inheritable.valuestringNoThe value for the specified parameter.7.3.2
isIncludeNameInNoticeBooleanNotrue | falseIndicates whether or not to display the condition name in the notice.7.3.3.2
isIncludeShortCommentsInNoticeBooleanNotrue | falseIndicates whether or not to display the condition comments in the notice.7.3.3.2
longCommentsstringNoNarrative comments to help identify the purpose or uses of the standard condition.7.3.3.2
namestringNoThe full name for the application contact.7.3.3.2
prioritypriority{}No Get All Standard Conditon Priorities The priority level assigned to the condition.7.3.3.2
priority.textstringNoThe localized display text.7.3.2
priority.valuestringNoThe value for the specified parameter.7.3.2
publicDisplayMessagestringNoText entered into this field displays in the condition notice or condition status bar for the Condition Name for the public user in Accela IVR (AIVR) and Accela Citizen Access (ACA).7.3.3.2
recordIdrecordId{}No Get All Records Search Records Get My Records The unique ID associated with a record.7.3.3.2
recordId.customIdstringNoAn 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.idstringNoThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
recordId.serviceProviderCodestringNoThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
recordId.trackingIdlongNoThe application tracking number (IVR tracking number).7.3.2
recordId.valuestringNoThe value for the specified parameter.7.3.2
resAdditionalInformationPlainTextstringNoAn unlimited text field to use if other fields are filled.7.3.3.2
resolutionActionstringNoThe action performed in response to a condition.7.3.3.2
serviceProviderCodestringNoThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.2
severityseverity{}NoIndicates the severity of the condition.7.3.3.2
severity.textstringNoThe localized display text.7.3.2
severity.valuestringNoThe value for the specified parameter.7.3.2
shortCommentsstringNoA brief description of the condition name. For example, the text may describe the situation that requires the system to apply the condition. You can set these short comments to display when a user accesses an application with this condition applied to it7.3.3.2
statusstatus{}No Get All Standard Condition Statuses Get All Approval Condition Statuses The record condition status.7.3.3.2
status.textstringNoThe localized display text.7.3.2
status.valuestringNoThe value for the specified parameter.7.3.2
statusDatedateTimeNoThe date when the current status changed.7.3.3.2
statusTypestringNoThe status type for a standard condition or an approval condition, applied or not applied for example.7.3.3.2
typetype{}No Get All Standard Condition Types The condition type.7.3.3.2
type.textstringNoThe localized display text.7.3.2
type.valuestringNoThe value for the specified parameter.7.3.2
fieldsstringNoComma-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
idstringYesThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
langStringNoIndicates 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

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}7.3.3.2
result.actionbyDepartmentresult.actionbyDepartment{}The department responsible for the action.7.3.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.3.2
result.actionbyUser.textstringThe localized display text.7.3.2
result.actionbyUser.valuestringThe value for the specified parameter.7.3.2
result.activeStatusresult.activeStatus{}Indicates whether or not the condition is active.7.3.3.2
result.activeStatus.textstringThe localized display text.7.3.2
result.activeStatus.valuestringThe value for the specified parameter.7.3.2
result.additionalInformationstringAn unlimited text field to use if other fields are filled.7.3.3.2
result.additionalInformationPlainTextstringAn unlimited text field to use if other fields are filled.7.3.3.2
result.appliedbyDepartmentresult.appliedbyDepartment{}The department responsible for applying a condition.7.3.3.2
result.appliedbyDepartment.textstringThe localized display text.7.3.2
result.appliedbyDepartment.valuestringThe value for the specified parameter.7.3.2
result.appliedbyUserresult.appliedbyUser{}The staff member responsible for applying a condition.7.3.3.2
result.appliedbyUser.textstringThe localized display text.7.3.2
result.appliedbyUser.valuestringThe value for the specified parameter.7.3.2
result.appliedDatedateTimeThe date to apply a condition.7.3.3.2
result.dispAdditionalInformationPlainTextstringAn unlimited text field to use if other fields are filled.7.3.3.2
result.displayNoticeInAgencyBooleanIndicates whether or not to display the condition notice in Accela Automation when a condition to a record or parcel is applied.7.3.3.2
result.displayNoticeInCitizensBooleanIndicates whether or not to display the condition notice in Accela Citizen Access when a condition to a record or parcel is applied.7.3.3.2
result.displayNoticeInCitizensFeeBooleanIndicates whether or not to display the condition notice in Accela Citizen Access Fee Estimate page when a condition to a record or parcel is applied.7.3.3.2
result.displayOrderlongThe order of the item in comparison to the other items.7.3.3.2
result.effectiveDatedateTimeThe date when you want the condition to become effective.7.3.3.2
result.expirationDatedateTimeThe date when the condition expires.7.3.3.2
result.groupresult.group{}This is the condition group. The condition group is an attribute of a condition that organizes condition types. Your agency defines these groups.7.3.3.2
result.group.textstringThe localized display text.7.3.2
result.group.valuestringThe value for the specified parameter.7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.2
result.inheritableresult.inheritable{}This defines whether or not Accela Automation checks for inheritable conditions when a user associates a child record with a parent record.7.3.3.2
result.inheritable.textstringThe localized display text.7.3.2
result.inheritable.valuestringThe value for the specified parameter.7.3.2
result.isIncludeNameInNoticeBooleanIndicates whether or not to display the condition name in the notice.7.3.3.2
result.isIncludeShortCommentsInNoticeBooleanIndicates whether or not to display the condition comments in the notice.7.3.3.2
result.longCommentsstringNarrative comments to help identify the purpose or uses of the standard condition.7.3.3.2
result.namestringThe full name for the application contact.7.3.3.2
result.priorityresult.priority{}The priority level assigned to the condition.7.3.3.2
result.priority.textstringThe localized display text.7.3.2
result.priority.valuestringThe value for the specified parameter.7.3.2
result.publicDisplayMessagestringText entered into this field displays in the condition notice or condition status bar for the Condition Name for the public user in Accela IVR (AIVR) and Accela Citizen Access (ACA).7.3.3.2
result.recordIdresult.recordId{}The unique ID associated with a record.7.3.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.resAdditionalInformationPlainTextstringAn unlimited text field to use if other fields are filled.7.3.3.2
result.resolutionActionstringThe action performed in response to a condition.7.3.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.2
result.severityresult.severity{}Indicates the severity of the condition.7.3.3.2
result.severity.textstringThe localized display text.7.3.2
result.severity.valuestringThe value for the specified parameter.7.3.2
result.shortCommentsstringA brief description of the condition name. For example, the text may describe the situation that requires the system to apply the condition. You can set these short comments to display when a user accesses an application with this condition applied to it7.3.3.2
result.statusresult.status{}The record condition status.7.3.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.3.2
result.statusTypestringThe status type for a standard condition or an approval condition, applied or not applied for example.7.3.3.2
result.typeresult.type{}The condition type.7.3.3.2
result.type.textstringThe localized display text.7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3