ISM Core API Operation Requests
- Last UpdatedFeb 24, 2026
- 2 minute read
These APIs provide access to core ISM capabilities, including class library and catalog management. They include:
Catalog Operations
A set of API requests used to retrieve catalog information. Some examples are listed below
|
Request |
Request body |
Description |
|---|---|---|
|
Query catalog identifiers |
query Core { core { catalog { identifiersInUse } } } |
Get all existing Information Standards identifiers. |
|
Query catalog content |
query { core { catalog { collection ( filters:{idLike: "AIM-A%"} orderBys:{ name: "ASC" } pagination: {count:0} includeObsoleted: false ) { id classLibraryHandle name description version abstract sortOrder } } } } |
Get the collection of catalog content with all listed properties after applying the filters configuered: idLike: "AIM-A%" includeObsoleted: false |
ISM Plugins Operations
API requests that expose information about available plugins.
|
Request Type |
Request body |
Description |
|
Query plugins |
query Core { core { plugin { collection { readers { service implementation name title product version description copyright date configuration } writers { supportedCategories defaultFileNameExtension service implementation name title product version description copyright date configuration } } } } } |
Get the collection of readers and writers' plugins. |
SecurityModel Operations
API requests used to retrieve and update security-related information, including folders, users, groups, and related entities.
|
Request Type |
Request body |
Description |
|---|---|---|
|
Query users |
query Core { core { securityModel { users { name handle createdTimeUtc createdBy updatedTimeUtc updatedBy } userGroups { hasMembers hasPotentialMembers hasAccessRights name groupType handle createdTimeUtc createdBy updatedTimeUtc updatedBy } } } } |
Get the list of users and user groups |
Class Library Operations
A set of API requests that support class library actions such as create, merge, save as, lock, unlock, delete, edit, commit, revert commit, and other related operations
|
Request Type |
Request body |
Description |
|
Query a class library with filters |
query { core { classLibrary { content(idOrHandle: "DemoClassLibrary") { id name description classes{ id name description } attributes{ id name description } } } } } |
Query a specific class library where Id="DemoClassLibrary" And list all available classes and attributes |
|
Query classes and attributes |
query { core { classLibrary { content(idOrHandle: "<clib id or handle>") { classes(filters: { nameLike: "Equipment" }) { id name description attributes { id name description dataType } } } } } } |
Get the list of all permissible attributes for the Equipment class |
|
Query enumerations |
query { core { classLibrary { content(idOrHandle: "<clib id or handle>") { id name enumerations(filters: { idLike: "<enum Id>" }) { id description name items { name description id } } } } } } |
Query an enumeration by applying filter on enumeration Id |