Lytho Workflow Open API (v1)
RESTful endpoints used to interact with Lytho Workflow.
Gets an array of Work Request deliverable files
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Work Request. |
Responses
Response Schema: application/json
Array
| fileVersionName | string |
| fileId | integer <int32> |
| fileVersionId | integer <int32> |
| url | string |
| urlExpiration | string <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "fileVersionName": "string",
- "fileId": 0,
- "fileVersionId": 0,
- "url": "string",
- "urlExpiration": "2019-08-24T14:15:22Z"
}
]Gets a Work Request by its id
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Work Request. |
Responses
Response Schema: application/json
| accountId | integer <int32> |
| id | integer <int32> > 0 |
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "accountId": 0,
- "id": 0,
- "name": "string",
- "archived": true,
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z"
}Gets an array of Work Requests by their ids
Authorizations:
Lytho Workflow Auth
query Parameters
| ids required | Array of integers <int32> [ items <int32 > ] Example: ids=0 |
| page required | integer <int32> Default: 1 |
| pageSize required | integer Default: 10 Enum: 10 20 30 10 (Default), 20 (Twenty), 30 (Thirty) |
Responses
Response Schema: application/json
| accountId | integer <int32> |
| id | integer <int32> > 0 |
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "accountId": 0,
- "id": 0,
- "name": "string",
- "archived": true,
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z"
}Gets an array of Work Request users
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Work Request. |
Responses
Response Schema: application/json
Array
| accountId | integer <int32> |
| id | integer <int32> |
| firstName | string [ 0 .. 30 ] characters |
| lastName | string [ 0 .. 30 ] characters |
string [ 0 .. 255 ] characters | |
| userStatusType | integer (UserStatusType) Enum: 0 1 0 (Disabled), 1 (Active) |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "accountId": 0,
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userStatusType": 0
}
]Searches for Work Requests based on the provided criteria
Authorizations:
Lytho Workflow Auth
query Parameters
| name | string or null |
| isArchived required | boolean Default: false |
| operatorMode required | integer Default: 1 Enum: 1 2 1 (Or), 2 (And) |
Responses
Response Schema: application/json
| ids | Array of integers <int32> [ items <int32 > ] |
| totalCount | integer <int32> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "ids": [
- 0
], - "totalCount": 0
}Gets a Task by its id
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Task. |
Responses
Response Schema: application/json
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| startDate | string or null <date-time> |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
| accountId | integer <int32> |
| id | integer <int32> > 0 |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "name": "string",
- "archived": true,
- "startDate": "2019-08-24T14:15:22Z",
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z",
- "accountId": 0,
- "id": 0
}Gets an array of Task files
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Task. |
Responses
Response Schema: application/json
Array
| fileVersionName | string |
| fileId | integer <int32> |
| fileVersionId | integer <int32> |
| url | string |
| urlExpiration | string <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "fileVersionName": "string",
- "fileId": 0,
- "fileVersionId": 0,
- "url": "string",
- "urlExpiration": "2019-08-24T14:15:22Z"
}
]Gets an array of Tasks by their ids
Authorizations:
Lytho Workflow Auth
query Parameters
| ids required | Array of integers <int32> [ items <int32 > ] Example: ids=0 |
| page required | integer <int32> Default: 1 |
| pageSize required | integer Default: 10 Enum: 10 20 30 10 (Default), 20 (Twenty), 30 (Thirty) |
Responses
Response Schema: application/json
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| startDate | string or null <date-time> |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
| accountId | integer <int32> |
| id | integer <int32> > 0 |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "name": "string",
- "archived": true,
- "startDate": "2019-08-24T14:15:22Z",
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z",
- "accountId": 0,
- "id": 0
}Gets an array of Task users
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Task. |
Responses
Response Schema: application/json
Array
| accountId | integer <int32> |
| id | integer <int32> |
| firstName | string [ 0 .. 30 ] characters |
| lastName | string [ 0 .. 30 ] characters |
string [ 0 .. 255 ] characters | |
| userStatusType | integer (UserStatusType) Enum: 0 1 0 (Disabled), 1 (Active) |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "accountId": 0,
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userStatusType": 0
}
]Searches for Tasks based on the provided criteria
Authorizations:
Lytho Workflow Auth
query Parameters
| name | string or null |
| isArchived required | boolean Default: false |
| operatorMode required | integer Default: 1 Enum: 1 2 1 (Or), 2 (And) |
Responses
Response Schema: application/json
| ids | Array of integers <int32> [ items <int32 > ] |
| totalCount | integer <int32> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "ids": [
- 0
], - "totalCount": 0
}Gets a Proof by its id
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Proof. |
Responses
Response Schema: application/json
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| startDate | string or null <date-time> |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
| accountId | integer <int32> |
| id | integer <int32> > 0 |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "name": "string",
- "archived": true,
- "startDate": "2019-08-24T14:15:22Z",
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z",
- "accountId": 0,
- "id": 0
}Gets an array of Proof files
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Proof. |
Responses
Response Schema: application/json
Array
| fileVersionName | string |
| fileId | integer <int32> |
| fileVersionId | integer <int32> |
| url | string |
| urlExpiration | string <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "fileVersionName": "string",
- "fileId": 0,
- "fileVersionId": 0,
- "url": "string",
- "urlExpiration": "2019-08-24T14:15:22Z"
}
]Gets an array of Proofs by their ids
Authorizations:
Lytho Workflow Auth
query Parameters
| ids required | Array of integers <int32> [ items <int32 > ] Example: ids=0 |
| page required | integer <int32> Default: 1 |
| pageSize required | integer Default: 10 Enum: 10 20 30 10 (Default), 20 (Twenty), 30 (Thirty) |
Responses
Response Schema: application/json
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| startDate | string or null <date-time> |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
| accountId | integer <int32> |
| id | integer <int32> > 0 |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "name": "string",
- "archived": true,
- "startDate": "2019-08-24T14:15:22Z",
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z",
- "accountId": 0,
- "id": 0
}Gets an array of Proof users
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Proof. |
Responses
Response Schema: application/json
Array
| accountId | integer <int32> |
| id | integer <int32> |
| firstName | string [ 0 .. 30 ] characters |
| lastName | string [ 0 .. 30 ] characters |
string [ 0 .. 255 ] characters | |
| userStatusType | integer (UserStatusType) Enum: 0 1 0 (Disabled), 1 (Active) |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "accountId": 0,
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userStatusType": 0
}
]Searches for Proofs based on the provided criteria
Authorizations:
Lytho Workflow Auth
query Parameters
| name | string or null |
| isArchived required | boolean Default: false |
| operatorMode required | integer Default: 1 Enum: 1 2 1 (Or), 2 (And) |
Responses
Response Schema: application/json
| ids | Array of integers <int32> [ items <int32 > ] |
| totalCount | integer <int32> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "ids": [
- 0
], - "totalCount": 0
}Gets a Project by its id
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Project. |
Responses
Response Schema: application/json
| accountId | integer <int32> |
| id | integer <int32> > 0 |
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| startDate | string or null <date-time> |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "accountId": 0,
- "id": 0,
- "name": "string",
- "archived": true,
- "startDate": "2019-08-24T14:15:22Z",
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z"
}Gets an array of Project files
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Project. |
Responses
Response Schema: application/json
Array
| fileVersionName | string |
| fileId | integer <int32> |
| fileVersionId | integer <int32> |
| url | string |
| urlExpiration | string <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "fileVersionName": "string",
- "fileId": 0,
- "fileVersionId": 0,
- "url": "string",
- "urlExpiration": "2019-08-24T14:15:22Z"
}
]Gets an array of Projects by their ids
Authorizations:
Lytho Workflow Auth
query Parameters
| ids required | Array of integers <int32> [ items <int32 > ] Example: ids=0 |
| page required | integer <int32> Default: 1 |
| pageSize required | integer Default: 10 Enum: 10 20 30 10 (Default), 20 (Twenty), 30 (Thirty) |
Responses
Response Schema: application/json
| accountId | integer <int32> |
| id | integer <int32> > 0 |
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| startDate | string or null <date-time> |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "accountId": 0,
- "id": 0,
- "name": "string",
- "archived": true,
- "startDate": "2019-08-24T14:15:22Z",
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z"
}Gets an array of Project users
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Project. |
Responses
Response Schema: application/json
Array
| accountId | integer <int32> |
| id | integer <int32> |
| firstName | string [ 0 .. 30 ] characters |
| lastName | string [ 0 .. 30 ] characters |
string [ 0 .. 255 ] characters | |
| userStatusType | integer (UserStatusType) Enum: 0 1 0 (Disabled), 1 (Active) |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "accountId": 0,
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userStatusType": 0
}
]Searches for Projects based on the provided criteria
Authorizations:
Lytho Workflow Auth
query Parameters
| name | string or null |
| isArchived required | boolean Default: false |
| operatorMode required | integer Default: 1 Enum: 1 2 1 (Or), 2 (And) |
Responses
Response Schema: application/json
| ids | Array of integers <int32> [ items <int32 > ] |
| totalCount | integer <int32> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "ids": [
- 0
], - "totalCount": 0
}Searches for Campaigns based on the provided criteria
Authorizations:
Lytho Workflow Auth
query Parameters
| name | string or null |
| isArchived required | boolean Default: false |
| operatorMode required | integer Default: 1 Enum: 1 2 1 (Or), 2 (And) |
Responses
Response Schema: application/json
| ids | Array of integers <int32> [ items <int32 > ] |
| totalCount | integer <int32> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "ids": [
- 0
], - "totalCount": 0
}Gets a Campaign by its id
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Campaign. |
Responses
Response Schema: application/json
| accountId | integer <int32> |
| id | integer <int32> > 0 |
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| startDate | string or null <date-time> |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "accountId": 0,
- "id": 0,
- "name": "string",
- "archived": true,
- "startDate": "2019-08-24T14:15:22Z",
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z"
}Gets an array of Campaign files
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Campaign. |
Responses
Response Schema: application/json
Array
| fileVersionName | string |
| fileId | integer <int32> |
| fileVersionId | integer <int32> |
| url | string |
| urlExpiration | string <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "fileVersionName": "string",
- "fileId": 0,
- "fileVersionId": 0,
- "url": "string",
- "urlExpiration": "2019-08-24T14:15:22Z"
}
]Gets an array of Campaigns by their ids
Authorizations:
Lytho Workflow Auth
query Parameters
| ids required | Array of integers <int32> [ items <int32 > ] Example: ids=0 |
| page required | integer <int32> Default: 1 |
| pageSize required | integer Default: 10 Enum: 10 20 30 10 (Default), 20 (Twenty), 30 (Thirty) |
Responses
Response Schema: application/json
| accountId | integer <int32> |
| id | integer <int32> > 0 |
| name | string [ 0 .. 255 ] characters |
| archived | boolean |
| startDate | string or null <date-time> |
| dueDate | string or null <date-time> |
| completedDate | string or null <date-time> |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
{- "accountId": 0,
- "id": 0,
- "name": "string",
- "archived": true,
- "startDate": "2019-08-24T14:15:22Z",
- "dueDate": "2019-08-24T14:15:22Z",
- "completedDate": "2019-08-24T14:15:22Z"
}Gets an array of Campaign users
Authorizations:
Lytho Workflow Auth
path Parameters
| id required | integer <int32> The id of the Campaign. |
Responses
Response Schema: application/json
Array
| accountId | integer <int32> |
| id | integer <int32> |
| firstName | string [ 0 .. 30 ] characters |
| lastName | string [ 0 .. 30 ] characters |
string [ 0 .. 255 ] characters | |
| userStatusType | integer (UserStatusType) Enum: 0 1 0 (Disabled), 1 (Active) |
Response samples
- 200
- 400
- 404
- 500
Content type
application/json
[- {
- "accountId": 0,
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "userStatusType": 0
}
]