タグ
タグはアセットのグループ化に使用できるアセットプロパティです。
以下のリソースを使用できます。
- •TagObjects。このリソースを使用してタグをアセットに割り当てます。
- •UntagObjects。このリソースを使用してタグをアセットから削除します。
タグの割り当て
TagObjectsリソースを使用して、アセットにタグを割り当てます。
POST要求
アセットにタグを割り当てるには、次のURIを使用します。
/public/core/v3/TagObjects
要求内の最大100個のアセットにタグを割り当てることができます。
各アセットに次の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
|---|
id | String | ○ | オブジェクトのグローバル一意識別子。 |
tags | List | はい | オブジェクトに割り当てるためのタグのリスト。 |
POSTの例
2つのアセットにタグを割り当てるには、次の例のようなPOST要求を使用します。
POST <baseApiUrl>/public/core/v3/TagObjects
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
[{
"id":"5kuZuAC3Os0dycZuqGpqmM",
"tags": ["R12 Tag", "DevQA"]
}, {
"id":"7feHjtC50mLb44CTW4Xmon",
"tags": ["Prod", "DevQA", "R12 Tag"]
}]
要求に成功した場合に204の応答コードを返します。要求が失敗した場合にエラーを返します。要求が部分的に成功した場合、次の例に示されるように、成功トランザクションと失敗トランザクションの情報を返します。
[{
"id": "9WfGCcHsygueFigGhAdWqh",
"status": "FAILED",
"msg": "Object: 9WfGCcHsygueFigGhAdWqh skipped, missing READ/UPDATE permissions."
}, {
"id": "0cLD48xB4TOgm8cNjP2kmJ",
"status": "SUCCESS",
"msg": "Object: 0cLD48xB4TOgm8cNjP2kmJ Operation Message: [Tag assignment succeeded for artifact 0cLD48xB4TOgm8cNjP2kmJ.]"
}]
タグの削除
UntagObjectsを使用してタグをアセットから削除します。
POST要求
タグをアセットから削除するには、次のURIを使用します。
/public/core/v3/UntagObjects
要求内の最大100個のアセットからタグを削除できます。
各アセットに次の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
|---|
id | String | ○ | オブジェクトのグローバル一意識別子。 |
tags | List | はい | オブジェクトから削除するためのタグのリスト。 |
POSTの例
2つのアセットからタグを削除するには、次の例のようなPOST要求を使用します。
POST <baseApiUrl>/public/core/v3/UntagObjects
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
[{
"id":"5kuZuAC3Os0dycZuqGpqmM",
"tags": ["R12 Tag", "DevQA"]
}, {
"id":"7feHjtC50mLb44CTW4Xmon",
"tags": ["DevQA", "R12 Tag"]
}]
要求に成功した場合に204の応答コードを返します。要求が失敗した場合にエラーを返します。要求が部分的に成功した場合、次の例に示されるように、成功トランザクションと失敗トランザクションの情報を返します。
[{
"id": "9WfGCcHsygueFigGhAdWqh",
"status": "FAILED",
"msg": "Object: 9WfGCcHsygueFigGhAdWqh skipped, missing READ/UPDATE permissions."
}, {
"id": "0cLD48xB4TOgm8cNjP2kmJ",
"status": "SUCCESS",
"msg": "Object: 0cLD48xB4TOgm8cNjP2kmJ Operation Message: [Tag assignment succeeded for artifact 0cLD48xB4TOgm8cNjP2kmJ.]"
}]