Custom Sets (Coming Soon)

You should have the API Key while retrieving or updating your data. Without these API keys, you cannot access your APIs.

Custom set object

Top level

{
  "id": "cd438fcb-3525-484c-ba83-858377d91948",
  "name": "Countries",
  "items_count": 3,
  "data": {},
  "teams_count": 1,
  "teams": [{}],
  "created_at": "2024-03-26T17:24:19.2014490Z",
  "created_by": {},
  "updated_at": "2024-03-26T17:26:58.6180210Z",
  "updated_by": {}
}

Key	Type	Description
id	String	A unique identifier for the custom set.
name	String	The name of the custom set.
items_count	Number	Count of custom set items associated with the custom set
data	Object	Custom set data Object (It contains the custom set items)
teams_count	Number	Count of teams which has access to this custom set
teams	Array	An array of team object(s) containing general information about the team that has access to this custom set.
created_at	String	The date and time the template was created in ISO 8601 date and time format.
created_by	Object	General information about the user who created the template.
updated_at	String	The date and time the template was last updated in ISO 8601 date and time format.
updated_by	Object	General information about the user who last updated the template.

Custom set data object

{
  "items_count": 3,
  "items": [{}]
}

Key	Type	Description
items_count	Number	Count of custom set items associated with the custom set
items	Array	An array of custom set item's object(s), which contains details of custom set items associated with that particular custom set

Item object (custom set item)

{
  "id": "0f0681c3-0090-49bc-afef-ef914032abd7",
  "item_name": "China",
  "score": -1,
  "color": "#e01e53",
  "is_flagged": true
}

Key	Description
id	A unique identifier for the custom set item.
item_name	Value of the custom set item (which will be displayed in UI)
score	The score for the custom set item (when a custom set item is selected while performing an inspection, if the item has a score then that question will be scored using this value).
color	The color for the custom set item (this is used for visual representation while performing an inspection, if the item has a color set then when the user selects that item it will be displayed on UI).
is_flagged	To determine if the custom set item is flagged or not.

Note: To know more about what scoring, flagging, and color coding feature is visit this link - scoring-flagging-and-color-coding.