Obtener Estados

    Detalles de la petición

    • URL Base: {host}/ASMSAPI/
    • Uri: /api/v9/model/{id}/{itemType}/states?stateId={stateId}&itemId={itemId}
    • Tipo: GET
    • Encabezados requeridos:

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

    Descripción de la URL

    • {host}: Representa el dominio del ambiente en el que se encuentra la API.
    • ASMSAPI/: Prefijo fijo de la API.
    • Uri: Endpoint específico para la petición.


    EJEMPLO URL:

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


    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    id Número Identificador del modelo.
    itemType Número Tipo de caso
    1. Incidente
    2. Problema
    3. Cambio
    4. Requerimiento de servicio
    13. Liberación
    stateId Número No Identificador del estado.
    itemId Número No Identificador del caso.

    Cuerpo de la petición

    N/A

    Respuesta

    {
       "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
    }
    

    Parámetros Respuesta

    Nombre Tipo de dato Descripción
    backgroundColorRgb Texto Representación del color del estado en escala RGB
    description Texto Descripción del estado
    foregroundColorRgb Texto Color del estado actual en blanco o negro en escala RGB
    haveRisk Booleano Determina si el estado tiene un riesgo
    id Número Id del estado
    isFinal Booleano Determina si el estado es final
    isVotingProcess Booleano Determina si el estado necesita de un voto de aprobación
    mandatoryNote Booleano Determina si el estado necesita de una nota. No aplica para estados iniciales
    name Texto Nombre del estado
    stageName Texto Nombre del comportamiento del estado
    content Lista Listado de objetos encontrados en la búsqueda
    totalItems Número Número total de objetos encontrados

    Mensajes de Error

    Código Estado HTTP Mensaje de error
    400 BadRequest \r\nNombre del parámetro: Id
    400 BadRequest \r\nNombre del parámetro: ItemType
    400 BadRequest {id} no es un valor válido para Int32.\r\nNombre del parámetro: Id
    400 BadRequest {itemType} no es un valor válido para ArandaType.\r\nNombre del parámetro: ItemType
    400 BadRequest {stateId} no es un valor válido para Int32.\r\nNombre del parámetro: StateId
    400 BadRequest {itemId} no es un valor válido para Int32.\r\nNombre del parámetro: ItemId