Update an Asset
post
/rest/v7/assets/{id}
This operation updates an existing asset.
Request
Path Parameters
-
id: integer
Primary Key of Asset Resource.
Root Schema : Assets-request
Type:
Show Source
object
-
_proxy_id(optional):
string
Title:
_proxy_id
temporary record identifier; optional field applicable only in the context of synchronize action -
_sync_action(optional):
string
Title:
_sync_action
record level operation; optional field applicable only in the context of synchronize action -
assetDescription(optional):
string
Title:
Asset Description
Description of the asset. -
assetKey(optional):
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
attributes(optional):
string
Title:
Attributes
A collection (JSON) of key/value pair attributes that define the configuration of this asset/component. -
billingAccount(optional):
string
Title:
Billing Account
The billing account associated with this asset. -
billingProfile(optional):
string
Title:
Billing Profile
The billing profile associated with this asset. -
contractReference(optional):
string
Title:
Contract
Contract associated with this asset. -
currency(optional):
object Currency
Title:
Currency
Currency Code for the asset -
customer(optional):
string
Title:
Customer
The customer that owns the product. This is the value stored in main doc XML attribute _customer_id. -
dateAdded(optional):
string
Title:
Date Added
System field indicating the date on which the Resource was created. -
dateModified(optional):
string
Title:
Date Modified
System field indicating the date on which the Resource was last modified. -
discountAmount(optional):
object DiscountAmount
Title:
DiscountAmount
The amount of discount received -
discountPercent(optional):
number
Title:
DiscountPercent
The percent of discount received. -
displayKey(optional):
string
Title:
Display
The public, non-unique key for the product instance. For example, phone number or serial number. -
endDate(optional):
string
Title:
Ends On
Date on which the service contract ends -
fixedRecurringAmount(optional):
object Fixed Recurring Amount
Title:
Fixed Recurring Amount
The recurring charge for the product. For example, $10 per month. -
fixedRecurringPeriod(optional):
string
Title:
Fixed Recurring Period
The period for the fixed recurring charge. For example, Per Month. -
id(optional):
integer
Title:
Id
Primary Key of Asset Resource. -
installDate(optional):
string
Title:
Installed On
Date on which asset was installed. -
oneTimeNetAmount(optional):
object One Time Net Amount
Title:
One Time Net Amount
The price paid to purchase the product -
parentAsset(optional):
object Parent Asset Id
Title:
Parent Asset Id
The parent component of the asset bill of materials tree -
parentDisplay(optional):
string
Title:
Parent Display
The display key of the parent asset. -
parentPartNumber(optional):
string
Title:
Parent Part Number
The part number of the parent asset. -
partDescription(optional):
string
Title:
Part Description
The description of the part. -
partNumber(optional):
string
Title:
Part Number
Part Number of the referenced product instance. -
paymentTerm(optional):
string
Title:
Payment Term
The payment terms. For example, Net 30. -
purchaseDate(optional):
string
Title:
Purchased On
Date on which the product/service was purchased. -
quantity(optional):
number
Title:
Quantity
The quantity of the asset. -
registeredDate(optional):
string
Title:
Registered On
Date on which product was registered. -
resumeDate(optional):
string
Title:
Resumed On
Date on which the service contract was resumed -
rootAsset(optional):
object Root Asset Id
Title:
Root Asset Id
The root component in the asset bill of materials tree. -
rootDisplay(optional):
string
Title:
Root Display
The display key of the root asset. -
rootPartNumber(optional):
string
Title:
Root Part Number
The part number of the root asset. -
serialNumber(optional):
string
Title:
Serial Number
Serial Number of the asset. -
serviceAccount(optional):
string
Title:
Service Account
The service account associated with this asset. -
serviceAddress(optional):
string
Title:
Service Address
The service address associated with this asset. -
startDate(optional):
string
Title:
Starts On
Date on which the service contract starts -
status(optional):
object Status
Title:
Status
The status of the asset -
suspendDate(optional):
string
Title:
Suspended On
Date on which the service contract was suspended -
usageNetAmount(optional):
object Usage Net Amount
Title:
Usage Net Amount
The variable, usage price for the product. For example, $0.10 per Copy. -
usageUnitOfMeasure(optional):
string
Title:
Usage Unit of Measure
The unit of measure for the usage charges. For example, Per Copy or Per Minute. -
warrantyEndDate(optional):
string
Title:
Warranty Ends On
Date on which warranty ends. -
warrantyStartDate(optional):
string
Title:
Warranty Starts On
Date on which warranty starts.
Nested Schema : Currency
Type:
object
Title:
Currency
Currency Code for the asset
Show Source
-
currencyCode(optional):
string
Title:
Currency Code
Unique currency code for the currency.
Nested Schema : DiscountAmount
Type:
object
Title:
DiscountAmount
The amount of discount received
Show Source
-
currency(optional):
string
Title:
currency
-
value(optional):
number
Title:
value
Nested Schema : Fixed Recurring Amount
Type:
object
Title:
Fixed Recurring Amount
The recurring charge for the product. For example, $10 per month.
Show Source
-
currency(optional):
string
Title:
currency
-
value(optional):
number
Title:
value
Nested Schema : One Time Net Amount
Type:
object
Title:
One Time Net Amount
The price paid to purchase the product
Show Source
-
currency(optional):
string
Title:
currency
-
value(optional):
number
Title:
value
Nested Schema : Parent Asset Id
Type:
object
Title:
Parent Asset Id
The parent component of the asset bill of materials tree
Show Source
-
assetKey(optional):
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
id(optional):
integer
Title:
Id
Primary Key of Asset Resource.
Nested Schema : Root Asset Id
Type:
object
Title:
Root Asset Id
The root component in the asset bill of materials tree.
Show Source
-
assetKey(optional):
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
id(optional):
integer
Title:
Id
Primary Key of Asset Resource.
Nested Schema : Status
Type:
object
Title:
Status
The status of the asset
Show Source
-
displayValue(optional):
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id(optional):
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode(optional):
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Usage Net Amount
Type:
object
Title:
Usage Net Amount
The variable, usage price for the product. For example, $0.10 per Copy.
Show Source
-
currency(optional):
string
Title:
currency
-
value(optional):
number
Title:
value
Response
Default Response
Root Schema : Assets
Type:
object
Title:
Show Source
Assets
-
_proxy_id(optional):
string
Title:
_proxy_id
temporary record identifier; optional field applicable only in the context of synchronize action -
_sync_action(optional):
string
Title:
_sync_action
record level operation; optional field applicable only in the context of synchronize action -
assetDescription(optional):
string
Title:
Asset Description
Description of the asset. -
assetKey(optional):
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
attributes(optional):
string
Title:
Attributes
A collection (JSON) of key/value pair attributes that define the configuration of this asset/component. -
billingAccount(optional):
string
Title:
Billing Account
The billing account associated with this asset. -
billingProfile(optional):
string
Title:
Billing Profile
The billing profile associated with this asset. -
contractReference(optional):
string
Title:
Contract
Contract associated with this asset. -
currency(optional):
object Currency
Title:
Currency
Currency Code for the asset -
customer(optional):
string
Title:
Customer
The customer that owns the product. This is the value stored in main doc XML attribute _customer_id. -
dateAdded(optional):
string
Title:
Date Added
System field indicating the date on which the Resource was created. -
dateModified(optional):
string
Title:
Date Modified
System field indicating the date on which the Resource was last modified. -
discountAmount(optional):
object DiscountAmount
Title:
DiscountAmount
The amount of discount received -
discountPercent(optional):
number
Title:
DiscountPercent
The percent of discount received. -
displayKey(optional):
string
Title:
Display
The public, non-unique key for the product instance. For example, phone number or serial number. -
endDate(optional):
string
Title:
Ends On
Date on which the service contract ends -
fixedRecurringAmount(optional):
object Fixed Recurring Amount
Title:
Fixed Recurring Amount
The recurring charge for the product. For example, $10 per month. -
fixedRecurringPeriod(optional):
string
Title:
Fixed Recurring Period
The period for the fixed recurring charge. For example, Per Month. -
id(optional):
integer
Title:
Id
Primary Key of Asset Resource. -
installDate(optional):
string
Title:
Installed On
Date on which asset was installed. -
oneTimeNetAmount(optional):
object One Time Net Amount
Title:
One Time Net Amount
The price paid to purchase the product -
parentAsset(optional):
object Parent Asset Id
Title:
Parent Asset Id
The parent component of the asset bill of materials tree -
parentDisplay(optional):
string
Title:
Parent Display
The display key of the parent asset. -
parentPartNumber(optional):
string
Title:
Parent Part Number
The part number of the parent asset. -
partDescription(optional):
string
Title:
Part Description
The description of the part. -
partNumber(optional):
string
Title:
Part Number
Part Number of the referenced product instance. -
paymentTerm(optional):
string
Title:
Payment Term
The payment terms. For example, Net 30. -
purchaseDate(optional):
string
Title:
Purchased On
Date on which the product/service was purchased. -
quantity(optional):
number
Title:
Quantity
The quantity of the asset. -
registeredDate(optional):
string
Title:
Registered On
Date on which product was registered. -
resumeDate(optional):
string
Title:
Resumed On
Date on which the service contract was resumed -
rootAsset(optional):
object Root Asset Id
Title:
Root Asset Id
The root component in the asset bill of materials tree. -
rootDisplay(optional):
string
Title:
Root Display
The display key of the root asset. -
rootPartNumber(optional):
string
Title:
Root Part Number
The part number of the root asset. -
serialNumber(optional):
string
Title:
Serial Number
Serial Number of the asset. -
serviceAccount(optional):
string
Title:
Service Account
The service account associated with this asset. -
serviceAddress(optional):
string
Title:
Service Address
The service address associated with this asset. -
startDate(optional):
string
Title:
Starts On
Date on which the service contract starts -
status(optional):
object Status
Title:
Status
The status of the asset -
suspendDate(optional):
string
Title:
Suspended On
Date on which the service contract was suspended -
usageNetAmount(optional):
object Usage Net Amount
Title:
Usage Net Amount
The variable, usage price for the product. For example, $0.10 per Copy. -
usageUnitOfMeasure(optional):
string
Title:
Usage Unit of Measure
The unit of measure for the usage charges. For example, Per Copy or Per Minute. -
warrantyEndDate(optional):
string
Title:
Warranty Ends On
Date on which warranty ends. -
warrantyStartDate(optional):
string
Title:
Warranty Starts On
Date on which warranty starts.
Nested Schema : Currency
Type:
object
Title:
Currency
Currency Code for the asset
Show Source
-
currencyCode(optional):
string
Title:
Currency Code
Unique currency code for the currency.
Nested Schema : DiscountAmount
Type:
object
Title:
DiscountAmount
The amount of discount received
Show Source
-
currency(optional):
string
Title:
currency
-
value(optional):
number
Title:
value
Nested Schema : Fixed Recurring Amount
Type:
object
Title:
Fixed Recurring Amount
The recurring charge for the product. For example, $10 per month.
Show Source
-
currency(optional):
string
Title:
currency
-
value(optional):
number
Title:
value
Nested Schema : One Time Net Amount
Type:
object
Title:
One Time Net Amount
The price paid to purchase the product
Show Source
-
currency(optional):
string
Title:
currency
-
value(optional):
number
Title:
value
Nested Schema : Parent Asset Id
Type:
object
Title:
Parent Asset Id
The parent component of the asset bill of materials tree
Show Source
-
assetKey(optional):
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
id(optional):
integer
Title:
Id
Primary Key of Asset Resource.
Nested Schema : Root Asset Id
Type:
object
Title:
Root Asset Id
The root component in the asset bill of materials tree.
Show Source
-
assetKey(optional):
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
id(optional):
integer
Title:
Id
Primary Key of Asset Resource.
Nested Schema : Status
Type:
object
Title:
Status
The status of the asset
Show Source
-
displayValue(optional):
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id(optional):
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode(optional):
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Usage Net Amount
Type:
object
Title:
Usage Net Amount
The variable, usage price for the product. For example, $0.10 per Copy.
Show Source
-
currency(optional):
string
Title:
currency
-
value(optional):
number
Title:
value