Tape Location Controller Resource

The API allows you to list and view Tape Locations.

GET /tape-locations

Returns list of tape locations filtered by specified query parameters.

Request Parameters
name type description
direction query
filter query
nameLike query
orderBy query
page query
size query
Response Body
media type data type description
application/json array of TapeLocationDetails (JSON) list of tape locations filtered by specified query parameters

Example

Request
GET /tape-locations
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "name" : "...",
  "description" : "..."
} ]
                
              

POST /tape-locations

Create tape location

Request Body
media type data type description
application/json TapeLocationRequest (JSON) specify details for new tape location
Response Body
media type data type description
application/json TapeLocationDetails (JSON) details for newly created tape location

Example

Request
POST /tape-locations
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "description" : "..."
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "..."
}
                
              

DELETE /tape-locations/{guid}

Remove tape location.

Request Parameters
name type description
guid path specify local unique identifier for tape location (use by vProtect)

Example

Request
DELETE /tape-locations/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /tape-locations/{guid}

Get a single tape location.

Request Parameters
name type description
guid path specify local unique identifier for tape location (use by vProtect)
Response Body
media type data type description
application/json TapeLocationDetails (JSON) tape location details

Example

Request
GET /tape-locations/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "..."
}
                
              

PUT /tape-locations/{guid}

Change tape location details.

Request Parameters
name type description
guid path specify local unique identifier for tape location (use by vProtect)
Request Body
media type data type description
application/json TapeLocationRequest (JSON) specify tape location details to update
Response Body
media type data type description
application/json TapeLocationDetails (JSON) updated details for tape location

Example

Request
PUT /tape-locations/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "description" : "..."
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "..."
}