Get Control Set Controls

Used to return the control definition of a single Control Set

Endpoint

POST - /ControlSets/GetControlSetControls

Overview

Use this endpoint to lookup a HelpMaster entity (Clients, Sites, Assets etc.), AND a Control Set ID, then then return a detailed definition (including set values) of that Control Set that is linked to that entity. If the Control Sets is linked to the entity, a JSON definition of the Control Set will be returned. This information can then be used to update the Control Set using the ControlSetValue API, or when logging a new job via the LogJobFromJobTemplate API endpoint.

Input Parameters

controlSetPKID

The PKID of the Control Set to lookup. View the “Properties” tab of the Control Set in the Desktop Edition of HelpMaster.

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

Example

Return Control Set #33 from Client #88

{
  "controlSetPKID": 33,
  "entityLink": 88,
  "entityType": "Client"
}

Results

The results display the Control Set information for that entity. These results can copied and used in other API endpoints to update Control Set information.

[
  {
    "guid": "0462fdb3-a6bf-4033-8c61-c22d5617b1ad",
    "name": "Date1",
    "caption": "Start date",
    "isRequired": true,
    "regularExpressionValidator": "",
    "controlType": "DateCtrl",
    "stringValue": null,
    "intValue": null,
    "decimalValue": null,
    "dateValue": "2000-01-01T12:59:48.293"
  },
  {
    "guid": "263da27e-c545-4e84-a3a1-25ec52ac3388",
    "name": "Text2",
    "caption": "First name",
    "isRequired": false,
    "regularExpressionValidator": "",
    "controlType": "TextCtrl",
    "stringValue": null,
    "intValue": null,
    "decimalValue": null,
    "dateValue": null
  },
  {
    "guid": "2de62207-1df8-4d9c-82e6-74c54ae7d649",
    "name": "Text1",
    "caption": "Employee #",
    "isRequired": false,
    "regularExpressionValidator": "",
    "controlType": "TextCtrl",
    "stringValue": "4",
    "intValue": null,
    "decimalValue": null,
    "dateValue": null
  },
  {
    "guid": "46161283-b39f-4ab1-a3fd-36708ae20d63",
    "name": "TextMultiLine1",
    "caption": "Additional information",
    "isRequired": false,
    "regularExpressionValidator": "",
    "controlType": "TextCtrlMultiLine",
    "stringValue": "Good guy",
    "intValue": null,
    "decimalValue": null,
    "dateValue": null
  },
  {
    "guid": "48603d60-e014-4f97-9ed5-350faad00880",
    "name": "DropDown1",
    "caption": "Employment type",
    "isRequired": false,
    "regularExpressionValidator": "",
    "controlType": "DropDownCtrl",
    "stringValue": "Full time",
    "intValue": null,
    "decimalValue": null,
    "dateValue": null
  },
  {
    "guid": "7ea80f89-cb8e-4e75-8e71-39026a896d45",
    "name": "Date2",
    "caption": "End date",
    "isRequired": false,
    "regularExpressionValidator": "",
    "controlType": "DateCtrl",
    "stringValue": null,
    "intValue": null,
    "decimalValue": null,
    "dateValue": null
  },
  {
    "guid": "970f76d6-21a7-4216-a0f2-9b7a1ba1b573",
    "name": "Text4",
    "caption": "Job Title",
    "isRequired": false,
    "regularExpressionValidator": "",
    "controlType": "TextCtrl",
    "stringValue": null,
    "intValue": null,
    "decimalValue": null,
    "dateValue": null
  },
  {
    "guid": "b65cafb3-619c-4f47-8507-9cabb6edf8e0",
    "name": "Text3",
    "caption": "Last name",
    "isRequired": false,
    "regularExpressionValidator": "",
    "controlType": "TextCtrl",
    "stringValue": null,
    "intValue": null,
    "decimalValue": null,
    "dateValue": null
  },
  {
    "guid": "e8538aad-39f4-4389-8f61-5d4574f0a386",
    "name": "TriChoice1",
    "caption": "Requires Carpark Access?",
    "isRequired": false,
    "regularExpressionValidator": "",
    "controlType": "TriChoice",
    "stringValue": "",
    "intValue": 2,
    "decimalValue": null,
    "dateValue": null
  }
]

See also

Control Sets