Get All Related Details for Record

Gets the records related, by a parent or child relation, to the specified record.

Resource Information

Scoperecords

Deprecated scope name:   get_record_related

App TypeAll
Authorization TypeAccess token
URI /v4/records/{recordId}/related?relationship={relationship}&lang={lang}&fields={fields}
HTTP MethodGET
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
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
relationshipstringNoparent | child | renewalThe type of relationship of a related record.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.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.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.relationshipstringThe type of relationship of a related record.7.3.2
result.serviceProveCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.typeresult.type{}The related record type.7.3.2
result.type.categorystringThe 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.filterNamestringThe name of the record type filter which defines the record types to be displayed for the citizen user.7.3.2
result.type.groupstringThe 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.type.modulestringUse to filter by the module.7.3.2
result.type.subTypestringThe 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.typestringThe 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3