GET Collection of Requests

リクエストのコレクションを表示する

説明

GET メソッドを使用して、サーバー上のリクエストのコレクションを表示します。up フィールドの URI は、メソッドのアドレス指定可能なリソースとして機能します。

以下のセクションでは、JSON をデータ シリアル化形式として使用します。Java® クライアント API で protobuf をデータ シリアル化形式として使用する方法を説明する例については、View the Collection of Requests Owned by a Particular Clientを参照してください。

リクエスト

HTTP メソッド

GET

URI

http://host:port/{request-collection-uri-string}

クエリ パラメーター

名前説明値のタイプ
since

必須。

{server-state-number}
clients

ids を指定しない場合、必須。

{client-id-string_1},{client-id-string_2},...
ids

clients を指定しない場合、必須。

{id-string_1},{id_string_2},...

例:

?since=30&clients=786

  • 非同期リクエストを行う場合、クエリ パラメーター since={server-state-number} は "必須"。

  • クエリ パラメーター clients={client-id-string} は "オプション"。

レスポンス

成功

HTTP ステータス コード

200 OK

本文

名前説明値のタイプ
createdSeqサーバーの状態を示す数値。data コレクションに含まれるリクエストは、since と createdSeq の間で何らかの状態変更が行われたリクエストです。{server-state-number}
dataクエリに一致する MATLAB® 実行リクエストのコレクション。

"data": [
   {
   "id": {id-string},
   "self": [request-uri-string},
   "up": {request-collection-uri-string},
   "lastModifiedSeq": {server-state-number},
   "state": {request-state-string},
   "client": {client-id-string}
 },
{
   "id": {id-string},
   "self": {request-uri-string},
   "up": {request-collection-uri-string},
   "lastModifiedSeq": {server-state-number},
   "state": {request-state-string},
   "client": {client-id-string}
 },...
  ]

例: 

"data": [
    {
      "id": "c5666088-b087-4bae-aa7d-d8470e6e082d",
      "self": "/~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests/c5666088-b087-4bae-aa7d-d8470e6e082d",
      "up": "/~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests",
      "lastModifiedSeq": 19,
      "state": "READY",
      "client": "786"
    },
    {
      "id": "a4d0f902-d212-47d5-a855-6d64192842d8",
      "self": "/~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests/a4d0f902-d212-47d5-a855-6d64192842d8",
      "up": "/~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests",
      "lastModifiedSeq": 17,
      "state": "READY",
      "client": "786"
    },
    
  ]

エラー

存在しないクライアントに対してコレクションの GET リクエストを呼び出すと、レスポンスで 404 エラーを受け取ります。

現在リクエストのないクライアント (たとえば、クライアントからの以前のすべてのリクエストが削除された場合) に対してコレクションの GET リクエストを呼び出すと、GET 呼び出しは以下のいずれかになります。

  • クライアントにタイムアウト制限が指定されている場合、タイムアウトします。

  • クライアントが新しいリクエストを送信するまで無期限に待機します。その後、GET 呼び出しはリクエストを返します。

HTTP ステータス コード

400 InvalidParamSince

400 MissingParamSince

400 MissingQueryParams

400 NoMatchForQueryParams

404 URL not found

500 InternalServerError

サンプル呼び出し

HTTP

リクエスト:

GET /~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests?since=15&clients=786 HTTP/1.1
Host: localhost:9910

レスポンス:

Status Code: 200 OK
{
  "createdSeq": 19,
  "data": [
    {
      "id": "c5666088-b087-4bae-aa7d-d8470e6e082d",
      "self": "/~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests/c5666088-b087-4bae-aa7d-d8470e6e082d",
      "up": "/~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests",
      "lastModifiedSeq": 19,
      "state": "READY",
      "client": "786"
    },
    {
      "id": "a4d0f902-d212-47d5-a855-6d64192842d8",
      "self": "/~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests/a4d0f902-d212-47d5-a855-6d64192842d8",
      "up": "/~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests",
      "lastModifiedSeq": 17,
      "state": "READY",
      "client": "786"
    }
   ]
  }

JavaScript

var data = null;
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
    if (this.readyState === 4) {
        console.log(this.responseText);
    }
});
xhr.open("GET", "http:////localhost:9910/~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests?since=15&clients=786");
xhr.send(data);

バージョン履歴

R2016b で導入

参考

|

トピック