WorkflowStatus API

In Surpass, every item is assigned a status that indicates its progress along the workflow. Every item starts at Draft and must be set to Live before being able to be added to a test form. Users may only have access to certain workflow statuses depending on their permissions and you can create custom workflow statuses.

The Workflow API resource is used to list workflow statuses.

This article explains what calls can be made to the Surpass API using the WorkflowStatus resource.

Import this API into your Postman Workspace

Listing workflow statuses

get /api/v2/WorkflowStatus

Send a request to the endpoint to retrieve a list of workflow statuses. Refer to the available parameters to influence the response. No request body is required.

Parameters

Parameters are passed with the endpoint to influence the response. Header parameters are included in the request header. Path parameters are extensions of the endpoint, and query parameters follow ? after any path parameters.

Name	Parameter	Input	Description
authorization	header MANDATORY	`Basic {credentials}`	Basic authentication details must be passed to authorise the user’s request, where `{credentials}` is a Base64 encoded `username:password` string.
accept	header OPTIONAL	`application/json` or `application/xml`	Determines data format of the response, which can be either JSON or XML.

Name

Parameter

Input

Description

authorization

header

MANDATORY

Basic {credentials}

Basic authentication details must be passed to authorise the user’s request, where {credentials} is a Base64 encoded username:password string.

accept

header

OPTIONAL

application/json or application/xml

Determines data format of the response, which can be either JSON or XML.

Sample response

If successful, the HTTP status code will be 200 and the response body will contain the information in either JSON or XML format as requested.

{
    "count": 5,
    "top": null,
    "skip": null,
    "pageCount": null,
    "nextPageLink": null,
    "prevPageLink": null,
    "response": [
        {
            "id": 1,
            "name": "Draft"
        },
        {
            "id": 2,
            "name": "To Review"
        },
        {
            "id": 3,
            "name": "Reviewed"
        },
        {
            "id": 4,
            "name": "Live"
        },
        {
            "id": 5,
            "name": "Withdrawn"
        }
    ],
    "errors": null,
    "serverTimeZone": "GMT Standard Time"
}

NOTE: This sample response contains all of the default workflow statuses in Surpass. Any more workflow statuses returned in a response are custom workflow statuses. For information on creating custom workflow statuses, read 'About Workflow Status settings' in About Site Settings options.

Error Codes

Refer to the following table for information on error codes that may be encountered when using this resource.

Name	Code	Description
InternalServer	1	Internal server error.
Unauthorized	3	The request has been sent by an unauthorised user.
IncorrectFieldFormat	4	A field in the request has not been completed in the correct format.
InaccessibleOperation	5	The request has been sent by a user with invalid permissions.
InaccessibleData	6	The request has been sent by a user with invalid permissions.

WorkflowStatus API

In This Article

Listing workflow statuses

Parameters

Sample response

Response schema

Error Codes

Further reading

About the site