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
classTypestringNoA 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{}NoGeneral comments about the asset.8.0
comments.textstringNoThe localized display text.9.0.0
comments.valuestringNoThe value for the specified parameter.9.0.0
currentValuedoubleNoThe current value of the asset.8.0
dateOfServicedateTimeNoThe date the asset was initially placed into service.8.0
dependentFlagstringNoIndicates whether or not the parent asset is dependent on this asset.8.0
depreciationAmountdoubleNoThe decline in the asset value by the asset depreciation calculation.8.0
depreciationEndDatedateTimeNoThe end date for the asset depreciation calculation. This field is used in the asset depreciation calculation.8.0
depreciationStartDatedateTimeNoThe start date for the asset depreciation calculation. This field is used in the asset depreciation calculation.8.0
depreciationValuedoubleNoThe 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{}NoThe description of the asset.8.0
description.textstringNoThe localized display text.9.0.0
description.valuestringNoThe value for the specified parameter.9.0.0
endIDstringNoThe ending point asset ID.8.0
gisObjects[]gisObjects{}NoContains GIS information about the location of the asset.8.0.3.0.0
gisObjects.gisIdstringNoThe id of the GIS object.9.0.0
gisObjects.layerIdstringNoThe Id of the GIS layer that contains the record location.9.0.0
gisObjects.serviceIdstringNoThe id of the GIS service.9.0.0
idlongNoThe 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{}NoThe descriptive name of the asset.8.0
name.textstringNoThe localized display text.9.0.0
name.valuestringNoThe value for the specified parameter.9.0.0
numberstringNoThe unique, alpha-numeric asset ID.8.0.3.0.0
salvageValuedoubleNoThe residual value of the asset at the end of it’s useful life.8.0
serviceProviderCodestringNoThe unique agency identifier.8.0.3.0.0
sizedoubleNoA positive numeric value for the asset size.8.0
sizeUnitstringNoThe unit of measure corresponding to the asset size.8.0
startIDstringNoThe starting point asset ID.8.0
startValuedoubleNoThe beginning value or purchase price of the asset.8.0
statusstringNoThe status of the asset.8.0
status.textstringNoThe localized display text.9.0.0
status.valuestringNoThe value for the specified parameter.9.0.0
statusDatedateTimeNoThe date the asset status changed.8.0
typestringNoThe type of asset.8.0
type.textstringNoThe localized display text.9.0.0
type.valuestringNoThe value for the specified parameter.9.0.0
fieldsstringNoComma-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
idstringNoThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.9.0.0
langStringNoIndicates 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