Get All Assets for Record

Returns all assets for a given record.

Resource Information

Scope records
App Type Agency
Authorization Type Access token
URI /v4/records/{recordId}/assets?lang={lang}&fields={fields}&limit={limit}&offset={offset}
HTTP Method GET
Automation Version(s) 9.0.0

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. 9.0.0
lang String No   Indicates the language applied. 9.0.0
limit long No   Indicates the number of items that are returned in each page. 9.0.0
offset long No   Indicates the offset start of each page by the number specified. 9.0.0
recordId string No Get All Records Search Records Get My Records The unique ID associated with a record. 9.0.0

Response Information

Field Type Description Automation Version
result[] result{} An array containing the assets. 9.0.0
result.classType string A Class Type is how Civic Platform groups objects that an agency owns or maintains. The five class types are component, linear, node-link linear, point, and polygon. Asset class types provide the ability to assign or group multiple asset types together. 9.0.0
result.comments result.comments{} General comments about the asset. 9.0.0
result.comments.text string The localized display text. 9.0.0
result.comments.value string The value for the specified parameter. 9.0.0
result.currentValue double The current value of the asset. 9.0.0
result.dateOfService dateTime The date the asset was initially placed into service. 9.0.0
result.dependentFlag string Indicates whether or not the parent asset is dependent on this asset. 9.0.0
result.depreciationAmount double The decline in the asset value by the asset depreciation calculation. 9.0.0
result.depreciationEndDate dateTime The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
result.depreciationStartDate dateTime The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
result.depreciationValue double The asset value after the asset depreciation calculation, which is based on the start value, depreciation start and end dates, useful life, and salvage value. 9.0.0
result.description result.description{} The description of the asset. 9.0.0
result.description.text string The localized display text. 9.0.0
result.description.value string The value for the specified parameter. 9.0.0
result.endID string The ending point asset ID. 9.0.0
result.gisObjects[] result.gisObjects{} Contains GIS information about the location of the asset. 9.0.0
result.gisObjects.gisId string The id of the GIS object. 9.0.0
result.gisObjects.layerId string The Id of the GIS layer that contains the record location. 9.0.0
result.gisObjects.serviceId string The id of the GIS service. 9.0.0
result.id long The unique, sequence id assigned by the Civic Platform server. Use the id to identify the object on the URI in subsequent object-specific API requests. 9.0.0
result.name result.name{} The descriptive name of the asset. 9.0.0
result.name.text string The localized display text. 9.0.0
result.name.value string The value for the specified parameter. 9.0.0
result.number string The unique, alpha-numeric asset ID. 9.0.0
result.salvageValue double The residual value of the asset at the end of it’s useful life. 9.0.0
result.serviceProviderCode string The unique agency identifier. 9.0.0
result.size double A positive numeric value for the asset size. 9.0.0
result.sizeUnit string The unit of measure corresponding to the asset size. 9.0.0
result.startID string The starting point asset ID. 9.0.0
result.startValue double The beginning value or purchase price of the asset. 9.0.0
result.status string The status of the asset. 9.0.0
result.status.text string The localized display text. 9.0.0
result.status.value string The value for the specified parameter. 9.0.0
result.statusDate dateTime The date the asset status changed. 9.0.0
result.type string The type of asset. 9.0.0
result.type.text string The localized display text. 9.0.0
result.type.value string The value for the specified parameter. 9.0.0
status integer The request status. 9.0.0