Remove Control Set Value

Used to remove a single Control Set field value

Endpoint

POST - /ControlSetValue/RemoveControlSetValue

Overview

Removes and/or blanks-out a value in a Control Set field.

Parameters

The PKID of an existing entity. The PKID is found on the “Properties” tab of each entity within the Desktop Edition of HelpMaster.

entityType

The entity type that the Control Set is linked to. Supported values include:

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

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

controlGUID

The unique GUID of the individual control within the Control Set that you want to remove/blank-out. The GUID can be found by viewing the Control Set definition within the Desktop Edition of HelpMaster, or by using the Web API call Get Control Set Controls

Example

{
  "entityLink": 88,
  "entityType": "Client",
  "controlSetLink": 8,
  "controlGUID": "416e06a1-256a-4318-84ac-270644f887e1"
}

See also

Control Sets