Create Record Approval Conditions

Creates a conditions of approval for the specified record(s).

Resource Information

Scoperecords

Deprecated scope name:   create_record_condition_approvals

App TypeAgency
Authorization TypeAccess token
URI /v4/records/{recordId}/conditionApprovals?lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
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
activeStatusactiveStatus{}NoA | IIndicates whether or not the condition is active.7.3.2
activeStatus.textstringNo The localized display text.7.3.2
activeStatus.valuestringNo The value for the specified parameter.7.3.2
additionalInformationstringNo An unlimited text field to use if other fields are filled.7.3.2
additionalInformationPlainTextstringNo An unlimited text field to use if other fields are filled.7.3.2
appliedbyDepartmentappliedbyDepartment{}No Get All Departments The department responsible for applying a condition.7.3.2
appliedbyDepartment.textstringNo The localized display text.7.3.2
appliedbyDepartment.valuestringNo The value for the specified parameter.7.3.2
appliedbyUserappliedbyUser{}No The staff member responsible for applying a condition.7.3.2
appliedbyUser.textstringNo The localized display text.7.3.2
appliedbyUser.valuestringNo The value for the specified parameter.7.3.2
appliedDatedateTimeNo The date to apply a condition.7.3.2
dispAdditionalInformationPlainTextstringNo An unlimited text field to use if other fields are filled.7.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.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.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.2
displayOrderlongNo The order of the item in comparison to the other items.7.3.2
effectiveDatedateTimeNo The date when you want the condition to become effective.7.3.2
expirationDatedateTimeNo The date when the condition expires.7.3.2
groupgroup{}No 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.2
group.textstringNo The localized display text.7.3.2
group.valuestringNo The value for the specified parameter.7.3.2
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
inheritableinheritable{}No This defines whether or not Accela Automation checks for inheritable conditions when a user associates a child record with a parent record.7.3.2
inheritable.textstringNo The localized display text.7.3.2
inheritable.valuestringNo The value for the specified parameter.7.3.2
isIncludeNameInNoticeBooleanNotrue | falseIndicates whether or not to display the condition name in the notice.7.3.2
isIncludeShortCommentsInNoticeBooleanNotrue | falseIndicates whether or not to display the condition comments in the notice.7.3.2
longCommentsstringNo Narrative comments to help identify the purpose or uses of the standard condition.7.3.2
namestringNo The full name for the application contact.7.3.2
prioritypriority{}No Get All Standard Conditon Priorities The priority level assigned to the condition.7.3.2
priority.textstringNo The localized display text.7.3.2
priority.valuestringNo The value for the specified parameter.7.3.2
publicDisplayMessagestringNo Text 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.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
resAdditionalInformationPlainTextstringNo An unlimited text field to use if other fields are filled.7.3.2
resolutionActionstringNo The action performed in response to a condition.7.3.2
serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
severityseverity{}No Indicates the severity of the condition.7.3.2
severity.textstringNo The localized display text.7.3.2
severity.valuestringNo The value for the specified parameter.7.3.2
shortCommentsstringNo A 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.2
statusstatus{}No Get All Standard Condition Statuses Get All Approval Condition Statuses The record condition 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
statusTypestringNo The status type for a standard condition or an approval condition, applied or not applied for example.7.3.2
typetype{}No Get All Standard Condition Types The condition type.7.3.2
type.textstringNo The localized display text.7.3.2
type.valuestringNo The value for the specified parameter.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

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.3