Get Streams
DescriptionGet All Images based on request param and Searchable field.Images can be searched based on name, os, multiSession, osType, sourceType, gpuType, sourceStreamId, sourceVersionId, status fields.
NOTE: If fields (os,os_type) are present in both request params and search criteria, request param would take precedence.
Request
URLURL
Query Parameters
Query Parameters
org_id
os
os_type
Page number to retrieve.
Search Criteria. Please see model definition for list of searchable fields.
search example
"providerInstanceId $eq provider-instance-id-1"
Size of each page.
Ascending/Descending. Format is property,{asc|desc} and default is ascending.
Authentication
Response
Response BodyResponse Body
200 OK
Successfully retrieved images
{
"content": [
{
"createdAt": "string",
"description": "string",
"gpuType": "AMD",
"id": "0123456789",
"markers": [
{
"createdAt": "string",
"errorCode": "UPDATES_FAILED",
"errorDetails": "string",
"errorDetailsParameters": {
"key": "string"
},
"id": "0123456789",
"imageId": "0123456789",
"name": "HRLite,HRPro",
"nextVersionId": "0123456789",
"orgId": "0123456789",
"status": "IN_PROGRESS",
"templateCount": 0,
"updatedAt": "string",
"versionId": "0123456789"
}
],
"multiSession": false,
"name": "string",
"orgId": "0123456789",
"os": "string",
"osType": "CLIENT",
"sourceStreamId": "string",
"sourceType": "AKKA_CUSTOM_VM",
"sourceVersionId": "string",
"status": "PENDING, AVAILABLE, IMPORT_COMPLETE and so on",
"updatedAt": "string",
"version": 0,
"versionCount": 100
}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}
Searchable fields are “name”, “os”, “multiSession”, “osType”, “sourceType”, “gpuType”, “sourceStreamId”, “sourceVersionId”, “status”
Errors
Bad request - unsupported provider type
Unauthorized
Forbidden
Streams are not found for the requested org
