Retrieves an entity based on the provided key
| Header | Name | Description | Type | Additional information |
|---|---|---|---|---|
| Accept | Mime Type |
The accept header used to specify the acceptable response mime type |
string |
Optional |
| Authorization | Scheme |
The authorization method (should always be Basic) |
string |
Required |
| Security Token |
The security token obtained by successfully authenticating a user with the Account API |
globally unique identifier |
Required |
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
The key of the entity to retrieve |
integer |
Required |
None.
{
"CompressorFailID": 1,
"CompressorFailReason": "sample string 2"
}
An error response containing the details about a failed api request
{
"error": {
"batcherror": {
"operationindex": 1,
"requestindex": 2
},
"code": "UnknownError",
"innererror": {
"innererror": {
"message": {
"lang": "en-US",
"value": "sample string 3"
},
"type": "sample string 5",
"trace": "sample string 4"
},
"message": {
"lang": "en-US",
"value": "sample string 6"
},
"type": "sample string 8",
"trace": "sample string 7"
},
"message": {
"lang": "en-US",
"value": "sample string 9"
}
}
}