Control Set Value String

Used to update a single Control Set string field value

Endpoint

POST - /ControlSetValue/UpdateControlSetValue_String

Overview

Update the text value in a Control Set string 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 update. 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

controlValue

A string/text value to save to the Control Set. The value specified here will overwrite any existing value that is stored in the Control Set field.

Example

{
  "entityLink": 132,
  "entityType": "Job",
  "controlSetLink": 8,
  "controlGUID": "416e06a1-256a-4318-84ac-270644f887e1",
  "controlValue": "This is the string value that will be updated"
}

See also

Control Sets