glossary-values/{category}

このリソースを使用して、特定の定義済みカテゴリーまたはカスタム・プロセス・プロパティーでグロッサリー値を追加したり更新したりします。

メソッドの要約

HTTP メソッド	パス	説明
PUT	/bwl/glossary-values/{category}	特定の定義済みカテゴリーまたはカスタム・プロセス・プロパティーでグロッサリー値を追加したり更新したりします。

PUT /glossary-values/{category}

説明: このメソッドを使用して、特定の定義済みカテゴリーまたはカスタム・プロセス・プロパティーでグロッサリー値を追加したり更新したりします。 tag カテゴリーと goal カテゴリーはサポートされていません。

リソース情報

要件	説明
応答フォーマット	JSON
認証が必要	はい。ユーザーはグロッサリー管理者でなければなりません。
OAuth 2 クライアント資格情報のサポート	はい (成果物オーサリング・カテゴリーを含むユーザー・サービス ID を使用)
指定時間内の数の制限	IBM Blueworks Live は、特定の期間内にこの API を呼び出すことができる頻度を決定するレート制限を適用します。許可されるレートは、1 時間当たり 30 要求です。レート制限は、アカウント全体に適用されます。異なる認証方式が使用された場合でも、すべてのユーザーにわたってアカウント全体の単一レートが適用されます。アカウントの API のレート制限を超えると、次の要求は拒否され、状況コード 429 と応答ヘッダー `Retry-After`が表示されます。これは、次の要求を実行できる秒数を示します。

パラメーター

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

要求 JSON 本体

要求本体は、以下のプロパティーを含む JSON オブジェクトの配列です。

名前	Location	説明	必須	タイプ
id	JSON 本体	グロッサリー値の ID。名前または ID が必要です。	はい	ストリング
name	JSON 本体	グロッサリー値の名前。 ID または名前が必要です。	はい	ストリング
description	JSON 本体	グロッサリー値の説明。	いいえ	ストリング
visibility	JSON 本体	グロッサリー値の可視性。許可される値は、`always-visible`、`always-visible-and-preferred`、および `visible-when-used` です。	いいえ	ストリング
type	JSON 本体	グロッサリー値に関連付けられた単純型。このパラメーターは、input-output カテゴリーにのみ適用されます。許可される値は、`text`、`yes-no`、`integer`、`decimal`、`date`、および `complex` です。	いいえ	ストリング
type-link	JSON 本体	このグロッサリー値の型として機能するもう 1 つのグロッサリー値。このパラメーターは、input-output カテゴリーにのみ適用されます。	いいえ	id プロパティーまたは name プロパティーを含む JSON オブジェクト
content	JSON 本体	グロッサリー値の内容。このパラメーターは、input-output カテゴリーの複合型にのみ適用されます。	いいえ	id プロパティーまたは name プロパティーを含む JSON オブジェクトの配列

応答

例 1 入力 - グロッサリー値を作成する

input-output カテゴリーに「input1」という名前で新しいグロッサリー値を作成します。

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

curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" 
   -X PUT --data "[{\"name\":\"input1\",\"description\":\"This is the description\"}]" 
   "https://your_server_url/bwl/glossary-values/input-output"

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

curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" 
   -X PUT --data "[{\"name\":\"input1\",\"description\":\"This is the description\"}]" 
   "https://your_server_url/bwl/glossary-values/input-output"

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

curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" 
    -H "X-On-Behalf-Of:GlossaryManager@domain.com" -X PUT 
  --data "[{\"name\":\"input1\",\"description\":\"This is the description\"}]" "https://your_server_url/bwl/glossary-values/input-output"

例 1 出力 - グロッサリー値を作成する

新しい値が作成されて、ID を割り当てられます。

{
   "values-created": [
       {
           "id": "13399a",
           "name": "input1"
       }
   ]
}

例 2 入力-グロッサリー値の作成および更新

この例では、JSON 本体を使用した、input-output カテゴリー内のグロッサリー値のバルク作成および更新の実行方法を示します。

注: 名前のみを指定し、その名前が既に使用されている場合、API は既存の値を入力で指定された情報で上書きします。

[
   {
       "name" : "input2",
       "description" : "This is the description"
   },
   {
       "name" : "input1"
   },
   {
       "id" : "d0012",
       "type" : "complex",
       "content" : [ 
	   {
            "name" : "input2"
           {
           },
           "id" : "134567"
           }
       ]
   }
]

例 2 出力-グロッサリー値の作成および更新

新しい「input2」グロッサリー値が作成されて、ID が割り当てられます。 ID「d0012」のグロッサリー値のプロパティーが更新されて、現在は、内容が「input2」の複合型になりました。「input1」または ID「134567」には変更は行われていません。

{
   "values-created": [
       {
           "id": "1348cf",
           "name": "input2"
       }
   ],
   "values-updated": [
       {
           "id": "d0012"
       }
   ],
   "values-unchanged": [
       {
           "id": "134567",
           "name": "input1"
       }
   ]
}

例 3 入力-参照を使用してグロッサリー値を作成する

この例では、JSON 本体を使用して、input-output カテゴリーにハイパーリンク参照およびリンク済みグロッサリー参照付きのグロッサリー値を作成する方法を示します。

注: リンクされたグロッサリー参照は、グロッサリー ID またはグロッサリー名によって追加できます。グロッサリー名を使用する場合は、グロッサリー参照のカテゴリーも追加する必要があります。

[  
   {  
       "name":"input1",
       "glossary-references":[  
           {  
               "id":"c0027"
           },
           {  
               "name":"Access Badge",
               "category":"input-output"
           }
       ],
       "hyperlink-references":[  
           {  
               "url":"http://yahoo.com",
               "name":"Yahoo"
           }
       ]
   }
]

例 3 出力-参照を使用してグロッサリー値を作成する

新しい値が作成されて、それに参照が割り当てられます。

{
    "values-created": [
        {
           "id": "13399a",
           "name": "input1"
       }
   ]
}

例 4 入力-グロッサリー値の作成および更新-入力が無効

入力データが検証されます。以下の例では、出力に示されているように、両方のエントリーの更新がスキップされ、変更は行われません。

[
   {
       "id": "1348d7",
       "name" : "input1"
   },
   {
       "id" : "d0012",
       "type" : "complex",
       "content" : [ {
           "name" : "input 100"
       }]
   }
]

例 4 出力-グロッサリー値の作成および更新-入力が無効

両方のエントリーの更新はスキップされて、エラー・メッセージが提供されます。検証メッセージの完全リストについては、この後の表を参照してください。

{
   "values-skipped": [
        {
            "id": "1348d7",
            "name": "input1",
            "code": "BWLGVU05",
            "message": "Name conflict with an existing item."
        },
        {
            "id": "d0012",
            "code": "BWLGVU09",
            "message": "An ID or name that is used in the type-link or content property is not found."
       }
   ]
}

検証メッセージ

エラー・コード	エラー・メッセージ
BWLGVU01	ID または名前が無効です。
BWLGVU02	ID が無効です。
BWLGVU03	この ID の値は見つかりません。
BWLGVU04	その項目を更新するためのアクセス権限を持っていません。
BWLGVU05	既存の項目との間で名前の競合があります。
BWLGVU06	アクセス権限を持っていない既存の項目との間で名前の競合があります。
BWLGVU07	2 つ以上の既存の項目との間で名前の競合があります。
BWLGVU08	内容が無効です。
BWLGVU09	type-link プロパティーまたは content プロパティーで使用されている ID または名前が見つかりません。
BWLGVU10	type-link プロパティーまたは content プロパティーで使用されている ID または名前へのアクセス権限がありません。
BWLGVU11	項目の type-link プロパティーまたは content プロパティーで使用されている ID または名前が項目自体を参照しています。
BWLGVU12	グロッサリー参照 URL が無効です。
BWLGVU13	リンクされたグロッサリー参照の ID が無効です。
BWLGVU14	リンクされたグロッサリー参照の ID、名前、または型が無効です。
BWLGVU15	項目の、リンクされたグロッサリー参照で使用されている ID または名前が項目自体を参照しています。
BWLGVU16	リンクされたグロッサリー参照で使用されている ID または名前へのアクセス権限がありません。
BWLGVU17	リンクされたグロッサリー参照で使用されている ID または名前が見つかりません。
BWLGVU18	項目の type-link プロパティーまたは content プロパティーで使用されている ID が無効です。
BWLGVU19	type-link プロパティーまたは content プロパティーで使用されている ID または名前が無効です。
BWLGVU20	入力内に重複している項目があります。最初の項目が使用され、その他の項目はすべてスキップされます。

応答ヘッダー

ヘッダー名	説明
Retry-After	いつ次の要求を行えるか (秒数)。

応答メッセージ

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

ここにリストされていない応答コードについては、HTTP 仕様を確認してください。

詳細は OpenAPI 仕様を参照。