Update Asset

Update the asset information for a given asset ID.

Resource Information

Scopeassets
App TypeAgency
Authorization TypeAccess token
URI /v4/assets/{id}/asset
HTTP MethodPUT
Automation Version(s)9.0.0

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
classTypestringNo�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.8.0
commentscomments{}No�General comments about the asset.8.0
comments.textstringNo�The localized display text.9.0.0
comments.valuestringNo�The value for the specified parameter.9.0.0
currentValuedoubleNo�The current value of the asset.8.0
dateOfServicedateTimeNo�The date the asset was initially placed into service.8.0
dependentFlagstringNo�Indicates whether or not the parent asset is dependent on this asset.8.0
depreciationAmountdoubleNo�The decline in the asset value by the asset depreciation calculation.8.0
depreciationEndDatedateTimeNo�The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation.8.0
depreciationStartDatedateTimeNo�The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation.8.0
depreciationValuedoubleNo�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.8.0
descriptiondescription{}No�The description of the asset.8.0
description.textstringNo�The localized display text.9.0.0
description.valuestringNo�The value for the specified parameter.9.0.0
endIDstringNo�The ending point asset ID.8.0
gisObjects[]gisObjects{}No�Contains GIS information about the location of the asset.8.0.3.0.0
gisObjects.gisIdstringNo�The id of the GIS object.9.0.0
gisObjects.layerIdstringNo�The Id of the GIS layer that contains the record location.9.0.0
gisObjects.serviceIdstringNo�The id of the GIS service.9.0.0
idlongNo�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.8.0
namename{}No�The descriptive name of the asset.8.0
name.textstringNo�The localized display text.9.0.0
name.valuestringNo�The value for the specified parameter.9.0.0
numberstringNo�The unique, alpha-numeric asset ID.8.0.3.0.0
salvageValuedoubleNo�The residual value of the asset at the end of it’s useful life.8.0
serviceProviderCodestringNo�The unique agency identifier.8.0.3.0.0
sizedoubleNo�A positive numeric value for the asset size.8.0
sizeUnitstringNo�The unit of measure corresponding to the asset size.8.0
startIDstringNo�The starting point asset ID.8.0
startValuedoubleNo�The beginning value or purchase price of the asset.8.0
statusstringNo�The status of the asset.8.0
status.textstringNo�The localized display text.9.0.0
status.valuestringNo�The value for the specified parameter.9.0.0
statusDatedateTimeNo�The date the asset status changed.8.0
typestringNo�The type of asset.8.0
type.textstringNo�The localized display text.9.0.0
type.valuestringNo�The value for the specified parameter.9.0.0
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.9.0.0
idstringNo�The unique identifier for the object, assigned by the Civic Platform server and provided in a response.9.0.0
langStringNo�Indicates the language applied.9.0.0

Response Information

FieldTypeDescriptionAutomation Version
resultresult{}�9.0.0
result.codestringA code identifying an associated item9.0.0
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.9.0.0
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 9.0.0
result.messagestringA text message related to the operation.9.0.0
statusintegerThe record status.9.0.0