glossary-values/{value-id}/usage

指定されたグロッサリー値が使用されている場所に関する情報を取得するには、このリソースを使用します。値はアクティブな値でなければならず、ユーザーに表示されるものでなければなりません。

メソッドの要約

HTTP メソッド	パス	説明
取得	/bwl/glossary-values/{value-id}/usage	特定のグロッサリー値の使用情報を返します。値はアクティブな値でなければならず、ユーザーに表示されるものでなければなりません。

取得 /glossary-values/{value-id}/usage

説明: 指定されたグロッサリー値の使用情報を返すには、このメソッドを使用します。

リソース情報

要件	説明
応答フォーマット	JSON
認証が必要	はい
OAuth 2 クライアント資格情報のサポート	はい (成果物レポート・カテゴリーを含むユーザー・サービス ID を使用)

パラメーター

名前	Location	説明	必須	タイプ
X-IBM-API-Version	ヘッダー	この API のバージョン。 API に対してプログラミングする場合は、バージョンを含める必要があります。省略した場合は、API の最新バージョンが使用され、以前のバージョンと非互換である可能性もあります。現在の値は `1.0.0` です。	いいえ	ストリング
X-On-Behalf-Of	ヘッダー	ユーザー・コンテキスト。値は、アカウントに含まれるユーザー名でなければなりません。ユーザーは、アカウント内と、親スペースを指定した場合はその親スペース内でアクションを実行する権限を持っている必要があります。	サービス ID OAuth 資格情報を使用する場合は必須です。ユーザー・サービス ID OAuth 資格情報を使用する場合は不要です。	ストリング
value-id	パス	該当するグロッサリー値の ID。	はい	ストリング

応答

入力例

特定のグロッサリー値が使用されている場所の詳細を取得します。

ユーザー・サービス ID OAuth 2 クライアント資格情報の使用:

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

サービス ID OAuth 2 クライアント資格情報の使用:

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

サービス ID OAuth 2 クライアント資格情報とユーザー・コンテキストの使用:

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"

出力例

特定のグロッサリー値が使用されている場所の詳細を取得します。

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

特定の事業単位が使用されている場所の詳細を取得します。

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

応答メッセージ

HTTP コード	理由
200	要求は正常に完了しました。
400	要求の処理中にエラーが発生しました。必須パラメーターが欠落していたか、無効な値が含まれていました。
401	このユーザーは認証に合格しませんでした。この応答は以下の理由で表示される可能性があります。無効なユーザー名またはパスワードが入力された。このユーザーは複数のアカウントに属しており、要求の中にアカウントが指定されませんでした。
403	指定されたグロッサリー値に対する十分なアクセス権を持っていないため、アクセスは禁止されています。
404	value-id パラメーターは、このアカウントに存在しないか非アクティブなグロッサリー値を特定しています。非アクティブな値はサポートされていません。

詳細は OpenAPI 仕様を参照。