キュー項目を追加

この記事の内容
  1. 事前操作
  2. リクエスト
  3. リクエストヘッダー
  4. リクエストパラメータ
  5. レスポンス
  6. レスポンスデータ構造
  7. レスポンスデータの例
  8. 使用例
  9. curlの例

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

このAPIは、指定したキューにキュー項目を追加するために使用します。

事前操作

  1. 認証APIを使用してaccessTokenを取得します。

リクエスト

基本 パラメータ値 説明
HTTP URL https://api.example.com/oapi/tool/queue/v1/queues/{{queueUuid}}/enqueue キューUUIDパラメータを置き換える必要があります。専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください
HTTP Method POST

リクエストヘッダー

基本 パラメータ値 説明
Authorization Bearer {accessToken} {accessToken}変数を、認証APIが返すaccess Tokenに置き換える必要があります

リクエストパラメータ

名称 タイプ 必須 説明
name String はい キューのタスク項目名です。長さは1~100にする必要があります
priority Integer はい 優先度です。列挙値は【0,100,200】です
0-高、100-中、200-低
expireTime Long いいえ 有効期限です。値はタイムスタンプで、単位は秒です
effectiveTime Long いいえ 有効開始時刻です。値はタイムスタンプで、単位は秒です
bizInfo String はい 業務情報です。長さは1~1000にする必要があります
description String いいえ 説明です。長さは0~2000にする必要があります
source String はい 追加元です。OpenAPIを指定してください

レスポンス

レスポンスデータ構造

名称 タイプ 説明
data object 結果データ
|─uuid string キュー項目uuid
|─name string 名称
|─status string 状態
|─priority Integer 優先度
|─expireTime Long 有効期限です。値はタイムスタンプで、単位は秒です
|─bizInfo string 業務情報
|─description string 説明
|─createTime Long 作成日時です。値はタイムスタンプで、単位は秒です
|─updateTime Long 更新日時です。値はタイムスタンプで、単位は秒です
code integer 戻り値の結果コードです
200は成功、その他は失敗を示します
success boolean 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しの成否を判断できます
requestId string リクエストidです。問題の調査に使用します
serverIp string 処理サービスのIP
serverInstName string 処理サービスのインスタンス名
msg string ステータスコードの説明

レスポンスデータの例

{
	"data": {
		"uuid": "q683587567319805952_R683587960149929985",
		"name": "1",
		"status": "queued",
		"priority": 100,
		"expireTime": 1714993713,
		"bizInfo": "1",
		"description": "1",
		"createTime": 1714983758,
		"updateTime": 1714983758
	},
	"page": null,
	"code": 200,
	"success": true,
	"requestId": null,
	"serverIp": null,
	"serverInstName": null,
	"msg": null
}

使用例

curlの例

curl --location --request POST 'https://api.example.com/oapi/tool/queue/v1/queues/{queueUuid}/enqueue' \ --header 'Authorization: Bearer 2eed910f-6ade-4e0c-9007-0feade4f5df6' \ \ --header 'Content-Type: application/json' \ --header 'Accept: */*' \ --header 'Host: api.example.com' \ --header 'Connection: keep-alive' \ --data-raw '{ "name": "1", "priority": 100, "expireTime": 1714993713, "bizInfo": "1", "description": "1", "source": "OpenAPI" }'
OpenAPIの記事一覧ページの先頭へ ↑