Asset Information Management APIs
- Last UpdatedOct 23, 2026
- 4 minute read
This section describes Asset Information Management (AIM) API examples to access data stored in AIM using data group concept.
Data Groups in AIM define collections of related attributes and associations that are retrieved and displayed together for different object types. They provide a structured way to organize and present information about tags, equipment, documents, events, activities, locations, and other objects within the system.
There are two types of data groups:
-
Core data groups
-
Details: Provides basic identifying information about any object.
-
Key Attributes: Provides essential information needed to understand an object at a glance.
-
Identification: Shows all alternative identifiers for an object.
-
Main Attributes / Properties: Displays all characteristics directly defined on an object.
-
-
Class specific data group: Each has a different list of data group assigned to them.
-
Document content
-
Functional artifact
-
Asset
-
Event
-
Activity
-
Location
-
Data Groups supported through API requests are Main Attributes and Related Items. The below table describes how to use those for each type of objects
|
AIM API |
Usage |
|---|---|
|
GET {dashboardUrl}/api/domain/authorization/issessionvalid |
To check if a session is still valid and retrieve the XSRF cookie. |
|
POST {dashboardUrl}/api/v1/domain/searches/run |
To fetch data from AIM. The request body contains information on the search parameters and data to be retrieved for the objects fulfilling the criteria. |
|
For Tags: GET {dashboardUrl}/api/v1/domain/dataGroup/{objecthandle} ?dataGroupNames=Main Attributes &dataGroupNames=Related Items 1 &dataGroupNames=Related Items 2 &dataGroupNames=Related Items 3 &dataGroupNames=Related Items 4 &dataGroupNames=Related Items 5 |
Different DataGroup names can be passed to this API. Different Related Items data group names fetch the following values (also used for Tag Summary view): Related Items 1: Parts/Components (using association is an assembly including against FACILITY and subclasses) Related Items 2: Equipment (using association is implemented by / is fulfilled by against ASSET and subclasses) Related Items 3: Documents and 3D Models (using association is referenced in / has document against DOCUMENT CONTENT and subclasses) Related Items 4: Events (using association has event against EVENT and subclasses) Related Items 5: Activities/Tasks (using association has activity / has task against ACTIVITY and subclasses) Fetch attributes and related items for each object by passing in the object handle. This API will only return 3000 related items - for performance reasons. |
|
For Documents: GET {dashboardUrl}/api/v1/domain/dataGroup/{objecthandle} ?dataGroupNames=Main Attributes &dataGroupNames=Related Items 1 &dataGroupNames=Related Items 2 &dataGroupNames=Related Items 3 &dataGroupNames=Related Items 4 &dataGroupNames=Related Items 5 |
Different Related Items data group names fetch the following values (also used for Document Summary view): Related Items 1: Tags (using association refers to / is a document for against FACILITY and subclasses) Related Items 2: Equipment (using association refers to / is a document for against ASSET and subclasses) Related Items 3: Documents and 3D Models (using association is associated with / refers to / is referenced in against DOCUMENT CONTENT and subclasses) Related Items 4: Events (using association refers to / is a document for against EVENT and subclasses) Related Items 5: Activities/Tasks (using association refers to / is a document for against ACTIVITY and subclasses) |
|
For Equipment Objects: GET {dashboardUrl}/api/v1/domain/dataGroup/{objecthandle} ?dataGroupNames=Main Attributes &dataGroupNames=Related Items 1 &dataGroupNames=Related Items 2 &dataGroupNames=Related Items 3 &dataGroupNames=Related Items 4 &dataGroupNames=Related Items 5 |
Different Related Items data group names fetch the following values (also used for Equipment Summary view): Related Items 1: Tags (using association implements / fulfills against FACILITY and subclasses) Related Items 2: Parts/Components (using association is an assembly including against ASSET and subclasses) Related Items 3: Documents and 3D Models (using association is referenced in / has document against DOCUMENT CONTENT and subclasses) Related Items 4: Events (using association has activity / has task against EVENT and subclasses) Related Items 5: Activities/Tasks (using association has activity / has task against ACTIVITY and subclasses) |
|
For Activity: GET {dashboardUrl}/api/v1/domain/dataGroup/{objecthandle} ?dataGroupNames=Main Attributes &dataGroupNames=Related Items 1 &dataGroupNames=Related Items 2 &dataGroupNames=Related Items 3 &dataGroupNames=Related Items 4 &dataGroupNames=Related Items 5 |
Different Related Items data group names fetch the following values (also used for Activity Summary view): Related Items 1: Tags (using association is an event on against FACILITY and subclasses) Related Items 2: Equipment (using association is an event on against ASSET and subclasses) Related Items 3: Documents &3D Model (using associations referenced in / has document against DOCUMENT CONTENT and subclasses) Related Items 4: Event (using association has event against EVENT and subclasses) Related Items 5:Activity (using association has activity / has task against ACTIVITY and subclasses) |
|
For Event: GET {dashboardUrl}/api/v1/domain/dataGroup/{objecthandle} ?dataGroupNames=Main Attributes &dataGroupNames=Related Items 1 &dataGroupNames=Related Items 2 &dataGroupNames=Related Items 3 &dataGroupNames=Related Items 4 &dataGroupNames=Related Items 5 |
Different Related Items data group names fetch the following values (also used for Event Summary view): Related Items 1: Tags (using association is an event on against FACILITY and subclasses) Related Items 2: Equipment (using association is an event on against ASSET and subclasses) Related Items 3: Documents&3D Model (using association is reference in / has document against DOCUMENT CONTENT and subclasses) Related Items 4: Event (using association has event against EVENT and subclasses) Related Items 5: Activity (using association has activity / has task against ACTIVITY and subclasses) |
|
For Location: GET {dashboardUrl}/api/v1/domain/dataGroup/{objecthandle} ?dataGroupNames=Main Attributes &dataGroupNames=Related Items 1 &dataGroupNames=Related Items 2 &dataGroupNames=Related Items 3 &dataGroupNames=Related Items 4 &dataGroupNames=Related Items 5 |
Different Related Items data group names fetch the following values (also used for Location Summary view): Related Items 1: Tags (using association is the location of against FACILITY and subclasses) Related Items 2: Equipment (using association is the location of against ASSET and subclasses) Related Items 3: Document&3D Model (using association is referenced in / has document against DOCUMENT CONTENT and subclasses) Related Items 4: Event (using association has event against EVENT and subclasses) Related Items 5: Activity (using association has activity / has task against ACTIVITY and subclasses) |