Introduction

Welcome to the WFC API! You can use this guide to access the API endpoints.

This is a RESTful (Representational State Transfer) API.

We have language bindings using cURL. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs on the top right (where available).

To use Guzzle check out the documentation http://docs.guzzlephp.org/en/stable/ to install run composer require guzzlehttp/guzzle:~6.0

Authentication

The API uses JWT to allow access to the API. You can register a new token in the application. The API expects the token to be included in all API requests to the server in a header that looks like the following:

# Just pass the correct header with each request

curl --request GET \
  --url https://auth.wfc.rest/api/v2/auth/service/check \
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \
  --header 'x-language: en'

{
  "token": "UGxQacz7yO.zddK1qgfEv.w90VI35vdd"
}

x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd

HTTP Request

GET https://auth.wfc.rest/api/v2/auth/service/check

Return Attributes

Parameter	Description
token	The token that was validated

Language

# Include the x-language header to set the language of the reponse
curl --request POST \
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users \
  --header 'content-type: application/json' \
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \
  --header 'x-language: nl' \
  --data '{
  "first_name": "Lurline",
  "last_name": "Stiedemann",
  "username": "lurline.stiedemann_AT_krajcik.info",
  "email": "lurline.stiedemann_AT_krajcik.info",
  "telephone": "01324567489",
  "mobile": "01324567489",
  "company": "Krajcik",
  "department": "Eligibility Interviewer",
  "line_manager": "Wilbert Sawayn",
  "role_id": 3
}'

{
  "username": [
    "gebruikersnaam is geen geldig e-mailadres."
  ],
  "email": [
    "e-mailadres is geen geldig e-mailadres."
  ]
}

The API uses the x-language header in the request to set the response language. This will return translated validation. It will not translate any of the field names or HTTP response codes.

x-language: nl

field	description
id	The ID of the Category
name	The unique name of the Category
label	The label of the Category
description	The description of the Category
data	The data explaining how the Category should be executed
instance_id	The instance the Category is linked to
in_scope	The scope of the Category
sequence	The sequence order of the Category
created_at	The date the Category was created
updated_at	The date the Category was last updated

Comments

Comments Summary

The comment endpoint allows you to list, view and manage all the comments for an instance. A comment is additional information that can be added to a task or issue. All comments can include rich text and images.

Attributes

field	description
data	The Comment date
id	The ID of the Comment
task_id	The task the Comment is linked to
user_id	The user that created the comment
issue_id	The issue the Comment is linked to
instance_id	The instance the Comment is linked to
workflow_id	The workflow the Comment is linked to
type	The type of the Comment chosen from issue and task
created_at	The date the Comment was created
updated_at	The date the Comment was last updated

Get all Comments

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/comments \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "data": "Some comment data...",
    "id": 1,
    "task_id": "",
    "user_id": "1",
    "issue_id": "1",
    "instance_id": "1",
    "workflow_id": "",
    "type": "issue",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "data": "Some comment data...",
    "id": 2,
    "task_id": "",
    "user_id": "3",
    "issue_id": "1",
    "instance_id": "1",
    "workflow_id": "",
    "type": "issue",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "data": "Some comment data...",
    "id": 3,
    "task_id": "",
    "user_id": "10",
    "issue_id": "1",
    "instance_id": "1",
    "workflow_id": "",
    "type": "issue",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Comments.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/comments

Filtering

Parameter	Operator	Validation
id	=	Numeric
type	=	IN
user_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"user_id":"1"}

URL encoded %7B%22user_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/comments?filter=%7B%22user_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Comments with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/comments/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "data": "Some comment data...",
      "id": 1,
      "task_id": "",
      "user_id": "17",
      "issue_id": "1",
      "instance_id": "1",
      "workflow_id": "",
      "type": "issue",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "data": "Some comment data...",
      "id": 2,
      "task_id": "",
      "user_id": "1",
      "issue_id": "1",
      "instance_id": "1",
      "workflow_id": "",
      "type": "issue",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "data": "Some comment data...",
      "id": 3,
      "task_id": "",
      "user_id": "9",
      "issue_id": "1",
      "instance_id": "1",
      "workflow_id": "",
      "type": "issue",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/comments\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/comments\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/comments\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Comments with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/comments/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
type	=	IN
user_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"user_id":"17"}

URL encoded %7B%22user_id%22%3A%2217%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/comments/paginate?filter=%7B%22user_id%22%3A%2217%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Comment

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/comments \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "data": "Some comment data...",
    "type": "issue",
    "instance_id": "1",
    "user_id": "20"
  }'

{
  "data": "Some comment data...",
  "id": 4,
  "task_id": "",
  "user_id": "20",
  "issue_id": "1",
  "instance_id": "1",
  "workflow_id": "",
  "type": "issue",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Comment.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/comments

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
data	POST	The Comment date
type	POST	The type of the Comment chosen from issue and task
instance_id	POST	The instance the Comment is linked to
user_id	POST	The user that created the comment

Get a Specific Comment

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/comments/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "data": "Some comment data...",
  "id": 4,
  "task_id": "",
  "user_id": "12",
  "issue_id": "1",
  "instance_id": "1",
  "workflow_id": "",
  "type": "issue",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Comment.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/comments/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Comment

Update a Specific Comment

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/comments/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "data": "Some comment data...",
    "type": "issue",
    "instance_id": "1",
    "user_id": "3"
  }'

{
  "data": "Some comment data...",
  "id": 4,
  "task_id": "",
  "user_id": "3",
  "issue_id": "1",
  "instance_id": "1",
  "workflow_id": "",
  "type": "issue",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Comment.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/comments/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Comment
data	PATCH	The Comment date
type	PATCH	The type of the Comment chosen from issue and task
instance_id	PATCH	The instance the Comment is linked to
user_id	PATCH	The user that created the comment

Delete a Specific Comment

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/comments/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "data": "Some comment data...",
  "id": 4,
  "task_id": "",
  "user_id": "3",
  "issue_id": "1",
  "instance_id": "1",
  "workflow_id": "",
  "type": "issue",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Comment.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/comments/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Comment

Lists all users linked to this scenario

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/comments/users \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 5,
    "name": "Eleanor Fox"
  },
  {
    "id": 3,
    "name": "Jonathan Hall"
  },
  {
    "id": 1,
    "name": "Marielle Wolff"
  },
  {
    "id": 6,
    "name": "Andy Young"
  }
]

This endpoint retrieves all users id's and name's that have been assigned to a this scenario. For more information on users See Users

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/comments/users

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create Dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/comments/create/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "can_create": 
}

This endpoint checks if the Comment has any Dependencies on other objects that will prevent it from being able to be created

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/comments/create/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Export Comments

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/comments/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "comments"
}

This endpoint exports to a file the current filters Comments in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/comments/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
type	=	IN
user_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"user_id":"26"}

URL encoded %7B%22user_id%22%3A%2226%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/comments/export/csv?filter=%7B%22user_id%22%3A%2226%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Components

Components Summary

The component endpoint allows you to list, view and manage all the components for an instance. The component equates to specific service or an umbrella for a group of workflows that require execution. Workflows in a component have a common link such as an application or room/region.

Attributes

field	description
id	The ID of the Component
name	The unique name of the Component
label	The label of the Component
description	The description of the Component
data	The data explaining how the Component should be executed
in_scope	The scope of the Component
instance_id	The instance the Component is linked to
category_id	The category the Component is linked to
created_at	The date the Component was created
updated_at	The date the Component was last updated

Get all Components

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "upgradable-empowering-website",
    "label": "Upgradable empowering website",
    "description": "Upgradable empowering website",
    "data": "Some component data...",
    "in_scope": "1",
    "instance_id": "1",
    "category_id": "1",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "optimized-high-level-emulation",
    "label": "Optimized high-level emulation",
    "description": "Optimized high-level emulation",
    "data": "Some component data...",
    "in_scope": "1",
    "instance_id": "1",
    "category_id": "1",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "reduced-cohesive-benchmark",
    "label": "Reduced cohesive benchmark",
    "description": "Reduced cohesive benchmark",
    "data": "Some component data...",
    "in_scope": "0",
    "instance_id": "1",
    "category_id": "1",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Components.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"1"}

URL encoded %7B%22instance_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/components?filter=%7B%22instance_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Components with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "adaptive6thgeneration-installation",
      "label": "Adaptive 6thgeneration installation",
      "description": "Adaptive 6thgeneration installation",
      "data": "Some component data...",
      "in_scope": "0",
      "instance_id": "1",
      "category_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "fully-configurable-fault-tolerant-service-desk",
      "label": "Fully-configurable fault-tolerant service-desk",
      "description": "Fully-configurable fault-tolerant service-desk",
      "data": "Some component data...",
      "in_scope": "1",
      "instance_id": "1",
      "category_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "right-sized-intermediate-superstructure",
      "label": "Right-sized intermediate superstructure",
      "description": "Right-sized intermediate superstructure",
      "data": "Some component data...",
      "in_scope": "1",
      "instance_id": "1",
      "category_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/components\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/components\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/components\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Components with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"1"}

URL encoded %7B%22instance_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/components/paginate?filter=%7B%22instance_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Component

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Synergistic contextually-based pricingstructure",
    "description": "Synergistic contextually-based pricingstructure",
    "instance_id": "1",
    "category_id": "1",
    "in_scope": "0"
  }'

{
  "id": 4,
  "name": "synergistic-contextually-based-pricingstructure",
  "label": "Synergistic contextually-based pricingstructure",
  "description": "Synergistic contextually-based pricingstructure",
  "data": "Some component data...",
  "in_scope": "0",
  "instance_id": "1",
  "category_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Component.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/components

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Component
description	POST	The description of the Component
instance_id	POST	The instance the Component is linked to
category_id	POST	The category the Component is linked to
in_scope	POST	The scope of the Component

Get a Specific Component

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "vision-oriented-context-sensitive-initiative",
  "label": "Vision-oriented context-sensitive initiative",
  "description": "Vision-oriented context-sensitive initiative",
  "data": "Some component data...",
  "in_scope": "1",
  "instance_id": "1",
  "category_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Component.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component

Update a Specific Component

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Fully-configurable system-worthy neural-net",
    "description": "Fully-configurable system-worthy neural-net",
    "instance_id": "1",
    "category_id": "1",
    "in_scope": "0"
  }'

{
  "id": 4,
  "name": "fully-configurable-system-worthy-neural-net",
  "label": "Fully-configurable system-worthy neural-net",
  "description": "Fully-configurable system-worthy neural-net",
  "data": "Some component data...",
  "in_scope": "0",
  "instance_id": "1",
  "category_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Component.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component
label	PATCH	The label of the Component
description	PATCH	The description of the Component
instance_id	PATCH	The instance the Component is linked to
category_id	PATCH	The category the Component is linked to
in_scope	PATCH	The scope of the Component

Delete a Specific Component

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "horizontal-composite-projection",
  "label": "Horizontal composite projection",
  "description": "Horizontal composite projection",
  "data": "Some component data...",
  "in_scope": "0",
  "instance_id": "1",
  "category_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Component.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component

Lists all the available workflows for a Component

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/workflows/available \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 3,
    "label": "Adaptive full-range infrastructure"
  },
  {
    "id": 1,
    "label": "Cloned motivating core"
  },
  {
    "id": 2,
    "label": "Cross-group even-keeled artificialintelligence"
  }
]

This endpoint retrieves all workflows that can be assigned to components ordered by label. You can also use the workflows endpoint however if you do not have access to that endpoint this is a alternative for the components module See Workflows for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/workflows/available

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component

Toggle the scope for a Component

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/toggle \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "right-sized-systematic-help-desk",
  "label": "Right-sized systematic help-desk",
  "description": "Right-sized systematic help-desk",
  "data": "Some component data...",
  "in_scope": 0,
  "instance_id": 1,
  "category_id": 1,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint toggles the scope for a Component

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/toggle

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component

Lists all the available categories for Components

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/categories/available \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 2,
    "label": "Adaptive systematic analyzer"
  },
  {
    "id": 3,
    "label": "Advanced needs-based knowledgebase"
  },
  {
    "id": 1,
    "label": "Advanced secondary collaboration"
  }
]

This endpoint retrieves all categories that can be assigned to components ordered by label. You can also use the categories endpoint however if you do not have access to that endpoint this is a alternative for the components module See Categories for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/categories/available

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component

Project view components

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/project/1 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "Phased upward-trending challenge",
    "progress": "0",
    "start_time": "na",
    "end_time": "na",
    "status": "ready",
    "type": "components",
    "loads": "workflows",
    "from": 1
  },
  {
    "id": 2,
    "name": "Enterprise-wide directional firmware",
    "progress": "0",
    "start_time": "na",
    "end_time": "na",
    "status": "ready",
    "type": "components",
    "loads": "workflows",
    "from": 1
  },
  {
    "id": 3,
    "name": "Visionary leadingedge portal",
    "progress": "0",
    "start_time": "na",
    "end_time": "na",
    "status": "ready",
    "type": "components",
    "loads": "workflows",
    "from": 1
  }
]

This endpoint gets the components linked through categories formatted for the project view

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/project/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component

Lists all workflows linked to a given Component

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/workflows \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 2,
    "label": "Visionary background benchmark",
    "description": "Visionary background benchmark",
    "in_scope": 1,
    "workflow_type_name": "Plate Finisher"
  },
  {
    "id": 3,
    "label": "Visionary non-volatile success",
    "description": "Visionary non-volatile success",
    "in_scope": 0,
    "workflow_type_name": "Application"
  }
]

This endpoint retrieves all workflows that have been assigned to a given Component. For more information on workflows See Workflows

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/workflows

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component

Create Dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/create/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "can_create": 
}

This endpoint checks if the Component has any Dependencies on other objects that will prevent it from being able to be created

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/create/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Adds a workflow to a given Component

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/workflows/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

[
  {
    "id": 2,
    "label": "Visionary background benchmark",
    "description": "Visionary background benchmark",
    "in_scope": 1,
    "workflow_type_name": "Plate Finisher"
  },
  {
    "id": 3,
    "label": "Visionary non-volatile success",
    "description": "Visionary non-volatile success",
    "in_scope": 0,
    "workflow_type_name": "Application"
  },
  {
    "id": 4,
    "label": "Robust fault-tolerant complexity",
    "description": "Robust fault-tolerant complexity",
    "in_scope": 1,
    "workflow_type_name": "Loading Machine"
  }
]

This endpoint adds a new workflow to a given Component. For more information on workflows See Workflows

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/workflows/{workflow_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component
workflow_id	GET	The unique ID for the workflow

Removes a workflow from a given Component

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/workflows/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 2,
    "label": "Visionary background benchmark",
    "description": "Visionary background benchmark",
    "in_scope": 1,
    "workflow_type_name": "Plate Finisher"
  },
  {
    "id": 3,
    "label": "Visionary non-volatile success",
    "description": "Visionary non-volatile success",
    "in_scope": 0,
    "workflow_type_name": "Application"
  }
]

This endpoint removes a workflow from a given Component. For more information on workflows See Workflows

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/workflows/{workflow_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component
workflow_id	GET	The unique ID for the workflow

Toggle the scope for a Workflow

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/workflows/4/toggle \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

[
  {
    "id": 2,
    "label": "Visionary background benchmark",
    "description": "Visionary background benchmark",
    "in_scope": 1,
    "workflow_type_name": "Plate Finisher"
  },
  {
    "id": 3,
    "label": "Visionary non-volatile success",
    "description": "Visionary non-volatile success",
    "in_scope": 0,
    "workflow_type_name": "Application"
  },
  {
    "id": 4,
    "label": "Robust fault-tolerant complexity",
    "description": "Robust fault-tolerant complexity",
    "in_scope": 1,
    "workflow_type_name": "Loading Machine"
  }
]

This endpoint toggles the scope a Workflow

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/workflows/{workflow_id}/toggle

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component
workflow_id	GET	The unique ID for the workflow

Sequences up workflows linked to a given Component

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/workflows/2/sequence/up \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{ 
  "sequence": 0
}

This endpoint updates the sequences up of linked workflows of a given Component

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/workflows/{workflow_id}/sequence/up

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component
workflow_id	GET	The unique ID for the workflow

Sequences down workflows linked to a given Component

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/workflows/1/sequence/down \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{ 
  "sequence": 2
}

This endpoint updates the sequences down of linked workflows of a given Component

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/workflows/{workflow_id}/sequence/down

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component
workflow_id	GET	The unique ID for the workflow

List dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/dependencies/available \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 5,
    "label": "Compatible stable parallelism"
  },
  {
    "id": 6,
    "label": "Persevering multimedia website"
  }
]

This endpoint lists the possible dependencies for Components

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/dependencies/available

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component

View dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "dependencies": [
    1,
    2,
    3
  ]
}

This endpoint allows you to view the dependencies for the given Component

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component

Update dependencies

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/1/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "dependencies" {
      "0": 1,
      "1": 2,
      "2": 3
    } [
      1,
      2,
      3
    ]
  }'

[ 
  1,
  2,
  3
]

This endpoint allows you to update the dependencies for the given Component

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/{id}/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Component
dependencies	PATCH	An array of dependencies

Export Components

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "components"
}

This endpoint exports to a file the current filters Components in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"1"}

URL encoded %7B%22instance_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/components/export/csv?filter=%7B%22instance_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Components

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/components/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "components"
}

This endpoint imports from a file the Components in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/components/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Downloads

Downloads Summary

The downloads endpoint allows you to list, view and manage all the downloads. A download is assigned to a user from a requested export

Attributes

field	description
id	The ID of the Download
name	The unique name of the Download
label	The label of the Download
uid	The unique id of the Download
url	The URL source of the Download
size	The size of the Download
type	The file type of the Download
expires	The date that the Download is removed
user_id	The user that the Download belongs to
created_at	The date the Download was created
updated_at	The date the Download was last updated

Get all Downloads

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/downloads \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "791168466e56e9a93cf00a1052c49344-transportation-attendant.txt",
    "label": "Transportation Attendant",
    "uid": "791168466e56e9a93cf00a1052c49344",
    "url": "https://en-eso-wfc2.s3.eu-west-2.amazonaws.com/downloads/791168466e56e9a93cf00a1052c49344-transportation-attendant.txt",
    "size": "2 KB",
    "type": ".txt",
    "expires": "2021-07-20 15:20:12",
    "user_id": "6",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "2c453d0c9b1a79aa113afe55b50ea989-payroll-clerk.docx",
    "label": "Payroll Clerk",
    "uid": "2c453d0c9b1a79aa113afe55b50ea989",
    "url": "https://en-eso-wfc2.s3.eu-west-2.amazonaws.com/downloads/2c453d0c9b1a79aa113afe55b50ea989-payroll-clerk.docx",
    "size": "6 MB",
    "type": ".docx",
    "expires": "2021-07-20 15:20:12",
    "user_id": "18",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "2d4fb02292eec114a2d65ebb4e721e6e-percussion-instrument-repairer.csv",
    "label": "Percussion Instrument Repairer",
    "uid": "2d4fb02292eec114a2d65ebb4e721e6e",
    "url": "https://en-eso-wfc2.s3.eu-west-2.amazonaws.com/downloads/2d4fb02292eec114a2d65ebb4e721e6e-percussion-instrument-repairer.csv",
    "size": "3 KB",
    "type": ".csv",
    "expires": "2021-07-20 15:20:12",
    "user_id": "25",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Downloads.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/downloads

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Transportation Attendant"}

URL encoded %7B%22label%22%3A%22Transportation+Attendant%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/downloads?filter=%7B%22label%22%3A%22Transportation+Attendant%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Downloads with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/downloads/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "bc204877cebc37deeecafd9fbbc46a69-hoist-and-winch-operator.xlsx",
      "label": "Hoist and Winch Operator",
      "uid": "bc204877cebc37deeecafd9fbbc46a69",
      "url": "https://en-eso-wfc2.s3.eu-west-2.amazonaws.com/downloads/bc204877cebc37deeecafd9fbbc46a69-hoist-and-winch-operator.xlsx",
      "size": "2.3 MB",
      "type": ".xlsx",
      "expires": "2021-07-20 15:20:12",
      "user_id": "9",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "488ce1b327eab064ebecf547fa089ea0-office-clerk.rtf",
      "label": "Office Clerk",
      "uid": "488ce1b327eab064ebecf547fa089ea0",
      "url": "https://en-eso-wfc2.s3.eu-west-2.amazonaws.com/downloads/488ce1b327eab064ebecf547fa089ea0-office-clerk.rtf",
      "size": "3 GB",
      "type": ".rtf",
      "expires": "2021-07-20 15:20:12",
      "user_id": "4",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "3c7725dd2790219510b0d824d717c87b-detective.rtf",
      "label": "Detective",
      "uid": "3c7725dd2790219510b0d824d717c87b",
      "url": "https://en-eso-wfc2.s3.eu-west-2.amazonaws.com/downloads/3c7725dd2790219510b0d824d717c87b-detective.rtf",
      "size": "2.1 GB",
      "type": ".rtf",
      "expires": "2021-07-20 15:20:12",
      "user_id": "8",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/downloads\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/downloads\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/downloads\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Downloads with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/downloads/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Hoist and Winch Operator"}

URL encoded %7B%22label%22%3A%22Hoist+and+Winch+Operator%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/downloads/paginate?filter=%7B%22label%22%3A%22Hoist+and+Winch+Operator%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get a Specific Download

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/downloads/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "4c627156b675d1a75b626edd04c5e3c9-electrical-drafter.docx",
  "label": "Electrical Drafter",
  "uid": "4c627156b675d1a75b626edd04c5e3c9",
  "url": "https://en-eso-wfc2.s3.eu-west-2.amazonaws.com/downloads/4c627156b675d1a75b626edd04c5e3c9-electrical-drafter.docx",
  "size": "1 GB",
  "type": ".docx",
  "expires": "2021-07-20 15:20:12",
  "user_id": "14",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Download.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/downloads/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Download

Delete a Specific Download

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/downloads/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "bc204877cebc37deeecafd9fbbc46a69-m-a-r-c-o-m-director.xlsx",
  "label": "MARCOM Director",
  "uid": "bc204877cebc37deeecafd9fbbc46a69",
  "url": "https://en-eso-wfc2.s3.eu-west-2.amazonaws.com/downloads/bc204877cebc37deeecafd9fbbc46a69-m-a-r-c-o-m-director.xlsx",
  "size": "73 b",
  "type": ".xlsx",
  "expires": "2021-07-20 15:20:12",
  "user_id": "9",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Download.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/downloads/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Download

Deletes all the available downloads

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/downloads/all \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "4c00592e33bed532a6b263da9092e283-landscaper.docx",
    "label": "Landscaper",
    "uid": "4c00592e33bed532a6b263da9092e283",
    "url": "https://example.com/storage/4c00592e33bed532a6b263da9092e283-landscaper.docx",
    "size": "2 KB",
    "type": ".docx",
    "expires": "2020-08-07 16:21:35",
    "user_id": 692,
    "created_at": "2019-04-08 10:09:00",
    "updated_at": "2019-04-08 10:09:00"
  },
  {
    "id": 2,
    "name": "98525056fd547d71e74a20713ac3d356-poet-o-r-lyricist.docx",
    "label": "Poet OR Lyricist",
    "uid": "98525056fd547d71e74a20713ac3d356",
    "url": "https://example.com/storage/98525056fd547d71e74a20713ac3d356-poet-o-r-lyricist.docx",
    "size": "73 b",
    "type": ".docx",
    "expires": "2020-08-07 16:21:35",
    "user_id": 874,
    "created_at": "2019-04-08 10:09:00",
    "updated_at": "2019-04-08 10:09:00"
  },
  {
    "id": 3,
    "name": "ded65b1603e08b1a1047ddd91871f04a-mining-machine-operator.txt",
    "label": "Mining Machine Operator",
    "uid": "ded65b1603e08b1a1047ddd91871f04a",
    "url": "https://example.com/storage/ded65b1603e08b1a1047ddd91871f04a-mining-machine-operator.txt",
    "size": "3 GB",
    "type": ".txt",
    "expires": "2020-08-07 16:21:35",
    "user_id": 44,
    "created_at": "2019-04-08 10:09:00",
    "updated_at": "2019-04-08 10:09:00"
  }
]

This endpoint deletes all downloads that have been assigned to a user.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/downloads/all

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Import Downloads

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/downloads/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "downloads"
}

This endpoint imports from a file the Downloads in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/downloads/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Groups

Groups Summary

The groups endpoint allows you to list, view and manage all the groups for an instance. Groups are specific expertise. For example, there may be a group 'Wintel', 'Unix', 'DBA', Applications Support, UAT etc. These are normally sub-groups of 'Groups' and ultimately determine which workflow is presented to each user when it becomes available.

Attributes

field	description
id	The ID of the Group
name	The unique name of the Group
label	The label of the Group
created_at	The date the Group was created
updated_at	The date the Group was last updated

Get all Groups

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "management-analyst",
    "label": "Management Analyst",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "medical-transcriptionist",
    "label": "Medical Transcriptionist",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "airframe-mechanic",
    "label": "Airframe Mechanic",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Groups.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/groups

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Management Analyst"}

URL encoded %7B%22label%22%3A%22Management+Analyst%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/groups?filter=%7B%22label%22%3A%22Management+Analyst%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Groups with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/groups/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "child-care",
      "label": "Child Care",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "cultural-studies-teacher",
      "label": "Cultural Studies Teacher",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "crushing-grinding-machine-operator",
      "label": "Crushing Grinding Machine Operator",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/groups\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/groups\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/groups\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Groups with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/groups/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Child Care"}

URL encoded %7B%22label%22%3A%22Child+Care%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/groups/paginate?filter=%7B%22label%22%3A%22Child+Care%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Group

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Motorboat Operator"
  }'

{
  "id": 4,
  "name": "motorboat-operator",
  "label": "Motorboat Operator",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Group.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Group

Get a Specific Group

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/groups/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "forensic-science-technician",
  "label": "Forensic Science Technician",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Group.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/groups/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Group

Update a Specific Group

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/groups/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Credit Checker"
  }'

{
  "id": 4,
  "name": "credit-checker",
  "label": "Credit Checker",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Group.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/groups/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Group
label	PATCH	The label of the Group

Delete a Specific Group

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/groups/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "cleaners-of-vehicles",
  "label": "Cleaners of Vehicles",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Group.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/groups/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Group

Export Groups

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/groups/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "groups"
}

This endpoint exports to a file the current filters Groups in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/groups/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Loading Machine Operator"}

URL encoded %7B%22label%22%3A%22Loading+Machine+Operator%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/groups/export/csv?filter=%7B%22label%22%3A%22Loading+Machine+Operator%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Groups

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/groups/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "groups"
}

This endpoint imports from a file the Groups in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/groups/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Holds

Holds Summary

The hold endpoint allows you to list, view and manage all the hold placed on a task. A hold is used to pause the execution of a workflow within the application.

Attributes

field	description
id	The ID of the Hold
start	The start time of the Hold
end	The end time of the Hold
comment	A comment to explain the Hold
task_id	The link to a task
workflow_id	The link to a workflow
instance_id	The link to an instance
created_at	The date the Hold was created
updated_at	The date the Hold was last updated

Get all Holds

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/holds/task/12/workflow/32 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "start": "2021-02-03 12:45:34",
    "end": "2021-02-03 12:45:34",
    "comment": "Voluptas aspernatur laborum quasi maiores fugit officia.",
    "task_id": 12,
    "workflow_id": 32,
    "instance_id": 1,
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "start": "2021-02-03 12:45:34",
    "end": "2021-02-03 12:45:34",
    "comment": "Optio omnis velit maiores qui laborum enim.",
    "task_id": 12,
    "workflow_id": 32,
    "instance_id": 1,
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "start": "2021-02-03 12:45:34",
    "end": "2021-02-03 12:45:34",
    "comment": "Quo aliquid aut expedita quia labore deserunt aspernatur.",
    "task_id": 12,
    "workflow_id": 32,
    "instance_id": 1,
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint gets the Hold using the task and workflow links

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/holds/task/{task_id}/workflow/{workflow_id}

Filtering

Parameter	Operator	Validation
id	=	Numeric
task_id	=	Numeric
workflow_id	=	Numeric
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"3"}

URL encoded %7B%22instance_id%22%3A%223%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/holds/task/12/workflow/32?filter=%7B%22instance_id%22%3A%223%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The link to a task
workflow_id	GET	The link to a workflow

Create a Hold

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/holds/task/156/workflow/167 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "start": "2021-07-13 15:20:12",
    "comment": "Deserunt a ut unde accusantium.",
    "instance_id": "4"
  }'

{
  "id": 4,
  "start": "2021-07-13 15:20:12",
  "end": "2021-07-13 17:10:01",
  "comment": "Deserunt a ut unde accusantium.",
  "task_id": "156",
  "workflow_id": "167",
  "instance_id": "4",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Hold.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/holds/task/{task_id}/workflow/{workflow_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The link to a task
workflow_id	GET	The link to a workflow
start	POST	The start time of the Hold
comment	POST	A comment to explain the Hold
task_id	POST	The link to a task
workflow_id	POST	The link to a workflow
instance_id	POST	The link to an instance

Update a Specific Hold

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/holds/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "start": "2021-07-13 15:20:12",
    "comment": "Quo dolore aut amet adipisci sint rerum.",
    "task_id": "26",
    "workflow_id": "6",
    "instance_id": "1"
  }'

{
  "id": 4,
  "start": "2021-07-13 15:20:12",
  "end": "2021-07-13 16:12:05",
  "comment": "Quo dolore aut amet adipisci sint rerum.",
  "task_id": "26",
  "workflow_id": "6",
  "instance_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Hold.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/holds/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Hold
start	PATCH	The start time of the Hold
comment	PATCH	A comment to explain the Hold
task_id	PATCH	The link to a task
workflow_id	PATCH	The link to a workflow
instance_id	PATCH	The link to an instance

Delete a Specific Hold

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/holds/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "start": "2021-07-13 15:20:12",
  "end": "2021-07-13 18:34:05",
  "comment": "Omnis reprehenderit cupiditate expedita et ab quaerat.",
  "task_id": "161",
  "workflow_id": "168",
  "instance_id": "4",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Hold.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/holds/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Hold

Remove a Hold from a task

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/holds/task/12/workflow/32 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "end": "2021-02-03 14:15:16"
  }'

{
  "id": 1,
  "start": "2021-02-03 12:45:34",
  "end": "2021-02-03 14:15:16",
  "comment": "This is a comment",
  "task_id": 12,
  "workflow_id": 32,
  "instance_id": 1,
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint removes the current hold from a task

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/holds/task/{task_id}/workflow/{workflow_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The link to a task
workflow_id	GET	The link to a workflow
end	PATCH	The end time of the Hold

Instances

Instances Summary

The instance endpoint allows you to list, view and manage all the instances. An instance contains workflow that can be executed for a pre-determined project plan of activities.

Attributes

field	description
id	The ID of the Instance
name	The unique name of the Instance
label	The label of the Instance
image	The path to the image of the Instance
data	A detailed description of the Instance
instance_group_id	The instance group the Instance is linked to
created_at	The date the Instance was created
updated_at	The date the Instance was last updated

Get all Instances

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "safety-engineer",
    "label": "Safety Engineer",
    "image": "https://example.com/storage/wfc-default-banner.png",
    "data": "",
    "instance_group_id": "1",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "transportation-attendant",
    "label": "Transportation Attendant",
    "image": "https://example.com/storage/wfc-default-banner.png",
    "data": "",
    "instance_group_id": "1",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "photographic-process-worker",
    "label": "Photographic Process Worker",
    "image": "https://example.com/storage/wfc-default-banner.png",
    "data": "",
    "instance_group_id": "1",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Instances.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Safety Engineer"}

URL encoded %7B%22label%22%3A%22Safety+Engineer%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/instances?filter=%7B%22label%22%3A%22Safety+Engineer%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Instances with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "potter",
      "label": "Potter",
      "image": "https://example.com/storage/wfc-default-banner.png",
      "data": "",
      "instance_group_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "media-and-communication-worker",
      "label": "Media and Communication Worker",
      "image": "https://example.com/storage/wfc-default-banner.png",
      "data": "",
      "instance_group_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "forest-fire-fighting-supervisor",
      "label": "Forest Fire Fighting Supervisor",
      "image": "https://example.com/storage/wfc-default-banner.png",
      "data": "",
      "instance_group_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/instances\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/instances\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/instances\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Instances with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Potter"}

URL encoded %7B%22label%22%3A%22Potter%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/instances/paginate?filter=%7B%22label%22%3A%22Potter%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create an Instance

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Command Control Center Specialist"
  }'

{
  "id": 4,
  "name": "command-control-center-specialist",
  "label": "Command Control Center Specialist",
  "image": "https://example.com/storage/wfc-default-banner.png",
  "data": "",
  "instance_group_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Instance.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Instance

Get a Specific Instance

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "short-order-cook",
  "label": "Short Order Cook",
  "image": "https://example.com/storage/wfc-default-banner.png",
  "data": "",
  "instance_group_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Instance.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance

Update a Specific Instance

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Precision Etcher and Engraver"
  }'

{
  "id": 4,
  "name": "precision-etcher-and-engraver",
  "label": "Precision Etcher and Engraver",
  "image": "https://example.com/storage/wfc-default-banner.png",
  "data": "",
  "instance_group_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Instance.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance
label	PATCH	The label of the Instance

Delete a Specific Instance

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "pharmacist",
  "label": "Pharmacist",
  "image": "https://example.com/storage/wfc-default-banner.png",
  "data": "",
  "instance_group_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Instance.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance

Project view instances

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/project \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "id": 1
}

This endpoint gets the instances linked through a scenario formatted for the project view

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/project

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Resets the Instance

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/reset \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "task": "remove-times",
    "issue": "archive-confirmed",
    "taskComment": "delete-comment",
    "issueComment": "delete-comment"
  }'

{
  "task": "remove-times",
  "issue": "archive-confirmed",
  "taskComment": "delete-comment",
  "issueComment": "delete-comment"
}

This endpoint resets the Instance with the given parameters back to its original state

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/reset

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance
task	PATCH	Reset task no-action OR remove-times
issue	PATCH	Reset no-action OR delete-all OR archive-confirmed OR archive-confirmed-delete
taskComment	PATCH	Reset no-action OR delete-comment
issueComment	PATCH	Reset no-action OR delete-comment

Clones the Instance

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/clone \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Shipping and Receiving Clerk"
  }'

[ 
  clone-queued
]

This endpoint clones the Instance with the new label given

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/clone

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance
label	PATCH	The label of the Instance

Lists all the available scenarios for instances

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/scenarios \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 5,
    "label": "Client A and B"
  },
  {
    "id": 6,
    "label": "Client C and D"
  }
]

This endpoint retrieves all scenarios that can be assigned to Instances ordered by label. You can also use the scenarios endpoint however if you do not have access to that endpoint this is a alternative for the Instances module See Scenarios for more information. Only scenarios that have the attribute editable=0 can be added to and instance.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/scenarios

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Resets Instance image to default

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/reset-image \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "shipping-and-receiving-clerk",
  "label": "Shipping and Receiving Clerk",
  "image": "https://example.com/storage/task-image/wfc-default-banner.png",
  "avatar": "https://example.com/storage/avater/default-avatar.png",
  "instance_group_id": 1,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint resets the Instance image to its default value

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/reset-image

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance

Lists all the available instance groups for Instances

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/instance-groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 3,
    "label": "Aerospace Engineer"
  },
  {
    "id": 1,
    "label": "Building Inspector"
  },
  {
    "id": 2,
    "label": "Freight Inspector"
  }
]

This endpoint retrieves all instance groups that can be assigned to Instances ordered by label. You can also use the instance groups endpoint however if you do not have access to that endpoint this is a alternative for the Instance module. For more information on Instance Groups See Instance Groups

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/instance-groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Resets Instance image to default

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/reset-avatar \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "shipping-and-receiving-clerk",
  "label": "Shipping and Receiving Clerk",
  "image": "https://example.com/storage/task-image/wfc-default-banner.png",
  "avatar": "https://example.com/storage/avater/default-avatar.png",
  "instance_group_id": 1,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint resets the Instance image to its default value

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/reset-avatar

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance

Updates the Instance image to the given image

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/update-image \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "imageData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgANvL ... fwnQxYVeu3ASUVORK5CYII="
  }'

{
  "id": 4,
  "name": "shipping-and-receiving-clerk",
  "label": "Shipping and Receiving Clerk",
  "image": "https://example.com/storage/IMAGE__d8bc8d2b37c1d11a82cd7c2c59d685da.png",
  "avatar": "https://example.com/storage/avater/default-avatar.png",
  "instance_group_id": 1,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint updates the Instance image to the given image

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/update-image

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance
imageData	PATCH	A base64 encoded image

Lists all scenarios linked to a given instance

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/scenarios \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "scenarios": [
    1,
    5
  ]
}

This endpoint retrieves all scenario id's that have been assigned to a given instance. The corresponding scenario for the instance is also returned, this scenario cannot be removed. For more information on scenarios See Scenarios

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/scenarios

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance

Updates the scenarios linked to a given instance

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/scenarios \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "scenarios" {
      "0": 5,
      "1": 6
    } [
      5,
      6
    ]
  }'

[ 
  3,
  5,
  6
]

This endpoint updates the scenario id's linked to a given instance, the scenarios must be complete as the endpoint will remove any ID's not in the list. The corresponding scenario for the instance is also returned, this scenario cannot be removed. For more information on scenarios See Scenarios

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/scenarios

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance
scenarios	PATCH	An array of scenarios to add to an Instance

Updates the Instance image to the given image

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/update-avatar \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "imageData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgANvL ... fwnQxYVeu3ASUVORK5CYII="
  }'

{
  "id": 4,
  "name": "shipping-and-receiving-clerk",
  "label": "Shipping and Receiving Clerk",
  "image": "https://example.com/storage/IMAGE__d8bc8d2b37c1d11a82cd7c2c59d685da.png",
  "avatar": "https://example.com/storage/avater/default-avatar.png",
  "instance_group_id": 1,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint updates the Instance image to the given image

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/update-avatar

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance
imageData	PATCH	A base64 encoded image

Categories for reporting

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/report/categories \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Synchronised web-enabled focus group"
  },
  {
    "id": 2,
    "label": "Profit-focused attitude-oriented archive"
  }
]

This endpoint gets the available categories linked to the Instance to build a report

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/report/categories

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance

Instance Report

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/report/format/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "categories" {
      "0": 1,
      "1": 2,
      "2": 3
    } [
      1,
      2,
      3
    ]
  }'

{
}

This endpoint will produce the instance report, If there are components or workflows out of scope they will also be excluded from the report

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/report/format/{export_format}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance
export_format	GET	The file format of the export (CSV, ODS and XLSX)
categories	PATCH	An array of categories

Sequences the Instances

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/sequence \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "ordering" {
      "0" {
        "id": 1,
        "original": 0,
        "new": 0
      },
      "1" {
        "id": 2,
        "original": 1,
        "new": 1
      },
      "2" {
        "id": 3,
        "original": 2,
        "new": 2
      }
    } [
      {
        "id": 1,
        "original": 0,
        "new": 0
      },
      {
        "id": 2,
        "original": 1,
        "new": 1
      },
      {
        "id": 3,
        "original": 2,
        "new": 2
      }
    ]
  }'

[
  {
    "id": 1,
    "original": 0,
    "new": 0
  },
  {
    "id": 2,
    "original": 1,
    "new": 1
  },
  {
    "id": 3,
    "original": 2,
    "new": 2
  }
]

This endpoint updates the sequences Instances

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/sequence

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Sequences up an Instance

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/sequence/up \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "sequence": 0
}

This endpoint updates the sequences Instances

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/sequence/up

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance

Sequences down an Instance

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/1/sequence/down \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "sequence": 2
}

This endpoint updates the sequences Instances

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/{id}/sequence/down

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance

Export Instances

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "instances"
}

This endpoint exports to a file the current filters Instances in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Director Of Talent Acquisition"}

URL encoded %7B%22label%22%3A%22Director+Of+Talent+Acquisition%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/instances/export/csv?filter=%7B%22label%22%3A%22Director+Of+Talent+Acquisition%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Instances

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instances/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "instances"
}

This endpoint imports from a file the Instances in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/instances/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Instance Groups

Instance Groups Summary

The instance groups endpoint allows you to list, view and manage all the instance groups. An instance group is a way of grouping related instances together (cloned or otherwise) for common search and reporting capabilities.

Attributes

field	description
id	The ID of the Instance Group
name	The unique name of the Instance Group
label	The label of the Instance Group
created_at	The date the Instance Group was created
updated_at	The date the Instance Group was last updated

Get all Instance Groups

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "douglas-jakubowski",
    "label": "Douglas-Jakubowski",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "lockman-kessler",
    "label": "Lockman-Kessler",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "windler-pouros",
    "label": "Windler-Pouros",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Instance Groups.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instance-groups

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Douglas-Jakubowski"}

URL encoded %7B%22label%22%3A%22Douglas-Jakubowski%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups?filter=%7B%22label%22%3A%22Douglas-Jakubowski%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Instance Groups with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "cassin-and-sons",
      "label": "Cassin and Sons",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "zemlak-stokes",
      "label": "Zemlak-Stokes",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "wilkinson-group",
      "label": "Wilkinson Group",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/instance-groups\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/instance-groups\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/instance-groups\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Instance Groups with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instance-groups/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Cassin and Sons"}

URL encoded %7B%22label%22%3A%22Cassin+and+Sons%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups/paginate?filter=%7B%22label%22%3A%22Cassin+and+Sons%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create an Instance Group

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Hoeger PLC"
  }'

{
  "id": 4,
  "name": "hoeger-p-l-c",
  "label": "Hoeger PLC",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Instance Group.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/instance-groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Instance Group

Get a Specific Instance Group

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "dietrich-lebsack-and-bradtke",
  "label": "Dietrich, Lebsack and Bradtke",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Instance Group.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instance-groups/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance Group

Update a Specific Instance Group

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Huels-Thiel"
  }'

{
  "id": 4,
  "name": "huels-thiel",
  "label": "Huels-Thiel",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Instance Group.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/instance-groups/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance Group
label	PATCH	The label of the Instance Group

Delete a Specific Instance Group

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "kiehn-gusikowski",
  "label": "Kiehn-Gusikowski",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Instance Group.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/instance-groups/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Instance Group

Export Instance Groups

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "instancegroups"
}

This endpoint exports to a file the current filters Instance Groups in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/instance-groups/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Friesen, Marks and Grady"}

URL encoded %7B%22label%22%3A%22Friesen%2C+Marks+and+Grady%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups/export/csv?filter=%7B%22label%22%3A%22Friesen%2C+Marks+and+Grady%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Instance Groups

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/instance-groups/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "instancegroups"
}

This endpoint imports from a file the Instance Groups in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/instance-groups/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Issues

Issues Summary

The issues endpoint allows you to list, view and manage all the issues for an instance. The issues module is a searchable collection of issues raised for each scenario and linked to an instance group and or task. Issues can be raised and solved by anyone. Issues can also be raised directly from workflow tasks by users.

Attributes

field	description
id	The ID of the Issue
title	The title name of the Issue
priority	The priority of the Issue chosen from low, medium and high
status	The status of the Issue chosen from open and closed
instance_id	The instance the Issue is linked to
user_id	The user that is assigned to the Issue
description	The description of the Issue
resolution	The resolution of the Issue
confirmed_at	The timestamp the Issue was confirmed
archived_at	The timestamp the Issue was archived
task_id	The task ID when linked to ta task
workflow_id	The workflow ID when linked to ta task
created_at	The date the Issue was created
updated_at	The date the Issue was last updated

Get all Issues

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "title": "Streamlined upward-trending moratorium",
    "priority": "low",
    "status": "open",
    "instance_id": "2",
    "user_id": "",
    "description": "Some issue data...",
    "resolution": "",
    "confirmed_at": "",
    "archived_at": "",
    "task_id": "1",
    "workflow_id": "2",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "title": "Triple-buffered interactive conglomeration",
    "priority": "low",
    "status": "open",
    "instance_id": "4",
    "user_id": "",
    "description": "Some issue data...",
    "resolution": "",
    "confirmed_at": "",
    "archived_at": "",
    "task_id": "1",
    "workflow_id": "2",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "title": "Expanded neutral firmware",
    "priority": "low",
    "status": "open",
    "instance_id": "2",
    "user_id": "",
    "description": "Some issue data...",
    "resolution": "",
    "confirmed_at": "",
    "archived_at": "",
    "task_id": "1",
    "workflow_id": "2",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Issues.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues

Filtering

Parameter	Operator	Validation
id	=	Numeric
title	LIKE	String
priority	=	IN
status	=	IN
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"2"}

URL encoded %7B%22instance_id%22%3A%222%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/issues?filter=%7B%22instance_id%22%3A%222%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Issues with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "title": "Integrated bi-directional superstructure",
      "priority": "low",
      "status": "open",
      "instance_id": "4",
      "user_id": "",
      "description": "Some issue data...",
      "resolution": "",
      "confirmed_at": "",
      "archived_at": "",
      "task_id": "1",
      "workflow_id": "2",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "title": "Automated transitional adapter",
      "priority": "low",
      "status": "open",
      "instance_id": "4",
      "user_id": "",
      "description": "Some issue data...",
      "resolution": "",
      "confirmed_at": "",
      "archived_at": "",
      "task_id": "1",
      "workflow_id": "2",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "title": "Up-sized incremental archive",
      "priority": "low",
      "status": "open",
      "instance_id": "3",
      "user_id": "",
      "description": "Some issue data...",
      "resolution": "",
      "confirmed_at": "",
      "archived_at": "",
      "task_id": "1",
      "workflow_id": "2",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/issues\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/issues\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/issues\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Issues with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
title	LIKE	String
priority	=	IN
status	=	IN
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"4"}

URL encoded %7B%22instance_id%22%3A%224%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/issues/paginate?filter=%7B%22instance_id%22%3A%224%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create an Issue

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "title": "Exclusive discrete throughput",
    "priority": "low",
    "status": "open"
  }'

{
  "id": 4,
  "title": "Exclusive discrete throughput",
  "priority": "low",
  "status": "open",
  "instance_id": "1",
  "user_id": "",
  "description": "Some issue data...",
  "resolution": "",
  "confirmed_at": "",
  "archived_at": "",
  "task_id": "1",
  "workflow_id": "2",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Issue.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
title	POST	The title name of the Issue
priority	POST	The priority of the Issue chosen from low, medium and high
status	POST	The status of the Issue chosen from open and closed

Get a Specific Issue

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "title": "Quality-focused content-based task-force",
  "priority": "low",
  "status": "open",
  "instance_id": "1",
  "user_id": "",
  "description": "Some issue data...",
  "resolution": "",
  "confirmed_at": "",
  "archived_at": "",
  "task_id": "1",
  "workflow_id": "2",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Issue.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Issue

Update a Specific Issue

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "title": "Mandatory analyzing focusgroup",
    "priority": "low",
    "status": "open"
  }'

{
  "id": 4,
  "title": "Mandatory analyzing focusgroup",
  "priority": "low",
  "status": "open",
  "instance_id": "1",
  "user_id": "",
  "description": "Some issue data...",
  "resolution": "",
  "confirmed_at": "",
  "archived_at": "",
  "task_id": "1",
  "workflow_id": "2",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Issue.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Issue
title	PATCH	The title name of the Issue
priority	PATCH	The priority of the Issue chosen from low, medium and high
status	PATCH	The status of the Issue chosen from open and closed

Delete a Specific Issue

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "title": "Organic incremental website",
  "priority": "low",
  "status": "open",
  "instance_id": "4",
  "user_id": "",
  "description": "Some issue data...",
  "resolution": "",
  "confirmed_at": "",
  "archived_at": "",
  "task_id": "1",
  "workflow_id": "2",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Issue.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Issue

List users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/users \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "Nova Senger"
  },
  {
    "id": 2,
    "first_name": "Birdie Bernier"
  },
  {
    "id": 3,
    "first_name": "Rudy Gaylord"
  }
]

This endpoint lists the users available to be assigned to an Issue. For more information on users See Users

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/users

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Confirms the closure of an Issue

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/1/confirm \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 3,
  "title": "Enterprise-wide impactful approach",
  "priority": "medium",
  "status": "open",
  "instance_id": 1,
  "confirmed_at": "2020-06-12 12:50:49",
  "archived_at": "",
  "deleted_at": "",
  "created_at": "2020-06-12 12:46:19",
  "updated_at": "2020-06-12 12:47:46",
  "created": "Friday 12th June 12:46:19",
  "updated": "1 hour ago"
}

This endpoint allows an authorised user to confirm the closure of an Issue

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/{id}/confirm

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Issue

Archives the given an Issue

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/1/archive \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 3,
  "title": "Enterprise-wide impactful approach",
  "priority": "medium",
  "status": "open",
  "instance_id": 1,
  "confirmed_at": "",
  "archived_at": "2020-06-12 12:58:11",
  "deleted_at": "",
  "created_at": "2020-06-12 12:46:19",
  "updated_at": "2020-06-12 12:47:46",
  "created": "Friday 12th June 12:46:19",
  "updated": "1 hour ago"
}

This endpoint allows an authorised user to archive the given an Issue

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/{id}/archive

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Issue

List comments of a given Issue

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/1/comments \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "data": "his is default data for comments.",
    "type": "task",
    "user_id": 511,
    "instance_id": 1,
    "created_at": "2019-04-08 10:09:00",
    "updated_at": "2019-04-08 10:09:00"
  },
  {
    "id": 2,
    "data": "This is default data for comments.",
    "type": "task",
    "user_id": 446,
    "instance_id": 1,
    "created_at": "2019-04-08 10:09:00",
    "updated_at": "2019-04-08 10:09:00"
  },
  {
    "id": 3,
    "data": "This is default data for comments.",
    "type": "task",
    "user_id": 750,
    "instance_id": 1,
    "created_at": "2019-04-08 10:09:00",
    "updated_at": "2019-04-08 10:09:00"
  }
]

This endpoint lists the comments of a given Issue

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/{id}/comments

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Issue

Create Dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/create/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "can_create": 
}

This endpoint checks if the Issue has any Dependencies on other objects that will prevent it from being able to be created

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/create/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a linked Issue

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/linked/workflow/2/task/1 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "title": "Multi-channelled zerodefect challenge",
    "priority": "low"
  }'

{
  "id": 4,
  "title": "Multi-channelled zerodefect challenge",
  "priority": "low",
  "status": "open",
  "instance_id": 1,
  "confirmed_at": "",
  "archived_at": "",
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint creates a new Issue that is linked to a task by the task ID and workflow ID.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/linked/workflow/{workflow_id}/task/{task_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
workflow_id	GET	The workflow ID when linked to ta task
task_id	GET	The task ID when linked to ta task
title	POST	The title name of the Issue
priority	POST	The priority of the Issue chosen from low, medium and high

Export Issues

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "issues"
}

This endpoint exports to a file the current filters Issues in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
title	LIKE	String
priority	=	IN
status	=	IN
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"3"}

URL encoded %7B%22instance_id%22%3A%223%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/issues/export/csv?filter=%7B%22instance_id%22%3A%223%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Issues

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/issues/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "issues"
}

This endpoint imports from a file the Issues in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/issues/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Roles

Roles Summary

The roles endpoint allows you to list, view and manage all the roles. A role is assigned to users and API users each role is assigned permissions, these permissions allow certain actions within the application.

Attributes

field	description
id	The ID of the Role
name	The unique name of the Role
label	The label of the Role
created_at	The date the Role was created
updated_at	The date the Role was last updated

Get all Roles

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "precious-stone-worker",
    "label": "Precious Stone Worker",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "network-systems-analyst",
    "label": "Network Systems Analyst",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "teller",
    "label": "Teller",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Roles.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Precious Stone Worker"}

URL encoded %7B%22label%22%3A%22Precious+Stone+Worker%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/roles?filter=%7B%22label%22%3A%22Precious+Stone+Worker%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Roles with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "janitor",
      "label": "Janitor",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "license-clerk",
      "label": "License Clerk",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "construction-manager",
      "label": "Construction Manager",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/roles\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/roles\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/roles\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Roles with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Janitor"}

URL encoded %7B%22label%22%3A%22Janitor%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/roles/paginate?filter=%7B%22label%22%3A%22Janitor%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Role

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Life Science Technician"
  }'

{
  "id": 4,
  "name": "life-science-technician",
  "label": "Life Science Technician",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Role.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Role

Get a Specific Role

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "sawing-machine-setter",
  "label": "Sawing Machine Setter",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Role.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Role

Update a Specific Role

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Aircraft Mechanics OR Aircraft Service Technician"
  }'

{
  "id": 4,
  "name": "aircraft-mechanics-o-r-aircraft-service-technician",
  "label": "Aircraft Mechanics OR Aircraft Service Technician",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Role.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Role
label	PATCH	The label of the Role

Delete a Specific Role

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "cafeteria-cook",
  "label": "Cafeteria Cook",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Role.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Role

Lists all the available permissions

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles/permissions \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Manage Groups"
  },
  {
    "id": 2,
    "label": "Manage Teams"
  },
  {
    "id": 3,
    "label": "Manage Users"
  }
]

This endpoint retrieves all permissions that can be assigned to roles ordered by description.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles/permissions

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Lists all permissions linked to a given role

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles/1/permissions \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "permissions": [
    1
  ]
}

This endpoint retrieves all permission id's that have been assigned to a given role.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles/{id}/permissions

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Role

Updates the permissions linked to a given role

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles/1/permissions \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "permissions" {
      "0": 1,
      "1": 2,
      "2": 3
    } [
      1,
      2,
      3
    ]
  }'

[ 
  1,
  2,
  3
]

This endpoint updates the permission id's linked to a given role, the permission must be complete as the endpoint will remove any ID's not in the list.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles/{id}/permissions

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Role
permissions	PATCH	An array of permissions to add to a Role

Export Roles

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "roles"
}

This endpoint exports to a file the current filters Roles in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Health Educator"}

URL encoded %7B%22label%22%3A%22Health+Educator%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/roles/export/csv?filter=%7B%22label%22%3A%22Health+Educator%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Roles

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/roles/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "roles"
}

This endpoint imports from a file the Roles in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/roles/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Scenario Containers

Scenario Containers Summary

The scenario container endpoint allows you to list, view and manage all the scenario containers. An scenario container is a way of grouping related scenarios together when choosing a scenario to access

Attributes

field	description
id	The ID of the Scenario Container
name	The unique name of the Scenario Container
label	The label of the Scenario Container
created_at	The date the Scenario Container was created
updated_at	The date the Scenario Container was last updated

Get all Scenario Containers

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "goyette-ltd",
    "label": "Goyette Ltd",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "christiansen-feeney-and-kihn",
    "label": "Christiansen, Feeney and Kihn",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "ondricka-prosacco",
    "label": "Ondricka-Prosacco",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Scenario Containers.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenario-containers

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Goyette Ltd"}

URL encoded %7B%22label%22%3A%22Goyette+Ltd%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers?filter=%7B%22label%22%3A%22Goyette+Ltd%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Scenario Containers with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "carroll-l-l-c",
      "label": "Carroll LLC",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "hackett-parker-and-reilly",
      "label": "Hackett, Parker and Reilly",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "moore-and-sons",
      "label": "Moore and Sons",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/scenario-containers\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/scenario-containers\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/scenario-containers\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Scenario Containers with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenario-containers/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Carroll LLC"}

URL encoded %7B%22label%22%3A%22Carroll+LLC%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers/paginate?filter=%7B%22label%22%3A%22Carroll+LLC%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Scenario Container

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Jaskolski, Kilback and Wyman"
  }'

{
  "id": 4,
  "name": "jaskolski-kilback-and-wyman",
  "label": "Jaskolski, Kilback and Wyman",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Scenario Container.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenario-containers

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Scenario Container

Get a Specific Scenario Container

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "jacobi-p-l-c",
  "label": "Jacobi PLC",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Scenario Container.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenario-containers/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario Container

Update a Specific Scenario Container

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Romaguera, Hahn and Gusikowski"
  }'

{
  "id": 4,
  "name": "romaguera-hahn-and-gusikowski",
  "label": "Romaguera, Hahn and Gusikowski",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Scenario Container.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenario-containers/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario Container
label	PATCH	The label of the Scenario Container

Delete a Specific Scenario Container

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "hane-group",
  "label": "Hane Group",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Scenario Container.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenario-containers/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario Container

Export Scenario Containers

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "scenariocontainers"
}

This endpoint exports to a file the current filters Scenario Containers in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenario-containers/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Hill, Howe and Stark"}

URL encoded %7B%22label%22%3A%22Hill%2C+Howe+and+Stark%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers/export/csv?filter=%7B%22label%22%3A%22Hill%2C+Howe+and+Stark%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Scenario Containers

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenario-containers/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "scenariocontainers"
}

This endpoint imports from a file the Scenario Containers in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenario-containers/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Scenarios

Scenarios Summary

The scenarios endpoint allows you to list, view and manage all the scenarios. A scenario is a single or a collection of instances.

Attributes

field	description
id	The ID of the Scenario
name	The unique name of the Scenario
label	The label of the Scenario
active	True or False if the Scenario is active and allows logins
scenario_container_id	The ID of the Scenarios container
created_at	The date the Scenario was created
updated_at	The date the Scenario was last updated

Get all Scenarios

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "fashion-designer",
    "label": "Fashion Designer",
    "active": "",
    "scenario_container_id": "6",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "bridge-tender-o-r-lock-tender",
    "label": "Bridge Tender OR Lock Tender",
    "active": "",
    "scenario_container_id": "51",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "machine-tool-operator",
    "label": "Machine Tool Operator",
    "active": "",
    "scenario_container_id": "19",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Scenarios.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
scenario_container_id	=	String

The filter string is a URL encoded JSON string.

JSON string {"scenario_container_id":"6"}

URL encoded %7B%22scenario_container_id%22%3A%226%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/scenarios?filter=%7B%22scenario_container_id%22%3A%226%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Scenarios with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "production-laborer",
      "label": "Production Laborer",
      "active": "",
      "scenario_container_id": "26",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "biophysicist",
      "label": "Biophysicist",
      "active": "",
      "scenario_container_id": "27",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "travel-clerk",
      "label": "Travel Clerk",
      "active": "",
      "scenario_container_id": "40",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/scenarios\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/scenarios\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/scenarios\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Scenarios with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
scenario_container_id	=	String

The filter string is a URL encoded JSON string.

JSON string {"scenario_container_id":"26"}

URL encoded %7B%22scenario_container_id%22%3A%2226%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/paginate?filter=%7B%22scenario_container_id%22%3A%2226%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Scenario

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Surveyor"
  }'

{
  "id": 4,
  "name": "surveyor",
  "label": "Surveyor",
  "active": "",
  "scenario_container_id": "24",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Scenario.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Scenario

Get a Specific Scenario

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "computer-software-engineer",
  "label": "Computer Software Engineer",
  "active": "",
  "scenario_container_id": "6",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Scenario.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario

Update a Specific Scenario

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Healthcare Support Worker"
  }'

{
  "id": 4,
  "name": "healthcare-support-worker",
  "label": "Healthcare Support Worker",
  "active": "",
  "scenario_container_id": "19",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Scenario.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario
label	PATCH	The label of the Scenario

Delete a Specific Scenario

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "recordkeeping-clerk",
  "label": "Recordkeeping Clerk",
  "active": "",
  "scenario_container_id": "6",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Scenario.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario

Lists all the available users for scenarios

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/users \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 2,
    "first_name": "Thalia",
    "last_name": "Abbott"
  },
  {
    "id": 1,
    "first_name": "Omari",
    "last_name": "Bahringer"
  },
  {
    "id": 3,
    "first_name": "Kristina",
    "last_name": "Cole"
  }
]

This endpoint retrieves all users that can be assigned to scenarios ordered by last_name. You can also use the users endpoint however if you do not have access to that endpoint this is a alternative for the scenarios module See Users for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/users

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Lists all the available roles for scenarios

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/roles \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Administrator"
  },
  {
    "id": 3,
    "label": "Guest"
  },
  {
    "id": 2,
    "label": "Team Member"
  }
]

This endpoint retrieves all roles that can be assigned to scenarios ordered by label. You can also use the roles endpoint however if you do not have access to that endpoint this is a alternative for the scenarios module See Roles for more information. Roles are linked to scenarios to allow a pass-thru where the scenario is not active.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/roles

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Lists all the available instances for scenarios

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/instances \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Client A"
  },
  {
    "id": 2,
    "label": "Client B"
  },
  {
    "id": 3,
    "label": "Client C"
  },
  {
    "id": 4,
    "label": "Client D"
  }
]

This endpoint retrieves all instances that can be assigned to scenarios ordered by label. You can also use the instances endpoint however if you do not have access to that endpoint this is a alternative for the scenarios module See Instances for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/instances

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Lists all users linked to a given scenario

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/1/users \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "users": [
    1,
    2
  ]
}

This endpoint retrieves all users id's that have been assigned to a given scenario. For more information on users See Users

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}/users

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario

Updates the user linked to a given scenario

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/1/users \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "users" {
      "0": 1,
      "1": 2,
      "2": 3
    } [
      1,
      2,
      3
    ]
  }'

[ 
  1,
  2,
  3
]

This endpoint updates the user id's linked to a given scenario, the users must be complete as the endpoint will remove any ID's not in the list. For more information on users See Users

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}/users

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario
users	PATCH	An array of users to add to a Scenario

Lists all roles linked to a given scenario

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/1/roles \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "roles": [
    1,
    2
  ]
}

This endpoint retrieves all roles id's that have been assigned to a given scenario. For more information on roles See Roles. Roles are linked to scenarios to allow a pass-thru where the scenario is not active.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}/roles

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario

Updates the role linked to a given scenario

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/1/roles \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "roles" {
      "0": 1,
      "1": 2,
      "2": 3
    } [
      1,
      2,
      3
    ]
  }'

[ 
  1,
  2,
  3
]

This endpoint updates the role id's linked to a given scenario, the roles must be complete as the endpoint will remove any ID's not in the list. For more information on roles See Roles. Roles are linked to scenarios to allow a pass-thru where the scenario is not active.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}/roles

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario

Lists all instances linked to a given scenario

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/1/instances \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "instances": [
    1,
    2,
    3
  ]
}

This endpoint retrieves all instance id's that have been assigned to a given scenario. For more information on instances See Instances

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}/instances

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario

Updates the instance linked to a given scenario

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/1/instances \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "instances" {
      "0": 1,
      "1": 2,
      "2": 3,
      "3": 4
    } [
      1,
      2,
      3,
      4
    ]
  }'

[ 
  1,
  2,
  3,
  4
]

This endpoint updates the instance id's linked to a given scenario, the instances must be complete as the endpoint will remove any ID's not in the list. For more information on instances See Instances. You can only update scenarios where the attribute editable is 0.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}/instances

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario
instances	PATCH	An array of instances to add to a Scenario

Lists all the available containers for Scenarios

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/scenario-containers \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 1,
  "label": "Default"
}

This endpoint retrieves all containers that can be assigned to Scenarios ordered by label. You can also use the scenario containers endpoint however if you do not have access to that endpoint this is a alternative for the Scenario module. For more information on Scenario Containers See Scenario Containers

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/scenario-containers

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Sequences the Scenarios

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/sequence \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "ordering" {
      "0" {
        "id": 1,
        "original": 0,
        "new": 0
      },
      "1" {
        "id": 2,
        "original": 1,
        "new": 1
      },
      "2" {
        "id": 3,
        "original": 2,
        "new": 2
      }
    } [
      {
        "id": 1,
        "original": 0,
        "new": 0
      },
      {
        "id": 2,
        "original": 1,
        "new": 1
      },
      {
        "id": 3,
        "original": 2,
        "new": 2
      }
    ]
  }'

[
  {
    "id": 1,
    "original": 0,
    "new": 0
  },
  {
    "id": 2,
    "original": 1,
    "new": 1
  },
  {
    "id": 3,
    "original": 2,
    "new": 2
  }
]

This endpoint updates the sequences Scenarios

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/sequence

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Sequences up a Scenario

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/1/sequence/up \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "sequence": 0
}

This endpoint updates the sequences Scenarios

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}/sequence/up

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario

Sequences down a Scenario

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/1/sequence/down \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "sequence": 2
}

This endpoint updates the sequences Scenarios

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/{id}/sequence/down

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Scenario

Export Scenarios

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "scenarios"
}

This endpoint exports to a file the current filters Scenarios in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
scenario_container_id	=	String

The filter string is a URL encoded JSON string.

JSON string {"scenario_container_id":"48"}

URL encoded %7B%22scenario_container_id%22%3A%2248%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/export/csv?filter=%7B%22scenario_container_id%22%3A%2248%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Scenarios

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/scenarios/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "scenarios"
}

This endpoint imports from a file the Scenarios in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/scenarios/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Tasks

Tasks Summary

The tasks endpoint allows you to list, view and manage all the tasks for an instance. A task is a sub-element of a workflow, workflow tasks are specific granular-level tasks that can be checked out and in by users.  Each task carries an estimated time for execution.  Task check-outs and check-ins are time-stamp recorded.

Attributes

field	description
id	The ID of the Task
name	The unique name of the Task
label	The label of the Task
estimate	The estimated number of seconds the Task will take to be executed
data	The data explaining how the Task should be executed
content_status	The status of the content
content_owner	The name of the person responsible for the content
concurrency	The number of Tasks that user can check-out at the same time
team_id	The team the Task is linked to
group_id	The group the Task is linked to
instance_id	The instance the Task is linked to
created_at	The date the Task was created
updated_at	The date the Task was last updated

Get all Tasks

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "focused-high-level-forecast",
    "label": "Focused high-level forecast",
    "estimate": "4500",
    "data": "Some task data...",
    "content_status": "incomplete",
    "content_owner": "Taryn Lindgren",
    "concurrency": "",
    "team_id": "1",
    "group_id": "1",
    "instance_id": "1",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "reactive-stable-help-desk",
    "label": "Reactive stable help-desk",
    "estimate": "3240",
    "data": "Some task data...",
    "content_status": "incomplete",
    "content_owner": "Zachariah Braun",
    "concurrency": "",
    "team_id": "1",
    "group_id": "1",
    "instance_id": "1",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "reactive-eco-centric-encoding",
    "label": "Reactive eco-centric encoding",
    "estimate": "2640",
    "data": "Some task data...",
    "content_status": "incomplete",
    "content_owner": "Salma Waelchi",
    "concurrency": "",
    "team_id": "1",
    "group_id": "1",
    "instance_id": "1",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Tasks.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
content_status	LIKE	String
content_owner	LIKE	String
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"1"}

URL encoded %7B%22instance_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/tasks?filter=%7B%22instance_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Tasks with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "customer-focused-stable-capability",
      "label": "Customer-focused stable capability",
      "estimate": "6720",
      "data": "Some task data...",
      "content_status": "incomplete",
      "content_owner": "Yasmeen Abernathy",
      "concurrency": "",
      "team_id": "1",
      "group_id": "1",
      "instance_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "centralized-eco-centric-hardware",
      "label": "Centralized eco-centric hardware",
      "estimate": "6780",
      "data": "Some task data...",
      "content_status": "incomplete",
      "content_owner": "Aiyana Effertz",
      "concurrency": "",
      "team_id": "1",
      "group_id": "1",
      "instance_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "profit-focused-contextually-based-graphical-user-interface",
      "label": "Profit-focused contextually-based GraphicalUserInterface",
      "estimate": "4500",
      "data": "Some task data...",
      "content_status": "incomplete",
      "content_owner": "Florence Yundt",
      "concurrency": "",
      "team_id": "1",
      "group_id": "1",
      "instance_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/tasks\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/tasks\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/tasks\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Tasks with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
content_status	LIKE	String
content_owner	LIKE	String
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"1"}

URL encoded %7B%22instance_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/tasks/paginate?filter=%7B%22instance_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Task

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Distributed transitional conglomeration",
    "estimate": "5580",
    "content_owner": "Annalise Quigley",
    "concurrency": "",
    "team_id": "1",
    "group_id": "1",
    "instance_id": "1",
    "content_status": "incomplete"
  }'

{
  "id": 4,
  "name": "distributed-transitional-conglomeration",
  "label": "Distributed transitional conglomeration",
  "estimate": "5580",
  "data": "Some task data...",
  "content_status": "incomplete",
  "content_owner": "Annalise Quigley",
  "concurrency": "",
  "team_id": "1",
  "group_id": "1",
  "instance_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Task.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Task
estimate	POST	The estimated number of seconds the Task will take to be executed
content_owner	POST	The name of the person responsible for the content
concurrency	POST	The number of Tasks that user can check-out at the same time
team_id	POST	The team the Task is linked to
group_id	POST	The group the Task is linked to
instance_id	POST	The instance the Task is linked to
content_status	POST	The status of the content

Get a Specific Task

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "up-sized-attitude-oriented-benchmark",
  "label": "Up-sized attitude-oriented benchmark",
  "estimate": "2640",
  "data": "Some task data...",
  "content_status": "incomplete",
  "content_owner": "Isabelle Cartwright",
  "concurrency": "",
  "team_id": "1",
  "group_id": "1",
  "instance_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Task.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Task

Update a Specific Task

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Up-sized user-facing database",
    "estimate": "1800",
    "content_owner": "Holly Treutel",
    "concurrency": "",
    "team_id": "1",
    "group_id": "1",
    "instance_id": "1",
    "content_status": "incomplete"
  }'

{
  "id": 4,
  "name": "up-sized-user-facing-database",
  "label": "Up-sized user-facing database",
  "estimate": "1800",
  "data": "Some task data...",
  "content_status": "incomplete",
  "content_owner": "Holly Treutel",
  "concurrency": "",
  "team_id": "1",
  "group_id": "1",
  "instance_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Task.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Task
label	PATCH	The label of the Task
estimate	PATCH	The estimated number of seconds the Task will take to be executed
content_owner	PATCH	The name of the person responsible for the content
concurrency	PATCH	The number of Tasks that user can check-out at the same time
team_id	PATCH	The team the Task is linked to
group_id	PATCH	The group the Task is linked to
instance_id	PATCH	The instance the Task is linked to
content_status	PATCH	The status of the content

Delete a Specific Task

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "multi-layered-discrete-superstructure",
  "label": "Multi-layered discrete superstructure",
  "estimate": "3840",
  "data": "Some task data...",
  "content_status": "incomplete",
  "content_owner": "Delta Erdman",
  "concurrency": "",
  "team_id": "1",
  "group_id": "1",
  "instance_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Task.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Task

Lists available teams for Tasks

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/teams \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Aircraft Cargo Handling Supervisor"
  },
  {
    "id": 3,
    "label": "Alteration Tailor"
  },
  {
    "id": 2,
    "label": "Central Office Operator"
  }
]

This endpoint retrieves all teams that can be assigned to tasks ordered by label. You can also use the teams endpoint however if you do not have access to that endpoint this is a alternative for the task module See Teams for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/teams

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Upload an image for a Task

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/image \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "imageData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgANvL ... fwnQxYVeu3ASUVORK5CYII="
  }'

{
  "name": "https://example.com/storage/IMAGE__d8bc8d2b37c1d11a82cd7c2c59d685da.png"
}

This endpoint uploads an image for a task

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/image

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
imageData	PATCH	A base64 encoded image for a Task

Lists available groups for Tasks

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 3,
    "label": "Biochemist or Biophysicist"
  },
  {
    "id": 2,
    "label": "Chemistry Teacher"
  },
  {
    "id": 1,
    "label": "Clinical School Psychologist"
  }
]

This endpoint retrieves all groups that can be assigned to tasks ordered by label. You can also use the groups endpoint however if you do not have access to that endpoint this is a alternative for the task module See Groups for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Project view tasks

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/1 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "workflow_id": 1,
    "name": "De-engineered zerotolerance localareanetwork",
    "user_name": "Unassigned",
    "user_avatar": "https://example.com/storage/default-avatar.png",
    "user_status": "not-known",
    "start_time": "na",
    "end_time": "na",
    "status": "ready",
    "type": "tasks",
    "loads": "",
    "from": 1
  },
  {
    "id": 2,
    "workflow_id": 1,
    "name": "Triple-buffered multi-tasking hub",
    "user_name": "Unassigned",
    "user_avatar": "https://example.com/storage/default-avatar.png",
    "user_status": "not-known",
    "start_time": "na",
    "end_time": "na",
    "status": "dependency",
    "type": "tasks",
    "loads": "",
    "from": 1
  },
  {
    "id": 3,
    "workflow_id": 1,
    "name": "Balanced reciprocal artificialintelligence",
    "user_name": "Unassigned",
    "user_avatar": "https://example.com/storage/default-avatar.png",
    "user_status": "not-known",
    "start_time": "na",
    "end_time": "na",
    "status": "dependency",
    "type": "tasks",
    "loads": "",
    "from": 1
  }
]

This endpoint gets the tasks linked through workflows formatted for the project view

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Task

Create Dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/create/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "can_create": 
}

This endpoint checks if the Task has any Dependencies on other objects that will prevent it from being able to be created

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/create/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Project view task

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "instance" {
    "id": 1,
    "label": "Client A",
    "name": "client-a",
    "image": "https://example.com/storage/wfc-default-banner.png"
  },
  "category" {
    "id": 14,
    "name": "up-sized-homogeneous-analyzer",
    "label": "Up-sized homogeneous analyzer",
    "data": "Some category data..."
  },
  "component" {
    "id": 1,
    "name": "multi-channelled-web-enabled-openarchitecture",
    "label": "Multi-channelled web-enabled openarchitecture",
    "data": "Some component data..."
  },
  "workflow" {
    "id": 1,
    "name": "multi-channelled-reciprocal-matrix",
    "label": "Multi-channelled reciprocal matrix",
    "data": "Some workflow data..."
  },
  "task" {
    "id": 1,
    "name": "de-engineered-zerotolerance-localareanetwork",
    "label": "De-engineered zerotolerance localareanetwork",
    "start_time": "na",
    "start_timestamp": "",
    "end_time": "na",
    "end_timestamp": "",
    "estimate_time": "05:33:00",
    "team" {
      "id": 1,
      "name": "workflow-centre-team",
      "label": "Workflow Centre Team",
      "created_at": "2021-02-09 11:30:53",
      "updated_at": "2021-02-09 11:30:53"
    },
    "group" {
      "id": 1,
      "name": "command-and-control",
      "label": "Command and Control",
      "created_at": "2021-02-09 11:30:53",
      "updated_at": "2021-02-09 11:30:53"
    },
    "content_status": "incomplete",
    "content_owner": "Rory Cartwright",
    "created_at": "2021-02-09 11:33:23",
    "updated_at": "2021-02-09 11:34:09",
    "data": "Some task data...",
    "assignee" {
      "id": 0,
      "name": "Unassigned",
      "avatar": "https://example.com/storage/default-avatar.png",
      "status": "not-known"
    },
    "status": "ready"
  },
  "task_previous" {
    "id": 0,
    "name": "start-of-workflow",
    "label": "Start of Workflow",
    "sequence": 0
  },
  "task_next" {
    "id": 2,
    "name": "triple-buffered-multi-tasking-hub",
    "label": "Triple-buffered multi-tasking hub",
    "sequence": 1
  }
}

This endpoint gets a given task linked through a workflow formatted for the project view

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Reset the task

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/reset \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{
}

This endpoint allows you to update the Start/End time of a given task

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/reset

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Get the issues

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/issues \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "title": "Right-sized logistical moratorium",
    "priority": "low",
    "status": "open",
    "instance_id": 1,
    "user_id": "",
    "description": "Some issue data...",
    "resolution": "",
    "confirmed_at": "",
    "archived_at": "",
    "task_id": 1,
    "workflow_id": 1,
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "title": "Configurable grid-enabled ability",
    "priority": "low",
    "status": "open",
    "instance_id": 1,
    "user_id": "",
    "description": "Some issue data...",
    "resolution": "",
    "confirmed_at": "",
    "archived_at": "",
    "task_id": 1,
    "workflow_id": 1,
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "title": "Fundamental motivating benchmark",
    "priority": "low",
    "status": "open",
    "instance_id": 1,
    "user_id": "",
    "description": "Some issue data...",
    "resolution": "",
    "confirmed_at": "",
    "archived_at": "",
    "task_id": 1,
    "workflow_id": 1,
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint gets the issues for a given task linked through a workflow

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/issues

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Assign a task to a user

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/assign \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "user_id": 1
  }'

{
}

This endpoint allows you to assign a task to a given user

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/assign

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow
user_id	PATCH	The ID of the user

Get the comments

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/comments \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "data": "Some comment data...",
    "id": 1,
    "task_id": 1,
    "user_id": 467,
    "issue_id": "",
    "instance_id": 1,
    "workflow_id": 1,
    "type": "task",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "data": "Some comment data...",
    "id": 2,
    "task_id": 1,
    "user_id": 182,
    "issue_id": "",
    "instance_id": 1,
    "workflow_id": 1,
    "type": "task",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "data": "Some comment data...",
    "id": 3,
    "task_id": 1,
    "user_id": 882,
    "issue_id": "",
    "instance_id": 1,
    "workflow_id": 1,
    "type": "task",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint gets the comments for a given task linked through a workflow

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/comments

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Get a given task in PDF format

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/download \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{
}

This endpoint gets a given task in a PDF format

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/download

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Check in a task

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/check-in \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{
}

Check in a given task to the logged in user

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/check-in

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Re-assign a task to a user

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/re-assign \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{
}

This endpoint allows you to re-assign a task to a given user

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/re-assign

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Check out a task

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/check-out \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{
}

Check out a given task to the logged in user

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/check-out

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

List the users for allocation

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/can-allocate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "Timmy Turner",
    "avatar": "https://example.com/storage/default-avatar.png",
    "status": "on-line",
    "in_progress": 1,
    "completed": 0
  },
  {
    "id": 1,
    "name": "Caroline Bogan",
    "avatar": "https://example.com/storage/default-avatar.png",
    "status": "on-line",
    "in_progress": 1,
    "completed": 0
  },
  {
    "id": 1,
    "name": "Valerie Klein",
    "avatar": "https://example.com/storage/default-avatar.png",
    "status": "on-line",
    "in_progress": 1,
    "completed": 0
  }
]

List the users that can be allocated to a given task

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/can-allocate

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

List the users for re-allocation

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/can-re-allocate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "Timmy Turner",
    "avatar": "https://example.com/storage/default-avatar.png",
    "status": "on-line",
    "in_progress": 1,
    "completed": 0
  },
  {
    "id": 1,
    "name": "Caroline Bogan",
    "avatar": "https://example.com/storage/default-avatar.png",
    "status": "on-line",
    "in_progress": 1,
    "completed": 0
  },
  {
    "id": 1,
    "name": "Valerie Klein",
    "avatar": "https://example.com/storage/default-avatar.png",
    "status": "on-line",
    "in_progress": 1,
    "completed": 0
  }
]

List the users that can be re-allocated to a given task

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/can-re-allocate

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Checks if a task can be checked out or in

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/can-check-in-out \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "canCheckOut": "1",
  "canCheckIn": "",
  "checkOutNudge": "1"
}

Checks that the logged in user can check out or in a given task

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/can-check-in-out

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Override the check-in

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/project/task/1/workflow/1/command-check-in \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{
}

This endpoint allows you to override the check-in for a given task

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/project/task/{task_id}/workflow/{workflow_id}/command-check-in

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
task_id	GET	The ID of the task
workflow_id	GET	The ID of the workflow

Export Tasks

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "tasks"
}

This endpoint exports to a file the current filters Tasks in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
content_status	LIKE	String
content_owner	LIKE	String
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"1"}

URL encoded %7B%22instance_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/tasks/export/csv?filter=%7B%22instance_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Tasks

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/tasks/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "tasks"
}

This endpoint imports from a file the Tasks in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/tasks/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Teams

Teams Summary

A team is A 'global' or regional group of people. For example, where multiple vendors are required to deliver a workflow, this would be the vendor's company name and possibly a country or regional division. You can create and modify teams, but assignment is done from the user or task module. A team can be assigned to users and tasks.

Attributes

field	description
id	The ID of the Team
name	The unique name of the Team
label	The label of the Team
created_at	The date the Team was created
updated_at	The date the Team was last updated

Get all Teams

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/teams \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "forest-fire-fighter",
    "label": "Forest Fire Fighter",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "sports-book-writer",
    "label": "Sports Book Writer",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "medical-laboratory-technologist",
    "label": "Medical Laboratory Technologist",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Teams.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/teams

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Forest Fire Fighter"}

URL encoded %7B%22label%22%3A%22Forest+Fire+Fighter%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/teams?filter=%7B%22label%22%3A%22Forest+Fire+Fighter%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Teams with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/teams/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "professor",
      "label": "Professor",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "automotive-technician",
      "label": "Automotive Technician",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "mapping-technician",
      "label": "Mapping Technician",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/teams\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/teams\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/teams\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Teams with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/teams/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Professor"}

URL encoded %7B%22label%22%3A%22Professor%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/teams/paginate?filter=%7B%22label%22%3A%22Professor%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Team

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/teams \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Photographic Developer"
  }'

{
  "id": 4,
  "name": "photographic-developer",
  "label": "Photographic Developer",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Team.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/teams

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Team

Get a Specific Team

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/teams/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "printing-press-machine-operator",
  "label": "Printing Press Machine Operator",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Team.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/teams/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Team

Update a Specific Team

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/teams/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Deburring Machine Operator"
  }'

{
  "id": 4,
  "name": "deburring-machine-operator",
  "label": "Deburring Machine Operator",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Team.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/teams/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Team
label	PATCH	The label of the Team

Delete a Specific Team

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/teams/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "correctional-officer",
  "label": "Correctional Officer",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Team.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/teams/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Team

Export Teams

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/teams/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "teams"
}

This endpoint exports to a file the current filters Teams in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/teams/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Roofer"}

URL encoded %7B%22label%22%3A%22Roofer%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/teams/export/csv?filter=%7B%22label%22%3A%22Roofer%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Teams

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/teams/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "teams"
}

This endpoint imports from a file the Teams in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/teams/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Users

Users Summary

The users endpoint allows you to list, view and manage all the users. A user is an physical entity that can login using the application through the user interface.

Attributes

field	description
id	The ID of the User
first_name	The first name of the User
last_name	The last name of the User
username	The unique username used for login
email	The email address to communicate with the User
avatar	An image to represent the User
company	The company that the User is working for or on behalf of
department	The department in the company
line_manager	The Users line manager in the company
telephone	The telephone number of the User
mobile	The mobile telephone number of the User
accepted_terms	True or false if the User has accepted the terms
enabled	True or false if the User is enabled
api	True or false if the User is an API user
restricted	True or false if the User is restricted
role_id	The role id of the User
team_id	The team id of the User
created_at	The date the User was created
updated_at	The date the User was last updated

Get all Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "first_name": "Adelle",
    "last_name": "Goyette",
    "username": "adelle.goyette@wiegand.org",
    "email": "adelle.goyette@wiegand.org",
    "avatar": "https://example.com/storage/default-avatar.png",
    "company": "Cummings-Hessel",
    "department": "PR Manager",
    "line_manager": "Jedidiah Hodkiewicz PhD",
    "telephone": "1-613-561-3906",
    "mobile": "+19216329934",
    "accepted_terms": "1",
    "enabled": "1",
    "api": "",
    "restricted": "",
    "role_id": "31",
    "team_id": "13",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "first_name": "Esperanza",
    "last_name": "Padberg",
    "username": "esperanza.padberg@harvey.com",
    "email": "esperanza.padberg@harvey.com",
    "avatar": "https://example.com/storage/default-avatar.png",
    "company": "Schuppe Inc",
    "department": "Stonemason",
    "line_manager": "Mario Bins",
    "telephone": "(431) 671-4722",
    "mobile": "+1-693-837-5602",
    "accepted_terms": "1",
    "enabled": "1",
    "api": "",
    "restricted": "",
    "role_id": "52",
    "team_id": "11",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "first_name": "Erika",
    "last_name": "Hahn",
    "username": "erika.hahn@flatley.com",
    "email": "erika.hahn@flatley.com",
    "avatar": "https://example.com/storage/default-avatar.png",
    "company": "Roob PLC",
    "department": "Education Teacher",
    "line_manager": "Mr. Urban Farrell",
    "telephone": "+1-759-669-6661",
    "mobile": "+1.575.218.0279",
    "accepted_terms": "1",
    "enabled": "1",
    "api": "",
    "restricted": "",
    "role_id": "6",
    "team_id": "4",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Users.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users

Filtering

Parameter	Operator	Validation
id	=	Numeric
first_name	LIKE	String
last_name	LIKE	String
email	LIKE	String
username	LIKE	String
company	LIKE	String
accepted_terms	=	String
enabled	=	String
department	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"department":"PR Manager"}

URL encoded %7B%22department%22%3A%22PR+Manager%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/users?filter=%7B%22department%22%3A%22PR+Manager%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Users with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "first_name": "Brigitte",
      "last_name": "Watsica",
      "username": "brigitte.watsica@schaefer.info",
      "email": "brigitte.watsica@schaefer.info",
      "avatar": "https://example.com/storage/default-avatar.png",
      "company": "Brekke PLC",
      "department": "Recreational Therapist",
      "line_manager": "Buster Cummings",
      "telephone": "794.266.3621",
      "mobile": "1-750-939-4685",
      "accepted_terms": "0",
      "enabled": "1",
      "api": "",
      "restricted": "",
      "role_id": "29",
      "team_id": "8",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "first_name": "Aurore",
      "last_name": "Breitenberg",
      "username": "aurore.breitenberg@dubuque.com",
      "email": "aurore.breitenberg@dubuque.com",
      "avatar": "https://example.com/storage/default-avatar.png",
      "company": "Hammes, Schulist and Turcotte",
      "department": "Fire Investigator",
      "line_manager": "Kennith Purdy",
      "telephone": "370-624-6631",
      "mobile": "389.676.7251",
      "accepted_terms": "1",
      "enabled": "1",
      "api": "",
      "restricted": "",
      "role_id": "45",
      "team_id": "5",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "first_name": "Gia",
      "last_name": "Maggio",
      "username": "gia.maggio@sporer.org",
      "email": "gia.maggio@sporer.org",
      "avatar": "https://example.com/storage/default-avatar.png",
      "company": "Casper LLC",
      "department": "Opticians",
      "line_manager": "Margot Glover",
      "telephone": "641.336.9163",
      "mobile": "+1.494.447.9806",
      "accepted_terms": "0",
      "enabled": "1",
      "api": "",
      "restricted": "",
      "role_id": "33",
      "team_id": "1",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/users\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/users\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/users\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Users with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
first_name	LIKE	String
last_name	LIKE	String
email	LIKE	String
username	LIKE	String
company	LIKE	String
accepted_terms	=	String
enabled	=	String
department	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"department":"Recreational Therapist"}

URL encoded %7B%22department%22%3A%22Recreational+Therapist%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/users/paginate?filter=%7B%22department%22%3A%22Recreational+Therapist%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a User

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "first_name": "Jonas",
    "last_name": "Auer",
    "username": "jonas.auer@strosin.com",
    "email": "jonas.auer@strosin.com",
    "telephone": "+1 (395) 450-8900",
    "mobile": "+13578827737",
    "company": "Nicolas Inc",
    "department": "Pile-Driver Operator",
    "line_manager": "Antonina King Sr."
  }'

{
  "id": 4,
  "first_name": "Jonas",
  "last_name": "Auer",
  "username": "jonas.auer@strosin.com",
  "email": "jonas.auer@strosin.com",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Nicolas Inc",
  "department": "Pile-Driver Operator",
  "line_manager": "Antonina King Sr.",
  "telephone": "+1 (395) 450-8900",
  "mobile": "+13578827737",
  "accepted_terms": "0",
  "enabled": "1",
  "api": "",
  "restricted": "",
  "role_id": "54",
  "team_id": "11",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new User.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/users

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
first_name	POST	The first name of the User
last_name	POST	The last name of the User
username	POST	The unique username used for login
email	POST	The email address to communicate with the User
telephone	POST	The telephone number of the User
mobile	POST	The mobile telephone number of the User
company	POST	The company that the User is working for or on behalf of
department	POST	The department in the company
line_manager	POST	The Users line manager in the company

Get a Specific User

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "first_name": "Dustin",
  "last_name": "Collins",
  "username": "dustin.collins@muller.com",
  "email": "dustin.collins@muller.com",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Hudson Ltd",
  "department": "Landscape Artist",
  "line_manager": "Prof. Sidney Pollich",
  "telephone": "+15537736790",
  "mobile": "689.824.8712",
  "accepted_terms": "0",
  "enabled": "1",
  "api": "",
  "restricted": "",
  "role_id": "48",
  "team_id": "4",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific User.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User

Update a Specific User

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "first_name": "Nelson",
    "last_name": "Jaskolski",
    "username": "nelson.jaskolski@lakin.biz",
    "email": "nelson.jaskolski@lakin.biz",
    "telephone": "+1.885.272.4646",
    "mobile": "+1.935.568.2457",
    "company": "Shields, Schamberger and Gottlieb",
    "department": "Social and Human Service Assistant",
    "line_manager": "Iliana Mohr"
  }'

{
  "id": 4,
  "first_name": "Nelson",
  "last_name": "Jaskolski",
  "username": "nelson.jaskolski@lakin.biz",
  "email": "nelson.jaskolski@lakin.biz",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Shields, Schamberger and Gottlieb",
  "department": "Social and Human Service Assistant",
  "line_manager": "Iliana Mohr",
  "telephone": "+1.885.272.4646",
  "mobile": "+1.935.568.2457",
  "accepted_terms": "0",
  "enabled": "1",
  "api": "",
  "restricted": "",
  "role_id": "31",
  "team_id": "1",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific User.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User
first_name	PATCH	The first name of the User
last_name	PATCH	The last name of the User
username	PATCH	The unique username used for login
email	PATCH	The email address to communicate with the User
telephone	PATCH	The telephone number of the User
mobile	PATCH	The mobile telephone number of the User
company	PATCH	The company that the User is working for or on behalf of
department	PATCH	The department in the company
line_manager	PATCH	The Users line manager in the company

Delete a Specific User

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "first_name": "Theron",
  "last_name": "Block",
  "username": "theron.block@blanda.com",
  "email": "theron.block@blanda.com",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Cassin-Smitham",
  "department": "Administrative Services Manager",
  "line_manager": "Garrick Crona",
  "telephone": "(502) 597-7761",
  "mobile": "+1.570.206.4726",
  "accepted_terms": "0",
  "enabled": "1",
  "api": "",
  "restricted": "",
  "role_id": "37",
  "team_id": "14",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific User.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User

Lists all the available roles for Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/roles \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 3,
    "label": "Auer Group"
  },
  {
    "id": 1,
    "label": "Stehr-Schaefer"
  },
  {
    "id": 2,
    "label": "Stroman Ltd"
  }
]

This endpoint retrieves all roles that can be assigned to users ordered by label. You can also use the roles endpoint however if you do not have access to that endpoint this is a alternative for the user module See Roles for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/roles

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Lists all the available teams for Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/teams \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Aircraft Cargo Handling Supervisor"
  },
  {
    "id": 3,
    "label": "Alteration Tailor"
  },
  {
    "id": 2,
    "label": "Central Office Operator"
  }
]

This endpoint retrieves all teams that can be assigned to users ordered by label. You can also use the teams endpoint however if you do not have access to that endpoint this is a alternative for the user module See Teams for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/teams

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Lists all the available groups for Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 3,
    "label": "Biochemist or Biophysicist"
  },
  {
    "id": 2,
    "label": "Chemistry Teacher"
  },
  {
    "id": 1,
    "label": "Clinical School Psychologist"
  }
]

This endpoint retrieves all groups that can be assigned to users ordered by label. You can also use the groups endpoint however if you do not have access to that endpoint this is a alternative for the user module See Groups for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Lists all the available scenarios for Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/scenarios \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 5,
    "label": "Client A and B"
  },
  {
    "id": 6,
    "label": "Client C and D"
  }
]

This endpoint retrieves all scenarios that can be assigned to users ordered by label. You can also use the scenarios endpoint however if you do not have access to that endpoint this is a alternative for the user module See Scenarios for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/scenarios

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Toggles the Users status

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/toggle \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "first_name": "Meredith",
  "last_name": "Farrell",
  "username": "meredith.farrell@herzog.org",
  "email": "meredith.farrell@herzog.org",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Hegmann-Littel",
  "department": "Administrative Law Judge",
  "line_manager": "Nigel Corwin",
  "telephone": "401.602.1753",
  "mobile": "287.308.5407 x3794",
  "accepted_terms": 0,
  "enabled": 0,
  "api": "",
  "role_id": 2,
  "team_id": 15,
  "restricted": 0,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint toggles the users enabled status. If the users enabled status is TRUE (1) then it will toggle to FALSE (0) and vice versa.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/toggle

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User

Toggles the Users restriction

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/restrict \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "first_name": "Meredith",
  "last_name": "Farrell",
  "username": "meredith.farrell@herzog.org",
  "email": "meredith.farrell@herzog.org",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Hegmann-Littel",
  "department": "Administrative Law Judge",
  "line_manager": "Nigel Corwin",
  "telephone": "401.602.1753",
  "mobile": "287.308.5407 x3794",
  "accepted_terms": 0,
  "enabled": 0,
  "api": "",
  "role_id": 2,
  "team_id": 15,
  "restricted": 0,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint toggles the users restriction status. If the users restricted status is TRUE (1) then it will toggle to FALSE (0) and vice versa.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/restrict

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User

Lists all default groups linked to a given User through scenarios

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "groups": [
    1,
    2,
    3,
    5,
    9
  ]
}

This endpoint retrieves all groups id's that have been assigned to a given user. For more information on groups See Groups

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User

Lists all scenarios linked to a given User

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/scenarios \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "scenarios": [
    1,
    2,
    3
  ]
}

This endpoint retrieves all scenario id's that have been assigned to a given user. For more information on scenarios See Scenarios

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/scenarios

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User

Lists all the available instance groups for Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/instance-groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 4,
    "label": "Abbott Ltd"
  },
  {
    "id": 5,
    "label": "Greenfelder Group"
  },
  {
    "id": 2,
    "label": "Internal"
  },
  {
    "id": 3,
    "label": "Nicolas, Torp and Kuvalis"
  },
  {
    "id": 1,
    "label": "Workflow Centre"
  }
]

This endpoint retrieves all instance groups that can be assigned to users ordered by label. You can also use the instance groups endpoint however if you do not have access to that endpoint this is a alternative for the user module See Instance Groups for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/instance-groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Updates the scenarios linked to a given User

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/scenarios \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "scenarios" {
      "0": 1,
      "1": 2,
      "2": 3
    } [
      1,
      2,
      3
    ]
  }'

[ 
  1,
  2,
  3
]

This endpoint updates the scenario id's linked to a given user, the scenarios must be complete as the endpoint will remove any ID's not in the list. For more information on scenarios See Scenarios

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/scenarios

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User
scenarios	PATCH	An array of scenarios added to the User

Updates the groups linked to a given User through scenarios

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "groups" {
      "0": 1,
      "1": 2,
      "2": 3,
      "3": 5,
      "4": 9
    } [
      1,
      2,
      3,
      5,
      9
    ]
  }'

[ 
  1,
  2,
  3,
  5,
  9
]

This endpoint updates the group id's linked to a given user, the groups must be complete as the endpoint will remove any ID's not in the list. For more information on groups See Groups

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User
groups	PATCH	An array of groups added to the User

Resets a User profile image

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/reset-profile-image \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "first_name": "Meredith",
  "last_name": "Farrell",
  "username": "meredith.farrell@herzog.org",
  "email": "meredith.farrell@herzog.org",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Hegmann-Littel",
  "department": "Administrative Law Judge",
  "line_manager": "Nigel Corwin",
  "telephone": "401.602.1753",
  "mobile": "287.308.5407 x3794",
  "accepted_terms": 0,
  "enabled": 0,
  "api": "",
  "role_id": 2,
  "team_id": 15,
  "restricted": 0,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint removes a users avatar image and replaces it with the default avatar

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/reset-profile-image

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User

Create Dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/create/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "can_create": 
}

This endpoint checks if the User has any Dependencies on other objects that will prevent it from being able to be created

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/create/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Updates a User profile image

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/update-profile-image \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "imageData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgANvL ... fwnQxYVeu3ASUVORK5CYII="
  }'

{
  "id": 4,
  "first_name": "Meredith",
  "last_name": "Farrell",
  "username": "meredith.farrell@herzog.org",
  "email": "meredith.farrell@herzog.org",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Hegmann-Littel",
  "department": "Administrative Law Judge",
  "line_manager": "Nigel Corwin",
  "telephone": "401.602.1753",
  "mobile": "287.308.5407 x3794",
  "accepted_terms": 0,
  "enabled": 0,
  "api": "",
  "role_id": 2,
  "team_id": 15,
  "restricted": 0,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint updates a users avatar image and replaces it with the provided image

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/update-profile-image

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User
imageData	PATCH	The image data base64 encoded

Lists all instance groups linked to a given User

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/instance-groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "groups": [
    1,
    2,
    3,
    5,
    9
  ]
}

This endpoint retrieves all instance groups id's that have been assigned to a given user. For more information on instance groups See Instance Groups

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/instance-groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User

Updates the instance groups linked to a given User

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/1/instance-groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "groups" {
      "0": 1,
      "1": 2,
      "2": 3,
      "3": 5,
      "4": 9
    } [
      1,
      2,
      3,
      5,
      9
    ]
  }'

[ 
  1,
  2,
  3,
  5,
  9
]

This endpoint updates the instance group id's linked to a given user, the instance groups must be complete as the endpoint will remove any ID's not in the list. For more information on instance groups See Instance Groups

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/{id}/instance-groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User
groups	PATCH	An array of groups added to the User

Export Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "users"
}

This endpoint exports to a file the current filters Users in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
first_name	LIKE	String
last_name	LIKE	String
email	LIKE	String
username	LIKE	String
company	LIKE	String
accepted_terms	=	String
enabled	=	String
department	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"department":"Physical Therapist"}

URL encoded %7B%22department%22%3A%22Physical+Therapist%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/users/export/csv?filter=%7B%22department%22%3A%22Physical+Therapist%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Users

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/users/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "users"
}

This endpoint imports from a file the Users in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/users/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

User Directories

User Directories Summary

The users endpoint allows you to list, view and manage all the users. A user is an physical entity that can login using the application through the user interface.

Attributes

field	description
id	The ID of the User Directory
first_name	The first name of the User Directory
last_name	The last name of the User Directory
username	The unique username used for login
email	The email address to communicate with the User Directory
avatar	An image to represent the User Directory
company	The company that the User Directory is working for or on behalf of
department	The department in the company
line_manager	The User Directories line manager in the company
telephone	The telephone number of the User Directory
mobile	The mobile telephone number of the User Directory
accepted_terms	True or false if the User Directory has accepted the terms
enabled	True or false if the User Directory is enabled
api	True or false if the User Directory is an API user
restricted	True or false if the User Directory is restricted
role_id	The role id of the User Directory
team_id	The team id of the User Directory
created_at	The date the User Directory was created
updated_at	The date the User Directory was last updated

Get all Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "first_name": "Lloyd",
    "last_name": "Purdy",
    "username": "lloyd.purdy@harber.info",
    "email": "lloyd.purdy@harber.info",
    "avatar": "https://example.com/storage/default-avatar.png",
    "company": "Klocko, Bergstrom and Kerluke",
    "department": "Copy Machine Operator",
    "line_manager": "Dr. Gilbert Hettinger",
    "telephone": "964-778-2596",
    "mobile": "591.204.3980",
    "accepted_terms": "1",
    "enabled": "1",
    "api": "",
    "restricted": "",
    "role_id": "19",
    "team_id": "8",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "first_name": "Sherman",
    "last_name": "Kerluke",
    "username": "sherman.kerluke@denesik.com",
    "email": "sherman.kerluke@denesik.com",
    "avatar": "https://example.com/storage/default-avatar.png",
    "company": "Ebert-Terry",
    "department": "Sociology Teacher",
    "line_manager": "Mr. Bill Gorczany",
    "telephone": "(469) 685-0768",
    "mobile": "+1.757.637.0640",
    "accepted_terms": "0",
    "enabled": "1",
    "api": "",
    "restricted": "",
    "role_id": "25",
    "team_id": "3",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "first_name": "Trudie",
    "last_name": "Harber",
    "username": "trudie.harber@dare.com",
    "email": "trudie.harber@dare.com",
    "avatar": "https://example.com/storage/default-avatar.png",
    "company": "Hartmann, Schultz and Kohler",
    "department": "Surveying and Mapping Technician",
    "line_manager": "Prof. Vita Rice DDS",
    "telephone": "+1-717-626-5140",
    "mobile": "1-205-209-7277",
    "accepted_terms": "0",
    "enabled": "1",
    "api": "",
    "restricted": "",
    "role_id": "47",
    "team_id": "11",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Users.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory

Filtering

Parameter	Operator	Validation
id	=	Numeric
first_name	LIKE	String
last_name	LIKE	String
email	LIKE	String
username	LIKE	String
company	LIKE	String
accepted_terms	=	String
enabled	=	String
department	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"department":"Copy Machine Operator"}

URL encoded %7B%22department%22%3A%22Copy+Machine+Operator%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/user-directory?filter=%7B%22department%22%3A%22Copy+Machine+Operator%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Users with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "first_name": "Lavada",
      "last_name": "Rice",
      "username": "lavada.rice@murphy.info",
      "email": "lavada.rice@murphy.info",
      "avatar": "https://example.com/storage/default-avatar.png",
      "company": "Heathcote Inc",
      "department": "Nursing Instructor",
      "line_manager": "Chad Watsica",
      "telephone": "550-214-2865",
      "mobile": "+1 (595) 515-6615",
      "accepted_terms": "1",
      "enabled": "1",
      "api": "",
      "restricted": "",
      "role_id": "5",
      "team_id": "10",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "first_name": "Edmund",
      "last_name": "Franecki",
      "username": "edmund.franecki@feeney.com",
      "email": "edmund.franecki@feeney.com",
      "avatar": "https://example.com/storage/default-avatar.png",
      "company": "Stiedemann LLC",
      "department": "Explosives Expert",
      "line_manager": "Javon Kris",
      "telephone": "763-696-3520",
      "mobile": "1-982-848-9125",
      "accepted_terms": "0",
      "enabled": "1",
      "api": "",
      "restricted": "",
      "role_id": "11",
      "team_id": "6",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "first_name": "Ivy",
      "last_name": "Marvin",
      "username": "ivy.marvin@feeney.com",
      "email": "ivy.marvin@feeney.com",
      "avatar": "https://example.com/storage/default-avatar.png",
      "company": "Becker-Hermann",
      "department": "Educational Psychologist",
      "line_manager": "Ariane O'Reilly",
      "telephone": "+1-287-414-8074",
      "mobile": "819-824-5960",
      "accepted_terms": "0",
      "enabled": "1",
      "api": "",
      "restricted": "",
      "role_id": "26",
      "team_id": "11",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/user-directory\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/user-directory\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/user-directory\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Users with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
first_name	LIKE	String
last_name	LIKE	String
email	LIKE	String
username	LIKE	String
company	LIKE	String
accepted_terms	=	String
enabled	=	String
department	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"department":"Nursing Instructor"}

URL encoded %7B%22department%22%3A%22Nursing+Instructor%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/paginate?filter=%7B%22department%22%3A%22Nursing+Instructor%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a User

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{
  "id": 4,
  "first_name": "Ron",
  "last_name": "Brekke",
  "username": "ron.brekke@blick.com",
  "email": "ron.brekke@blick.com",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Rau Inc",
  "department": "Forging Machine Setter",
  "line_manager": "Dr. Cleora Murazik Jr.",
  "telephone": "1-264-792-0395",
  "mobile": "249.694.2376",
  "accepted_terms": "1",
  "enabled": "1",
  "api": "",
  "restricted": "",
  "role_id": "34",
  "team_id": "9",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new User.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get a Specific User

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "first_name": "Anne",
  "last_name": "O'Conner",
  "username": "anne.oconner@waters.org",
  "email": "anne.oconner@waters.org",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Hyatt, Hodkiewicz and Emmerich",
  "department": "Production Planning",
  "line_manager": "Prof. Jayson Macejkovic DDS",
  "telephone": "+1 (626) 488-3589",
  "mobile": "+14093887130",
  "accepted_terms": "0",
  "enabled": "1",
  "api": "",
  "restricted": "",
  "role_id": "15",
  "team_id": "9",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific User.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User Directory

Update a Specific User

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{
  "id": 4,
  "first_name": "Lila",
  "last_name": "Ruecker",
  "username": "lila.ruecker@kemmer.net",
  "email": "lila.ruecker@kemmer.net",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Swaniawski-Okuneva",
  "department": "Welding Machine Tender",
  "line_manager": "Ora Ledner",
  "telephone": "+1-437-891-0849",
  "mobile": "(826) 260-4983",
  "accepted_terms": "1",
  "enabled": "1",
  "api": "",
  "restricted": "",
  "role_id": "54",
  "team_id": "2",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific User.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User Directory

Delete a Specific User

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "first_name": "Bill",
  "last_name": "Gerhold",
  "username": "bill.gerhold@rempel.org",
  "email": "bill.gerhold@rempel.org",
  "avatar": "https://example.com/storage/default-avatar.png",
  "company": "Wintheiser Ltd",
  "department": "Computer Science Teacher",
  "line_manager": "Oliver Wunsch",
  "telephone": "1-670-912-1654",
  "mobile": "1-849-239-4583",
  "accepted_terms": "1",
  "enabled": "1",
  "api": "",
  "restricted": "",
  "role_id": "2",
  "team_id": "7",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific User.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User Directory

Lists all the available groups for Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 3,
    "label": "Biochemist or Biophysicist"
  },
  {
    "id": 2,
    "label": "Chemistry Teacher"
  },
  {
    "id": 1,
    "label": "Clinical School Psychologist"
  }
]

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Lists all default groups linked to a given User through scenarios

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/1/groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "groups": [
    1,
    2,
    3,
    5,
    9
  ]
}

This endpoint retrieves all groups id's that have been assigned to a given user. For more information on groups See Groups

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/{id}/groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User Directory

Lists all the available instance groups for Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/instance-groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 4,
    "label": "Abbott Ltd"
  },
  {
    "id": 5,
    "label": "Greenfelder Group"
  },
  {
    "id": 2,
    "label": "Internal"
  },
  {
    "id": 3,
    "label": "Nicolas, Torp and Kuvalis"
  },
  {
    "id": 1,
    "label": "Workflow Centre"
  }
]

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/instance-groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Lists all instance groups linked to a given User

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/1/instance-groups \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "groups": [
    1,
    2,
    3,
    5,
    9
  ]
}

This endpoint retrieves all instance groups id's that have been assigned to a given user. For more information on instance groups See Instance Groups

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/{id}/instance-groups

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the User Directory

Export Users

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "users"
}

This endpoint exports to a file the current filters Users in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
first_name	LIKE	String
last_name	LIKE	String
email	LIKE	String
username	LIKE	String
company	LIKE	String
accepted_terms	=	String
enabled	=	String
department	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"department":"Building Cleaning Worker"}

URL encoded %7B%22department%22%3A%22Building+Cleaning+Worker%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/export/csv?filter=%7B%22department%22%3A%22Building+Cleaning+Worker%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Users

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/user-directory/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "users"
}

This endpoint imports from a file the Users in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/user-directory/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Workflows

Workflows Summary

The workflows endpoint allows you to list, view and manage all the workflows for an instance. Each Component is made up of a group of workflows.  Each workflow is made up of a series of tasks. This could equate to a list of actions that contribute to the completion of categories.

Attributes

field	description
id	The ID of the Workflow
name	The unique name of the Workflow
label	The label of the Workflow
description	The description of the Workflow
data	The data explaining how the Workflow should be executed
in_scope	he scope of the Workflow
workflow_type_id	The type of the Workflow
instance_id	The instance the Workflow is linked to
task_id	The ID of the task
component_id	The unique ID for the component
created_at	The date the Workflow was created
updated_at	The date the Workflow was last updated

Get all Workflows

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "future-proofed-well-modulated-workforce",
    "label": "Future-proofed well-modulated workforce",
    "description": "Future-proofed well-modulated workforce",
    "data": "Some workflow data...",
    "in_scope": "1",
    "workflow_type_id": "1",
    "instance_id": "1",
    "task_id": "",
    "component_id": "",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "triple-buffered-system-worthy-monitoring",
    "label": "Triple-buffered system-worthy monitoring",
    "description": "Triple-buffered system-worthy monitoring",
    "data": "Some workflow data...",
    "in_scope": "0",
    "workflow_type_id": "1",
    "instance_id": "1",
    "task_id": "",
    "component_id": "",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "balanced-transitional-capacity",
    "label": "Balanced transitional capacity",
    "description": "Balanced transitional capacity",
    "data": "Some workflow data...",
    "in_scope": "0",
    "workflow_type_id": "1",
    "instance_id": "1",
    "task_id": "",
    "component_id": "",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Workflows.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"1"}

URL encoded %7B%22instance_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/workflows?filter=%7B%22instance_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Workflows with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "customizable-mobile-algorithm",
      "label": "Customizable mobile algorithm",
      "description": "Customizable mobile algorithm",
      "data": "Some workflow data...",
      "in_scope": "1",
      "workflow_type_id": "1",
      "instance_id": "1",
      "task_id": "",
      "component_id": "",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "advanced-value-added-help-desk",
      "label": "Advanced value-added help-desk",
      "description": "Advanced value-added help-desk",
      "data": "Some workflow data...",
      "in_scope": "0",
      "workflow_type_id": "1",
      "instance_id": "1",
      "task_id": "",
      "component_id": "",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "customer-focused-exuding-matrices",
      "label": "Customer-focused exuding matrices",
      "description": "Customer-focused exuding matrices",
      "data": "Some workflow data...",
      "in_scope": "1",
      "workflow_type_id": "1",
      "instance_id": "1",
      "task_id": "",
      "component_id": "",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/workflows\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/workflows\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/workflows\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Workflows with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"1"}

URL encoded %7B%22instance_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/workflows/paginate?filter=%7B%22instance_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Workflow

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Right-sized multimedia intranet",
    "description": "Right-sized multimedia intranet",
    "workflow_type_id": "1",
    "instance_id": "1",
    "in_scope": "0"
  }'

{
  "id": 4,
  "name": "right-sized-multimedia-intranet",
  "label": "Right-sized multimedia intranet",
  "description": "Right-sized multimedia intranet",
  "data": "Some workflow data...",
  "in_scope": "0",
  "workflow_type_id": "1",
  "instance_id": "1",
  "task_id": "",
  "component_id": "",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Workflow.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Workflow
description	POST	The description of the Workflow
workflow_type_id	POST	The type of the Workflow
instance_id	POST	The instance the Workflow is linked to
in_scope	POST	he scope of the Workflow

Get a Specific Workflow

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "open-architected-demand-driven-parallelism",
  "label": "Open-architected demand-driven parallelism",
  "description": "Open-architected demand-driven parallelism",
  "data": "Some workflow data...",
  "in_scope": "1",
  "workflow_type_id": "1",
  "instance_id": "1",
  "task_id": "",
  "component_id": "",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Workflow.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

Update a Specific Workflow

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "De-engineered context-sensitive attitude",
    "description": "De-engineered context-sensitive attitude",
    "workflow_type_id": "1",
    "instance_id": "1",
    "in_scope": "0"
  }'

{
  "id": 4,
  "name": "de-engineered-context-sensitive-attitude",
  "label": "De-engineered context-sensitive attitude",
  "description": "De-engineered context-sensitive attitude",
  "data": "Some workflow data...",
  "in_scope": "0",
  "workflow_type_id": "1",
  "instance_id": "1",
  "task_id": "",
  "component_id": "",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Workflow.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
label	PATCH	The label of the Workflow
description	PATCH	The description of the Workflow
workflow_type_id	PATCH	The type of the Workflow
instance_id	PATCH	The instance the Workflow is linked to
in_scope	PATCH	he scope of the Workflow

Delete a Specific Workflow

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "switchable-background-workforce",
  "label": "Switchable background workforce",
  "description": "Switchable background workforce",
  "data": "Some workflow data...",
  "in_scope": "0",
  "workflow_type_id": "1",
  "instance_id": "1",
  "task_id": "",
  "component_id": "",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Workflow.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

Lists all the available tasks for Workflows

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/tasks/available \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 3,
    "label": "Advanced dedicated benchmark"
  },
  {
    "id": 2,
    "label": "Cross-platform discrete contingency"
  },
  {
    "id": 1,
    "label": "Front-line client-server productivity"
  }
]

This endpoint retrieves all tasks that can be assigned to workflow ordered by label. You can also use the tasks endpoint however if you do not have access to that endpoint this is a alternative for the workflow module See Tasks for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/tasks/available

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

Lists all the available workflow types for Workflows

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/types \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Advertising Sales Agent"
  },
  {
    "id": 3,
    "label": "Agricultural Crop Farm Manager"
  },
  {
    "id": 2,
    "label": "Agricultural Crop Farm Manager"
  }
]

This endpoint retrieves all workflow types that can be assigned to workflows ordered by label. You can also use the workflow types endpoint however if you do not have access to that endpoint this is a alternative for the workflow module See Workflow Types for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/types

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Toggle the scope for a Workflow

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/toggle \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "visionary-background-benchmark",
  "label": "Visionary background benchmark",
  "description": "Visionary background benchmark",
  "data": "Some workflow data...",
  "instance_id": 1,
  "in_scope": 0,
  "workflow_type_id": 1,
  "created_at": "2019-04-08 10:09:00",
  "updated_at": "2019-04-08 10:09:00"
}

This endpoint toggles the scope for a Workflow

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/toggle

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

Lists all the available components for Workflows

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/components/available \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 3,
    "label": "Business-focused multi-tasking matrix"
  },
  {
    "id": 1,
    "label": "Pre-emptive reciprocal synergy"
  },
  {
    "id": 2,
    "label": "Stand-alone incremental service-desk"
  }
]

This endpoint retrieves all components that can be assigned to workflow ordered by label. You can also use the components endpoint however if you do not have access to that endpoint this is a alternative for the workflow module See Components for more information

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/components/available

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

Project view workflows

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/project/1 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "Multi-channelled reciprocal matrix",
    "progress": "0",
    "start_time": "na",
    "end_time": "na",
    "status": "ready",
    "type": "workflows",
    "loads": "tasks",
    "from": 1
  },
  {
    "id": 2,
    "name": "Fundamental full-range extranet",
    "progress": "0",
    "start_time": "na",
    "end_time": "na",
    "status": "dependency",
    "type": "workflows",
    "loads": "tasks",
    "from": 1
  },
  {
    "id": 3,
    "name": "Re-engineered maximized concept",
    "progress": "0",
    "start_time": "na",
    "end_time": "na",
    "status": "dependency",
    "type": "workflows",
    "loads": "tasks",
    "from": 1
  }
]

This endpoint gets the workflows linked through components formatted for the project view

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/project/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

Lists all tasks linked to a given Workflow

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/tasks \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Integrated asynchronous productivity",
    "team_id": 3,
    "group_id": 4,
    "estimate": 3480,
    "time": "00:58:00",
    "team_name": "Alteration Tailor",
    "group_name": "Electric Meter Installer",
    "days": 0,
    "hours": 0,
    "mins": 3480,
    "secs": 0
  },
  {
    "id": 2,
    "label": "Reactive directional interface",
    "team_id": 5,
    "group_id": 1,
    "estimate": 4740,
    "time": "01:19:00",
    "team_name": "Central Office Operator",
    "group_name": "Command and Control",
    "days": 0,
    "hours": 3600,
    "mins": 1140,
    "secs": 0
  },
  {
    "id": 3,
    "label": "Optimized systematic capacity",
    "team_id": 8,
    "group_id": 1,
    "estimate": 2280,
    "time": "00:38:00",
    "team_name": "Aircraft Cargo Handling Supervisor",
    "group_name": "Command and Control",
    "days": 0,
    "hours": 0,
    "mins": 2280,
    "secs": 0
  }
]

This endpoint retrieves all task that have been assigned to a given workflow. For more information on tasks See Tasks

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/tasks

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

Updates the tasks linked to a given Workflow through scenarios

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/tasks \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "tasks" {
      "0": 1,
      "1": 2,
      "2": 3
    } [
      1,
      2,
      3
    ]
  }'

[
  {
    "id": 1,
    "label": "Integrated asynchronous productivity",
    "team_id": 3,
    "group_id": 4,
    "estimate": 3480,
    "time": "00:58:00",
    "team_name": "Alteration Tailor",
    "group_name": "Electric Meter Installer",
    "days": 0,
    "hours": 0,
    "mins": 3480,
    "secs": 0
  },
  {
    "id": 2,
    "label": "Reactive directional interface",
    "team_id": 5,
    "group_id": 1,
    "estimate": 4740,
    "time": "01:19:00",
    "team_name": "Central Office Operator",
    "group_name": "Command and Control",
    "days": 0,
    "hours": 3600,
    "mins": 1140,
    "secs": 0
  },
  {
    "id": 3,
    "label": "Optimized systematic capacity",
    "team_id": 8,
    "group_id": 1,
    "estimate": 2280,
    "time": "00:38:00",
    "team_name": "Aircraft Cargo Handling Supervisor",
    "group_name": "Command and Control",
    "days": 0,
    "hours": 0,
    "mins": 2280,
    "secs": 0
  },
  {
    "id": 4,
    "label": "Realigned context-sensitive interface",
    "team_id": 3,
    "group_id": 1,
    "estimate": 1860,
    "time": "00:31:00",
    "team_name": "Alteration Tailor",
    "group_name": "Command and Control",
    "days": 0,
    "hours": 0,
    "mins": 1860,
    "secs": 0
  }
]

This endpoint updates the task id's linked to a given workflow, the tasks must be complete as the endpoint will remove any ID's not in the list. For more information on tasks See Tasks

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/tasks

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
tasks	PATCH	An array of tasks added to the Workflow

Adds a task to a given Workflow

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/tasks/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

[
  {
    "id": 2,
    "label": "Enterprise-wide multimedia solution",
    "team_name": "Workflow Centre Team",
    "group_name": "Command and Control",
    "time": "01:01:01",
    "total_estimate": "04:12:03"
  },
  {
    "id": 3,
    "label": "Visionary non-volatile success",
    "team_name": "Workflow Centre Team",
    "group_name": "Command and Control",
    "time": "02:01:01",
    "total_estimate": "04:12:03"
  },
  {
    "id": 4,
    "label": "Robust fault-tolerant complexity",
    "team_name": "Workflow Centre Team",
    "group_name": "Command and Control",
    "time": "01:10:01",
    "total_estimate": "04:12:03"
  }
]

This endpoint adds a new task to a given Workflow. For more information on tasks See Tasks

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/tasks/{task_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
task_id	GET	The ID of the task

Lists all components linked to a given Workflow

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/components \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Optimized upward-trending solution",
    "category_id": 31,
    "category_name": "De-engineered systemic encoding",
    "category_sequence": 30
  },
  {
    "id": 9,
    "label": "Adaptive global access",
    "category_id": 3,
    "category_name": "Right-sized high-level access",
    "category_sequence": 2
  },
  {
    "id": 11,
    "label": "Cloned methodical initiative",
    "category_id": 16,
    "category_name": "Focused mission-critical migration",
    "category_sequence": 15
  }
]

This endpoint retrieves all components that have been assigned to a given workflow. For more information on components See Components

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/components

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

Removes a task from a given Workflow

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/tasks/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 2,
    "label": "Enterprise-wide multimedia solution",
    "team_name": "Workflow Centre Team",
    "group_name": "Command and Control",
    "time": "01:01:01",
    "total_estimate": "03:02:02"
  },
  {
    "id": 3,
    "label": "Visionary non-volatile success",
    "team_name": "Workflow Centre Team",
    "group_name": "Command and Control",
    "time": "02:01:01",
    "total_estimate": "03:02:02"
  }
]

This endpoint removes a new task from a given Workflow. For more information on tasks See Tasks

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/tasks/{task_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
task_id	GET	The ID of the task

Create Dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/create/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "can_create": 
}

This endpoint checks if the Workflow has any Dependencies on other objects that will prevent it from being able to be created

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/create/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Adds a component to a given Workflow

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/components/3 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

[
  {
    "id": 1,
    "label": "Automated multimedia solution",
    "category_name": "Extended exuding functionalities"
  },
  {
    "id": 3,
    "label": "Synergized multi-state alliance",
    "category_name": "Triple-buffered cohesive toolset"
  },
  {
    "id": 2,
    "label": "Team-oriented regional capacity",
    "category_name": "Secured modular intranet"
  }
]

This endpoint adds a new components to a given Workflow. For more information on tasks See Components

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/components/{component_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
component_id	GET	The unique ID for the component

Overrides the estimate task time

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/tasks/2/override \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "estimate": 4201
  }'

[
  {
    "id": 2,
    "label": "Enterprise-wide multimedia solution",
    "team_name": "Workflow Centre Team",
    "group_name": "Command and Control",
    "time": "01:10:01",
    "total_estimate": "03:11:02"
  },
  {
    "id": 3,
    "label": "Visionary non-volatile success",
    "team_name": "Workflow Centre Team",
    "group_name": "Command and Control",
    "time": "02:01:01",
    "total_estimate": "03:11:02"
  }
]

This endpoint overrides the estimate task time when linked to a Workflow

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/tasks/{task_id}/override

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
task_id	GET	The ID of the task
estimate	PATCH	An integer of the seconds to override

Removes a component to a given Workflow

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/components/3 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "label": "Automated multimedia solution",
    "category_name": "Extended exuding functionalities"
  },
  {
    "id": 2,
    "label": "Team-oriented regional capacity",
    "category_name": "Secured modular intranet"
  }
]

This endpoint removes a new components to a given Workflow. For more information on tasks See Components

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/components/{component_id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
component_id	GET	The unique ID for the component

Sequences up tasks linked to a given Workflow

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/tasks/2/sequence/up \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{ 
  "sequence": 0
}

This endpoint updates the sequences up of linked task of a given Workflow

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/tasks/{task_id}/sequence/up

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
task_id	GET	The ID of the task

Sequences down tasks linked to a given Workflow

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/tasks/1/sequence/down \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json'

{ 
  "sequence": 2
}

This endpoint updates the sequences down of linked tasks of a given Workflow

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/tasks/{task_id}/sequence/down

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
task_id	GET	The ID of the task

List dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/dependencies/available \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 5,
    "label": "Compatible stable parallelism"
  },
  {
    "id": 6,
    "label": "Persevering multimedia website"
  }
]

This endpoint lists the possible dependencies for Workflows

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/dependencies/available

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

View dependencies

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{ 
  "dependencies": [
    1,
    2,
    3
  ]
}

This endpoint allows you to view the dependencies for the given Workflow

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow

Update dependencies

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/1/dependencies \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "dependencies" {
      "0": 1,
      "1": 2,
      "2": 3
    } [
      1,
      2,
      3
    ]
  }'

[ 
  1,
  2,
  3
]

This endpoint allows you to update the dependencies for the given Workflow

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/{id}/dependencies

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow
dependencies	PATCH	An array of dependencies

Export Workflows

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "workflows"
}

This endpoint exports to a file the current filters Workflows in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String
instance_id	=	Numeric

The filter string is a URL encoded JSON string.

JSON string {"instance_id":"1"}

URL encoded %7B%22instance_id%22%3A%221%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/workflows/export/csv?filter=%7B%22instance_id%22%3A%221%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Workflows

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflows/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "workflows"
}

This endpoint imports from a file the Workflows in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflows/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Workflow Types

Workflow Types Summary

The workflow types endpoint allows you to list, view and manage all the workflow types for a workflow. A workflow type is an additional description of the type of Workflow. Each Component is made up of a group of workflows.  Each workflow is made up of a series of tasks. This could equate to a list of server recoveries or server fail-overs for each component.

Attributes

field	description
id	The ID of the Workflow Types
name	The unique name of the Workflow Types
label	The label of the Workflow Types
created_at	The date the Workflow Types was created
updated_at	The date the Workflow Types was last updated

Get all Workflow Types

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

[
  {
    "id": 1,
    "name": "h-r-manager",
    "label": "HR Manager",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 2,
    "name": "home-appliance-repairer",
    "label": "Home Appliance Repairer",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  },
  {
    "id": 3,
    "name": "therapist",
    "label": "Therapist",
    "created_at": "2021-04-05 10:09:30",
    "updated_at": "2021-04-05 10:09:30"
  }
]

This endpoint retrieves all Workflow Types.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflow-types

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"HR Manager"}

URL encoded %7B%22label%22%3A%22HR+Manager%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types?filter=%7B%22label%22%3A%22HR+Manager%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Get all Workflow Types with pagination

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types/paginate \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current_page": 1,
  "data":   [
    {
      "id": 1,
      "name": "custom-tailor",
      "label": "Custom Tailor",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 2,
      "name": "medical-records-technician",
      "label": "Medical Records Technician",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    },
    {
      "id": 3,
      "name": "office-and-administrative-support-worker",
      "label": "Office and Administrative Support Worker",
      "created_at": "2021-04-05 10:09:30",
      "updated_at": "2021-04-05 10:09:30"
    }
  ],
  "first_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/workflow-types\/paginate?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/workflow-types\/paginate?page=1",
  "next_page_url": null,
  "path": "https:\/\/api.wfc.rest\/api\/v2\/acme-co\/client-a\/workflow-types\/paginate",
  "per_page": 50,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

This endpoint retrieves all Workflow Types with pagination.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflow-types/paginate

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Custom Tailor"}

URL encoded %7B%22label%22%3A%22Custom+Tailor%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types/paginate?filter=%7B%22label%22%3A%22Custom+Tailor%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant

Create a Workflow Type

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Sales Person"
  }'

{
  "id": 4,
  "name": "sales-person",
  "label": "Sales Person",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint creates a new Workflow Type.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflow-types

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
label	POST	The label of the Workflow Types

Get a Specific Workflow Type

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "production-worker",
  "label": "Production Worker",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint retrieves a specific Workflow Type.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflow-types/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow Types

Update a Specific Workflow Type

curl --request PATCH \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "label": "Sawing Machine Tool Setter"
  }'

{
  "id": 4,
  "name": "sawing-machine-tool-setter",
  "label": "Sawing Machine Tool Setter",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint updates a specific Workflow Type.

HTTP Request

PATCH https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflow-types/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow Types
label	PATCH	The label of the Workflow Types

Delete a Specific Workflow Type

curl --request DELETE \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types/4 \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "id": 4,
  "name": "patrol-officer",
  "label": "Patrol Officer",
  "created_at": "2021-04-05 10:09:30",
  "updated_at": "2021-04-05 10:09:30"
}

This endpoint deletes a specific Workflow Type.

HTTP Request

DELETE https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflow-types/{id}

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
id	GET	The ID of the Workflow Types

Export Workflow Types

curl --request GET \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types/export/csv \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "queued": "1",
  "class": "workflowtypes"
}

This endpoint exports to a file the current filters Workflow Types in the format of CSV, ODS and XLSX. You can choose the format using the format var.

HTTP Request

GET https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflow-types/export/{export_format}

Filtering

Parameter	Operator	Validation
id	=	Numeric
label	LIKE	String

The filter string is a URL encoded JSON string.

JSON string {"label":"Algorithm Developer"}

URL encoded %7B%22label%22%3A%22Algorithm+Developer%22%7D

Request GET https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types/export/csv?filter=%7B%22label%22%3A%22Algorithm+Developer%22%7D

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
export_format	GET	The file format of the export (CSV, ODS and XLSX)

Import Workflow Types

curl --request POST \ 
  --url https://api.wfc.rest/api/v2/acme-co/client-a/workflow-types/import \ 
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd' \ 
  --header 'content-type: application/json' \ 
  --data '{ 
    "importData": "data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,UEsDBBQABgAIAAAAIQB3erJaZAEAAAMFAA ... gAABkb2NQcm9wcy9jb3JlMC54bWxQSwUGAAAAAAsACwDAAgAAbyEAAAAA"
  }'

{
  "queued": "1",
  "class": "workflowtypes"
}

This endpoint imports from a file the Workflow Types in the format of CSV, ODS and XLSX. The endpoint auto detects the format.

HTTP Request

POST https://api.wfc.rest/api/v2/{tenant}/{scenario}/workflow-types/import

Request Parameters

Parameter	Type	Description
tenant	GET	The tenant you are accessing
scenario	GET	The scenario of the tenant
importData	POST	The data to import in base64 format

Version

Version Summary

The version endpoint allows you to list the current version and 5 previous versions.

Attributes

Parameter	Description
version	The version number (vx.YYMM.x)
release	The date the version was release
sloc	The number of Source Lines of Code in the version
diff	The difference from the last version (Only for the current version)
updates	A list of the changes

Get Version

curl --request GET \
  --url https://api.wfc.rest/api/v2/acme-co/client-a/version \
  --header 'x-auth-token: UGxQacz7yO.zddK1qgfEv.w90VI35vdd'

{
  "current": {
    "version": "v2.1904.1",
    "release": "Fri 5th Apr 2019",
    "sloc": "84481",
    "diff": -466161,
    "updates": [
      "Initial Workflow Centre version 2 build"
    ]
  },
  "previous": [
    {
      "version": "v1.1804.1",
      "release": "Tue 24th Apr 2018",
      "sloc": "550642",
      "updates": [
        "Performance improvements in various modules",
        "Removal of redundant code",
        "Add the ability to checkout multiple tasks"
      ]
    },
    {
      "version": "v1.1707.1",
      "release": "Wed 26th Jul 2017",
      "sloc": "550452",
      "updates": [
        "Fixes an issue with timezones when exporting to Excel",
        "Performance improvements in various modules",
        "Fixes an issue with submitting a page twice",
        "Removal of redundant code",
        "Fixes an issue with duplicate workflow tasks in a clone"
      ]
    },
    {
      "version": "v1.1704.1",
      "release": "Wed 19th Apr 2017",
      "sloc": "551307",
      "updates": [
        "Minor updates to the Detailed Instance Issue report",
        "Minor updates to the Detailed Instance User report"
      ]
    },
    {
      "version": "v1.1702.1",
      "release": "Mon 13th Feb 2017",
      "sloc": "551155",
      "updates": [
        "Fixes an issue with the instance clone that caused the clone to fail if the name was over 45 characters",
        "Further improvements to the indexing performance",
        "Fixes an issue on the pop-out status in workflow mode"
      ]
    },
    {
      "version": "v1.1612.1",
      "release": "Wed 21st Dec 2016",
      "sloc": "551014",
      "updates": [
        "Fixes an issue with out of Scope tasks on the task list",
        "Changed the core route matching to allow access to module without the language marker",
        "Updated instances so they can be re-ordered using a drop-down menu",
        "Fixes to the the index status"
      ]
    }
  ]
}

This endpoint retrieves the current version and the previous 5 versions.

HTTP Request

GET https://api.wfc.rest/api/v2/acme-co/client-a/version

Licence

curl --request POST \
  --url https://auth.wfc.rest/api/v2/auth/service/licence/check \
  --header 'content-type: application/json' \
  --header 'x-language: en' \
  --data '{
    "tenant": "acme-co-sandbox",
    "licence": "LS0tLS1CRU ... UtLS0tLQ=="
}'

{
  "uid": "a761ad-bb1fac-cef48c-dfc6cf",
  "tenant": "acme-co-sandbox",
  "concurrences": 10,
  "valid_to": "2020-05-06 23:59:59",
  "expires": "1 month from now"
}

-----BEGIN WFC LICENCE-----
 YTU0MTlkLWJmMjRlYy1jODYzZTEtZDQ5NTlmfHh8fwPmJa6HWLD8qgshTV9/PuJq
 EMsn4Y5Pt9UokS8krIY0t3nW7Vj0gy/KKer5odPHtzdhuKktDFhmhJb0DgaN3sRX
 JYU/icJNqsWenhJ3Zqes2NRtWNcn6G4Ix2j9sO0al2lRYF5HD/n72C3aV+xxpTkM
 zURuP61UqyiMR/4tMfeYl80AG4WuyZ82Q2ZsHX5MVBtR5eMWTIHmtlNZceGVPb9c
 kQPnWd6k7jXjXjSBWliI6VGcZrf0RdOqVa2xIhiqMAI72X3NeYuupCJy0rDHDKuR
 Ioman3zp9IdTwRhvNuD15XOaXFK3m3MIPagY9BrNgBBuQbwpaZ+kzcgvesQxYxCn
 y4TOIdbu2DyquaKVm+epmx7yQZFgHfpiGdGGlCJAgYAHErnpoVxeodaNiAIzzefR
 TyG+PnCWq2Sw2imsZIBoWkyGpEr0DpkOXS8H/4W4W1ckXU+Ptx76Yqu03qyvh3fG
 XGFF0kY/25VVYMV2qRmZthDj+p4BIVy9LXqDVLvRhcmZtmWqKjmj7dgazA/4b6jz
 ffI3pI+9RirmZBXq/ayB1pa3W6FnklnuEvqOD9om1sgm5XT80+kQOL+gBZ25lljn
 DTDMs9yXakX/H1VL2Gv1bdDmYDP66I5kLULYcrsHhbVzfkIU4qgJ9Zlp6jzGwbtQ
 aM0N2YmN1jl92s70Yap8eHx8rBws1TiXArMz/ljcuyrYs7Kdk32whNf1e2COjhra
 AK10R0nfKpno/Kz6FPeANZfRBVVZ9rBW9GrjAL6Pv4YaSDAiLeU/8PvzLkG6ONb9
 nyH6KAikiktqOFLncwAOc19v7mkoiFEwL8KTh+G+lo9XVlpUNusYOj5Qd+QforJm
 SJSuq3K0TVgQbMzLTlKVfO32MI5CzcvxHNNpuVjt1WSoWnOzt9O7BnNuysEfkU55
 CzkBX1BGDHI6W5X+1GLHFg0G26Eg94NP17ShQrIkAMh8DBG0AetnNVHi/2y9VNbm
 paYgvu1SYgazzkgUwkvMaX8RTJ68Mra+AvC5tYXWqjTf
 -----END WFC LICENCE-----

To use any part of WFC you must have a valid licence, if you are unsure about the licence you have please contact us. Once you have obtained or renewed the licence you can upload this to the frontend so that you and your users can access WFC. During the licence process you can nominate a person to be responsible for the licence, this person MUST renew the licence prior to it expiring to continue access.

HTTP Request

POST https://auth.wfc.rest/api/v2/auth/service/licence/check

Request Parameters

Parameter	Type	Description
tenant	POST	The tenant you are accessing
licence	POST	A base64 encoded string of the your licence key

Return Attributes

Parameter	Description
uid	The unique identifier for the licence
tenant	The tenant you are accessing
concurrences	The number of concurrent users allowed for this licence
valid_to	The date this licence is valid to as a timestamp
expires	The date this licence is valid to as a sentence

Request Methods

The API uses the following request methods:

Method	Meaning	Idempotent
GET	Retrieve an object or a collection of objects.	TRUE
POST	Create an object.	FALSE
PATCH	Modify an object or a collection of objects.	MIXED
DELETE	Delete an object or a collection of objects.	TRUE

HTTP Status Codes

The API uses the following HTTP status codes:

Status Code	Meaning
200	OK -- Your request has succeeded.
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong or invalid.
403	Forbidden -- You are not authorized to view specified endpoint or object.
404	Not Found -- The specified endpoint or object could not be found.
405	Method Not Allowed -- You tried to access an endpoint with an invalid method See Methods.
418	I'm a teapot. The resulting entity body MAY be short and stout.
422	Unprocessable Entity -- You're request has not passed validation
429	Too Many Requests -- You have sent too many requests in a given amount of time. Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Introduction

Authentication

HTTP Request

Return Attributes

Language

Categories

Categories Summary

Attributes

Get all Categories

HTTP Request

Filtering

Request Parameters

Get all Categories with pagination

HTTP Request

Filtering

Request Parameters

Create a Category

HTTP Request

Request Parameters

Get a Specific Category

HTTP Request

Request Parameters

Update a Specific Category

HTTP Request

Request Parameters

Delete a Specific Category

HTTP Request

Request Parameters

Toggle the scope for a Category

HTTP Request

Request Parameters

Project view categories

HTTP Request

Request Parameters

Category Components

HTTP Request

Request Parameters

Create Dependencies

HTTP Request

Request Parameters

Toggle the scope for a Component

HTTP Request

Request Parameters

Sequences up components linked to a given Category

HTTP Request

Request Parameters

Sequences down components linked to a given Category

HTTP Request

Request Parameters

Sequences the Categories

HTTP Request

Request Parameters

Sequences up a Category

HTTP Request

Request Parameters

Sequences down a Category

HTTP Request

Request Parameters

List dependencies

HTTP Request

Request Parameters

View dependencies

HTTP Request

Request Parameters

Update dependencies

HTTP Request

Request Parameters

Export Categories

HTTP Request

Filtering

Request Parameters

Import Categories

HTTP Request

Request Parameters

Comments

Comments Summary

Attributes

Get all Comments

HTTP Request

Filtering