Get Media List for a Library

Select

Customer Managed

Get the list of media for given library.

Path Parameters

libraryId int32 required
Id of Library

Query Parameters

filterMediaType required
Possible values: [ALL, SPARE, CLEANING, RETIRED, OVERWRITE_PROTECT, AGED, FOREIGN, CATALOG, ASSIGNED, ERASABLE]
Filter media list to given FilterMediaType
isExported boolean required
List "Media In Library" only if isExported is set to false otherwise list "Exported Media"

Responses

application/json

Schema
Example (from schema)

Schema

mediaDetailsList object[]
mediaId int32
Id of Media
isExported boolean
Indicates whether media is exported or in library
libraryId int32
Id of Library
libraryName string
Name of Library
status string
Status of media
barcode string
Barcode label on media
storagePolicy object
id int32
name string
storagePolicyCopy object
id int32
name string
slot object
id int32
name string
container object
id int32
name string
storedDataBytes int64
The amount of stored data in media
lastWriteTime int64
The date and time when the last write occurred on media
retainDataUntil int64
The date and time until the data should be retained
spareGroup object
id int32
name string
spareGroupType
Possible values: [REGULAR_SPARE_GROUP, DEFAULT_SPARE_GROUP, UNIDENTIFIED_GROUP, DEPRECATED_GROUP, FOREIGN_GROUP, CLEANING_GROUP, OVERWRITE_PROTECT_GROUP, CATALOG_GROUP, REGULAR_AND_DEFAULT_SPARE_GROUP]
Spare group type of a group from which media belongs
mediaType object
id int32
name string
drive object
id int32
name string
isInMediaGroup boolean
Indicates whether media is assigned or not.
guiMediaAttribute int64
Attributes of Media

{
  "mediaDetailsList": [
    {
      "mediaId": 0,
      "isExported": true,
      "libraryId": 0,
      "libraryName": "string",
      "status": "string",
      "barcode": "string",
      "storagePolicy": {
        "id": 0,
        "name": "string"
      },
      "storagePolicyCopy": {
        "id": 0,
        "name": "string"
      },
      "slot": {
        "id": 0,
        "name": "string"
      },
      "container": {
        "id": 0,
        "name": "string"
      },
      "storedDataBytes": 0,
      "lastWriteTime": 0,
      "retainDataUntil": 0,
      "spareGroup": {
        "id": 0,
        "name": "string"
      },
      "mediaType": {
        "id": 0,
        "name": "string"
      },
      "drive": {
        "id": 0,
        "name": "string"
      },
      "isInMediaGroup": true,
      "guiMediaAttribute": 0
    }
  ]
}

Bad Request

application/json

Schema
Example (from schema)

Schema

errorMessage string
Tells about the error occured
errorCode ErrorCode
Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]
Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Forbidden

application/json

Schema
Example (from schema)

Schema

errorMessage string
Tells about the error occured
errorCode ErrorCode
Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]
Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Internal Server Error

application/json

Schema
Example (from schema)

Schema

errorMessage string
Tells about the error occured
errorCode ErrorCode
Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]
Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

GET /v4/library/:libraryid/media

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

libraryId — path required

filterMediaType — query required

isExported — query required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Library/:libraryId/Media' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Library/:libraryId/Media' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Library/:libraryId/Media' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Library/:libraryId/Media' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Library/:libraryId/Media' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Library/:libraryId/Media' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Library/:libraryId/Media' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Get Media List for a Library​

Authorization

Request

Get Media List for a Library