v2 > Lookups > ProjectStatusesLookup

Get available project's statuses.

  • URL

    /connect/v2/project-statuses

  • Method:

    GET

  • URL Params

Param Type Required Description Domain of value
locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'

  • Sample URL

    /connect/v2/project-statuses?locale=en

  • Request :

    The request has no body.

  • Response :

Field Type Presence Description Domain of value
status object Always The execution status A status object
status.state string Always The state of execution 'SUCCESS' or 'ERROR'
status.code string On error The general error code and message See Errors reference
status.messages[] array of string On error List of errors causes A validation message or other causes
result object On success The execution result A result object
result.entityType string On success The type of entity this result is about 'PROJECT_STATUS'
result.searchInfo object On success Informations about the search result pages A searchInfo object
result.searchInfo.numberOfElements object On success The total number of elements found A positive integer
result.searchInfo.numberOfPages object On success The total number of pages NumberOfElements / pageSize
result.data[] array of object On success A list of status values Array of value object
result.data[].name string On success The name of the status A string
result.data[].code string On success The unique code of the status A string
connectRequest object Always The exact request sent that produced this response A ProjectStatusesLookup request

  • Sample Response (Success):

    HTTP Code : 200

{
    "connectRequest": {
        "locale": "en"
    },
    "result": {
        "data": [
            {
                "code": "PRJ_STATUS_ON_GOING",
                "name": "Ongoing"
            },
            {
                "code": "PRJ_STATUS_COMPLETE",
                "name": "Complete"
            },
            {
                "code": "PRJ_STATUS_PAUSED",
                "name": "Paused"
            },
            {
                "code": "PRJ_STATUS_CANCELED",
                "name": "Canceled"
            }
        ],
        "entityType": "PROJECT_STATUS",
        "searchInfo": {
            "numberOfElements": "4",
            "numberOfPages": "1"
        }
    },
    "status": {
        "state": "SUCCESS"
    }
}

  • Sample Response (Error):

    HTTP Code : 400, 500

{
    "status": {
        "state": "ERROR",
        "code": "CE00001 - Connect request failed validation. Refer to provided messages for details.",
        "messages": [
            "Request has invalid value 'es' for field locale. Allowed value(s) : [de, es_MX, en, fr, zh_CN]"
        ]
    },
    "connectRequest": {
        "locale": "es"
    }
}

results matching ""

    No results matching ""