glossary-values/{ID_valor}/usage

Resumen del método

GET/glossary-values/{value-id}/usage

Descripción

Utilice este método para obtener información de uso de un valor de glosario especificado.

Información de recursos

Requisitos	Descripción
Formato de la respuesta	JSON
Requiere autenticación	Sí
Permite credenciales de cliente de OAuth 2	Sí, utilizando un ID de servicio de usuario que contiene la categoría de creación de informes de artefactos

Parámetros

Nombre	Ubicación	Descripción	Obligatorio	Tipo
X-IBM-API-Version	Cabecera	Versión de esta API. Si está programando contra la API, TIENE que incluir la versión. Si se omite, se usará la última versión de la API, que podría ser incompatible con versiones anteriores. El valor actual es 1.0.0.	Nee	Serie
X-On-Behalf-Of	Cabecera	El contexto de usuario. El valor debe ser un nombre de usuario en la cuenta. El usuario debe tener permiso para realizar la acción en la cuenta y en el espacio padre especificado, si lo hay.	Necesario si se utilizan credenciales de ID de servicio OAuth. No es necesario cuando se utiliza la credencial de ID de servicio de usuario OAuth.	Serie
value-id	Vía de acceso	Identificador del valor de glosario de interés.	Sí	Serie

Respuesta

Entrada de ejemplo

Obtener con GET los detalles de dónde se usa un determinado valor de glosario:

• Uso de la ID de servicio de usuario OAuth 2 credenciales de cliente:

  curl -i -H "Authorization: Bearer access_token"  
      "https://your_server_url/bwl/glossary-values/2500d8/usage"

• Uso de la ID de servicio OAuth 2 credenciales de cliente:

  curl -i -H "Authorization: Bearer access_token"  
  "https://your_server_url/bwl/glossary-values/2500d8/usage"

• Uso de la ID de servicio OAuth 2 credenciales de cliente con contexto de usuario:

  curl -i -H "Authorization: Bearer access_token"  
      -H "X-On-Behalf-Of:user_name@domain.com" "https://your_server_url/bwl/glossary-values/2500d8/usage"

Resultado de ejemplo

Obtener con GET los detalles de dónde se usa un determinado valor de glosario:

{
  "target-artifact-name": "myKPI1",
  "target-artifact-id": "2500d8",
  "usage-count": 1,
  "used-by-artifacts": [
    {
      "id": "2500b1",
      "name": "MyDecision",
      "type": "decision",
      "space-ids": [
        "250006"
      ],
      "space-names": [
        "MySpace"
      ],
      "archived-state": "active",
      "published-state": "unpublished",
      "last-modified-date": "2017-01-03T22:41:41.384+0000",
      "last-modified-by-user": {
        "id": "50029",
        "full-name": "Edith Editor",
        "email-address": "edith"
      },
      "created-date": "2017-01-01T22:41:41.260+0000",
      "created-by-user": {
        "id": "50029",
        "full-name": "Edith Editor",
        "email-address": "edith"
      },
      "decision-items": [
        {
          "type": "sub-decision",
          "id": "2500b3",
          "name": "MyDecision"
        }
      ]
    }
  ]
}

Obtener con GET los detalles de dónde se usa una determinada unidad de negocio:

{
  "target-artifact-name": "BusinessUnit1",
  "target-artifact-id": "2500a6",
  "usage-count": 1,
  "used-by-users": [
    {
      "id": "2500a1",
      "full-name": "Jane Doe",
      "email-address": "jdoe@myorg.com"
    }
  ]
}

Mensajes de respuesta

Código HTTP	Razón
200	La solicitud se ha completado correctamente.
400	Hay un error al procesar la solicitud. Faltaban algunos parámetros obligatorios o contenían valores no válidos.
401	Este usuario no ha pasado la autenticación. Esta respuesta puede aparecer por las siguientes razones: Se ha proporcionado un nombre de usuario o contraseña no válidos. Este usuario pertenece a varias cuentas y no se ha especificado una cuenta en la solicitud.
403	El acceso está prohibido porque no tiene permisos suficientes en el valor de glosario especificado.
404	El parámetro value-id identifica un valor de glosario que no existe en esta cuenta o que está inactivo. Los valores inactivos no están soportados.

Para más información, consulte OpenAPI specification.