Get All Related Details for Record

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

Resource Information

Scope	records Deprecated scope name: get_record_related
App Type	All
Authorization Type	Access token
URI	/v4/records/{recordId}/related?relationship={relationship}&lang={lang}&fields={fields}
HTTP Method	GET
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
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
relationship	string	No	parent \| child \| renewal	The type of relationship of a related record.	7.3.2

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.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.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.relationship	string	The type of relationship of a related record.	7.3.2
result.serviceProveCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.trackingId	long	The application tracking number (IVR tracking number).	7.3.2
result.type	result.type{}	The related record type.	7.3.2
result.type.category	string	The 4th level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.type.filterName	string	The name of the record type filter which defines the record types to be displayed for the citizen user.	7.3.2
result.type.group	string	The 1st level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.type.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.type.module	string	Use to filter by the module.	7.3.2
result.type.subType	string	The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.type.text	string	The localized display text.	7.3.2
result.type.type	string	The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.type.value	string	The value for the specified parameter.	7.3.2
status	integer	The record status.	7.3.3