0% found this document useful (0 votes)

1K views359 pages

Swimlaneapiv2 1

Uploaded by

Not Required

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

1K views359 pages

Swimlaneapiv2 1

Uploaded by

Not Required

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 359

API Reference

Swimlane API
API Version: 2.0

1 of 359
INDEX
1. ACCESSTOKEN 10
1.1 POST /auth/token/create 10
1.2 GET /auth/user/{userId}/token 12
1.3 DELETE /auth/user/{userId}/token 14

2. APPLET 17
2.1 GET /applet/{id} 17
2.2 PUT /applet/{id} 20
2.3 DELETE /applet/{id} 23
2.4 GET /applet 26
2.5 POST /applet 29
2.6 GET /applet/{id}/history 32
2.7 GET /applet/{id}/history/{revisionNumber} 35
2.8 POST /applet/{id}/copy 37
2.9 GET /applet/{id}/export 40
2.10 POST /applet/import 41
2.11 PUT /applet/{id}/workflow 46
2.12 POST /applet/{id}/fields 50

3. APPLICATION 52
3.1 GET /app/light 52
3.2 GET /app 52
3.3 PUT /app 54
3.4 POST /app 55
3.5 GET /app/{id} 57
3.6 PUT /app/{id} 58
3.7 DELETE /app/{id} 60
3.8 GET /app/workspace/{id} 61
3.9 POST /app/{id}/copy 62
3.10 GET /app/{id}/export 64
3.11 GET /app/{id}/history 65
3.12 GET /app/{id}/history/{revisionNumber} 65
3.13 POST /app/import 66
3.14 POST /app/{id}/fields 77
3.15 GET /app/fields/descriptor/mapping 78

4. ASSET 80
4.1 GET /asset/{id} 80
4.2 PUT /asset/{id} 81
4.3 DELETE /asset/{id} 84
4.4 GET /asset 85
4.5 PUT /asset 87
4.6 POST /asset 88

2 of 359
4.7 GET /asset/list 91
4.8 GET /asset/available 92
4.9 POST /asset/test 93

5. CONTENT 95
5.1 POST /content/export/download 95
5.2 POST /content/export/try 95
5.3 POST /content/import 97
5.4 GET /content/import/{trackingId}/status 99

6. CREDENTIALS 101
6.1 GET /credentials 101
6.2 PUT /credentials 101
6.3 POST /credentials 101
6.4 GET /credentials/{name} 102
6.5 PUT /credentials/{name} 103
6.6 DELETE /credentials/{name} 103

7. DASHBOARD 104
7.1 GET /dashboard/workspace/{id} 104
7.2 GET /dashboard/status/workspace/{id} 105
7.3 GET /dashboard/{id} 105
7.4 PUT /dashboard/{id} 107
7.5 DELETE /dashboard/{id} 108
7.6 GET /dashboard 109
7.7 PUT /dashboard 110
7.8 POST /dashboard 111

8. DATAIMPORT 114
8.1 POST /data-import/upload 114
8.2 POST /data-import/run 114

9. FORMULA 116
9.1 POST /app/formula-validate 116

10. GROUPS 118

10.1 GET /groups/{id} 118
10.2 PUT /groups/{id} 119
10.3 DELETE /groups/{id} 120
10.4 GET /groups 121
10.5 POST /groups 122
10.6 GET /groups/lookup 124

11. HEALTH 126

11.1 GET /health/ping 126
11.2 GET /health/wait/{duration} 126

3 of 359
11.3 GET /health/tasksstatus 127
11.4 GET /health/ldap 127
11.5 GET /health/ 127
11.6 GET /health/mongodb 128
11.7 GET /health/hangfire 128

12. ICON 130

12.1 GET /icon/{id} 130
12.2 GET /icon 130

13. LOGGING 132

13.1 POST /logging/recent 132
13.2 POST /logging/offset 132
13.3 POST /logging/date 133
13.4 GET /logging/job/{jobId} 134
13.5 POST /logging/ 135

14. ONETIMEPASSWORD 136

14.1 POST /otp/enroll 136
14.2 POST /otp/secret/verify 136
14.3 POST /otp/opt-out 138
14.4 POST /otp/exempt 138
14.5 POST /otp/reset 139

15. PIPPACKAGE 141

15.1 GET /pip/packages/{pythonVersion} 141
15.2 POST /pip/packages/ 141
15.3 POST /pip/packages/offline 142
15.4 DELETE /pip/packages/{packageName}/{pythonVersion} 143

16. RECORD 145

16.1 POST /app/{appId}/record/{id}/calc/{fieldId} 145
16.2 GET /app/{appId}/record 145
16.3 PUT /app/{appId}/record 147
16.4 POST /app/{appId}/record 149
16.5 DELETE /app/{appId}/record 152
16.6 GET /app/{appId}/record/{id} 152
16.7 PUT /app/{appId}/record/{id} 154
16.8 DELETE /app/{appId}/record/{id} 156
16.9 PATCH /app/{appId}/record/{id} 157
16.10 GET /app/{appId}/record/tracking/{trackingId} 159
16.11 POST /app/{appId}/record/{id}/references 161
16.12 POST /app/{appId}/record/validate 162
16.13 PUT /app/{appId}/record/batch 164
16.14 POST /app/{appId}/record/batch 165
16.15 DELETE /app/{appId}/record/batch 165

4 of 359
16.16 PUT /app/{appId}/record/{id}/restrict 166
16.17 POST /app/{appId}/record/{recordId}/add-references 167
16.18 POST /app/{appId}/record/{recordId}/{fieldId}/comment 168
16.19 PUT /app/{appId}/record/{recordId}/{fieldId}/comment/{index} 169
16.20 POST /app/{appId}/record/{recordId}/lock 169
16.21 POST /app/{appId}/record/{recordId}/unlock 170
16.22 POST /app/{appId}/record/{id}/unique/{fieldId} 170
16.23 GET /app/{appId}/record/{id}/history 171
16.24 GET /app/{appId}/record/{id}/history/{revision} 172
16.25 GET /app/{appId}/record/{id}/history/{revision}/diff 172
16.26 GET /app/{appId}/record/{id}/export/{formatId} 173
16.27 GET /app/{appId}/record/underEdit 174

17. REPORTS 175

17.1 GET /reports/{id} 175
17.2 PUT /reports/{id} 177
17.3 DELETE /reports/{id} 180
17.4 GET /reports/app/{appId} 181
17.5 DELETE /reports/app/{appId} 183
17.6 GET /reports 184
17.7 POST /reports 187
17.8 GET /reports/app/{id}/default 189
17.9 GET /reports/workspace/{id} 192
17.10 PUT /reports/ 195
17.11 GET /reports/status/workspace/{id} 197

18. ROLES 199

18.1 GET /roles/{id} 199
18.2 PUT /roles/{id} 200
18.3 DELETE /roles/{id} 201
18.4 GET /roles/ 201
18.5 POST /roles/ 203
18.6 GET /roles/light 204

19. SAML 205

19.1 GET /saml/enabled 205

20. SCHEDULEDDASHBOARD 206

20.1 GET /scheduled/dashboard 206
20.2 POST /scheduled/dashboard 207
20.3 GET /scheduled/dashboard/{dashboardId} 209
20.4 PUT /scheduled/dashboard/{id} 211
20.5 DELETE /scheduled/dashboard/{id} 213

21. SCHEDULEDREPORT 215

21.1 GET /scheduled/reports 215

5 of 359
21.2 GET /scheduled/report/{reportId} 216
21.3 GET /scheduled/{scheduledId} 218
21.4 PUT /scheduled/{id} 220
21.5 DELETE /scheduled/{id} 222
21.6 POST /scheduled 223

22. SEARCH 226

22.1 POST /search/stats 226
22.2 GET /search/keyword 228
22.3 POST /search/keyword 231
22.4 POST /search/ 235
22.5 GET /search/export/{id} 236
22.6 POST /search/export 236

23. SETTINGS 238

23.1 GET /settings/features 238
23.2 GET /settings/features/enabled 238
23.3 POST /settings/features/{id} 239
23.4 GET /settings/timezones/ 239
23.5 POST /settings/ldap/validategroups 240
23.6 GET /settings/ldap/defaultsettings 240
23.7 GET /settings/ 242
23.8 PUT /settings/ 245
23.9 GET /settings/schedule 250
23.10 GET /settings/mailsettings/test 251
23.11 GET /settings/version 251
23.12 GET /settings/python3-version 251
23.13 GET /settings/login-banner 252
23.14 GET /settings/upgrade-status 252
23.15 GET /settings/password-complexity 253
23.16 POST /settings/install 253
23.17 POST /settings/ldap/sync 254
23.18 POST /settings/license/upload 255

24. SHARING 257

24.1 POST /sharing/ 257
24.2 POST /sharing/scheduled/report 257
24.3 POST /sharing/scheduled/dashboard 258
24.4 POST /sharing/scheduled/report/export/csv 258
24.5 POST /sharing/scheduled/report/export/pdf 258
24.6 POST /sharing/scheduled/download/pdf 259
24.7 POST /sharing/scheduled/dashboard/export/pdf 260

25. TASK 262

25.1 GET /task/actions 262

6 of 359
25.2 GET /task/action/{id}/new 263
25.3 GET /task/action/{id}/fork 266
25.4 GET /task/options 269
25.5 GET /task/light 270
25.6 GET /task/light/{parentId} 270
25.7 GET /task/list 271
25.8 GET /task/list/{parentId} 272
25.9 GET /task 272
25.10 POST /task 275
25.11 GET /task/common 280
25.12 GET /task/{id} 283
25.13 PUT /task/{id} 286
25.14 DELETE /task/{id} 289
25.15 POST /task/fork 289
25.16 POST /task/execute/record 292
25.17 POST /task/test/output 294
25.18 GET /task/export/{id} 295
25.19 POST /task/upload-script 295
25.20 POST /task/upload-task 298
25.21 POST /task/upload 301
25.22 POST /task/{jobId}/cancel 304
25.23 POST /task/enable 305

26. TASKPACKAGE 308

26.1 DELETE /task/packages/{packageName}/{version} 308
26.2 DELETE /task/packages/{packageName}/{version}/{pythonVersion} 308
26.3 GET /task/packages 309
26.4 GET /task/packages/{packageName} 310
26.5 GET /task/packages/{packageName}/{version}/usage 313
26.6 GET /task/packages/{packageName}/{version}/usage/{pythonVersion} 314
26.7 POST /task/packages/upload 314
26.8 POST /task/packages/upgrade 315
26.9 POST /task/packages/upload/ssp 316
26.10 POST /task/packages/upgrade/ssp 318

27. USAGE 320

27.1 GET /usage/app/{appId} 320
27.2 GET /usage/app/common 321
27.3 PUT /usage/update 321
27.4 POST /usage/stats 322

28. USER 324

28.1 GET /user/authorize 324
28.2 GET /user/avatar/{id} 324
28.3 POST /user/avatar/{id} 324

7 of 359
28.4 GET /user 325
28.5 POST /user 327
28.6 GET /user/{id} 328
28.7 PUT /user/{id} 330
28.8 DELETE /user/{id} 332
28.9 GET /user/{id}/permissions 332
28.10 GET /user/{id}/light 333
28.11 GET /user/light 334
28.12 GET /user/search 334
28.13 POST /user/token 336
28.14 POST /user/login 336
28.15 POST /user/logout 337
28.16 POST /user/password/reset 338
28.17 POST /user/password/set 338
28.18 POST /user/password/test 338
28.19 GET /usergroup/lookup 339
28.20 GET /user/lookup 340

29. WORKFLOW 341

29.1 GET /workflow/ 341
29.2 POST /workflow/ 343
29.3 DELETE /workflow/ 345
29.4 GET /workflow/{id} 345
29.5 PUT /workflow/{id} 348
29.6 POST /workflow/notify 350
29.7 GET /workflow/record/runs/{recordId} 350
29.8 GET /workflow/run/{workflowRunId} 351

30. WORKSPACE 354

30.1 GET /workspaces/ 354
30.2 POST /workspaces/ 354
30.3 GET /workspaces/nav 355
30.4 GET /workspaces/{id} 356
30.5 PUT /workspaces/{id} 357
30.6 DELETE /workspaces/{id} 358
30.7 GET /workspaces/app/{id} 358

8 of 359
Security and Authentication
SECURITY SCHEMES

KEY TYPE DESCRIPTION

jwt_token apiKey
access_token apiKey

9 of 359
API
1. ACCESSTOKEN

1.1 POST /auth/token/create

Creates a new access token for the user making the request

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: The access token that was created

RESPONSE MODEL - application/json

STATUS CODE - 400: The access token that was created

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

10 of 359
NAME TYPE DESCRIPTION

errorCode enum ALLOWED:None,

PasswordExpired, DuplicateUserName,
InvalidUserNameOrPassword, ConfirmPasswordDoesNotMatch,
PasswordDoesNotMeetComplexityRequirements,
PasswordResetRequired, NewPasswordCannotMatchCurrent,
InvalidUser, DuplicateEmail, NonAdminUser,
DuplicateGroupName, DuplicateRoleName, DuplicateFieldName,
FieldNameEmpty, InvalidApplicationExportFile,
ApplicationNotFound, InvalidCalculation,
DuplicateApplicationName, DuplicateAppletName,
DuplicateAppletAcronym, DuplicateApplicationAcronym,
AppletNotFound, SettingsInvalid, SectionNameTooLong,
DuplicateFieldValue, InvalidDateField, RecordNotFound,
FieldNotFound, RecordLocked, CannotGeneratePdfPreview,
BadStatsGroup, BadFilter, BadSort, AppLimitExceeded,
UserLimitExceeded, NewServerInstall,
UnableToConnectToActiveDirectory,
UnableToRetrieveStoredValue, UnableToConnectToMongoDb,
UnableToConnectToSmtp, SwimlaneAlreadyInitialized,
ModelValidationError, UpgradeInProcess, RequiredFieldMissing,
UnableToRetrieveEncryptionKey, PathNotFound, WrongType,
ModificationError, DatabaseError, NetworkError,
InvalidOnThisOS, DeserializationError, ContractRequiresError,
ContractEnsuresError, InvalidNumericInput,
InvalidSessionTimeout, InvalidInputTemplateString,
ConnectionDataNotProvided, RegexNotDefined, AssetNotFound,
BadThreatIntelConnector, NoThreatIntel,
ThreatIntelTypeNotSupportedByThisProvider, DuplicateTaskName,
TaskNotFound, PythonVersionNotSupported, TaskMigrated,
PackageAlreadyInstalled, PackageNotFound,
PackageInstallError, InvalidSupportedSwimlaneVersion,
PackageUploadError, PackageUpgradeError,
UserAlreadyHasAccessToken, AccessTokenNotFound,
UserAlreadyEnrolledInOneTimePassword,
UserNotEnrolledInOneTimePassword,
OneTimePasswordNotAvailable, OneTimePasswordRecentlyUsed,
OneTimePasswordUseIsNotEnforced, SamlNotEnabled,
SamlUserNotFound, SamlInternalError, SamlUserValidationError,
InvalidSamlResponse, WorkflowLocked,
FeatureFlagNotModifiable, DuplicateAssetName,
IngestionRuleInvalid, DuplicateIngestionRuleName,
DuplicateOrchestrationTaskName, OrchestrationTaskDisabled,
HangfireError, ReportNotFound, ReportProcessFailed,
CardsNotContained, WidgetsNotSupported, DashboardNotFound,
ContentExchangeError, CommentsListNotFound, CommentNotFound,
CommentNotOwned
argument string
innerException object

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

11 of 359
1.2 GET /auth/user/{userId}/token

Retrieves the metadata for the token belonging to the specified user

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*userId string The id of the user to get token metadata for

RESPONSE

STATUS CODE - 200: The metadata for the token belonging to the specified user

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
createdBy object
id string
name string
createdOn string
lastUsedOn string
id string
name string
disabled boolean

STATUS CODE - 400: The metadata for the token belonging to the specified user

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

12 of 359
NAME TYPE DESCRIPTION

errorCode enum ALLOWED:None,

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

13 of 359
1.3 DELETE /auth/user/{userId}/token

Deletes the access token for the specified user

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*userId string The id of the user to delete the access token of

RESPONSE

STATUS CODE - 200: 200 if the request succeeds, 400 if the user does not have a token

RESPONSE MODEL - application/json

STATUS CODE - 204: 200 if the request succeeds, 400 if the user does not have a token

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 400: 200 if the request succeeds, 400 if the user does not have a token

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

14 of 359
NAME TYPE DESCRIPTION

errorCode enum ALLOWED:None,

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

15 of 359
16 of 359
2. APPLET

2.1 GET /applet/{id}

Gets the applet by id.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Applet.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
acronym string
iconImage64 string
layout array
id string
parentId string
row integer
col integer
sizex number
sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject,
Tab, Integration, Tabs, Widget,
OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList,
Date, UserGroup, Attachment, Tracking,
Reference, Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
permissions object

17 of 359
NAME TYPE DESCRIPTION

workflow object
applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
repeats array
id string
name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string

18 of 359
NAME TYPE DESCRIPTION

actionType enum ALLOWED:ShowHide,

SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string
disabled boolean
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
uid string
version integer
id string

19 of 359
NAME TYPE DESCRIPTION

name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.2 PUT /applet/{id}

Updates the applet.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Applet.

RESPONSE MODEL - application/json

20 of 359
NAME TYPE DESCRIPTION

sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList,
Date, UserGroup, Attachment, Tracking,
Reference, Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
permissions object
workflow object
applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
repeats array

21 of 359
NAME TYPE DESCRIPTION

id string
name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string
disabled boolean
createdDate string
modifiedDate string
createdByUser object

22 of 359
NAME TYPE DESCRIPTION

id string
name string
modifiedByUser object
id string
name string
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - 400: Applet.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

STATUS CODE - 403: Applet.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 404: Applet.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.3 DELETE /applet/{id}

Deletes the applet.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

23 of 359
RESPONSE

STATUS CODE - 200: IActionResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: IActionResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 400: IActionResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
id string

24 of 359
NAME TYPE DESCRIPTION

errorCodes enum ALLOWED:None,

STATUS CODE - 403: IActionResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

25 of 359
NAME TYPE DESCRIPTION

statusCode integer

STATUS CODE - 404: IActionResult.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.4 GET /applet

Gets the applets.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<Applet>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
acronym string
iconImage64 string
layout array
id string
parentId string
row integer
col integer
sizex number
sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject,
Tab, Integration, Tabs, Widget,
OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string

26 of 359
NAME TYPE DESCRIPTION

fieldType enum ALLOWED:None,

Text, Numeric, ValuesList,
Date, UserGroup, Attachment, Tracking,
Reference, Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
permissions object
workflow object
applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
repeats array
id string

27 of 359
NAME TYPE DESCRIPTION

name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string
disabled boolean
createdDate string
modifiedDate string
createdByUser object
id string

28 of 359
NAME TYPE DESCRIPTION

name string
modifiedByUser object
id string
name string
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.5 POST /applet

Inserts the applet.

REQUEST

RESPONSE

STATUS CODE - 200: Applet.

RESPONSE MODEL - application/json

29 of 359
NAME TYPE DESCRIPTION

name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList,
Date, UserGroup, Attachment, Tracking,
Reference, Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
permissions object
workflow object
applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string

30 of 359
NAME TYPE DESCRIPTION

name string
disabled boolean
repeats array
id string
name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string
disabled boolean

31 of 359
NAME TYPE DESCRIPTION

createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - 400: Applet.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

STATUS CODE - 403: Applet.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.6 GET /applet/{id}/history

Gets the history for specified applet.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The applet identifier

32 of 359
RESPONSE

STATUS CODE - 200: Applet revisions

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
revisionNumber number
status enum ALLOWED:Current, Historical, Deleted
userId object
id string
name string
modifiedDate string
version undefined

STATUS CODE - 400: Applet revisions

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
id string

33 of 359
NAME TYPE DESCRIPTION

errorCodes enum ALLOWED:None,

STATUS CODE - 403: Applet revisions

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

34 of 359
NAME TYPE DESCRIPTION

statusCode integer

STATUS CODE - 404: Applet revisions

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.7 GET /applet/{id}/history/{revisionNumber}

Gets the specified revision for the specified applet.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The applet identifier

*revisionNumber number The revision number

RESPONSE

STATUS CODE - 200: The applet revision

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
revisionNumber number
status enum ALLOWED:Current, Historical, Deleted
userId object
id string
name string
modifiedDate string
version undefined

STATUS CODE - 400: The applet revision

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
id string

35 of 359
NAME TYPE DESCRIPTION

errorCodes enum ALLOWED:None,

STATUS CODE - 403: The applet revision

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

36 of 359
NAME TYPE DESCRIPTION

statusCode integer

STATUS CODE - 404: The applet revision

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.8 POST /applet/{id}/copy

Copies the specified applet and inserts the copy

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The id of the applet to copy

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

modifications array
field string
value undefined
type enum ALLOWED:None, Create, Delete, Append, Subtract
id string

RESPONSE

STATUS CODE - 200: The saved, copied applet

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
acronym string
iconImage64 string
layout array
id string
parentId string
row integer
col integer
sizex number

37 of 359
NAME TYPE DESCRIPTION

sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject,
Tab, Integration, Tabs, Widget,
OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList,
Date, UserGroup, Attachment, Tracking,
Reference, Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
permissions object
workflow object
applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string

38 of 359
NAME TYPE DESCRIPTION

actionType enum ALLOWED:ShowHide,

SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
repeats array
id string
name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean

39 of 359
NAME TYPE DESCRIPTION

uid string
version integer
id string
name string
disabled boolean
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - 404: The saved, copied applet

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.9 GET /applet/{id}/export

Exports the specified applet

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The id of the applet to export

RESPONSE

STATUS CODE - 200: Task<FileResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION

40 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
contentType string
fileDownloadName string
lastModified string
entityTag object
tag object
buffer string
offset integer
length integer
value string
hasValue boolean
isWeak boolean
enableRangeProcessing boolean

STATUS CODE - 403: Task<FileResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 404: Task<FileResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.10 POST /applet/import

Imports the applet.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

modifications array
field string
value undefined
type enum ALLOWED:None, Create, Delete, Append,
Subtract
manifest object
swimlaneVersion string

41 of 359
NAME TYPE DESCRIPTION

applet object
description string
acronym string
iconImage64 string
layout array
id string
parentId string
row integer
col integer
sizex number
sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject,
Tab, Integration, Tabs, Widget,
OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList,
Date, UserGroup, Attachment, Tracking,
Reference, Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
permissions object
workflow object
applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,

42 of 359
NAME TYPE DESCRIPTION

GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
repeats array
id string
name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string

43 of 359
NAME TYPE DESCRIPTION

workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string
disabled boolean
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
uid string
version integer
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: IActionResult.

RESPONSE MODEL - application/json

STATUS CODE - 400: IActionResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
id string

44 of 359
NAME TYPE DESCRIPTION

errorCodes enum ALLOWED:None,

PasswordExpired, DuplicateUserName,
InvalidUserNameOrPassword, ConfirmPasswordDoesNotMatch,
PasswordDoesNotMeetComplexityRequirements,
PasswordResetRequired, NewPasswordCannotMatchCurrent,
InvalidUser, DuplicateEmail, NonAdminUser, DuplicateGroupName,
DuplicateRoleName, DuplicateFieldName, FieldNameEmpty,
InvalidApplicationExportFile, ApplicationNotFound,
InvalidCalculation, DuplicateApplicationName,
DuplicateAppletName, DuplicateAppletAcronym,
DuplicateApplicationAcronym, AppletNotFound, SettingsInvalid,
SectionNameTooLong, DuplicateFieldValue, InvalidDateField,
RecordNotFound, FieldNotFound, RecordLocked,
CannotGeneratePdfPreview, BadStatsGroup, BadFilter, BadSort,
AppLimitExceeded, UserLimitExceeded, NewServerInstall,
UnableToConnectToActiveDirectory, UnableToRetrieveStoredValue,
UnableToConnectToMongoDb, UnableToConnectToSmtp,
SwimlaneAlreadyInitialized, ModelValidationError,
UpgradeInProcess, RequiredFieldMissing,
UnableToRetrieveEncryptionKey, PathNotFound, WrongType,
ModificationError, DatabaseError, NetworkError,
InvalidOnThisOS, DeserializationError, ContractRequiresError,
ContractEnsuresError, InvalidNumericInput,
InvalidSessionTimeout, InvalidInputTemplateString,
ConnectionDataNotProvided, RegexNotDefined, AssetNotFound,
BadThreatIntelConnector, NoThreatIntel,
ThreatIntelTypeNotSupportedByThisProvider, DuplicateTaskName,
TaskNotFound, PythonVersionNotSupported, TaskMigrated,
PackageAlreadyInstalled, PackageNotFound, PackageInstallError,
InvalidSupportedSwimlaneVersion, PackageUploadError,
PackageUpgradeError, UserAlreadyHasAccessToken,
AccessTokenNotFound, UserAlreadyEnrolledInOneTimePassword,
UserNotEnrolledInOneTimePassword, OneTimePasswordNotAvailable,
OneTimePasswordRecentlyUsed, OneTimePasswordUseIsNotEnforced,
SamlNotEnabled, SamlUserNotFound, SamlInternalError,
SamlUserValidationError, InvalidSamlResponse, WorkflowLocked,
FeatureFlagNotModifiable, DuplicateAssetName,
IngestionRuleInvalid, DuplicateIngestionRuleName,
DuplicateOrchestrationTaskName, OrchestrationTaskDisabled,
HangfireError, ReportNotFound, ReportProcessFailed,
CardsNotContained, WidgetsNotSupported, DashboardNotFound,
ContentExchangeError, CommentsListNotFound, CommentNotFound,
CommentNotOwned
errors array
succeeded boolean
error string
deletedCount integer

STATUS CODE - 403: IActionResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

45 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.11 PUT /applet/{id}/workflow

Updates the workflow of the specified applet

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The id of the applet to update the workflow of

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, DefaultActions, Regex,
HasValue, DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array
conditionType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, DefaultActions, Regex,
HasValue, DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly, Required,
CreateNewRecord, Notification, Integration,
FilterValues, FormattedExport,

46 of 359
NAME TYPE DESCRIPTION

ToggleTimeTracking, OrchestrationTask
id string
name string
disabled boolean
repeats array
id string
name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly, Required,
CreateNewRecord, Notification, Integration,
FilterValues, FormattedExport,
ToggleTimeTracking, OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual, LessThan,
LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string

47 of 359
NAME TYPE DESCRIPTION

disabled boolean

RESPONSE

STATUS CODE - 200: The workflow tied to the applet

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly, Required,
CreateNewRecord, Notification, Integration,
FilterValues, FormattedExport,
ToggleTimeTracking, OrchestrationTask
id string
name string
disabled boolean
repeats array
id string
name string
parentId string

48 of 359
NAME TYPE DESCRIPTION

fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly, Required,
CreateNewRecord, Notification, Integration,
FilterValues, FormattedExport,
ToggleTimeTracking, OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual, LessThan,
LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - 400: The workflow tied to the applet

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

49 of 359
STATUS CODE - 403: The workflow tied to the applet

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 404: The workflow tied to the applet

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

2.12 POST /applet/{id}/fields

Add one or more fields to the specified applet

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The id of the applet to add the fields to

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

appletId string
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
createLayout enum ALLOWED:None,
AddToHidden, AddToLayout,
AddToNewSection
sectionName string

RESPONSE

50 of 359
STATUS CODE - 200: Task<IEnumerable<Field>>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

51 of 359
3. APPLICATION

3.1 GET /app/light

Gets the Swimlane applications as a light view models.

Supersedes GetLight method

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Collection of ApplicationViewModels

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
id string
name string
acronym string
description string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.2 GET /app

Gets the Swimlane full applications.

Supersedes Get method

REQUEST
No request parameters

52 of 359
RESPONSE

STATUS CODE - 200: Collection of applications

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
acronym string
trackingFieldId string
layout array
id string
parentId string
row integer
col integer
sizex number
sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject, Tab,
Integration, Tabs, Widget, OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
maxTrackingId number
workspaces array
createWorkspace boolean
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
timeSpentFieldId string
timeTrackingEnabled boolean
permissions object

53 of 359
NAME TYPE DESCRIPTION

uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.3 PUT /app

Saves/Updates the Swimlane application.

REQUEST

RESPONSE

STATUS CODE - 200: Saved Swimlane application.

RESPONSE MODEL - application/json

54 of 359
NAME TYPE DESCRIPTION

fieldType enum ALLOWED:None,

Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
maxTrackingId number
workspaces array
createWorkspace boolean
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
timeSpentFieldId string
timeTrackingEnabled boolean
permissions object
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.4 POST /app

Inserts new Swimlane application.

Supersedes Post method

REQUEST

RESPONSE

STATUS CODE - 200: Saved application

RESPONSE MODEL - application/json

55 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
acronym string
trackingFieldId string
layout array
id string
parentId string
row integer
col integer
sizex number
sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject, Tab,
Integration, Tabs, Widget, OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
maxTrackingId number
workspaces array
createWorkspace boolean
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
timeSpentFieldId string
timeTrackingEnabled boolean
permissions object
uid string
version integer
id string
name string

56 of 359
NAME TYPE DESCRIPTION

disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.5 GET /app/{id}

Gets the Swimlane application by identifier.

Supersedes Get method with id parameter

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Application

RESPONSE MODEL - application/json

57 of 359
NAME TYPE DESCRIPTION

sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
maxTrackingId number
workspaces array
createWorkspace boolean
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
timeSpentFieldId string
timeTrackingEnabled boolean
permissions object
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.6 PUT /app/{id}

Saves/Updates the Swimlane application.

Rest compliant interface

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

58 of 359
NAME TYPE DESCRIPTION

*id string The application ID

RESPONSE

STATUS CODE - 200: Saved Swimlane application.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
acronym string
trackingFieldId string
layout array
id string
parentId string
row integer
col integer
sizex number
sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject, Tab,
Integration, Tabs, Widget, OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
maxTrackingId number
workspaces array
createWorkspace boolean
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string

59 of 359
NAME TYPE DESCRIPTION

timeSpentFieldId string
timeTrackingEnabled boolean
permissions object
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.7 DELETE /app/{id}

Deletes the Swimlane application.

Supersedes Delete method.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The application identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

60 of 359
3.8 GET /app/workspace/{id}

Gets the Swimlane applications defined in workspace.

Supersedes GetByWorkspace method.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The workspace identifier.

RESPONSE

STATUS CODE - 200: Application collection.

RESPONSE MODEL - application/json

61 of 359
NAME TYPE DESCRIPTION

createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
timeSpentFieldId string
timeTrackingEnabled boolean
permissions object
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.9 POST /app/{id}/copy

Get a copy of Swimlane application.

Supersedes Copy method.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The application identifier.

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

modifications array
field string
value undefined
type enum ALLOWED:None, Create, Delete, Append, Subtract
id string

62 of 359
RESPONSE

STATUS CODE - 200: Application

RESPONSE MODEL - application/json

63 of 359
NAME TYPE DESCRIPTION

uid string
version integer
id string
name string
disabled boolean

STATUS CODE - 404: Application

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.10 GET /app/{id}/export

Exports Swimlane application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The application identifier.

RESPONSE

STATUS CODE - 200: Response message

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
contentType string
fileDownloadName string
lastModified string
entityTag object
tag object
buffer string
offset integer
length integer
value string
hasValue boolean
isWeak boolean
enableRangeProcessing boolean

64 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.11 GET /app/{id}/history

Gets the history for specified application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The application identifier.

RESPONSE

STATUS CODE - 200: The Revision collection.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.12 GET /app/{id}/history/{revisionNumber}

Gets the specified revision for specified application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

65 of 359
NAME TYPE DESCRIPTION

*id string The application identifier.

*revisionNumber number The revision number.

RESPONSE

STATUS CODE - 200: The Revision.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
revisionNumber number
status enum ALLOWED:Current, Historical, Deleted
userId object
id string
name string
modifiedDate string
version undefined

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.13 POST /app/import

Imports Swimlane application

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

modifications array
field string
value undefined
type enum ALLOWED:None, Create, Delete, Append,
Subtract
manifest object
swimlaneVersion string
application object
description string
acronym string
trackingFieldId string
layout array

66 of 359
NAME TYPE DESCRIPTION

id string
parentId string
row integer
col integer
sizex number
sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject,
Tab, Integration, Tabs, Widget,
OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList,
Date, UserGroup, Attachment, Tracking,
Reference, Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
maxTrackingId number
workspaces array
createWorkspace boolean
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
timeSpentFieldId string
timeTrackingEnabled boolean
permissions object
uid string
version integer
id string
name string
disabled boolean
reports array
groupBys array
fieldId string

67 of 359
NAME TYPE DESCRIPTION

groupByType enum ALLOWED:GroupBy,

GroupByHour, GroupByDay,
GroupByWeek, GroupByMonth, GroupByQuarter,
GroupByYear, GroupByNull
aggregates array
fieldId string
aggregateType enum ALLOWED:Average, Count, Sum, Min, Max
applicationIds array
keywords string
columns array
sorts object
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual, Previous,
Current, Next, Exists, Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute,
Hour, Day, Week, Month,
Quarter, Year, AllTime
value undefined
drillin boolean
countByApplicationFacet boolean
pageSize integer
offset integer
defaultSearchReport boolean
allowed array
id string
name string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None,
Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line,
Scatter, Bubble, Pie, Heat, Gauge, Number,
Map, Area, AdvancedPie, LinearGauge,

68 of 359
NAME TYPE DESCRIPTION

Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked,
Step, Spline, PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending,
Custom, ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending,
Custom, ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value

69 of 359
NAME TYPE DESCRIPTION

number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean
statsReports array
groupBys array
fieldId string
groupByType enum ALLOWED:GroupBy,
GroupByHour, GroupByDay,
GroupByWeek, GroupByMonth, GroupByQuarter,
GroupByYear, GroupByNull
aggregates array
fieldId string
aggregateType enum ALLOWED:Average, Count, Sum, Min, Max
applicationIds array
keywords string
columns array
sorts object
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual, Previous,
Current, Next, Exists, Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute,
Hour, Day, Week, Month,
Quarter, Year, AllTime
value undefined
drillin boolean
countByApplicationFacet boolean
pageSize integer
offset integer
defaultSearchReport boolean
allowed array
id string
name string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string

70 of 359
NAME TYPE DESCRIPTION

name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None,
Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line,
Scatter, Bubble, Pie, Heat, Gauge, Number,
Map, Area, AdvancedPie, LinearGauge,
Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked,
Step, Spline, PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending,
Custom, ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending,
Custom, ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string

71 of 359
NAME TYPE DESCRIPTION

showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean
workspaces array
description string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
dashboards array
applications array
permissions object
uid string
version integer
id string
name string
disabled boolean
dashboards array
description string
workspaces array
items array
id string
name string

72 of 359
NAME TYPE DESCRIPTION

description string
autoRefreshMilliseconds integer
cardType enum ALLOWED:Report, Html, UsageStatistic
row integer
col integer
sizeX integer
sizeY integer
timelineEnabled boolean
timelineFilters object
minTimelineDate string
maxTimelineDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
permissions object
allowed array
id string
name string
uid string
version integer
id string
name string
disabled boolean
workflows array
applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array

73 of 359
NAME TYPE DESCRIPTION

conditionType enum ALLOWED:Contains,

Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
repeats array
id string
name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly,
Required, CreateNewRecord, Notification,
Integration, FilterValues,
FormattedExport, ToggleTimeTracking,
OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object

74 of 359
NAME TYPE DESCRIPTION

workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string
disabled boolean
exportTransformations array
applicationId string
format string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
uid string
version integer
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: Task<ApplicationImportResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
application object
description string
acronym string

75 of 359
NAME TYPE DESCRIPTION

trackingFieldId string
layout array
id string
parentId string
row integer
col integer
sizex number
sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject, Tab,
Integration, Tabs, Widget, OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
maxTrackingId number
workspaces array
createWorkspace boolean
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
timeSpentFieldId string
timeTrackingEnabled boolean
permissions object
uid string
version integer
id string
name string
disabled boolean
errors array

76 of 359
STATUS CODE - 400: Task<ApplicationImportResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
contentType string
serializerSettings undefined
statusCode integer
value undefined

STATUS CODE - 403: Task<ApplicationImportResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.14 POST /app/{id}/fields

Add one or more fields to the specified application

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The id of the application to add the fields to

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

applicationId string
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean

77 of 359
NAME TYPE DESCRIPTION

supportsMultipleOutputMappings boolean
createLayout enum ALLOWED:None,
AddToHidden, AddToLayout,
AddToNewSection
sectionName string

RESPONSE

STATUS CODE - 200: Task<IEnumerable<Field>>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

3.15 GET /app/fields/descriptor/mapping

Gets the mappings for descriptor types.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

78 of 359
NAME TYPE DESCRIPTION

message* string
code* integer between 100 and 600

79 of 359
4. ASSET

4.1 GET /asset/{id}

Gets the asset.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Asset.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
type string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
parameters object
descriptor object
type string
base64Image string
family string
version string
description string
testScript string
testScriptFile string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
inputParameters object
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string

80 of 359
NAME TYPE DESCRIPTION

url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

4.2 PUT /asset/{id}

Updates the asset.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier of asset to update.

81 of 359
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

description string
type string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
parameters object
descriptor object
type string
base64Image string
family string
version string
description string
testScript string
testScriptFile string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
inputParameters object
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

vendor string
product string
family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean

82 of 359
NAME TYPE DESCRIPTION

imageId string
id string
name string
disabled boolean
valid boolean
uid string
version integer
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: The updated asset.

RESPONSE MODEL - application/json

83 of 359
NAME TYPE DESCRIPTION

installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

4.3 DELETE /asset/{id}

Deletes the asset.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

84 of 359
RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

4.4 GET /asset

Gets the assets.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<Asset>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
type string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
parameters object
descriptor object
type string
base64Image string
family string
version string
description string
testScript string
testScriptFile string

85 of 359
NAME TYPE DESCRIPTION

pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3

inputParameters object
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

86 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

4.5 PUT /asset

Puts the asset old.

REQUEST

RESPONSE

STATUS CODE - 200: Asset.

RESPONSE MODEL - application/json

87 of 359
NAME TYPE DESCRIPTION

packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

4.6 POST /asset

Adds the asset.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

description string
type string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
parameters object

88 of 359
NAME TYPE DESCRIPTION

descriptor object
type string
base64Image string
family string
version string
description string
testScript string
testScriptFile string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
inputParameters object
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

89 of 359
NAME TYPE DESCRIPTION

uid string
version integer
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: The added asset.

RESPONSE MODEL - application/json

90 of 359
NAME TYPE DESCRIPTION

packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

4.7 GET /asset/list

Gets the assets list for UI.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Assets list object, de-duped images and asset light objects collection.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
images object
assets array
valid boolean

91 of 359
NAME TYPE DESCRIPTION

assetDescriptorVersion string
assetDescriptorProduct string
assetDescriptorVendor string
assetDescriptorImageId string
assetDescriptorDescription string
assetDescriptorName string
type string
disabled boolean
description string
name string
id string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

4.8 GET /asset/available

Gets the available assets descriptors.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<AssetDescriptor>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
type string
base64Image string
family string
version string
description string
testScript string
testScriptFile string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
inputParameters object
packageDescriptor object
name string
base64Image string

92 of 359
NAME TYPE DESCRIPTION

description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

vendor string
product string
family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean
imageId string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

4.9 POST /asset/test

Tests the specified asset.

REQUEST

RESPONSE

93 of 359
STATUS CODE - 200: AssetTestResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
successful boolean
errorMessage string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

94 of 359
5. CONTENT

5.1 POST /content/export/download

Exports Swimlane solution content package.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

exportName string
applicationIds array
appletIds array

RESPONSE

STATUS CODE - 200: Swimlane solution package. (Zip archive).

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

5.2 POST /content/export/try

Performs export dry run. Running collection and validation of entities.

If any errors or issues are encountered, the problem will contain an associated error code. Possible

95 of 359
codes are:

0: An unexpected error has occurred.1000: Could not load application file in package1001: Could
not load applet file in package1002: Could not load asset file in package1003: Could not load
dashboard file in package1004: Could not load export transformation file in package1005: Could
not load package descriptor file in package1006: Could not load available action descriptor file in
package1007: Could not load report file in package1008: Could not load task file in package1009:
Could not load workflow file in package1010: Could not load workspace file in package2000: An
error was encountered while saving an application2001: An error was encountered while saving an
applet2002: An error was encountered while saving an asset2003: An error was encountered while
saving a dashboard2004: An error was encountered while saving an export transformation2005:
An error was encountered while saving a plugin2006: An error was encountered while saving a
report2007: An error was encountered while saving a task2008: An error was encountered while
saving a workflow2009: An error was encountered while saving a workspace100: A value was
unexpectedly null or empty. (Obsolete)101: A file was missing from the ssp. (Obsolete)102: A file in
the ssp was unexpectedly empty. (Obsolete)3000: The SSP is missing a bundle file3001: The SSP
is missing a result file3002: The SSP is missing a mapping file3003: The SSP is missing an
application file3004: The SSP is missing an applet bundle file3005: The SSP is missing an asset
file3006: The SSP is missing a dashboard file3007: The SSP is missing an export transformation
file3008: The SSP is missing a package descriptor file3009: The SSP is missing an available action
descriptor file3010: The SSP is missing a report file3011: The SSP is missing a task file3012: The
SSP is missing a workflow file3013: The SSP is missing a workspace file103: The requested entity
is not in the system. (Obsolete)4000: No application matching the provided ID exists4001: No
applet matching the provided ID exists4002: No task matching the provided ID exists4003: No
package descriptor matching the provided ID exists200: An entity with this UID is already present in
the system. (Obsolete)5000: An application with this UID is already present in the system.5001: An
applet with this UID is already present in the system.5002: An asset with this UID is already present
in the system.5003: A dashboard with this UID is already present in the system.5004: An export
transformation with this UID is already present in the system.5005: A report with this UID is already
present in the system.5006: A task with this UID is already present in the system.5007: A workflow
with this UID is already present in the system.5008: A workspace with this UID is already present in
the system.201: An entity with this acronym is already present in the system. (Obsolete)6000: An
application with this acronym is already present in the system.6001: An applet with this acronym is
already present in the system.202: An entity with this name is already present in the system.
(Obsolete)7000: An application with this name is already present in the system.7001: An applet
with this name is already present in the system.7002: An asset with this name is already present in
the system.8000: A workflow task reference was left undefined8001: A layout task reference was
left undefined8002: An output's email asset reference was left undefined8003: An output's task
reference was left undefined8004: An output's application reference was left undefined8005: A
trigger's email asset reference was left undefined8006: An action's plugin reference was left
undefined8007: An action's asset reference was left undefined8008: A package descriptor's name
was left undefined8009: A packages descriptor's file ID was left undefined8010: A reference field ID
in an application was left undefined8011: A reference field ID in an applet was left undefined8012:
A reference field in an application has an invalid type8013: A reference field in an applet has an
invalid type300: A secure credential has been removed during export. (Obsolete)9000: A secure
credential has been removed from an asset during export.9001: A key store reference has been
removed from a task during export.302: Entries from a user/group field have been removed during
export. (Obsolete)10000: The notification recipients have been removed from an action.10001: An
action's user/group single-select field has been cleared.10002: An action's user/group multi-select
field has been cleared.10003: A condition's user/group single-select field has been cleared.10004:
A condition's user/group multi-select field has been cleared.10005: An application's user/group
field has been cleared.10006: An applet's user/group field has been cleared.11000: Mapping file
could not be deserialized.12000: An application has failed its validation12001: An applet has failed
its validation12002: An task has failed its validation12003: An application's workflow has failed its

96 of 359
validation12004: An applet's workflow has failed its validation13000: A task's asset has been
modified.400: The system has an older version of a plugin installed. Upgrade the plugin and try
again.401: The system has a newer version of a plugin installed. The older version cannot be
imported.301: A report filter has been removed during export.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

applicationIds array
appletIds array

RESPONSE

STATUS CODE - 200: Returns dry run results including errors and issues encountered.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
errors object
entities object
state enum ALLOWED:Incomplete, Success, Failure
issues object
images object
swimlaneVersion string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

5.3 POST /content/import

Imports Swimlane solution content package.

If any errors or issues are encountered, the problem will contain an associated error code. Possible
codes are:

97 of 359
saving a workflow2009: An error was encountered while saving a workspace100: A value was
unexpectedly null or empty. (Obsolete)101: A file was missing from the ssp. (Obsolete)102: A file in
the ssp was unexpectedly empty. (Obsolete)3000: The SSP is missing a bundle file3001: The SSP
is missing a result file3002: The SSP is missing a mapping file3003: The SSP is missing an
application file3004: The SSP is missing an applet bundle file3005: The SSP is missing an asset
file3006: The SSP is missing a dashboard file3007: The SSP is missing an export transformation
file3008: The SSP is missing a package descriptor file3009: The SSP is missing an available action
descriptor file3010: The SSP is missing a report file3011: The SSP is missing a task file3012: The
SSP is missing a workflow file3013: The SSP is missing a workspace file103: The requested entity
is not in the system. (Obsolete)4000: No application matching the provided ID exists4001: No
applet matching the provided ID exists4002: No task matching the provided ID exists4003: No
package descriptor matching the provided ID exists200: An entity with this UID is already present in
the system. (Obsolete)5000: An application with this UID is already present in the system.5001: An
applet with this UID is already present in the system.5002: An asset with this UID is already present
in the system.5003: A dashboard with this UID is already present in the system.5004: An export
transformation with this UID is already present in the system.5005: A report with this UID is already
present in the system.5006: A task with this UID is already present in the system.5007: A workflow
with this UID is already present in the system.5008: A workspace with this UID is already present in
the system.201: An entity with this acronym is already present in the system. (Obsolete)6000: An
application with this acronym is already present in the system.6001: An applet with this acronym is
already present in the system.202: An entity with this name is already present in the system.
(Obsolete)7000: An application with this name is already present in the system.7001: An applet
with this name is already present in the system.7002: An asset with this name is already present in
the system.8000: A workflow task reference was left undefined8001: A layout task reference was
left undefined8002: An output's email asset reference was left undefined8003: An output's task
reference was left undefined8004: An output's application reference was left undefined8005: A
trigger's email asset reference was left undefined8006: An action's plugin reference was left
undefined8007: An action's asset reference was left undefined8008: A package descriptor's name
was left undefined8009: A packages descriptor's file ID was left undefined8010: A reference field ID
in an application was left undefined8011: A reference field ID in an applet was left undefined8012:
A reference field in an application has an invalid type8013: A reference field in an applet has an
invalid type300: A secure credential has been removed during export. (Obsolete)9000: A secure
credential has been removed from an asset during export.9001: A key store reference has been
removed from a task during export.302: Entries from a user/group field have been removed during
export. (Obsolete)10000: The notification recipients have been removed from an action.10001: An
action's user/group single-select field has been cleared.10002: An action's user/group multi-select
field has been cleared.10003: A condition's user/group single-select field has been cleared.10004:
A condition's user/group multi-select field has been cleared.10005: An application's user/group
field has been cleared.10006: An applet's user/group field has been cleared.11000: Mapping file
could not be deserialized.12000: An application has failed its validation12001: An applet has failed
its validation12002: An task has failed its validation12003: An application's workflow has failed its
validation12004: An applet's workflow has failed its validation13000: A task's asset has been
modified.400: The system has an older version of a plugin installed. Upgrade the plugin and try
again.401: The system has a newer version of a plugin installed. The older version cannot be
imported.301: A report filter has been removed during export.

REQUEST
FORM DATA PARAMETERS
NAME TYPE DESCRIPTION

file string(binary) Swimlane solution content package, ssp.

runInBackground boolean Determines if import process should run as a background task.
Defaults to true.

98 of 359
RESPONSE

STATUS CODE - 200: A tracking ID which can be used to retrieve the status and results of the import process.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

5.4 GET /content/import/{trackingId}/status

Retrieves the status and results (if available) of a content exchange import.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*trackingId string Tracking ID of the import process.

RESPONSE

STATUS CODE - 200: <see cref="T:Core.Models.Content.ContentExchangeResult" />

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
entities object
issues object
errors object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
state enum ALLOWED:Incomplete, Success, Failure
images object
swimlaneVersion string
id string
name string
disabled boolean

99 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

100 of 359
6. CREDENTIALS

6.1 GET /credentials

Gets the credentials.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Dictionary of credential names with masked values.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

6.2 PUT /credentials

Updates the credentials.

REQUEST

RESPONSE

STATUS CODE - 200: IActionResult.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

6.3 POST /credentials

Creates new credentials.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

101 of 359
NAME TYPE DESCRIPTION

name string
value string
linkedId string
isInternal boolean

RESPONSE

STATUS CODE - 200: Unencrypted credentials back.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

6.4 GET /credentials/{name}

Gets the credential by name.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*name string The name.

RESPONSE

STATUS CODE - 200: Name value pair (value is masked)

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
name string
value string
linkedId string
isInternal boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

102 of 359
6.5 PUT /credentials/{name}

Updates the credentials.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*name string The name.

RESPONSE

STATUS CODE - 200: IActionResult.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

6.6 DELETE /credentials/{name}

Deletes the credentials.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*name string The name.

RESPONSE

STATUS CODE - 200: IActionResult.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

103 of 359
7. DASHBOARD

7.1 GET /dashboard/workspace/{id}

Gets dashboards containing the identified workspace.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The workspace identifier.

RESPONSE

STATUS CODE - 200: IEnumerable<Dashboard>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
workspaces array
items array
id string
name string
description string
autoRefreshMilliseconds integer
cardType enum ALLOWED:Report, Html, UsageStatistic
row integer
col integer
sizeX integer
sizeY integer
timelineEnabled boolean
timelineFilters object
minTimelineDate string
maxTimelineDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
permissions object

104 of 359
NAME TYPE DESCRIPTION

allowed array
id string
name string
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

7.2 GET /dashboard/status/workspace/{id}

Gets a map of dashboard ids with their status i.e. enabled or disabled if they have any
schedules.If the report does not have schedules will not be added to the map.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The workspace id.

RESPONSE

STATUS CODE - 200: The Dictionary with the report ids and their status calculated.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

7.3 GET /dashboard/{id}

Gets the specified dashboard.

REQUEST

105 of 359
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Dashboard.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
workspaces array
items array
id string
name string
description string
autoRefreshMilliseconds integer
cardType enum ALLOWED:Report, Html, UsageStatistic
row integer
col integer
sizeX integer
sizeY integer
timelineEnabled boolean
timelineFilters object
minTimelineDate string
maxTimelineDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
permissions object
allowed array
id string
name string
uid string
version integer
id string
name string
disabled boolean

106 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

7.4 PUT /dashboard/{id}

Updates the specified dashboard.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The dashboard ID

RESPONSE

STATUS CODE - 200: The saved dashboard.

RESPONSE MODEL - application/json

107 of 359
NAME TYPE DESCRIPTION

name string
createdDate string
modifiedDate string
permissions object
allowed array
id string
name string
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

7.5 DELETE /dashboard/{id}

Deletes the specified dashboard.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

108 of 359
NAME TYPE DESCRIPTION

message* string
code* integer between 100 and 600

7.6 GET /dashboard

Gets all dashboards in application.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Dashboard collection

RESPONSE MODEL - application/json

109 of 359
NAME TYPE DESCRIPTION

name string
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

7.7 PUT /dashboard

Updates the specified dashboard.

REQUEST

RESPONSE

STATUS CODE - 200: The saved dashboard.

RESPONSE MODEL - application/json

110 of 359
NAME TYPE DESCRIPTION

name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
permissions object
allowed array
id string
name string
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

7.8 POST /dashboard

Inserts/Creates the dashboard.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

description string
workspaces array
items array
id string
name string
description string
autoRefreshMilliseconds integer
cardType enum ALLOWED:Report, Html, UsageStatistic
row integer
col integer
sizeX integer
sizeY integer
timelineEnabled boolean

111 of 359
NAME TYPE DESCRIPTION

timelineFilters object
minTimelineDate string
maxTimelineDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
permissions object
allowed array
id string
name string
uid string
version integer
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: The saved dashboard

RESPONSE MODEL - application/json

112 of 359
NAME TYPE DESCRIPTION

createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
permissions object
allowed array
id string
name string
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

113 of 359
8. DATAIMPORT

8.1 POST /data-import/upload

Uploads the file to database.

REQUEST

RESPONSE

STATUS CODE - 200: object.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

8.2 POST /data-import/run

Runs the submitted data import.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

fileId string
applicationId string
columns array
header string
fieldId string
addMissing boolean
hasHeaders boolean
dataFormat string
userFormat string
createType enum ALLOWED:InsertOnly, Replace, Update
errorHandlingType enum ALLOWED:SetEmptyColumn, SkipRow, CancelImport
keyFieldId string
hasHeaders boolean

RESPONSE

STATUS CODE - 200: System.String.

114 of 359
RESPONSE MODEL - application/json

STATUS CODE - 204: System.String.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

115 of 359
9. FORMULA

9.1 POST /app/formula-validate

Validate formulas.

Superceeds ValidateFormula

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

formula string
application object
description string
acronym string
trackingFieldId string
layout array
id string
parentId string
row integer
col integer
sizex number
sizey number
layoutType enum ALLOWED:None,
Field, Section, HtmlObject, Tab,
Integration, Tabs, Widget, OrchestrationTask
fields array
id string
name string
key string
sourceAppletFieldId string
sourceAppletId string
fieldType enum ALLOWED:None,
Text, Numeric, ValuesList, Date,
UserGroup, Attachment, Tracking, Reference,
Comments, History, List
required boolean
readOnly boolean
supportsMultipleOutputMappings boolean
maxTrackingId number
workspaces array
createWorkspace boolean
createdDate string
createdByUser object
id string

116 of 359
NAME TYPE DESCRIPTION

name string
modifiedDate string
modifiedByUser object
id string
name string
timeSpentFieldId string
timeTrackingEnabled boolean
permissions object
uid string
version integer
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: Http response codes.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

117 of 359
10. GROUPS

10.1 GET /groups/{id}

Gets the specified group.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: The GroupService

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
users array
id string
name string
disabled boolean
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean
activeDirectoryGuids array
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
id string
name string
disabled boolean

118 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

10.2 PUT /groups/{id}

Updates the specified group.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

description string
users array
id string
name string
disabled boolean
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean
activeDirectoryGuids array
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
id string
name string
disabled boolean

119 of 359
RESPONSE

STATUS CODE - 200: Saved GroupService.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

10.3 DELETE /groups/{id}

Deletes the specified group.

REQUEST

120 of 359
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

10.4 GET /groups

Gets an amount of groups based on the paged search criteria.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

size integer The number of documents to gather after skip..

pageNumber integer Page number to skip.
sortFieldName string The group field name to be sorted.
sortType string The direction of the sorting.
searchFieldName string The field name where the search will be executed.
searchValue string The search value to look into the search field name.

RESPONSE

STATUS CODE - 200: PagedResponse<Group>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
totalCount integer
items array

121 of 359
NAME TYPE DESCRIPTION

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

10.5 POST /groups

Inserts/Creates the specified group.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

description string
users array
id string

122 of 359
NAME TYPE DESCRIPTION

name string
disabled boolean
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean
activeDirectoryGuids array
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: Saved Group.

RESPONSE MODEL - application/json

123 of 359
NAME TYPE DESCRIPTION

createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

10.6 GET /groups/lookup

Gets all groups for whose name starts with query.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*name string The name.

appId string The application identifier.
appletId string The applet identifier.
fieldId string The field identifier.

RESPONSE

STATUS CODE - 200: GroupService collection.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
users array
id string
name string
disabled boolean
groups array

124 of 359
NAME TYPE DESCRIPTION

id string
name string
disabled boolean
roles array
id string
name string
disabled boolean
activeDirectoryGuids array
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

125 of 359
11. HEALTH

11.1 GET /health/ping

A basic ping endpoint for clients to use to test connectivity to the Swimlane API.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

11.2 GET /health/wait/{duration}

A basic ping endpoint for clients to use to test connectivity to the Swimlane API.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*duration integer

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

126 of 359
11.3 GET /health/tasksstatus

A basic endpoint for checking the health state of Swimalne web server.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

128 of 359
RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

129 of 359
12. ICON

12.1 GET /icon/{id}

Gets the icon by id.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Task<IconImageModel>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
image64 string
id string
name string
thumbnail64 string

STATUS CODE - 404: Task<IconImageModel>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

12.2 GET /icon

Gets the icons ordered by name. Note only thumbnail is included in results, not the full icon.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer The page to return.

size integer The number of icons to return.

RESPONSE
130 of 359
STATUS CODE - 200: Task<PagedResponse<IconModel>>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
totalCount integer
items array
id string
name string
thumbnail64 string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

131 of 359
13. LOGGING

13.1 POST /logging/recent

Finds the recent logs.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

level array

RESPONSE

STATUS CODE - 200: Log entries collection.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
level string
message string
timeStamp string
hostName string
userName string
methodName string
exceptionMessage string
exceptionMethod string
exceptionType string
exceptionStackTrace string
exceptionWithInner string
id string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

13.2 POST /logging/offset

Finds logs by the provided offset.

REQUEST
REQUEST BODY - application/json

132 of 359
NAME TYPE DESCRIPTION

offset string
queryFilter enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual, LessThan,
LessThanOrEqual, GreaterThan, GreaterThanOrEqual, Previous, Current,
Next, Exists, Hour, DayOfWeek
querySort enum ALLOWED:Ascending, Descending
level array

RESPONSE

STATUS CODE - 200: Log entries collection.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

13.3 POST /logging/date

Finds logs before, after and equals the provided date.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

date string
level array

RESPONSE

133 of 359
STATUS CODE - 200: Log entries collection.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

13.4 GET /logging/job/{jobId}

Gets the job information.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*jobId string The job identifier.

RESPONSE

STATUS CODE - 200: IEnumerable<JobInfo>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

134 of 359
13.5 POST /logging/

Insert new log entry.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

errorUrl string
errorMessage string
stackTrace array
cause string

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

135 of 359
14. ONETIMEPASSWORD

14.1 POST /otp/enroll

Enrolls the current logged in user in 2FA / OTP

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

userName string
password string

RESPONSE

STATUS CODE - 200: 200 with OTP secret and key uri if successful, 400 if not

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
secret string
keyUri string

STATUS CODE - 400: 200 with OTP secret and key uri if successful, 400 if not

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

STATUS CODE - 401: 200 with OTP secret and key uri if successful, 400 if not

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

14.2 POST /otp/secret/verify

Verify that the secret has been correctly configured within the user's 2FA / OTP application of

136 of 359
choice

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

userName string
password string
oneTimePassword string

RESPONSE

STATUS CODE - 200: Whether (or not) the secret has been verified

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
value undefined
formatters array
contentTypes array
declaredType string
statusCode integer

STATUS CODE - 204: Whether (or not) the secret has been verified

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 400: Whether (or not) the secret has been verified

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

STATUS CODE - 401: Whether (or not) the secret has been verified

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

137 of 359
14.3 POST /otp/opt-out

Opts the user out of 2FA / OTP (if not enforced)

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

password string

RESPONSE

STATUS CODE - 200: The result

RESPONSE MODEL - application/json

STATUS CODE - 204: The result

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 400: The result

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

14.4 POST /otp/exempt

Exempts the user from 2FA / OTP when globally enforced, requires adminpermissions

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

userName string

RESPONSE

STATUS CODE - 200: 204 if the request succeeds, 400 or 403 otherwise

138 of 359
RESPONSE MODEL - application/json

STATUS CODE - 204: 204 if the request succeeds, 400 or 403 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 400: 204 if the request succeeds, 400 or 403 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

STATUS CODE - 403: 204 if the request succeeds, 400 or 403 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

14.5 POST /otp/reset

Resets OTP for a user and flags them for re-enrollment on next login, requires adminpermissions

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

userName string

RESPONSE

STATUS CODE - 200: 204 if the request succeeds, 400 or 403 otherwise

RESPONSE MODEL - application/json

STATUS CODE - 204: 204 if the request succeeds, 400 or 403 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

139 of 359
NAME TYPE DESCRIPTION

statusCode integer

STATUS CODE - 400: 204 if the request succeeds, 400 or 403 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

STATUS CODE - 403: 204 if the request succeeds, 400 or 403 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

140 of 359
15. PIPPACKAGE

15.1 GET /pip/packages/{pythonVersion}

Gets all globally installed packages that were installed via Swimlane

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*pythonVersion string

RESPONSE

STATUS CODE - 200: The list of packages that were globally installed via Swimlane

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
version string
summary string
homePage string
author string
authorEmail string
license string
requires array
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
fileId string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

15.2 POST /pip/packages/

Globally installs the Python package with the given name and optional version number

REQUEST

141 of 359
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

name* string
version string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3

RESPONSE

STATUS CODE - 200: 200 if the Python package exists, 400 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 400: 200 if the Python package exists, 400 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

15.3 POST /pip/packages/offline

Globally installs the Python package with the given name and optional version number using whl
for offline installs

REQUEST
FORM DATA PARAMETERS
NAME TYPE DESCRIPTION

pythonVersion string The python version with which to install this whl.
wheel string(binary) The wheel of the python package to install.

RESPONSE

STATUS CODE - 200: 200 if the Python package exists, 400 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

142 of 359
NAME TYPE DESCRIPTION

statusCode integer

STATUS CODE - 400: 200 if the Python package exists, 400 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

15.4 DELETE /pip/packages/{packageName}/{pythonVersion}

Uninstalls a Python package that was globally installed via Swimlane

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*packageName string The name of the Python package to uninstall

*pythonVersion string

RESPONSE

STATUS CODE - 200: 204 if the package is installed, 404 otherwise

RESPONSE MODEL - application/json

STATUS CODE - 204: 204 if the package is installed, 404 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 404: 204 if the package is installed, 404 otherwise

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
content string
contentType string
statusCode integer

143 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

144 of 359
16. RECORD

16.1 POST /app/{appId}/record/{id}/calc/{fieldId}

Calculate field value.

Result can be string, date or number.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier.

*id string The record identifier
*fieldId string The field identifier.

RESPONSE

STATUS CODE - 200: Calculation result.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.2 GET /app/{appId}/record

Gets the base record for an application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier.

RESPONSE

STATUS CODE - 200: Record.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
name string

145 of 359
NAME TYPE DESCRIPTION

allowed array
id string
name string
trackingId number
trackingFull string
applicationId string
referencedRecordIds array
referencedByIds array
matches array
isNew boolean
values object
repeatFieldCurrentValues object
valuesDocument object
actionsExecuted object
visualizations object
applicationRevision number
coeditSession object
editors array
id string
name string
recordId string
applicationId string
values object
createdDate string
modifiedDate string
id string
name string
disabled boolean
locked boolean
lockingUser object
id string
name string
lockedDate string
comments object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string

146 of 359
NAME TYPE DESCRIPTION

sessionTimeSpent integer
totalTimeSpent integer
timeTrackingEnabled boolean
hangfireJobId string
isHangfireCreatedAndUnpersisted boolean
infiniteLoopFlag boolean
latestWorkflowRun array
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
lockTimestamp string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.3 PUT /app/{appId}/record

Updates the specified record.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

RESPONSE

147 of 359
STATUS CODE - 200: Record.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
name string
allowed array
id string
name string
trackingId number
trackingFull string
applicationId string
referencedRecordIds array
referencedByIds array
matches array
isNew boolean
values object
repeatFieldCurrentValues object
valuesDocument object
actionsExecuted object
visualizations object
applicationRevision number
coeditSession object
editors array
id string
name string
recordId string
applicationId string
values object
createdDate string
modifiedDate string
id string
name string
disabled boolean
locked boolean
lockingUser object
id string
name string
lockedDate string
comments object
createdDate string
modifiedDate string
createdByUser object
id string

148 of 359
NAME TYPE DESCRIPTION

name string
modifiedByUser object
id string
name string
sessionTimeSpent integer
totalTimeSpent integer
timeTrackingEnabled boolean
hangfireJobId string
isHangfireCreatedAndUnpersisted boolean
infiniteLoopFlag boolean
latestWorkflowRun array
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
lockTimestamp string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.4 POST /app/{appId}/record

Insert/Create the record.

The bare minimum you need to sendis (assuming applicaton id is 5667113fd273a205bc747cf0):

{"applicationId": "5667113fd273a205bc747cf0","values": {"$type":
"System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.Object, mscorlib]],
mscorlib","56674c5cc6c7dea0aeab4aed": "A new value"}
149 of 359
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

RESPONSE

STATUS CODE - 200: Saved record.

RESPONSE MODEL - application/json

150 of 359
NAME TYPE DESCRIPTION

name string
lockedDate string
comments object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
sessionTimeSpent integer
totalTimeSpent integer
timeTrackingEnabled boolean
hangfireJobId string
isHangfireCreatedAndUnpersisted boolean
infiniteLoopFlag boolean
latestWorkflowRun array
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
lockTimestamp string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

151 of 359
16.5 DELETE /app/{appId}/record

Deletes all records for identified application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.6 GET /app/{appId}/record/{id}

Gets the application application identifier record identifier.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier.

*id string The identifier.

RESPONSE

STATUS CODE - 200: Record.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
name string
allowed array

152 of 359
NAME TYPE DESCRIPTION

id string
name string
trackingId number
trackingFull string
applicationId string
referencedRecordIds array
referencedByIds array
matches array
isNew boolean
values object
repeatFieldCurrentValues object
valuesDocument object
actionsExecuted object
visualizations object
applicationRevision number
coeditSession object
editors array
id string
name string
recordId string
applicationId string
values object
createdDate string
modifiedDate string
id string
name string
disabled boolean
locked boolean
lockingUser object
id string
name string
lockedDate string
comments object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
sessionTimeSpent integer

153 of 359
NAME TYPE DESCRIPTION

totalTimeSpent integer
timeTrackingEnabled boolean
hangfireJobId string
isHangfireCreatedAndUnpersisted boolean
infiniteLoopFlag boolean
latestWorkflowRun array
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
lockTimestamp string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.7 PUT /app/{appId}/record/{id}

Updates the specified record.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*id string The record identifier

RESPONSE

154 of 359
STATUS CODE - 200: Record.

RESPONSE MODEL - application/json

155 of 359
NAME TYPE DESCRIPTION

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.8 DELETE /app/{appId}/record/{id}

Deletes the specified record.

REQUEST
PATH PARAMETERS

156 of 359
NAME TYPE DESCRIPTION

*appId string The application identifier

*id string The identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.9 PATCH /app/{appId}/record/{id}

Updates the record values

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*id string The record identifier

RESPONSE

STATUS CODE - 200: Record.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
name string
allowed array
id string
name string
trackingId number
trackingFull string

157 of 359
NAME TYPE DESCRIPTION

applicationId string
referencedRecordIds array
referencedByIds array
matches array
isNew boolean
values object
repeatFieldCurrentValues object
valuesDocument object
actionsExecuted object
visualizations object
applicationRevision number
coeditSession object
editors array
id string
name string
recordId string
applicationId string
values object
createdDate string
modifiedDate string
id string
name string
disabled boolean
locked boolean
lockingUser object
id string
name string
lockedDate string
comments object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
sessionTimeSpent integer
totalTimeSpent integer
timeTrackingEnabled boolean
hangfireJobId string
isHangfireCreatedAndUnpersisted boolean

158 of 359
NAME TYPE DESCRIPTION

infiniteLoopFlag boolean
latestWorkflowRun array
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
lockTimestamp string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.10 GET /app/{appId}/record/tracking/{trackingId}

Gets a record by tracking Id for an application

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier.

*trackingId string The tracking Id for the record requested.

RESPONSE

STATUS CODE - 200: Record.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

159 of 359
NAME TYPE DESCRIPTION

name string
allowed array
id string
name string
trackingId number
trackingFull string
applicationId string
referencedRecordIds array
referencedByIds array
matches array
isNew boolean
values object
repeatFieldCurrentValues object
valuesDocument object
actionsExecuted object
visualizations object
applicationRevision number
coeditSession object
editors array
id string
name string
recordId string
applicationId string
values object
createdDate string
modifiedDate string
id string
name string
disabled boolean
locked boolean
lockingUser object
id string
name string
lockedDate string
comments object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string

160 of 359
NAME TYPE DESCRIPTION

name string
sessionTimeSpent integer
totalTimeSpent integer
timeTrackingEnabled boolean
hangfireJobId string
isHangfireCreatedAndUnpersisted boolean
infiniteLoopFlag boolean
latestWorkflowRun array
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
lockTimestamp string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.11 POST /app/{appId}/record/{id}/references

Gets the referenced records by fields if specified.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*id string The record id.

161 of 359
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

recordIds array
fieldIds array

RESPONSE

STATUS CODE - 200: IEnumerable<ReferencedRecord>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
recordId string
values object
applicationId string
allowed array
id string
name string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.12 POST /app/{appId}/record/validate

Insert/Create the record.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

RESPONSE

STATUS CODE - 200: Saved record.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
id string

162 of 359
NAME TYPE DESCRIPTION

errorCodes enum ALLOWED:None,

PasswordExpired, DuplicateUserName,
InvalidUserNameOrPassword, ConfirmPasswordDoesNotMatch,
PasswordDoesNotMeetComplexityRequirements,
PasswordResetRequired, NewPasswordCannotMatchCurrent,
InvalidUser, DuplicateEmail, NonAdminUser, DuplicateGroupName,
DuplicateRoleName, DuplicateFieldName, FieldNameEmpty,
InvalidApplicationExportFile, ApplicationNotFound,
InvalidCalculation, DuplicateApplicationName,
DuplicateAppletName, DuplicateAppletAcronym,
DuplicateApplicationAcronym, AppletNotFound, SettingsInvalid,
SectionNameTooLong, DuplicateFieldValue, InvalidDateField,
RecordNotFound, FieldNotFound, RecordLocked,
CannotGeneratePdfPreview, BadStatsGroup, BadFilter, BadSort,
AppLimitExceeded, UserLimitExceeded, NewServerInstall,
UnableToConnectToActiveDirectory, UnableToRetrieveStoredValue,
UnableToConnectToMongoDb, UnableToConnectToSmtp,
SwimlaneAlreadyInitialized, ModelValidationError,
UpgradeInProcess, RequiredFieldMissing,
UnableToRetrieveEncryptionKey, PathNotFound, WrongType,
ModificationError, DatabaseError, NetworkError,
InvalidOnThisOS, DeserializationError, ContractRequiresError,
ContractEnsuresError, InvalidNumericInput,
InvalidSessionTimeout, InvalidInputTemplateString,
ConnectionDataNotProvided, RegexNotDefined, AssetNotFound,
BadThreatIntelConnector, NoThreatIntel,
ThreatIntelTypeNotSupportedByThisProvider, DuplicateTaskName,
TaskNotFound, PythonVersionNotSupported, TaskMigrated,
PackageAlreadyInstalled, PackageNotFound, PackageInstallError,
InvalidSupportedSwimlaneVersion, PackageUploadError,
PackageUpgradeError, UserAlreadyHasAccessToken,
AccessTokenNotFound, UserAlreadyEnrolledInOneTimePassword,
UserNotEnrolledInOneTimePassword, OneTimePasswordNotAvailable,
OneTimePasswordRecentlyUsed, OneTimePasswordUseIsNotEnforced,
SamlNotEnabled, SamlUserNotFound, SamlInternalError,
SamlUserValidationError, InvalidSamlResponse, WorkflowLocked,
FeatureFlagNotModifiable, DuplicateAssetName,
IngestionRuleInvalid, DuplicateIngestionRuleName,
DuplicateOrchestrationTaskName, OrchestrationTaskDisabled,
HangfireError, ReportNotFound, ReportProcessFailed,
CardsNotContained, WidgetsNotSupported, DashboardNotFound,
ContentExchangeError, CommentsListNotFound, CommentNotFound,
CommentNotOwned
errors array
succeeded boolean
error string
deletedCount integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

163 of 359
16.13 PUT /app/{appId}/record/batch

Update records in batch mode.

Updates records based on sent ids or query (filters) with new Values provided.Field identification in
values can be id, name or key.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string Application id, for records needed to be removed.

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

applicationId string
changeAll boolean
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual, LessThan,
LessThanOrEqual, GreaterThan, GreaterThanOrEqual, Previous,
Current, Next, Exists, Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute, Hour, Day, Week, Month, Quarter, Year, AllTime
value undefined
drillin boolean
keywords string
recordIds array
cutOffDate string
modifications array
fieldId object
value string
type enum ALLOWED:None, Id, Name, Key
value undefined
type enum ALLOWED:None, Create, Delete, Append, Subtract

RESPONSE

STATUS CODE - 200: Accepted with JobId of a task.

RESPONSE MODEL - application/json

STATUS CODE - 202: Accepted with JobId of a task.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

164 of 359
NAME TYPE DESCRIPTION

message* string
code* integer between 100 and 600

16.14 POST /app/{appId}/record/batch

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string

REQUEST BODY - application/json

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

STATUS CODE - 204:

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.15 DELETE /app/{appId}/record/batch

Delete records in batch mode.

Delete records based on sent ids or query (filters).

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string Application id, for records needed to be removed.

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

applicationId string

165 of 359
NAME TYPE DESCRIPTION

changeAll boolean
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual, LessThan,
LessThanOrEqual, GreaterThan, GreaterThanOrEqual, Previous,
Current, Next, Exists, Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute, Hour, Day, Week, Month, Quarter, Year, AllTime
value undefined
drillin boolean
keywords string
recordIds array
cutOffDate string
modifications array
fieldId object
value string
type enum ALLOWED:None, Id, Name, Key
value undefined
type enum ALLOWED:None, Create, Delete, Append, Subtract

RESPONSE

STATUS CODE - 200: Accepted with JobId of a task.

RESPONSE MODEL - application/json

STATUS CODE - 202: Accepted with JobId of a task.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.16 PUT /app/{appId}/record/{id}/restrict

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string
*id string

REQUEST BODY - application/json

RESPONSE
166 of 359
STATUS CODE - 200:

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204:

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.17 POST /app/{appId}/record/{recordId}/add-references

Add references to an existing record.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The referencing application identifer

*recordId string The referencing record identifer

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

fieldId string
targetRecordIds array

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

167 of 359
NAME TYPE DESCRIPTION

message* string
code* integer between 100 and 600

16.18 POST /app/{appId}/record/{recordId}/{fieldId}/comment

Add a comment to a existing record.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*recordId string The record identifier
*fieldId string The field identifier

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

message string
createdDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
modifiedDate string
isRichText boolean

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION

168 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.19 PUT /app/{appId}/record/{recordId}/{fieldId}/comment/{index}

Update a comment from an existing record.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*recordId string The record identifier
*fieldId string The field identifier
*index integer The index of the comment to be updated

REQUEST BODY - application/json

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.20 POST /app/{appId}/record/{recordId}/lock

Locks the specified record

REQUEST

169 of 359
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*recordId string The record identifier

RESPONSE

STATUS CODE - 200: IActionResult.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.21 POST /app/{appId}/record/{recordId}/unlock

Un-Locks the specified record

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*recordId string The record identifier

RESPONSE

STATUS CODE - 200: IActionResult.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.22 POST /app/{appId}/record/{id}/unique/{fieldId}

Validates the field has unique values across the records.

REQUEST

170 of 359
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier.

*fieldId string The field identifier.
*id string The record identifier.

REQUEST BODY - application/json

RESPONSE

STATUS CODE - 200: The validation result.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
unique boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.23 GET /app/{appId}/record/{id}/history

Gets the revision history for specified record.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*id string The identifier.

RESPONSE

STATUS CODE - 200: The revisons collection.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
revisionNumber number
status enum ALLOWED:Current, Historical, Deleted
userId object
id string
name string
modifiedDate string

171 of 359
NAME TYPE DESCRIPTION

version undefined

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.24 GET /app/{appId}/record/{id}/history/{revision}

Gets the specified revision of the record.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*id string The record identifier.
*revision number The revision number.

RESPONSE

STATUS CODE - 200: The Revision

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
revisionNumber number
status enum ALLOWED:Current, Historical, Deleted
userId object
id string
name string
modifiedDate string
version undefined

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.25 GET /app/{appId}/record/{id}/history/{revision}/diff

Gets the diff between revision of the record and the current record.
172 of 359
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier

*id string The record identifier.
*revision number The revision number.

RESPONSE

STATUS CODE - 200: The Revision

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
differential object
valuesChange object
newComments object
fromRevisionNumber number
referenceId string
referenceCollection string
revisionNumber number
status enum ALLOWED:Current, Historical, Deleted
userId object
id string
name string
modifiedDate string
version undefined
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.26 GET /app/{appId}/record/{id}/export/{formatId}

Generates a formatted export of a record.

REQUEST
PATH PARAMETERS

173 of 359
NAME TYPE DESCRIPTION

*appId string The application identifier

*id string The record identifier of the record to export
*formatId string The format identifier of the lay

RESPONSE

STATUS CODE - 200: The exported record in the specified format

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

16.27 GET /app/{appId}/record/underEdit

Gets the number of the records currently being edited for specified application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier.

RESPONSE

STATUS CODE - 200: The number records currently being edited, that belong to this application

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

174 of 359
17. REPORTS

17.1 GET /reports/{id}

Gets the specified report.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Report.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
groupBys array
fieldId string
groupByType enum ALLOWED:GroupBy,
GroupByHour, GroupByDay,
GroupByWeek, GroupByMonth, GroupByQuarter,
GroupByYear, GroupByNull
aggregates array
fieldId string
aggregateType enum ALLOWED:Average, Count, Sum, Min, Max
applicationIds array
keywords string
columns array
sorts object
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Previous, Current, Next, Exists,
Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute, Hour, Day, Week, Month, Quarter,
Year, AllTime
value undefined
drillin boolean
countByApplicationFacet boolean
pageSize integer
offset integer
defaultSearchReport boolean

175 of 359
NAME TYPE DESCRIPTION

allowed array
id string
name string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD1 array
name undefined

176 of 359
NAME TYPE DESCRIPTION

colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.2 PUT /reports/{id}

Updates the specified report.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The report identifier

177 of 359
RESPONSE

STATUS CODE - 200: Saved Report.

RESPONSE MODEL - application/json

178 of 359
NAME TYPE DESCRIPTION

colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string

179 of 359
NAME TYPE DESCRIPTION

bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.3 DELETE /reports/{id}

Deletes the specified report.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

180 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.4 GET /reports/app/{appId}

Gets the reports for specific application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier.

RESPONSE

STATUS CODE - 200: IEnumerable<Report>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
groupBys array
fieldId string
groupByType enum ALLOWED:GroupBy,
GroupByHour, GroupByDay,
GroupByWeek, GroupByMonth, GroupByQuarter,
GroupByYear, GroupByNull
aggregates array
fieldId string
aggregateType enum ALLOWED:Average, Count, Sum, Min, Max
applicationIds array
keywords string
columns array
sorts object
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Previous, Current, Next, Exists,
Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute, Hour, Day, Week, Month, Quarter,
Year, AllTime
value undefined
drillin boolean
countByApplicationFacet boolean
pageSize integer

181 of 359
NAME TYPE DESCRIPTION

offset integer
defaultSearchReport boolean
allowed array
id string
name string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending

182 of 359
NAME TYPE DESCRIPTION

entriesD1 array
name undefined
colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.5 DELETE /reports/app/{appId}

Delete reports by application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

183 of 359
NAME TYPE DESCRIPTION

*appId string The application identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.6 GET /reports

Gets all reports.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<Report>.

RESPONSE MODEL - application/json

184 of 359
NAME TYPE DESCRIPTION

keywords string
columns array
sorts object
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Previous, Current, Next, Exists,
Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute, Hour, Day, Week, Month, Quarter,
Year, AllTime
value undefined
drillin boolean
countByApplicationFacet boolean
pageSize integer
offset integer
defaultSearchReport boolean
allowed array
id string
name string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean

185 of 359
NAME TYPE DESCRIPTION

showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

186 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.7 POST /reports

Inserts/Creates the specified report.

REQUEST

RESPONSE

STATUS CODE - 200: Saved Report.

RESPONSE MODEL - application/json

187 of 359
NAME TYPE DESCRIPTION

name string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string

188 of 359
NAME TYPE DESCRIPTION

value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.8 GET /reports/app/{id}/default

Gets the default report for the application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The application identifier.

RESPONSE

STATUS CODE - 200: The Report

189 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
groupBys array
fieldId string
groupByType enum ALLOWED:GroupBy,
GroupByHour, GroupByDay,
GroupByWeek, GroupByMonth, GroupByQuarter,
GroupByYear, GroupByNull
aggregates array
fieldId string
aggregateType enum ALLOWED:Average, Count, Sum, Min, Max
applicationIds array
keywords string
columns array
sorts object
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Previous, Current, Next, Exists,
Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute, Hour, Day, Week, Month, Quarter,
Year, AllTime
value undefined
drillin boolean
countByApplicationFacet boolean
pageSize integer
offset integer
defaultSearchReport boolean
allowed array
id string
name string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced

190 of 359
NAME TYPE DESCRIPTION

chartType enum ALLOWED:VerticalBar,

HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer

191 of 359
NAME TYPE DESCRIPTION

startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.9 GET /reports/workspace/{id}

Gets the reports in the workspace.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The workspace identifier.

RESPONSE

STATUS CODE - 200: The Report collection.

RESPONSE MODEL - application/json

192 of 359
NAME TYPE DESCRIPTION

sorts object
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Previous, Current, Next, Exists,
Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute, Hour, Day, Week, Month, Quarter,
Year, AllTime
value undefined
drillin boolean
countByApplicationFacet boolean
pageSize integer
offset integer
defaultSearchReport boolean
allowed array
id string
name string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string

193 of 359
NAME TYPE DESCRIPTION

gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION

194 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.10 PUT /reports/

Updates the specified report.

REQUEST

RESPONSE

STATUS CODE - 200: Saved Report.

RESPONSE MODEL - application/json

195 of 359
NAME TYPE DESCRIPTION

permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string
value string

196 of 359
NAME TYPE DESCRIPTION

linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

17.11 GET /reports/status/workspace/{id}

Gets a Dictionary with the report ids with a status enabled or disabled if has schedules reports, if
the report does not have schedules will not be added to the dictionary.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string

RESPONSE

STATUS CODE - 200: The Dictionary with the report ids and their status calculated.

197 of 359
RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

198 of 359
18. ROLES

18.1 GET /roles/{id}

Gets the specified role.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The role identifier.

RESPONSE

STATUS CODE - 200: The role.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean
users array
id string
name string
disabled boolean
id string
name string
disabled boolean

199 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

18.2 PUT /roles/{id}

Updates the specified role.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The role identifier.

RESPONSE

STATUS CODE - 200: Saved role

RESPONSE MODEL - application/json

200 of 359
NAME TYPE DESCRIPTION

disabled boolean
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

18.3 DELETE /roles/{id}

Deletes the specified role.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The role identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

18.4 GET /roles/

Gets an amount of roles based on the paged search criteria.

REQUEST

201 of 359
QUERY PARAMETERS
NAME TYPE DESCRIPTION

size integer The number of documents to gather after skip..

pageNumber integer Page number to skip.
sortFieldName string The roles field name to be sorted.
sortType string The direction of the sorting.
searchFieldName string The field name where the search will be executed.
searchValue string The search value to look into the search field name.

RESPONSE

STATUS CODE - 200: PagedResponse<Role>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
totalCount integer
items array
description string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean
users array
id string
name string
disabled boolean
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

202 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

18.5 POST /roles/

Inserts/Creates the role.

REQUEST

RESPONSE

STATUS CODE - 200: Saved role

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

203 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

18.6 GET /roles/light

Gets the light models of the roles.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: The RoleView model

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

204 of 359
19. SAML

19.1 GET /saml/enabled

Gets a SAML AuthnRequest

Required so the UI can determine if SAML is enabled before the user has logged in.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: True if

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

205 of 359
20. SCHEDULEDDASHBOARD

20.1 GET /scheduled/dashboard

Gets all schedule dashboards

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<Dashboard>

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
applicationId string
notes string
recipients array
itemType string
id string
name string
includeLink boolean
includeCsv boolean
includeTable boolean
scheduleType enum ALLOWED:Recurring, OneTime
cronExpression string
scheduleTime string
layout enum ALLOWED:Portrait, Landscape
reportId string
dashboardId string
scheduleReportType enum ALLOWED:Report, Dashboard
createdDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
modifiedDate string
dashboardCards array
cardId string
row integer
col integer

206 of 359
NAME TYPE DESCRIPTION

sizeX integer
sizeY integer
recipients array
itemType string
id string
name string
notes string
includeLink boolean
cronExpression string
runOneTime string
layout enum ALLOWED:Portrait, Landscape
header string
footer string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
currentUserId string
link string
id string
name string
disabled boolean
header string
footer string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

20.2 POST /scheduled/dashboard

Inserts/Creates the specified scheduled dashboard

207 of 359
REQUEST

RESPONSE

STATUS CODE - 200: Saved Scheduled Dashboard

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
applicationId string
notes string
recipients array
itemType string
id string
name string
includeLink boolean
includeCsv boolean
includeTable boolean
scheduleType enum ALLOWED:Recurring, OneTime
cronExpression string
scheduleTime string
layout enum ALLOWED:Portrait, Landscape
reportId string
dashboardId string
scheduleReportType enum ALLOWED:Report, Dashboard
createdDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
modifiedDate string
dashboardCards array
cardId string
row integer
col integer
sizeX integer
sizeY integer
recipients array
itemType string
id string
name string
notes string
includeLink boolean

208 of 359
NAME TYPE DESCRIPTION

cronExpression string
runOneTime string
layout enum ALLOWED:Portrait, Landscape
header string
footer string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
currentUserId string
link string
id string
name string
disabled boolean
header string
footer string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

20.3 GET /scheduled/dashboard/{dashboardId}

Gets scheduled dashboards by dashboard id

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*dashboardId string The dashboard identifier

RESPONSE

STATUS CODE - 200: IEnumerable<Scheduled Dashboard>

209 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
applicationId string
notes string
recipients array
itemType string
id string
name string
includeLink boolean
includeCsv boolean
includeTable boolean
scheduleType enum ALLOWED:Recurring, OneTime
cronExpression string
scheduleTime string
layout enum ALLOWED:Portrait, Landscape
reportId string
dashboardId string
scheduleReportType enum ALLOWED:Report, Dashboard
createdDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
modifiedDate string
dashboardCards array
cardId string
row integer
col integer
sizeX integer
sizeY integer
recipients array
itemType string
id string
name string
notes string
includeLink boolean
cronExpression string
runOneTime string
layout enum ALLOWED:Portrait, Landscape
header string

210 of 359
NAME TYPE DESCRIPTION

footer string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
currentUserId string
link string
id string
name string
disabled boolean
header string
footer string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

20.4 PUT /scheduled/dashboard/{id}

Updates the specified scheduled dashboard

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The scheduled dashboard identifier

RESPONSE

STATUS CODE - 200: Saved Scheduled Dashboard

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
applicationId string

211 of 359
NAME TYPE DESCRIPTION

notes string
recipients array
itemType string
id string
name string
includeLink boolean
includeCsv boolean
includeTable boolean
scheduleType enum ALLOWED:Recurring, OneTime
cronExpression string
scheduleTime string
layout enum ALLOWED:Portrait, Landscape
reportId string
dashboardId string
scheduleReportType enum ALLOWED:Report, Dashboard
createdDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
modifiedDate string
dashboardCards array
cardId string
row integer
col integer
sizeX integer
sizeY integer
recipients array
itemType string
id string
name string
notes string
includeLink boolean
cronExpression string
runOneTime string
layout enum ALLOWED:Portrait, Landscape
header string
footer string
createdDate string
createdByUser object

212 of 359
NAME TYPE DESCRIPTION

id string
name string
modifiedDate string
modifiedByUser object
id string
name string
currentUserId string
link string
id string
name string
disabled boolean
header string
footer string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

20.5 DELETE /scheduled/dashboard/{id}

Deletes the specified scheduled dashboard

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The scheduled dashboard identifier

RESPONSE

STATUS CODE - 200: NoContentResult

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: NoContentResult

RESPONSE MODEL - application/json

213 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

214 of 359
21. SCHEDULEDREPORT

21.1 GET /scheduled/reports

Gets all schedule reports

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<Report>

RESPONSE MODEL - application/json

215 of 359
NAME TYPE DESCRIPTION

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

21.2 GET /scheduled/report/{reportId}

Gets schedule reports by report id

216 of 359
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*reportId string

RESPONSE

STATUS CODE - 200: IEnumerable<Scheduled Report>

RESPONSE MODEL - application/json

217 of 359
NAME TYPE DESCRIPTION

id string
name string
notes string
includeLink boolean
cronExpression string
runOneTime string
layout enum ALLOWED:Portrait, Landscape
header string
footer string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
currentUserId string
link string
id string
name string
disabled boolean
header string
footer string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

21.3 GET /scheduled/{scheduledId}

Gets scheduled report by id

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

218 of 359
NAME TYPE DESCRIPTION

*scheduledId string

RESPONSE

STATUS CODE - 200: Scheduled Report

RESPONSE MODEL - application/json

219 of 359
NAME TYPE DESCRIPTION

notes string
includeLink boolean
cronExpression string
runOneTime string
layout enum ALLOWED:Portrait, Landscape
header string
footer string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
currentUserId string
link string
id string
name string
disabled boolean
header string
footer string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

21.4 PUT /scheduled/{id}

Updates the specified scheduled report

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The scheduled report identifier

220 of 359
RESPONSE

STATUS CODE - 200: Saved Scheduled Report

RESPONSE MODEL - application/json

221 of 359
NAME TYPE DESCRIPTION

runOneTime string
layout enum ALLOWED:Portrait, Landscape
header string
footer string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
currentUserId string
link string
id string
name string
disabled boolean
header string
footer string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

21.5 DELETE /scheduled/{id}

Deletes the specified scheduled report

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The scheduled report identifier

RESPONSE

STATUS CODE - 200: NoContentResult

222 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: NoContentResult

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

21.6 POST /scheduled

Inserts/Creates the specified scheduled report

REQUEST

RESPONSE

STATUS CODE - 200: Saved Scheduled Report

RESPONSE MODEL - application/json

223 of 359
NAME TYPE DESCRIPTION

createdDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
modifiedDate string
dashboardCards array
cardId string
row integer
col integer
sizeX integer
sizeY integer
recipients array
itemType string
id string
name string
notes string
includeLink boolean
cronExpression string
runOneTime string
layout enum ALLOWED:Portrait, Landscape
header string
footer string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
currentUserId string
link string
id string
name string
disabled boolean
header string
footer string
id string
name string

224 of 359
NAME TYPE DESCRIPTION

disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

225 of 359
22. SEARCH

22.1 POST /search/stats

Gets statistics for defined on report.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

groupBys array
fieldId string
groupByType enum ALLOWED:GroupBy,
GroupByHour, GroupByDay, GroupByWeek,
GroupByMonth, GroupByQuarter, GroupByYear,
GroupByNull
aggregates array
fieldId string
aggregateType enum ALLOWED:Average, Count, Sum, Min, Max
applicationIds array
keywords string
columns array
sorts object
filters array
fieldId string
filterType enum ALLOWED:Contains,
Excludes, Equals, DoesNotEqual,
LessThan, LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Previous, Current, Next, Exists,
Hour, DayOfWeek
dateFilterType enum ALLOWED:Minute, Hour, Day, Week, Month, Quarter, Year,
AllTime
value undefined
drillin boolean
countByApplicationFacet boolean
pageSize integer
offset integer
defaultSearchReport boolean
allowed array
id string
name string
permissions object
createdDate string
modifiedDate string
createdByUser object
id string

226 of 359
NAME TYPE DESCRIPTION

name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean
curveType string
showAxis boolean

227 of 359
NAME TYPE DESCRIPTION

min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: Object collection.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

22.2 GET /search/keyword

Gets the search result.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*keywords string The keywords to search.

page integer The page to return.
size integer The number of results to return.

RESPONSE

228 of 359
STATUS CODE - 200: GroupedSearchResults

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
totalCount integer
isCountLimited boolean
countByApplication object
results object
totalCount integer
items array
name string
allowed array
id string
name string
trackingId number
trackingFull string
applicationId string
referencedRecordIds array
referencedByIds array
matches array
isNew boolean
values object
repeatFieldCurrentValues object
valuesDocument object
actionsExecuted object
visualizations object
applicationRevision number
coeditSession object
editors array
id string
name string
recordId string
applicationId string
values object
createdDate string
modifiedDate string
id string
name string
disabled boolean
locked boolean
lockingUser object
id string
name string

229 of 359
NAME TYPE DESCRIPTION

lockedDate string
comments object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
sessionTimeSpent integer
totalTimeSpent integer
timeTrackingEnabled boolean
hangfireJobId string
isHangfireCreatedAndUnpersisted boolean
infiniteLoopFlag boolean
latestWorkflowRun array
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
lockTimestamp string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

230 of 359
22.3 POST /search/keyword

Gets the search result.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer The page to return.

size integer The number of results to return.

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

231 of 359
NAME TYPE DESCRIPTION

createdByUser object
id string
name string
modifiedByUser object
id string
name string
chartOptions object
colorScheme string
showLegend boolean
legendPosition enum ALLOWED:Top, Left, Right, Bottom, None, Advanced
chartType enum ALLOWED:VerticalBar,
HorizontalBar, Line, Scatter,
Bubble, Pie, Heat, Gauge, Number, Map, Area,
AdvancedPie, LinearGauge, Widget, Polar
chartSubType enum ALLOWED:Doughnut,
Stacked, FullStacked, Step, Spline,
PieGrid, Usa, World
label string
showLabels boolean
showXAxis boolean
showXAxisLabel boolean
xAxisLabelText string
showYAxis boolean
showYAxisLabel boolean
yAxisLabelText string
gradient boolean
zoom boolean
autoScale boolean
explodeSlices boolean
transparentBackground boolean
sort object
directionD0 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD0 array
name undefined
directionD1 enum ALLOWED:LabelAscending,
LabelDescending, Custom,
ValueAscending, ValueDescending
entriesD1 array
name undefined
colorMap array
name string
value string
linkedId string
isInternal boolean
showOtherGroup boolean

232 of 359
NAME TYPE DESCRIPTION

curveType string
showAxis boolean
min number
max number
minRadius integer
maxRadius integer
units string
bigSegments integer
smallSegments integer
angleSpan integer
startAngle integer
value number
code string
statsDrillin boolean
uid string
version integer
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: GroupedSearchResults

RESPONSE MODEL - application/json

233 of 359
NAME TYPE DESCRIPTION

values object
repeatFieldCurrentValues object
valuesDocument object
actionsExecuted object
visualizations object
applicationRevision number
coeditSession object
editors array
id string
name string
recordId string
applicationId string
values object
createdDate string
modifiedDate string
id string
name string
disabled boolean
locked boolean
lockingUser object
id string
name string
lockedDate string
comments object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
sessionTimeSpent integer
totalTimeSpent integer
timeTrackingEnabled boolean
hangfireJobId string
isHangfireCreatedAndUnpersisted boolean
infiniteLoopFlag boolean
latestWorkflowRun array
workflowId string
applicationId string
recordId string

234 of 359
NAME TYPE DESCRIPTION

executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
lockTimestamp string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

22.4 POST /search/

Gets the search result.

REQUEST

RESPONSE

STATUS CODE - 200: GroupedSearchResults

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
results object
count integer
offset integer
limit integer
isCountLimited boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string

235 of 359
NAME TYPE DESCRIPTION

code* integer between 100 and 600

22.5 GET /search/export/{id}

Exports the specified identifier.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Task<FileResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

22.6 POST /search/export

Exports the report.

REQUEST

RESPONSE
236 of 359
STATUS CODE - 200: Task<FileResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

237 of 359
23. SETTINGS

23.1 GET /settings/features

Gets all of the externally visible feature flags

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: List of feature flags

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
system boolean
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

23.2 GET /settings/features/enabled

Gets all of the externally visible feature flags

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: List of feature flags

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
system boolean
id string
name string

238 of 359
NAME TYPE DESCRIPTION

disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

23.3 POST /settings/features/{id}

Enables or disables a feature flag

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

disabled boolean

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
system boolean
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

23.4 GET /settings/timezones/

Get all available system time zones.

239 of 359
REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: List of available time zones.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

23.5 POST /settings/ldap/validategroups

Checks that the Active Directory groups are valid.

Admin only.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

domain string
groups array

RESPONSE

STATUS CODE - 200: A Successful property with a value of true if all groups are valid. The Reason property lists the
invalid groups if any.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
successful boolean
reason string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

23.6 GET /settings/ldap/defaultsettings

Gets the default directory settings.

240 of 359
REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*type enum The type.

ALLOWED: OpenLdap, ActiveDirectory

RESPONSE

STATUS CODE - 200: DirectorySettings.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
enabled* boolean
groups* array
serverSettings* object
type* enum ALLOWED:OpenLdap, ActiveDirectory
server string
userName* string
password* string
passwordBytes string
domain* string
ssl boolean
tls boolean
allowInvalidCertificates boolean
authorizationType enum ALLOWED:Negotiate, Basic
protocolVersion integer
valid boolean
userSettings* object
objectClass* string
uniqueId* string
accountNameField* string
memberOfField string
mapping object
memberOfFieldTarget string
userLocation string
groupSettings* object
objectClass* string
userMembershipField string
groupLocation string
userMembershipFieldTarget string
membership* enum ALLOWED:ByGroupField, ByUserField
valid boolean

STATUS CODE - default: Unexpected Error

241 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

23.7 GET /settings/

Gets the global settings.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Global settings

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
hasOutgoingMailSettingsConfigured boolean
databaseEncryptionKeys object
directory object
enabled* boolean
groups* array
serverSettings* object
type* enum ALLOWED:OpenLdap, ActiveDirectory
server string
userName* string
password* string
passwordBytes string
domain* string
ssl boolean
tls boolean
allowInvalidCertificates boolean
authorizationType enum ALLOWED:Negotiate, Basic
protocolVersion integer
valid boolean
userSettings* object
objectClass* string
uniqueId* string
accountNameField* string
memberOfField string
mapping object
memberOfFieldTarget string
userLocation string

242 of 359
NAME TYPE DESCRIPTION

groupSettings* object
objectClass* string
userMembershipField string
groupLocation string
userMembershipFieldTarget string
membership* enum ALLOWED:ByGroupField, ByUserField
valid boolean
mailSettings object
outgoingMailHost string
outgoingMailPort integer
outgoingMailEnableSSL boolean
outgoingMailFrom string
outgoingMailLogin string
outgoingMailPassword string
outgoingMailPasswordBytes string
outgoingMailDisableCertificateValidation boolean
incomingMailHost string
incomingMailPort integer
incomingMailEnableSSL boolean
incomingMailFrom string
incomingMailLogin string
incomingMailPassword string
incomingMailPasswordBytes string
incomingMailTimeQueue integer
mailHeader string
mailFooter string
emailCheckFrequencyMinutes integer
scheduledReportSettings object
header string
footer string
layout enum ALLOWED:Portrait, Landscape
securityParameters object
sessionTimeout number
sessionTimeoutType enum ALLOWED:Minutes, Hours
passwordExpiration number
passwordExpirationType enum ALLOWED:None, Days
minPasswordComplexityScore integer between 0 and 4
httpProxy string
httpProxyBytes string
httpsProxy string
httpsProxyBytes string
maxFailedLogInAttempts integer

243 of 359
NAME TYPE DESCRIPTION

securityNotificationEmail string
loginBanner string
systemTimeZoneId string
workflowRunTtlType enum ALLOWED:Days, Weeks, Months
workflowRunTtl integer
license object
file string
licenseType enum ALLOWED:Trial, Standard
expiration string
licensedTo string
licensedToEmail string
applicationLimit number
userLimit number
valid boolean
apiVersion string
swimlaneUrl string
updateInProgress boolean
featureSettings object
enableCertificateAuthentication boolean
enableOtpAuthenticationEnforcement boolean
samlSettings object
enabled boolean
nameIdContent enum ALLOWED:EmailAddress, Username
idpSsoUrl string
idpCertificate string
verifyIdpSignature boolean
applicationServiceProviderId string
identityProviderId string
signRequest boolean
sourceCertificate string
usageMetricsSettings object
manualTimeExpenditure number
manualTimeCost number
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string

244 of 359
NAME TYPE DESCRIPTION

code* integer between 100 and 600

23.8 PUT /settings/

Updates global settings.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

hasOutgoingMailSettingsConfigured boolean
databaseEncryptionKeys object
directory object
enabled* boolean
groups* array
serverSettings* object
type* enum ALLOWED:OpenLdap, ActiveDirectory
server string
userName* string
password* string
passwordBytes string
domain* string
ssl boolean
tls boolean
allowInvalidCertificates boolean
authorizationType enum ALLOWED:Negotiate, Basic
protocolVersion integer
valid boolean
userSettings* object
objectClass* string
uniqueId* string
accountNameField* string
memberOfField string
mapping object
memberOfFieldTarget string
userLocation string
groupSettings* object
objectClass* string
userMembershipField string
groupLocation string
userMembershipFieldTarget string
membership* enum ALLOWED:ByGroupField, ByUserField
valid boolean

245 of 359
NAME TYPE DESCRIPTION

mailSettings object
outgoingMailHost string
outgoingMailPort integer
outgoingMailEnableSSL boolean
outgoingMailFrom string
outgoingMailLogin string
outgoingMailPassword string
outgoingMailPasswordBytes string
outgoingMailDisableCertificateValidation boolean
incomingMailHost string
incomingMailPort integer
incomingMailEnableSSL boolean
incomingMailFrom string
incomingMailLogin string
incomingMailPassword string
incomingMailPasswordBytes string
incomingMailTimeQueue integer
mailHeader string
mailFooter string
emailCheckFrequencyMinutes integer
scheduledReportSettings object
header string
footer string
layout enum ALLOWED:Portrait, Landscape
securityParameters object
sessionTimeout number
sessionTimeoutType enum ALLOWED:Minutes, Hours
passwordExpiration number
passwordExpirationType enum ALLOWED:None, Days
minPasswordComplexityScore integer between 0 and 4
httpProxy string
httpProxyBytes string
httpsProxy string
httpsProxyBytes string
maxFailedLogInAttempts integer
securityNotificationEmail string
loginBanner string
systemTimeZoneId string
workflowRunTtlType enum ALLOWED:Days, Weeks, Months
workflowRunTtl integer
license object
file string

246 of 359
NAME TYPE DESCRIPTION

licenseType enum ALLOWED:Trial, Standard

expiration string
licensedTo string
licensedToEmail string
applicationLimit number
userLimit number
valid boolean
apiVersion string
swimlaneUrl string
updateInProgress boolean
featureSettings object
enableCertificateAuthentication boolean
enableOtpAuthenticationEnforcement boolean
samlSettings object
enabled boolean
nameIdContent enum ALLOWED:EmailAddress, Username
idpSsoUrl string
idpCertificate string
verifyIdpSignature boolean
applicationServiceProviderId string
identityProviderId string
signRequest boolean
sourceCertificate string
usageMetricsSettings object
manualTimeExpenditure number
manualTimeCost number
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: Saved global settings.

RESPONSE MODEL - application/json

247 of 359
NAME TYPE DESCRIPTION

server string
userName* string
password* string
passwordBytes string
domain* string
ssl boolean
tls boolean
allowInvalidCertificates boolean
authorizationType enum ALLOWED:Negotiate, Basic
protocolVersion integer
valid boolean
userSettings* object
objectClass* string
uniqueId* string
accountNameField* string
memberOfField string
mapping object
memberOfFieldTarget string
userLocation string
groupSettings* object
objectClass* string
userMembershipField string
groupLocation string
userMembershipFieldTarget string
membership* enum ALLOWED:ByGroupField, ByUserField
valid boolean
mailSettings object
outgoingMailHost string
outgoingMailPort integer
outgoingMailEnableSSL boolean
outgoingMailFrom string
outgoingMailLogin string
outgoingMailPassword string
outgoingMailPasswordBytes string
outgoingMailDisableCertificateValidation boolean
incomingMailHost string
incomingMailPort integer
incomingMailEnableSSL boolean
incomingMailFrom string
incomingMailLogin string
incomingMailPassword string
incomingMailPasswordBytes string

248 of 359
NAME TYPE DESCRIPTION

incomingMailTimeQueue integer
mailHeader string
mailFooter string
emailCheckFrequencyMinutes integer
scheduledReportSettings object
header string
footer string
layout enum ALLOWED:Portrait, Landscape
securityParameters object
sessionTimeout number
sessionTimeoutType enum ALLOWED:Minutes, Hours
passwordExpiration number
passwordExpirationType enum ALLOWED:None, Days
minPasswordComplexityScore integer between 0 and 4
httpProxy string
httpProxyBytes string
httpsProxy string
httpsProxyBytes string
maxFailedLogInAttempts integer
securityNotificationEmail string
loginBanner string
systemTimeZoneId string
workflowRunTtlType enum ALLOWED:Days, Weeks, Months
workflowRunTtl integer
license object
file string
licenseType enum ALLOWED:Trial, Standard
expiration string
licensedTo string
licensedToEmail string
applicationLimit number
userLimit number
valid boolean
apiVersion string
swimlaneUrl string
updateInProgress boolean
featureSettings object
enableCertificateAuthentication boolean
enableOtpAuthenticationEnforcement boolean
samlSettings object
enabled boolean
nameIdContent enum ALLOWED:EmailAddress, Username

249 of 359
NAME TYPE DESCRIPTION

idpSsoUrl string
idpCertificate string
verifyIdpSignature boolean
applicationServiceProviderId string
identityProviderId string
signRequest boolean
sourceCertificate string
usageMetricsSettings object
manualTimeExpenditure number
manualTimeCost number
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

23.9 GET /settings/schedule

Gets the scheduled report settings.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Scheduled report settings.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
header string
footer string
layout enum ALLOWED:Portrait, Landscape

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

250 of 359
23.10 GET /settings/mailsettings/test

ValidateMailSettings

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

adminUserName string
password string
license object
file string
licenseType enum ALLOWED:Trial, Standard
expiration string
licensedTo string
licensedToEmail string
applicationLimit number
userLimit number
valid boolean
swimlaneUrl string
systemTimeZoneId string
mailSettings object
outgoingMailHost string
outgoingMailPort integer
outgoingMailEnableSSL boolean
outgoingMailFrom string
outgoingMailLogin string

253 of 359
NAME TYPE DESCRIPTION

outgoingMailPassword string
outgoingMailPasswordBytes string
outgoingMailDisableCertificateValidation boolean
incomingMailHost string
incomingMailPort integer
incomingMailEnableSSL boolean
incomingMailFrom string
incomingMailLogin string
incomingMailPassword string
incomingMailPasswordBytes string
incomingMailTimeQueue integer
mailHeader string
mailFooter string
emailCheckFrequencyMinutes integer

RESPONSE

STATUS CODE - 200: Task<NoContentResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: Task<NoContentResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

23.17 POST /settings/ldap/sync

Synchronizes the active directory. Admin.

Admin only.

REQUEST
No request parameters

RESPONSE
254 of 359
STATUS CODE - 200: BasicResult to be able to return if there is an error without the full stack trace or not and his
status.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
success boolean
resultMessages array

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

23.18 POST /settings/license/upload

Uploads the license.

REQUEST

RESPONSE

STATUS CODE - 200: Task<FileResult>.

RESPONSE MODEL - application/json

STATUS CODE - 400: Task<FileResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

255 of 359
NAME TYPE DESCRIPTION

message* string
code* integer between 100 and 600

256 of 359
24. SHARING

24.1 POST /sharing/

Sends the message.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

to array
subject string
message string

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

24.2 POST /sharing/scheduled/report

Sends the scheduled report

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

257 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

24.3 POST /sharing/scheduled/dashboard

Sends the scheduled dashboard

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

24.4 POST /sharing/scheduled/report/export/csv

Exports scheduled reports csv files and returns them into a compressed file

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/octet-stream

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/octet-stream

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

24.5 POST /sharing/scheduled/report/export/pdf

258 of 359
Create and returns a PDF with the reports

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/octet-stream

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/octet-stream

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

24.6 POST /sharing/scheduled/download/pdf

Generates and returns a PDF with the reports

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

name string
html string
layout enum ALLOWED:Portrait, Landscape

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/octet-stream

NAME TYPE DESCRIPTION

259 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
contentType string
fileDownloadName string
lastModified string
entityTag object
tag object
buffer string
offset integer
length integer
value string
hasValue boolean
isWeak boolean
enableRangeProcessing boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/octet-stream

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

24.7 POST /sharing/scheduled/dashboard/export/pdf

Create and returns a PDF with the dashboard

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/octet-stream

260 of 359
NAME TYPE DESCRIPTION

enableRangeProcessing boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/octet-stream

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

261 of 359
25. TASK

25.1 GET /task/actions

Gets the available actions.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<AvailableActionDescriptor>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
actionId string
actionType string
family string
base64Image string
readonly boolean
assetDependencyType string
assetDependencyVersion string
pythonDependencies object
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
availableOutputVariables object
availableOutputTypes array
inputParameters object
script string
scriptFile string
version string
licenses array
package string
license string
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string

262 of 359
NAME TYPE DESCRIPTION

pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.2 GET /task/action/{id}/new

Creates the default task for an action descriptor.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The action identifier.

RESPONSE

263 of 359
STATUS CODE - 200: Default task template.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
applicationId string
appletId string
action object
readonly boolean
type string
descriptor object
description string
actionId string
actionType string
family string
base64Image string
readonly boolean
assetDependencyType string
assetDependencyVersion string
pythonDependencies object
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
availableOutputVariables object
availableOutputTypes array
inputParameters object
script string
scriptFile string
version string
licenses array
package string
license string
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array

264 of 359
NAME TYPE DESCRIPTION

packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

vendor string
product string
family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean
imageId string
createdDate string
modifiedDate string
id string
name string
disabled boolean
inputMapping array
type string
parserType string
expression string
key string
value undefined
subValue undefined
example undefined
addMissing boolean
unixEpochUnit string
enableDeletionOnNull boolean
dataFormat string
customDataFormat string
userFormat string
listModificationType enum ALLOWED:None, Create, Delete, Append,
Subtract
isSystemTask boolean
outputs array
type string
triggers array
conditions array
type string

265 of 359
NAME TYPE DESCRIPTION

availableMappings array
hasRecord boolean
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - 404: Default task template.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.3 GET /task/action/{id}/fork

Creates the forked task for an action descriptor.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The action identifier.

RESPONSE

STATUS CODE - 200: Forked task template.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string

266 of 359
NAME TYPE DESCRIPTION

applicationId string
appletId string
action object
readonly boolean
type string
descriptor object
description string
actionId string
actionType string
family string
base64Image string
readonly boolean
assetDependencyType string
assetDependencyVersion string
pythonDependencies object
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
availableOutputVariables object
availableOutputTypes array
inputParameters object
script string
scriptFile string
version string
licenses array
package string
license string
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean

267 of 359
NAME TYPE DESCRIPTION

packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

268 of 359
NAME TYPE DESCRIPTION

name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - 404: Forked task template.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.4 GET /task/options

Gets the options.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: TaskOptionModel.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
triggers array
type string
availableMappings array
parsers array
description string
family string
type enum ALLOWED:None, Regex, Python, Delimiter
version string

269 of 359
NAME TYPE DESCRIPTION

src string
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.5 GET /task/light

Gets the tasks (light model).

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<object>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.6 GET /task/light/{parentId}

Gets the tasks (light model).

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*parentId string The application or applet identifier.

RESPONSE

STATUS CODE - 200: IEnumerable<object>.

RESPONSE MODEL - application/json

270 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.7 GET /task/list

Gets the tasks list with de-duped images for them.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Task list object with a tasks list and dictionary of de-duped images.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
images object
tasks array
id string
name string
description string
disabled boolean
applicationId string
appletId string
actionType string
actionDescription string
actionDescriptorImageId string
actionDescriptorName string
actionDescriptorVendor string
actionDescriptorProduct string
actionDescriptorVersion string
migrated boolean
deprecated boolean
valid boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

271 of 359
25.8 GET /task/list/{parentId}

Gets the tasks list with de-duped images for them.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*parentId string The application or applet identifier.

RESPONSE

STATUS CODE - 200: Task list object with a tasks list and dictionary of de-duped images.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.9 GET /task

Gets the tasks by application or applet.

272 of 359
REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*parentId string The application or applet identifier.

RESPONSE

STATUS CODE - 200: IEnumerable<Task>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
applicationId string
appletId string
action object
readonly boolean
type string
descriptor object
description string
actionId string
actionType string
family string
base64Image string
readonly boolean
assetDependencyType string
assetDependencyVersion string
pythonDependencies object
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
availableOutputVariables object
availableOutputTypes array
inputParameters object
script string
scriptFile string
version string
licenses array
package string
license string
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string

273 of 359
NAME TYPE DESCRIPTION

author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

274 of 359
NAME TYPE DESCRIPTION

listModificationType enum ALLOWED:None, Create, Delete, Append,

Subtract
isSystemTask boolean
outputs array
type string
triggers array
conditions array
type string
availableMappings array
hasRecord boolean
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.10 POST /task

Posts the task.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

description string
applicationId string
appletId string
action object

275 of 359
NAME TYPE DESCRIPTION

readonly boolean
type string
descriptor object
description string
actionId string
actionType string
family string
base64Image string
readonly boolean
assetDependencyType string
assetDependencyVersion string
pythonDependencies object
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
availableOutputVariables object
availableOutputTypes array
inputParameters object
script string
scriptFile string
version string
licenses array
package string
license string
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

vendor string
product string

276 of 359
NAME TYPE DESCRIPTION

family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean
imageId string
createdDate string
modifiedDate string
id string
name string
disabled boolean
inputMapping array
type string
parserType string
expression string
key string
value undefined
subValue undefined
example undefined
addMissing boolean
unixEpochUnit string
enableDeletionOnNull boolean
dataFormat string
customDataFormat string
userFormat string
listModificationType enum ALLOWED:None, Create, Delete, Append,
Subtract
isSystemTask boolean
outputs array
type string
triggers array
conditions array
type string
availableMappings array
hasRecord boolean
createdByUser object
id string
name string
modifiedByUser object
id string

277 of 359
NAME TYPE DESCRIPTION

name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: Task.

RESPONSE MODEL - application/json

278 of 359
NAME TYPE DESCRIPTION

name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

279 of 359
NAME TYPE DESCRIPTION

enableDeletionOnNull boolean
dataFormat string
customDataFormat string
userFormat string
listModificationType enum ALLOWED:None, Create, Delete, Append,
Subtract
isSystemTask boolean
outputs array
type string
triggers array
conditions array
type string
availableMappings array
hasRecord boolean
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.11 GET /task/common

Gets all common tasks.

REQUEST
No request parameters

RESPONSE

280 of 359
STATUS CODE - 200:

RESPONSE MODEL - application/json

281 of 359
NAME TYPE DESCRIPTION

packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

282 of 359
NAME TYPE DESCRIPTION

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.12 GET /task/{id}

Gets the task with specified identifier.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: JsonResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
applicationId string
appletId string
action object

283 of 359
NAME TYPE DESCRIPTION

vendor string
product string

284 of 359
NAME TYPE DESCRIPTION

285 of 359
NAME TYPE DESCRIPTION

name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.13 PUT /task/{id}

Puts the task.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Task.

RESPONSE MODEL - application/json

286 of 359
NAME TYPE DESCRIPTION

base64Image string
readonly boolean
assetDependencyType string
assetDependencyVersion string
pythonDependencies object
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
availableOutputVariables object
availableOutputTypes array
inputParameters object
script string
scriptFile string
version string
licenses array
package string
license string
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

vendor string
product string
family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean

287 of 359
NAME TYPE DESCRIPTION

imageId string
createdDate string
modifiedDate string
id string
name string
disabled boolean
inputMapping array
type string
parserType string
expression string
key string
value undefined
subValue undefined
example undefined
addMissing boolean
unixEpochUnit string
enableDeletionOnNull boolean
dataFormat string
customDataFormat string
userFormat string
listModificationType enum ALLOWED:None, Create, Delete, Append,
Subtract
isSystemTask boolean
outputs array
type string
triggers array
conditions array
type string
availableMappings array
hasRecord boolean
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string

288 of 359
NAME TYPE DESCRIPTION

name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.14 DELETE /task/{id}

Deletes the task.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.15 POST /task/fork

Forks the specified task.

289 of 359
REQUEST

RESPONSE

STATUS CODE - 200: Task.

RESPONSE MODEL - application/json

290 of 359
NAME TYPE DESCRIPTION

python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

291 of 359
NAME TYPE DESCRIPTION

triggers array
conditions array
type string
availableMappings array
hasRecord boolean
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.16 POST /task/execute/record

Executes the record.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

taskId string
record object
name string
allowed array
id string
name string
trackingId number
trackingFull string
applicationId string

292 of 359
NAME TYPE DESCRIPTION

referencedRecordIds array
referencedByIds array
matches array
isNew boolean
values object
repeatFieldCurrentValues object
valuesDocument object
actionsExecuted object
visualizations object
applicationRevision number
coeditSession object
editors array
id string
name string
recordId string
applicationId string
values object
createdDate string
modifiedDate string
id string
name string
disabled boolean
locked boolean
lockingUser object
id string
name string
lockedDate string
comments object
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
sessionTimeSpent integer
totalTimeSpent integer
timeTrackingEnabled boolean
hangfireJobId string
isHangfireCreatedAndUnpersisted boolean
infiniteLoopFlag boolean

293 of 359
NAME TYPE DESCRIPTION

latestWorkflowRun array
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
lockTimestamp string
id string
disabled boolean

RESPONSE

STATUS CODE - 200: System.String.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.17 POST /task/test/output

Tests the output.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

type string
parserType string
expression string
key string
value undefined
subValue

294 of 359
NAME TYPE DESCRIPTION

undefined
example undefined
addMissing boolean
unixEpochUnit string
enableDeletionOnNull boolean
dataFormat string
customDataFormat string
userFormat string
listModificationType enum ALLOWED:None, Create, Delete, Append, Subtract

RESPONSE

STATUS CODE - 200: object.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.18 GET /task/export/{id}

Exports the task.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: FileContentResult.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.19 POST /task/upload-script

295 of 359
Uploads the script.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*form array of undefined The form. Fields:

appId: Application id.
appletId: Applet id.
taskName: The name of the task.
scriptType: Either python or powershell
File type fields (any name): The content of the script.

RESPONSE

STATUS CODE - 200: Task or null if failed

RESPONSE MODEL - application/json

296 of 359
NAME TYPE DESCRIPTION

packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

297 of 359
NAME TYPE DESCRIPTION

unixEpochUnit string
enableDeletionOnNull boolean
dataFormat string
customDataFormat string
userFormat string
listModificationType enum ALLOWED:None, Create, Delete, Append,
Subtract
isSystemTask boolean
outputs array
type string
triggers array
conditions array
type string
availableMappings array
hasRecord boolean
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.20 POST /task/upload-task

Uploads the task.

REQUEST
QUERY PARAMETERS

298 of 359
NAME TYPE DESCRIPTION

*form array of undefined The form.

RESPONSE

STATUS CODE - 200: The uploaded task

RESPONSE MODEL - application/json

299 of 359
NAME TYPE DESCRIPTION

supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

300 of 359
NAME TYPE DESCRIPTION

outputs array
type string
triggers array
conditions array
type string
availableMappings array
hasRecord boolean
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.21 POST /task/upload

Upload task to Swimlane.

REQUEST
FORM DATA PARAMETERS
NAME TYPE DESCRIPTION

appId string The application identifier. Will overwrite the one in file.
appletId string The applet identifier. Will overwrite the one in file.
taskName string New task name. Will overwrite the one in file.
files string(binary) Task file.

RESPONSE

301 of 359
STATUS CODE - 200: Created task from Swimlane.

RESPONSE MODEL - application/json

302 of 359
NAME TYPE DESCRIPTION

packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

303 of 359
NAME TYPE DESCRIPTION

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.22 POST /task/{jobId}/cancel

Cancels the task.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*jobId string The job identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

304 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

25.23 POST /task/enable

Bulk enable tasks

REQUEST
REQUEST BODY - application/json

RESPONSE

STATUS CODE - 200: Collection of IDs of tasks enabled.

RESPONSE MODEL - application/json

305 of 359
NAME TYPE DESCRIPTION

scriptFile string
version string
licenses array
package string
license string
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

306 of 359
NAME TYPE DESCRIPTION

key string
value undefined
subValue undefined
example undefined
addMissing boolean
unixEpochUnit string
enableDeletionOnNull boolean
dataFormat string
customDataFormat string
userFormat string
listModificationType enum ALLOWED:None, Create, Delete, Append,
Subtract
isSystemTask boolean
outputs array
type string
triggers array
conditions array
type string
availableMappings array
hasRecord boolean
createdByUser object
id string
name string
modifiedByUser object
id string
name string
createdDate string
modifiedDate string
valid boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

307 of 359
26. TASKPACKAGE

26.1 DELETE /task/packages/{packageName}/{version}

Deletes the package.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*packageName string Name of the package.

*version string Version of the package.

RESPONSE

STATUS CODE - 200: Task<IActionResult>.

RESPONSE MODEL - application/json

STATUS CODE - 204: Task<IActionResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 404: Task<IActionResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

26.2 DELETE /task/packages/{packageName}/{version}/{pythonVersion}

Deletes the package.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*packageName string Name of the package.

*version string Version of the package.
*pythonVersion string

308 of 359
RESPONSE

STATUS CODE - 200: Task<IActionResult>.

RESPONSE MODEL - application/json

STATUS CODE - 204: Task<IActionResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 404: Task<IActionResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

26.3 GET /task/packages

Gets the packages.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<System.Object>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
id string
base64Image string
vendor string
product string
name string
description string
version string
author string
pythonVersion string
readme string
changeLog string
family string
modifiedDate string

309 of 359
NAME TYPE DESCRIPTION

createdDate string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

26.4 GET /task/packages/{packageName}

Gets the package with assets and actions.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*packageName string

RESPONSE

STATUS CODE - 200: Extended package object.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
family string
modifiedDate string
createdDate string
assetDescriptors array
type string
base64Image string
family string
version string
description string
testScript string
testScriptFile string
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
inputParameters object
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string

310 of 359
NAME TYPE DESCRIPTION

vendor string
product string
family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean
imageId string
id string
name string
disabled boolean
availableActionDescriptors array
description string
actionId string
actionType string
family string
base64Image string
readonly boolean
assetDependencyType string
assetDependencyVersion string
pythonDependencies object
pythonVersion enum ALLOWED:Python2_7, Python3_6, Python3
availableOutputVariables object
availableOutputTypes array
inputParameters object
script string
scriptFile string
version string

311 of 359
NAME TYPE DESCRIPTION

licenses array
package string
license string
packageDescriptor object
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

312 of 359
NAME TYPE DESCRIPTION

version string
supportedSwimlaneVersion string
pythonVersion string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
vendor string
product string
readme string
changeLog string
id string
disabled boolean

STATUS CODE - 404: Extended package object.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

26.5 GET /task/packages/{packageName}/{version}/usage

Retrieves the task and asset usage of the bundle specified.Useful for confirming deletion of
bundles.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*packageName string Name of the package.

*version string Version of the package.

RESPONSE

STATUS CODE - 200: Task<JsonResult>.

RESPONSE MODEL - application/json

STATUS CODE - 404: Task<JsonResult>.

RESPONSE MODEL - application/json

313 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

26.6 GET /task/packages/{packageName}/{version}/usage/{pythonVersion}

Retrieves the task and asset usage of the bundle specified.Useful for confirming deletion of
bundles.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*packageName string Name of the package.

*version string Version of the package.
*pythonVersion string

RESPONSE

STATUS CODE - 200: Task<JsonResult>.

RESPONSE MODEL - application/json

STATUS CODE - 404: Task<JsonResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

26.7 POST /task/packages/upload

Uploads the package and validates if it requires upgrade.

Inserts if no issues found. Returns issues to let user decide.

REQUEST

RESPONSE

STATUS CODE - 200: Package definition.

RESPONSE MODEL - application/json

314 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

vendor string
product string
family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

26.8 POST /task/packages/upgrade

Uploads the package and forces upgrade.

REQUEST

RESPONSE

STATUS CODE - 200: Package definition.

315 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

vendor string
product string
family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

26.9 POST /task/packages/upload/ssp

Uploads the package from an SSP and validates if it requires upgrade.

Inserts if no issues found. Returns issues to let user decide.

REQUEST

316 of 359
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*pluginId string The id of the desired plugin.

RESPONSE

STATUS CODE - 200: Package definition.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
name string
base64Image string
description string
author string
versionHash string
author_email string
version string
supported_swimlane_version string
pythonVersion string
python_version string
url string
installRequires array
packages array
bundleHash string
fileId string
isEmailBundle boolean
packageIssue {recursive} Core.Models.Integrations.Upgrade.PackageIssue

vendor string
product string
family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

317 of 359
26.10 POST /task/packages/upgrade/ssp

Uploads the package from an SSP and forces upgrade.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*pluginId string The id of the desired plugin.

RESPONSE

STATUS CODE - 200: Package definition.

RESPONSE MODEL - application/json

vendor string
product string
family string
readme string
changeLog string
createdDate string
modifiedDate string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

318 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

319 of 359
27. USAGE

27.1 GET /usage/app/{appId}

Retrieves all filter usage tasks by a specific application identifier.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*appId string The application identifier.

RESPONSE

STATUS CODE - 200: List<UsageTask>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
name* string
taskId* string
type* enum ALLOWED:Integration, Workflow
applicationId string
cost number
manualTimeExpenditure number
manualTimeCost number
executionCount integer
totalExecutionDuration number
fastestExecutionTime number
longestExecutionTime number
averageExecutionTime number
averageTimeSavings number
totalTimeSavings number
averageCostSavings number
totalCostSavings number
usageTaskSeries object
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string

320 of 359
NAME TYPE DESCRIPTION

code* integer between 100 and 600

27.2 GET /usage/app/common

Retrieves all common usage tasks.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: List<UsageTask>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

27.3 PUT /usage/update

321 of 359
Updates or inserts all usage tasks.

REQUEST
REQUEST BODY - application/json

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

27.4 POST /usage/stats

REQUEST
REQUEST BODY - application/json

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
averageTimeSavings number
averageCostSavings number
totalTimeSavings number
globalCostSavings number
totalRecords integer
totalExecutionsRan integer
applicationUsage array
applicationId string
totalExecutionsRan integer
totalRecords integer
averageTimeSavings number
totalExecutionDuration number

322 of 359
NAME TYPE DESCRIPTION

totalTimeSavings number
averageCostSavings number
totalCostSavings number
usageTasks array
name* string
taskId* string
type* enum ALLOWED:Integration, Workflow
applicationId string
cost number
manualTimeExpenditure number
manualTimeCost number
executionCount integer
totalExecutionDuration number
fastestExecutionTime number
longestExecutionTime number
averageExecutionTime number
averageTimeSavings number
totalTimeSavings number
averageCostSavings number
totalCostSavings number
usageTaskSeries object
id string
disabled boolean
applicationUsageSeries object
timeSeries object
timeSeries array

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

323 of 359
28. USER

28.1 GET /user/authorize

Returns user with permissions.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Task<IActionResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.2 GET /user/avatar/{id}

Avatars the specified identifier.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: ActionResult.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.3 POST /user/avatar/{id}

324 of 359
Uploads the avatar image.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The user id

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

id string
file object
contentType string
contentDisposition string
headers object
length integer
name string
fileName string

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.4 GET /user

Gets an amount of application users based on the paged search criteria.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

size integer The number of documents to gather after skip..

pageNumber integer Page number to skip.

325 of 359
NAME TYPE DESCRIPTION

sortFieldName string The application user field name to be sorted.

sortType string The direction of the sorting.
searchFieldName string The field name where the search will be executed.
searchValue string The search value to look into the search field name.

RESPONSE

STATUS CODE - 200: PagedResponse<ApplicationUser>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
totalCount integer
items array
favorites object
firstName string
lastName string
middleInitial string
displayName string
lastLogin string
activeDirectoryGuid string
domain string
active boolean
name string
avatar string
lastPasswordChangedDate string
passwordResetRequired boolean
defaultWorkspaceId string
defaultDashboardId string
sessionTimeout number
sessionTimeoutType enum ALLOWED:Minutes, Hours
users array
id string
name string
disabled boolean
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean

326 of 359
NAME TYPE DESCRIPTION

primaryGroup object
id string
name string
email string
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
userName string
phoneNumber string
passwordComplexityScore integer
isSystemUser boolean
timeZoneId string
oneTimePasswordSecretBytes string
isOTPVerified boolean
isOtpUser boolean
isOtpEnforced boolean
isOtpExempted boolean
isLdapUser boolean
isLocked boolean
currentFailedLogInAttempts integer
lastFailedLogInAttemptAt string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.5 POST /user

Insert/Creates the specified user.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

327 of 359
NAME TYPE DESCRIPTION

userName string
notify boolean
firstName string
lastName string
middleInitial string
displayName string
password string
confirmPassword string
email* string
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean

RESPONSE

STATUS CODE - 200: Saved user.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.6 GET /user/{id}

Gets the specified user.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The user identifier.

RESPONSE

STATUS CODE - 200: The user.

RESPONSE MODEL - application/json

328 of 359
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
favorites object
firstName string
lastName string
middleInitial string
displayName string
lastLogin string
activeDirectoryGuid string
domain string
active boolean
name string
avatar string
lastPasswordChangedDate string
passwordResetRequired boolean
defaultWorkspaceId string
defaultDashboardId string
sessionTimeout number
sessionTimeoutType enum ALLOWED:Minutes, Hours
users array
id string
name string
disabled boolean
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean
primaryGroup object
id string
name string
email string
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string

329 of 359
NAME TYPE DESCRIPTION

userName string
phoneNumber string
passwordComplexityScore integer
isSystemUser boolean
timeZoneId string
oneTimePasswordSecretBytes string
isOTPVerified boolean
isOtpUser boolean
isOtpEnforced boolean
isOtpExempted boolean
isLdapUser boolean
isLocked boolean
currentFailedLogInAttempts integer
lastFailedLogInAttemptAt string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.7 PUT /user/{id}

Updates the specified user.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The user identifier.

REQUEST BODY - application/json

NAME TYPE DESCRIPTION

favorites object
firstName string
lastName string
middleInitial string
displayName string
lastLogin string
activeDirectoryGuid string

330 of 359
NAME TYPE DESCRIPTION

domain string
active boolean
name string
avatar string
lastPasswordChangedDate string
passwordResetRequired boolean
defaultWorkspaceId string
defaultDashboardId string
sessionTimeout number
sessionTimeoutType enum ALLOWED:Minutes, Hours
users array
id string
name string
disabled boolean
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean
primaryGroup object
id string
name string
email string
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
userName string
phoneNumber string
passwordComplexityScore integer
isSystemUser boolean
timeZoneId string
oneTimePasswordSecretBytes string
isOTPVerified boolean
isOtpUser boolean

331 of 359
NAME TYPE DESCRIPTION

isOtpEnforced boolean
isOtpExempted boolean
isLdapUser boolean
isLocked boolean
currentFailedLogInAttempts integer
lastFailedLogInAttemptAt string
id string
disabled boolean

RESPONSE

STATUS CODE - 200: The user light model.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

333 of 359
28.11 GET /user/light

Gets all users as light model.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: All user light model.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.12 GET /user/search

Returns users whose display name matches the query.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*query string The text to search user display names for

appId string The application identifier of the application where the user/group field being searched is
located
appletId string The applet identifier of the applet where the user/group field being searched is located
fieldId string The field identifier of the user/group field being searched

RESPONSE

STATUS CODE - 200: List of users that match the search query and field constraints. The search is preformed within
the constraints defined
on the specified user/group field, so some users may be filtered out.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
favorites object

334 of 359
NAME TYPE DESCRIPTION

firstName string
lastName string
middleInitial string
displayName string
lastLogin string
activeDirectoryGuid string
domain string
active boolean
name string
avatar string
lastPasswordChangedDate string
passwordResetRequired boolean
defaultWorkspaceId string
defaultDashboardId string
sessionTimeout number
sessionTimeoutType enum ALLOWED:Minutes, Hours
users array
id string
name string
disabled boolean
groups array
id string
name string
disabled boolean
roles array
id string
name string
disabled boolean
primaryGroup object
id string
name string
email string
createdDate string
modifiedDate string
createdByUser object
id string
name string
modifiedByUser object
id string
name string
userName string
phoneNumber string

335 of 359
NAME TYPE DESCRIPTION

passwordComplexityScore integer
isSystemUser boolean
timeZoneId string
oneTimePasswordSecretBytes string
isOTPVerified boolean
isOtpUser boolean
isOtpEnforced boolean
isOtpExempted boolean
isLdapUser boolean
isLocked boolean
currentFailedLogInAttempts integer
lastFailedLogInAttemptAt string
id string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.13 POST /user/token

Log in the user and return an authentication token.

REQUEST

RESPONSE

STATUS CODE - 200: Task<System.String>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.14 POST /user/login

Log in the user.

REQUEST

336 of 359
RESPONSE

STATUS CODE - 200: Task<IActionResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.15 POST /user/logout

Logouts this instance.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Task<NoContentResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - 204: Task<NoContentResult>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
result object
statusCode integer
id integer
exception object
status enum ALLOWED:Created,
WaitingForActivation, WaitingToRun,
Running, WaitingForChildrenToComplete,
RanToCompletion, Canceled, Faulted
isCanceled boolean
isCompleted boolean
isCompletedSuccessfully boolean
creationOptions enum ALLOWED:None,
PreferFairness, LongRunning,
AttachedToParent, DenyChildAttach, HideScheduler,
RunContinuationsAsynchronously
asyncState undefined
isFaulted boolean

STATUS CODE - default: Unexpected Error

337 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.16 POST /user/password/reset

Resets the password.

REQUEST

RESPONSE

STATUS CODE - 200: Task<IActionResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.17 POST /user/password/set

Sets the password.

REQUEST

RESPONSE

STATUS CODE - 200: Task<IActionResult>.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.18 POST /user/password/test

Tests a password and returns zxcvbn results, including the strength score.

REQUEST

338 of 359
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

password string

RESPONSE

STATUS CODE - 200: The zxcvbn password test result

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
entropy number
calcTime integer
crackTime number
crackTimeDisplay string
score integer
suggestions array
warning string

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.19 GET /usergroup/lookup

Returns both groups and users whose name starts with supplied string.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*name string Partial name (starting characters).

RESPONSE

STATUS CODE - 200: Collection of users and groups as Id,Name,Disabled and EntityType object.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

339 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

28.20 GET /user/lookup

Returns users whose username matches starting string.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*name string Partial name (starting characters).

RESPONSE

STATUS CODE - 200: Collection of users as Id,Name,Disabled object.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

340 of 359
29. WORKFLOW

29.1 GET /workflow/

Gets all workflows.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: IEnumerable<Workflow>.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
applicationId string
stages array
id string
sourceAppletId string
name string
disabled boolean
parentId string
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
evalType enum ALLOWED:And, Or
conditions array
conditionType enum ALLOWED:Contains,
Excludes, Equals,
DoesNotEqual, LessThan, LessThanOrEqual,
GreaterThan, GreaterThanOrEqual,
DefaultActions, Regex, HasValue,
DoesNotHaveValue, HasBeenModified
fieldId string
referencedApplicationFieldId string
referenceFieldConjunction enum ALLOWED:And, Or
value undefined
isCaseSensitive boolean
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly, Required,
CreateNewRecord, Notification, Integration,
FilterValues, FormattedExport,
ToggleTimeTracking, OrchestrationTask

341 of 359
NAME TYPE DESCRIPTION

id string
name string
disabled boolean
repeats array
id string
name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly, Required,
CreateNewRecord, Notification, Integration,
FilterValues, FormattedExport,
ToggleTimeTracking, OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual, LessThan,
LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string
disabled boolean

342 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

29.2 POST /workflow/

Creates a new workflow.

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

343 of 359
NAME TYPE DESCRIPTION

actionType enum ALLOWED:ShowHide,

SetValue, ReadOnly, Required,
CreateNewRecord, Notification, Integration,
FilterValues, FormattedExport,
ToggleTimeTracking, OrchestrationTask
id string
name string
disabled boolean
repeats array
id string
name string
parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly, Required,
CreateNewRecord, Notification, Integration,
FilterValues, FormattedExport,
ToggleTimeTracking, OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual, LessThan,
LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer

344 of 359
NAME TYPE DESCRIPTION

id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

29.3 DELETE /workflow/

Deletes the specified workflow.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*id string The workflow identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

29.4 GET /workflow/{id}

Gets the specified workflow.

REQUEST
PATH PARAMETERS

345 of 359
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Workflow.

RESPONSE MODEL - application/json

346 of 359
NAME TYPE DESCRIPTION

parentId string
fieldId string
referencedApplicationFieldId string
actions array
sourceAppletId string
parentId string
actionType enum ALLOWED:ShowHide,
SetValue, ReadOnly, Required,
CreateNewRecord, Notification, Integration,
FilterValues, FormattedExport,
ToggleTimeTracking, OrchestrationTask
id string
name string
disabled boolean
disabled boolean
filterType enum ALLOWED:None,
Equals, DoesNotEqual, LessThan,
LessThanOrEqual, GreaterThan,
GreaterThanOrEqual, Regex
filterValue undefined
stages array
permissions object
workflowLock object
applicationId string
workflowId string
lockedDate string
lockingUser object
id string
name string
lockExpiration string
isExpired boolean
id string
name string
disabled boolean
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

347 of 359
29.5 PUT /workflow/{id}

Updates workflow.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The identifier.

RESPONSE

STATUS CODE - 200: Saved workflow.

RESPONSE MODEL - application/json

348 of 359
NAME TYPE DESCRIPTION

349 of 359
STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

29.6 POST /workflow/notify

Sends the notification.

REQUEST
REQUEST BODY - application/json
NAME TYPE DESCRIPTION

applicationId string
recordId string
actionIds array

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

29.7 GET /workflow/record/runs/{recordId}

Retrieves the workflow runs for the specified record id

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*recordId string The record id

350 of 359
RESPONSE

STATUS CODE - 200: The workflow runs for the record

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean

STATUS CODE - 404: The workflow runs for the record

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

29.8 GET /workflow/run/{workflowRunId}

Retrieves the run and executions for the specified workflow run id

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*workflowRunId string

RESPONSE

351 of 359
STATUS CODE - 200: The workflow run and executions

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
run object
workflowId string
applicationId string
recordId string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
lastFailedActionId string
id string
name string
disabled boolean
executions array
workflowRunId string
recordId string
jobId string
source object
type enum ALLOWED:Workflow, Continuation, Api
name string
id string
executionMetadata object
started string
finished string
originator object
id string
name string
success boolean
message string
differential object
id string
name string
disabled boolean

STATUS CODE - 404: The workflow run and executions

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE

352 of 359
NAME TYPE DESCRIPTION

statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

353 of 359
30. WORKSPACE

30.1 GET /workspaces/

Gets all workspaces.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: The workspace collection.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
dashboards array
applications array
permissions object
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

30.2 POST /workspaces/

Inserts/Creates the specified workspace.

354 of 359
REQUEST

RESPONSE

STATUS CODE - 200: Saved workspace.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
description string
createdDate string
createdByUser object
id string
name string
modifiedDate string
modifiedByUser object
id string
name string
dashboards array
applications array
permissions object
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

30.3 GET /workspaces/nav

Gets the workspace navigation.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200: Object list

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

355 of 359
RESPONSE MODEL - application/json
NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

30.4 GET /workspaces/{id}

Gets the specified workspace.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The workspace identifier.

RESPONSE

STATUS CODE - 200: The workspace

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string

356 of 359
NAME TYPE DESCRIPTION

code* integer between 100 and 600

30.5 PUT /workspaces/{id}

Updates the specified workspace.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The workspace identifier.

RESPONSE

STATUS CODE - 200: Saved workspace.

RESPONSE MODEL - application/json

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

357 of 359
30.6 DELETE /workspaces/{id}

Deletes the specified workspace.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string The workspace identifier.

RESPONSE

STATUS CODE - 200: NoContentResult.

RESPONSE MODEL - application/json

STATUS CODE - 204: NoContentResult.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
statusCode integer

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

30.7 GET /workspaces/app/{id}

Gets workspaces for application.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string Application id.

RESPONSE

STATUS CODE - 200: Workspace collection.

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
ARRAY OF OBJECT WITH BELOW STRUCTURE
description string
createdDate string
createdByUser object

358 of 359
NAME TYPE DESCRIPTION

id string
name string
modifiedDate string
modifiedByUser object
id string
name string
dashboards array
applications array
permissions object
uid string
version integer
id string
name string
disabled boolean

STATUS CODE - default: Unexpected Error

RESPONSE MODEL - application/json

NAME TYPE DESCRIPTION
OBJECT WITH BELOW STRUCTURE
message* string
code* integer between 100 and 600

359 of 359

The Use of Mean Kinetic Temperature To Aid Evaluation of Temperature Excursions - Proper
No ratings yet
The Use of Mean Kinetic Temperature To Aid Evaluation of Temperature Excursions - Proper
13 pages
Crypto Trading Secrets How To Earn Big in The Cryptocurrency Market
100% (4)
Crypto Trading Secrets How To Earn Big in The Cryptocurrency Market
25 pages
13 Practical Statistics Using SPSS Revision 2009
100% (1)
13 Practical Statistics Using SPSS Revision 2009
60 pages
Building A Basic RestFul API in Python
No ratings yet
Building A Basic RestFul API in Python
6 pages
Django REST Framework JSON API Documentation: Release 4.2.0
No ratings yet
Django REST Framework JSON API Documentation: Release 4.2.0
56 pages
Postman Tutorial For Beginners
0% (1)
Postman Tutorial For Beginners
34 pages
T13151-176 Api 614 PDF
No ratings yet
T13151-176 Api 614 PDF
26 pages
Rest Api For Humans
No ratings yet
Rest Api For Humans
99 pages
Happyfox API Manual
No ratings yet
Happyfox API Manual
28 pages
Building Beautiful Restful Apis Using Flask 1
No ratings yet
Building Beautiful Restful Apis Using Flask 1
34 pages
Scrapy
No ratings yet
Scrapy
248 pages
Postman Quick Reference Guide Readthedocs Io en Latest
No ratings yet
Postman Quick Reference Guide Readthedocs Io en Latest
36 pages
API Cheet Sheet
No ratings yet
API Cheet Sheet
9 pages
V 4 Apidocs
No ratings yet
V 4 Apidocs
101 pages
Deltek Web Services Programmer's Guide
No ratings yet
Deltek Web Services Programmer's Guide
67 pages
HELP - OpenStack Guide v0
No ratings yet
HELP - OpenStack Guide v0
41 pages
Python Rest Framework
No ratings yet
Python Rest Framework
58 pages
GAD Resolution
No ratings yet
GAD Resolution
5 pages
Charging Station Installation Guide
No ratings yet
Charging Station Installation Guide
71 pages
Postman Tutorial For Beginners
No ratings yet
Postman Tutorial For Beginners
34 pages
Michael Yin - The Definitive Guide Next - Js Wagtail-Leanpub (2021)
No ratings yet
Michael Yin - The Definitive Guide Next - Js Wagtail-Leanpub (2021)
216 pages
Pfhais
No ratings yet
Pfhais
149 pages
Google App Engine Cheat Sheet Python 122 11
100% (1)
Google App Engine Cheat Sheet Python 122 11
2 pages
Agile Architecture Poster V 1 - 0
No ratings yet
Agile Architecture Poster V 1 - 0
1 page
AMLCFT Prakas English
No ratings yet
AMLCFT Prakas English
24 pages
Bira 91
No ratings yet
Bira 91
11 pages
55153rr10 17
No ratings yet
55153rr10 17
2 pages
Graduate Handbook Counselling Psychology Program Faculty of Education The University of Western Ontario
No ratings yet
Graduate Handbook Counselling Psychology Program Faculty of Education The University of Western Ontario
35 pages
Monash Offer Guide For International - 161216 - v4
No ratings yet
Monash Offer Guide For International - 161216 - v4
30 pages
Binary-Com - Github.io-Module Deriv - Apideriv - Api - Calls
No ratings yet
Binary-Com - Github.io-Module Deriv - Apideriv - Api - Calls
68 pages
Endpoint Design Patterns: Rest-Api Guideline: Reflect Relationships in Endpoint Paths
No ratings yet
Endpoint Design Patterns: Rest-Api Guideline: Reflect Relationships in Endpoint Paths
1 page
Fastapi
No ratings yet
Fastapi
14 pages
The Social Impact of Technology On Millennials and Consequences For Higher Education and Leadership
No ratings yet
The Social Impact of Technology On Millennials and Consequences For Higher Education and Leadership
14 pages
ETC Console Shortcut Keys: Element v2.3.0
No ratings yet
ETC Console Shortcut Keys: Element v2.3.0
3 pages
WEB2PY 2.9 Cheat Sheet: Database Abstraction Layer Forms
No ratings yet
WEB2PY 2.9 Cheat Sheet: Database Abstraction Layer Forms
2 pages
2
No ratings yet
2
7 pages
Rest Api
No ratings yet
Rest Api
36 pages
Cost Efficient Dual Shredder For Paper A PDF
No ratings yet
Cost Efficient Dual Shredder For Paper A PDF
9 pages
Master Thesis
No ratings yet
Master Thesis
70 pages
RestAPI With Python and Flask
No ratings yet
RestAPI With Python and Flask
5 pages
Administración de Sistemas Y Servicios en Red (Tlmg1022) : Docente: Msig. Adriana Collaguazo Jaramillo
No ratings yet
Administración de Sistemas Y Servicios en Red (Tlmg1022) : Docente: Msig. Adriana Collaguazo Jaramillo
33 pages
Balance of Payment - FOREX
No ratings yet
Balance of Payment - FOREX
18 pages
Swagger API Sharing Cloud
No ratings yet
Swagger API Sharing Cloud
352 pages
REST API For IBM Cloud
No ratings yet
REST API For IBM Cloud
31 pages
Tài liệu không có tiêu đề
No ratings yet
Tài liệu không có tiêu đề
22 pages
CRUD Operations Using Constellation DX API's
No ratings yet
CRUD Operations Using Constellation DX API's
13 pages
Business Strategy Analysis
No ratings yet
Business Strategy Analysis
22 pages
Apis Fuzzing For Bug Bounty: Tools
No ratings yet
Apis Fuzzing For Bug Bounty: Tools
7 pages
IDOR
No ratings yet
IDOR
3 pages
Postman API
No ratings yet
Postman API
30 pages
A Study On API Security Pentesting
No ratings yet
A Study On API Security Pentesting
108 pages
Applied Use of Parabolas
No ratings yet
Applied Use of Parabolas
7 pages
RESTful API Design OCTO Quick Reference Card 2.2
No ratings yet
RESTful API Design OCTO Quick Reference Card 2.2
4 pages
Trifacta Developer Guide
No ratings yet
Trifacta Developer Guide
525 pages
API Introduction
No ratings yet
API Introduction
22 pages
SDO COTABATO SGC Minutes of The Meeting
No ratings yet
SDO COTABATO SGC Minutes of The Meeting
6 pages
153 PTQ q3 2024 Issue
No ratings yet
153 PTQ q3 2024 Issue
102 pages
Unit-3 Deployment Using FastAPI
No ratings yet
Unit-3 Deployment Using FastAPI
52 pages
CloudAPIGuide BusinessFlows
No ratings yet
CloudAPIGuide BusinessFlows
172 pages
New Assignment Backend
No ratings yet
New Assignment Backend
34 pages
? REST API Cheatsheet
No ratings yet
? REST API Cheatsheet
17 pages
API Documentation
No ratings yet
API Documentation
2 pages
Postman 2
No ratings yet
Postman 2
23 pages
How To Build An API in Python - Postman Blog
No ratings yet
How To Build An API in Python - Postman Blog
5 pages
Applications of Integration in Calculus
No ratings yet
Applications of Integration in Calculus
13 pages
0intro To Rest Apis
No ratings yet
0intro To Rest Apis
8 pages
API Design
No ratings yet
API Design
29 pages
Advavce Task 4
No ratings yet
Advavce Task 4
8 pages
Subscription and Warehousing
No ratings yet
Subscription and Warehousing
18 pages
BBC Black History Month Event Proposal September 2024
No ratings yet
BBC Black History Month Event Proposal September 2024
11 pages
Json 1
No ratings yet
Json 1
2 pages
EXP3
No ratings yet
EXP3
10 pages
Lesson 8
No ratings yet
Lesson 8
63 pages
Module 6 Work Physiology
No ratings yet
Module 6 Work Physiology
50 pages
Cloud Computing Practical3
No ratings yet
Cloud Computing Practical3
7 pages
Introduction To Concepts For Lab Assignments On API, Web Services
No ratings yet
Introduction To Concepts For Lab Assignments On API, Web Services
3 pages
Q&A For Manufacturing in D365 BC-1
No ratings yet
Q&A For Manufacturing in D365 BC-1
33 pages
REST APIs and REST Principles
No ratings yet
REST APIs and REST Principles
2 pages
Restful Api
No ratings yet
Restful Api
5 pages
Problem Statement
No ratings yet
Problem Statement
5 pages
Final Assessment Spring Boot SecB
No ratings yet
Final Assessment Spring Boot SecB
10 pages
Defamation Cases
No ratings yet
Defamation Cases
10 pages
Android Preparation Notes
No ratings yet
Android Preparation Notes
1 page
Final Assessment Spring Boot Section B
No ratings yet
Final Assessment Spring Boot Section B
9 pages
Revised Final Vacancy, Stenographer Gr. C D Exam 2024 As On 27.06.2025
No ratings yet
Revised Final Vacancy, Stenographer Gr. C D Exam 2024 As On 27.06.2025
6 pages
Untitled Document
No ratings yet
Untitled Document
17 pages
Principles and Methods of Teaching Accounting Syllabus
No ratings yet
Principles and Methods of Teaching Accounting Syllabus
4 pages
Inbound 8192051004444615706
No ratings yet
Inbound 8192051004444615706
2 pages

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.