POST tags
2024年4月11日
ID 222772
新しいタグを追加します。
パス
/api/%API_VERSION%/tags
メソッド
POST
リクエストヘッダー
このリクエストには、次のヘッダーがあります。
リクエストヘッダー
名前 | 値 | 説明 |
|---|---|---|
| string (base 64) | |
|
| レスポンスのコンテンツタイプ。 |
|
| リクエストのコンテンツタイプ。
|
| integer | リクエストボディのサイズ（バイト）。 このリクエストボディの最大サイズは、128 MB（ |
リクエストボディ
このリクエストボディには、JSON 配列とタグオブジェクトが含まれます。1 つのタグオブジェクトのみを指定する必要があります。
[
{
"name":"%TAG_NAME%",
"weight": TAG_WEIGHT
}
]
次の表でタグオブジェクトのプロパティについて説明します。
タグオブジェクトのプロパティ
プロパティ | 値 | 必須 | 説明 |
|---|---|---|---|
| 文字列 | Yes | タグの名前。 タグ名の長さは 1 ～ 128 文字にする必要があります。タグ名には、ラテン文字、数字、ハイフン（-）、アンダースコア（_）を含めることができます。新しいタグに既存のタグの名前を使用することはできません。 タグ名を追加する場合、文字が大文字に変換されます。 |
| 整数 | Yes | タグの重要性。 このパラメータの値の範囲は、 |
リクエスト例
POST tags リクエストの例は、次の通りです。
POST https://192.0.2.57/api/1.1/tags
Accept: application/json Content-Type: application/json Authorization: Basic AWxhZGRpbjpvcGVuc2VzYW23 Content-Length: 150
[ { "name": "WIN-TROJAN", "weight": 5 } ] |
レスポンスヘッダー
このレスポンスには、次のヘッダーがあります。
レスポンスヘッダー
名前 | 値 | 説明 |
|---|---|---|
Content-Type |
| レスポンスのコンテンツタイプ。 |
Content-Length | integer | レスポンスボディのサイズ（バイト）。 |
レスポンスボディ
レスポンスボディには、JSON オブジェクトと操作のステータスが含まれます。
[
{
"status": "Tag successfully created"
}
]
次の表でステータスオブジェクトのプロパティについて説明します。
ステータスオブジェクトのプロパティ
プロパティ | 値 | 説明 |
|---|---|---|
| 文字列 | 操作のステータス。 |
レスポンス例
POST suppliers リクエストのレスポンス例は、次の通りです。
НТТР/1.1 201 ОК Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 150
[ { "status": "Tag successfully created" } ] |
エラーレスポンス
エラーレスポンスには、レスポンスのステータスに関する情報が含まれます。
エラーレスポンスには、JSON オブジェクトとエラーの説明が含まれます。
[
{
"status": "An error occurred while creating tag",
"reason": "%REASON%"
}
]