Delete Related Details from Record

Removes the relationship between the specifed child record(s) and their specified parent record.

Resource Information

Scoperecords

Deprecated scope name:   delete_record_related

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
childRecordIdsstringYes Comma-delimited ID's of child records related to the parent record7.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