Endpoints.md

Table of contents

• Authorization
• Endpoints
  • GET health status
  • GET all users
  • GET single user
  • POST user
  • GET all workflowlists
  • POST workflowlist
  • DELETE workflowlist
  • PUT workflowlist
  • PUT workflowlist resource
  • PUT workflowlist type
  • PUT workflowlist position
  • PUT workflowlist parent
  • GET workflowlist scheduling
• Enums
  • WorkflowListType

Authorization

All requests to /workflowlist require the UUID of an active user as an Authorization header. Otherwise, the API will return 401 Unauthorized.

Endpoints

GET health status

Check if the API is healthy.

GET /health

GET all users

Retrieve all users.

GET /user

GET single user

Retrieve a single user.

GET /user/:userApiId

POST user

Create a new user.

POST /user

JSON body parameters

Name	Type	Required	Description
username	string	yes

GET all workflowlists

Retrieve all workflow lists.

GET /workflowlist

URI parameters

Name	Type	Required	Description
userApiId	string	no	Filter by user

POST workflowlist

Create a new workflow list.

POST /workflowlist

JSON body parameters (CreateWorkflowListEntity)

Name	Type	Required	Description
title	string	yes
description	string	no
listType	WorkflowListType	yes
parentApiId	boolean	no
isTemporalConstraintBoard	string	no
children	array(CreateWorkflowListEntity)	yes	Leave empty for no children.

DELETE workflowlist

Delete a workflow list.

DELETE /workflowlist/:workflowlistApiId

PUT workflowlist

Update a workflow list.

PUT /workflowlist/:workflowlistApiId

JSON body parameters

Name	Type	Required	Description
newTitle	string	yes
newDescription	string	no
isTemporalConstraintBoard	boolean	no

PUT workflowlist resource

Update the resources of a workflow list.

PUT /workflowlist/:workflowlistApiId/resource

JSON body parameters

Name	Type	Required	Description
numeric	array(NumericResourceEntity)	no
textual	array(TextualResourceEntity)	no
temporal	TemporalResourceEntity	no
user	UserResourceEntity	no

NumericResourceEntity

Name	Type	Required	Description
label	string	yes
value	float	yes

TextualResourceEntity

Name	Type	Required	Description
label	string	yes
value	string	no

UserResourceEntity

Name	Type	Required	Description
username	string	no

TemporalResourceEntity

Name	Type	Required	Description
startDate	date	no
endDate	date	no
durationInMinutes	long	no

PUT workflowlist type

Convert a workflow list to a new type.

PUT /workflowlist/:workflowlistApiId/type

JSON body parameters

Name	Type	Required	Description
newListType	WorkflowListType	yes

PUT workflowlist position

Change the position of a workflow list within its parent.

PUT /workflowlist/:workflowlistApiId/position

JSON body parameters

Name	Type	Required	Description
newPosition	integer	yes

PUT workflowlist parent

Move a workflow list to a new parent.

PUT /workflowlist/:workflowlistApiId/parent

JSON body parameters

Name	Type	Required	Description
newParentApiId	string	no
newPosition	integer	no

GET workflowlist scheduling

Retrieve a scheduling proposal for the workflow list from the symbolic intelligence.

GET /workflowlist/:workflowlistApiId/scheduling

Enums

WorkflowListType

• ITEM
• BOARD
• LIST