Update Asset Custom Attributes

Updates the custom attributes for a given asset. The response returns an array containing any custom attribute validation error and the status of the asset update.

Resource Information

Scope assets
App Type Agency
Authorization Type Access token
URI /v4/assets/{id}/attributes
HTTP Method PUT
Automation Version(s) 9.0.0

Request Information

Field or Parameter Type Required Values Description Automation Version
<customType> string No   A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables.
  • For a Text field, the maximum length is 256.
  • For a Number field, any numeric form is allowed, including negative numbers.
  • For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm.
  • For a TextArea field, the maximum length is 4000 characters, and allows line return characters.
  • For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED".
  • For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No".
 9.0.0
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. 9.0.0
id string No Get All Assets The unique identifier for the asset assigned by the Civic Platform server. 9.0.0
lang String No   Indicates the language applied. 9.0.0

Response Information

Field Type Description Automation Version
result[] result{} An array containing any validation errors related to the custom attributes in the update request. 9.0.0
result.code string A code identifying an associated item 9.0.0
result.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 9.0.0
result.isSuccess boolean Indicates whether or not the operation on the item is successful. 9.0.0
result.message string A text message related to the operation. 9.0.0
status integer The request status. 9.0.0