EN
Español
English
Português
    Get Statuses

    Petition Details

    • URL Base: {host}/ASMSAPI/
    • URI: /api/v9/model/{id}/{itemType}/states?stateId={stateId}&itemId={itemId}
    • Guy: GET

    • Required headings:

    • content-type: application/json
    • X-Authorization: Bearer {token}

    URL Description

    • {host}: It represents the domain of the environment in which the API is located.
    • ASMSAPI/: Fixed API prefix.
    • URI: Specific endpoint for the request.


    ⚐ EXAMPLE URL:

    https://{host}/ASMSAPI/api/v9/model/{id}/{itemType}/states?stateId={stateId}&itemId={itemId}


    Parameters

    Name Data type Obligatory Description
    Id Number Yes Model identifier.
    itemType Number Yes Case Type
    1. Incident
    2. Problem
    3. Change
    4. Service Requirement
    13. Release
    stateId Number No State identifier.
    itemId Number No Case identifier.

    Body of the petition

    N/A

    Answer

    {
   "content":[
      {
         "backgroundColorRgb":"0.174.239",
         "description":"Estado inicial que se le asigna a un incidente que ha sido registrado por el usuario a través de los diferentes medios. El incidente contiene información inicial, por lo tanto el especialista deberá validar y completar la misma.",
         "foregroundColorRgb":"255.255.255",
         "haveRisk":false,
         "id":25,
         "isFinal":false,
         "isVotingProcess":false,
         "mandatoryNote":false,
         "name":"Registrado",
         "stageName":null
      }
   ],
   "totalItems":1
}

    Parameters Response

    Name Data type Description
    backgroundColorRgb Text RGB Scale Status Color Representation
    Description Text Description of the state
    foregroundColorRgb Text Color of the current state in black or white in RGB scale
    haveRisk Boolean Determine if the state has a risk
    Id Number State ID
    isFinal Boolean Determine if the state is final
    isVotingProcess Boolean Determine if the state needs a vote of approval
    mandatoryNote Boolean Determine if the status needs a note. Does not apply to initial states
    Name Text State Name
    stageName Text Status Behavior Name
    content List List of objects found in the search
    totalItems Number Total number of objects found

    Error Messages

    Code HTTP status Error Message
    400 BadRequest \r\nParameter Name: Id
    400 BadRequest \r\nParameter Name: ItemType
    400 BadRequest {id} is not a valid value for Int32.\r\nParameter Name: Id
    400 BadRequest {itemType} is not a valid value for ArandaType.\r\nParameter Name: ItemType
    400 BadRequest {stateId} is not a valid value for Int32.\r\nParameter name: StateId
    400 BadRequest {itemId} is not a valid value for Int32.\r\nParameter name: ItemId