REST API v1.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Authentication
API Key (Auth Token)
- Parameter Name: AuthToken, in: cookie. Auth Token
API Key (Bearer)
- Parameter Name: Authorization, in: header. Auth Token (also header:"Impersonate" can be used with user id)
API Key (Tenant)
- Parameter Name: Tenant, in: header. Name of tenant
RestApi
Get information from specific template
Code samples
# You can also use wget
curl -X GET /app/templates/templates/{id} \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/templates/templates/{id} HTTP/1.1
Accept: application/json
api-version: string
const headers = {
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/templates/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/app/templates/templates/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "/app/templates/templates/{id}";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/templates/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /app/templates/templates/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string(uuid) | true | Template ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
{
"status": 0,
"approved": true,
"locations": [
"ccbaa575-7fe2-470d-8045-b58a98658a24"
],
"permissions": [
{
"possibility": 121,
"positions": [
{
"position": "73dd2558-98b1-4b3a-88e8-2d6257df360b",
"activeOnly": true
}
],
"positionTeams": null
}
],
"onlyStartByApi": false,
"refId": "Ref.Id",
"shortDescription": "Description text",
"customCompleteMessage": null,
"everybodyCanFinishChecklist": false,
"checklistCanBeAssigned": true,
"webhooks": [
{
"location": null,
"action": "Task_Comment",
"url": "http://webhook.host/path",
"description": "Comment webhook"
}
],
"publishToMessagebus": false,
"singleUserTemplate": false,
"allowExternalUse": false,
"revisionUpdateTime": "2022-06-09T10:13:33.3279839Z",
"revisionUpdateTimeString": "2022-06-09T10:13:33.3279839Z",
"revision": 1,
"reoccurring": false,
"archiveChecklistsAfter": 1,
"archiveChecklistsAfterSpan": 0,
"locationTagging": false,
"preventQuickDiscard": false,
"imageUrl": null,
"preventFlowCreateByActiveRefId": null,
"discardReasons": null,
"commentTypes": null,
"id": "1e6d99eb-8b4d-4ed3-9380-7ae81afb3bec",
"name": "Template name",
"sectionTemplates": [
{
"name": "Section",
"color": "#DEEBFF",
"documentation": [],
"order": 0,
"webhooks": [
{
"location": null,
"action": "Task_Comment",
"url": "http://webhook.host/path",
"description": "Comment webhook"
}
],
"templateId": "1e6d99eb-8b4d-4ed3-9380-7ae81afb3bec",
"metadata": null,
"id": "482f362b-27a9-41e8-b252-4cf6e5c6a332",
"taskTemplates": [
{
"id": "a5880621-d0a0-49e8-b226-9295fa131285",
"reminderHours": null,
"reminderMinutes": null,
"reminderTimeString": null,
"templateId": "1e6d99eb-8b4d-4ed3-9380-7ae81afb3bec",
"name": "Task 1",
"documentation": [],
"order": 0,
"sectionId": "482f362b-27a9-41e8-b252-4cf6e5c6a332",
"control": {
"values": null,
"valueTitle": null,
"min": null,
"max": null,
"preventValueInThePast": false,
"scanOption": null,
"listControl": null,
"fileControl": null,
"numberControl": null,
"phoneNumberControl": null,
"dataRegisterControl": null,
"systemListsControl": null,
"text": null,
"dataId": null,
"type": 0,
"shouldConfirm": null
},
"control2": null,
"secondaryTitle": "Task info",
"tags": "tag2",
"analyticTags": "tag1",
"webhooks": [
{
"location": null,
"action": "Task_Comment",
"url": "http://webhook.host/path",
"description": "Comment webhook"
}
],
"transferValueOnConsecutiveChecklist": false,
"preventQuickInput": false,
"metadata": [
{
"name": "Title",
"value": "Value"
}
],
"assignedPosition": null,
"sensitiveData": false,
"setContentByAPI": false,
"isReadonly": false,
"discardReasons": null,
"commentTypes": null
},
{
"id": "9c4824e7-6235-4f2f-a042-dbb53126a1b9",
"reminderHours": null,
"reminderMinutes": null,
"reminderTimeString": null,
"templateId": "1e6d99eb-8b4d-4ed3-9380-7ae81afb3bec",
"name": "Task 2",
"documentation": [
{
"externalItemId": null,
"sourceName": "Internal",
"order": 0,
"title": "Information",
"value": "Description text",
"relativeExternalItemUrl": null,
"message": null
}
],
"order": 1,
"sectionId": "482f362b-27a9-41e8-b252-4cf6e5c6a332",
"control": {
"values": "",
"valueTitle": null,
"min": null,
"max": null,
"preventValueInThePast": false,
"scanOption": null,
"listControl": null,
"fileControl": null,
"numberControl": null,
"phoneNumberControl": null,
"dataRegisterControl": null,
"systemListsControl": null,
"text": null,
"dataId": null,
"type": 6,
"shouldConfirm": null
},
"control2": {
"values": null,
"valueTitle": null,
"min": null,
"max": null,
"preventValueInThePast": false,
"scanOption": null,
"listControl": null,
"fileControl": null,
"numberControl": null,
"phoneNumberControl": null,
"dataRegisterControl": null,
"systemListsControl": null,
"text": null,
"dataId": null,
"type": 5,
"shouldConfirm": null
},
"secondaryTitle": "Task info",
"tags": "tag2",
"analyticTags": "tag3",
"webhooks": null,
"transferValueOnConsecutiveChecklist": false,
"preventQuickInput": false,
"metadata": null,
"assignedPosition": null,
"sensitiveData": false,
"setContentByAPI": false,
"isReadonly": false,
"discardReasons": null,
"commentTypes": null
}
]
}
],
"rules": {
"hiddenByDefault": [
"9c4824e7-6235-4f2f-a042-dbb53126a1b9"
],
"rules": [
{
"condition": "is not empty",
"effect": "show",
"effectedItems": [
"9c4824e7-6235-4f2f-a042-dbb53126a1b9"
],
"formField": "a5880621-d0a0-49e8-b226-9295fa131285",
"values": null
}
]
},
"metadata": [
{
"displayAsSubHeading": false,
"type": 1,
"fillOnlyByAPI": false,
"id": "fc7e7ab2-04c5-4b98-8449-6dba7f41bcd0",
"dataRegister": null,
"name": "Title",
"value": null
}
],
"categoryId": null
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ChecklistTemplateInfo |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Get information from specific template by refID
Code samples
# You can also use wget
curl -X GET /app/templates/templates/{refId} \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/templates/templates/{refId} HTTP/1.1
Accept: application/json
api-version: string
const headers = {
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/templates/{refId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/app/templates/templates/{refId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "/app/templates/templates/{refId}";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/templates/{refId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /app/templates/templates/{refId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| refId | path | string | true | refID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
{
"status": 0,
"approved": true,
"locations": [
"ccbaa575-7fe2-470d-8045-b58a98658a24"
],
"permissions": [
{
"possibility": 121,
"positions": [
{
"position": "73dd2558-98b1-4b3a-88e8-2d6257df360b",
"activeOnly": true
}
],
"positionTeams": null
}
],
"onlyStartByApi": false,
"refId": "Ref.Id",
"shortDescription": "Description text",
"customCompleteMessage": null,
"everybodyCanFinishChecklist": false,
"checklistCanBeAssigned": true,
"webhooks": [
{
"location": null,
"action": "Task_Comment",
"url": "http://webhook.host/path",
"description": "Comment webhook"
}
],
"publishToMessagebus": false,
"singleUserTemplate": false,
"allowExternalUse": false,
"revisionUpdateTime": "2022-06-09T10:13:33.3331224Z",
"revisionUpdateTimeString": "2022-06-09T10:13:33.3331224Z",
"revision": 1,
"reoccurring": false,
"archiveChecklistsAfter": 1,
"archiveChecklistsAfterSpan": 0,
"locationTagging": false,
"preventQuickDiscard": false,
"imageUrl": null,
"preventFlowCreateByActiveRefId": null,
"discardReasons": null,
"commentTypes": null,
"id": "1e6d99eb-8b4d-4ed3-9380-7ae81afb3bec",
"name": "Template name",
"sectionTemplates": [
{
"name": "Section",
"color": "#DEEBFF",
"documentation": [],
"order": 0,
"webhooks": [
{
"location": null,
"action": "Task_Comment",
"url": "http://webhook.host/path",
"description": "Comment webhook"
}
],
"templateId": "1e6d99eb-8b4d-4ed3-9380-7ae81afb3bec",
"metadata": null,
"id": "482f362b-27a9-41e8-b252-4cf6e5c6a332",
"taskTemplates": [
{
"id": "a5880621-d0a0-49e8-b226-9295fa131285",
"reminderHours": null,
"reminderMinutes": null,
"reminderTimeString": null,
"templateId": "1e6d99eb-8b4d-4ed3-9380-7ae81afb3bec",
"name": "Task 1",
"documentation": [],
"order": 0,
"sectionId": "482f362b-27a9-41e8-b252-4cf6e5c6a332",
"control": {
"values": null,
"valueTitle": null,
"min": null,
"max": null,
"preventValueInThePast": false,
"scanOption": null,
"listControl": null,
"fileControl": null,
"numberControl": null,
"phoneNumberControl": null,
"dataRegisterControl": null,
"systemListsControl": null,
"text": null,
"dataId": null,
"type": 0,
"shouldConfirm": null
},
"control2": null,
"secondaryTitle": "Task info",
"tags": "tag2",
"analyticTags": "tag1",
"webhooks": [
{
"location": null,
"action": "Task_Comment",
"url": "http://webhook.host/path",
"description": "Comment webhook"
}
],
"transferValueOnConsecutiveChecklist": false,
"preventQuickInput": false,
"metadata": [
{
"name": "Title",
"value": "Value"
}
],
"assignedPosition": null,
"sensitiveData": false,
"setContentByAPI": false,
"isReadonly": false,
"discardReasons": null,
"commentTypes": null
},
{
"id": "9c4824e7-6235-4f2f-a042-dbb53126a1b9",
"reminderHours": null,
"reminderMinutes": null,
"reminderTimeString": null,
"templateId": "1e6d99eb-8b4d-4ed3-9380-7ae81afb3bec",
"name": "Task 2",
"documentation": [
{
"externalItemId": null,
"sourceName": "Internal",
"order": 0,
"title": "Information",
"value": "Description text",
"relativeExternalItemUrl": null,
"message": null
}
],
"order": 1,
"sectionId": "482f362b-27a9-41e8-b252-4cf6e5c6a332",
"control": {
"values": "",
"valueTitle": null,
"min": null,
"max": null,
"preventValueInThePast": false,
"scanOption": null,
"listControl": null,
"fileControl": null,
"numberControl": null,
"phoneNumberControl": null,
"dataRegisterControl": null,
"systemListsControl": null,
"text": null,
"dataId": null,
"type": 6,
"shouldConfirm": null
},
"control2": {
"values": null,
"valueTitle": null,
"min": null,
"max": null,
"preventValueInThePast": false,
"scanOption": null,
"listControl": null,
"fileControl": null,
"numberControl": null,
"phoneNumberControl": null,
"dataRegisterControl": null,
"systemListsControl": null,
"text": null,
"dataId": null,
"type": 5,
"shouldConfirm": null
},
"secondaryTitle": "Task info",
"tags": "tag2",
"analyticTags": "tag3",
"webhooks": null,
"transferValueOnConsecutiveChecklist": false,
"preventQuickInput": false,
"metadata": null,
"assignedPosition": null,
"sensitiveData": false,
"setContentByAPI": false,
"isReadonly": false,
"discardReasons": null,
"commentTypes": null
}
]
}
],
"rules": {
"hiddenByDefault": [
"9c4824e7-6235-4f2f-a042-dbb53126a1b9"
],
"rules": [
{
"condition": "is not empty",
"effect": "show",
"effectedItems": [
"9c4824e7-6235-4f2f-a042-dbb53126a1b9"
],
"formField": "a5880621-d0a0-49e8-b226-9295fa131285",
"values": null
}
]
},
"metadata": [
{
"displayAsSubHeading": false,
"type": 1,
"fillOnlyByAPI": false,
"id": "fc7e7ab2-04c5-4b98-8449-6dba7f41bcd0",
"dataRegister": null,
"name": "Title",
"value": null
}
],
"categoryId": null
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ChecklistTemplateInfo |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Get information from all templates
Code samples
# You can also use wget
curl -X GET /app/templates/templates \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/templates/templates HTTP/1.1
Accept: application/json
api-version: string
const headers = {
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/templates',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/app/templates/templates', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "/app/templates/templates";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/templates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /app/templates/templates
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ActiveAndDraft | query | boolean | false | none |
| Deactivated | query | boolean | false | none |
| Archived | query | boolean | false | none |
| SearchString | query | string | false | none |
| SearchInTitle | query | boolean | false | none |
| SearchInRefId | query | boolean | false | none |
| SearchInMetadataTitle | query | boolean | false | none |
| SearchInMetadataValue | query | boolean | false | none |
| Location | query | string(uuid) | false | none |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"refId": "string",
"locations": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0"
}
]
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ChecklistTemplateShortInfo] | false | none | none |
| » id | string(uuid) | false | none | none |
| » name | string¦null | false | none | none |
| » refId | string¦null | false | none | none |
| » locations | [string]¦null | false | none | none |
| » categoryId | string(uuid)¦null | false | none | none |
Creates a new information to a template
Code samples
# You can also use wget
curl -X POST /app/templates/templates \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
POST /app/templates/templates HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sectionTemplates": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"taskTemplates": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reminderHours": 0,
"reminderMinutes": 0,
"reminderTime": "2019-08-24T14:15:22Z",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"name": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"sectionId": "e886b9ca-b5a6-42e4-892d-0b160851d7c9",
"control": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": []
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"control2": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": []
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"transferValueOnConsecutiveChecklist": true,
"preventQuickInput": true,
"metadata": [
{
"name": "string",
"value": "string"
}
],
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": true,
"setContentByAPI": true,
"isReadonly": true,
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
]
}
],
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"metadata": [
{
"name": "string",
"value": "string"
}
]
}
],
"rules": {
"hiddenByDefault": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"rules": [
{
"condition": "string",
"effect": "string",
"effectedItems": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"formField": "4e3bb2fb-00c6-4221-bc83-18e6bbf178c3",
"values": [
"string"
]
}
]
},
"metadata": [
{
"name": "string",
"value": "string",
"displayAsSubHeading": true,
"type": 0,
"fillOnlyByAPI": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dataRegister": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
}
}
],
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"refId": "string",
"shortDescription": "string",
"customCompleteMessage": "string",
"everybodyCanFinishChecklist": true,
"checklistCanBeAssigned": true,
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"publishToMessagebus": true,
"singleUserTemplate": true,
"allowExternalUse": true,
"revisionUpdateTime": "2019-08-24T14:15:22Z",
"revision": 0,
"reoccurring": true,
"archiveChecklistsAfter": 0,
"archiveChecklistsAfterSpan": 0,
"locationTagging": true,
"preventQuickDiscard": true,
"imageUrl": "string",
"preventFlowCreateByActiveRefId": "string",
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
],
"locations": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"permissions": [
{
"possibility": 0,
"positions": [
{
"position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
"activeOnly": true
}
],
"positionTeams": [
{
"positionTeam": "f96affed-abdc-43fd-a04b-102913c886c8",
"activeOnly": true
}
]
}
],
"onlyStartByApi": true,
"overrideExisting": true
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/templates',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json-patch+json',
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/app/templates/templates', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "/app/templates/templates";
string json = @"{
""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
""name"": ""string"",
""sectionTemplates"": [
{
""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
""taskTemplates"": [
{
""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
""reminderHours"": 0,
""reminderMinutes"": 0,
""reminderTime"": ""2019-08-24T14:15:22Z"",
""templateId"": ""196100ac-4eec-4fb6-a7f7-86c8b584771d"",
""name"": ""string"",
""documentation"": [
{
""externalItemId"": ""0e1fce12-4246-4901-adef-a4db111e0a19"",
""sourceName"": ""string"",
""order"": 0,
""title"": ""string"",
""value"": ""string"",
""relativeExternalItemUrl"": ""string"",
""message"": ""string""
}
],
""order"": 0,
""sectionId"": ""e886b9ca-b5a6-42e4-892d-0b160851d7c9"",
""control"": {
""type"": 0,
""shouldConfirm"": true,
""values"": ""string"",
""valueTitle"": ""string"",
""min"": 0,
""max"": 0,
""preventValueInThePast"": true,
""scanOption"": 0,
""listControl"": {
""submitText"": ""string"",
""formTitle"": ""string"",
""inputs"": [
{
""title"": ""string"",
""type"": 0,
""values"": ""string"",
""displayInList"": true,
""dataRegisterControl"": {
""type"": 0,
""listId"": ""string"",
""listKey"": ""string"",
""filtersTemplateId"": ""e7fcc60b-a6a3-45d6-900b-e68c0911e0d4"",
""filters"": []
},
""scanOption"": 0,
""isRequired"": true,
""dataId"": ""string""
}
],
""requireDescription"": true,
""completeValues"": ""string""
},
""fileControl"": {
""type"": 0,
""multiple"": true
},
""numberControl"": {
""allowDecimals"": true,
""textBefore"": ""string"",
""textAfter"": ""string""
},
""phoneNumberControl"": {
""callingCode"": ""string""
},
""dataRegisterControl"": {
""type"": 0,
""listId"": ""string"",
""listKey"": ""string"",
""filtersTemplateId"": ""e7fcc60b-a6a3-45d6-900b-e68c0911e0d4"",
""filters"": [
{
""keyword"": 0,
""condition"": 0,
""property"": ""string"",
""value"": ""string""
}
]
},
""systemListsControl"": {
""type"": 0,
""list"": 0,
""allLocations"": true
},
""text"": ""string"",
""dataId"": ""string""
},
""control2"": {
""type"": 0,
""shouldConfirm"": true,
""values"": ""string"",
""valueTitle"": ""string"",
""min"": 0,
""max"": 0,
""preventValueInThePast"": true,
""scanOption"": 0,
""listControl"": {
""submitText"": ""string"",
""formTitle"": ""string"",
""inputs"": [
{
""title"": ""string"",
""type"": 0,
""values"": ""string"",
""displayInList"": true,
""dataRegisterControl"": {
""type"": 0,
""listId"": ""string"",
""listKey"": ""string"",
""filtersTemplateId"": ""e7fcc60b-a6a3-45d6-900b-e68c0911e0d4"",
""filters"": []
},
""scanOption"": 0,
""isRequired"": true,
""dataId"": ""string""
}
],
""requireDescription"": true,
""completeValues"": ""string""
},
""fileControl"": {
""type"": 0,
""multiple"": true
},
""numberControl"": {
""allowDecimals"": true,
""textBefore"": ""string"",
""textAfter"": ""string""
},
""phoneNumberControl"": {
""callingCode"": ""string""
},
""dataRegisterControl"": {
""type"": 0,
""listId"": ""string"",
""listKey"": ""string"",
""filtersTemplateId"": ""e7fcc60b-a6a3-45d6-900b-e68c0911e0d4"",
""filters"": [
{
""keyword"": 0,
""condition"": 0,
""property"": ""string"",
""value"": ""string""
}
]
},
""systemListsControl"": {
""type"": 0,
""list"": 0,
""allLocations"": true
},
""text"": ""string"",
""dataId"": ""string""
},
""secondaryTitle"": ""string"",
""tags"": ""string"",
""analyticTags"": ""string"",
""webhooks"": [
{
""location"": ""15f20760-76a7-41ee-b509-705d3ffd8eb5"",
""action"": 0,
""url"": ""string"",
""description"": ""string""
}
],
""transferValueOnConsecutiveChecklist"": true,
""preventQuickInput"": true,
""metadata"": [
{
""name"": ""string"",
""value"": ""string""
}
],
""assignedPosition"": ""0e023770-feda-40e2-8177-601401251112"",
""sensitiveData"": true,
""setContentByAPI"": true,
""isReadonly"": true,
""discardReasons"": [
{
""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
""name"": ""string"",
""requireComment"": true,
""default"": true
}
],
""commentTypes"": [
{
""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
""name"": ""string"",
""requireComment"": true
}
]
}
],
""name"": ""string"",
""color"": ""string"",
""documentation"": [
{
""externalItemId"": ""0e1fce12-4246-4901-adef-a4db111e0a19"",
""sourceName"": ""string"",
""order"": 0,
""title"": ""string"",
""value"": ""string"",
""relativeExternalItemUrl"": ""string"",
""message"": ""string""
}
],
""order"": 0,
""webhooks"": [
{
""location"": ""15f20760-76a7-41ee-b509-705d3ffd8eb5"",
""action"": 0,
""url"": ""string"",
""description"": ""string""
}
],
""templateId"": ""196100ac-4eec-4fb6-a7f7-86c8b584771d"",
""metadata"": [
{
""name"": ""string"",
""value"": ""string""
}
]
}
],
""rules"": {
""hiddenByDefault"": [
""497f6eca-6276-4993-bfeb-53cbbbba6f08""
],
""rules"": [
{
""condition"": ""string"",
""effect"": ""string"",
""effectedItems"": [
""497f6eca-6276-4993-bfeb-53cbbbba6f08""
],
""formField"": ""4e3bb2fb-00c6-4221-bc83-18e6bbf178c3"",
""values"": [
""string""
]
}
]
},
""metadata"": [
{
""name"": ""string"",
""value"": ""string"",
""displayAsSubHeading"": true,
""type"": 0,
""fillOnlyByAPI"": true,
""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
""dataRegister"": {
""type"": 0,
""listId"": ""string"",
""listKey"": ""string"",
""filtersTemplateId"": ""e7fcc60b-a6a3-45d6-900b-e68c0911e0d4"",
""filters"": [
{
""keyword"": 0,
""condition"": 0,
""property"": ""string"",
""value"": ""string""
}
]
}
}
],
""categoryId"": ""337f5e5d-288b-40d5-be14-901cc3acacc0"",
""refId"": ""string"",
""shortDescription"": ""string"",
""customCompleteMessage"": ""string"",
""everybodyCanFinishChecklist"": true,
""checklistCanBeAssigned"": true,
""webhooks"": [
{
""location"": ""15f20760-76a7-41ee-b509-705d3ffd8eb5"",
""action"": 0,
""url"": ""string"",
""description"": ""string""
}
],
""publishToMessagebus"": true,
""singleUserTemplate"": true,
""allowExternalUse"": true,
""revisionUpdateTime"": ""2019-08-24T14:15:22Z"",
""revision"": 0,
""reoccurring"": true,
""archiveChecklistsAfter"": 0,
""archiveChecklistsAfterSpan"": 0,
""locationTagging"": true,
""preventQuickDiscard"": true,
""imageUrl"": ""string"",
""preventFlowCreateByActiveRefId"": ""string"",
""discardReasons"": [
{
""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
""name"": ""string"",
""requireComment"": true,
""default"": true
}
],
""commentTypes"": [
{
""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
""name"": ""string"",
""requireComment"": true
}
],
""locations"": [
""497f6eca-6276-4993-bfeb-53cbbbba6f08""
],
""permissions"": [
{
""possibility"": 0,
""positions"": [
{
""position"": ""0e5919e5-e53d-46dc-8c08-74a8a4a272c7"",
""activeOnly"": true
}
],
""positionTeams"": [
{
""positionTeam"": ""f96affed-abdc-43fd-a04b-102913c886c8"",
""activeOnly"": true
}
]
}
],
""onlyStartByApi"": true,
""overrideExisting"": true
}";
NewTemplateApiModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(NewTemplateApiModel content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(NewTemplateApiModel content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/templates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /app/templates/templates
Body parameter
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sectionTemplates": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"taskTemplates": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reminderHours": 0,
"reminderMinutes": 0,
"reminderTime": "2019-08-24T14:15:22Z",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"name": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"sectionId": "e886b9ca-b5a6-42e4-892d-0b160851d7c9",
"control": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": []
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"control2": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": []
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"transferValueOnConsecutiveChecklist": true,
"preventQuickInput": true,
"metadata": [
{
"name": "string",
"value": "string"
}
],
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": true,
"setContentByAPI": true,
"isReadonly": true,
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
]
}
],
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"metadata": [
{
"name": "string",
"value": "string"
}
]
}
],
"rules": {
"hiddenByDefault": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"rules": [
{
"condition": "string",
"effect": "string",
"effectedItems": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"formField": "4e3bb2fb-00c6-4221-bc83-18e6bbf178c3",
"values": [
"string"
]
}
]
},
"metadata": [
{
"name": "string",
"value": "string",
"displayAsSubHeading": true,
"type": 0,
"fillOnlyByAPI": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dataRegister": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
}
}
],
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"refId": "string",
"shortDescription": "string",
"customCompleteMessage": "string",
"everybodyCanFinishChecklist": true,
"checklistCanBeAssigned": true,
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"publishToMessagebus": true,
"singleUserTemplate": true,
"allowExternalUse": true,
"revisionUpdateTime": "2019-08-24T14:15:22Z",
"revision": 0,
"reoccurring": true,
"archiveChecklistsAfter": 0,
"archiveChecklistsAfterSpan": 0,
"locationTagging": true,
"preventQuickDiscard": true,
"imageUrl": "string",
"preventFlowCreateByActiveRefId": "string",
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
],
"locations": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"permissions": [
{
"possibility": 0,
"positions": [
{
"position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
"activeOnly": true
}
],
"positionTeams": [
{
"positionTeam": "f96affed-abdc-43fd-a04b-102913c886c8",
"activeOnly": true
}
]
}
],
"onlyStartByApi": true,
"overrideExisting": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | NewTemplateApiModel | true | none |
Example responses
200 Response
{
"id": "4a4f0a30-9ac5-4729-a192-a019aa638084"
}
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
409 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | IdApiModel |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 409 | Conflict | Conflict | ApiMessage |
Update metadata for specific template
Code samples
# You can also use wget
curl -X PUT /app/templates/templates/{templateId}/tasks/metadata \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
PUT /app/templates/templates/{templateId}/tasks/metadata HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"taskMetadata": [
{
"taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
"metadata": {
"property1": "string",
"property2": "string"
}
}
]
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/templates/{templateId}/tasks/metadata',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json-patch+json',
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/app/templates/templates/{templateId}/tasks/metadata', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePutRequest()
{
int id = 1;
string url = "/app/templates/templates/{templateId}/tasks/metadata";
string json = @"{
""taskMetadata"": [
{
""taskId"": ""e6e9d88a-9b63-468a-aec3-b7a11de27af8"",
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
}
}
]
}";
TemplateTaskMetadataApiModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, TemplateTaskMetadataApiModel content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute PUT request
HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
//Return response
return await DeserializeObject(response);
}
/// Serialize an object to Json
private StringContent SerializeObject(TemplateTaskMetadataApiModel content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/templates/{templateId}/tasks/metadata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /app/templates/templates/{templateId}/tasks/metadata
Body parameter
{
"taskMetadata": [
{
"taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
"metadata": {
"property1": "string",
"property2": "string"
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| templateId | path | string(uuid) | true | Template ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | TemplateTaskMetadataApiModel | true | TemplateTaskMetadataApiModel object |
Example responses
200 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Get status from a template
Code samples
# You can also use wget
curl -X PATCH /app/templates/templates/{id}/status \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
PATCH /app/templates/templates/{id}/status HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"status": 0,
"onlyIfStatus": 0,
"comment": null
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/templates/{id}/status',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json-patch+json',
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PATCH','/app/templates/templates/{id}/status', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/templates/{id}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PATCH /app/templates/templates/{id}/status
Body parameter
{
"status": 0,
"onlyIfStatus": 0,
"comment": null
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string(uuid) | true | none |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | ChangeTemplateStatusApiModel | true | none |
Example responses
200 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Echo
Code samples
# You can also use wget
curl -X GET /app/templates/echo \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/templates/echo HTTP/1.1
Accept: application/json
api-version: string
const headers = {
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/echo',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/app/templates/echo', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "/app/templates/echo";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/echo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /app/templates/echo
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Posting security key
Code samples
# You can also use wget
curl -X POST /app/templates/securityKeys \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
POST /app/templates/securityKeys HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"applicationName": "string",
"applicationPublicKey": "string",
"previousInputPublicKey": "string"
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/securityKeys',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json-patch+json',
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/app/templates/securityKeys', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "/app/templates/securityKeys";
string json = @"{
""applicationName"": ""string"",
""applicationPublicKey"": ""string"",
""previousInputPublicKey"": ""string""
}";
SecurityKeyApiModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(SecurityKeyApiModel content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(SecurityKeyApiModel content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/securityKeys");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /app/templates/securityKeys
Body parameter
{
"applicationName": "string",
"applicationPublicKey": "string",
"previousInputPublicKey": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | SecurityKeyApiModel | true | SecurityKeyApiModel object |
Example responses
200 Response
{
"applicationName": "Checklist",
"inputPublicKey": "859f96e3fd12b0bbdf9470b0820d89265824cd95d8787edef4e8d780ef368104"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SecurityKey |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Update template thumbnail
Code samples
# You can also use wget
curl -X PUT /app/templates/templates/{id}/thumbnail \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
PUT /app/templates/templates/{id}/thumbnail HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"content": [
0
],
"base64Content": "string",
"urlContent": "string"
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/templates/{id}/thumbnail',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json-patch+json',
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/app/templates/templates/{id}/thumbnail', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePutRequest()
{
int id = 1;
string url = "/app/templates/templates/{id}/thumbnail";
string json = @"{
""content"": [
0
],
""base64Content"": ""string"",
""urlContent"": ""string""
}";
TemplateThumbnailApiModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, TemplateThumbnailApiModel content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute PUT request
HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
//Return response
return await DeserializeObject(response);
}
/// Serialize an object to Json
private StringContent SerializeObject(TemplateThumbnailApiModel content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/templates/{id}/thumbnail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /app/templates/templates/{id}/thumbnail
Body parameter
{
"content": [
0
],
"base64Content": "string",
"urlContent": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string(uuid) | true | ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | TemplateThumbnailApiModel | true | TemplateThumbnailApiModel object |
Example responses
200 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Get discard reasons
Code samples
# You can also use wget
curl -X GET /app/templates/discardReasons \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/templates/discardReasons HTTP/1.1
Accept: application/json
api-version: string
const headers = {
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/discardReasons',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/app/templates/discardReasons', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "/app/templates/discardReasons";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/discardReasons");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /app/templates/discardReasons
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
]
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [DiscardReason] | false | none | none |
| » id | string(uuid) | false | none | none |
| » name | string¦null | false | none | none |
| » requireComment | boolean | false | none | none |
| » default | boolean | false | none | none |
Update discard reasons
Code samples
# You can also use wget
curl -X POST /app/templates/discardReasons \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
POST /app/templates/discardReasons HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/discardReasons',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json-patch+json',
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/app/templates/discardReasons', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "/app/templates/discardReasons";
string json = @"{
""id"": ""497f6eca-6276-4993-bfeb-53cbbbba6f08"",
""name"": ""string"",
""requireComment"": true,
""default"": true
}";
DiscardReason content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(DiscardReason content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(DiscardReason content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/discardReasons");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /app/templates/discardReasons
Body parameter
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | DiscardReason | true | none |
Example responses
200 Response
{
"id": "4a4f0a30-9ac5-4729-a192-a019aa638084"
}
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | IdApiModel |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Delete specific discard reason
Code samples
# You can also use wget
curl -X DELETE /app/templates/discardReasons/{id} \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
DELETE /app/templates/discardReasons/{id} HTTP/1.1
Accept: application/json
api-version: string
const headers = {
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/discardReasons/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/app/templates/discardReasons/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeDeleteRequest()
{
int id = 1;
string url = "/app/templates/discardReasons/{id}";
await DeleteAsync(id, url);
}
/// Performs a DELETE Request
public async Task DeleteAsync(int id, string url)
{
//Execute DELETE request
HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
//Return response
await DeserializeObject(response);
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/discardReasons/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /app/templates/discardReasons/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string(uuid) | true | none |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Success | None |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Get comment types
Code samples
# You can also use wget
curl -X GET /app/templates/comments/types \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/templates/comments/types HTTP/1.1
Accept: application/json
api-version: string
const headers = {
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/comments/types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/app/templates/comments/types', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "/app/templates/comments/types";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/comments/types");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /app/templates/comments/types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
]
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CommentType] | false | none | none |
| » id | string(uuid) | false | none | none |
| » name | string¦null | false | none | none |
| » requireComment | boolean | false | none | none |
Update comment types
Code samples
# You can also use wget
curl -X POST /app/templates/comments/types \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
POST /app/templates/comments/types HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"name": "string",
"requireComment": true
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/comments/types',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json-patch+json',
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/app/templates/comments/types', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePostRequest()
{
string url = "/app/templates/comments/types";
string json = @"{
""name"": ""string"",
""requireComment"": true
}";
NewCommentTypeModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(NewCommentTypeModel content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute POST request
HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
}
/// Serialize an object to Json
private StringContent SerializeObject(NewCommentTypeModel content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/comments/types");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /app/templates/comments/types
Body parameter
{
"name": "string",
"requireComment": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | NewCommentTypeModel | true | none |
Example responses
200 Response
{
"id": "4a4f0a30-9ac5-4729-a192-a019aa638084"
}
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | IdApiModel |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Update specific comment type
Code samples
# You can also use wget
curl -X PUT /app/templates/comments/types/{id} \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
PUT /app/templates/comments/types/{id} HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"name": "string",
"requireComment": true
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/comments/types/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json-patch+json',
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/app/templates/comments/types/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakePutRequest()
{
int id = 1;
string url = "/app/templates/comments/types/{id}";
string json = @"{
""name"": ""string"",
""requireComment"": true
}";
CommentTypeModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, CommentTypeModel content, string url)
{
//Serialize Object
StringContent jsonContent = SerializeObject(content);
//Execute PUT request
HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
//Return response
return await DeserializeObject(response);
}
/// Serialize an object to Json
private StringContent SerializeObject(CommentTypeModel content)
{
//Serialize Object
string jsonObject = JsonConvert.SerializeObject(content);
//Create Json UTF8 String Content
return new StringContent(jsonObject, Encoding.UTF8, "application/json");
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/comments/types/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /app/templates/comments/types/{id}
Body parameter
{
"name": "string",
"requireComment": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string(uuid) | true | none |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | CommentTypeModel | true | none |
Example responses
200 Response
{
"id": "4a4f0a30-9ac5-4729-a192-a019aa638084"
}
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | IdApiModel |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Delete specific comment type
Code samples
# You can also use wget
curl -X DELETE /app/templates/comments/types/{id} \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
DELETE /app/templates/comments/types/{id} HTTP/1.1
Accept: application/json
api-version: string
const headers = {
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/templates/comments/types/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'api-version' => 'string',
'Tenant' => 'API_KEY',
'Authorization' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/app/templates/comments/types/{id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeDeleteRequest()
{
int id = 1;
string url = "/app/templates/comments/types/{id}";
await DeleteAsync(id, url);
}
/// Performs a DELETE Request
public async Task DeleteAsync(int id, string url)
{
//Execute DELETE request
HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
//Return response
await DeserializeObject(response);
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("/app/templates/comments/types/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /app/templates/comments/types/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string(uuid) | true | none |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Success | None |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Schemas
ApiMessage
{
"message": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| message | string¦null | false | none | none |
ChangeTemplateStatusApiModel
{
"status": 0,
"onlyIfStatus": 0,
"comment": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| status | ChecklistTemplateStatus | true | none | Active = 0 Archived = 1 Draft = 2 Deactivated = 8 |
| onlyIfStatus | ChecklistTemplateStatus | false | none | Active = 0 Archived = 1 Draft = 2 Deactivated = 8 |
| comment | string¦null | false | none | none |
ChecklistTemplateInfo
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sectionTemplates": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"taskTemplates": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reminderHours": 0,
"reminderMinutes": 0,
"reminderTime": "2019-08-24T14:15:22Z",
"reminderTimeString": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"name": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"sectionId": "e886b9ca-b5a6-42e4-892d-0b160851d7c9",
"control": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": []
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"control2": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": []
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"transferValueOnConsecutiveChecklist": true,
"preventQuickInput": true,
"metadata": [
{
"name": "string",
"value": "string"
}
],
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": true,
"setContentByAPI": true,
"isReadonly": true,
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
]
}
],
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"metadata": [
{
"name": "string",
"value": "string"
}
]
}
],
"rules": {
"hiddenByDefault": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"rules": [
{
"condition": "string",
"effect": "string",
"effectedItems": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"formField": "4e3bb2fb-00c6-4221-bc83-18e6bbf178c3",
"values": [
"string"
]
}
]
},
"metadata": [
{
"name": "string",
"value": "string",
"displayAsSubHeading": true,
"type": 0,
"fillOnlyByAPI": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dataRegister": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
}
}
],
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"refId": "string",
"shortDescription": "string",
"customCompleteMessage": "string",
"everybodyCanFinishChecklist": true,
"checklistCanBeAssigned": true,
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"publishToMessagebus": true,
"singleUserTemplate": true,
"allowExternalUse": true,
"revisionUpdateTime": "2019-08-24T14:15:22Z",
"revisionUpdateTimeString": "string",
"revision": 0,
"reoccurring": true,
"archiveChecklistsAfter": 0,
"archiveChecklistsAfterSpan": 0,
"locationTagging": true,
"preventQuickDiscard": true,
"imageUrl": "string",
"preventFlowCreateByActiveRefId": "string",
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
],
"status": 0,
"approved": true,
"locations": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"permissions": [
{
"possibility": 0,
"positions": [
{
"position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
"activeOnly": true
}
],
"positionTeams": [
{
"positionTeam": "f96affed-abdc-43fd-a04b-102913c886c8",
"activeOnly": true
}
]
}
],
"onlyStartByApi": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| sectionTemplates | [SectionTemplate]¦null | false | none | none |
| rules | ChecklistTemplateRules | false | none | none |
| metadata | [TemplateMetadata]¦null | false | none | none |
| categoryId | string(uuid)¦null | false | none | none |
| refId | string¦null | false | none | none |
| shortDescription | string¦null | false | none | none |
| customCompleteMessage | string¦null | false | none | none |
| everybodyCanFinishChecklist | boolean | false | none | none |
| checklistCanBeAssigned | boolean | false | none | none |
| webhooks | [Webhook]¦null | false | none | none |
| publishToMessagebus | boolean | false | none | none |
| singleUserTemplate | boolean | false | none | none |
| allowExternalUse | boolean | false | none | none |
| revisionUpdateTime | string(date-time) | false | none | none |
| revisionUpdateTimeString | string¦null | false | read-only | none |
| revision | integer(int32) | false | none | none |
| reoccurring | boolean | false | none | none |
| archiveChecklistsAfter | integer(int32) | false | none | none |
| archiveChecklistsAfterSpan | TimeSpanType | false | none | Month = 0 Days = 1 |
| locationTagging | boolean | false | none | none |
| preventQuickDiscard | boolean | false | none | none |
| imageUrl | string¦null | false | none | none |
| preventFlowCreateByActiveRefId | string¦null | false | none | none |
| discardReasons | [DiscardReason]¦null | false | none | none |
| commentTypes | [CommentType]¦null | false | none | none |
| status | ChecklistTemplateStatus | false | none | Active = 0 Archived = 1 Draft = 2 Deactivated = 8 |
| approved | boolean | false | none | none |
| locations | [string]¦null | false | none | none |
| permissions | [ChecklistTemplatePermissions]¦null | false | none | none |
| onlyStartByApi | boolean | false | none | none |
ChecklistTemplatePermissionPosition
{
"position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
"activeOnly": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| position | string(uuid) | false | none | none |
| activeOnly | boolean | false | none | none |
ChecklistTemplatePermissionPositionTeam
{
"positionTeam": "f96affed-abdc-43fd-a04b-102913c886c8",
"activeOnly": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| positionTeam | string(uuid) | false | none | none |
| activeOnly | boolean | false | none | none |
ChecklistTemplatePermissions
{
"possibility": 0,
"positions": [
{
"position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
"activeOnly": true
}
],
"positionTeams": [
{
"positionTeam": "f96affed-abdc-43fd-a04b-102913c886c8",
"activeOnly": true
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| possibility | Possibility | false | none | UnlimitedPossibilities = 0 AllPossibilities = 1 ManagePermissions = 10 ManagePermissionGroups = 11 ManagePositions = 12 ManagePersons = 13 ManageOrganisations = 14 ManageLocations = 15 ManageCategories = 16 ManageThemes = 17 ManageApplicationLinks = 18 ReviewAudit = 19 ManageOptions = 20 ApiCalls = 80 Impersonate = 81 ImpersonateLocation = 82 ManageChecklistApplicationOptions = 100 ViewTemplates = 109 ManageTemplates = 110 ApproveTemplateRevisions = 111 TemplateLocationFilter = 112 UpdateChecklists = 120 FinishChecklists = 121 DiscardChecklists = 122 ViewArchivedChecklists = 123 ViewChecklists = 124 CommentChecklists = 125 CreateChecklists = 126 CreateExternalChecklists = 127 ManagePortalApplicationOptions = 200 DocumentationAdmin = 250 DocumentationEditor = 251 ManageTaskVerifiers = 252 VerifyTaskExternal = 253 DocumentationViewer = 254 DocumentationManager = 261 DocumentationVerifier = 262 ManageEquipmentCatalogue = 300 ViewEquipmentCatalogue = 310 ManageBarrier = 350 ViewBarrier = 360 DataRegisterCreate = 400 DataRegisterRead = 401 DataRegisterUpdate = 402 DataRegisterDelete = 403 ValidateAlerts = 450 ViewAlerts = 451 ShoreViewer = 500 ElsaAppAccess = 550 |
| positions | [ChecklistTemplatePermissionPosition]¦null | false | none | none |
| positionTeams | [ChecklistTemplatePermissionPositionTeam]¦null | false | none | none |
ChecklistTemplateRule
{
"condition": "string",
"effect": "string",
"effectedItems": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"formField": "4e3bb2fb-00c6-4221-bc83-18e6bbf178c3",
"values": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| condition | string¦null | false | none | none |
| effect | string¦null | false | none | none |
| effectedItems | [string]¦null | false | none | none |
| formField | string(uuid) | false | none | none |
| values | [string]¦null | false | none | none |
ChecklistTemplateRules
{
"hiddenByDefault": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"rules": [
{
"condition": "string",
"effect": "string",
"effectedItems": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"formField": "4e3bb2fb-00c6-4221-bc83-18e6bbf178c3",
"values": [
"string"
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hiddenByDefault | [string]¦null | false | none | none |
| rules | [ChecklistTemplateRule]¦null | false | none | none |
ChecklistTemplateShortInfo
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"refId": "string",
"locations": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| refId | string¦null | false | none | none |
| locations | [string]¦null | false | none | none |
| categoryId | string(uuid)¦null | false | none | none |
ChecklistTemplateStatus
0
Active = 0
Archived = 1
Draft = 2
Deactivated = 8
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Active = 0 Archived = 1 Draft = 2 Deactivated = 8 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
| anonymous | 8 |
CommentType
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| requireComment | boolean | false | none | none |
CommentTypeModel
{
"name": "string",
"requireComment": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| requireComment | boolean | false | none | none |
DataRegisterControl
{
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | TaskType | false | none | Text = 0 Number = 1 Dropdown = 2 Date = 3 DateAndTime = 4 Time = 5 Checkbox = 6 RadioButtons = 7 LongText = 8 PersonsOnBoard = 9 List = 10 Picture = 11 Information = 12 GPS = 13 ScanLabel = 14 RichText = 15 File = 16 DataRegister = 17 SystemLists = 18 Email = 19 Sign = 20 PhoneNumber = 21 |
| listId | string¦null | false | none | none |
| listKey | string¦null | false | none | none |
| filtersTemplateId | string(uuid)¦null | false | none | none |
| filters | [DataRegisterFilter]¦null | false | none | none |
DataRegisterFilter
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| keyword | FilterKeyword | false | none | And = 0 Or = 1 |
| condition | FilterCondition | false | none | Equals = 0 NotEqual = 1 Contains = 10 More = 20 Less = 21 |
| property | string¦null | false | none | none |
| value | string¦null | false | none | none |
DiscardReason
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| requireComment | boolean | false | none | none |
| default | boolean | false | none | none |
DispatchAction
0
Flow_Create = 0
Flow_Start = 1
Flow_Complete = 2
Flow_Discard = 3
Flow_DueTimeMissed = 4
Flow_Update = 5
Section_Start = 10
Section_Comment = 11
Section_CommentComplete = 12
Section_Override = 13
Section_Complete = 14
Section_Clear = 15
Task_Update = 20
Task_Modify = 21
Task_Clear = 22
Task_Comment = 23
Task_CommentComplete = 24
Task_Override = 25
Task_Reminder = 26
Unknown = 100
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Flow_Create = 0 Flow_Start = 1 Flow_Complete = 2 Flow_Discard = 3 Flow_DueTimeMissed = 4 Flow_Update = 5 Section_Start = 10 Section_Comment = 11 Section_CommentComplete = 12 Section_Override = 13 Section_Complete = 14 Section_Clear = 15 Task_Update = 20 Task_Modify = 21 Task_Clear = 22 Task_Comment = 23 Task_CommentComplete = 24 Task_Override = 25 Task_Reminder = 26 Unknown = 100 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
| anonymous | 3 |
| anonymous | 4 |
| anonymous | 5 |
| anonymous | 10 |
| anonymous | 11 |
| anonymous | 12 |
| anonymous | 13 |
| anonymous | 14 |
| anonymous | 15 |
| anonymous | 20 |
| anonymous | 21 |
| anonymous | 22 |
| anonymous | 23 |
| anonymous | 24 |
| anonymous | 25 |
| anonymous | 26 |
| anonymous | 100 |
Documentation
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| externalItemId | string(uuid)¦null | false | none | none |
| sourceName | string¦null | false | none | none |
| order | integer(int32) | false | none | none |
| title | string¦null | false | none | none |
| value | string¦null | false | none | none |
| relativeExternalItemUrl | string¦null | false | none | none |
| message | string¦null | false | none | none |
FileControl
{
"type": 0,
"multiple": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | FileMimeType | false | none | Any = 0 Picture = 1 Video = 3 Document = 4 |
| multiple | boolean | false | none | none |
FileMimeType
0
Any = 0
Picture = 1
Video = 3
Document = 4
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Any = 0 Picture = 1 Video = 3 Document = 4 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 3 |
| anonymous | 4 |
FilterCondition
0
Equals = 0
NotEqual = 1
Contains = 10
More = 20
Less = 21
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Equals = 0 NotEqual = 1 Contains = 10 More = 20 Less = 21 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 10 |
| anonymous | 20 |
| anonymous | 21 |
FilterKeyword
0
And = 0
Or = 1
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | And = 0 Or = 1 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
IdApiModel
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | true | none | none |
ListControl
{
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| submitText | string¦null | false | none | none |
| formTitle | string¦null | false | none | none |
| inputs | [ListControlInput]¦null | false | none | none |
| requireDescription | boolean | false | none | none |
| completeValues | string¦null | false | none | none |
ListControlInput
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string¦null | false | none | none |
| type | TaskType | false | none | Text = 0 Number = 1 Dropdown = 2 Date = 3 DateAndTime = 4 Time = 5 Checkbox = 6 RadioButtons = 7 LongText = 8 PersonsOnBoard = 9 List = 10 Picture = 11 Information = 12 GPS = 13 ScanLabel = 14 RichText = 15 File = 16 DataRegister = 17 SystemLists = 18 Email = 19 Sign = 20 PhoneNumber = 21 |
| values | string¦null | false | none | none |
| displayInList | boolean | false | none | none |
| dataRegisterControl | DataRegisterControl | false | none | none |
| scanOption | ScanOption | false | none | NFC = 0 QR = 1 BarCode = 2 |
| isRequired | boolean | false | none | none |
| dataId | string¦null | false | none | none |
MetaDataType
0
Defined = 0
Text = 1
Number = 2
Dropdown = 3
Date = 4
DateAndTime = 5
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Defined = 0 Text = 1 Number = 2 Dropdown = 3 Date = 4 DateAndTime = 5 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
| anonymous | 3 |
| anonymous | 4 |
| anonymous | 5 |
NewCommentTypeModel
{
"name": "string",
"requireComment": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| requireComment | boolean | false | none | none |
NewTemplateApiModel
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sectionTemplates": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"taskTemplates": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reminderHours": 0,
"reminderMinutes": 0,
"reminderTime": "2019-08-24T14:15:22Z",
"reminderTimeString": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"name": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"sectionId": "e886b9ca-b5a6-42e4-892d-0b160851d7c9",
"control": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": []
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"control2": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": []
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"transferValueOnConsecutiveChecklist": true,
"preventQuickInput": true,
"metadata": [
{
"name": "string",
"value": "string"
}
],
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": true,
"setContentByAPI": true,
"isReadonly": true,
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
]
}
],
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"metadata": [
{
"name": "string",
"value": "string"
}
]
}
],
"rules": {
"hiddenByDefault": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"rules": [
{
"condition": "string",
"effect": "string",
"effectedItems": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"formField": "4e3bb2fb-00c6-4221-bc83-18e6bbf178c3",
"values": [
"string"
]
}
]
},
"metadata": [
{
"name": "string",
"value": "string",
"displayAsSubHeading": true,
"type": 0,
"fillOnlyByAPI": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dataRegister": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
}
}
],
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"refId": "string",
"shortDescription": "string",
"customCompleteMessage": "string",
"everybodyCanFinishChecklist": true,
"checklistCanBeAssigned": true,
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"publishToMessagebus": true,
"singleUserTemplate": true,
"allowExternalUse": true,
"revisionUpdateTime": "2019-08-24T14:15:22Z",
"revisionUpdateTimeString": "string",
"revision": 0,
"reoccurring": true,
"archiveChecklistsAfter": 0,
"archiveChecklistsAfterSpan": 0,
"locationTagging": true,
"preventQuickDiscard": true,
"imageUrl": "string",
"preventFlowCreateByActiveRefId": "string",
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
],
"locations": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"permissions": [
{
"possibility": 0,
"positions": [
{
"position": "0e5919e5-e53d-46dc-8c08-74a8a4a272c7",
"activeOnly": true
}
],
"positionTeams": [
{
"positionTeam": "f96affed-abdc-43fd-a04b-102913c886c8",
"activeOnly": true
}
]
}
],
"onlyStartByApi": true,
"overrideExisting": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid)¦null | false | none | none |
| name | string¦null | false | none | none |
| sectionTemplates | [SectionTemplate]¦null | false | none | none |
| rules | ChecklistTemplateRules | false | none | none |
| metadata | [TemplateMetadata]¦null | false | none | none |
| categoryId | string(uuid)¦null | false | none | none |
| refId | string¦null | false | none | none |
| shortDescription | string¦null | false | none | none |
| customCompleteMessage | string¦null | false | none | none |
| everybodyCanFinishChecklist | boolean | false | none | none |
| checklistCanBeAssigned | boolean | false | none | none |
| webhooks | [Webhook]¦null | false | none | none |
| publishToMessagebus | boolean | false | none | none |
| singleUserTemplate | boolean | false | none | none |
| allowExternalUse | boolean | false | none | none |
| revisionUpdateTime | string(date-time) | false | none | none |
| revisionUpdateTimeString | string¦null | false | read-only | none |
| revision | integer(int32) | false | none | none |
| reoccurring | boolean | false | none | none |
| archiveChecklistsAfter | integer(int32) | false | none | none |
| archiveChecklistsAfterSpan | TimeSpanType | false | none | Month = 0 Days = 1 |
| locationTagging | boolean | false | none | none |
| preventQuickDiscard | boolean | false | none | none |
| imageUrl | string¦null | false | none | none |
| preventFlowCreateByActiveRefId | string¦null | false | none | none |
| discardReasons | [DiscardReason]¦null | false | none | none |
| commentTypes | [CommentType]¦null | false | none | none |
| locations | [string]¦null | false | none | none |
| permissions | [ChecklistTemplatePermissions]¦null | false | none | none |
| onlyStartByApi | boolean | false | none | none |
| overrideExisting | boolean | false | none | none |
NumberControl
{
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| allowDecimals | boolean | false | none | none |
| textBefore | string¦null | false | none | none |
| textAfter | string¦null | false | none | none |
PhoneNumberControl
{
"callingCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| callingCode | string¦null | false | none | none |
Possibility
0
UnlimitedPossibilities = 0
AllPossibilities = 1
ManagePermissions = 10
ManagePermissionGroups = 11
ManagePositions = 12
ManagePersons = 13
ManageOrganisations = 14
ManageLocations = 15
ManageCategories = 16
ManageThemes = 17
ManageApplicationLinks = 18
ReviewAudit = 19
ManageOptions = 20
ApiCalls = 80
Impersonate = 81
ImpersonateLocation = 82
ManageChecklistApplicationOptions = 100
ViewTemplates = 109
ManageTemplates = 110
ApproveTemplateRevisions = 111
TemplateLocationFilter = 112
UpdateChecklists = 120
FinishChecklists = 121
DiscardChecklists = 122
ViewArchivedChecklists = 123
ViewChecklists = 124
CommentChecklists = 125
CreateChecklists = 126
CreateExternalChecklists = 127
ManagePortalApplicationOptions = 200
DocumentationAdmin = 250
DocumentationEditor = 251
ManageTaskVerifiers = 252
VerifyTaskExternal = 253
DocumentationViewer = 254
DocumentationManager = 261
DocumentationVerifier = 262
ManageEquipmentCatalogue = 300
ViewEquipmentCatalogue = 310
ManageBarrier = 350
ViewBarrier = 360
DataRegisterCreate = 400
DataRegisterRead = 401
DataRegisterUpdate = 402
DataRegisterDelete = 403
ValidateAlerts = 450
ViewAlerts = 451
ShoreViewer = 500
ElsaAppAccess = 550
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | UnlimitedPossibilities = 0 AllPossibilities = 1 ManagePermissions = 10 ManagePermissionGroups = 11 ManagePositions = 12 ManagePersons = 13 ManageOrganisations = 14 ManageLocations = 15 ManageCategories = 16 ManageThemes = 17 ManageApplicationLinks = 18 ReviewAudit = 19 ManageOptions = 20 ApiCalls = 80 Impersonate = 81 ImpersonateLocation = 82 ManageChecklistApplicationOptions = 100 ViewTemplates = 109 ManageTemplates = 110 ApproveTemplateRevisions = 111 TemplateLocationFilter = 112 UpdateChecklists = 120 FinishChecklists = 121 DiscardChecklists = 122 ViewArchivedChecklists = 123 ViewChecklists = 124 CommentChecklists = 125 CreateChecklists = 126 CreateExternalChecklists = 127 ManagePortalApplicationOptions = 200 DocumentationAdmin = 250 DocumentationEditor = 251 ManageTaskVerifiers = 252 VerifyTaskExternal = 253 DocumentationViewer = 254 DocumentationManager = 261 DocumentationVerifier = 262 ManageEquipmentCatalogue = 300 ViewEquipmentCatalogue = 310 ManageBarrier = 350 ViewBarrier = 360 DataRegisterCreate = 400 DataRegisterRead = 401 DataRegisterUpdate = 402 DataRegisterDelete = 403 ValidateAlerts = 450 ViewAlerts = 451 ShoreViewer = 500 ElsaAppAccess = 550 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 10 |
| anonymous | 11 |
| anonymous | 12 |
| anonymous | 13 |
| anonymous | 14 |
| anonymous | 15 |
| anonymous | 16 |
| anonymous | 17 |
| anonymous | 18 |
| anonymous | 19 |
| anonymous | 20 |
| anonymous | 80 |
| anonymous | 81 |
| anonymous | 82 |
| anonymous | 100 |
| anonymous | 109 |
| anonymous | 110 |
| anonymous | 111 |
| anonymous | 112 |
| anonymous | 120 |
| anonymous | 121 |
| anonymous | 122 |
| anonymous | 123 |
| anonymous | 124 |
| anonymous | 125 |
| anonymous | 126 |
| anonymous | 127 |
| anonymous | 200 |
| anonymous | 250 |
| anonymous | 251 |
| anonymous | 252 |
| anonymous | 253 |
| anonymous | 254 |
| anonymous | 261 |
| anonymous | 262 |
| anonymous | 300 |
| anonymous | 310 |
| anonymous | 350 |
| anonymous | 360 |
| anonymous | 400 |
| anonymous | 401 |
| anonymous | 402 |
| anonymous | 403 |
| anonymous | 450 |
| anonymous | 451 |
| anonymous | 500 |
| anonymous | 550 |
ScanOption
0
NFC = 0
QR = 1
BarCode = 2
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | NFC = 0 QR = 1 BarCode = 2 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
SectionTemplate
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"taskTemplates": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reminderHours": 0,
"reminderMinutes": 0,
"reminderTime": "2019-08-24T14:15:22Z",
"reminderTimeString": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"name": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"sectionId": "e886b9ca-b5a6-42e4-892d-0b160851d7c9",
"control": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"control2": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"transferValueOnConsecutiveChecklist": true,
"preventQuickInput": true,
"metadata": [
{
"name": "string",
"value": "string"
}
],
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": true,
"setContentByAPI": true,
"isReadonly": true,
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
]
}
],
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"metadata": [
{
"name": "string",
"value": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| taskTemplates | [TaskTemplate]¦null | false | none | none |
| name | string¦null | false | none | none |
| color | string¦null | false | none | none |
| documentation | [Documentation]¦null | false | none | none |
| order | integer(int32) | false | none | none |
| webhooks | [Webhook]¦null | false | none | none |
| templateId | string(uuid) | false | none | none |
| metadata | [TemplateMetadataShort]¦null | false | none | none |
SecurityKey
{
"applicationName": "string",
"outputPublicKey": "string",
"inputPublicKey": "string",
"inputPrivateKey": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| applicationName | string¦null | false | none | none |
| outputPublicKey | string¦null | false | none | none |
| inputPublicKey | string¦null | false | none | none |
| inputPrivateKey | string¦null | false | none | none |
SecurityKeyApiModel
{
"applicationName": "string",
"applicationPublicKey": "string",
"previousInputPublicKey": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| applicationName | string | true | none | none |
| applicationPublicKey | string¦null | false | none | none |
| previousInputPublicKey | string¦null | false | none | none |
SystemListsControl
{
"type": 0,
"list": 0,
"allLocations": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | TaskType | false | none | Text = 0 Number = 1 Dropdown = 2 Date = 3 DateAndTime = 4 Time = 5 Checkbox = 6 RadioButtons = 7 LongText = 8 PersonsOnBoard = 9 List = 10 Picture = 11 Information = 12 GPS = 13 ScanLabel = 14 RichText = 15 File = 16 DataRegister = 17 SystemLists = 18 Email = 19 Sign = 20 PhoneNumber = 21 |
| list | SystemListType | false | none | Persons = 0 Positions = 1 Locations = 2 |
| allLocations | boolean | false | none | none |
SystemListType
0
Persons = 0
Positions = 1
Locations = 2
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Persons = 0 Positions = 1 Locations = 2 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
TaskMetadataApiModel
{
"taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
"metadata": {
"property1": "string",
"property2": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskId | string(uuid) | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
TaskTemplate
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reminderHours": 0,
"reminderMinutes": 0,
"reminderTime": "2019-08-24T14:15:22Z",
"reminderTimeString": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"name": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"order": 0,
"sectionId": "e886b9ca-b5a6-42e4-892d-0b160851d7c9",
"control": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"control2": {
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
},
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"transferValueOnConsecutiveChecklist": true,
"preventQuickInput": true,
"metadata": [
{
"name": "string",
"value": "string"
}
],
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": true,
"setContentByAPI": true,
"isReadonly": true,
"discardReasons": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"requireComment": true
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| reminderHours | integer(int32)¦null | false | none | none |
| reminderMinutes | integer(int32)¦null | false | none | none |
| reminderTime | string(date-time)¦null | false | none | none |
| reminderTimeString | string¦null | false | read-only | none |
| templateId | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| documentation | [Documentation]¦null | false | none | none |
| order | integer(int32) | false | none | none |
| sectionId | string(uuid) | false | none | none |
| control | TaskTemplateControl | false | none | none |
| control2 | TaskTemplateControl | false | none | none |
| secondaryTitle | string¦null | false | none | none |
| tags | string¦null | false | none | none |
| analyticTags | string¦null | false | none | none |
| webhooks | [Webhook]¦null | false | none | none |
| transferValueOnConsecutiveChecklist | boolean | false | none | none |
| preventQuickInput | boolean | false | none | none |
| metadata | [TemplateMetadataShort]¦null | false | none | none |
| assignedPosition | string(uuid)¦null | false | none | none |
| sensitiveData | boolean | false | none | none |
| setContentByAPI | boolean | false | none | none |
| isReadonly | boolean | false | none | none |
| discardReasons | [DiscardReason]¦null | false | none | none |
| commentTypes | [CommentType]¦null | false | none | none |
TaskTemplateControl
{
"type": 0,
"shouldConfirm": true,
"values": "string",
"valueTitle": "string",
"min": 0,
"max": 0,
"preventValueInThePast": true,
"scanOption": 0,
"listControl": {
"submitText": "string",
"formTitle": "string",
"inputs": [
{
"title": "string",
"type": 0,
"values": "string",
"displayInList": true,
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"scanOption": 0,
"isRequired": true,
"dataId": "string"
}
],
"requireDescription": true,
"completeValues": "string"
},
"fileControl": {
"type": 0,
"multiple": true
},
"numberControl": {
"allowDecimals": true,
"textBefore": "string",
"textAfter": "string"
},
"phoneNumberControl": {
"callingCode": "string"
},
"dataRegisterControl": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
},
"systemListsControl": {
"type": 0,
"list": 0,
"allLocations": true
},
"text": "string",
"dataId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | TaskType | false | none | Text = 0 Number = 1 Dropdown = 2 Date = 3 DateAndTime = 4 Time = 5 Checkbox = 6 RadioButtons = 7 LongText = 8 PersonsOnBoard = 9 List = 10 Picture = 11 Information = 12 GPS = 13 ScanLabel = 14 RichText = 15 File = 16 DataRegister = 17 SystemLists = 18 Email = 19 Sign = 20 PhoneNumber = 21 |
| shouldConfirm | boolean¦null | false | none | none |
| values | string¦null | false | none | none |
| valueTitle | string¦null | false | none | none |
| min | number(double)¦null | false | none | none |
| max | number(double)¦null | false | none | none |
| preventValueInThePast | boolean | false | none | none |
| scanOption | ScanOption | false | none | NFC = 0 QR = 1 BarCode = 2 |
| listControl | ListControl | false | none | none |
| fileControl | FileControl | false | none | none |
| numberControl | NumberControl | false | none | none |
| phoneNumberControl | PhoneNumberControl | false | none | none |
| dataRegisterControl | DataRegisterControl | false | none | none |
| systemListsControl | SystemListsControl | false | none | none |
| text | string¦null | false | none | none |
| dataId | string¦null | false | none | none |
TaskType
0
Text = 0
Number = 1
Dropdown = 2
Date = 3
DateAndTime = 4
Time = 5
Checkbox = 6
RadioButtons = 7
LongText = 8
PersonsOnBoard = 9
List = 10
Picture = 11
Information = 12
GPS = 13
ScanLabel = 14
RichText = 15
File = 16
DataRegister = 17
SystemLists = 18
Email = 19
Sign = 20
PhoneNumber = 21
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Text = 0 Number = 1 Dropdown = 2 Date = 3 DateAndTime = 4 Time = 5 Checkbox = 6 RadioButtons = 7 LongText = 8 PersonsOnBoard = 9 List = 10 Picture = 11 Information = 12 GPS = 13 ScanLabel = 14 RichText = 15 File = 16 DataRegister = 17 SystemLists = 18 Email = 19 Sign = 20 PhoneNumber = 21 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
| anonymous | 3 |
| anonymous | 4 |
| anonymous | 5 |
| anonymous | 6 |
| anonymous | 7 |
| anonymous | 8 |
| anonymous | 9 |
| anonymous | 10 |
| anonymous | 11 |
| anonymous | 12 |
| anonymous | 13 |
| anonymous | 14 |
| anonymous | 15 |
| anonymous | 16 |
| anonymous | 17 |
| anonymous | 18 |
| anonymous | 19 |
| anonymous | 20 |
| anonymous | 21 |
TemplateMetadata
{
"name": "string",
"value": "string",
"displayAsSubHeading": true,
"type": 0,
"fillOnlyByAPI": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dataRegister": {
"type": 0,
"listId": "string",
"listKey": "string",
"filtersTemplateId": "e7fcc60b-a6a3-45d6-900b-e68c0911e0d4",
"filters": [
{
"keyword": 0,
"condition": 0,
"property": "string",
"value": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| value | string¦null | false | none | none |
| displayAsSubHeading | boolean | false | none | none |
| type | MetaDataType | false | none | Defined = 0 Text = 1 Number = 2 Dropdown = 3 Date = 4 DateAndTime = 5 |
| fillOnlyByAPI | boolean | false | none | none |
| id | string(uuid) | false | none | none |
| dataRegister | DataRegisterControl | false | none | none |
TemplateMetadataShort
{
"name": "string",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| value | string¦null | false | none | none |
TemplateTaskMetadataApiModel
{
"taskMetadata": [
{
"taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
"metadata": {
"property1": "string",
"property2": "string"
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskMetadata | [TaskMetadataApiModel]¦null | false | none | none |
TemplateThumbnailApiModel
{
"content": [
0
],
"base64Content": "string",
"urlContent": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| content | [integer]¦null | false | none | One of Content, Base64Content or UrlContent should be used |
| base64Content | string¦null | false | none | One of Content, Base64Content or UrlContent should be used |
| urlContent | string¦null | false | none | One of Content, Base64Content or UrlContent should be used |
TimeSpanType
0
Month = 0
Days = 1
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Month = 0 Days = 1 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
Webhook
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| location | string(uuid)¦null | false | none | none |
| action | DispatchAction | false | none | Flow_Create = 0 Flow_Start = 1 Flow_Complete = 2 Flow_Discard = 3 Flow_DueTimeMissed = 4 Flow_Update = 5 Section_Start = 10 Section_Comment = 11 Section_CommentComplete = 12 Section_Override = 13 Section_Complete = 14 Section_Clear = 15 Task_Update = 20 Task_Modify = 21 Task_Clear = 22 Task_Comment = 23 Task_CommentComplete = 24 Task_Override = 25 Task_Reminder = 26 Unknown = 100 |
| url | string¦null | false | none | none |
| description | string¦null | false | none | none |