View a collection of requests
Use a GET method to view a collection of requests on the server.
The URI of the up field serves as the addressable
resource for the method.
GET
http://host:port/{request-collection-uri-string}
| Name | Description | Value-Type |
|---|---|---|
since | Required. | {server-state-number} |
clients | Required if | {client-id-string_1},{client-id-string_2},... |
ids | Required if | {id-string_1},{id_string_2},... |
Example:
?since=30&clients=786
The query parameter since={server-state-number} is required if
you are making an asynchronous request.
The query parameter clients={client-id-string} is optional.
200 OK
| Name | Description | Value-Type |
|---|---|---|
createdSeq | Number indicating the server state. The requests included in
the data collection are the requests that have
gone through some state change between since and createdSeq. | {server-state-number} |
data | Collection of MATLAB® execution requests that match a query. | "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}
},...
]
|
Example:
"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"
},
]
|
400 InvalidParamSince
400 MissingParamSince
400 MissingQueryParams
400 NoMatchForQueryParams
404 URL not found
500 InternalServerError
Request: GET /~e4a954fd-5eaf-4b54-aac2-20681b33d075/requests?since=15&clients=786 HTTP/1.1 Host: localhost:9910 Response: 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"
}
]
} |
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); |