Manage assets
Here you will find endpoints relevant to asset management and details about every verb and its fields.
Required modules
You will need the Data Studio module to visualize the Assets in your company. Check your modules at Admin > Licenses. To obtain this module, contact your IXON account manager or IXON distributor.
Before you start
Make sure to check this support article to understand the advantages of assets and how to manage them through the portal. This will help with visualizing the actions performed from the following API endpoints.
Assuming that you already have an applicationId, companyId and bearerToken, you will now be able to call the following endpoints!
Note about
resourceVariantThis object field is used to represent the asset type, and can be found in Admin > Device settings > Asset types. Machine and Component are default types.
AssetList
| Verb | Goal | Required fields and IDs |
|---|---|---|
| GET | Retrieves a list of assets. | You can use ?fields=company.publicId,name,description,resourceVariant.\*,parent.publicId and more to return the needed data. |
| POST | Creates one or more new assets. Returns the publicId of each of the new assets. | The name of the new asset(s) and the publicId of the resourceVariant. |
| PATCH | Modifies one or more fields of one or more assets. | The publicId of the asset(s) you want to modify. |
| DELETE | Deletes one or more assets. | The publicId of the asset(s) you want to delete. |
Please note: the Asset endpoint is the non-list version of AssetList, and can be used to perform GET, POST, PATCH and DELETE actions for a single asset.
AssetTypeList
| Verb | Goal | Required fields and IDs |
|---|---|---|
| GET | Retrieves a list of asset types. | N/A |
| POST | Creates one or more new asset types. Returns the publicId of each of the new asset types. | The name of the new asset(s) and the order, whose value is based on the position in the list of asset types. If it's the first asset type in the list, its value will be 0, if it's second it will be 1000, if third it will be 2000 and so on. |
| PATCH | Modifies one or more fields of one or more asset types. | The publicId of the asset type(s) you want to modify. |
| DELETE | Deletes one or more assets. | The publicId of the asset(s) you want to delete. |
Please note: the AssetType endpoint is the non-list version of AssetTypeList, and can be used to perform GET, POST, PATCH and DELETE actions for a single asset type.
AssetMembershipList
| Verb | Goal | Required fields and IDs |
|---|---|---|
| GET | Retrieves a list of asset memberships. | You can use ?fields=asset.publicId,group.publicId to retrieve the needed fields. |
| POST | Creates one or more new asset memberships. Returns the publicId of each of the new asset memberships. | The publicId of both the asset and the group. Note: you cannot use the publicId of a sub-asset. |
| PATCH | Modifies one or more fields of one or more asset types. | The publicId of the asset membership(s) you want to modify, of those of the asset and group. |
| DELETE | Deletes one or more asset memberships. | The publicId of the asset membership(s) you want to delete. |
Please note: the AssetMembership endpoint is the non-list version of AssetMembershipList, and can be used to perform GET, PATCH and DELETE actions for a single asset membership.
Updated about 17 hours ago