GET jobs/configuration/statuses/list

Available from CRM.COM R6.0.0

This method returns the statuses that are allowed to be used by jobs of specific type. Multiple statuses are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

job_type_identifier

(mandatory)

Job Type Identifier

The identifier of the type of the job that will be using the statuses. The statuses are filtered against the allowed statuses of the specified type. The allowed job type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job type

name

(semi-optional)

String

The name of the job type

alternative_code

(semi-optional)

String

The alternative code of the job type

life_cycle_state

(optional)

Sting

The life cycle state that the status should have. If specified then only statuses related with the specified life cycle state will be retrieved

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Response Data

Name	Type	Description
id	String	The ID of the retrieved job type status
default	Boolean	Determines if the job type status is the default status or not
status	Job Status Object	The actual status provided by the job type status

Referred Objects Response Data

job_status object response data

Name	Type	Description
id	String	The ID of the retrieved job status
name	String	The name of the retrieved job status
alternative_code	String	The alternative code of the retrieved job status
description	String	A description of the retrieved job status
life_cycle_state	String	The life cycle state related with the retrieved job status The supported life cycle states are the following: DRAFT, PENDING, IN_PROGRESS,COMPLETED,CANCELLED

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "CANCELLED",
                "id": "A1E10920D28A4496BCA2811A94783BDF",
                "name": "Cancelled",
                "alternative_code": "C"
            },
            "id": "1E33734C4FBF4E059BB4190407AB6209"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "PENDING",
                "id": "59310E86D1DD626A04102462FC3E9D1B",
                "name": "To be Approved",
                "description": "To be Accepted",
                "alternative_code": "TBA"
            },
            "id": "63B3A06962BD0A1F3D26B3BBD240ECD3"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "COMPLETED",
                "id": "JobStatus4",
                "name": "Closed",
                "description": "Completed",
                "alternative_code": "CL"
            },
            "id": "8474D91CF4AF1D47033D66E79B1CDC61"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "IN_PROGRESS",
                "id": "D67BE6044C7F5802480FD591FC09319B",
                "name": "In Progress",
                "description": "In Progress",
                "alternative_code": "IP"
            },
            "id": "8781916ABD01EDB7C9194E60B849B140"
        },
        {
            "default": true,
            "status":
            {
                "life_cycle_state": "DRAFT",
                "id": "0F1EE97BD63642699FFAEB461F471147",
                "name": "Draft",
                "alternative_code": "D"
            },
            "id": "F086AC246B4C47A9B93CDED0796C6AF3"
        }
    ]
}