Update asset entity
You can update asset information using the following API:
Value | |
---|---|
HTTP Method | PUT |
Path | * /api/entities/asset/{scopeId}/{assetId} |
Request parameter | Scope ID: a scope ID to which this asset belongs to. The scope ID is also used to determine the user privilege to update this asset. Full access permission to Asset feature is required to make changes to asset information. Asset ID: an asset ID to update information |
Request body | Asset object in JSON, the required fields are - name - sectorId - industryId |
Request body example
{
"name": "Company #123",
"sectorId": 1,
"industryId": 1,
"custom_1605597587566" : "SET"
}
Request body with timestamp example
{
"name": "Company #123",
"sectorId": 1,
"industryId": 1,
"custom_1605597587566" : "SET",
"custom_1622368040764": [
{
"value": "dropdown value 1",
"asOfDate": "2019-01-01"
},
{
"value": "dropdown value 2",
"asOfDate": "2020-01-01"
},
{
"value": "Inception dropdown",
"isInception": true
}
],
"typeId": [
{
"value": 2,
"asOfDate": "2017-01-01"
},
{
"value": 3,
"asOfDate": "2016-01-01"
},
{
"value": 1,
"isInception": true
}
]
}
Response
Code | Description |
---|---|
200 (OK) | The asset information has been updated successfully |
400 (Bad request) | Your request parameter or Body is not in the correct format. Please check the error message for the reason. |
404 (Not found) | The given asset ID doesn't exist in the database |
You can update multiple assets information using the following API:
Value | |
---|---|
HTTP Method | PUT |
Path | /api/entities/asset/multiple/{scopeId} |
Request parameter | Scope ID: a scope ID to which this asset belongs to. The scope ID is also used to determine the user privilege to update this asset. Full access permission to Asset feature is required to make changes to asset information. |
Request body | Asset object array in JSON, the required fields are - name - sectorId - industryId |
Request body example
[
{
"name": "Company #123",
"sectorId": 1,
"industryId": 1,
"custom_1605597587566" : "SET asset 1"
},
{
"name": "Company #456",
"sectorId": 1,
"industryId": 1,
"custom_1605597587566" : "SET asset 2",
"legalName": [
{
"value": "legal name 1",
"asOfDate": "2019-01-01"
}
]
}
]
Response
Value | |
---|---|
200 (OK) | The asset information has been updated successfully |
400 (Bad request) | Your request parameter or Body is not in the correct format. Please check the error message for the reason. |
Updated about 3 years ago