Control Sets List For Entity

Used to return a list of control sets that are linked to an entity

Endpoint

POST - /ControlSets/GetControlSetsListForEntity

Overview

Use this endpoint to lookup a HelpMaster entity (Clients, Sites, Assets etc.), and return a simple list of Control Sets that are linked to that entity.

Input Parameters

The PKID of an existing entity. The PKID is found on the “Properties” tab of each entity within the Desktop Edition of HelpMaster. See picture below for an example of the PKID for a Job Template.

Job Template PKIKD

entityType

The entity type that you wish to look up. Supported values include:

  • Client
  • Site
  • Asset
  • Job
  • JobTemplate
  • ChangeRequest

Examples

Query all of the Control Sets linked to Job Template #17

Example

{
  "entityLink": 17,
  "entityType": "JobTemplate"
}

Results

[
  {
    "pkid": 33,
    "controlSetName": "Employee Details"
  },
  {
    "pkid": 4,
    "controlSetName": "Workstation build"
  },
  {
    "pkid": 35,
    "controlSetName": "Manager"
  }
]

See also

Control Sets