Responses
Unauthorized
This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.
Name |
Type |
Description |
code |
string |
|
http_response_code |
any type |
|
detail |
string or MissingRequiredScopes |
|
DATA_TYPE |
string |
Type of this document |
data |
array of object |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to fetch the next
page of results if the returned document has |
message |
string |
Message describing this result |
{
"code": "not_authorized",
"http_response_code": 401,
"detail": "string",
"DATA_TYPE": "result#1.0.0",
"data": [
{}
],
"has_next_page": false,
"marker": "string",
"message": "string"
}
Unsupported media type
This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.
Name |
Type |
Description |
code |
string |
|
http_response_code |
any type |
|
DATA_TYPE |
string |
Type of this document |
data |
array of object |
|
detail |
any type |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to fetch the next
page of results if the returned document has |
message |
string |
Message describing this result |
{
"code": "unsupported_media_type",
"http_response_code": 415,
"DATA_TYPE": "result#1.0.0",
"data": [
{}
],
"detail": null,
"has_next_page": false,
"marker": "string",
"message": "string"
}
Bad Request
This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.
Name |
Type |
Description |
code |
string |
|
http_response_code |
any type |
|
DATA_TYPE |
string |
Type of this document |
data |
array of object |
|
detail |
any type |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to fetch the next
page of results if the returned document has |
message |
string |
Message describing this result |
{
"code": "bad_request",
"http_response_code": 400,
"DATA_TYPE": "result#1.0.0",
"data": [
{}
],
"detail": null,
"has_next_page": false,
"marker": "string",
"message": "string"
}
Unprocessable entity
This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.
Name |
Type |
Description |
code |
string |
|
http_response_code |
any type |
|
detail |
string or InvalidInput |
|
DATA_TYPE |
string |
Type of this document |
data |
array of object |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to fetch the next
page of results if the returned document has |
message |
string |
Message describing this result |
{
"code": "unprocessable_entity",
"http_response_code": 422,
"detail": "string",
"DATA_TYPE": "result#1.0.0",
"data": [
{}
],
"has_next_page": false,
"marker": "string",
"message": "string"
}
Not found
This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.
Name |
Type |
Description |
code |
string |
|
http_response_code |
any type |
|
DATA_TYPE |
string |
Type of this document |
data |
array of object |
|
detail |
any type |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to fetch the next
page of results if the returned document has |
message |
string |
Message describing this result |
{
"code": "not_found",
"http_response_code": 404,
"DATA_TYPE": "result#1.0.0",
"data": [
{}
],
"detail": null,
"has_next_page": false,
"marker": "string",
"message": "string"
}