Get Tape Library Properties

The Get Tape Library Properties request returns the complete set of properties defined for a single tape library.

HTTP method and URI

GET /api/tape-libraries/{tape-library-id}

In this request, the URI variable {tape-library-id} is the object ID of the Tape Library object.

Response body contents

On successful completion, the response body is a JSON object that provides the current values of the properties for the Tape Library object as defined in the Data model. Field names and data types in the JSON object are the same as the property names and data types defined in the data model.

Description

Returns the current values of the properties for the Tape Library object as defined in the Data model.

If the object ID {tape-library-id} does not identify a Tape Library object on the Console, a 404 (Not Found) status code is returned.

Authorization requirements

This operation has the following authorization requirement:
  • Object-access permission to the tape library whose object-id is {tape-library-id}.

HTTP status and reason codes

On success, the HTTP status code 200 (OK) is returned and the response body is provided as described in the Response body contents.

Otherwise, the following HTTP status codes are returned for the indicated errors. The response body is a standard error response body providing the reason code indicated and associated error message.

Table 1. Get Tape Library Properties: HTTP status and reason codes
HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.
404 (Not Found) 1 A tape library with object-id {tape-library-id} does not exist on the Console or the API user does not have object-access permission for it.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. Get Tape Library Properties: Request
GET /api/tape-libraries/031e2350-5b37-11eb-b81d-fa163e11e9ec HTTP/1.1
x-api-session: 2bwrdbymnco1dr84guh8fogvi7blnj1y25x0yppkz9lb5h8izo
Figure 2. Get Tape Library Properties: Response
200 OK
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Wed, 20 Jan 2021 16:05:43 GMT
content-type: application/json;charset=UTF-8
content-length: 358
{
   "class":"tape-library",
   "cpc-uri":"/api/cpcs/406a206e-e4ae-3277-bcc2-30c136208dd9",
   "description":"",
   "device-id":"3573-TL 00L2U78Z8185_LL0",
   "name":"3573-TL 00L2U78Z8185_LL0",
   "object-id":"031e2350-5b37-11eb-b81d-fa163e11e9ec",
   "object-uri":"/api/tape-libraries/031e2350-5b37-11eb-b81d-fa163e11e9ec",
   "parent":"/api/console",
   "state":"available",
   "vendor-id":"IND"
}