Groups

Managing test groups

Retrieving groups list

get

Returns many groups.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

folderstring · uuidOptional

folderIdstring · uuidOptional

noFolderbooleanOptional

orderingstring · enumOptionalPossible values:

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

querystringOptional

Search in names with the following query

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

401

Authentication credentials were missing or invalid.

get/api/v2/groups/

GET /api/v2/groups/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "text",
      "originGroupId": "123e4567-e89b-12d3-a456-426614174000",
      "name": null,
      "isComponent": true,
      "folderId": null,
      "steps": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "name": null,
          "blockId": null,
          "groupId": null,
          "originGroupId": "text",
          "notes": null,
          "isActive": true,
          "runTimeout": null,
          "sleep": null,
          "waitingConditions": [
            {
              "type": "documentComplete",
              "expected": null,
              "isActive": true,
              "timeout": null
            }
          ],
          "value": "text"
        }
      ]
    }
  ]
}

Creating a group

post

Create a new group.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

namestring · max: 255 · nullableOptional

isActivebooleanOptional

isComponentbooleanOptional

folderIdstring · nullableOptional

testIdstringRequired

atIndexintegerOptional

Responses

201Success

application/json

idstringRead-onlyRequired

originGroupIdstring · uuidRead-onlyRequired

namestring · nullableRead-onlyRequired

isComponentbooleanRead-onlyRequired

folderIdstring · nullableRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

post/api/v2/groups/

POST /api/v2/groups/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 92

"name=null&isActive=true&isComponent=true&folderId=null&testId='text'&atIndex=1"

{
  "id": "text",
  "originGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "name": null,
  "isComponent": true,
  "folderId": null,
  "steps": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": null,
      "blockId": null,
      "groupId": null,
      "originGroupId": "text",
      "notes": null,
      "isActive": true,
      "runTimeout": null,
      "sleep": null,
      "waitingConditions": [
        {
          "type": "documentComplete",
          "expected": null,
          "isActive": true,
          "timeout": null
        }
      ],
      "value": "text"
    }
  ]
}

Retrieving group by ID

get

Returns a single group.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this group.

Responses

200Success

application/json

idstringRead-onlyRequired

originGroupIdstring · uuidRead-onlyRequired

namestring · nullableRead-onlyRequired

isComponentbooleanRead-onlyRequired

folderIdstring · nullableRead-onlyRequired

401

Authentication credentials were missing or invalid.

404

Resource not found.

get/api/v2/groups/{id}/

GET /api/v2/groups/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "originGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "name": null,
  "isComponent": true,
  "folderId": null,
  "steps": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": null,
      "blockId": null,
      "groupId": null,
      "originGroupId": "text",
      "notes": null,
      "isActive": true,
      "runTimeout": null,
      "sleep": null,
      "waitingConditions": [
        {
          "type": "documentComplete",
          "expected": null,
          "isActive": true,
          "timeout": null
        }
      ],
      "value": "text"
    }
  ]
}

Updating a group

put

Update a group.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this group.

Body

namestring · max: 255 · nullableOptional

isActivebooleanOptional

isComponentbooleanOptional

folderIdstring · nullableOptional

Responses

200Success

application/json

idstringRead-onlyRequired

originGroupIdstring · uuidRead-onlyRequired

namestring · nullableRead-onlyRequired

isComponentbooleanRead-onlyRequired

folderIdstring · nullableRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

put/api/v2/groups/{id}/

PUT /api/v2/groups/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 64

"name=null&isActive=true&isComponent=true&folderId=null"

{
  "id": "text",
  "originGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "name": null,
  "isComponent": true,
  "folderId": null,
  "steps": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": null,
      "blockId": null,
      "groupId": null,
      "originGroupId": "text",
      "notes": null,
      "isActive": true,
      "runTimeout": null,
      "sleep": null,
      "waitingConditions": [
        {
          "type": "documentComplete",
          "expected": null,
          "isActive": true,
          "timeout": null
        }
      ],
      "value": "text"
    }
  ]
}

Removing a group

delete

Remove a group.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this group.

Responses

204

No response body

No content

401

Authentication credentials were missing or invalid.

404

Resource not found.

delete/api/v2/groups/{id}/

DELETE /api/v2/groups/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Partially updating a group

patch

Partially update a group.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this group.

Body

namestring · max: 255 · nullableOptional

isActivebooleanOptional

isComponentbooleanOptional

folderIdstring · nullableOptional

Responses

200Success

application/json

idstringRead-onlyRequired

originGroupIdstring · uuidRead-onlyRequired

namestring · nullableRead-onlyRequired

isComponentbooleanRead-onlyRequired

folderIdstring · nullableRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

patch/api/v2/groups/{id}/

PATCH /api/v2/groups/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 64

"name=null&isActive=true&isComponent=true&folderId=null"

{
  "id": "text",
  "originGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "name": null,
  "isComponent": true,
  "folderId": null,
  "steps": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": null,
      "blockId": null,
      "groupId": null,
      "originGroupId": "text",
      "notes": null,
      "isActive": true,
      "runTimeout": null,
      "sleep": null,
      "waitingConditions": [
        {
          "type": "documentComplete",
          "expected": null,
          "isActive": true,
          "timeout": null
        }
      ],
      "value": "text"
    }
  ]
}

PreviousProfiles

NextSteps

Last updated 2 days ago

Was this helpful?