GetControlSetsLiteTemplateForLogJob

Used to populate a Control Set when logging a new job

Endpoint

POST - /jobs/GetControlSetsLiteTemplateForLogJob

Overview

Use this endpoint to lookup a Job Template, and return a simplified definition of any Control Sets that are linked to that Job Template. If any Control Sets are linked to the template, a JSON definition of the Control Set will be returned. This information can then be used when logging a new job via the LogJobFromJobTemplate API endpoint.

Note! This version of the Control Set lookup provides just the basic information required to set values for a control set. This method is useful to minimize the network volume of an API request by only sending the bare minimum information required to satisfy the requirements of updating a Control Set. In order to map the Control Set field information to the GUIDs for the field, you will need to refer to the design of the Control Set in the desktop edition of HelpMaster, and/or use the more comprehensive Web API endpoint /ControlSets/GetControlSetsForEntity

Input Parameters

p_intJobTemplatePKID

The PKID of a existing Job Template. See picture below.

Job Template PKIKD

Example

Look up and return any Control Sets that are linked to Job Template PKID = 19.

{19}

Returns the following:

[
  {
    "controlSetPKID": 14,
    "controls": [
      {
        "guid": "1a3c0fd3-3d3e-4ac3-a639-cbf932c162b4",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "3dd575d8-dc81-49ba-9606-95346f5efdec",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "3e5fb7b7-ca6c-4d5d-a375-638467744050",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "49841348-bc7a-480c-b712-50ad183fb358",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "57b0da71-40af-41a3-b5a1-1cbe01bc8ee0",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "6694511a-710e-452a-af02-9040c3fb3f80",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "779ac879-8a98-43be-b75b-40f59ca6b9ed",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "8b8b91b4-366b-4d3b-9e6a-6f47cc666d2b",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "bb8a5946-d4ab-4ec4-a432-9c3436838f61",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "d289cf14-9b28-48cb-8f9d-04c1162d7720",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "ded223ab-5261-4128-a2f5-7454dd42bf35",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "ed6c228c-4f28-45c2-aee7-c631ebd56697",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "fb4bd694-d490-4d22-9b5f-a263072da05b",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "fb4d853e-5987-4bbc-adbf-faccc70b366f",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      },
      {
        "guid": "fc453170-6667-4397-a519-864271aaa37b",
        "stringValue": null,
        "intValue": null,
        "decimalValue": null,
        "dateValue": null
      }
    ]
  }
]

See also