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 a specific Flow
Code samples
# You can also use wget
curl -X GET /app/flows/templates/{templateId}/flows \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/templates/{templateId}/flows 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/flows/templates/{templateId}/flows',
{
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/flows/templates/{templateId}/flows', 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/flows/templates/{templateId}/flows";
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/flows/templates/{templateId}/flows");
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/flows/templates/{templateId}/flows
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 |
Example responses
200 Response
[
{
"checklist": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"refId": "string",
"state": 0,
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"templateName": "string",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"items": 0,
"itemsFinished": 0,
"metadata": {
"property1": "string",
"property2": "string"
},
"history": {
"histories": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"action": 0,
"isDispatched": true,
"personName": "string",
"_Action": 0,
"object": 0
}
],
"created": "string",
"started": "string",
"lastUpdate": "string",
"finished": "string"
}
},
"task": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"tags": "string",
"analyticTags": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
},
"section": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"event": {
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"name": "string",
"action": 0,
"item": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"position": "string",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"impersonatedByUserId": "5dda35a5-d13e-4984-920c-ef0c60163370",
"comment": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
},
"tenant": "string"
},
"tasks": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
],
"location": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": 0,
"typeName": "string",
"imoNumber": "string",
"mmsiNumber": "string",
"globalId": "string",
"routeId": "string",
"name": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
},
"comments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
}
]
}
]
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [DispatchData] | false | none | none |
| » checklist | ChecklistData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| »» refId | string¦null | false | none | none |
| »» state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| »» templateId | string(uuid) | false | none | none |
| »» templateName | string¦null | false | none | none |
| »» locationId | string(uuid)¦null | false | none | none |
| »» items | integer(int32) | false | none | none |
| »» itemsFinished | integer(int32) | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| »» history | ChecklistHistoryData | false | none | none |
| »»» histories | [HistorySmall]¦null | false | none | none |
| »»»» id | string(uuid) | false | none | none |
| »»»» time | string(date-time) | false | none | none |
| »»»» timeString | string¦null | false | read-only | none |
| »»»» action | HistoryAction(int32) | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| »»»» isDispatched | boolean | false | none | none |
| »»»» personName | string¦null | false | none | none |
| »»»» _Action | HistoryAction(int32) | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| »»»» object | HistoryObject(int32) | false | none | Checklist = 0 Task = 1 Section = 2 ChecklistTemplate = 10 SectionTemplate = 11 TaskTemplate = 12 |
| »»» created | string¦null | false | read-only | none |
| »»» started | string¦null | false | read-only | none |
| »»» lastUpdate | string¦null | false | read-only | none |
| »»» finished | string¦null | false | read-only | none |
| » task | TaskData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| »» secondaryTitle | string¦null | false | none | none |
| »» state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| »» tags | string¦null | false | none | none |
| »» analyticTags | string¦null | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| » section | SectionData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| » event | DispatchEvent | false | none | none |
| »» time | string(date-time) | false | none | none |
| »» timeString | string¦null | false | read-only | none |
| »» timezone | string¦null | false | none | none |
| »» name | string¦null | false | none | none |
| »» action | DispatchAction(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 |
| »» item | DispatchItem(int32) | false | none | Task = 0 Section = 1 Checklist = 2 |
| »» control | TaskControlData | false | none | none |
| »»» value | string¦null | false | none | none |
| »»» key | string¦null | false | none | none |
| »»» valueTitle | string¦null | false | none | none |
| »»» displayValue | string¦null | false | none | none |
| »»» items | [TaskControlItemData]¦null | false | none | none |
| »»»» id | string(uuid) | false | none | none |
| »»»» values | [TaskControlItemValueData]¦null | false | none | none |
| »»»»» title | string¦null | false | none | none |
| »»»»» value | string¦null | false | none | none |
| »»»»» displayValue | string¦null | false | none | none |
| »»»»» type | TaskType(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 |
| »»»»» typeString | string¦null | false | read-only | none |
| »»»»» dataId | string¦null | false | none | none |
| »»»» time | string(date-time) | false | none | none |
| »»»» timeString | string¦null | false | read-only | none |
| »»» type | TaskType(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 |
| »»» typeString | string¦null | false | read-only | none |
| »»» dataRegister | DataRegisterData | false | none | none |
| »»»» listId | string¦null | false | none | none |
| »»»» listKey | string¦null | false | none | none |
| »»» text | string¦null | false | none | none |
| »»» dataId | string¦null | false | none | none |
| »» control2 | TaskControlData | false | none | none |
| »» geoposition | Geoposition | false | none | none |
| »»» latitude | number(double)¦null | false | none | none |
| »»» longitude | number(double)¦null | false | none | none |
| »» userId | string(uuid)¦null | false | none | none |
| »» position | string¦null | false | none | none |
| »» positionId | string(uuid)¦null | false | none | none |
| »» impersonatedByUserId | string(uuid)¦null | false | none | none |
| »» comment | CommentData | false | none | none |
| »»» id | string(uuid) | false | none | none |
| »»» displayType | string¦null | false | none | none |
| »»» type | string¦null | false | none | none |
| »»» value | string¦null | false | none | none |
| »»» imageUrl | string¦null | false | none | none |
| »»» externalLinkUrl | string¦null | false | none | none |
| »»» externalLinkTitle | string¦null | false | none | none |
| »»» taskTemplateId | string(uuid)¦null | false | none | none |
| »»» sectionTemplateId | string(uuid)¦null | false | none | none |
| »» tenant | string¦null | false | none | none |
| » tasks | [TaskDetailsData]¦null | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| »» secondaryTitle | string¦null | false | none | none |
| »» state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| »» control | TaskControlData | false | none | none |
| »» control2 | TaskControlData | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| »» geoposition | Geoposition | false | none | none |
| »» time | string(date-time)¦null | false | none | none |
| »» timeString | string¦null | false | read-only | none |
| »» timezone | string¦null | false | none | none |
| »» userId | string(uuid)¦null | false | none | none |
| » location | LocationData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» type | LocationType(int32) | false | none | Office = 0 Vessel = 1 Truck = 2 |
| »» typeName | string¦null | false | read-only | none |
| »» imoNumber | string¦null | false | none | none |
| »» mmsiNumber | string¦null | false | none | none |
| »» globalId | string¦null | false | none | none |
| »» routeId | string¦null | false | none | none |
| »» name | string¦null | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| » comments | [CommentData]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| action | 0 |
| action | 1 |
| action | 2 |
| action | 3 |
| action | 4 |
| action | 5 |
| action | 6 |
| action | 7 |
| action | 8 |
| action | 9 |
| action | 10 |
| action | 11 |
| action | 12 |
| _Action | 0 |
| _Action | 1 |
| _Action | 2 |
| _Action | 3 |
| _Action | 4 |
| _Action | 5 |
| _Action | 6 |
| _Action | 7 |
| _Action | 8 |
| _Action | 9 |
| _Action | 10 |
| _Action | 11 |
| _Action | 12 |
| object | 0 |
| object | 1 |
| object | 2 |
| object | 10 |
| object | 11 |
| object | 12 |
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| action | 0 |
| action | 1 |
| action | 2 |
| action | 3 |
| action | 4 |
| action | 5 |
| action | 10 |
| action | 11 |
| action | 12 |
| action | 13 |
| action | 14 |
| action | 15 |
| action | 20 |
| action | 21 |
| action | 22 |
| action | 23 |
| action | 24 |
| action | 25 |
| action | 26 |
| action | 100 |
| item | 0 |
| item | 1 |
| item | 2 |
| type | 0 |
| type | 1 |
| type | 2 |
| type | 3 |
| type | 4 |
| type | 5 |
| type | 6 |
| type | 7 |
| type | 8 |
| type | 9 |
| type | 10 |
| type | 11 |
| type | 12 |
| type | 13 |
| type | 14 |
| type | 15 |
| type | 16 |
| type | 17 |
| type | 18 |
| type | 19 |
| type | 20 |
| type | 21 |
| type | 0 |
| type | 1 |
| type | 2 |
| type | 3 |
| type | 4 |
| type | 5 |
| type | 6 |
| type | 7 |
| type | 8 |
| type | 9 |
| type | 10 |
| type | 11 |
| type | 12 |
| type | 13 |
| type | 14 |
| type | 15 |
| type | 16 |
| type | 17 |
| type | 18 |
| type | 19 |
| type | 20 |
| type | 21 |
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| type | 0 |
| type | 1 |
| type | 2 |
Get information from all flows
Code samples
# You can also use wget
curl -X GET /app/flows/flows?Status=string \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows?Status=string 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/flows/flows?Status=string',
{
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/flows/flows', 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/flows/flows";
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/flows/flows?Status=string");
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/flows/flows
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ActiveAndReady | query | boolean | false | none |
| Completed | query | boolean | false | none |
| Discarded | query | boolean | false | none |
| Archived | query | boolean | false | none |
| Status | query | array[string] | true | none |
| Location | query | string(uuid) | false | none |
| TemplateId | query | string(uuid) | false | none |
| TemplateRefId | query | string | false | none |
| TemplateName | query | string | false | none |
| TemplateMetadataTitles | query | array[string] | false | none |
| TemplateMetadataValues | query | array[string] | false | none |
| TemplateMetadata | query | object | 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",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"metadata": {
"property1": "string",
"property2": "string"
},
"refId": "string",
"history": {
"histories": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"action": 0,
"isDispatched": true,
"personName": "string",
"_Action": 0,
"object": 0
}
],
"created": "string",
"started": "string",
"lastUpdate": "string",
"finished": "string"
}
}
]
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 | [ChecklistShortInfo] | false | none | none |
| » id | string(uuid) | false | none | none |
| » name | string¦null | false | none | none |
| » locationId | string(uuid) | false | none | none |
| » metadata | object¦null | false | none | none |
| »» additionalProperties | string | false | none | none |
| » refId | string¦null | false | none | none |
| » history | ChecklistHistoryData | false | none | none |
| »» histories | [HistorySmall]¦null | false | none | none |
| »»» id | string(uuid) | false | none | none |
| »»» time | string(date-time) | false | none | none |
| »»» timeString | string¦null | false | read-only | none |
| »»» action | HistoryAction(int32) | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| »»» isDispatched | boolean | false | none | none |
| »»» personName | string¦null | false | none | none |
| »»» _Action | HistoryAction(int32) | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| »»» object | HistoryObject(int32) | false | none | Checklist = 0 Task = 1 Section = 2 ChecklistTemplate = 10 SectionTemplate = 11 TaskTemplate = 12 |
| »» created | string¦null | false | read-only | none |
| »» started | string¦null | false | read-only | none |
| »» lastUpdate | string¦null | false | read-only | none |
| »» finished | string¦null | false | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| action | 0 |
| action | 1 |
| action | 2 |
| action | 3 |
| action | 4 |
| action | 5 |
| action | 6 |
| action | 7 |
| action | 8 |
| action | 9 |
| action | 10 |
| action | 11 |
| action | 12 |
| _Action | 0 |
| _Action | 1 |
| _Action | 2 |
| _Action | 3 |
| _Action | 4 |
| _Action | 5 |
| _Action | 6 |
| _Action | 7 |
| _Action | 8 |
| _Action | 9 |
| _Action | 10 |
| _Action | 11 |
| _Action | 12 |
| object | 0 |
| object | 1 |
| object | 2 |
| object | 10 |
| object | 11 |
| object | 12 |
Creates new information to a flow
Code samples
# You can also use wget
curl -X POST /app/flows/flows \
-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/flows/flows HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"id": null,
"refId": null,
"dueTime": null,
"reoccurFrom": null,
"metadata": {
"property1": "string",
"property2": "string"
},
"externalData": {
"email": "string",
"fullName": "string",
"phone": null,
"sendEmail": false,
"expireDays": 30
},
"assignToPersonId": null,
"assignToPositionId": null
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows',
{
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/flows/flows', 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/flows/flows";
string json = @"{
""id"": null,
""refId"": null,
""dueTime"": null,
""reoccurFrom"": null,
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
},
""externalData"": {
""email"": ""string"",
""fullName"": ""string"",
""phone"": null,
""sendEmail"": false,
""expireDays"": 30
},
""assignToPersonId"": null,
""assignToPositionId"": null
}";
NewChecklistApiModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(NewChecklistApiModel 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(NewChecklistApiModel 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/flows/flows");
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/flows/flows
Body parameter
{
"id": null,
"refId": null,
"dueTime": null,
"reoccurFrom": null,
"metadata": {
"property1": "string",
"property2": "string"
},
"externalData": {
"email": "string",
"fullName": "string",
"phone": null,
"sendEmail": false,
"expireDays": 30
},
"assignToPersonId": null,
"assignToPositionId": null
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | NewChecklistApiModel | true | NewChecklistApiModel object |
Example responses
200 Response
{
"id": "80e60f44-f1cd-49b0-948a-8e5e4125d9f7",
"url": "http://apphost.com/flow/80e60f44-f1cd-49b0-948a-8e5e4125d9f7",
"invalidateExternalUrl": null
}
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | NewChecklistResultModel |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Get information from a specific flow
Code samples
# You can also use wget
curl -X GET /app/flows/flows/{flowId} \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows/{flowId} 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/flows/flows/{flowId}',
{
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/flows/flows/{flowId}', 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/flows/flows/{flowId}";
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/flows/flows/{flowId}");
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/flows/flows/{flowId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
{
"checklist": {
"id": "73a437c8-d422-4fdf-9212-df12b0683514",
"name": "Test flow",
"refId": "Ref.Id",
"state": "Active",
"templateId": "ae34e0a6-bca1-476f-b865-26f361e47b14",
"templateName": "Test flow",
"locationId": "63dc5c65-6194-427d-b97e-4aea5f2e2112",
"items": 5,
"itemsFinished": 1,
"metadata": {
"title1": "value1",
"title2": "value2"
},
"history": {
"created": "2022-06-09T10:08:40.7413142Z",
"started": null,
"lastUpdate": "2022-06-09T10:08:40.7413142Z",
"finished": null
}
},
"task": {
"id": "d179f588-26fc-441f-af26-7ef395ae6374",
"name": "Task 1",
"secondaryTitle": "Task info",
"state": "Finished",
"tags": "tag2",
"analyticTags": "tag1",
"metadata": {
"title1": "value1",
"title2": "value2"
}
},
"section": {
"id": "7d3973fb-2996-45f0-bdde-1abda0c15ce8",
"name": "Section"
},
"event": {
"Time": "2022-06-09T10:08:40.7413103",
"timezone": "GMT+2",
"name": null,
"action": "Task_Comment",
"item": "Task",
"control": {
"value": "OK",
"key": null,
"valueTitle": null,
"displayValue": "OK",
"items": null,
"Type": "Checkbox",
"dataRegister": null,
"text": null,
"dataId": null
},
"control2": null,
"geoposition": {
"latitude": 0,
"longitude": 0
},
"userId": "0e4987e9-4a56-4dae-8c2f-85e2a4d309f7",
"position": "Capitan",
"positionId": "010878da-bde1-46a5-8b55-85fd57ffe523",
"impersonatedByUserId": null,
"comment": {
"id": "46bcc938-263a-4268-b9ea-e2f5e9cac035",
"displayType": "Other",
"type": "other",
"value": "Comment text",
"imageUrl": "http://image.host/path",
"externalLinkUrl": null,
"externalLinkTitle": null,
"taskTemplateId": null,
"sectionTemplateId": null
},
"tenant": "TenantName"
},
"tasks": [
{
"id": "d179f588-26fc-441f-af26-7ef395ae6374",
"name": "Task 1",
"secondaryTitle": "Secondary Title",
"state": "Finished",
"control": {
"value": "OK",
"key": null,
"valueTitle": null,
"displayValue": "OK",
"items": null,
"Type": "Checkbox",
"dataRegister": null,
"text": null,
"dataId": null
},
"control2": null,
"metadata": {
"title1": "value1",
"title2": "value2"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"Time": "2022-06-09T10:08:40.741312+00:00",
"timezone": "GMT+3",
"userId": "8871143e-ebf8-437f-b45c-122ce1d3907e"
}
],
"location": {
"id": "63dc5c65-6194-427d-b97e-4aea5f2e2112",
"Type": "Office",
"imoNumber": "12345",
"mmsiNumber": null,
"globalId": "Location.Global",
"routeId": "GL",
"name": "Global location",
"metadata": {
"title1": "value1",
"title2": "value2"
}
},
"comments": [
{
"id": "a6ea46d9-17a3-45a0-97f1-f88db03d5e6d",
"displayType": "Other",
"type": "Other",
"value": "Some Comment Value",
"imageUrl": "",
"externalLinkUrl": null,
"externalLinkTitle": null,
"taskTemplateId": "d179f588-26fc-441f-af26-7ef395ae6374",
"sectionTemplateId": null
}
]
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DispatchData |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Creates a one-time template
Code samples
# You can also use wget
curl -X POST /app/flows/flows/oneTimeTemplate \
-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/flows/flows/oneTimeTemplate HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"dueTime": null,
"checklistTemplate": {
"name": "string",
"refId": "string",
"shortDescription": "string",
"customCompleteMessage": "string",
"sectionTemplates": [
{
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"taskTemplates": [
{
"name": "string",
"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": {},
"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": {},
"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"
},
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"reminderHours": null,
"reminderMinutes": null,
"reminderTime": null,
"preventQuickInput": false,
"metadata": {
"property1": "string",
"property2": "string"
},
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": false,
"setContentByAPI": false,
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
}
],
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"metadata": {
"property1": "string",
"property2": "string"
}
}
],
"metadata": [
{
"name": "string",
"value": "string",
"displayAsSubHeading": true
}
],
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"archiveChecklistsAfter": 1,
"archiveChecklistsAfterSpan": 0,
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"publishToMessagebus": false,
"singleUserTemplate": false,
"allowExternalUse": false,
"locationTagging": false,
"preventQuickDiscard": false,
"preventFlowCreateByActiveRefId": "string",
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
},
"externalData": {
"email": "string",
"fullName": "string",
"phone": null,
"sendEmail": false,
"expireDays": 30
},
"assignToPersonId": null,
"assignToPositionId": null
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/oneTimeTemplate',
{
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/flows/flows/oneTimeTemplate', 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/flows/flows/oneTimeTemplate";
string json = @"{
""dueTime"": null,
""checklistTemplate"": {
""name"": ""string"",
""refId"": ""string"",
""shortDescription"": ""string"",
""customCompleteMessage"": ""string"",
""sectionTemplates"": [
{
""name"": ""string"",
""color"": ""string"",
""documentation"": [
{
""externalItemId"": ""0e1fce12-4246-4901-adef-a4db111e0a19"",
""sourceName"": ""string"",
""order"": 0,
""title"": ""string"",
""value"": ""string"",
""relativeExternalItemUrl"": ""string"",
""message"": ""string""
}
],
""taskTemplates"": [
{
""name"": ""string"",
""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"": {},
""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"": {},
""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""
},
""documentation"": [
{
""externalItemId"": ""0e1fce12-4246-4901-adef-a4db111e0a19"",
""sourceName"": ""string"",
""order"": 0,
""title"": ""string"",
""value"": ""string"",
""relativeExternalItemUrl"": ""string"",
""message"": ""string""
}
],
""secondaryTitle"": ""string"",
""tags"": ""string"",
""analyticTags"": ""string"",
""webhooks"": [
{
""location"": ""15f20760-76a7-41ee-b509-705d3ffd8eb5"",
""action"": 0,
""url"": ""string"",
""description"": ""string""
}
],
""reminderHours"": null,
""reminderMinutes"": null,
""reminderTime"": null,
""preventQuickInput"": false,
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
},
""assignedPosition"": ""0e023770-feda-40e2-8177-601401251112"",
""sensitiveData"": false,
""setContentByAPI"": false,
""discardReasons"": [
{
""name"": ""string"",
""requireComment"": true,
""default"": true
}
],
""commentTypes"": [
{
""name"": ""string"",
""requireComment"": true
}
]
}
],
""webhooks"": [
{
""location"": ""15f20760-76a7-41ee-b509-705d3ffd8eb5"",
""action"": 0,
""url"": ""string"",
""description"": ""string""
}
],
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
}
}
],
""metadata"": [
{
""name"": ""string"",
""value"": ""string"",
""displayAsSubHeading"": true
}
],
""webhooks"": [
{
""location"": ""15f20760-76a7-41ee-b509-705d3ffd8eb5"",
""action"": 0,
""url"": ""string"",
""description"": ""string""
}
],
""archiveChecklistsAfter"": 1,
""archiveChecklistsAfterSpan"": 0,
""categoryId"": ""337f5e5d-288b-40d5-be14-901cc3acacc0"",
""publishToMessagebus"": false,
""singleUserTemplate"": false,
""allowExternalUse"": false,
""locationTagging"": false,
""preventQuickDiscard"": false,
""preventFlowCreateByActiveRefId"": ""string"",
""discardReasons"": [
{
""name"": ""string"",
""requireComment"": true,
""default"": true
}
],
""commentTypes"": [
{
""name"": ""string"",
""requireComment"": true
}
]
},
""externalData"": {
""email"": ""string"",
""fullName"": ""string"",
""phone"": null,
""sendEmail"": false,
""expireDays"": 30
},
""assignToPersonId"": null,
""assignToPositionId"": null
}";
NewChecklistByOnetimeTemplateApiModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(NewChecklistByOnetimeTemplateApiModel 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(NewChecklistByOnetimeTemplateApiModel 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/flows/flows/oneTimeTemplate");
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/flows/flows/oneTimeTemplate
Body parameter
{
"dueTime": null,
"checklistTemplate": {
"name": "string",
"refId": "string",
"shortDescription": "string",
"customCompleteMessage": "string",
"sectionTemplates": [
{
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"taskTemplates": [
{
"name": "string",
"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": {},
"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": {},
"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"
},
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"reminderHours": null,
"reminderMinutes": null,
"reminderTime": null,
"preventQuickInput": false,
"metadata": {
"property1": "string",
"property2": "string"
},
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": false,
"setContentByAPI": false,
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
}
],
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"metadata": {
"property1": "string",
"property2": "string"
}
}
],
"metadata": [
{
"name": "string",
"value": "string",
"displayAsSubHeading": true
}
],
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"archiveChecklistsAfter": 1,
"archiveChecklistsAfterSpan": 0,
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"publishToMessagebus": false,
"singleUserTemplate": false,
"allowExternalUse": false,
"locationTagging": false,
"preventQuickDiscard": false,
"preventFlowCreateByActiveRefId": "string",
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
},
"externalData": {
"email": "string",
"fullName": "string",
"phone": null,
"sendEmail": false,
"expireDays": 30
},
"assignToPersonId": null,
"assignToPositionId": null
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | NewChecklistByOnetimeTemplateApiModel | true | none |
Example responses
200 Response
{
"id": "80e60f44-f1cd-49b0-948a-8e5e4125d9f7",
"url": "http://apphost.com/flow/80e60f44-f1cd-49b0-948a-8e5e4125d9f7",
"invalidateExternalUrl": null
}
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | NewChecklistResultModel |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Update specific flow to discarded
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/discard \
-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/flows/flows/{flowId}/discard HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"comment": "string"
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/discard',
{
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/flows/flows/{flowId}/discard', 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/flows/flows/{flowId}/discard";
string json = @"{
""comment"": ""string""
}";
DiscardChecklistApiModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, DiscardChecklistApiModel 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(DiscardChecklistApiModel 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/flows/flows/{flowId}/discard");
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/flows/flows/{flowId}/discard
Body parameter
{
"comment": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | DiscardChecklistApiModel | true | DiscardChecklisApiModel object |
Example responses
200 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Get specific flow in PDF
Code samples
# You can also use wget
curl -X GET /app/flows/flows/{flowId}/pdf \
-H 'Accept: application/pdf' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows/{flowId}/pdf HTTP/1.1
Accept: application/pdf
api-version: string
const headers = {
'Accept':'application/pdf',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/pdf',
{
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/pdf',
'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/flows/flows/{flowId}/pdf', 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/flows/flows/{flowId}/pdf";
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/flows/flows/{flowId}/pdf");
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/flows/flows/{flowId}/pdf
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
"string"
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
424 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
| 424 | Failed Dependency | Client Error | ApiMessage |
Update metadata for specific flow
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/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/flows/flows/{flowId}/metadata HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"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/flows/flows/{flowId}/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/flows/flows/{flowId}/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/flows/flows/{flowId}/metadata";
string json = @"{
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
}
}";
ChecklistMetadataApiModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, ChecklistMetadataApiModel 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(ChecklistMetadataApiModel 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/flows/flows/{flowId}/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/flows/flows/{flowId}/metadata
Body parameter
{
"metadata": {
"property1": "string",
"property2": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | ChecklistMetadataApiModel | true | ChecklistMetadataApiModel object |
Example responses
200 Response
{
"message": "Result message"
}
400 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApiMessage |
| 400 | Bad Request | Bad Request | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Posting picture in a specific flow
Code samples
# You can also use wget
curl -X POST /app/flows/flows/{flowId}/pictures \
-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/flows/flows/{flowId}/pictures HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"content": [
0
],
"base64Content": "string",
"urlContent": "string",
"fileName": null
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/pictures',
{
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/flows/flows/{flowId}/pictures', 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/flows/flows/{flowId}/pictures";
string json = @"{
""content"": [
0
],
""base64Content"": ""string"",
""urlContent"": ""string"",
""fileName"": null
}";
FileApiModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(FileApiModel 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(FileApiModel 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/flows/flows/{flowId}/pictures");
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/flows/flows/{flowId}/pictures
Body parameter
{
"content": [
0
],
"base64Content": "string",
"urlContent": "string",
"fileName": null
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | FileApiModel | true | FileApiModel object |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": {
"appPath": "string",
"hasSmallImage": true,
"value": 0,
"name": "string"
},
"objectId": "e39ea5f2-2188-47f8-add0-f1976630af5e",
"checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
"url": "string"
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | File |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Get list of comments from specified flow
Code samples
# You can also use wget
curl -X GET /app/flows/flows/{flowId}/comments \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows/{flowId}/comments 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/flows/flows/{flowId}/comments',
{
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/flows/flows/{flowId}/comments', 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/flows/flows/{flowId}/comments";
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/flows/flows/{flowId}/comments");
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/flows/flows/{flowId}/comments
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | query | string(uuid) | false | Task ID |
| sectionId | query | string(uuid) | false | Section ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
[
{
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed",
"isOverride": true,
"isCanceled": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"value": "string",
"checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
"personName": "string",
"personPosition": "string",
"personInitials": "string",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"discardReason": "string",
"commentType": "string",
"picture": "string",
"pictureUrl": "string",
"canceledPersonName": "string",
"canceledPersonPosition": "string",
"canceledPersonInitials": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string"
}
]
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Comment] | false | none | none |
| » taskTemplateId | string(uuid)¦null | false | none | none |
| » sectionTemplateId | string(uuid)¦null | false | none | none |
| » isOverride | boolean | false | none | none |
| » isCanceled | boolean | false | none | none |
| » id | string(uuid) | false | none | none |
| » value | string¦null | false | none | none |
| » checklistId | string(uuid) | false | none | none |
| » personName | string¦null | false | none | none |
| » personPosition | string¦null | false | none | none |
| » personInitials | string¦null | false | read-only | none |
| » time | string(date-time) | false | none | none |
| » timeString | string¦null | false | read-only | none |
| » discardReason | string¦null | false | none | none |
| » commentType | string¦null | false | none | none |
| » picture | string¦null | false | none | none |
| » pictureUrl | string¦null | false | none | none |
| » canceledPersonName | string¦null | false | none | none |
| » canceledPersonPosition | string¦null | false | none | none |
| » canceledPersonInitials | string¦null | false | read-only | none |
| » externalLinkUrl | string¦null | false | none | none |
| » externalLinkTitle | string¦null | false | none | none |
Complete a comment for a specific flow
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/comments/{commentId}/complete \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
PUT /app/flows/flows/{flowId}/comments/{commentId}/complete 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/flows/flows/{flowId}/comments/{commentId}/complete',
{
method: 'PUT',
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('PUT','/app/flows/flows/{flowId}/comments/{commentId}/complete', 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/flows/flows/{flowId}/comments/{commentId}/complete";
var result = await PutAsync(id, null, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, undefined 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(undefined 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/flows/flows/{flowId}/comments/{commentId}/complete");
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/flows/flows/{flowId}/comments/{commentId}/complete
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| commentId | path | string(uuid) | true | Comment ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Success | None |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Get information on tasks from a specific flow
Code samples
# You can also use wget
curl -X GET /app/flows/flows/{flowId}/tasks \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows/{flowId}/tasks 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/flows/flows/{flowId}/tasks',
{
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/flows/flows/{flowId}/tasks', 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/flows/flows/{flowId}/tasks";
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/flows/flows/{flowId}/tasks");
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/flows/flows/{flowId}/tasks
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| SearchString | query | string | false | none |
| SearchInTaskName | query | boolean | false | none |
| SearchInTaskValue | query | boolean | false | none |
| SearchInMetadataTitle | query | boolean | false | none |
| SearchInDataId | query | boolean | false | none |
| SearchInMetadataValue | query | boolean | false | none |
| flowId | path | string(uuid) | true | none |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
[
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
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
Update information on tasks for a specific flow
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/tasks \
-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/flows/flows/{flowId}/tasks HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '[
{
"taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
"value1": null,
"value2": null,
"source": null,
"time": null,
"shouldConfirm": false,
"overrideExistingValue": true,
"appendValue": false
}
]';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/tasks',
{
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/flows/flows/{flowId}/tasks', 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/flows/flows/{flowId}/tasks";
string json = @"[
{
""taskId"": ""e6e9d88a-9b63-468a-aec3-b7a11de27af8"",
""value1"": null,
""value2"": null,
""source"": null,
""time"": null,
""shouldConfirm"": false,
""overrideExistingValue"": true,
""appendValue"": false
}
]";
SetTaskValueModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, SetTaskValueModel 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(SetTaskValueModel 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/flows/flows/{flowId}/tasks");
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/flows/flows/{flowId}/tasks
Body parameter
[
{
"taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
"value1": null,
"value2": null,
"source": null,
"time": null,
"shouldConfirm": false,
"overrideExistingValue": true,
"appendValue": false
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | SetTaskValueModel | true | List of SetTaskValueModel objects |
Example responses
200 Response
[
{
"checklist": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"refId": "string",
"state": 0,
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"templateName": "string",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"items": 0,
"itemsFinished": 0,
"metadata": {
"property1": "string",
"property2": "string"
},
"history": {
"histories": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"action": 0,
"isDispatched": true,
"personName": "string",
"_Action": 0,
"object": 0
}
],
"created": "string",
"started": "string",
"lastUpdate": "string",
"finished": "string"
}
},
"task": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"tags": "string",
"analyticTags": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
},
"section": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"event": {
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"name": "string",
"action": 0,
"item": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"position": "string",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"impersonatedByUserId": "5dda35a5-d13e-4984-920c-ef0c60163370",
"comment": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
},
"tenant": "string"
},
"tasks": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
],
"location": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": 0,
"typeName": "string",
"imoNumber": "string",
"mmsiNumber": "string",
"globalId": "string",
"routeId": "string",
"name": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
},
"comments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
}
]
}
]
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [DispatchData] | false | none | none |
| » checklist | ChecklistData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| »» refId | string¦null | false | none | none |
| »» state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| »» templateId | string(uuid) | false | none | none |
| »» templateName | string¦null | false | none | none |
| »» locationId | string(uuid)¦null | false | none | none |
| »» items | integer(int32) | false | none | none |
| »» itemsFinished | integer(int32) | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| »» history | ChecklistHistoryData | false | none | none |
| »»» histories | [HistorySmall]¦null | false | none | none |
| »»»» id | string(uuid) | false | none | none |
| »»»» time | string(date-time) | false | none | none |
| »»»» timeString | string¦null | false | read-only | none |
| »»»» action | HistoryAction(int32) | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| »»»» isDispatched | boolean | false | none | none |
| »»»» personName | string¦null | false | none | none |
| »»»» _Action | HistoryAction(int32) | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| »»»» object | HistoryObject(int32) | false | none | Checklist = 0 Task = 1 Section = 2 ChecklistTemplate = 10 SectionTemplate = 11 TaskTemplate = 12 |
| »»» created | string¦null | false | read-only | none |
| »»» started | string¦null | false | read-only | none |
| »»» lastUpdate | string¦null | false | read-only | none |
| »»» finished | string¦null | false | read-only | none |
| » task | TaskData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| »» secondaryTitle | string¦null | false | none | none |
| »» state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| »» tags | string¦null | false | none | none |
| »» analyticTags | string¦null | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| » section | SectionData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| » event | DispatchEvent | false | none | none |
| »» time | string(date-time) | false | none | none |
| »» timeString | string¦null | false | read-only | none |
| »» timezone | string¦null | false | none | none |
| »» name | string¦null | false | none | none |
| »» action | DispatchAction(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 |
| »» item | DispatchItem(int32) | false | none | Task = 0 Section = 1 Checklist = 2 |
| »» control | TaskControlData | false | none | none |
| »»» value | string¦null | false | none | none |
| »»» key | string¦null | false | none | none |
| »»» valueTitle | string¦null | false | none | none |
| »»» displayValue | string¦null | false | none | none |
| »»» items | [TaskControlItemData]¦null | false | none | none |
| »»»» id | string(uuid) | false | none | none |
| »»»» values | [TaskControlItemValueData]¦null | false | none | none |
| »»»»» title | string¦null | false | none | none |
| »»»»» value | string¦null | false | none | none |
| »»»»» displayValue | string¦null | false | none | none |
| »»»»» type | TaskType(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 |
| »»»»» typeString | string¦null | false | read-only | none |
| »»»»» dataId | string¦null | false | none | none |
| »»»» time | string(date-time) | false | none | none |
| »»»» timeString | string¦null | false | read-only | none |
| »»» type | TaskType(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 |
| »»» typeString | string¦null | false | read-only | none |
| »»» dataRegister | DataRegisterData | false | none | none |
| »»»» listId | string¦null | false | none | none |
| »»»» listKey | string¦null | false | none | none |
| »»» text | string¦null | false | none | none |
| »»» dataId | string¦null | false | none | none |
| »» control2 | TaskControlData | false | none | none |
| »» geoposition | Geoposition | false | none | none |
| »»» latitude | number(double)¦null | false | none | none |
| »»» longitude | number(double)¦null | false | none | none |
| »» userId | string(uuid)¦null | false | none | none |
| »» position | string¦null | false | none | none |
| »» positionId | string(uuid)¦null | false | none | none |
| »» impersonatedByUserId | string(uuid)¦null | false | none | none |
| »» comment | CommentData | false | none | none |
| »»» id | string(uuid) | false | none | none |
| »»» displayType | string¦null | false | none | none |
| »»» type | string¦null | false | none | none |
| »»» value | string¦null | false | none | none |
| »»» imageUrl | string¦null | false | none | none |
| »»» externalLinkUrl | string¦null | false | none | none |
| »»» externalLinkTitle | string¦null | false | none | none |
| »»» taskTemplateId | string(uuid)¦null | false | none | none |
| »»» sectionTemplateId | string(uuid)¦null | false | none | none |
| »» tenant | string¦null | false | none | none |
| » tasks | [TaskDetailsData]¦null | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| »» secondaryTitle | string¦null | false | none | none |
| »» state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| »» control | TaskControlData | false | none | none |
| »» control2 | TaskControlData | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| »» geoposition | Geoposition | false | none | none |
| »» time | string(date-time)¦null | false | none | none |
| »» timeString | string¦null | false | read-only | none |
| »» timezone | string¦null | false | none | none |
| »» userId | string(uuid)¦null | false | none | none |
| » location | LocationData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» type | LocationType(int32) | false | none | Office = 0 Vessel = 1 Truck = 2 |
| »» typeName | string¦null | false | read-only | none |
| »» imoNumber | string¦null | false | none | none |
| »» mmsiNumber | string¦null | false | none | none |
| »» globalId | string¦null | false | none | none |
| »» routeId | string¦null | false | none | none |
| »» name | string¦null | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| » comments | [CommentData]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| action | 0 |
| action | 1 |
| action | 2 |
| action | 3 |
| action | 4 |
| action | 5 |
| action | 6 |
| action | 7 |
| action | 8 |
| action | 9 |
| action | 10 |
| action | 11 |
| action | 12 |
| _Action | 0 |
| _Action | 1 |
| _Action | 2 |
| _Action | 3 |
| _Action | 4 |
| _Action | 5 |
| _Action | 6 |
| _Action | 7 |
| _Action | 8 |
| _Action | 9 |
| _Action | 10 |
| _Action | 11 |
| _Action | 12 |
| object | 0 |
| object | 1 |
| object | 2 |
| object | 10 |
| object | 11 |
| object | 12 |
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| action | 0 |
| action | 1 |
| action | 2 |
| action | 3 |
| action | 4 |
| action | 5 |
| action | 10 |
| action | 11 |
| action | 12 |
| action | 13 |
| action | 14 |
| action | 15 |
| action | 20 |
| action | 21 |
| action | 22 |
| action | 23 |
| action | 24 |
| action | 25 |
| action | 26 |
| action | 100 |
| item | 0 |
| item | 1 |
| item | 2 |
| type | 0 |
| type | 1 |
| type | 2 |
| type | 3 |
| type | 4 |
| type | 5 |
| type | 6 |
| type | 7 |
| type | 8 |
| type | 9 |
| type | 10 |
| type | 11 |
| type | 12 |
| type | 13 |
| type | 14 |
| type | 15 |
| type | 16 |
| type | 17 |
| type | 18 |
| type | 19 |
| type | 20 |
| type | 21 |
| type | 0 |
| type | 1 |
| type | 2 |
| type | 3 |
| type | 4 |
| type | 5 |
| type | 6 |
| type | 7 |
| type | 8 |
| type | 9 |
| type | 10 |
| type | 11 |
| type | 12 |
| type | 13 |
| type | 14 |
| type | 15 |
| type | 16 |
| type | 17 |
| type | 18 |
| type | 19 |
| type | 20 |
| type | 21 |
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| type | 0 |
| type | 1 |
| type | 2 |
Update information on a task by ID from a specific flow
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/tasks/{taskId} \
-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/flows/flows/{flowId}/tasks/{taskId} HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"value1": null,
"value2": null,
"source": null,
"time": null,
"shouldConfirm": false,
"overrideExistingValue": true,
"appendValue": false
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/tasks/{taskId}',
{
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/flows/flows/{flowId}/tasks/{taskId}', 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/flows/flows/{flowId}/tasks/{taskId}";
string json = @"{
""value1"": null,
""value2"": null,
""source"": null,
""time"": null,
""shouldConfirm"": false,
""overrideExistingValue"": true,
""appendValue"": false
}";
TaskValueApiModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, TaskValueApiModel 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(TaskValueApiModel 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/flows/flows/{flowId}/tasks/{taskId}");
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/flows/flows/{flowId}/tasks/{taskId}
Body parameter
{
"value1": null,
"value2": null,
"source": null,
"time": null,
"shouldConfirm": false,
"overrideExistingValue": true,
"appendValue": false
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | path | string(uuid) | true | Task ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | TaskValueApiModel | true | TaskValueApiModel object |
Example responses
200 Response
{
"checklist": {
"id": "73a437c8-d422-4fdf-9212-df12b0683514",
"name": "Test flow",
"refId": "Ref.Id",
"state": "Active",
"templateId": "ae34e0a6-bca1-476f-b865-26f361e47b14",
"templateName": "Test flow",
"locationId": "63dc5c65-6194-427d-b97e-4aea5f2e2112",
"items": 5,
"itemsFinished": 1,
"metadata": {
"title1": "value1",
"title2": "value2"
},
"history": {
"created": "2022-06-09T10:08:40.7641745Z",
"started": null,
"lastUpdate": "2022-06-09T10:08:40.7641745Z",
"finished": null
}
},
"task": {
"id": "d179f588-26fc-441f-af26-7ef395ae6374",
"name": "Task 1",
"secondaryTitle": "Task info",
"state": "Finished",
"tags": "tag2",
"analyticTags": "tag1",
"metadata": {
"title1": "value1",
"title2": "value2"
}
},
"section": {
"id": "7d3973fb-2996-45f0-bdde-1abda0c15ce8",
"name": "Section"
},
"event": {
"Time": "2022-06-09T10:08:40.7641704",
"timezone": "GMT+2",
"name": null,
"action": "Task_Comment",
"item": "Task",
"control": {
"value": "OK",
"key": null,
"valueTitle": null,
"displayValue": "OK",
"items": null,
"Type": "Checkbox",
"dataRegister": null,
"text": null,
"dataId": null
},
"control2": null,
"geoposition": {
"latitude": 0,
"longitude": 0
},
"userId": "0e4987e9-4a56-4dae-8c2f-85e2a4d309f7",
"position": "Capitan",
"positionId": "010878da-bde1-46a5-8b55-85fd57ffe523",
"impersonatedByUserId": null,
"comment": {
"id": "46bcc938-263a-4268-b9ea-e2f5e9cac035",
"displayType": "Other",
"type": "other",
"value": "Comment text",
"imageUrl": "http://image.host/path",
"externalLinkUrl": null,
"externalLinkTitle": null,
"taskTemplateId": null,
"sectionTemplateId": null
},
"tenant": "TenantName"
},
"tasks": [
{
"id": "d179f588-26fc-441f-af26-7ef395ae6374",
"name": "Task 1",
"secondaryTitle": "Secondary Title",
"state": "Finished",
"control": {
"value": "OK",
"key": null,
"valueTitle": null,
"displayValue": "OK",
"items": null,
"Type": "Checkbox",
"dataRegister": null,
"text": null,
"dataId": null
},
"control2": null,
"metadata": {
"title1": "value1",
"title2": "value2"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"Time": "2022-06-09T10:08:40.7641716+00:00",
"timezone": "GMT+3",
"userId": "8871143e-ebf8-437f-b45c-122ce1d3907e"
}
],
"location": {
"id": "63dc5c65-6194-427d-b97e-4aea5f2e2112",
"Type": "Office",
"imoNumber": "12345",
"mmsiNumber": null,
"globalId": "Location.Global",
"routeId": "GL",
"name": "Global location",
"metadata": {
"title1": "value1",
"title2": "value2"
}
},
"comments": [
{
"id": "a6ea46d9-17a3-45a0-97f1-f88db03d5e6d",
"displayType": "Other",
"type": "Other",
"value": "Some Comment Value",
"imageUrl": "",
"externalLinkUrl": null,
"externalLinkTitle": null,
"taskTemplateId": "d179f588-26fc-441f-af26-7ef395ae6374",
"sectionTemplateId": null
}
]
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DispatchData |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Get information on a task from a specific flow
Code samples
# You can also use wget
curl -X GET /app/flows/flows/{flowId}/tasks/{taskId} \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows/{flowId}/tasks/{taskId} 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/flows/flows/{flowId}/tasks/{taskId}',
{
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/flows/flows/{flowId}/tasks/{taskId}', 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/flows/flows/{flowId}/tasks/{taskId}";
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/flows/flows/{flowId}/tasks/{taskId}");
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/flows/flows/{flowId}/tasks/{taskId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | path | string(uuid) | true | Task ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
{
"id": "932b89cb-44bc-4798-9aaa-e6d80aad6c54",
"reminderHours": null,
"reminderMinutes": null,
"reminderTimeString": null,
"templateId": "2565eac1-9538-4ad6-9fa9-7808b6e6226b",
"name": "Task 1",
"documentation": [
{
"externalItemId": null,
"sourceName": "Internal",
"order": 0,
"title": "Information",
"value": "Description text",
"relativeExternalItemUrl": null,
"message": null
}
],
"order": 0,
"sectionId": "f82edebb-9d52-4f59-90ae-1cd41c96c0de",
"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
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TaskTemplate |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
List data on a task from specific flow
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/tasks/{taskId}/listData \
-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/flows/flows/{flowId}/tasks/{taskId}/listData HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"listData": {
"property1": "string",
"property2": "string"
},
"description": "string"
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/tasks/{taskId}/listData',
{
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/flows/flows/{flowId}/tasks/{taskId}/listData', 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/flows/flows/{flowId}/tasks/{taskId}/listData";
string json = @"{
""listData"": {
""property1"": ""string"",
""property2"": ""string""
},
""description"": ""string""
}";
NewListItem content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, NewListItem 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(NewListItem 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/flows/flows/{flowId}/tasks/{taskId}/listData");
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/flows/flows/{flowId}/tasks/{taskId}/listData
Body parameter
{
"listData": {
"property1": "string",
"property2": "string"
},
"description": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | path | string(uuid) | true | Task ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | NewListItem | true | NewListItem object |
Example responses
200 Response
{
"id": "9d64ad11-4a23-4482-9008-35b7e160988f",
"values": [
"val 1",
"val 2"
],
"time": "2022-06-09T10:08:40.769266Z"
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ListTaskValue |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Confirm task in specific flow
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/tasks/{taskId}/confirm \
-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/flows/flows/{flowId}/tasks/{taskId}/confirm HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"source": null,
"time": null
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/tasks/{taskId}/confirm',
{
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/flows/flows/{flowId}/tasks/{taskId}/confirm', 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/flows/flows/{flowId}/tasks/{taskId}/confirm";
string json = @"{
""source"": null,
""time"": null
}";
ConfirmTaskApiModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, ConfirmTaskApiModel 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(ConfirmTaskApiModel 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/flows/flows/{flowId}/tasks/{taskId}/confirm");
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/flows/flows/{flowId}/tasks/{taskId}/confirm
Body parameter
{
"source": null,
"time": null
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | path | string(uuid) | true | Task ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | ConfirmTaskApiModel | true | ConfirmTaskApiModel object |
Example responses
200 Response
{
"checklist": {
"id": "73a437c8-d422-4fdf-9212-df12b0683514",
"name": "Test flow",
"refId": "Ref.Id",
"state": "Active",
"templateId": "ae34e0a6-bca1-476f-b865-26f361e47b14",
"templateName": "Test flow",
"locationId": "63dc5c65-6194-427d-b97e-4aea5f2e2112",
"items": 5,
"itemsFinished": 1,
"metadata": {
"title1": "value1",
"title2": "value2"
},
"history": {
"created": "2022-06-09T10:08:40.7707227Z",
"started": null,
"lastUpdate": "2022-06-09T10:08:40.7707227Z",
"finished": null
}
},
"task": {
"id": "d179f588-26fc-441f-af26-7ef395ae6374",
"name": "Task 1",
"secondaryTitle": "Task info",
"state": "Finished",
"tags": "tag2",
"analyticTags": "tag1",
"metadata": {
"title1": "value1",
"title2": "value2"
}
},
"section": {
"id": "7d3973fb-2996-45f0-bdde-1abda0c15ce8",
"name": "Section"
},
"event": {
"Time": "2022-06-09T10:08:40.7707197",
"timezone": "GMT+2",
"name": null,
"action": "Task_Comment",
"item": "Task",
"control": {
"value": "OK",
"key": null,
"valueTitle": null,
"displayValue": "OK",
"items": null,
"Type": "Checkbox",
"dataRegister": null,
"text": null,
"dataId": null
},
"control2": null,
"geoposition": {
"latitude": 0,
"longitude": 0
},
"userId": "0e4987e9-4a56-4dae-8c2f-85e2a4d309f7",
"position": "Capitan",
"positionId": "010878da-bde1-46a5-8b55-85fd57ffe523",
"impersonatedByUserId": null,
"comment": {
"id": "46bcc938-263a-4268-b9ea-e2f5e9cac035",
"displayType": "Other",
"type": "other",
"value": "Comment text",
"imageUrl": "http://image.host/path",
"externalLinkUrl": null,
"externalLinkTitle": null,
"taskTemplateId": null,
"sectionTemplateId": null
},
"tenant": "TenantName"
},
"tasks": [
{
"id": "d179f588-26fc-441f-af26-7ef395ae6374",
"name": "Task 1",
"secondaryTitle": "Secondary Title",
"state": "Finished",
"control": {
"value": "OK",
"key": null,
"valueTitle": null,
"displayValue": "OK",
"items": null,
"Type": "Checkbox",
"dataRegister": null,
"text": null,
"dataId": null
},
"control2": null,
"metadata": {
"title1": "value1",
"title2": "value2"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"Time": "2022-06-09T10:08:40.7707208+00:00",
"timezone": "GMT+3",
"userId": "8871143e-ebf8-437f-b45c-122ce1d3907e"
}
],
"location": {
"id": "63dc5c65-6194-427d-b97e-4aea5f2e2112",
"Type": "Office",
"imoNumber": "12345",
"mmsiNumber": null,
"globalId": "Location.Global",
"routeId": "GL",
"name": "Global location",
"metadata": {
"title1": "value1",
"title2": "value2"
}
},
"comments": [
{
"id": "a6ea46d9-17a3-45a0-97f1-f88db03d5e6d",
"displayType": "Other",
"type": "Other",
"value": "Some Comment Value",
"imageUrl": "",
"externalLinkUrl": null,
"externalLinkTitle": null,
"taskTemplateId": "d179f588-26fc-441f-af26-7ef395ae6374",
"sectionTemplateId": null
}
]
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DispatchData |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Clear task in specific flow
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/tasks/{taskId}/clear \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
PUT /app/flows/flows/{flowId}/tasks/{taskId}/clear 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/flows/flows/{flowId}/tasks/{taskId}/clear',
{
method: 'PUT',
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('PUT','/app/flows/flows/{flowId}/tasks/{taskId}/clear', 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/flows/flows/{flowId}/tasks/{taskId}/clear";
var result = await PutAsync(id, null, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, undefined 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(undefined 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/flows/flows/{flowId}/tasks/{taskId}/clear");
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/flows/flows/{flowId}/tasks/{taskId}/clear
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | path | string(uuid) | true | Task ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Create comments on task in a specific flow
Code samples
# You can also use wget
curl -X POST /app/flows/flows/{flowId}/tasks/{taskId}/comments \
-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/flows/flows/{flowId}/tasks/{taskId}/comments HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/tasks/{taskId}/comments',
{
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/flows/flows/{flowId}/tasks/{taskId}/comments', 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/flows/flows/{flowId}/tasks/{taskId}/comments";
string json = @"{
""value"": ""string"",
""commentType"": ""string"",
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
},
""externalLinkUrl"": ""string"",
""externalLinkTitle"": ""string"",
""picture"": [
0
],
""base64Picture"": ""string"",
""urlPicture"": ""string"",
""fileName"": null
}";
CommentModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(CommentModel 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(CommentModel 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/flows/flows/{flowId}/tasks/{taskId}/comments");
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/flows/flows/{flowId}/tasks/{taskId}/comments
Body parameter
{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | path | string(uuid) | true | Task ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | CommentModel | true | CommentModel object |
Example responses
200 Response
{
"id": "565c6897-492a-4eab-ae34-ea6e2821b000",
"value": "Comment text",
"checklistId": "f25e291d-fb16-4b38-97fd-5773b7c439de",
"personName": "Full Name",
"personPosition": "Capitan",
"personInitials": "FNA",
"timeString": "2022-06-09T10:08:40.7736842Z",
"discardReason": null,
"commentType": "Other",
"picture": null,
"pictureUrl": null,
"canceledPersonName": null,
"canceledPersonPosition": null,
"canceledPersonInitials": "",
"externalLinkUrl": "http://domain.com/id",
"externalLinkTitle": null,
"taskTemplateId": "68501c2e-fddf-4cf5-b16f-10e4d4104fc3",
"sectionTemplateId": null,
"isOverride": false,
"isCanceled": false
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Comment |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Creates comments for specific tasks in a specific flow
Code samples
# You can also use wget
curl -X POST /app/flows/flows/{flowId}/tasks/{dataId}/comments \
-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/flows/flows/{flowId}/tasks/{dataId}/comments HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/tasks/{dataId}/comments',
{
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/flows/flows/{flowId}/tasks/{dataId}/comments', 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/flows/flows/{flowId}/tasks/{dataId}/comments";
string json = @"{
""value"": ""string"",
""commentType"": ""string"",
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
},
""externalLinkUrl"": ""string"",
""externalLinkTitle"": ""string"",
""picture"": [
0
],
""base64Picture"": ""string"",
""urlPicture"": ""string"",
""fileName"": null
}";
CommentModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(CommentModel 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(CommentModel 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/flows/flows/{flowId}/tasks/{dataId}/comments");
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/flows/flows/{flowId}/tasks/{dataId}/comments
Body parameter
{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| dataId | path | string | true | Data ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | CommentModel | true | CommentModel object |
Example responses
200 Response
{
"id": "565c6897-492a-4eab-ae34-ea6e2821b000",
"value": "Comment text",
"checklistId": "f25e291d-fb16-4b38-97fd-5773b7c439de",
"personName": "Full Name",
"personPosition": "Capitan",
"personInitials": "FNA",
"timeString": "2022-06-09T10:08:40.7749511Z",
"discardReason": null,
"commentType": "Other",
"picture": null,
"pictureUrl": null,
"canceledPersonName": null,
"canceledPersonPosition": null,
"canceledPersonInitials": "",
"externalLinkUrl": "http://domain.com/id",
"externalLinkTitle": null,
"taskTemplateId": "68501c2e-fddf-4cf5-b16f-10e4d4104fc3",
"sectionTemplateId": null,
"isOverride": false,
"isCanceled": false
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Comment |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Override task in a specific flow
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/tasks/{taskId}/override \
-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/flows/flows/{flowId}/tasks/{taskId}/override HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null,
"discardReason": "string"
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/tasks/{taskId}/override',
{
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/flows/flows/{flowId}/tasks/{taskId}/override', 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/flows/flows/{flowId}/tasks/{taskId}/override";
string json = @"{
""value"": ""string"",
""commentType"": ""string"",
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
},
""externalLinkUrl"": ""string"",
""externalLinkTitle"": ""string"",
""picture"": [
0
],
""base64Picture"": ""string"",
""urlPicture"": ""string"",
""fileName"": null,
""discardReason"": ""string""
}";
OverrideItemModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, OverrideItemModel 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(OverrideItemModel 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/flows/flows/{flowId}/tasks/{taskId}/override");
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/flows/flows/{flowId}/tasks/{taskId}/override
Body parameter
{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null,
"discardReason": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | path | string(uuid) | true | Task ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | OverrideItemModel | true | OverrideItemModel object |
Example responses
200 Response
{
"id": "565c6897-492a-4eab-ae34-ea6e2821b000",
"value": "Comment text",
"checklistId": "f25e291d-fb16-4b38-97fd-5773b7c439de",
"personName": "Full Name",
"personPosition": "Capitan",
"personInitials": "FNA",
"timeString": "2022-06-09T10:08:40.7768547Z",
"discardReason": null,
"commentType": "Other",
"picture": null,
"pictureUrl": null,
"canceledPersonName": null,
"canceledPersonPosition": null,
"canceledPersonInitials": "",
"externalLinkUrl": "http://domain.com/id",
"externalLinkTitle": null,
"taskTemplateId": "68501c2e-fddf-4cf5-b16f-10e4d4104fc3",
"sectionTemplateId": null,
"isOverride": false,
"isCanceled": false
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Comment |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Modify information on specific task
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/tasks/{dataId}?taskType=0 \
-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/flows/flows/{flowId}/tasks/{dataId}?taskType=0 HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"value": null,
"source": null,
"time": null,
"shouldConfirm": false,
"overrideExistingValue": true,
"appendValue": false
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/tasks/{dataId}?taskType=0',
{
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/flows/flows/{flowId}/tasks/{dataId}', 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/flows/flows/{flowId}/tasks/{dataId}";
string json = @"{
""value"": null,
""source"": null,
""time"": null,
""shouldConfirm"": false,
""overrideExistingValue"": true,
""appendValue"": false
}";
TaskValueApiModelByDataId content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, TaskValueApiModelByDataId 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(TaskValueApiModelByDataId 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/flows/flows/{flowId}/tasks/{dataId}?taskType=0");
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/flows/flows/{flowId}/tasks/{dataId}
Body parameter
{
"value": null,
"source": null,
"time": null,
"shouldConfirm": false,
"overrideExistingValue": true,
"appendValue": false
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| dataId | path | string | true | Data ID |
| taskType | query | TaskType | true | TaskType |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | TaskValueApiModelByDataId | true | TaskValueApiModelByDataId object |
Enumerated Values
| Parameter | Value |
|---|---|
| taskType | 0 |
| taskType | 1 |
| taskType | 2 |
| taskType | 3 |
| taskType | 4 |
| taskType | 5 |
| taskType | 6 |
| taskType | 7 |
| taskType | 8 |
| taskType | 9 |
| taskType | 10 |
| taskType | 11 |
| taskType | 12 |
| taskType | 13 |
| taskType | 14 |
| taskType | 15 |
| taskType | 16 |
| taskType | 17 |
| taskType | 18 |
| taskType | 19 |
| taskType | 20 |
| taskType | 21 |
Example responses
200 Response
[
{
"checklist": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"refId": "string",
"state": 0,
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"templateName": "string",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"items": 0,
"itemsFinished": 0,
"metadata": {
"property1": "string",
"property2": "string"
},
"history": {
"histories": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"action": 0,
"isDispatched": true,
"personName": "string",
"_Action": 0,
"object": 0
}
],
"created": "string",
"started": "string",
"lastUpdate": "string",
"finished": "string"
}
},
"task": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"tags": "string",
"analyticTags": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
},
"section": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"event": {
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"name": "string",
"action": 0,
"item": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"position": "string",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"impersonatedByUserId": "5dda35a5-d13e-4984-920c-ef0c60163370",
"comment": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
},
"tenant": "string"
},
"tasks": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
],
"location": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": 0,
"typeName": "string",
"imoNumber": "string",
"mmsiNumber": "string",
"globalId": "string",
"routeId": "string",
"name": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
},
"comments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
}
]
}
]
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [DispatchData] | false | none | none |
| » checklist | ChecklistData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| »» refId | string¦null | false | none | none |
| »» state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| »» templateId | string(uuid) | false | none | none |
| »» templateName | string¦null | false | none | none |
| »» locationId | string(uuid)¦null | false | none | none |
| »» items | integer(int32) | false | none | none |
| »» itemsFinished | integer(int32) | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| »» history | ChecklistHistoryData | false | none | none |
| »»» histories | [HistorySmall]¦null | false | none | none |
| »»»» id | string(uuid) | false | none | none |
| »»»» time | string(date-time) | false | none | none |
| »»»» timeString | string¦null | false | read-only | none |
| »»»» action | HistoryAction(int32) | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| »»»» isDispatched | boolean | false | none | none |
| »»»» personName | string¦null | false | none | none |
| »»»» _Action | HistoryAction(int32) | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| »»»» object | HistoryObject(int32) | false | none | Checklist = 0 Task = 1 Section = 2 ChecklistTemplate = 10 SectionTemplate = 11 TaskTemplate = 12 |
| »»» created | string¦null | false | read-only | none |
| »»» started | string¦null | false | read-only | none |
| »»» lastUpdate | string¦null | false | read-only | none |
| »»» finished | string¦null | false | read-only | none |
| » task | TaskData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| »» secondaryTitle | string¦null | false | none | none |
| »» state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| »» tags | string¦null | false | none | none |
| »» analyticTags | string¦null | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| » section | SectionData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| » event | DispatchEvent | false | none | none |
| »» time | string(date-time) | false | none | none |
| »» timeString | string¦null | false | read-only | none |
| »» timezone | string¦null | false | none | none |
| »» name | string¦null | false | none | none |
| »» action | DispatchAction(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 |
| »» item | DispatchItem(int32) | false | none | Task = 0 Section = 1 Checklist = 2 |
| »» control | TaskControlData | false | none | none |
| »»» value | string¦null | false | none | none |
| »»» key | string¦null | false | none | none |
| »»» valueTitle | string¦null | false | none | none |
| »»» displayValue | string¦null | false | none | none |
| »»» items | [TaskControlItemData]¦null | false | none | none |
| »»»» id | string(uuid) | false | none | none |
| »»»» values | [TaskControlItemValueData]¦null | false | none | none |
| »»»»» title | string¦null | false | none | none |
| »»»»» value | string¦null | false | none | none |
| »»»»» displayValue | string¦null | false | none | none |
| »»»»» type | TaskType(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 |
| »»»»» typeString | string¦null | false | read-only | none |
| »»»»» dataId | string¦null | false | none | none |
| »»»» time | string(date-time) | false | none | none |
| »»»» timeString | string¦null | false | read-only | none |
| »»» type | TaskType(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 |
| »»» typeString | string¦null | false | read-only | none |
| »»» dataRegister | DataRegisterData | false | none | none |
| »»»» listId | string¦null | false | none | none |
| »»»» listKey | string¦null | false | none | none |
| »»» text | string¦null | false | none | none |
| »»» dataId | string¦null | false | none | none |
| »» control2 | TaskControlData | false | none | none |
| »» geoposition | Geoposition | false | none | none |
| »»» latitude | number(double)¦null | false | none | none |
| »»» longitude | number(double)¦null | false | none | none |
| »» userId | string(uuid)¦null | false | none | none |
| »» position | string¦null | false | none | none |
| »» positionId | string(uuid)¦null | false | none | none |
| »» impersonatedByUserId | string(uuid)¦null | false | none | none |
| »» comment | CommentData | false | none | none |
| »»» id | string(uuid) | false | none | none |
| »»» displayType | string¦null | false | none | none |
| »»» type | string¦null | false | none | none |
| »»» value | string¦null | false | none | none |
| »»» imageUrl | string¦null | false | none | none |
| »»» externalLinkUrl | string¦null | false | none | none |
| »»» externalLinkTitle | string¦null | false | none | none |
| »»» taskTemplateId | string(uuid)¦null | false | none | none |
| »»» sectionTemplateId | string(uuid)¦null | false | none | none |
| »» tenant | string¦null | false | none | none |
| » tasks | [TaskDetailsData]¦null | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» name | string¦null | false | none | none |
| »» secondaryTitle | string¦null | false | none | none |
| »» state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| »» control | TaskControlData | false | none | none |
| »» control2 | TaskControlData | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| »» geoposition | Geoposition | false | none | none |
| »» time | string(date-time)¦null | false | none | none |
| »» timeString | string¦null | false | read-only | none |
| »» timezone | string¦null | false | none | none |
| »» userId | string(uuid)¦null | false | none | none |
| » location | LocationData | false | none | none |
| »» id | string(uuid) | false | none | none |
| »» type | LocationType(int32) | false | none | Office = 0 Vessel = 1 Truck = 2 |
| »» typeName | string¦null | false | read-only | none |
| »» imoNumber | string¦null | false | none | none |
| »» mmsiNumber | string¦null | false | none | none |
| »» globalId | string¦null | false | none | none |
| »» routeId | string¦null | false | none | none |
| »» name | string¦null | false | none | none |
| »» metadata | object¦null | false | none | none |
| »»» additionalProperties | string | false | none | none |
| » comments | [CommentData]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| action | 0 |
| action | 1 |
| action | 2 |
| action | 3 |
| action | 4 |
| action | 5 |
| action | 6 |
| action | 7 |
| action | 8 |
| action | 9 |
| action | 10 |
| action | 11 |
| action | 12 |
| _Action | 0 |
| _Action | 1 |
| _Action | 2 |
| _Action | 3 |
| _Action | 4 |
| _Action | 5 |
| _Action | 6 |
| _Action | 7 |
| _Action | 8 |
| _Action | 9 |
| _Action | 10 |
| _Action | 11 |
| _Action | 12 |
| object | 0 |
| object | 1 |
| object | 2 |
| object | 10 |
| object | 11 |
| object | 12 |
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| action | 0 |
| action | 1 |
| action | 2 |
| action | 3 |
| action | 4 |
| action | 5 |
| action | 10 |
| action | 11 |
| action | 12 |
| action | 13 |
| action | 14 |
| action | 15 |
| action | 20 |
| action | 21 |
| action | 22 |
| action | 23 |
| action | 24 |
| action | 25 |
| action | 26 |
| action | 100 |
| item | 0 |
| item | 1 |
| item | 2 |
| type | 0 |
| type | 1 |
| type | 2 |
| type | 3 |
| type | 4 |
| type | 5 |
| type | 6 |
| type | 7 |
| type | 8 |
| type | 9 |
| type | 10 |
| type | 11 |
| type | 12 |
| type | 13 |
| type | 14 |
| type | 15 |
| type | 16 |
| type | 17 |
| type | 18 |
| type | 19 |
| type | 20 |
| type | 21 |
| type | 0 |
| type | 1 |
| type | 2 |
| type | 3 |
| type | 4 |
| type | 5 |
| type | 6 |
| type | 7 |
| type | 8 |
| type | 9 |
| type | 10 |
| type | 11 |
| type | 12 |
| type | 13 |
| type | 14 |
| type | 15 |
| type | 16 |
| type | 17 |
| type | 18 |
| type | 19 |
| type | 20 |
| type | 21 |
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| type | 0 |
| type | 1 |
| type | 2 |
Get information about a specific task in a specified flow
Code samples
# You can also use wget
curl -X GET /app/flows/flows/{flowId}/tasks/{dataId} \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows/{flowId}/tasks/{dataId} 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/flows/flows/{flowId}/tasks/{dataId}',
{
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/flows/flows/{flowId}/tasks/{dataId}', 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/flows/flows/{flowId}/tasks/{dataId}";
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/flows/flows/{flowId}/tasks/{dataId}");
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/flows/flows/{flowId}/tasks/{dataId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| dataId | path | string | true | Data ID |
| taskType | query | TaskType | false | TaskType |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Enumerated Values
| Parameter | Value |
|---|---|
| taskType | 0 |
| taskType | 1 |
| taskType | 2 |
| taskType | 3 |
| taskType | 4 |
| taskType | 5 |
| taskType | 6 |
| taskType | 7 |
| taskType | 8 |
| taskType | 9 |
| taskType | 10 |
| taskType | 11 |
| taskType | 12 |
| taskType | 13 |
| taskType | 14 |
| taskType | 15 |
| taskType | 16 |
| taskType | 17 |
| taskType | 18 |
| taskType | 19 |
| taskType | 20 |
| taskType | 21 |
Example responses
200 Response
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
]
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [TaskDetailsData] | false | none | none |
| » id | string(uuid) | false | none | none |
| » name | string¦null | false | none | none |
| » secondaryTitle | string¦null | false | none | none |
| » state | DispatchObjectState(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| » control | TaskControlData | false | none | none |
| »» value | string¦null | false | none | none |
| »» key | string¦null | false | none | none |
| »» valueTitle | string¦null | false | none | none |
| »» displayValue | string¦null | false | none | none |
| »» items | [TaskControlItemData]¦null | false | none | none |
| »»» id | string(uuid) | false | none | none |
| »»» values | [TaskControlItemValueData]¦null | false | none | none |
| »»»» title | string¦null | false | none | none |
| »»»» value | string¦null | false | none | none |
| »»»» displayValue | string¦null | false | none | none |
| »»»» type | TaskType(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 |
| »»»» typeString | string¦null | false | read-only | none |
| »»»» dataId | string¦null | false | none | none |
| »»» time | string(date-time) | false | none | none |
| »»» timeString | string¦null | false | read-only | none |
| »» type | TaskType(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 |
| »» typeString | string¦null | false | read-only | none |
| »» dataRegister | DataRegisterData | false | none | none |
| »»» listId | string¦null | false | none | none |
| »»» listKey | string¦null | false | none | none |
| »» text | string¦null | false | none | none |
| »» dataId | string¦null | false | none | none |
| » control2 | TaskControlData | false | none | none |
| » metadata | object¦null | false | none | none |
| »» additionalProperties | string | false | none | none |
| » geoposition | Geoposition | false | none | none |
| »» latitude | number(double)¦null | false | none | none |
| »» longitude | number(double)¦null | false | none | none |
| » time | string(date-time)¦null | false | none | none |
| » timeString | string¦null | false | read-only | none |
| » timezone | string¦null | false | none | none |
| » userId | string(uuid)¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| state | 0 |
| state | 1 |
| state | 2 |
| state | 3 |
| type | 0 |
| type | 1 |
| type | 2 |
| type | 3 |
| type | 4 |
| type | 5 |
| type | 6 |
| type | 7 |
| type | 8 |
| type | 9 |
| type | 10 |
| type | 11 |
| type | 12 |
| type | 13 |
| type | 14 |
| type | 15 |
| type | 16 |
| type | 17 |
| type | 18 |
| type | 19 |
| type | 20 |
| type | 21 |
| type | 0 |
| type | 1 |
| type | 2 |
| type | 3 |
| type | 4 |
| type | 5 |
| type | 6 |
| type | 7 |
| type | 8 |
| type | 9 |
| type | 10 |
| type | 11 |
| type | 12 |
| type | 13 |
| type | 14 |
| type | 15 |
| type | 16 |
| type | 17 |
| type | 18 |
| type | 19 |
| type | 20 |
| type | 21 |
Get value of a specific task
Code samples
# You can also use wget
curl -X GET /app/flows/flows/{flowId}/tasks/{taskId}/value \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows/{flowId}/tasks/{taskId}/value 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/flows/flows/{flowId}/tasks/{taskId}/value',
{
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/flows/flows/{flowId}/tasks/{taskId}/value', 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/flows/flows/{flowId}/tasks/{taskId}/value";
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/flows/flows/{flowId}/tasks/{taskId}/value");
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/flows/flows/{flowId}/tasks/{taskId}/value
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | path | string(uuid) | true | Task ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TaskDetailsData |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Get value of a specific task by data ID
Code samples
# You can also use wget
curl -X GET /app/flows/flows/{flowId}/tasks/by-data-id/{dataId}/value \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows/{flowId}/tasks/by-data-id/{dataId}/value 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/flows/flows/{flowId}/tasks/by-data-id/{dataId}/value',
{
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/flows/flows/{flowId}/tasks/by-data-id/{dataId}/value', 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/flows/flows/{flowId}/tasks/by-data-id/{dataId}/value";
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/flows/flows/{flowId}/tasks/by-data-id/{dataId}/value");
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/flows/flows/{flowId}/tasks/by-data-id/{dataId}/value
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | none |
| dataId | path | string | true | 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",
"secondaryTitle": "string",
"state": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TaskDetailsData |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Modify rick text for a specific task
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/tasks/{taskId}/richText \
-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/flows/flows/{flowId}/tasks/{taskId}/richText HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"name": "string",
"secondaryTitle": "string",
"content": "string",
"isMarkdown": false
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/tasks/{taskId}/richText',
{
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/flows/flows/{flowId}/tasks/{taskId}/richText', 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/flows/flows/{flowId}/tasks/{taskId}/richText";
string json = @"{
""name"": ""string"",
""secondaryTitle"": ""string"",
""content"": ""string"",
""isMarkdown"": false
}";
UpdateRichTextControlApiModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, UpdateRichTextControlApiModel 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(UpdateRichTextControlApiModel 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/flows/flows/{flowId}/tasks/{taskId}/richText");
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/flows/flows/{flowId}/tasks/{taskId}/richText
Body parameter
{
"name": "string",
"secondaryTitle": "string",
"content": "string",
"isMarkdown": false
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| taskId | path | string(uuid) | true | Task ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | UpdateRichTextControlApiModel | true | UpdateRichTextControlApiModel object |
Example responses
200 Response
{
"message": "Result message"
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApiMessage |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
List sections by ID for a specific flow
Code samples
# You can also use wget
curl -X GET /app/flows/flows/{flowId}/sections/{sectionId} \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/flows/{flowId}/sections/{sectionId} 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/flows/flows/{flowId}/sections/{sectionId}',
{
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/flows/flows/{flowId}/sections/{sectionId}', 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/flows/flows/{flowId}/sections/{sectionId}";
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/flows/flows/{flowId}/sections/{sectionId}");
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/flows/flows/{flowId}/sections/{sectionId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| sectionId | path | string(uuid) | true | Section ID |
| includeTasks | query | boolean | false | boolean |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
Example responses
200 Response
{
"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"
}
]
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SectionTemplate |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Create section in a specific flow
Code samples
# You can also use wget
curl -X POST /app/flows/flows/{flowId}/section \
-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/flows/flows/{flowId}/section HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"section": {
"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"
}
]
},
"previousSectionId": null
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/section',
{
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/flows/flows/{flowId}/section', 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/flows/flows/{flowId}/section";
string json = @"{
""section"": {
""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""
}
]
},
""previousSectionId"": null
}";
NewSectionApiModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(NewSectionApiModel 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(NewSectionApiModel 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/flows/flows/{flowId}/section");
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/flows/flows/{flowId}/section
Body parameter
{
"section": {
"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"
}
]
},
"previousSectionId": null
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | NewSectionApiModel | true | NewSectionApiModel object |
Example responses
200 Response
{
"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"
}
]
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
409 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SectionTemplate |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
| 409 | Conflict | Conflict | ApiMessage |
Override section by ID for a specific flow
Code samples
# You can also use wget
curl -X PUT /app/flows/flows/{flowId}/sections/{sectionId}/override \
-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/flows/flows/{flowId}/sections/{sectionId}/override HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null,
"discardReason": "string"
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/sections/{sectionId}/override',
{
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/flows/flows/{flowId}/sections/{sectionId}/override', 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/flows/flows/{flowId}/sections/{sectionId}/override";
string json = @"{
""value"": ""string"",
""commentType"": ""string"",
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
},
""externalLinkUrl"": ""string"",
""externalLinkTitle"": ""string"",
""picture"": [
0
],
""base64Picture"": ""string"",
""urlPicture"": ""string"",
""fileName"": null,
""discardReason"": ""string""
}";
OverrideItemModel content = JsonConvert.DeserializeObject(json);
var result = await PutAsync(id, content, url);
}
/// Performs a PUT Request
public async Task PutAsync(int id, OverrideItemModel 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(OverrideItemModel 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/flows/flows/{flowId}/sections/{sectionId}/override");
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/flows/flows/{flowId}/sections/{sectionId}/override
Body parameter
{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null,
"discardReason": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| sectionId | path | string(uuid) | true | Section ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | OverrideItemModel | true | OverrideItemModel object |
Example responses
200 Response
{
"id": "565c6897-492a-4eab-ae34-ea6e2821b000",
"value": "Comment text",
"checklistId": "f25e291d-fb16-4b38-97fd-5773b7c439de",
"personName": "Full Name",
"personPosition": "Capitan",
"personInitials": "FNA",
"timeString": "2022-06-09T10:08:40.7880158Z",
"discardReason": null,
"commentType": "Other",
"picture": null,
"pictureUrl": null,
"canceledPersonName": null,
"canceledPersonPosition": null,
"canceledPersonInitials": "",
"externalLinkUrl": "http://domain.com/id",
"externalLinkTitle": null,
"taskTemplateId": "68501c2e-fddf-4cf5-b16f-10e4d4104fc3",
"sectionTemplateId": null,
"isOverride": false,
"isCanceled": false
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Comment |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Create a comment in the section by ID for a specific flow
Code samples
# You can also use wget
curl -X POST /app/flows/flows/{flowId}/sections/{sectionId}/comments \
-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/flows/flows/{flowId}/sections/{sectionId}/comments HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
api-version: string
const inputBody = '{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null
}';
const headers = {
'Content-Type':'application/json-patch+json',
'Accept':'application/json',
'api-version':'string',
'Tenant':'API_KEY',
'Authorization':'API_KEY'
};
fetch('/app/flows/flows/{flowId}/sections/{sectionId}/comments',
{
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/flows/flows/{flowId}/sections/{sectionId}/comments', 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/flows/flows/{flowId}/sections/{sectionId}/comments";
string json = @"{
""value"": ""string"",
""commentType"": ""string"",
""metadata"": {
""property1"": ""string"",
""property2"": ""string""
},
""externalLinkUrl"": ""string"",
""externalLinkTitle"": ""string"",
""picture"": [
0
],
""base64Picture"": ""string"",
""urlPicture"": ""string"",
""fileName"": null
}";
CommentModel content = JsonConvert.DeserializeObject(json);
await PostAsync(content, url);
}
/// Performs a POST Request
public async Task PostAsync(CommentModel 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(CommentModel 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/flows/flows/{flowId}/sections/{sectionId}/comments");
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/flows/flows/{flowId}/sections/{sectionId}/comments
Body parameter
{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| flowId | path | string(uuid) | true | Flow ID |
| sectionId | path | string(uuid) | true | Section ID |
| api-version | query | string | false | none |
| api-version | header | string | false | none |
| body | body | CommentModel | true | CommentModel object |
Example responses
200 Response
{
"id": "565c6897-492a-4eab-ae34-ea6e2821b000",
"value": "Comment text",
"checklistId": "f25e291d-fb16-4b38-97fd-5773b7c439de",
"personName": "Full Name",
"personPosition": "Capitan",
"personInitials": "FNA",
"timeString": "2022-06-09T10:08:40.7895214Z",
"discardReason": null,
"commentType": "Other",
"picture": null,
"pictureUrl": null,
"canceledPersonName": null,
"canceledPersonPosition": null,
"canceledPersonInitials": "",
"externalLinkUrl": "http://domain.com/id",
"externalLinkTitle": null,
"taskTemplateId": "68501c2e-fddf-4cf5-b16f-10e4d4104fc3",
"sectionTemplateId": null,
"isOverride": false,
"isCanceled": false
}
401 Response
{
"message": "Result message"
}
404 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Comment |
| 401 | Unauthorized | Unauthorized | ApiMessage |
| 404 | Not Found | Not Found | ApiMessage |
Echo
Code samples
# You can also use wget
curl -X GET /app/flows/echo \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/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/flows/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/flows/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/flows/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/flows/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/flows/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/flows/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/flows/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/flows/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/flows/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/flows/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/flows/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/flows/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": "9793494ecaf7cb067838eb254da10da946e26d0c3f64f7cea0c3e94a7ef323aa"
}
401 Response
{
"message": "Result message"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SecurityKey |
| 401 | Unauthorized | Unauthorized | ApiMessage |
Process Checklists polling
Code samples
# You can also use wget
curl -X GET /app/flows/processChecklistsPolling \
-H 'Accept: application/json' \
-H 'api-version: string' \
-H 'Tenant: API_KEY' \
-H 'Authorization: API_KEY'
GET /app/flows/processChecklistsPolling 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/flows/processChecklistsPolling',
{
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/flows/processChecklistsPolling', 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/flows/processChecklistsPolling";
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/flows/processChecklistsPolling");
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/flows/processChecklistsPolling
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 |
Schemas
ApiMessage
{
"message": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| message | string¦null | false | none | none |
ChecklistData
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"refId": "string",
"state": 0,
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"templateName": "string",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"items": 0,
"itemsFinished": 0,
"metadata": {
"property1": "string",
"property2": "string"
},
"history": {
"histories": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"action": 0,
"isDispatched": true,
"personName": "string",
"_Action": 0,
"object": 0
}
],
"created": "string",
"started": "string",
"lastUpdate": "string",
"finished": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| refId | string¦null | false | none | none |
| state | DispatchObjectState | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| templateId | string(uuid) | false | none | none |
| templateName | string¦null | false | none | none |
| locationId | string(uuid)¦null | false | none | none |
| items | integer(int32) | false | none | none |
| itemsFinished | integer(int32) | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
| history | ChecklistHistoryData | false | none | none |
ChecklistHistoryData
{
"histories": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"action": 0,
"isDispatched": true,
"personName": "string",
"_Action": 0,
"object": 0
}
],
"created": "string",
"started": "string",
"lastUpdate": "string",
"finished": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| histories | [HistorySmall]¦null | false | none | none |
| created | string¦null | false | read-only | none |
| started | string¦null | false | read-only | none |
| lastUpdate | string¦null | false | read-only | none |
| finished | string¦null | false | read-only | none |
ChecklistMetadataApiModel
{
"metadata": {
"property1": "string",
"property2": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | object | true | none | none |
| » additionalProperties | string | false | none | none |
ChecklistShortInfo
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"metadata": {
"property1": "string",
"property2": "string"
},
"refId": "string",
"history": {
"histories": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"action": 0,
"isDispatched": true,
"personName": "string",
"_Action": 0,
"object": 0
}
],
"created": "string",
"started": "string",
"lastUpdate": "string",
"finished": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| locationId | string(uuid) | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
| refId | string¦null | false | none | none |
| history | ChecklistHistoryData | false | none | none |
Comment
{
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed",
"isOverride": true,
"isCanceled": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"value": "string",
"checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
"personName": "string",
"personPosition": "string",
"personInitials": "string",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"discardReason": "string",
"commentType": "string",
"picture": "string",
"pictureUrl": "string",
"canceledPersonName": "string",
"canceledPersonPosition": "string",
"canceledPersonInitials": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskTemplateId | string(uuid)¦null | false | none | none |
| sectionTemplateId | string(uuid)¦null | false | none | none |
| isOverride | boolean | false | none | none |
| isCanceled | boolean | false | none | none |
| id | string(uuid) | false | none | none |
| value | string¦null | false | none | none |
| checklistId | string(uuid) | false | none | none |
| personName | string¦null | false | none | none |
| personPosition | string¦null | false | none | none |
| personInitials | string¦null | false | read-only | none |
| time | string(date-time) | false | none | none |
| timeString | string¦null | false | read-only | none |
| discardReason | string¦null | false | none | none |
| commentType | string¦null | false | none | none |
| picture | string¦null | false | none | none |
| pictureUrl | string¦null | false | none | none |
| canceledPersonName | string¦null | false | none | none |
| canceledPersonPosition | string¦null | false | none | none |
| canceledPersonInitials | string¦null | false | read-only | none |
| externalLinkUrl | string¦null | false | none | none |
| externalLinkTitle | string¦null | false | none | none |
CommentData
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| displayType | string¦null | false | none | none |
| type | string¦null | false | none | none |
| value | string¦null | false | none | none |
| imageUrl | string¦null | false | none | none |
| externalLinkUrl | string¦null | false | none | none |
| externalLinkTitle | string¦null | false | none | none |
| taskTemplateId | string(uuid)¦null | false | none | none |
| sectionTemplateId | string(uuid)¦null | false | none | none |
CommentModel
{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string¦null | false | none | none |
| commentType | string¦null | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
| externalLinkUrl | string¦null | false | none | none |
| externalLinkTitle | string¦null | false | none | none |
| picture | [integer]¦null | false | none | One of Picture, Base64Picture or UrlPicture should be used |
| base64Picture | string¦null | false | none | One of Picture, Base64Picture or UrlPicture should be used |
| urlPicture | string¦null | false | none | One of Picture, Base64Picture or UrlPicture should be used |
| fileName | string¦null | false | none | Optional, used to get file type (.jpg is default) |
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 |
ConfirmTaskApiModel
{
"source": null,
"time": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | string¦null | false | none | none |
| time | string(date-time)¦null | 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 |
DataRegisterData
{
"listId": "string",
"listKey": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| listId | string¦null | false | none | none |
| listKey | string¦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 |
DiscardChecklistApiModel
{
"comment": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| comment | string | true | 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 |
DispatchData
{
"checklist": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"refId": "string",
"state": 0,
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"templateName": "string",
"locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
"items": 0,
"itemsFinished": 0,
"metadata": {
"property1": "string",
"property2": "string"
},
"history": {
"histories": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"action": 0,
"isDispatched": true,
"personName": "string",
"_Action": 0,
"object": 0
}
],
"created": "string",
"started": "string",
"lastUpdate": "string",
"finished": "string"
}
},
"task": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"tags": "string",
"analyticTags": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
},
"section": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"event": {
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"name": "string",
"action": 0,
"item": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"position": "string",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"impersonatedByUserId": "5dda35a5-d13e-4984-920c-ef0c60163370",
"comment": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
},
"tenant": "string"
},
"tasks": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
],
"location": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": 0,
"typeName": "string",
"imoNumber": "string",
"mmsiNumber": "string",
"globalId": "string",
"routeId": "string",
"name": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
},
"comments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| checklist | ChecklistData | false | none | none |
| task | TaskData | false | none | none |
| section | SectionData | false | none | none |
| event | DispatchEvent | false | none | none |
| tasks | [TaskDetailsData]¦null | false | none | none |
| location | LocationData | false | none | none |
| comments | [CommentData]¦null | false | none | none |
DispatchEvent
{
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"name": "string",
"action": 0,
"item": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"position": "string",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"impersonatedByUserId": "5dda35a5-d13e-4984-920c-ef0c60163370",
"comment": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayType": "string",
"type": "string",
"value": "string",
"imageUrl": "string",
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"taskTemplateId": "0bace236-fe21-4c91-8146-4a71f4b64090",
"sectionTemplateId": "e7eee275-e1e3-40be-a9ef-28af7c5b89ed"
},
"tenant": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| time | string(date-time) | false | none | none |
| timeString | string¦null | false | read-only | none |
| timezone | string¦null | false | none | none |
| name | string¦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 |
| item | DispatchItem | false | none | Task = 0 Section = 1 Checklist = 2 |
| control | TaskControlData | false | none | none |
| control2 | TaskControlData | false | none | none |
| geoposition | Geoposition | false | none | none |
| userId | string(uuid)¦null | false | none | none |
| position | string¦null | false | none | none |
| positionId | string(uuid)¦null | false | none | none |
| impersonatedByUserId | string(uuid)¦null | false | none | none |
| comment | CommentData | false | none | none |
| tenant | string¦null | false | none | none |
DispatchItem
0
Task = 0
Section = 1
Checklist = 2
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Task = 0 Section = 1 Checklist = 2 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
DispatchObjectState
0
Active = 0
Finished = 1
Overriden = 2
Discarded = 3
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
| anonymous | 3 |
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 |
ExternalChecklistData
{
"email": "string",
"fullName": "string",
"phone": null,
"sendEmail": false,
"expireDays": 30
}
Used to create external token
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| string | true | none | none | |
| fullName | string | true | none | none |
| phone | string¦null | false | none | none |
| sendEmail | boolean | false | none | none |
| expireDays | integer(int32) | false | none | none |
File
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": {
"appPath": "string",
"hasSmallImage": true,
"value": 0,
"name": "string"
},
"objectId": "e39ea5f2-2188-47f8-add0-f1976630af5e",
"checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
"url": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| type | FileType | false | none | none |
| objectId | string(uuid) | false | none | none |
| checklistId | string(uuid)¦null | false | none | none |
| url | string¦null | false | none | none |
FileApiModel
{
"content": [
0
],
"base64Content": "string",
"urlContent": "string",
"fileName": null
}
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 |
| fileName | string¦null | false | none | Optional, used to get file type (.jpg is default) |
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 |
FileType
{
"appPath": "string",
"hasSmallImage": true,
"value": 0,
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| appPath | string¦null | false | read-only | none |
| hasSmallImage | boolean | false | read-only | none |
| value | integer(int32) | false | read-only | none |
| name | string¦null | false | read-only | none |
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 |
Geoposition
{
"latitude": 0,
"longitude": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| latitude | number(double)¦null | false | none | none |
| longitude | number(double)¦null | false | none | none |
HistoryAction
0
Create = 0
Edit = 1
Remove = 2
OrderInnerObjects = 3
Finish = 4
Start = 5
Override = 6
NewRevision = 7
Comment = 8
CommentComplete = 9
Revert = 10
Approve = 11
Recover = 12
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
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 |
HistoryObject
0
Checklist = 0
Task = 1
Section = 2
ChecklistTemplate = 10
SectionTemplate = 11
TaskTemplate = 12
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Checklist = 0 Task = 1 Section = 2 ChecklistTemplate = 10 SectionTemplate = 11 TaskTemplate = 12 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
| anonymous | 10 |
| anonymous | 11 |
| anonymous | 12 |
HistorySmall
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"action": 0,
"isDispatched": true,
"personName": "string",
"_Action": 0,
"object": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| time | string(date-time) | false | none | none |
| timeString | string¦null | false | read-only | none |
| action | HistoryAction | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| isDispatched | boolean | false | none | none |
| personName | string¦null | false | none | none |
| _Action | HistoryAction | false | none | Create = 0 Edit = 1 Remove = 2 OrderInnerObjects = 3 Finish = 4 Start = 5 Override = 6 NewRevision = 7 Comment = 8 CommentComplete = 9 Revert = 10 Approve = 11 Recover = 12 |
| object | HistoryObject | false | none | Checklist = 0 Task = 1 Section = 2 ChecklistTemplate = 10 SectionTemplate = 11 TaskTemplate = 12 |
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 |
ListTaskValue
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
"string"
],
"time": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| values | [string]¦null | false | none | none |
| time | string(date-time) | false | none | none |
LocationData
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": 0,
"typeName": "string",
"imoNumber": "string",
"mmsiNumber": "string",
"globalId": "string",
"routeId": "string",
"name": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| type | LocationType | false | none | Office = 0 Vessel = 1 Truck = 2 |
| typeName | string¦null | false | read-only | none |
| imoNumber | string¦null | false | none | none |
| mmsiNumber | string¦null | false | none | none |
| globalId | string¦null | false | none | none |
| routeId | string¦null | false | none | none |
| name | string¦null | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
LocationType
0
Office = 0
Vessel = 1
Truck = 2
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | Office = 0 Vessel = 1 Truck = 2 |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | 0 |
| anonymous | 1 |
| anonymous | 2 |
NewChecklistApiModel
{
"id": null,
"refId": null,
"dueTime": null,
"reoccurFrom": null,
"metadata": {
"property1": "string",
"property2": "string"
},
"externalData": {
"email": "string",
"fullName": "string",
"phone": null,
"sendEmail": false,
"expireDays": 30
},
"assignToPersonId": null,
"assignToPositionId": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid)¦null | false | none | Id of template |
| refId | string¦null | false | none | RefId of template, should be passed if Id not passed |
| dueTime | string(date-time)¦null | false | none | none |
| reoccurFrom | string(uuid)¦null | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
| externalData | ExternalChecklistData | false | none | Used to create external token |
| assignToPersonId | string(uuid)¦null | false | none | none |
| assignToPositionId | string(uuid)¦null | false | none | none |
NewChecklistByOnetimeTemplateApiModel
{
"dueTime": null,
"checklistTemplate": {
"name": "string",
"refId": "string",
"shortDescription": "string",
"customCompleteMessage": "string",
"sectionTemplates": [
{
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"taskTemplates": [
{
"name": "string",
"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": {},
"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": {},
"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"
},
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"reminderHours": null,
"reminderMinutes": null,
"reminderTime": null,
"preventQuickInput": false,
"metadata": {
"property1": "string",
"property2": "string"
},
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": false,
"setContentByAPI": false,
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
}
],
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"metadata": {
"property1": "string",
"property2": "string"
}
}
],
"metadata": [
{
"name": "string",
"value": "string",
"displayAsSubHeading": true
}
],
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"archiveChecklistsAfter": 1,
"archiveChecklistsAfterSpan": 0,
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"publishToMessagebus": false,
"singleUserTemplate": false,
"allowExternalUse": false,
"locationTagging": false,
"preventQuickDiscard": false,
"preventFlowCreateByActiveRefId": "string",
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
},
"externalData": {
"email": "string",
"fullName": "string",
"phone": null,
"sendEmail": false,
"expireDays": 30
},
"assignToPersonId": null,
"assignToPositionId": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dueTime | string(date-time)¦null | false | none | none |
| checklistTemplate | OnetimeTemplateApiModel | true | none | none |
| externalData | ExternalChecklistData | false | none | Used to create external token |
| assignToPersonId | string(uuid)¦null | false | none | none |
| assignToPositionId | string(uuid)¦null | false | none | none |
NewChecklistResultModel
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string",
"invalidateExternalUrl": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| url | string¦null | false | none | none |
| invalidateExternalUrl | string¦null | false | none | none |
NewListItem
{
"listData": {
"property1": "string",
"property2": "string"
},
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| listData | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
| description | string¦null | false | none | none |
NewSectionApiModel
{
"section": {
"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"
}
]
},
"previousSectionId": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| section | SectionTemplate | true | none | none |
| previousSectionId | string(uuid)¦null | false | none | 00000000-0000-0000-0000-000000000000 to put it first, null to put it last |
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 |
OnetimeCommentTypeApiModel
{
"name": "string",
"requireComment": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| requireComment | boolean | false | none | none |
OnetimeDiscardReasonApiModel
{
"name": "string",
"requireComment": true,
"default": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| requireComment | boolean | false | none | none |
| default | boolean | false | none | none |
OnetimeMetadataApiModel
{
"name": "string",
"value": "string",
"displayAsSubHeading": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| value | string¦null | false | none | none |
| displayAsSubHeading | boolean | false | none | none |
OnetimeSectionTemplateApiModel
{
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"taskTemplates": [
{
"name": "string",
"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"
},
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"reminderHours": null,
"reminderMinutes": null,
"reminderTime": null,
"preventQuickInput": false,
"metadata": {
"property1": "string",
"property2": "string"
},
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": false,
"setContentByAPI": false,
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
}
],
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"metadata": {
"property1": "string",
"property2": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
| color | string¦null | false | none | none |
| documentation | [Documentation]¦null | false | none | none |
| taskTemplates | [OnetimeTaskTemplateApiModel]¦null | false | none | none |
| webhooks | [Webhook]¦null | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
OnetimeTaskTemplateApiModel
{
"name": "string",
"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"
},
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"reminderHours": null,
"reminderMinutes": null,
"reminderTime": null,
"preventQuickInput": false,
"metadata": {
"property1": "string",
"property2": "string"
},
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": false,
"setContentByAPI": false,
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
| control | TaskTemplateControl | true | none | none |
| control2 | TaskTemplateControl | false | none | none |
| documentation | [Documentation]¦null | 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 |
| reminderHours | integer(int32)¦null | false | none | none |
| reminderMinutes | integer(int32)¦null | false | none | none |
| reminderTime | string(date-time)¦null | false | none | none |
| preventQuickInput | boolean | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
| assignedPosition | string(uuid)¦null | false | none | none |
| sensitiveData | boolean | false | none | none |
| setContentByAPI | boolean | false | none | none |
| discardReasons | [OnetimeDiscardReasonApiModel]¦null | false | none | none |
| commentTypes | [OnetimeCommentTypeApiModel]¦null | false | none | none |
OnetimeTemplateApiModel
{
"name": "string",
"refId": "string",
"shortDescription": "string",
"customCompleteMessage": "string",
"sectionTemplates": [
{
"name": "string",
"color": "string",
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"taskTemplates": [
{
"name": "string",
"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"
},
"documentation": [
{
"externalItemId": "0e1fce12-4246-4901-adef-a4db111e0a19",
"sourceName": "string",
"order": 0,
"title": "string",
"value": "string",
"relativeExternalItemUrl": "string",
"message": "string"
}
],
"secondaryTitle": "string",
"tags": "string",
"analyticTags": "string",
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"reminderHours": null,
"reminderMinutes": null,
"reminderTime": null,
"preventQuickInput": false,
"metadata": {
"property1": "string",
"property2": "string"
},
"assignedPosition": "0e023770-feda-40e2-8177-601401251112",
"sensitiveData": false,
"setContentByAPI": false,
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
}
],
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"metadata": {
"property1": "string",
"property2": "string"
}
}
],
"metadata": [
{
"name": "string",
"value": "string",
"displayAsSubHeading": true
}
],
"webhooks": [
{
"location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
"action": 0,
"url": "string",
"description": "string"
}
],
"archiveChecklistsAfter": 1,
"archiveChecklistsAfterSpan": 0,
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"publishToMessagebus": false,
"singleUserTemplate": false,
"allowExternalUse": false,
"locationTagging": false,
"preventQuickDiscard": false,
"preventFlowCreateByActiveRefId": "string",
"discardReasons": [
{
"name": "string",
"requireComment": true,
"default": true
}
],
"commentTypes": [
{
"name": "string",
"requireComment": true
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
| refId | string¦null | false | none | none |
| shortDescription | string¦null | false | none | none |
| customCompleteMessage | string¦null | false | none | none |
| sectionTemplates | [OnetimeSectionTemplateApiModel]¦null | false | none | none |
| metadata | [OnetimeMetadataApiModel]¦null | false | none | none |
| webhooks | [Webhook]¦null | false | none | none |
| archiveChecklistsAfter | integer(int32) | false | none | none |
| archiveChecklistsAfterSpan | TimeSpanType | false | none | Month = 0 Days = 1 |
| categoryId | string(uuid)¦null | false | none | none |
| publishToMessagebus | boolean | false | none | none |
| singleUserTemplate | boolean | false | none | none |
| allowExternalUse | boolean | false | none | none |
| locationTagging | boolean | false | none | none |
| preventQuickDiscard | boolean | false | none | none |
| preventFlowCreateByActiveRefId | string¦null | false | none | none |
| discardReasons | [OnetimeDiscardReasonApiModel]¦null | false | none | none |
| commentTypes | [OnetimeCommentTypeApiModel]¦null | false | none | none |
OverrideItemModel
{
"value": "string",
"commentType": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"externalLinkUrl": "string",
"externalLinkTitle": "string",
"picture": [
0
],
"base64Picture": "string",
"urlPicture": "string",
"fileName": null,
"discardReason": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string¦null | false | none | none |
| commentType | string¦null | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
| externalLinkUrl | string¦null | false | none | none |
| externalLinkTitle | string¦null | false | none | none |
| picture | [integer]¦null | false | none | One of Picture, Base64Picture or UrlPicture should be used |
| base64Picture | string¦null | false | none | One of Picture, Base64Picture or UrlPicture should be used |
| urlPicture | string¦null | false | none | One of Picture, Base64Picture or UrlPicture should be used |
| fileName | string¦null | false | none | Optional, used to get file type (.jpg is default) |
| discardReason | string¦null | false | none | none |
PhoneNumberControl
{
"callingCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| callingCode | string¦null | false | none | none |
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 |
SectionData
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
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 |
SetTaskValueModel
{
"taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
"value1": null,
"value2": null,
"source": null,
"time": null,
"shouldConfirm": false,
"overrideExistingValue": true,
"appendValue": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskId | string(uuid) | true | none | none |
| value1 | string¦null | false | none | none |
| value2 | string¦null | false | none | none |
| source | string¦null | false | none | none |
| time | string(date-time)¦null | false | none | none |
| shouldConfirm | boolean | false | none | none |
| overrideExistingValue | boolean | false | none | none |
| appendValue | boolean | 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 |
TaskControlData
{
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string¦null | false | none | none |
| key | string¦null | false | none | none |
| valueTitle | string¦null | false | none | none |
| displayValue | string¦null | false | none | none |
| items | [TaskControlItemData]¦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 |
| typeString | string¦null | false | read-only | none |
| dataRegister | DataRegisterData | false | none | none |
| text | string¦null | false | none | none |
| dataId | string¦null | false | none | none |
TaskControlItemData
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| values | [TaskControlItemValueData]¦null | false | none | none |
| time | string(date-time) | false | none | none |
| timeString | string¦null | false | read-only | none |
TaskControlItemValueData
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string¦null | false | none | none |
| value | string¦null | false | none | none |
| displayValue | 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 |
| typeString | string¦null | false | read-only | none |
| dataId | string¦null | false | none | none |
TaskData
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"tags": "string",
"analyticTags": "string",
"metadata": {
"property1": "string",
"property2": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| secondaryTitle | string¦null | false | none | none |
| state | DispatchObjectState | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| tags | string¦null | false | none | none |
| analyticTags | string¦null | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
TaskDetailsData
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"secondaryTitle": "string",
"state": 0,
"control": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"control2": {
"value": "string",
"key": "string",
"valueTitle": "string",
"displayValue": "string",
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [
{
"title": "string",
"value": "string",
"displayValue": "string",
"type": 0,
"typeString": "string",
"dataId": "string"
}
],
"time": "2019-08-24T14:15:22Z",
"timeString": "string"
}
],
"type": 0,
"typeString": "string",
"dataRegister": {
"listId": "string",
"listKey": "string"
},
"text": "string",
"dataId": "string"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"geoposition": {
"latitude": 0,
"longitude": 0
},
"time": "2019-08-24T14:15:22Z",
"timeString": "string",
"timezone": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | false | none | none |
| name | string¦null | false | none | none |
| secondaryTitle | string¦null | false | none | none |
| state | DispatchObjectState | false | none | Active = 0 Finished = 1 Overriden = 2 Discarded = 3 |
| control | TaskControlData | false | none | none |
| control2 | TaskControlData | false | none | none |
| metadata | object¦null | false | none | none |
| » additionalProperties | string | false | none | none |
| geoposition | Geoposition | false | none | none |
| time | string(date-time)¦null | false | none | none |
| timeString | string¦null | false | read-only | none |
| timezone | string¦null | false | none | none |
| userId | string(uuid)¦null | 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 |
TaskValueApiModel
{
"value1": null,
"value2": null,
"source": null,
"time": null,
"shouldConfirm": false,
"overrideExistingValue": true,
"appendValue": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value1 | string¦null | false | none | none |
| value2 | string¦null | false | none | none |
| source | string¦null | false | none | none |
| time | string(date-time)¦null | false | none | none |
| shouldConfirm | boolean | false | none | none |
| overrideExistingValue | boolean | false | none | none |
| appendValue | boolean | false | none | none |
TaskValueApiModelByDataId
{
"value": null,
"source": null,
"time": null,
"shouldConfirm": false,
"overrideExistingValue": true,
"appendValue": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string¦null | false | none | none |
| source | string¦null | false | none | none |
| time | string(date-time)¦null | false | none | none |
| shouldConfirm | boolean | false | none | none |
| overrideExistingValue | boolean | false | none | none |
| appendValue | boolean | 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 |
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 |
UpdateRichTextControlApiModel
{
"name": "string",
"secondaryTitle": "string",
"content": "string",
"isMarkdown": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | Will be updated only if set and not empty |
| secondaryTitle | string¦null | false | none | Will be updated only if set, can apply empty value |
| content | string¦null | false | none | Will be updated only if set, can apply empty value |
| isMarkdown | boolean | false | none | Set this flag to convert markdown to html |
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 |