Reference Data API Overview

The Reference Data API exposes a collection of API operations to manage platform wide reference data resources.

A tag is a keyword or term assigned to an instance of a data entity (e.g. an account, database, profile, or treaty ) which describes that entity and facilitates searching or automation. All users may assign tags to risk data entities.

A tag group is a collection of tags. The tags within a tag group are organized by tag entity, a prefined structure for categorizing tags. The tenant may create an manage multiple tag groups to organize their tags in any way they find appropriate.

For example, the following tag group collects tags belonging to its Western office. The three tag entities collect tags that identify Databases (1), Profiles (3), and Treaties (6):

{
  "tagGroupName": "West",
  "tagGroupId": 5,
  "createdAt": "2024-07-08T20:11:41.288Z",
  "updatedAt": "2024-07-08T20:11:41.288Z",
  "createdBy": "[email protected]",
  "updatedBy": "[email protected]",
  "description": "Tags for western business organization",
  "entityMap": [
    {
      "entityId": 1,
      "tagIds": [11, 23, 33]
    },
    {
      "entityId": 3,
      "tagIds": [14, 15, 36]
    },
    {
      "entityId": 6,
      "tagIds": [45, 57, 63, 89]
    }
  ],
  "isPrivate": true
}

The entityMap is an array of mappings between a tag entity and a group of tags. A tag entity is a predefined bucket for organizing tags within a tag group. Platform API supports nine types of tag entities that that identified by tagEntityID:

Tag Entity IDDescription
1Databases
2Results
3Profiles
4Portfolios
5Accounts
6Treaties
7Aggregate Portfolios
8Programs
9Business Hierarchies