Create a new asset entity
You can add a new asset entity to the system using the following API
Value | |
---|---|
HTTP Method | POST |
Path | /api/entities/asset/{scopeId} |
Request parameter | Scope ID: A scope ID in which you want to add this new asset. All users within this scope will automatically see this asset in the asset list |
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"
}
Response
Code | Message body |
---|---|
200 (OK) | The newly added asset ID |
400 (Bad request) | Your request parameter or Body is not in the correct format. Please check the error message for the reason. |
Adding existing asset from other scope into the given scope
In order to maintain data integration, the system doesn't allow you to add duplicate asset names.
If you already have an asset created and would like to use it in a certain scope, you can call the Add API and pass the field internalId
into the request body. The internalId
field is an asset ID which can be acquired by calling /api/entities/asset/list/all
Example
{
"internalId": "5fb3a772d7fde852a4bd2e2a"
"name": "Company #123",
"sectorId": 1,
"industryId": 1,
"custom_1605597587566" : "SET"
}
Updated about 4 years ago