{ "swagger":"2.0", "info":{ "description":"API used to communicate with the DIVA Core manager. These end-points are used for submitting requests, configuring resources and getting information on DIVA Core resources and requests. All endpoints with free text field sorts are sorted on the numeric values of the characters defined by the character encoding scheme, otherwise known as a binary sort. This is done to optimize performance.", "version":"1.0.0", "title":"DIVA Core Manager API", "license":{ "name":"Apache 2.0", "url":"http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host":"127.0.0.1:12443", "basePath":"/", "tags":[ { "name":"actors-api-controller", "description":"Actors Api Controller" }, { "name":"spm-media-api-controller", "description":"Spm Media Api Controller" }, { "name":"ui-controller", "description":"UI Controller" }, { "name":"data-service-controller", "description":"Data Service Controller" }, { "name":"system-api-controller", "description":"System Api Controller" }, { "name":"collections-api-controller", "description":"Collections Api Controller" }, { "name":"disks-api-controller", "description":"Disks Api Controller" }, { "name":"robots-api-controller", "description":"Robots Api Controller" }, { "name":"requests-api-controller", "description":"Requests Api Controller" }, { "name":"drives-api-controller", "description":"Drives Api Controller" }, { "name":"spm-slots-api-controller", "description":"Spm Slots Api Controller" }, { "name":"sites-api-controller", "description":"Sites Api Controller" }, { "name":"transcoders-api-controller", "description":"Transcoders Api Controller" }, { "name":"robot-acs-api-controller", "description":"Robot Acs Api Controller" }, { "name":"actor-proxies-api-controller", "description":"Actor Proxies Api Controller" }, { "name":"spms-api-controller", "description":"Spms Api Controller" }, { "name":"tapes-api-controller", "description":"Tapes Api Controller" }, { "name":"tape-libraries-api-controller", "description":"Tape Libraries Api Controller" }, { "name":"production-systems-api-controller", "description":"Production Systems Api Controller" }, { "name":"groups-api-controller", "description":"Groups Api Controller" }, { "name":"confs-api-controller", "description":"Confs Api Controller" }, { "name":"actor-disks-api-controller", "description":"Actor Disks Api Controller" }, { "name":"scan-disk-controller", "description":"Scan Disk Controller" }, { "name":"diva-versions-api-controller", "description":"DIVA Versions Api Controller" }, { "name":"prod-api-controller", "description":"Prod Api Controller" }, { "name":"sets-api-controller", "description":"Sets Api Controller" }, { "name":"storage-accounts-api-controller", "description":"Storage Accounts Api Controller" }, { "name":"media-api-controller", "description":"Media Api Controller" }, { "name":"arrays-api-controller", "description":"Arrays Api Controller" }, { "name":"spm-filters-api-controller", "description":"Spm Filters Api Controller" }, { "name":"servers-api-controller", "description":"Servers Api Controller" }, { "name":"events-api-controller", "description":"Events Api Controller" }, { "name":"actor-drives-api-controller", "description":"Actor Drives Api Controller" }, { "name":"diva-protect-api-controller", "description":"DIVA Protect Api Controller" } ], "paths":{ "/actorDisks":{ "get":{ "tags":[ "actor-disk" ], "summary":"Gets the list of all actor disks in the configuration.", "description":"Returns actor disk information for all actor disks in the configuration.", "operationId":"getAllActorDisks", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"name of actor", "required":false, "type":"string" }, { "name":"diskName", "in":"query", "description":"name of disk", "required":false, "type":"string" }, { "name":"isCloud", "in":"query", "description":"isCloud", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ActorDisks" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "actor-disk" ], "summary":"Creates an actor-disk connection in the configuration.", "description":"Returns status for creation of an actor-disk connection in the configuration.", "operationId":"postActorDisk", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"actorDisk", "description":"Actor-Disk connection", "required":true, "schema":{ "$ref":"#/definitions/ActorDisk" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor-disk connection supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "actor-disk" ], "summary":"Updates an actor-disk connection in the configuration.", "description":"Returns status for update of an actor-disk connection in the configuration.", "operationId":"putActorDisk", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"Name of actor", "required":true, "type":"string" }, { "name":"diskName", "in":"query", "description":"Name of disk", "required":true, "type":"string" }, { "in":"body", "name":"newActorDisk", "description":"Actor Disk Connection", "required":true, "schema":{ "$ref":"#/definitions/ActorDisk" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor-disk connection supplied" }, "404":{ "description":"Actor-Disk connection not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "actor-disk" ], "summary":"Deletes an actor-disk connection.", "description":"Returns status for delete of an actor-disk connection from the configuration.", "operationId":"deleteActorDisk", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"Name of actor", "required":true, "type":"string" }, { "name":"diskName", "in":"query", "description":"Name of disk", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor-disk connection supplied" }, "404":{ "description":"Actor-Disk connection not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/actorDrives":{ "get":{ "tags":[ "actor-drive" ], "summary":"Gets the list of all actor drives.", "description":"Returns actor drive information for all actor drives in the configuration.", "operationId":"getAllActorDrives", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"name of actor", "required":false, "type":"string" }, { "name":"driveName", "in":"query", "description":"name of drive", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ActorDrives" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "actor-drive" ], "summary":"Creates an actor-drive connection in the configuration.", "description":"Returns status for creation of an actor-drive connection in the configuration.", "operationId":"postActorDrive", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"actorDrive", "description":"Actor Drive connection", "required":true, "schema":{ "$ref":"#/definitions/ActorDrive" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor-drive connection supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "actor-drive" ], "summary":"Updates an actor-drive connection in the configuration.", "description":"Returns status for update of an actor-drive connection in the configuration.", "operationId":"putActorDrive", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"Name of actor", "required":true, "type":"string" }, { "name":"driveName", "in":"query", "description":"Name of drive", "required":true, "type":"string" }, { "in":"body", "name":"newActorDrive", "description":"Actor Drive connection", "required":true, "schema":{ "$ref":"#/definitions/ActorDrive" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor-drive connection supplied" }, "404":{ "description":"Actor-Drive connection not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "actor-drive" ], "summary":"Deletes an actor-drive connection from the configuration.", "description":"Returns status for delete of an actor-drive connection from the configuration.", "operationId":"deleteActorDrive", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"Name of actor", "required":true, "type":"string" }, { "name":"driveName", "in":"query", "description":"Name of drive", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor-drive connection supplied" }, "404":{ "description":"Actor-Drive connection not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/actorProxies":{ "get":{ "tags":[ "actor-proxy" ], "summary":"Gets the list of all actor proxies in the configuration.", "description":"Returns actor proxy information for all actor-proxies in the configuration.", "operationId":"getAllActorProxies", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"name of actor", "required":false, "type":"string" }, { "name":"proxyName", "in":"query", "description":"name of proxy", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ActorProxies" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "actor-proxy" ], "summary":"Creates an actor-proxy connection in the configuration.", "description":"Returns status for creation of an actor-proxy connection in the configuration.", "operationId":"postActorProxy", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"actorProxy", "description":"Actor Proxy connection", "required":true, "schema":{ "$ref":"#/definitions/ActorProxy" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor-proxy connection supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "actor-proxy" ], "summary":"Deletes an actor-proxy connection from the configuration.", "description":"Returns status for delete of an actor-proxy connection from the configuration.", "operationId":"deleteActorProxy", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"Name of actor", "required":true, "type":"string" }, { "name":"proxyName", "in":"query", "description":"Name of proxy", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor-proxy connection supplied" }, "404":{ "description":"Actor-Proxy connection not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/actors":{ "get":{ "tags":[ "actor" ], "summary":"Gets the list of all actors in the configuration.", "description":"Returns actor information for all actors in the configuration.", "operationId":"getAllActors", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"name of actor", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Actors" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "actor" ], "summary":"Creates an actor.", "description":"Returns status for creation of an actor in the configuration.", "operationId":"postActor", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"actor", "description":"Actor to create", "required":true, "schema":{ "$ref":"#/definitions/Actor" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "actor" ], "summary":"Updates an actor.", "description":"Returns status for update of an actor in the configuration.", "operationId":"putActor", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"Name of actor", "required":true, "type":"string" }, { "in":"body", "name":"newActor", "description":"New Actor", "required":true, "schema":{ "$ref":"#/definitions/Actor" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor supplied" }, "404":{ "description":"Actor not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "actor" ], "summary":"Deletes an actor from the configuration.", "description":"Returns status for delete of an actor from the configuration.", "operationId":"deleteActor", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"Name of actor", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid actor supplied" }, "404":{ "description":"Actor not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/configuration":{ "get":{ "tags":[ "analytics" ], "summary":"Get the DIVA Protect configuration settings.", "description":"Returns the DIVA Protect configuration settings.", "operationId":"getDIVAProtectConfiguration", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAProtectConfiguration" } } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "analytics" ], "summary":"Updates the DIVA Protect configuration settings.", "description":"Returns status for update of the DIVA Protect configuration settings.", "operationId":"putDIVAProtectConfiguration", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"newConfiguration", "description":"New Configuration", "required":true, "schema":{ "$ref":"#/definitions/DIVAProtectConfiguration" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid configuration supplied" }, "404":{ "description":"Configuration not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/configuration/events":{ "get":{ "tags":[ "analytics" ], "summary":"Gets the list of DIVA Protect event definitions in the configuration.", "description":"Returns DIVA Protect event definitions in the configuration.", "operationId":"getDIVAProtectEventDefinitions", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAProtectEventDefinitions" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/configuration/metrics":{ "get":{ "tags":[ "analytics" ], "summary":"Gets the list of DIVA Protect metric definitions in the configuration.", "description":"Returns DIVA Protect metric definitions in the configuration.", "operationId":"getDIVAProtectMetricDefinitions", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of metric", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAProtectMetricDefinitions" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "analytics" ], "summary":"Inserts a new DIVA Protect metric into the configuration. ", "description":"Returns status for insert of a new DIVA Protect metric definition.\nThe options for collectionType may be retrieved from /analytics/configuration/metrics/collection/types.\nThe options for collectionMetadataType may be retrieved from /analytics/configuration/metrics/collection/metadata.\nThe options for weightType may be retrieved from /analytics/configuration/metrics/collection/weights.\nThe options for collectedEvents may be retrieved from /analytics/configuration/metrics/collection/events.\nThe options for resourceType may be retrieved from /analytics/configuration/metrics/collection/types.\nThe options for collectionInterval may be retrieved from /analytics/configuration/metrics/aggregation/intervals.", "operationId":"postDIVAProtectMetricDefinition", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"newDefinition", "description":"New metric definition", "required":true, "schema":{ "$ref":"#/definitions/DIVAProtectMetricDefinition" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid metric supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "analytics" ], "summary":"Updates a DIVA Protect metric of the configuration.The options for collectionType may be retrieved from /analytics/configuration/metrics/collection/types.\nThe options for collectionMetadataType may be retrieved from /analytics/configuration/metrics/collection/metadata.\nThe options for weightType may be retrieved from /analytics/configuration/metrics/collection/weights.\nThe options for collectedEvents may be retrieved from /analytics/configuration/metrics/collection/events.\nThe options for resourceType may be retrieved from /analytics/configuration/metrics/collection/types.\nThe options for collectionInterval may be retrieved from /analytics/configuration/metrics/aggregation/intervals.", "description":"Returns status for update of the DIVA Protect metric definition of the configuration.", "operationId":"putDIVAProtectMetricDefinition", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of metric", "required":true, "type":"string" }, { "in":"body", "name":"newDefinition", "description":"New metric definition", "required":true, "schema":{ "$ref":"#/definitions/DIVAProtectMetricDefinition" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid metric supplied" }, "404":{ "description":"Metric not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "analytics" ], "summary":"Deletes a DIVA Protect metric definition from the configuration.", "description":"Returns status for delete of a DIVA Protect metric definition from the configuration.", "operationId":"deleteDIVAProtectMetricDefinition", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of DIVA Protect metric definition", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid DIVA Protect metric definition supplied" }, "404":{ "description":"DIVA Protect metric definition not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/configuration/metrics/aggregation/intervals":{ "get":{ "tags":[ "analytics" ], "summary":"Gets the list of DIVA Protect metric aggregation interval units in the configuration.", "description":"Returns DIVA Protect metric aggregation interval units in the configuration.", "operationId":"getDIVAProtectMetricAggregationIntervals", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAProtectStorageIntervalUnits" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/configuration/metrics/aggregation/resources":{ "get":{ "tags":[ "analytics" ], "summary":"Gets the list of DIVA Protect metric aggregation resource types in the configuration.", "description":"Returns DIVA Protect metric collection weights in the configuration.", "operationId":"getDIVAProtectMetricAggregationResourceTypes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAProtectMetricResourceTypes" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/configuration/metrics/collection/events":{ "get":{ "tags":[ "analytics" ], "summary":"Gets the list of DIVA Protect metric collection events in the configuration.", "description":"Returns DIVA Protect metric collection events in the configuration.", "operationId":"getDIVAProtectMetricCollectionEventDefinitions", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAProtectEventDictionary" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/configuration/metrics/collection/metadata":{ "get":{ "tags":[ "analytics" ], "summary":"Gets the list of DIVA Protect metric collection metadata in the configuration.", "description":"Returns DIVA Protect metric collection metadata in the configuration.", "operationId":"getDIVAProtectMetricCollectionMetadata", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAProtectEventParameters" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/configuration/metrics/collection/types":{ "get":{ "tags":[ "analytics" ], "summary":"Gets the list of DIVA Protect metric collection types in the configuration.", "description":"Returns DIVA Protect metric collection types in the configuration.", "operationId":"getDIVAProtectMetricCollectionTypes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAProtectMetricCollectionTypes" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/drives/alerts/logs":{ "get":{ "tags":[ "analytics" ], "summary":"Gets drive alert logs.", "description":"Returns list of drive alerts.", "operationId":"getDriveAlertLogs", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of page sort", "required":false, "type":"string", "enum":[ "alertId", "barcode", "date", "level", "message", "requestId", "serialNumber" ] }, { "name":"sortDirection", "in":"query", "description":"direction of page sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" }, { "name":"level", "in":"query", "description":"log level", "required":false, "type":"string", "enum":[ "INFORMATION", "WARNING", "CRITICAL", "UNKNOWN" ] }, { "name":"message", "in":"query", "description":"message", "required":false, "type":"string" }, { "name":"serialNumber", "in":"query", "description":"serial number", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"tape barcode", "required":false, "type":"string" }, { "name":"id", "in":"query", "description":"request id", "required":false, "type":"string" }, { "name":"startDateTime", "in":"query", "description":"start date & time as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"endDateTime", "in":"query", "description":"end date & time as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DriveAlertLogs" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/events":{ "get":{ "tags":[ "analytics" ], "summary":"Gets analytics events.", "description":"Returns list of analytics events.", "operationId":"getAnalyticsEvents", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort (uses Lexicographic Ordering for Strings)", "required":false, "type":"string", "enum":[ "ACTOR_NAME", "END_TIME", "TYPE" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"types", "in":"query", "description":"types of events (refer to /analytics/events/definitions for possible values)", "required":true, "type":"array", "items":{ "type":"integer", "format":"int32" }, "collectionFormat":"multi" }, { "name":"actorName", "in":"query", "description":"name of actor", "required":false, "type":"string" }, { "name":"startDateTime", "in":"query", "description":"start date & time as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"endDateTime", "in":"query", "description":"end date & time as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"errorCodes", "in":"query", "description":"error codes", "required":false, "type":"array", "items":{ "type":"integer", "format":"int32" }, "collectionFormat":"multi" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/AnalyticsEvents" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/events/definitions":{ "get":{ "tags":[ "analytics" ], "summary":"Gets the analytics event defintions list.", "description":"Returns a list of the analytics event defintions defined in DIVA Core.", "operationId":"getAnalyticsEventDefinitions", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/AnalyticsEventDefinitions" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/libraries/alerts/logs":{ "get":{ "tags":[ "analytics" ], "summary":"Gets library alert logs.", "description":"Returns list of library alerts.", "operationId":"getLibraryAlertLogs", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of page sort", "required":false, "type":"string", "enum":[ "alertId", "date", "level", "message", "serialNumber" ] }, { "name":"sortDirection", "in":"query", "description":"direction of page sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" }, { "name":"level", "in":"query", "description":"log level", "required":false, "type":"string", "enum":[ "INFORMATION", "WARNING", "CRITICAL", "UNKNOWN" ] }, { "name":"message", "in":"query", "description":"message", "required":false, "type":"string" }, { "name":"serialNumber", "in":"query", "description":"serial number", "required":false, "type":"string" }, { "name":"startDateTime", "in":"query", "description":"start date & time as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"endDateTime", "in":"query", "description":"end date & time as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/LibraryAlertLogs" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/tapes/operations/types":{ "get":{ "tags":[ "analytics" ], "summary":"Get list of tape operations.", "description":"Returns a list of tape operations.", "operationId":"getTapeOperations", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/PossibleTapeOperations" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Tape Operation not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/analytics/tapes/operations/view":{ "get":{ "tags":[ "analytics" ], "summary":"Gets a summary of the major tape operations.", "description":"Returns a summary containing the number of major tape operations.", "operationId":"getMajorTapeOperations", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorNames", "in":"query", "description":"actor names", "required":false, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }, { "name":"driveNames", "in":"query", "description":"drive names", "required":false, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }, { "name":"operations", "in":"query", "description":"operations", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "READ", "WRITE", "MOUNT", "DISMOUNT", "POSITIONING", "INSERT", "EJECT", "IMPORT", "EXPORT" ] }, "collectionFormat":"multi", "enum":[ "READ", "WRITE", "MOUNT", "DISMOUNT", "POSITIONING", "INSERT", "EJECT", "IMPORT", "EXPORT" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TapeOperations" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/arrays":{ "get":{ "tags":[ "array" ], "summary":"Gets the list of all arrays in the configuration.", "description":"Returns array information for all arrays in the configuration.", "operationId":"getAllArrays", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"arrayName", "in":"query", "description":"name of array", "required":false, "type":"string" }, { "name":"isCloud", "in":"query", "description":"isCloud", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DiskArrays" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "array" ], "summary":"Creates an array in the configuration.", "description":"Returns status for creation of an array in the configuration.", "operationId":"postArray", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"array", "description":"Array", "required":true, "schema":{ "$ref":"#/definitions/DiskArrayWODisks" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid array supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "array" ], "summary":"Updates an array in the configuration.", "description":"Returns status for update of an array in the configuration.", "operationId":"putArray", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"arrayName", "in":"query", "description":"Name of array", "required":false, "type":"string" }, { "in":"body", "name":"newArray", "description":"Array", "required":true, "schema":{ "$ref":"#/definitions/DiskArrayWODisks" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid array supplied" }, "404":{ "description":"Array not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "array" ], "summary":"Deletes an array from the configuration.", "description":"Returns status for delete of an array from the configuration.", "operationId":"deleteArray", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"arrayName", "in":"query", "description":"Name of array", "required":false, "type":"string" }, { "name":"cascadeDelete", "in":"query", "description":"Cascade Delete", "required":false, "type":"string", "default":"false" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid array supplied" }, "404":{ "description":"Array not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/configuration":{ "get":{ "tags":[ "configuration" ], "summary":"Get the DIVA Core configuration settings.", "description":"Returns the DIVA Core configuration settings.", "operationId":"getDIVAConfiguration", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAConfiguration" } } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "configuration" ], "summary":"Updates the DIVA Core configuration settings.", "description":"Returns status for update of the DIVA Core configuration settings.", "operationId":"putDIVAConfiguration", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"newConfiguration", "description":"New Configuration", "required":true, "schema":{ "$ref":"#/definitions/DIVAConfiguration" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid configuration supplied" }, "404":{ "description":"Configuration not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/configuration/ui":{ "get":{ "tags":[ "configuration" ], "summary":"Get the DIVA Core configuration (structured) settings.", "description":"Returns the DIVA Core configuration (structured) settings.", "operationId":"getDIVAConfiguration_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ConfigParameters" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/disks":{ "get":{ "tags":[ "disk" ], "summary":"Gets the list of all disks in the configuration.", "description":"Returns disk information for all disks in the configuration.", "operationId":"getAllDisks", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"diskName", "in":"query", "description":"name of disk", "required":false, "type":"string" }, { "name":"isCloud", "in":"query", "description":"isCloud", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"arrayName", "in":"query", "description":"name of array", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Disks" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "disk" ], "summary":"Creates a disk.", "description":"Returns status for creation of a disk. NOTE: disk id is ignored for POST.", "operationId":"postDisk", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"disk", "description":"Disk to create", "required":true, "schema":{ "$ref":"#/definitions/DiskForWrite" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid disk supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "disk" ], "summary":"Updates a disk in the configuration.", "description":"Returns status for update of a disk in the configuration.", "operationId":"putDisk", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"diskName", "in":"query", "description":"Name of disk", "required":false, "type":"string" }, { "in":"body", "name":"newDisk", "description":"Disk", "required":true, "schema":{ "$ref":"#/definitions/DiskForWrite" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid disk supplied" }, "404":{ "description":"Disk not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "disk" ], "summary":"Deletes a disk from the configuration.", "description":"Returns status for delete of a disk from the configuration.", "operationId":"deleteDisk", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"diskName", "in":"query", "description":"Name of disk", "required":false, "type":"string" }, { "name":"cascadeDelete", "in":"query", "description":"Cascade Delete", "required":false, "type":"string", "default":"false" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid disk supplied" }, "404":{ "description":"Disk not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/disks/scans":{ "get":{ "tags":[ "disk" ], "summary":"Get status of a scan disk service.", "description":"Returns the status of a scan disk service. If the service is NOT running, a state of STOPPED is returned. ", "operationId":"getScanDiskServiceStatus", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"diskName", "in":"query", "description":"Disk name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ScanDiskServiceInfo" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "disk" ], "summary":"Creates a scan disk service.", "description":"Creates a scan disk service. \nThis call returns as soon as the command to create a scan disk service is submitted. \n This means the state of the service MAY have a value of STOPPED. To get the updated \nstate, please call GET /disks/scans. ", "operationId":"postScanDiskService", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Request body needed to initiate the scan of a disk", "required":true, "schema":{ "$ref":"#/definitions/ScanDisk" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ScanDiskServiceInfo" } }, "404":{ "description":"Disk not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "disk" ], "summary":"Deletes a scan disk service.", "description":"Deletes a scan disk service. \nThis call returns as soon as the command to delete a scan disk service is submitted. This means the state of the service MAY have a value of RUNNING. To get the updated \nstate, please call GET /disks/scans. ", "operationId":"deleteScanDiskService", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"diskName", "in":"query", "description":"Disk name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ScanDiskServiceInfo" } }, "404":{ "description":"Disk not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/disks/scans/events":{ "get":{ "tags":[ "disk" ], "summary":"Get all scan disk events.", "description":"Returns all scan disk events.", "operationId":"getScanDiskEvents", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"scanId", "in":"query", "description":"Scan identifier", "required":false, "type":"integer", "format":"int32" }, { "name":"serviceId", "in":"query", "description":"Service identifier", "required":false, "type":"integer", "format":"int32" }, { "name":"diskName", "in":"query", "description":"Disk name", "required":false, "type":"string", "default":"*" }, { "name":"actorName", "in":"query", "description":"Actor name", "required":false, "type":"string", "default":"*" }, { "name":"objectName", "in":"query", "description":"Object name", "required":false, "type":"string", "default":"*" }, { "name":"category", "in":"query", "description":"Category", "required":false, "type":"string", "default":"*" }, { "name":"description", "in":"query", "description":"Description", "required":false, "type":"string", "default":"*" }, { "name":"severity", "in":"query", "description":"Severity of event", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "INFORMATION", "WARNING", "ERROR", "CRITICAL" ] }, { "name":"type", "in":"query", "description":"Scan Disk Type", "required":false, "type":"string", "enum":[ "AXF_SCAN", "AXF_INDEXING" ] }, { "name":"eventType", "in":"query", "description":"Scan Disk Event Type", "required":false, "type":"string", "default":"ALL", "enum":[ "START", "STOP", "RESOURCE_SELECTION", "SERVICE", "SCAN_STATISTICS", "INSTANCE_PERSISTED", "INSTANCE_NOT_PERSISTED", "ALL" ] }, { "name":"eventStartDateTime", "in":"query", "description":"Event Start Date Time as epoch time in seconds", "required":false, "type":"integer", "format":"int64" }, { "name":"eventEndDateTime", "in":"query", "description":"Event End Date Time as epoch time in seconds", "required":false, "type":"integer", "format":"int64" }, { "name":"lastScanStartDateTime", "in":"query", "description":"Last Scan Start Date Time as epoch time in seconds", "required":false, "type":"integer", "format":"int64" }, { "name":"lastScanEndDateTime", "in":"query", "description":"Last Scan End Date Time as epoch time in seconds", "required":false, "type":"integer", "format":"int64" }, { "name":"page", "in":"query", "description":"Page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"Size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ScanDiskEvents" } }, "400":{ "description":"Invalid ID supplied" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/drives":{ "get":{ "tags":[ "drive" ], "summary":"Gets the list of all drives in the configuration.", "description":"Returns drive information for all drives in the configuration.", "operationId":"getAllDrives", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"driveName", "in":"query", "description":"Name of drive", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Drives" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "drive" ], "summary":"Synchronize drives from a specified robot or all robots if nothing is specified.", "description":"Returns status for synchronization of drives of a robot or all robots if nothing is specified.", "operationId":"postDrivesOfRobot", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"robotForSyncDb", "description":"Robot from which to create drives", "required":true, "schema":{ "$ref":"#/definitions/RobotForSyncDB" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid robot name supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "drive" ], "summary":"Updates a drive in the configuration.", "description":"Returns status for update of a drive in the configuration.", "operationId":"putDrive", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"driveName", "in":"query", "description":"Name of drive", "required":true, "type":"string" }, { "in":"body", "name":"newDrive", "description":"Drive", "required":true, "schema":{ "$ref":"#/definitions/Drive" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid drive supplied" }, "404":{ "description":"Drive not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "drive" ], "summary":"Deletes a drive.", "description":"Returns status for delete of a drive from the configuration.", "operationId":"deleteDrive", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"driveName", "in":"query", "description":"Name of Drive", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid drive supplied" }, "404":{ "description":"Drive not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/drives/multi":{ "put":{ "tags":[ "drive" ], "summary":"Updates multiple drives in the configuration at once.", "description":"Returns status for update of all specified drives in the configuration.", "operationId":"putDrives", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"newDrives", "description":"Drives", "required":true, "schema":{ "$ref":"#/definitions/MultiDrives" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid drive supplied" }, "404":{ "description":"Drive not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/drives/types":{ "get":{ "tags":[ "drive" ], "summary":"Gets the list of all drive types in the configuration.", "description":"Returns drive information for all drive types in the configuration.", "operationId":"getAllDriveTypes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"name of drive type", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DriveTypes" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "drive" ], "summary":"Synchronizes drive types from all robots in the configuration.", "description":"Returns status for creation of drive types of all robots in the configuration. Name is used to match against the drive types found in all robots. The ID is ignored if specified. Only types found in robot manager are added. User must provide block size for each type found in the robot manager. Types found in the robot manager but missing from the body and types provided in the body but not found in the robot manager will both be skipped.", "operationId":"postDriveTypesOfRobots", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"driveTypes", "description":"Drive types to synchronize from all robots", "required":false, "schema":{ "$ref":"#/definitions/DriveTypesBody" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid drive types supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "drive" ], "summary":"Deletes a drive type from the configuration.", "description":"Returns status for delete of a drive type from the configuration.", "operationId":"deleteDriveType", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of Drive type", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid drive type supplied" }, "404":{ "description":"Drive type not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/drives/types/missing":{ "get":{ "tags":[ "drive" ], "summary":"Gets the list of all missing (not yet configured) drive types in the configuration.", "description":"Returns drive information for all missing (not yet configured) drive types in the configuration.", "operationId":"getAllMissingDriveTypes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DriveTypes" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/events":{ "get":{ "tags":[ "event" ], "summary":"Get events.", "description":"Returns all events.", "operationId":"getAllEvents", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"type", "in":"query", "description":"type of event", "required":true, "type":"string", "default":"REQUEST", "enum":[ "REQUEST", "CONFIG_NOTIFICATION", "DB_BACKUP", "DB_BACKUPS_TAPES_LIST", "MDS_ONLINE", "MDS_OFFLINE", "MDS_MONGODB_ONLINE", "MDS_MONGODB_OFFLINE", "MDS_SOLR_ONLINE", "MDS_SOLR_OFFLINE" ] }, { "name":"requestId", "in":"query", "description":"request identifier (only needed if type is REQUEST)", "required":false, "type":"integer", "format":"int32" }, { "name":"severity", "in":"query", "description":"severity of event", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "INFORMATION", "WARNING", "ERROR", "CRITICAL" ] }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Events" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Request not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "event" ], "summary":"Add an event to DIVA Core.", "description":"Returns status for creation of an event in DIVA Core.", "operationId":"postEvent", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"event", "description":"Event to create", "required":true, "schema":{ "$ref":"#/definitions/DIVAEvent" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid event supplied" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/groups":{ "get":{ "tags":[ "group" ], "summary":"Gets the list of all tape groups in the configuration.", "description":"Returns group information for all tape groups in the configuration.", "operationId":"getAllGroups", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"groupName", "in":"query", "description":"name of group", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Groups" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "group" ], "summary":"Create a tape group in the configuration.", "description":"Returns status for creation of a tape group in the configuration.", "operationId":"postGroup", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"notifyManager", "in":"query", "description":"Notify manager", "required":false, "type":"boolean", "default":false }, { "in":"body", "name":"group", "description":"Group to create", "required":true, "schema":{ "$ref":"#/definitions/Group" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid group supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "group" ], "summary":"Update a tape group in the configuration.", "description":"Returns status for update of a tape group in the configuration.", "operationId":"putGroup", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"groupName", "in":"query", "description":"Name of group to update", "required":true, "type":"string" }, { "in":"body", "name":"newGroup", "description":"New Group", "required":true, "schema":{ "$ref":"#/definitions/Group" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid group supplied" }, "404":{ "description":"Group not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "group" ], "summary":"Deletes a group from the configuration.", "description":"Returns status for delete of a group from the configuration.", "operationId":"deleteGroup", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"notifyManager", "in":"query", "description":"Notify manager", "required":false, "type":"boolean", "default":false }, { "name":"groupName", "in":"query", "description":"Name of group", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid group supplied" }, "404":{ "description":"Group not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/license":{ "get":{ "tags":[ "license" ], "summary":"Gets active license information.", "description":"Returns current active license information.", "operationId":"getLicense", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/License" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/licenseHistories":{ "get":{ "tags":[ "license" ], "summary":"Gets the list of all licenses.", "description":"Returns information for all licenses in the database.", "operationId":"getAllLicenses", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"id", "in":"query", "description":"license id", "required":false, "type":"integer", "format":"int32" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/LicenseHistories" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "license" ], "summary":"Imports a license.", "description":"Returns status for import of a license.", "operationId":"postLicense", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"license", "description":"License to import", "required":true, "schema":{ "$ref":"#/definitions/LicenseInput" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid license supplied" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/media/compatibilities":{ "get":{ "tags":[ "media" ], "summary":"Gets the list of all media compatibilities in the configuration.", "description":"Returns media compatibility information for all media compatibilities in the configuration.", "operationId":"getAllMediaCompatibilities", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"mediaType", "in":"query", "description":"name of media type", "required":false, "type":"string" }, { "name":"driveType", "in":"query", "description":"name of drive type", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MediaCompatibilities" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "media" ], "summary":"Synchronizes media compatibilities from all robots.", "description":"Returns status for the creation of media compatibilities of all robots.", "operationId":"postMediaCompatibility", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid media compatibility supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "media" ], "summary":"Updates a media compatibility in the configuration.", "description":"Returns status for update of a media compatibility in the configuration.", "operationId":"putMediaCompatibility", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"mediaType", "in":"query", "description":"Name of media compatibility", "required":true, "type":"string" }, { "name":"driveType", "in":"query", "description":"Name of drive type", "required":true, "type":"string" }, { "in":"body", "name":"newMediaCompatibility", "description":"New Media compatibility", "required":true, "schema":{ "$ref":"#/definitions/MediaCompatibility" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid media compatibility supplied" }, "404":{ "description":"Media compatibility not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "media" ], "summary":"Deletes a media compatibility from the configuration.", "description":"Returns status for delete of a media compatibility from the configuration.", "operationId":"deleteMediaCompatibility", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"mediaType", "in":"query", "description":"Name of media type", "required":true, "type":"string" }, { "name":"driveType", "in":"query", "description":"Name of drive type", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid media compatibility supplied" }, "404":{ "description":"Media compatibility not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/media/mappings":{ "get":{ "tags":[ "media" ], "summary":"Gets the list of all media mappings in the configuration.", "description":"Returns media mapping information for all media mappings in the configuration.", "operationId":"getAllMediaMappings", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"mediaMappingName", "in":"query", "description":"name of media mapping", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MediaMappings" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "media" ], "summary":"Creates a media mapping in the configuration.", "description":"Returns status for creation of a media mapping in the configuration.", "operationId":"postMediaMapping", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"mediaMapping", "description":"Media mapping to create", "required":true, "schema":{ "$ref":"#/definitions/MediaMapping" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid media mapping supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "media" ], "summary":"Updates a media mapping in the configuration.", "description":"Returns status for update of an media mapping in the configuration.", "operationId":"putMediaMapping", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"mediaMappingName", "in":"query", "description":"Name of media mapping to update", "required":true, "type":"string" }, { "in":"body", "name":"newMediaMapping", "description":"New Media mapping", "required":true, "schema":{ "$ref":"#/definitions/MediaMapping" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid media mapping supplied" }, "404":{ "description":"Media mapping not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "media" ], "summary":"Deletes a media mapping from the configuration.", "description":"Returns status for delete of a media mapping from the configuration.", "operationId":"deleteMediaMapping", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"mediaMappingName", "in":"query", "description":"Name of media mapping to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid media mapping supplied" }, "404":{ "description":"Media mapping not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects":{ "put":{ "tags":[ "object" ], "summary":"Assign a storage plan to a list of objects.", "description":"Assigns a storage plan to a list of objects. ", "operationId":"updateObject", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Defintion of update to object", "required":true, "schema":{ "$ref":"#/definitions/UpdateObjectBody" } } ], "responses":{ "200":{ "description":"Assigned a storage plan", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } }, "404":{ "description":"Object(s) not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects/byFilename":{ "get":{ "tags":[ "object" ], "summary":"Retrieves the object list by filename.", "description":"Returns the object list by file name.", "operationId":"getByFilename", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"fileName", "in":"query", "description":"Name of file", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection (category)", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ObjectListByFileNameResponse2" } }, "400":{ "description":"Invalid filename supplied" }, "404":{ "description":"File name not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects/files":{ "delete":{ "tags":[ "object" ], "summary":"Deletes a file.", "description":"Returns status for delete of a file.", "operationId":"deleteFile", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"fileName", "in":"query", "description":"Name of file to delete", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection (category)", "required":true, "type":"string" }, { "name":"filter", "in":"query", "description":"Filter", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DeleteFileStatus" } }, "400":{ "description":"Invalid file supplied" }, "404":{ "description":"File not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects/files/byCollectionMask":{ "delete":{ "tags":[ "object" ], "summary":"Delete a file by collection (category) mask.", "description":"Returns status for delete of a file.", "operationId":"deleteFileByCollectionMask", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"fileName", "in":"query", "description":"Name of file to delete", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection (category)", "required":true, "type":"string" }, { "name":"filter", "in":"query", "description":"Filter", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DeleteFileForCategoryMaskStatus" } }, "400":{ "description":"Invalid file supplied" }, "404":{ "description":"File not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects/filesAndFolders":{ "get":{ "tags":[ "object" ], "summary":"Retrieves the names of the files and folders for the specified object from DIVA Core. You set the startIndex to zero to get all of the file and folder names for an object. A list of names of the specified size is returned.", "description":"Returns the file and folders list for an object.", "operationId":"requireObject", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"objectName", "in":"query", "description":"Name of object", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection (category)", "required":true, "type":"string" }, { "name":"listType", "in":"query", "description":"List type (0=Files, 1=Folders, 2=All)", "required":true, "type":"integer", "format":"int32", "enum":[ 0, 1, 2 ] }, { "name":"startIndex", "in":"query", "description":"Start index", "required":false, "type":"integer", "default":1, "maximum":1000, "minimum":0, "format":"int32" }, { "name":"batchSize", "in":"query", "description":"Batch size", "required":false, "type":"integer", "default":5, "maximum":1000, "minimum":0, "format":"int32" }, { "name":"options", "in":"query", "description":"Options", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/FilesAndFolders" } }, "400":{ "description":"Invalid object supplied" }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects/info":{ "get":{ "tags":[ "object" ], "summary":"Gets object information for a specfic object.", "description":"Returns object information for a specfic object.", "operationId":"getInfo", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"objectName", "in":"query", "description":"Name of object", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ObjectInformation" } }, "400":{ "description":"Invalid object supplied" }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects/link":{ "get":{ "tags":[ "object" ], "summary":"Gets linked objects for a specified object.\nIf you want to get all child objects of the specified object, set children=true.\nIf you want to get parents, set children=false.\nSetting BOTH Cascade Delete and Cascade Restore to true will ONLY return objects that are linked in BOTH ways.\nIf you want to get all objects linked by delete OR restore, you must retrieve the lists separately.", "description":"Returns linked objects.", "operationId":"getLinkedObjects", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"objectName", "in":"query", "description":"Name of object", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection", "required":true, "type":"string" }, { "name":"children", "in":"query", "description":"Children", "required":false, "type":"boolean", "default":true }, { "name":"cascadeDelete", "in":"query", "description":"Cascade Delete", "required":false, "type":"boolean", "default":true }, { "name":"cascadeRestore", "in":"query", "description":"Cascade Restore", "required":false, "type":"boolean", "default":true } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/LinkedObjects" } }, "400":{ "description":"Invalid filters supplied" }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "object" ], "summary":"Links the specified parent object to the specified child object.", "description":"Returns status for link of an object.", "operationId":"linkObject", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"parentObjectName", "in":"query", "description":"Name of parent object", "required":true, "type":"string" }, { "name":"parentCollectionName", "in":"query", "description":"Name of parent collection", "required":true, "type":"string" }, { "name":"childObjectName", "in":"query", "description":"Name of child object", "required":true, "type":"string" }, { "name":"childCollectionName", "in":"query", "description":"Name of child collection", "required":true, "type":"string" }, { "name":"cascadeDelete", "in":"query", "description":"Cascade Delete", "required":false, "type":"boolean" }, { "name":"cascadeRestore", "in":"query", "description":"Cascade Restore", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid object supplied" }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects/list":{ "get":{ "tags":[ "object" ], "summary":"Gets object information for all objects based on filter criteria.", "description":"Returns object information for objects.", "operationId":"getDetailslist", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"initialTime", "in":"query", "description":"Initial Time", "required":true, "type":"integer", "format":"int32" }, { "name":"listType", "in":"query", "description":"List Type", "required":true, "type":"integer", "format":"int32" }, { "name":"objectsListType", "in":"query", "description":"Objects List Type", "required":true, "type":"integer", "format":"int32" }, { "name":"maxListSize", "in":"query", "description":"Maximum List Size", "required":true, "type":"integer", "format":"int32" }, { "name":"objectName", "in":"query", "description":"Name of object", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection", "required":true, "type":"string" }, { "name":"mediaName", "in":"query", "description":"Name of media", "required":true, "type":"string" }, { "name":"levelOfDetail", "in":"query", "description":"Level of detail", "required":true, "type":"integer", "format":"int32" }, { "name":"listPosition", "in":"query", "description":"List Position", "required":false, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ObjectDetailsList" } }, "400":{ "description":"Invalid filters supplied" }, "404":{ "description":"Objects not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects/locks":{ "post":{ "tags":[ "object" ], "summary":"Lock or Unlock the specified object, by enabling or disabling an object lock.", "description":"Returns status for lock/unlock of an object.", "operationId":"lockObject", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"objectName", "in":"query", "description":"Name of object", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection (category)", "required":true, "type":"string" }, { "name":"options", "in":"query", "description":"Options", "required":false, "type":"string" }, { "name":"enable", "in":"query", "description":"Enable", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid object supplied" }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/objects/requirements":{ "post":{ "tags":[ "object" ], "summary":"Require or Release the specified object by enabling/disabling a requirement for the object.", "description":"Returns status for require/release of an object.", "operationId":"requireObject_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"objectName", "in":"query", "description":"Name of object", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection (category)", "required":true, "type":"string" }, { "name":"instanceID", "in":"query", "description":"Instance Identiier", "required":false, "type":"integer", "format":"int32" }, { "name":"enable", "in":"query", "description":"Enable", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid object supplied" }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/productionSystems":{ "get":{ "tags":[ "productionSystem" ], "summary":"Gets the list of all production systems in the configuration.", "description":"Returns production system information for all production systems in the configuration.", "operationId":"getAllProductionSystems", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"productionSystemName", "in":"query", "description":"name of production system", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ProductionSystems" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "productionSystem" ], "summary":"Creates a production system in the configuration.", "description":"Returns status for creation of a production system in the configuration.", "operationId":"postProductionSystem", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"productionSystem", "description":"Production System to create", "required":true, "schema":{ "$ref":"#/definitions/ProductionSystem" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid production system supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "productionSystem" ], "summary":"Updates a production system in the configuration.", "description":"Returns status for update of a production system in the configuration.", "operationId":"putProductionSystem", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"productionSystemName", "in":"query", "description":"Name of production system to update", "required":true, "type":"string" }, { "in":"body", "name":"newProductionSystem", "description":"New Production System", "required":true, "schema":{ "$ref":"#/definitions/ProductionSystem" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid production system supplied" }, "404":{ "description":"Production System not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "productionSystem" ], "summary":"Deletes a production system from the configuration.", "description":"Returns status for delete of a production system from the configuration.", "operationId":"deleteProductionSystem", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"productionSystemName", "in":"query", "description":"Name of production system to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid production system supplied" }, "404":{ "description":"Production System not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests":{ "get":{ "tags":[ "request" ], "summary":"List all requests.", "description":"Returns a list of requests.", "operationId":"getRequests", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort (uses Lexicographic Ordering for Strings)", "required":false, "type":"string", "enum":[ "ID", "TYPE", "STATE", "COMPLETION_DATE", "SUBMISSION_DATE" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"type", "in":"query", "description":"type of request", "required":false, "type":"string", "enum":[ "Archive", "Restore", "Delete", "Eject", "Insert", "Copy to group/media", "Copy As", "Restore instance", "Delete instance", "UNKNOWN", "Automatic Repack", "Manual Repack", "Associative Copy", "Partial Restore", "Partial Restore Instance", "Multiple Restore", "Transcode Archive", "Export", "Transfer", "Manual Verify Tapes", "Clone Tapes", "Server Delete", "Stage" ] }, { "name":"states", "in":"query", "description":"states of request", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "Pending", "Transferring", "Migrating", "Completed", "Aborted", "Cancelled", "UNKNOWN", "Deleting", "Waiting for resources", "Waiting for operator", "Assigning pool", "Partially Aborted", "Running" ] }, "collectionFormat":"multi", "enum":[ "Pending", "Transferring", "Migrating", "Completed", "Aborted", "Cancelled", "UNKNOWN", "Deleting", "Waiting for resources", "Waiting for operator", "Assigning pool", "Partially Aborted", "Running" ] }, { "name":"startDateTime", "in":"query", "description":"start completion date & time as yyyy-MM-dd HH:mm:ss in UTC - only used for requests with state; Completed, Aborted, Partially Aborted and Cancelled", "required":false, "type":"string" }, { "name":"endDateTime", "in":"query", "description":"end completion date & time as yyyy-MM-dd HH:mm:ss in UTC - only used for requests with state; Completed, Aborted, Partially Aborted and Cancelled", "required":false, "type":"string" }, { "name":"requestIds", "in":"query", "description":"request identifiers", "required":false, "type":"array", "items":{ "type":"integer", "format":"int32" }, "collectionFormat":"multi" }, { "name":"objectName", "in":"query", "description":"object name", "required":false, "type":"string" }, { "name":"collectionName", "in":"query", "description":"collection name", "required":false, "type":"string" }, { "name":"serverName", "in":"query", "description":"server name", "required":false, "type":"string" }, { "name":"sourceTape", "in":"query", "description":"source tape", "required":false, "type":"string" }, { "name":"thirdPartyId", "in":"query", "description":"third party id", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Requests" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/archive":{ "post":{ "tags":[ "request" ], "summary":"Creates an archive request.", "description":"Submits an archive request to the DIVA Core Manager. \nThis call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postArchiveRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Archive Request to create", "required":true, "schema":{ "$ref":"#/definitions/ArchiveRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/associativeCopy":{ "post":{ "tags":[ "request" ], "summary":"Creates an associative copy request", "description":"Submits a request for creating new instances in the group (specified by group). DIVA Core guarantees that these instances are stored sequentially on tapes: \n - The request is completed only when every object is copied to the same tape. \n - In the case of drive or tape failure during a write operation, instances currently written are erased and the request is retried once.\n - The choice of the tape to be used for the copy follows the policy used for the archive operation (written tapes with enough remaining size regardless of optimizations).\n - Associative Copy does not span tapes - the request terminates (and is retried once) instead of spanning. The request terminates if the sum of the size of the objects to copy exceeds the capacity of every individual tape present in the library. \nThis call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postAssociativeCopyRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Associative Copy Request to create", "required":true, "schema":{ "$ref":"#/definitions/AssociativeCopyRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/automaticRepack":{ "get":{ "tags":[ "request" ], "summary":"Get Automatic Repack parameters.", "description":"Returns the list of automatic repack parameters.", "operationId":"getAutomaticRepackParameters", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/AutomaticRepackSettings" } } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "request" ], "summary":"Enable Automatic Repack", "description":"Enable or disable the automatic repack scheduling in the DIVA Core Manager. When the automatic repack scheduling is enabled.", "operationId":"putAutomaticRepack", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Settings", "required":true, "schema":{ "$ref":"#/definitions/AutomaticRepackSettings" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/cancel":{ "post":{ "tags":[ "request" ], "summary":"Cancel the specified request", "description":"Submits a Cancel operation to the DIVArchive Manager.This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"cancelRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"requestId", "in":"query", "description":"Request Id (A number identifying the request to be canceled)", "required":true, "type":"integer", "format":"int32" }, { "name":"options", "in":"query", "description":"Options", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/cloneTape":{ "post":{ "tags":[ "request" ], "summary":"Creates a clone tape request", "description":"Submits a clone tape request to the DIVA Core Manager. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postCloneTapeRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Clone Tape Request to create", "required":true, "schema":{ "$ref":"#/definitions/CloneTapeRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/copyToGroup":{ "post":{ "tags":[ "request" ], "summary":"Creates a copy to group request.", "description":"Submits a New Instance Creation request on the media specified by mediaName to the DIVA Core Manager, and the Manager chooses the appropriate instance to be created. The request will fail if the requested object is on media that is not available.This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postCopyToGroupRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Copy to group Request to create", "required":true, "schema":{ "$ref":"#/definitions/CopyToGroupRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/copyToNew":{ "post":{ "tags":[ "request" ], "summary":"Creates a copy to new object request", "description":"Submits a request for copying an archived object to a new object, with another name or category, to the DIVA Core Manager. The Manager chooses the appropriate instance as the source of the copy. The request will fail if the requested object is on an unavailable media. All types of transfers (disk to disk, disk to tape, tape to disk, and tape to tape) are supported. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postCopyToNewRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Copy to new object request to create", "required":true, "schema":{ "$ref":"#/definitions/CopyToNewRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/delete":{ "post":{ "tags":[ "request" ], "summary":"Creates a delete request", "description":"Submits an Object Delete Request to the DIVA Core Manager. The Manager deletes the specified instance OR every instance of the object if the instance is -1. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postDeleteRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Delete Request to create", "required":true, "schema":{ "$ref":"#/definitions/DeleteRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "404":{ "description":"Instance not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/ejectTape":{ "post":{ "tags":[ "request" ], "summary":"Creates an eject tape request", "description":"Submits an Eject Request to the DIVA Core Manager. The request completes when the specified tapes are outside of the library. If at least one of the tapes does not exist, is already ejected, or currently in use by another request, an error is returned and no tapes are ejected.This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postEjectTapeRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Eject Tape Request to create", "required":true, "schema":{ "$ref":"#/definitions/EjectTapeRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/exportTape":{ "post":{ "tags":[ "request" ], "summary":"Creates an export tape request", "description":"Submits an export tape request to the DIVA Core Manager. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postExportTapeRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Export Tape Request to create", "required":true, "schema":{ "$ref":"#/definitions/ExportTapeRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/exportTapes":{ "get":{ "tags":[ "request" ], "summary":"Gets export tapes information for an a subsequent export request.", "description":"Returns export tapes information.", "operationId":"getExportTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcodes", "in":"query", "description":"barcodes", "required":false, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ExportTapes" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/finished":{ "get":{ "tags":[ "request" ], "summary":"Get finished requests", "description":"Returns list of finished requests. \nGet all of the finished requests starting from the specified number of seconds before the present. Finished requests are requests that have completed normally or were terminated. \nUse this function as follows: \nIf the list of requests to be processed is greater than the batch size, make successive calls. The first time the function is called, set initialTime to the desired number of seconds earlier, where the list is to start. The maximum is three days. For successive calls set initialTime to zero and set the uniqueId to the value returned by the previous call. The returned list will be empty after all of the requests have been returned.", "operationId":"getFinished", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"batchSize", "in":"query", "description":"The maximum size of the returned list of objects. This must be set to a value no greater than 1000; the recommended setting is 500. This is only a suggestion and may be overridden by the underlying functionality. This parameter should not be used to guarantee that the list will be a certain size.", "required":true, "type":"integer", "format":"int32" }, { "name":"initialTime", "in":"query", "description":"The first time the function is called this value defines how far back in time to go to look for finished requests. Requests that have finished between this time and the present will be retrieved. The valid range for this parameter is 1 to 259200 (three days). If the number of requests to be returned is greater than the batch size, the call is repeated. For these calls this parameter should be set to zero (0).", "required":true, "type":"integer", "format":"int32" }, { "name":"uniqueId", "in":"query", "description":"The first time the function is called this value must be set to an empty string. If the number of request to be returned is greater than the batch size, the call is repeated. For these calls this value should be set to the uniqueId that was returned by the previous call.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/FinishedRequests" } }, "400":{ "description":"Invalid filter supplied" }, "404":{ "description":"Requests not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/importTape":{ "post":{ "tags":[ "request" ], "summary":"Creates a Diva tape import request", "description":"Submits an import tape request to the DIVA Core Manager. Imports one or multiple exported tape metadata file or files. The file paths must exist in a location that the DIVA manager service can access. This call returns after the operation is completed. The status in the response body indicates if the operation was successful.", "operationId":"postImportTapeRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Import Tape Request to create", "required":true, "schema":{ "$ref":"#/definitions/ImportTapeRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/insertTape":{ "post":{ "tags":[ "request" ], "summary":"Creates an insert tape request", "description":"Submits an Insert request to the DIVA Core Manager. This request completes when the operator has entered the requested tapes into the library. The application is responsible for managing which tapes must be entered.This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postInsertTapeRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Insert Tape Request to create", "required":true, "schema":{ "$ref":"#/definitions/InsertTapeRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/metadataMigration":{ "post":{ "tags":[ "request" ], "summary":"Metadata DB Migration", "description":"Submits a request to migrate Meta Database. Migrates one or multiple metadata file or files. This call returns after the operation is completed. For new request the requestID and The status in the response body indicates if the operation was successful.", "operationId":"postDBMigrationRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Migrate file base metadata", "required":false, "schema":{ "$ref":"#/definitions/DBMigrationRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } }, "500":{ "description":"Internal Exception", "schema":{ "$ref":"#/definitions/Status" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/multipleRestore":{ "post":{ "tags":[ "request" ], "summary":"Creates a multiple restore request.", "description":"Submits an object Restore request to the DIVA Core Manager using several destinations. The DIVA Core Manager chooses the appropriate instance to be restored. The request will continue even if an error occurs with one of the destinations. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postMultipleRestoreRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"N-Restore Request to create", "required":true, "schema":{ "$ref":"#/definitions/NRestoreRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/partialRestore":{ "post":{ "tags":[ "request" ], "summary":"Creates a partial restore request.", "description":"Submits a Partial Object Restore request to the DIVArchive Manager and the Manager chooses the appropriate instance to be restored. If the request was not accepted (for example, if the requested object is on media not currently available) the request will generate an error. The Manager will use the instanceID field to select the instance of the object to use for the Partial Restore operation. The Manager will choose an appropriate instance to restore if -1 is used. DIVA Core supports four types of Partial Restore (bytes, timecode (DIVA_FORMAT_VIDEO_*), files and folders and DPX). \n The default QOS is the default QOS of the server. If a default QOS is not specified for the server, then DIRECT AND CACHE is used. \nThis call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postPartialRestoreRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Partial Restore Request to create", "required":true, "schema":{ "$ref":"#/definitions/PartialRestoreRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/partialRestore/{requestId}":{ "get":{ "tags":[ "request" ], "summary":"Get partial restore offsets by request identifier", "description":"Returns partial restore offsets for a completed request. \nIf the format for the offsets was specified as timecodes, the offsets that are actually used may differ (somewhat) from what was specified in the request. Once the DIVA Core Partial File Restore request is complete, you can use this command to obtain the actual offsets of the restored files. This is a special purpose command that is valid only as follows: \n- The request number to be queried must be a partial file restore request that has been successfully completed. \n- The format specified in the partial file restore request may be a binary or timecode type. This command is therefore not valid when the format of the request was folder-based or DPX. \n", "operationId":"getPartialRestoreRequestById", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"requestId", "in":"path", "description":"requestId", "required":true, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/PartialRestoreOffsets" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Request not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/repackTape":{ "post":{ "tags":[ "request" ], "summary":"Creates an repack tape request", "description":"Submits a repack tape request to the DIVA Core Manager. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postRepackTapeRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Repack Tape Request to create", "required":true, "schema":{ "$ref":"#/definitions/RepackTapeRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/restore":{ "post":{ "tags":[ "request" ], "summary":"Creates a restore request.", "description":"Submits an Object Restore request to the DIVA Core Manager and the Manager chooses the appropriate instance to be restored. If the requested object is on media that is not available, the request will fail.This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postRestoreRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Restore Request to create", "required":true, "schema":{ "$ref":"#/definitions/RestoreRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/serverDelete":{ "post":{ "tags":[ "request" ], "summary":"Creates a server delete request", "description":"Submits an Server Delete Request to the DIVA Core Manager.", "operationId":"postServerDeleteRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Server Delete Request to create", "required":true, "schema":{ "$ref":"#/definitions/ServerDeleteRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/stage":{ "post":{ "tags":[ "request" ], "summary":"Creates a stage request.", "description":"Submits a Stage request to the media specified by targetMedia. The request will fail if the requested object is on media that is not available.This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postStageRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Stage Request to create", "required":true, "schema":{ "$ref":"#/definitions/StageRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/transcodeArchive":{ "post":{ "tags":[ "request" ], "summary":"Creates a transcode archive request", "description":"Submits a TranscodeArchive request to the DIVA Core Manager. The original object will be restored to the local Actor cache, then transcoded to the format defined in the option field. A new object containing the transcoded clip will then be archived back to DIVA Core. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postTranscodeArchiveRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Transcode Archive Request to create", "required":true, "schema":{ "$ref":"#/definitions/TranscodeArchiveRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/transferFiles":{ "post":{ "tags":[ "request" ], "summary":"Creates a transfer files request", "description":"Submits a Transfer files request to the DIVA Core Manager. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postTransferFilesRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Transfer Files Request to create", "required":true, "schema":{ "$ref":"#/definitions/TransferRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/verifyTape":{ "post":{ "tags":[ "request" ], "summary":"Creates a verify tape request", "description":"Submits a verify tape request to the DIVA Core Manager. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"postVerifyTapeRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Verify Tape Request to create", "required":true, "schema":{ "$ref":"#/definitions/VerifyTapeRequestBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/RequestStatus" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/RequestStatus" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/{id}/properties":{ "get":{ "tags":[ "request" ], "summary":"Get properties for a specified request.", "description":"Returns properties for a single request. \n\n\n\n The response body for an archive request will appear as follows: \n\n {\n\n \t\"id\": 3, \n\n \t\"properties\": { \n\n \t\"additionalServices\": \"None\", \n\n \t\"comments\": \"\", \n\n \t\"qos\": \"Direct Only\", \n\n \t\"options\": \"-gcinfilelist MD5\", \n\n \t\"files\": \"op1a-mpeg2-wave_hd.mxf\", \n\n \t\"source\": \"sourcedest\", \n\n \t\"media\": \"divagrid\", \n\n \t\"filePathRoot\": \"random\" } \n\n \n\n } \n\n \n\n The response body for a restore request will appear as follows: \n\n {\n\n \t\"id\": 4, \n\n \t\"properties\": { \n\n \t\"additionalServices\": \"None\", \n\n \t\"qos\": \"Direct and Cache\", \n\n \t\"destination\": \"sourcedest\", \n\n \t\"instance\": 0, \t\"filePathRoot\": \"random\" } \n\n \n\n } \n\n \n\n The response body for a copy to group request will appear as follows: \n\n {\n\n \t\"id\": 5, \n\n \t\"properties\": { \n\n \t\"instance\": 0, \t\"media\": \"sourcedest\" } \n\n \n\n } \n\n \n\n The response body for a delete instance request will appear as follows: \n\n {\n\n \t\"id\": 6, \n\n \t\"properties\": { \n\n \t\"instance\": 0 } \n\n \n\n } \n\n \n\n The response body for a copy to new object request will appear as follows: \n\n {\n\n \t\"id\": 6, \n\n \t\"properties\": { \n\n \t\"media\": \"default\" \n\n \t\"comments\": \"\" \n\n \t\"options\": \"\" } \n\n \n\n } \n\n \n\n The response body for a repack / clone request request will appear as follows: \n\n {\n\n \t\"id\": 6, \n\n \t\"properties\": { \n\n \t\"source\": \"000000\" \n\n \t\"destination\": \"210000\" } \n\n \n\n } \n\n ", "operationId":"getRequestPropertiesById", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"id", "in":"path", "description":"Request identifier", "required":true, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/RequestProperties" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Request not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/{requestId}":{ "get":{ "tags":[ "request" ], "summary":"Get request by ID", "description":"Returns a single request", "operationId":"getRequestById", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"requestId", "in":"path", "description":"Request identifier", "required":true, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Request" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Request not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "request" ], "summary":"Update the priority of a request", "description":"Submits a Change Request Priority request to the DIVA Core Manager. This call returns as soon as the Manager accepts the request. The application must call GET \\requests\\{requestid} to check that the operation was successful.", "operationId":"putRequestPriority", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"requestId", "in":"path", "description":"requestId", "required":true, "type":"integer", "format":"int32" }, { "in":"body", "name":"body", "description":"Defintion of Request Priority", "required":true, "schema":{ "$ref":"#/definitions/RequestPriorityBody" } } ], "responses":{ "200":{ "description":"Submitted request", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/requests/{requestId}/events":{ "get":{ "tags":[ "request" ], "summary":"Get events by request identifier.", "description":"Returns all events for a single request.", "operationId":"getAllEventsOfRequest", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort (uses Lexicographic Ordering for Strings)", "required":false, "type":"string", "enum":[ "ID", "SEVERITY", "DATE" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"requestId", "in":"path", "description":"Request identifier", "required":true, "type":"integer", "format":"int32" }, { "name":"severity", "in":"query", "description":"severity of event", "required":false, "type":"string", "enum":[ "ALL", "INFORMATION", "WARNING", "ERROR", "CRITICAL" ] }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Event" } } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Request not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/robots":{ "get":{ "tags":[ "robot" ], "summary":"Gets the list of all robots in the configuration.", "description":"Returns robot information for all robots in the configuration.", "operationId":"getAllRobots", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"robotName", "in":"query", "description":"name of robot", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Robots" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "robot" ], "summary":"Creates a robot in the configuration.", "description":"Returns status for creation of a robot in the configuration.", "operationId":"postRobot", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"robot", "description":"Robot to create", "required":true, "schema":{ "$ref":"#/definitions/Robot" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid robot supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "robot" ], "summary":"Updates a robot in the configuration.", "description":"Returns status for update of a robot in the configuration.", "operationId":"putRobot", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"robotName", "in":"query", "description":"Name of robot to update", "required":true, "type":"string" }, { "in":"body", "name":"newRobot", "description":"New Robot", "required":true, "schema":{ "$ref":"#/definitions/Robot" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid robot supplied" }, "404":{ "description":"Robot not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "robot" ], "summary":"Deletes a robot.", "description":"Returns status for delete of a robot from the configuration.", "operationId":"deleteRobot", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"robotName", "in":"query", "description":"Name of robot to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid robot supplied" }, "404":{ "description":"Robot not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/robots/acs":{ "get":{ "tags":[ "robot" ], "summary":"Gets the list of all robot ACS in the configuration.", "description":"Returns all robot ACS associations in the configuration.", "operationId":"getAllRobotAcs", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of robot", "required":false, "type":"string" }, { "name":"acs", "in":"query", "description":"Id of ACS", "required":false, "type":"integer", "format":"int32" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/RobotAcses" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "robot" ], "summary":"Synchronizes Robot ACS associations and add tape library information for each acs controlled by each robot.", "description":"This is an alias for POST /tapeLibraries.", "operationId":"postRobotAcs", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"tapeLibraries", "description":"Tape Libraries to synchronize from all robots", "required":true, "schema":{ "$ref":"#/definitions/TapeLibrariesBody" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid tape library supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "robot" ], "summary":"Updates a Robot ACS association in the configuration.", "description":"Returns status for update of a Robot ACS association in the configuration. Note an invalid ACS or robot manager name will be ignored.", "operationId":"putRobotAcs", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of robot", "required":true, "type":"string" }, { "name":"acs", "in":"query", "description":"Id of ACS", "required":true, "type":"integer", "format":"int32" }, { "in":"body", "name":"newRobotAcs", "description":"Robot-ACS association to update", "required":true, "schema":{ "$ref":"#/definitions/RobotAcs" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid robot-acs association supplied" }, "404":{ "description":"Robot-ACS association not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "robot" ], "summary":"Deletes a Robot ACS association from the configuration.", "description":"Returns status for delete of a Robot ACS association from the configuration.", "operationId":"deleteRobotAcsAssociation", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of robot", "required":true, "type":"string" }, { "name":"acs", "in":"query", "description":"Id of ACS", "required":true, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid robot-acs association supplied" }, "404":{ "description":"Robot-ACS association not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/roles":{ "get":{ "tags":[ "role" ], "summary":"Gets the list of all DIVA Core roles.", "description":"A user may belong to one of five roles; sysadmin, admin, advoperator, operator, or user.\n\n\n\nThe role of user may perform all basic GET operations including;\n\n POST /users/login\n\n POST /users/logout\n\n PUT /users/{userName}/password\n\n GET /profile\n\n PUT /profile\n\n GET /users\n\n GET /roles\n\n GET ANY RESOURCE (ex: GET /actors)\n\n\n\nAn operator may perform all the operations of a user and:\n\n POST /requests/archive\n\n POST /requests/restore\n\n POST /requests/copy\n\n\n\nAn advanced operator (advoperator) may perform all the operations of an operator and:\n\n PUT /requests\n\n POST /requests/transferFiles\n\n POST /requests/insertTape\n\n POST /requests/ejectTape\n\n POST /requests/repackTape\n\n POST /requests/exportTape\n\n POST /requests/importTape\n\n\n\nAn administrator (admin) may perform all operations of an administrator and:\n\n POST /requests/delete\n\n POST /requests/serverDelete\n\n\n\nA system administrator (sysadmin) may perform all operations of an administrator and the following operations:\n\n POST /users\n\n DELETE /users\n\n GET /users\n\n GET /roles\n\n", "operationId":"getAllRoles", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/RoleOutputs" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/servers":{ "get":{ "tags":[ "server" ], "summary":"Gets the list of all servers in the configuration.", "description":"Returns server information for all servers in the configuration.", "operationId":"getAllServers", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"serverName", "in":"query", "description":"name of server", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Servers" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "server" ], "summary":"Creates a server in the configuration.", "description":"Returns status for creation of a server in the configuration.", "operationId":"postServer", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"server", "description":"Server to create", "required":true, "schema":{ "$ref":"#/definitions/Server" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid server supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "server" ], "summary":"Updates a server in the configuration.", "description":"Returns status for update of a server in the configuration.", "operationId":"putServer", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"serverName", "in":"query", "description":"Name of server to update", "required":true, "type":"string" }, { "in":"body", "name":"newServer", "description":"New Server", "required":true, "schema":{ "$ref":"#/definitions/Server" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid server supplied" }, "404":{ "description":"Server not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "server" ], "summary":"Deletes a server from the configuration.", "description":"Returns status for delete of an server from the configuration.", "operationId":"deleteServer", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"serverName", "in":"query", "description":"Name of server to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid server supplied" }, "404":{ "description":"Server not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/sets":{ "get":{ "tags":[ "set" ], "summary":"Gets the list of all sets in the configuration.", "description":"Returns set information for all sets in the configuration.", "operationId":"getAllSets", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"setId", "in":"query", "description":"set id", "required":false, "type":"integer", "format":"int32" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Sets" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/sites":{ "get":{ "tags":[ "site" ], "summary":"Gets the list of all sites in the configuration.", "description":"Returns site information for all sites in the configuration.", "operationId":"getAllSites", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"siteName", "in":"query", "description":"name of site", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Sites" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "site" ], "summary":"Creates a site in the configuration.", "description":"Returns status for creation of a site in the configuration.", "operationId":"postSite", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"site", "description":"Site to create", "required":true, "schema":{ "$ref":"#/definitions/Site" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid site supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "site" ], "summary":"Updates a site in the configuration.", "description":"Returns status for update of a site in the configuration.", "operationId":"putSite", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"siteName", "in":"query", "description":"Name of site to update", "required":true, "type":"string" }, { "in":"body", "name":"newSite", "description":"New Site", "required":true, "schema":{ "$ref":"#/definitions/Site" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid site supplied" }, "404":{ "description":"Site not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "site" ], "summary":"Deletes a site by name from the configuration.", "description":"Returns status for deletion of a site from the configuration.", "operationId":"deleteSite", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"siteName", "in":"query", "description":"Name of site to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid site supplied" }, "404":{ "description":"Site not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/spms":{ "get":{ "tags":[ "spm" ], "summary":"Gets the list of all storage plans in the configuration.", "description":"Returns storage plan information for all storage plans in the configuration.", "operationId":"getAllSpms", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"storagePlanName", "in":"query", "description":"name of storage plan", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/SPMs" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "spm" ], "summary":"Creates a storage plan in the configuration.", "description":"Returns status for creation of a storage plan in the configuration.", "operationId":"postSPM", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"spm", "description":"Storage plan to create", "required":false, "schema":{ "$ref":"#/definitions/SPM" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "spm" ], "summary":"Updates a storage plan in the configuration", "description":"Returns status for update of a storage plan in the configuration.", "operationId":"putSPM", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"storagePlanName", "in":"query", "description":"Name of storage plan to update", "required":true, "type":"string" }, { "in":"body", "name":"newSPM", "description":"Storage plan to update", "required":true, "schema":{ "$ref":"#/definitions/SPM" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan supplied" }, "404":{ "description":"Storage plan not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "spm" ], "summary":"Deletes a storage plan from the configuration.", "description":"Returns status for delete of a storage plan from the configuration.", "operationId":"deleteSPM", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"storagePlanName", "in":"query", "description":"Storage plan to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan supplied" }, "404":{ "description":"Storage plan not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/spms/filters":{ "get":{ "tags":[ "spm" ], "summary":"Gets the list of all storage plan filters in the configuration.", "description":"Returns storage plan filter information for all storage plan filters in the configuration.", "operationId":"getAllSpmFilters", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"name of storage plan filter", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/SPMFilters" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "spm" ], "summary":"Creates a storage plan filter in the configuration.", "description":"Returns status for creation of a storage plan filter in the configuration.", "operationId":"postSPMFilter", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"spm", "description":"Storage plan filter to create", "required":false, "schema":{ "$ref":"#/definitions/SPMFilter" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan filter supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "spm" ], "summary":"Updates a storage plan filter in the configuration.", "description":"Returns status for update of a storage plan filter in the configuration.", "operationId":"putSPMFilter", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of storage plan filter to update", "required":true, "type":"string" }, { "in":"body", "name":"newSPMFilter", "description":"Storage plan filter to update", "required":true, "schema":{ "$ref":"#/definitions/SPMFilter" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan filter supplied" }, "404":{ "description":"Storage plan filter not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "spm" ], "summary":"Deletes a storage plan filter from the configuration.", "description":"Returns status for delete of a storage plan filter from the configuration.", "operationId":"deleteSPMFilter", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Storage plan filter to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan filter supplied" }, "404":{ "description":"Storage plan filter not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/spms/media":{ "get":{ "tags":[ "spm" ], "summary":"Gets the list of all storage plan media in the configuration.", "description":"Returns storage plan medium information for all storage plan media in the configuration.", "operationId":"getAllSpmMedia", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"name of storage plan medium", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/SPMMedia" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "spm" ], "summary":"Creates a storage plan medium in the configuration.", "description":"Returns status for creation of an storage plan medium in the configuration.", "operationId":"postSPMMedium", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"spm", "description":"Storage plan medium to create", "required":false, "schema":{ "$ref":"#/definitions/SPMMedium" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan medium supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "spm" ], "summary":"Updates a storage plan medium from the configuration.", "description":"Returns status for update of a storage plan medium from the configuration.", "operationId":"putSPMMedium", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of storage plan medium to update", "required":true, "type":"string" }, { "in":"body", "name":"newSPMMedium", "description":"Storage plan medium to update", "required":true, "schema":{ "$ref":"#/definitions/SPMMedium" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan medium supplied" }, "404":{ "description":"Storage plan medium not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "spm" ], "summary":"Deletes a storage plan medium from the configuration.", "description":"Returns status for delete of a storage plan medium from the configuration.", "operationId":"deleteSPMMedium", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Storage plan medium to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan medium supplied" }, "404":{ "description":"Storage plan medium not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/spms/slots":{ "get":{ "tags":[ "spm" ], "summary":"Gets the list of all storage plan slots in the configuration.", "description":"Returns storage plan slot information for all storage plan slots in the configuration.", "operationId":"getAllSpmSlots", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"name of storage plan slot", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/SPMSlots" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "spm" ], "summary":"Creates a storage plan slot in the configuration.", "description":"Returns status for creation of an storage plan slot in the configuration.", "operationId":"postSPMSlot", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"spm", "description":"Storage plan slot to create", "required":false, "schema":{ "$ref":"#/definitions/SPMSlot" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan slot supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "spm" ], "summary":"Updates a storage plan slot in the configuration.", "description":"Returns status for update of a storage plan slot in the configuration.", "operationId":"putSPMSlot", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of storage plan slot to update", "required":true, "type":"string" }, { "in":"body", "name":"newSPMSlot", "description":"Storage plan slot to update", "required":true, "schema":{ "$ref":"#/definitions/SPMSlot" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan slot supplied" }, "404":{ "description":"Storage plan slot not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "spm" ], "summary":"Deletes a storage plan slot from the configuration", "description":"Returns status for delete of a storage plan slot from the configuration.", "operationId":"deleteSPMSlot", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Storage plan slot to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage plan slot supplied" }, "404":{ "description":"Storage plan slot not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/storageAccounts":{ "get":{ "tags":[ "storageAccount" ], "summary":"Gets the list of all storage accounts in the configuration.", "description":"Returns storage account information for all storage accounts in the configuration.", "operationId":"getAllStorageAccounts", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"storageAccountName", "in":"query", "description":"name of storage account", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/StorageAccounts" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "storageAccount" ], "summary":"Creates a storage account in the configuration.", "description":"Returns status for creation of a storage accounts in the configuration.", "operationId":"postStorageAccount", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"storageAccount", "description":"Storage account to create", "required":true, "schema":{ "$ref":"#/definitions/StorageAccount" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage account supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "storageAccount" ], "summary":"Updates a storage account in the configuration.", "description":"Returns status for update of a storage account in the configuration.", "operationId":"putStorageAccount", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"storageAccountName", "in":"query", "description":"Name of storage account to update", "required":true, "type":"string" }, { "in":"body", "name":"newStorageAccount", "description":"New storage account", "required":true, "schema":{ "$ref":"#/definitions/StorageAccount" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage account supplied" }, "404":{ "description":"Storage Account not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "storageAccount" ], "summary":"Deletes a storage account by name from the configuration.", "description":"Returns status for delete of a storage account from the configuration.", "operationId":"deleteStorageAccount", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"storageAccountName", "in":"query", "description":"Name of storage account to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid storage account supplied" }, "404":{ "description":"Storage account not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/system":{ "get":{ "tags":[ "system" ], "summary":"Gets the DIVA Core system-level information.", "description":"Returns DIVA Core system's current state.", "operationId":"getArchiveSysteminfo", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"options", "in":"query", "description":"options", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ArchiveSystemInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/system/notify":{ "get":{ "tags":[ "system" ], "summary":"Gets status of the last DIVA Core configuration update.", "description":"Returns status of the last update to the configuration of DIVA Core.", "operationId":"getNotificationStatus", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "system" ], "summary":"Submits DIVA Core configuration update.", "description":"Submits a request to update the configuration of DIVA Core.", "operationId":"submitNotifyOfConfigurationUpdate", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Submitted configuration update request", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/system/reload":{ "get":{ "tags":[ "system" ], "summary":"Gets the status of the last DIVA Core system reload.", "description":"Returns status of the last DIVA Core system reload.", "operationId":"getReloadStatus", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "system" ], "summary":"Submits a DIVA Core system reload.", "description":"Returns status of a DIVA Core system reload.", "operationId":"submitReload", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Submitted reload request", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapeLibraries":{ "get":{ "tags":[ "library" ], "summary":"Gets the list of all tape libraries in the configuration.", "description":"Returns tape library information for all tape libraries in the configuration.", "operationId":"getAllTapeLibraries", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"libraryName", "in":"query", "description":"name of library", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TapeLibraries" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "library" ], "summary":"Synchronizes Robot ACS associations and add tape library information for each ACS controlled by each robot.", "description":"Returns status for creation of tape libraries. Name is used to match against the tape libraries found in all robots. The ACS and Status are ignored if specified. Only libraries found in robot manager are added. Note, also adds robot-acs associations.", "operationId":"postTapeLibrary", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"tapeLibraries", "description":"Tape Libraries to synchronize from all robots", "required":false, "schema":{ "$ref":"#/definitions/TapeLibrariesBody" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid tape library supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "library" ], "summary":"Updates a tape library in the configuration.", "description":"Returns status for the update of a tape library in the configuration. ACS is ignored if specified.", "operationId":"putTapeLibrary", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"libraryName", "in":"query", "description":"Name of tape library", "required":true, "type":"string" }, { "in":"body", "name":"newTapeLibrary", "description":"Tape library", "required":true, "schema":{ "$ref":"#/definitions/TapeLibrary" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid tape library supplied" }, "404":{ "description":"Tape Library not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "library" ], "summary":"Deletes a tape library from the configuration.", "description":"Returns status for the delete of a tape library from the configuration.", "operationId":"deleteTapeLibrary", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"libraryName", "in":"query", "description":"Tape library to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid tape library supplied" }, "404":{ "description":"Tape Library not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes":{ "get":{ "tags":[ "tape" ], "summary":"Gets the list of all tapes in the configuration.", "description":"Returns tape information for all tapes in the configuration. If ACS/LSM is NOT specified, 0 is assumed. Note remainingSizeMB and totalSizeMB are big decimals and should be deserialized as decimal values.", "operationId":"getAllTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"barcode", "required":false, "type":"string" }, { "name":"acsId", "in":"query", "description":"ACS id", "required":false, "type":"integer", "format":"int32" }, { "name":"lsmId", "in":"query", "description":"LSM id", "required":false, "type":"integer", "format":"int32" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Tapes" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "tape" ], "summary":"Synchronizes tapes from a specified robot or all robots if nothing is specified.", "description":"Returns status for synchronization of tapes of a robot or all robots if nothing is specified.", "operationId":"postTapesOfRobot", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"robotForSyncDb", "description":"Robot from which to create tapes", "required":true, "schema":{ "$ref":"#/definitions/RobotForSyncDB" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid robot name supplied" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes/emptyEjected":{ "get":{ "tags":[ "tape" ], "summary":"Gets the list of empty ejected tapes from the configuration.", "description":"Returns empty ejected tape information from the configuration.", "operationId":"getEmptyEjectedTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"Barcode", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/EmptyEjectedTapes" } } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "tape" ], "summary":"Deletes an empty ejected tape from the configuration.", "description":"Returns status for delete of an empty ejected tape from the configuration.", "operationId":"deleteEmptyEjectedTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"Barcode of empty ejected tape", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid empty ejected tape supplied" }, "404":{ "description":"Empty ejected tape not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes/info":{ "get":{ "tags":[ "tape" ], "summary":"Gets tape information for a specfic tape.", "description":"Returns tape information for a specfic tape.", "operationId":"getInfo_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"Barcode", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TapeInformation" } }, "400":{ "description":"Invalid tape supplied" }, "404":{ "description":"Tape not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes/inserted":{ "put":{ "tags":[ "tape" ], "summary":"Unprotects / protects an inserted tape in the configuration.", "description":"Returns status of the operation.", "operationId":"putProtectionOfInsertedTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"Barcode of inserted tape", "required":true, "type":"string" }, { "name":"protect", "in":"query", "description":"protect", "required":false, "type":"boolean", "default":false } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "404":{ "description":"Inserted tape not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes/insertedProtected":{ "get":{ "tags":[ "tape" ], "summary":"Gets the list of inserted protected tapes in the configuration.", "description":"Returns inserted protected tape information in the configuration.", "operationId":"getInsertedProtectedTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"Barcode", "required":false, "type":"string" }, { "name":"acsId", "in":"query", "description":"ACS id", "required":false, "type":"integer", "format":"int32" }, { "name":"lsmId", "in":"query", "description":"LSM id", "required":false, "type":"integer", "format":"int32" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/InsertedProtectedTapes" } } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "tape" ], "summary":"Unprotects an inserted and protected tape in the configuration.", "description":"Returns status for an unprotect operation in the configuration.", "operationId":"putInsertedProtectedTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"Barcode of inserted protected tape", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "404":{ "description":"Inserted protected tape not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes/states":{ "get":{ "tags":[ "tape" ], "summary":"Get tapes that contain disabled states from the configuration.", "description":"Returns tape state information from the configuration.", "operationId":"getAllTapeStates", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"barcode", "required":false, "type":"string" }, { "name":"acsId", "in":"query", "description":"ACS id", "required":false, "type":"integer", "format":"int32" }, { "name":"lsmId", "in":"query", "description":"LSM id", "required":false, "type":"integer", "format":"int32" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TapeStates" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "tape" ], "summary":"Disables all states of a tape in the configuration.", "description":"Returns status for creation of a tape states in the configuration.", "operationId":"postTapeStates", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"tapeStates", "description":"Barcodes", "required":true, "schema":{ "$ref":"#/definitions/MultiCreateTapeStates" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid tape state supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "tape" ], "summary":"Updates states of a tapes in the configuration.", "description":"Returns status for update of a tape states in the configuration. Note: Tapes that have been enabled for write, repack and clone, may NOT be updated.", "operationId":"putTapeStates", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"newTapeStates", "description":"New Tape states", "required":true, "schema":{ "$ref":"#/definitions/MultiEditTapeStates" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid tape state supplied" }, "404":{ "description":"Tape state not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes/types":{ "get":{ "tags":[ "tape" ], "summary":"Gets the list of all tape types.", "description":"Returns tape information for all tape types.", "operationId":"getAllTapeTypes_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"name", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TapeTypes" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "tape" ], "summary":"Synchronizes tape types from all robots.", "description":"Returns status for the creation of tape types of all robots. Name is used to match against the tape types found in all robots. The ID is ignored if specified. Only types found in robot manager are added. User must provide total and block size for each type found in the robot manager. Types found in the robot manager but missing from the body and types provided in the body but not found in the robot manager will both be skipped.", "operationId":"postTapeTypesOfRobots", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"tapeTypes", "description":"Tape types to synchronize from all robots", "required":false, "schema":{ "$ref":"#/definitions/TapeTypesBody" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid tape types supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "tape" ], "summary":"Updates a tape type.", "description":"Returns status for the update of a tape type. Only totalSizeKB can be updated. Name, id and blockSizeKB are ignored if specified.", "operationId":"putTapeType", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of tape type to update", "required":true, "type":"string" }, { "in":"body", "name":"newTapeType", "description":"Tape type to update", "required":true, "schema":{ "$ref":"#/definitions/TapeType" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid tape type supplied" }, "404":{ "description":"Tape type not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "tape" ], "summary":"Deletes a tape type.", "description":"Returns status for delete of a tape type.", "operationId":"deleteTapeType", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name of tape type to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid tape type supplied" }, "404":{ "description":"Tape type not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes/types/missing":{ "get":{ "tags":[ "tape" ], "summary":"Gets the list of all missing (not yet configured) tape types.", "description":"Returns tape information of all missing (not yet configured) tape types.", "operationId":"getAllTapeTypes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TapeTypes" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes/unused":{ "get":{ "tags":[ "tape" ], "summary":"Gets the list of unused tapes in the configuration.", "description":"Returns unused tape information in the configuration.", "operationId":"getUnusedTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"barcode", "required":false, "type":"string" }, { "name":"acsId", "in":"query", "description":"ACS id", "required":false, "type":"integer", "format":"int32" }, { "name":"lsmId", "in":"query", "description":"LSM id", "required":false, "type":"integer", "format":"int32" }, { "name":"setIds", "in":"query", "description":"set identifiers", "required":false, "type":"array", "items":{ "type":"integer", "format":"int32" }, "collectionFormat":"multi" }, { "name":"isExcludeSetId", "in":"query", "description":"exclude set identifiers", "required":false, "type":"boolean", "default":false }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/UnusedTapes" } } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "tape" ], "summary":"Updates an unused tape's setId in the configuration.", "description":"Returns status for update of an unused tape in the configuration.", "operationId":"putUnusedTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"newUnusedTapes", "description":"Unused tape", "required":true, "schema":{ "$ref":"#/definitions/MultiEditUnusedTapes" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid unused tape supplied" }, "404":{ "description":"Unused tape not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/tapes/unusedToBeCleared":{ "get":{ "tags":[ "tape" ], "summary":"Gets the list of empty tapes by their to be cleared setting.", "description":"Returns empty tapes by their to be cleared setting.", "operationId":"getToBeClearedTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"barcode", "in":"query", "description":"Barcode", "required":false, "type":"string" }, { "name":"toBeCleared", "in":"query", "description":"To be cleared", "required":false, "type":"boolean", "default":true }, { "name":"acsId", "in":"query", "description":"ACS id", "required":false, "type":"integer", "format":"int32" }, { "name":"lsmId", "in":"query", "description":"LSM id", "required":false, "type":"integer", "format":"int32" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ToBeClearedTapes" } } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "tape" ], "summary":"Sets the to be cleared flag of all unused tapes in the configuration.", "description":"Returns status for the setting of to be cleared flag in the configuration.", "operationId":"putToBeClearedTapes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"newToBeClearedTapes", "description":"New to be cleared tapes", "required":true, "schema":{ "$ref":"#/definitions/MultiEditToBeClearedTapes" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "404":{ "description":"To be cleared tape not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/transcoders":{ "get":{ "tags":[ "transcoder" ], "summary":"Gets the list of all transcoders in the configuration.", "description":"Returns transcoder information for all transcoders in the configuration.", "operationId":"getAllTranscoders", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"transcoderName", "in":"query", "description":"name of transcoder", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Transcoders" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "transcoder" ], "summary":"Creates a transcoder in the configuration.", "description":"Returns status for creation of a transcoder in the configuration.", "operationId":"postTranscoder", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"transcoder", "description":"Transcoder to create", "required":true, "schema":{ "$ref":"#/definitions/Transcoder" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid transcoder supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "transcoder" ], "summary":"Updates a transcoder in the configuration.", "description":"Returns status for the update of a transcoder in the configuration.", "operationId":"putTranscoder", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"transcoderName", "in":"query", "description":"Name of transcoder to update", "required":true, "type":"string" }, { "in":"body", "name":"newTranscoder", "description":"New Transcoder", "required":true, "schema":{ "$ref":"#/definitions/Transcoder" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid transcoder supplied" }, "404":{ "description":"Transcoder not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "transcoder" ], "summary":"Deletes a transcoder from the configuration.", "description":"Returns status for the delete of a transcoder from the configuration.", "operationId":"deleteTranscoder", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"transcoderName", "in":"query", "description":"Name of transcoder to delete", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid transcoder supplied" }, "404":{ "description":"Transcoder not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/actorDisks":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all actor disks in the configuration.", "description":"Returns actor disk information for all actor disks in the configuration.", "operationId":"getAllActorDisks_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"name of actor", "required":false, "type":"string" }, { "name":"diskName", "in":"query", "description":"name of disk", "required":false, "type":"string" }, { "name":"isCloud", "in":"query", "description":"isCloud", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ActorDisks" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/actorDrives":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all actor drives.", "description":"Returns actor drive information for all actor drives in the configuration.", "operationId":"getAllActorDrives_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"name of actor", "required":false, "type":"string" }, { "name":"driveName", "in":"query", "description":"name of drive", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ActorDrives" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/actors":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all actors.", "description":"Returns actor information for all actors.", "operationId":"getAllActors_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actorName", "in":"query", "description":"name of actor", "required":false, "type":"string" }, { "name":"productionSystemName", "in":"query", "description":"name of production system", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Actors" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/archivedObject":{ "get":{ "tags":[ "ui" ], "summary":"Gets object information for a specfic object.", "description":"Returns object information for a specfic object.", "operationId":"getArchivedObjectInfo", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"objectName", "in":"query", "description":"Object name", "required":true, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Collection name (category)", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DetailedObjectInfo" } }, "400":{ "description":"Invalid object supplied" }, "404":{ "description":"Object not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/archivedObjects":{ "get":{ "tags":[ "ui" ], "summary":"Gets Detailed Information on archived objects.", "description":"Returns detailed information on archived objects.", "operationId":"getArchivedObjectsInfo", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort", "required":false, "type":"string", "enum":[ "objectName", "collection", "archiveDate", "checksumStatus", "comments", "complex", "externalized", "storagePlan", "numInstances", "numFiles", "lastReadDate", "sizeKB" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"objectName", "in":"query", "description":"object name", "required":false, "type":"string", "default":"*" }, { "name":"collectionName", "in":"query", "description":"collection name (category)", "required":false, "type":"string", "default":"*" }, { "name":"spm", "in":"query", "description":"storage Plan", "required":false, "type":"string", "default":"*" }, { "name":"comments", "in":"query", "description":"comments", "required":false, "type":"string", "default":"*" }, { "name":"isComplex", "in":"query", "description":"complex object", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isExternalized", "in":"query", "description":"externalized", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"checksum", "in":"query", "description":"checksum", "required":false, "type":"string", "default":"*", "enum":[ "*", "VERIFIED", "PARTIALLY_VERIFIED", "NOT_VERIFIED" ] }, { "name":"beginDate", "in":"query", "description":"begin Date as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"endDate", "in":"query", "description":"end Date as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"beginDateOfLastRead", "in":"query", "description":"begin Date of Last Read as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"endDateOfLastRead", "in":"query", "description":"end Date of Last Read as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ObjectsInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/caps":{ "get":{ "tags":[ "ui" ], "summary":"Gets CAPs.", "description":"Returns CAPs in the configuration.", "operationId":"getCAPs", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/CAPs" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/disk/files":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all files on a disk.", "description":"Returns list of files on disk.", "operationId":"getFilesOfDisk", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort", "required":false, "type":"string", "enum":[ "objectName", "collection", "name", "fileFolderType", "sizeBytes", "path" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"name", "in":"query", "description":"name", "required":true, "type":"string", "default":"*" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DiskFilesInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/disks":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all disks in the configuration.", "description":"Returns disk information for all disks in the configuration.", "operationId":"getAllDisksUI", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort", "required":false, "type":"string", "enum":[ "name", "array", "state", "lastErrorMessage", "availableSizeKB", "consumedSizeKB", "totalSizeKB", "usedCapacity", "storageOptions", "writable", "firstUtilizationDate", "lastAccessDate", "lastReadDate", "lastWriteDate" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"isCloud", "in":"query", "description":"isCloud", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"name", "in":"query", "description":"name", "required":false, "type":"string", "default":"*" }, { "name":"arrayName", "in":"query", "description":"name of array", "required":false, "type":"string", "default":"*" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DisksInfo" } } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "ui" ], "summary":"Clear the last error message of the specified disk.", "description":"Submit a clear last error message.", "operationId":"putDisk_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"Name", "required":false, "type":"string", "default":"*" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid Disk Name", "schema":{ "$ref":"#/definitions/Status" } }, "404":{ "description":"Disk not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/disks/{id}":{ "get":{ "tags":[ "ui" ], "summary":"Gets a single disk from the configuration.", "description":"Returns disk information for a single disk in the configuration.", "operationId":"getDiskByName", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"id", "in":"path", "description":"disk id", "required":true, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DiskInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/drives":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all drives filtered by serial number.", "description":"Returns drive information for all drives filtered by serial number.", "operationId":"getAllDrivesUI", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"driveSerialNumber", "in":"query", "description":"Drive serial number", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Drives" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/events":{ "get":{ "tags":[ "ui" ], "summary":"Get all events.", "description":"Returns all events.", "operationId":"getEvents", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"Field of sort", "required":false, "type":"string", "enum":[ "id", "severity", "description", "requestId", "date" ] }, { "name":"sortDirection", "in":"query", "description":"Direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"requestId", "in":"query", "description":"Request ID", "required":false, "type":"string", "default":"*" }, { "name":"eventId", "in":"query", "description":"Event ID", "required":false, "type":"string", "default":"*" }, { "name":"dbBackupOnly", "in":"query", "description":"Database Backup Only", "required":false, "type":"boolean" }, { "name":"severities", "in":"query", "description":"Severity of events", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "Information", "Warning", "Error", "Critical" ] }, "collectionFormat":"multi", "enum":[ "Information", "Warning", "Error", "Critical" ] }, { "name":"eventBeginDate", "in":"query", "description":"Begin date as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"eventEndDate", "in":"query", "description":"End date as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"eventDescription", "in":"query", "description":"Description", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/EventsV2" } }, "400":{ "description":"Invalid ID supplied" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/events/keepAlive":{ "put":{ "tags":[ "ui" ], "summary":"Tell server to NOT delete queues associated with client for a specified number of minutes", "description":"Server will delete all queues for a specified client after approximately the specified number of minutes has expired from the current time", "operationId":"keepAlive", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"clientId", "in":"query", "description":"Client identifier", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"number of minutes to keep alive from current time", "required":true, "schema":{ "$ref":"#/definitions/KeepAliveBody" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/events/subscribe":{ "post":{ "tags":[ "ui" ], "summary":"Subscribe to brokered events.", "description":"Subscribe to brokered events. Returns the client id associated with the subscription.", "operationId":"subscribeBrokerQueues", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/BrokerClientInfo" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/BrokerClientInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/events/unsubscribe":{ "post":{ "tags":[ "ui" ], "summary":"Unsubscribe specified client from brokered events.", "description":"Unsubscribe specified client from brokered events.", "operationId":"unsubscribeBrokerQueues", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Client id for brokered events", "required":true, "schema":{ "$ref":"#/definitions/BrokerClientInfoBody" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "404":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/Status" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/journal":{ "get":{ "tags":[ "ui" ], "summary":"Gets Journal entries.", "description":"Returns journal entries.", "operationId":"getJournalEntries", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"Field of sort (uses Lexicographic Ordering for Strings)", "required":false, "type":"string", "enum":[ "id", "severity", "requestId", "startTime", "eventTime", "durationSec", "eventDescription", "tapeBarcode", "driveSerialNumber", "librarySerialNumber", "diskName", "actorName", "sourceDestinationName", "objectName", "objectCategory", "objectInstance", "transferSizeMB", "transferRateMBPerSec", "errorRate", "errorCode", "errorMessage" ] }, { "name":"sortDirection", "in":"query", "description":"Direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"id", "in":"query", "description":"ID", "required":false, "type":"string", "default":"*" }, { "name":"requestId", "in":"query", "description":"Request ID", "required":false, "type":"string", "default":"*" }, { "name":"eventTimeBeginValue", "in":"query", "description":"Event time begin value as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"eventTimeEndValue", "in":"query", "description":"Event time end value as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"eventDefinition", "in":"query", "description":"Event Description / Definition (refer to /analytics/events/definitions for possible values)", "required":false, "type":"string", "default":"*" }, { "name":"tapeBarcode", "in":"query", "description":"Tape barcode", "required":false, "type":"string", "default":"*" }, { "name":"driveSerialNumber", "in":"query", "description":"Drive serial number (refer to /drives for possible values)", "required":false, "type":"string", "default":"*" }, { "name":"actorName", "in":"query", "description":"Actor name", "required":false, "type":"string", "default":"*" }, { "name":"objectName", "in":"query", "description":"Object name", "required":false, "type":"string", "default":"*" }, { "name":"objectCategory", "in":"query", "description":"Object category", "required":false, "type":"string", "default":"*" }, { "name":"objectInstance", "in":"query", "description":"Object instance", "required":false, "type":"string", "default":"*" }, { "name":"errorCode", "in":"query", "description":"Error code", "required":false, "type":"string", "default":"*" }, { "name":"errorMessage", "in":"query", "description":"Error message", "required":false, "type":"string", "default":"*" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/JournalEntries" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/media":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all media in the configuration.", "description":"Returns media information for all media in the configuration.", "operationId":"getAllMediaUI", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort", "required":false, "type":"string", "enum":[ "name", "type", "firstUtilizationDate", "lastUtilizationDate", "usedSpaceKB", "mediaFormat", "sourceMediaPriority" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"name", "in":"query", "description":"name", "required":false, "type":"string", "default":"*" }, { "name":"type", "in":"query", "description":"type", "required":false, "type":"string", "default":"*" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MediaInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/media/sizes":{ "get":{ "tags":[ "ui" ], "summary":"Gets aggregated media (disk, tape and cloud) sizes.", "description":"Returns the aggregated total and used size in KB by media type.", "operationId":"getAggregatedSizesPerMediaType", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/AggregatedMediaSizeByType" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/migrationJobs":{ "get":{ "tags":[ "ui" ], "summary":"Get migration jobs by filters", "description":"Returns migration jobs", "operationId":"getMigrateJobsByFilters", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort", "required":false, "type":"string", "enum":[ "status", "type", "sourceType", "destinationType", "startedAt", "finishedAt", "progress", "numberInstancesToMigrate", "dataTransferred", "jobName", "jobDescription" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"jobName", "in":"query", "description":"jobName", "required":false, "type":"string", "default":"*" }, { "name":"jobDescription", "in":"query", "description":"jobDescription", "required":false, "type":"string", "default":"*" }, { "name":"barcode", "in":"query", "description":"barcode", "required":false, "type":"string", "default":"*" }, { "name":"status", "in":"query", "description":"job status", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "Unknown", "Submitted", "Pending", "Initializing", "CleaningUp", "Paused", "Pausing", "Stopped", "Stopping", "Deleting", "Finalizing", "Cancelled", "Cancelling", "Aborted", "Completed", "PartiallyCompleted", "Resuming", "WaitingForResource", "Running" ] }, "collectionFormat":"multi", "enum":[ "Unknown", "Submitted", "Pending", "Initializing", "CleaningUp", "Paused", "Pausing", "Stopped", "Stopping", "Deleting", "Finalizing", "Cancelled", "Cancelling", "Aborted", "Completed", "PartiallyCompleted", "Resuming", "WaitingForResource", "Running" ] }, { "name":"types", "in":"query", "description":"job types", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "Copy", "Move", "CopyToSource", "Unknown", "Restore", "Delete" ] }, "collectionFormat":"multi", "enum":[ "Copy", "Move", "CopyToSource", "Unknown", "Restore", "Delete" ] }, { "name":"startDateBeginValue", "in":"query", "description":"start date begin value as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"startDateEndValue", "in":"query", "description":"start date end value as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"endDateBeginValue", "in":"query", "description":"end date begin value as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"endDateEndValue", "in":"query", "description":"end date end value as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MigrationJobsInfoUI" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Jobs not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "ui" ], "summary":"Creates a Migration job.", "description":"Submits a migration job to the DIVA Core Migration service. \nThis call returns as soon as the Migration service accepts the job. The application must call GET /ui/migrationJobs/{jobid} to check that the operation was successful.", "operationId":"postMigrateJob", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Migrate job to create", "required":true, "schema":{ "$ref":"#/definitions/MigrateJobBody" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MigrationJobInfo" } }, "400":{ "description":"Invalid input", "schema":{ "$ref":"#/definitions/MigrationJobInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/migrationJobs/sourceDestinationTypes":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all migration source / destination types in the configuration.", "description":"Returns source /destination names for all migration source / destination types in the configuration.", "operationId":"getAllMigrationSourceDestinationTypes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MigrationSourceDestinationTypes" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/migrationJobs/{jobId}":{ "get":{ "tags":[ "ui" ], "summary":"Get migration job by ID", "description":"Returns a single job", "operationId":"getMigrateJobById", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"jobId", "in":"path", "description":"Migration job identifier", "required":true, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MigrationJobInfo" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Job not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "put":{ "tags":[ "ui" ], "summary":"Modify a migration job.", "description":"Submit a modification to a migration job.This call returns as soon as Migrate service accepts the change to the job. The application must call GET /ui/migrationJobs/{jobId} to check that the operation was successful.", "operationId":"putMigrationJob", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"jobId", "in":"path", "description":"Migration job identifier", "required":false, "type":"integer", "format":"int32" }, { "in":"body", "name":"body", "description":"Migration job operation", "required":true, "schema":{ "$ref":"#/definitions/MigrationJobOperationBody" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MigrationJobInfo" } }, "400":{ "description":"Invalid job id", "schema":{ "$ref":"#/definitions/MigrationJobInfo" } }, "404":{ "description":"Job not found" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "ui" ], "summary":"Deletes a migration job.", "description":"Returns status for delete of a migration job.", "operationId":"deleteMigrationJob", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"jobId", "in":"path", "description":"Migration job identifier", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid job id supplied" }, "404":{ "description":"Job not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/migrationJobs/{jobId}/requests":{ "get":{ "tags":[ "ui" ], "summary":"Get requests for a migration job by ID", "description":"Returns request information for a single job", "operationId":"getRequestsByMigrateJobId", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort", "required":false, "type":"string", "enum":[ "objectName", "collectionName", "instanceId", "type", "requestId", "media", "status" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"jobId", "in":"path", "description":"migration job identifier", "required":false, "type":"integer", "format":"int32" }, { "name":"objectName", "in":"query", "description":"object name", "required":false, "type":"string", "default":"*" }, { "name":"collectionName", "in":"query", "description":"collection name (category)", "required":false, "type":"string", "default":"*" }, { "name":"status", "in":"query", "description":"request status", "required":false, "type":"string", "default":"*", "enum":[ "ALL", "PENDING", "RUNNING", "COMPLETED", "PARTIALLY_ABORTED", "ABORTED", "CANCELLED" ] }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/RequestsInfo" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Job not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/requests":{ "get":{ "tags":[ "ui" ], "summary":"List all requests.", "description":"Returns a list of requests.", "operationId":"getRequests_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort (uses Lexicographic Ordering for Strings)", "required":false, "type":"string", "enum":[ "id", "additionalInfo", "collectionName", "completionDate", "currentPriority", "destinationTape", "objectName", "sourceTape", "stateDescription", "submissionDate", "typeDescription", "thirdPartyId" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"type", "in":"query", "description":"type of request", "required":false, "type":"string", "enum":[ "Archive", "Restore", "Delete", "Eject", "Insert", "Copy to group/media", "Copy As", "Restore instance", "Delete instance", "UNKNOWN", "Automatic Repack", "Manual Repack", "Associative Copy", "Partial Restore", "Partial Restore Instance", "Multiple Restore", "Transcode Archive", "Export", "Transfer", "Manual Verify Tapes", "Clone Tapes", "Server Delete", "Stage" ] }, { "name":"states", "in":"query", "description":"states of request", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "Pending", "Transferring", "Migrating", "Completed", "Aborted", "Cancelled", "UNKNOWN", "Deleting", "Waiting for resources", "Waiting for operator", "Assigning pool", "Partially Aborted", "Running" ] }, "collectionFormat":"multi", "enum":[ "Pending", "Transferring", "Migrating", "Completed", "Aborted", "Cancelled", "UNKNOWN", "Deleting", "Waiting for resources", "Waiting for operator", "Assigning pool", "Partially Aborted", "Running" ] }, { "name":"startDateTime", "in":"query", "description":"start completion date & time as yyyy-MM-dd HH:mm:ss in UTC - only used for requests with state; Completed, Aborted, Partially Aborted and Cancelled", "required":false, "type":"string" }, { "name":"endDateTime", "in":"query", "description":"end completion date & time as yyyy-MM-dd HH:mm:ss in UTC - only used for requests with state; Completed, Aborted, Partially Aborted and Cancelled", "required":false, "type":"string" }, { "name":"requestIds", "in":"query", "description":"request identifiers", "required":false, "type":"array", "items":{ "type":"integer", "format":"int32" }, "collectionFormat":"multi" }, { "name":"objectName", "in":"query", "description":"object name", "required":false, "type":"string" }, { "name":"collectionName", "in":"query", "description":"collection name", "required":false, "type":"string" }, { "name":"serverName", "in":"query", "description":"server name", "required":false, "type":"string" }, { "name":"sourceTape", "in":"query", "description":"source tape", "required":false, "type":"string" }, { "name":"thirdPartyId", "in":"query", "description":"third party id", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Requests" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/requests/{requestId}":{ "get":{ "tags":[ "ui" ], "summary":"Get request by ID", "description":"Returns a single request", "operationId":"getRequestById_1", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"requestId", "in":"path", "description":"Request identifier", "required":true, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Request" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Request not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/servers":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all servers in the configuration.", "description":"Returns server information for all servers in the configuration.", "operationId":"getAllServersUI", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"name", "in":"query", "description":"name", "required":false, "type":"string", "default":"*" }, { "name":"sortField", "in":"query", "description":"Field of sort", "required":false, "type":"string", "enum":[ "name", "address", "checksumType", "connectOptions", "gcMode", "isUseExternalChecksumSource", "isVFA", "isVFR", "maxAccesses", "maxReadAccesses", "maxWriteAccesses", "maxThroughputMBPerSec", "productionSystem", "rootPath", "site", "sourcePassword", "type", "typeId" ] }, { "name":"sortDirection", "in":"query", "description":"Direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Servers" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/spm/actions":{ "get":{ "tags":[ "ui" ], "summary":"Gets SPM actions.", "description":"Returns SPM actions.", "operationId":"getSPMActions", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"Field of sort", "required":false, "type":"string", "enum":[ "id", "status", "isEnabled", "type", "objectName", "collectionName", "comments", "taskName", "slotName", "startAt", "requestId", "step", "resultCode", "resultCodeName", "numberOfFailures" ] }, { "name":"sortDirection", "in":"query", "description":"Direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"status", "in":"query", "description":"status", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "Scheduled", "Processing", "Completed", "FailedLong", "FailedShort", "Loaded", "Postponed", "Rejected" ] }, "collectionFormat":"multi", "enum":[ "Scheduled", "Processing", "Completed", "FailedLong", "FailedShort", "Loaded", "Postponed", "Rejected" ] }, { "name":"types", "in":"query", "description":"types", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "Transcode", "Archive", "Restore", "Copy", "DeleteInstance", "DeleteObject" ] }, "collectionFormat":"multi", "enum":[ "Transcode", "Archive", "Restore", "Copy", "DeleteInstance", "DeleteObject" ] }, { "name":"objectName", "in":"query", "description":"Name of object", "required":false, "type":"string" }, { "name":"collectionName", "in":"query", "description":"Name of collection (category)", "required":false, "type":"string" }, { "name":"comments", "in":"query", "description":"Comments", "required":false, "type":"string" }, { "name":"taskName", "in":"query", "description":"Name of task", "required":false, "type":"string" }, { "name":"slotName", "in":"query", "description":"Name of slot", "required":false, "type":"string" }, { "name":"scheduledBeginDate", "in":"query", "description":"Scheduled Begin date as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"scheduledEndDate", "in":"query", "description":"Scheduled End date as yyyy-MM-dd HH:mm:ss in UTC", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"Page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"Size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/SPMActions" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/spm/actions/{actionId}":{ "put":{ "tags":[ "ui" ], "summary":"Modify an SPM action.", "description":"Submit a modification to an SPM action.", "operationId":"putSPMActions", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"actionId", "in":"path", "description":"SPM action identifier", "required":false, "type":"integer", "format":"int32" }, { "in":"body", "name":"body", "description":"APM action operation", "required":true, "schema":{ "$ref":"#/definitions/SpmActionOperationBody" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid action id", "schema":{ "$ref":"#/definitions/Status" } }, "404":{ "description":"Action not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/tape/files":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all files on a tape.", "description":"Returns list of files on tape.", "operationId":"getFilesOfTape", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort", "required":false, "type":"string", "enum":[ "objectName", "collection", "instanceId", "fileName", "fileSizeInKB", "spanned", "beginPositionOnTape", "endPositionOnTape", "checksumValue", "checksumVerified" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"barcode", "in":"query", "description":"barcode", "required":true, "type":"string", "default":"*" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TapeFilesInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/tape/instances":{ "get":{ "tags":[ "ui" ], "summary":"Get Exported Tape Instances information.", "description":"Returns whether a list of exported instances are last instances.", "operationId":"getExportedTapeInstancesInfo", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"tapeBarcode", "in":"query", "description":"Tape barcode", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ExportedTapeInstancesInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/tapeLibraries":{ "get":{ "tags":[ "ui" ], "summary":"Gets Detailed Information on tape libraries.", "description":"Returns detailed information on tape libraries.", "operationId":"getTapeLibrariesInfo", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"serialNumber", "in":"query", "description":"Serial number", "required":true, "type":"string", "default":"*" }, { "name":"name", "in":"query", "description":"Name of library", "required":true, "type":"string", "default":"*" }, { "name":"type", "in":"query", "description":"Type of library", "required":true, "type":"string", "default":"*" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TapeLibrariesInfo" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/ui/tapes":{ "get":{ "tags":[ "ui" ], "summary":"Gets the list of all tapes in the configuration.", "description":"Returns tape information for all tapes in the configuration. If ACS/LSM is NOT specified, 0 is assumed. Note remainingSizeMB and totalSizeMB are big decimals and should be deserialized as decimal values.", "operationId":"getAllTapesUI", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"sortField", "in":"query", "description":"field of sort", "required":false, "type":"string", "enum":[ "barcode", "status", "acs", "lsm", "mediaType", "set", "group", "protected", "cloneEnabled", "compressionEnabled", "repackEnabled", "writeEnabled", "remainingSizeMB", "totalSizeMB", "firstMountDate", "firstInsertionDate", "lastArchiveDate", "lastRetentionDate", "lastCloneDate", "fragmentationRatio", "fillingRatio" ] }, { "name":"sortDirection", "in":"query", "description":"direction of sort", "required":false, "type":"string", "enum":[ "ASC", "DESC" ] }, { "name":"mediaType", "in":"query", "description":"mediaType", "required":false, "type":"string", "default":"*" }, { "name":"acsId", "in":"query", "description":"ACS id", "required":false, "type":"string", "default":"*" }, { "name":"lsmId", "in":"query", "description":"LSM id", "required":false, "type":"string", "default":"*" }, { "name":"barcode", "in":"query", "description":"barcode", "required":false, "type":"string", "default":"*" }, { "name":"group", "in":"query", "description":"group", "required":false, "type":"string", "default":"*" }, { "name":"cloneBarcode", "in":"query", "description":"cloneBarcode", "required":false, "type":"string", "default":"*" }, { "name":"set", "in":"query", "description":"set", "required":false, "type":"string", "default":"*" }, { "name":"isUsed", "in":"query", "description":"isUsed", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isProtected", "in":"query", "description":"isProtected", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isWritable", "in":"query", "description":"isWritable", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isEncrypted", "in":"query", "description":"isEncrypted", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isWriteOnceMedia", "in":"query", "description":"isWriteOnceMedia", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isSynchronized", "in":"query", "description":"isSynchronized", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isExternalized", "in":"query", "description":"isExternalized", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isCompressionEnabled", "in":"query", "description":"isCompressionEnabled", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isCloneEnabled", "in":"query", "description":"isCloneEnabled", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isRepackEnabled", "in":"query", "description":"isRepackEnabled", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"isTapeStateSet", "in":"query", "description":"isTapeStateSet (Checks if isCloneEnabled, isRepackEnabled OR isWritable is set to this value)", "required":false, "type":"string", "default":"*", "enum":[ "*", "Y", "N" ] }, { "name":"fillingRatioMin", "in":"query", "description":"fillingRatioMin", "required":false, "type":"integer", "format":"int32" }, { "name":"fillingRatioMax", "in":"query", "description":"fillingRatioMax", "required":false, "type":"integer", "format":"int32" }, { "name":"fragmentationRatioMin", "in":"query", "description":"fragmentationRatioMin", "required":false, "type":"integer", "format":"int32" }, { "name":"fragmentationRatioMax", "in":"query", "description":"fragmentationRatioMax", "required":false, "type":"integer", "format":"int32" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Tapes" } } }, "security":[ { "bearerAuth":[ ] } ] } }, "/users":{ "get":{ "tags":[ "user" ], "summary":"Gets the list of all users or get a single user by name.", "description":"Returns user information for all users.", "operationId":"getAllUsers", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"userName", "in":"query", "description":"name of user", "required":false, "type":"string" }, { "name":"page", "in":"query", "description":"page", "required":false, "type":"integer", "default":1, "format":"int32" }, { "name":"size", "in":"query", "description":"size", "required":false, "type":"integer", "default":5, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/UserOutputs" } } }, "security":[ { "bearerAuth":[ ] } ] }, "post":{ "tags":[ "user" ], "summary":"Creates a DIVA Core user.", "description":"Returns status for the creation of a user.", "operationId":"createUser", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"user", "description":"User to create", "required":true, "schema":{ "$ref":"#/definitions/UserRegistration" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid user supplied" } }, "security":[ { "bearerAuth":[ ] } ] }, "delete":{ "tags":[ "user" ], "summary":"Deletes a DIVA Core user.", "description":"Returns status for the deletion of a user.", "operationId":"deleteUser", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"userName", "in":"query", "description":"name of user", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid user supplied" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/users/login":{ "post":{ "tags":[ "user" ], "summary":"Login a user", "description":"Returns the created token.", "operationId":"login", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"userLogin", "description":"User for whom to create a token", "required":true, "schema":{ "$ref":"#/definitions/UserLogin" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Token" } }, "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/users/logout":{ "post":{ "tags":[ "user" ], "summary":"Logout a user", "description":"Returns the status.", "operationId":"logout", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/users/password":{ "put":{ "tags":[ "user" ], "summary":"Updates the password of a user.", "description":"Update the password of a user.", "operationId":"updatePassword", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"userName", "in":"query", "description":"name of user", "required":true, "type":"string" }, { "in":"body", "name":"credentials", "description":"passwords", "required":true, "schema":{ "$ref":"#/definitions/UserPasswordUpdate" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/users/role":{ "put":{ "tags":[ "user" ], "summary":"Updates the role of a user.", "description":"Returns status for update of a user's role.", "operationId":"updateRole", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" }, { "name":"userName", "in":"query", "description":"name of user", "required":true, "type":"string" }, { "in":"body", "name":"credentials", "description":"role", "required":true, "schema":{ "$ref":"#/definitions/UserRoleUpdate" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Status" } }, "400":{ "description":"Invalid role supplied" }, "404":{ "description":"User not found" } }, "security":[ { "bearerAuth":[ ] } ] } }, "/versions":{ "get":{ "tags":[ "version" ], "summary":"Gets DIVA build version and API version.", "description":"Returns the DIVA build version and the API version.", "operationId":"getDIVAVersion", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"Authorization", "in":"header", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DIVAVersions" } } }, "security":[ { "bearerAuth":[ ] } ] } } }, "definitions":{ "AbortionReason":{ "type":"object", "properties":{ "code":{ "type":"integer", "format":"int32", "example":0, "description":"code" }, "description":{ "type":"string", "description":"description" }, "name":{ "type":"string", "example":"DIVA_AR_NONE", "description":"name" } } }, "Actor":{ "type":"object", "required":[ "id", "name", "status" ], "properties":{ "actorToActorConnectTimeoutInSeconds":{ "type":"integer", "format":"int32", "example":60, "description":"actorToActorConnectTimeoutInSeconds" }, "actorToActorTransferTimeoutInSeconds":{ "type":"integer", "format":"int32", "example":5, "description":"actorToActorTransferTimeoutInSeconds" }, "address":{ "type":"string", "example":"127.0.0.1", "description":"address" }, "altoVirtualDrives":{ "type":"string", "example":"192.168.59.102:6480-ACS1-2,192.168.59.102:6480-ACS0-10", "description":"altoVirtualDrives" }, "associativeCopyEnabled":{ "type":"boolean" }, "cacheArchiveEnabled":{ "type":"boolean" }, "cacheReservedForRepack":{ "type":"integer", "format":"int32" }, "cacheRestoreEnabled":{ "type":"boolean" }, "cloneEnabled":{ "type":"boolean" }, "cloudArchiveEnabled":{ "type":"boolean" }, "cloudRestoreEnabled":{ "type":"boolean" }, "copyToGroupEnabled":{ "type":"boolean" }, "deleteEnabled":{ "type":"boolean" }, "directArchiveEnabled":{ "type":"boolean" }, "directRestoreEnabled":{ "type":"boolean" }, "disableDiskPreallocation":{ "type":"boolean" }, "diskDiscoveryEnabled":{ "type":"boolean" }, "diskFTPBlockSizeInKB":{ "type":"integer", "format":"int32", "example":32, "description":"diskFTPBlockSizeInKB" }, "diskFTPSocketWindowSizeInBytes":{ "type":"integer", "format":"int32", "example":65536, "description":"diskFTPSocketWindowSizeInBytes" }, "gxfTimecodeReference":{ "type":"integer", "format":"int32" }, "id":{ "type":"integer", "format":"int32", "description":"id" }, "isAVIIgnoreStartTimecode":{ "type":"boolean" }, "isDirectoryServer":{ "type":"boolean" }, "isDiskFTPPassiveMode":{ "type":"boolean" }, "isDoNotCheckCategory":{ "type":"boolean" }, "isDoNotCheckObjectName":{ "type":"boolean" }, "isEVSMXFIgnoreStartTimecode":{ "type":"boolean" }, "isGXFProgressiveTimecodeTranslation":{ "type":"boolean" }, "isLXFIgnoreStartTimecode":{ "type":"boolean" }, "isMPEG2ProgramStreamIgnoreStartTimecode":{ "type":"boolean" }, "isMPEG2TransportStreamIgnoreStartTimecode":{ "type":"boolean" }, "isMXFDurationFromFooter":{ "type":"boolean" }, "isMXFEnforceClosedHeader":{ "type":"boolean" }, "isMXFGenerateRandomIndexPack":{ "type":"boolean" }, "isMXFIgnoreStartTimecode":{ "type":"boolean" }, "isMXFSerializeDepthFirst":{ "type":"boolean" }, "isMXFTimecodeFromSourcePackage":{ "type":"boolean" }, "isMXFUpdateTCTrackOrigin":{ "type":"boolean" }, "isMXFUseOmneonDarkMeta":{ "type":"boolean" }, "isQuantelRenameClip":{ "type":"boolean" }, "isQuickTimeIgnoreStartTimecode":{ "type":"boolean" }, "isSeachangeIgnoreStartTimecode":{ "type":"boolean" }, "isUseMXFBMXLibrary":{ "type":"boolean" }, "maxBridgeOperations":{ "type":"integer", "format":"int32", "example":1, "description":"maxBridgeOperations" }, "maxDiskOperations":{ "type":"integer", "format":"int32", "example":5, "description":"maxDiskOperations" }, "maxDriveOperations":{ "type":"integer", "format":"int32", "example":3, "description":"maxDriveOperations" }, "maxServerOperations":{ "type":"integer", "format":"int32", "example":5, "description":"maxServerOperations" }, "maxStageOperations":{ "type":"integer", "format":"int32", "example":50, "description":"maxStageOperations" }, "mountPoint":{ "type":"string", "example":"/mnt", "description":"mountPoint" }, "mxfMaximumQueueSize":{ "type":"integer", "format":"int32", "example":100, "description":"mxfMaximumQueueSize" }, "mxfNumberofFramesPerBodyPartition":{ "type":"integer", "format":"int32", "example":50, "description":"mxfNumberofFramesPerBodyPartition" }, "mxfPartialRestoreDictionaryFile":{ "type":"string", "description":"mxfPartialRestoreDictionaryFile" }, "mxfRunInProcessor":{ "type":"string", "description":"mxfRunInProcessor" }, "mxfTimecodeValueToSwitchPackage":{ "type":"integer", "format":"int64", "example":0, "description":"mxfTimecodeValueToSwitchPackage" }, "mxfToleranceOnTCOUT":{ "type":"integer", "format":"int32" }, "name":{ "type":"string", "example":"test", "description":"name" }, "productionSystem":{ "type":"string", "example":"A valid production system name", "description":"productionSystem" }, "profileReadBlockSizeInBytes":{ "type":"integer", "format":"int32", "example":1500, "description":"profileReadBlockSizeInBytes" }, "profileWriteBlockSizeInBytes":{ "type":"integer", "format":"int32", "example":1500, "description":"profileWriteBlockSizeInBytes" }, "proxy":{ "type":"boolean" }, "quantelSelfContainedThresholdInMB":{ "type":"integer", "format":"int32", "example":10, "description":"quantelSelfContainedThresholdInMB" }, "quickTimeOmneonFirstFrameHandling":{ "type":"string", "example":"RESET", "description":"quickTimeOmneonFirstFrameHandling" }, "repackEnabled":{ "type":"boolean" }, "seachangeCheckDelayInMS":{ "type":"integer", "format":"int32" }, "simulatedLibraryPath":{ "type":"string", "description":"simulatedLibraryPath" }, "simulationReadErrorRatePercentage":{ "type":"integer", "format":"int32" }, "simulationTapeSizeInMB":{ "type":"integer", "format":"int32", "example":20, "description":"simulationTapeSizeInMB" }, "simulationWriteErrorRatePercentage":{ "type":"integer", "format":"int32" }, "site":{ "type":"string", "example":"A valid site name", "description":"site" }, "status":{ "type":"string", "example":"ONLINE", "description":"status", "enum":[ "ONLINE", "OFFLINE" ] }, "tapeTestUnitReadyTimeoutInSeconds":{ "type":"integer", "format":"int32", "example":60, "description":"tapeTestUnitReadyTimeoutInSeconds" }, "tcpPort":{ "type":"integer", "format":"int32", "example":9909, "description":"tcpPort" }, "udpPort":{ "type":"integer", "format":"int32", "example":10009, "description":"udpPort" }, "verifyTapeEnabled":{ "type":"boolean" } } }, "ActorDisk":{ "type":"object", "properties":{ "accessType":{ "type":"string", "example":"Read/Write", "description":"The type of access for the connection. May be one of: Read/Write, Read Only or Disabled.", "enum":[ "Read/Write/Delete", "Read/Delete", "Read Only", "Disabled" ] }, "actorName":{ "type":"string", "example":"A valid actor name", "description":"The name of the actor in this connection." }, "diskName":{ "type":"string", "example":"A valid disk name", "description":"The name of the disk in this connection." }, "interfaceType":{ "type":"string", "example":"s3", "description":"The type of interface used by this connection. Can be one of: local, remote, bml, ftp, metasan, simulation,mediagrid, swift, oci, s3, gcs or azcs.", "enum":[ "local", "remote", "bml", "ftp", "metasan", "simulation", "mediagrid", "swift", "oci", "s3", "gcs", "azcs" ] }, "maxThroughputMbps":{ "type":"integer", "format":"int64", "example":12500, "description":"The maximum throughput of the connection in Mbps." }, "mountPoint":{ "type":"string", "example":"A valid mount point", "description":"The mount point of an actor-disk connection. For an object storage connection, the name of the corresponding account is used." }, "status":{ "type":"string", "example":"Online/Offline status", "description":"The status of this connection.", "enum":[ "ONLINE", "OFFLINE" ] }, "usageType":{ "type":"string", "example":"STORAGE_AND_NEARLINE", "description":"The type of usage for the connection. May be one of: CACHE_AND_STORAGE, CACHE_ONLY, STORAGE_ONLY, STORAGE_AND_NEARLINE, CACHE_AND_STORAGE_AND_NEARLINE, WAN_TRANSFER_CACHE_ONLY.", "enum":[ "CACHE_AND_STORAGE", "CACHE_ONLY", "STORAGE_ONLY", "STORAGE_AND_NEARLINE", "CACHE_AND_STORAGE_AND_NEARLINE", "WAN_TRANSFER_CACHE_ONLY" ] } } }, "ActorDisks":{ "type":"object", "properties":{ "actorDisks":{ "type":"array", "items":{ "$ref":"#/definitions/ActorDisk" } }, "count":{ "type":"integer", "format":"int32" } } }, "ActorDrive":{ "type":"object", "properties":{ "actorName":{ "type":"string", "example":"A valid actor name", "description":"The name of the actor in this connection." }, "driveName":{ "type":"string", "example":"A valid drive name", "description":"The name of the drive in this connection." }, "status":{ "type":"string", "example":"Online/Offline status", "description":"The status of this connection.", "enum":[ "ONLINE", "OFFLINE" ] } } }, "ActorDrives":{ "type":"object", "properties":{ "actorDrives":{ "type":"array", "items":{ "$ref":"#/definitions/ActorDrive" } }, "count":{ "type":"integer", "format":"int32" } } }, "ActorInfo":{ "type":"object", "properties":{ "address":{ "type":"string" }, "associativeCopyEnabled":{ "type":"boolean" }, "available":{ "type":"boolean" }, "cacheArchiveEnabled":{ "type":"boolean" }, "cacheForRepack":{ "type":"integer", "format":"int32" }, "cacheRestoreEnabled":{ "type":"boolean" }, "classicEnabled":{ "type":"boolean" }, "connectedDrives":{ "type":"array", "items":{ "type":"string" } }, "copyToGroupEnabled":{ "type":"boolean" }, "deleteEnabled":{ "type":"boolean" }, "directArchiveEnabled":{ "type":"boolean" }, "directRestoreEnabled":{ "type":"boolean" }, "name":{ "type":"string" }, "repackEnabled":{ "type":"boolean" } } }, "ActorProxies":{ "type":"object", "properties":{ "actorProxies":{ "type":"array", "description":"List of actor-proxies.", "items":{ "$ref":"#/definitions/ActorProxy" } }, "count":{ "type":"integer", "format":"int32" } } }, "ActorProxy":{ "type":"object", "properties":{ "actorName":{ "type":"string", "example":"A valid actor name", "description":"The name of the actor in this connection." }, "proxyName":{ "type":"string", "example":"A valid proxy name", "description":"The name of the proxy in this connection." } } }, "Actors":{ "type":"object", "properties":{ "actors":{ "type":"array", "items":{ "$ref":"#/definitions/Actor" } }, "count":{ "type":"integer", "format":"int32" } }, "description":"Definition of Actors" }, "AggregatedMediaSizeByType":{ "type":"object", "properties":{ "array":{ "$ref":"#/definitions/MediaSize" }, "cloudWithQuota":{ "$ref":"#/definitions/MediaSize" }, "cloudWithoutQuota":{ "$ref":"#/definitions/MediaSize" }, "group":{ "$ref":"#/definitions/MediaSize" } } }, "AnalyticsEvent":{ "type":"object", "properties":{ "actorName":{ "type":"string", "description":"The name of the actor referenced by the analytics event." }, "barcode":{ "type":"string", "description":"The tape barcode referenced by the analytics event." }, "collectionName":{ "type":"string", "description":"The name of the collection (category) referenced by the analytics event." }, "diskName":{ "type":"string", "description":"The name of the disk referenced by the analytics event." }, "divaSystem":{ "type":"string", "description":"The DIVA Core system referenced by the analytics event." }, "driveName":{ "type":"string", "description":"The name of the drive referenced by the analytics event." }, "driveSerialNumber":{ "type":"string", "description":"The serial number of the drive referenced by the analytics event." }, "driveType":{ "type":"string", "description":"The type of drive referenced by the analytics event." }, "duration":{ "type":"integer", "format":"int32", "description":"The duration of the analytics event." }, "endTime":{ "type":"string", "format":"date-time", "description":"The end time as a local date time referenced by the analytics event." }, "errorClassification":{ "type":"string", "description":"The error classification for the analytics event." }, "errorCode":{ "type":"integer", "format":"int32", "description":"The error code for the analytics event." }, "errorMessage":{ "type":"string", "description":"The error message for the analytics event." }, "errorRate":{ "type":"integer", "format":"int64", "description":"The error rate for the analytics event." }, "eventDescription":{ "type":"string", "description":"The description of the analytics event." }, "eventName":{ "type":"string", "description":"The name of the analytics event." }, "id":{ "type":"integer", "format":"int32", "example":1, "description":"The identifier for an analytics event." }, "instanceNumber":{ "type":"integer", "format":"int32", "description":"The instance number of the object referenced by the analytics event." }, "librarySerialNumber":{ "type":"string", "description":"The serial number of the library referenced by the analytics event." }, "mediaName":{ "type":"string", "description":"The media name referenced by the analytics event." }, "numberOfOperations":{ "type":"integer", "format":"int64", "example":1, "description":"The number of operations for the analytics event." }, "objectName":{ "type":"string", "description":"The name of the object referenced by the analytics event." }, "requestId":{ "type":"integer", "format":"int32", "description":"The request identifier referenced by the analytics event." }, "sizeBytes":{ "type":"integer", "format":"int64", "example":1, "description":"The size in bytes for the analytics event." }, "sourceDestName":{ "type":"string", "description":"The server name referenced by the analytics event." }, "tapeType":{ "type":"string", "description":"The type of tape referenced by the analytics event." }, "transcoderAnalyzerName":{ "type":"string", "description":"The transcoder analyzer name referenced by the analytics event." }, "transferRate":{ "type":"integer", "format":"int64", "description":"The transfer rate for the analytics event." }, "transferSize":{ "type":"integer", "format":"int64", "description":"The size of the transfer for the analytics event." } } }, "AnalyticsEventCount":{ "type":"object", "properties":{ "data":{ "type":"array", "description":"The list of counts for the analytics event.", "items":{ "type":"array", "items":{ "type":"object" } } }, "name":{ "type":"string", "description":"The name of the analytics event." } } }, "AnalyticsEventDefinition":{ "type":"object", "properties":{ "description":{ "type":"string", "description":"The description of the analytic event." }, "id":{ "type":"integer", "format":"int32", "description":"The analytic event identifier." }, "name":{ "type":"string", "description":"The name of the analytic event." } } }, "AnalyticsEventDefinitions":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "definitions":{ "type":"array", "description":"List of analytic event definitions.", "items":{ "$ref":"#/definitions/AnalyticsEventDefinition" } } } }, "AnalyticsEvents":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "events":{ "type":"array", "description":"List of analytic events.", "items":{ "$ref":"#/definitions/AnalyticsEvent" } }, "summary":{ "type":"array", "description":"List of analytic event counts.", "items":{ "$ref":"#/definitions/AnalyticsEventCount" } } } }, "ArchiveRequestBody":{ "type":"object", "required":[ "collectionName", "components", "media", "objectName", "sourceServer" ], "properties":{ "collectionName":{ "type":"string", "example":"testCollectionName", "description":"Collection Name (Category) of the Object" }, "comments":{ "type":"string", "example":" ", "description":"Optional information describing the object." }, "components":{ "type":"array", "description":"List of file pathnames relative to the folder specified by the filePathRoot parameter. When filePathRoot is null, pathnames must be absolute names.", "items":{ "type":"string" } }, "filePathRoot":{ "type":"string", "description":"Root folder for the files specified by the filenamesList parameter." }, "media":{ "type":"string", "example":"A Valid Media, ex: array_002_axf", "description":"Media designates either a Group of Tapes or an Array of Disks declared in the configuration where the instance has to be created.DIVA CONNECT - Normally DIVA Connect will archive to the local site. If the sitename is prepended to the media, the archive may be directed to the specified site. For example site1_TapeGroup1." }, "objectName":{ "type":"string", "example":"testObjectName", "description":"Name of the Object to be archived." }, "options":{ "type":"string", "example":" ", "description":"DIVA CORE - Additional options for performing the transfer of data from the source to DIVA Core. These options supersede any options specified in the DIVA Core configuration database. Currently the possible values for options are as follows: Empty string specifies no options. -delete_on_source Executes a delete on the source server after an archive request completes. -r Using -r specifies that every name in filenamesList that refers to a folder must be scanned recursively. This also applies when FilesPathRoot is specified and an asterisk designates the files to be archived. This option can be used when archiving from a local source or from a standard FTP Server.-login A user name and password is required to log in to some sources. This option obsoletes the -gateway option from earlier releases.-pass The password used with -login. The following is for DIVA Core releases 7.1.2 and later only:-gcinfilelist [gcType] Specifies that Genuine Checksum (GC) values are included in the file names list. The value of gcType must match the Manager's default checksum type as specified in the DIVA Core configuration (MD5 by default). The GC values are then used to verify the transfer from the source.requestNumber The request number assigned to this request. This number is used for querying the status or canceling the request.DIVA CONNECT- In addition to the above, the -site [sitename] option is supported. Normally DIVA Connect willarchive to the local site. If this option is used, the archive may be directed to the specified site." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority level for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred the highest priority" }, "qos":{ "type":"integer", "format":"int32", "example":0, "description":"One of the following codes: DIVA_QOS_DEFAULT (0): Archiving is performed according to the default Quality Of Service (currently: direct and cache for archive operations). DIVA_QOS_CACHE_ONLY (1): Use cache archive only. DIVA_QOS_DIRECT_ONLY (2): Use direct archive only. No Disk Instance is created. DIVA_QOS_DIRECT_AND_CACHE (3): Use direct archive if available or cache archive if direct archive is not available. DIVA_QOS_CACHE_AND_DIRECT (4): Use cache archive if available or direct archive if cache archive is not available. Additional and optional services are available. To request those services, use a logical OR between the previously documented Quality Of Service parameter and the following constant: DIVA_ARCHIVE_SERVICE_DELETE_ON_SOURCE (0x0100): Delete source files when the tape migration is done. Available for local sources, disk sources, and standard ftp sources. " }, "sourceServer":{ "type":"string", "example":"A Valid Source Server Name, ex: ftproot", "description":"Name of the Source (e.g. video server, browsing server). This name must be known to the DIVA Core Configuration Description. " } }, "description":"definition of an archive request" }, "ArchiveSystemInfo":{ "type":"object", "properties":{ "actors":{ "type":"array", "description":"List of DIVA Core Actor information.", "items":{ "$ref":"#/definitions/ActorInfo" } }, "capSize":{ "type":"integer", "format":"int32", "description":"The number of slots in the default CAP." }, "currentRequests":{ "type":"array", "description":"The number of current requests.", "items":{ "type":"integer", "format":"int32" } }, "divaGlobalState":{ "description":"The status of DIVArchive.", "$ref":"#/definitions/GlobalState" }, "divaLibraryState":{ "description":"This is ok if at least one ACS is online.", "$ref":"#/definitions/LibraryState" }, "divaVersion":{ "type":"string", "description":"The version of DIVA Core Manager" }, "drives":{ "type":"array", "description":"List of DIVA Core Drives information.", "items":{ "$ref":"#/definitions/DriveInfo" } }, "firstUsedRequestId":{ "type":"integer", "format":"int32" }, "isDatabaseConnected":{ "type":"boolean", "example":false, "description":"Whether the database is connected or not" }, "lastUsedRequestId":{ "type":"integer", "format":"int32" }, "licenseExpirationDate":{ "type":"string", "format":"date-time", "description":"The license expiration date" }, "lsms":{ "type":"array", "description":"List of DIVA Core LSM information.", "items":{ "$ref":"#/definitions/LSMInfo" } }, "managerStartDate":{ "type":"string", "format":"date-time", "description":"Manager start date" }, "numberOfAvailableActors":{ "type":"integer", "format":"int32", "description":"The number of currently running Actors." }, "numberOfAvailableDisks":{ "type":"integer", "format":"int32", "description":"The number of disks currently in online status." }, "numberOfAvailableDrives":{ "type":"integer", "format":"int32", "description":"The number of drives currently in online status." }, "numberOfBlankTapes":{ "type":"integer", "format":"int32", "description":"The number of blank tapes in a Set associated with at least one group. Tape(s) may be externalized or write disabled." }, "numberOfObjects":{ "type":"integer", "format":"int32", "description":"The number of objects managed by this DIVA Core system." }, "pendingRequests":{ "type":"array", "description":"The number of pending requests.", "items":{ "type":"integer", "format":"int32" } }, "remainingSizeOnTapesInGB":{ "type":"integer", "format":"int64", "description":"The sum of the remaining size of tapes (in gigabytes) that are online, in a Set associated with at least one group in an ACS where DIVA Core has a drive that is writable, and the remaining size on disks accepting permanent storage. Only disks that are currently visible are used in the calculation. Remaining_Size_of_Online_Tapes + Remaining_Size_of_Disks_Accepting_ Permanent_Storage." }, "site":{ "type":"string", "description":"The name of the main site as entered in the configuration." }, "siteIp":{ "type":"string", "description":"The Manager IP Address." }, "sitePort":{ "type":"integer", "format":"int32", "description":"The port number where the Manager is listening." }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" }, "totalSizeOnTapesInGB":{ "type":"integer", "format":"int64", "description":"The sum of the total size of all tapes (in gigabytes) in a Set associated with at least one group available for DIVArchive, and of the total size of all disks accepting storage. Only disks that are currently visible are used in the calculation. Total_Size_of_all_Available_Tapes + Total_Size_of_all_Disks_Accepting_ Storage" } } }, "AssociativeCopyRequestBody":{ "type":"object", "properties":{ "collectionNames":{ "type":"array", "example":"cat1,cat2", "description":"List of collection names", "items":{ "type":"string" } }, "media":{ "type":"string", "example":"default", "description":"The name of the group where the new instance will be located. Complex objects can only be saved to AXF media types. Associative Copy to a disk array is not available." }, "objectNames":{ "type":"array", "example":"name1,name2", "description":"List of object names", "items":{ "type":"string" } }, "options":{ "type":"string", "description":"An optional string attribute for specifying additional parameters to the request." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The level of priority for this request. The priority can be in the range zero to one hundred or the value DIVA_DEFAULT_REQUEST_PRIORITY. The value zero is the lowest priority and one hundred is the highest priority." } }, "description":"definition of an associative copy request" }, "AutomaticRepackSettings":{ "type":"object", "properties":{ "friday":{ "$ref":"#/definitions/AutomaticRepackWeekDaySetting" }, "groups":{ "type":"array", "items":{ "type":"string" } }, "isEnabled":{ "type":"boolean" }, "monday":{ "$ref":"#/definitions/AutomaticRepackWeekDaySetting" }, "saturday":{ "$ref":"#/definitions/AutomaticRepackWeekDaySetting" }, "sunday":{ "$ref":"#/definitions/AutomaticRepackWeekDaySetting" }, "tapeFillingThresholdPercent":{ "type":"integer", "format":"int32" }, "tapeFragmentationThresholdPercent":{ "type":"integer", "format":"int32" }, "thursday":{ "$ref":"#/definitions/AutomaticRepackWeekDaySetting" }, "tuesday":{ "$ref":"#/definitions/AutomaticRepackWeekDaySetting" }, "wednesday":{ "$ref":"#/definitions/AutomaticRepackWeekDaySetting" } } }, "AutomaticRepackWeekDaySetting":{ "type":"object", "properties":{ "durationHours":{ "type":"integer", "format":"int32" }, "durationMinutes":{ "type":"integer", "format":"int32" }, "startHours":{ "type":"integer", "format":"int32" }, "startMinutes":{ "type":"integer", "format":"int32" } } }, "BrokerClientInfo":{ "type":"object", "properties":{ "brokerSettings":{ "$ref":"#/definitions/BrokerSettings" }, "clientId":{ "type":"string" } } }, "BrokerClientInfoBody":{ "type":"object", "required":[ "clientId" ], "properties":{ "clientId":{ "type":"string", "example":"ebb88abc-817e-4f30-9e27-14c90ad6f957", "description":"Identifier of client connected to broker" } }, "description":"definition of client connected to broker" }, "BrokerSettings":{ "type":"object", "properties":{ "brokerPassword":{ "type":"string" }, "brokerServiceURL":{ "type":"string" }, "brokerUsername":{ "type":"string" } } }, "CAP":{ "type":"object", "properties":{ "acs":{ "type":"integer", "format":"int32" }, "id":{ "type":"integer", "format":"int32" }, "isOnline":{ "type":"boolean" }, "name":{ "type":"string" }, "robotName":{ "type":"string" }, "size":{ "type":"integer", "format":"int32" } } }, "CAPs":{ "type":"object", "properties":{ "caps":{ "type":"array", "items":{ "$ref":"#/definitions/CAP" } }, "count":{ "type":"integer", "format":"int32" } } }, "CheckSumInfo":{ "type":"object", "properties":{ "isGenuine":{ "type":"boolean" }, "type":{ "type":"string" }, "value":{ "type":"string" } } }, "CloneTapeRequestBody":{ "type":"object", "properties":{ "options":{ "type":"string", "description":"Request options." }, "priority":{ "type":"integer", "format":"int32", "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred the highest priority." }, "tapeBarcode":{ "type":"string", "description":"Barcode of tape to be cloned." } }, "description":"definition of an clone tape request" }, "ConfigParameter":{ "type":"object", "properties":{ "availableValues":{ "type":"array", "items":{ "type":"string" } }, "category":{ "type":"string" }, "description":{ "type":"string" }, "name":{ "type":"string" }, "subParameters":{ "type":"array", "items":{ "$ref":"#/definitions/ConfigParameter" } }, "type":{ "type":"string" }, "value":{ "type":"string" } } }, "ConfigParameters":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "parameters":{ "type":"array", "items":{ "$ref":"#/definitions/ConfigParameter" } } } }, "CopyToGroupRequestBody":{ "type":"object", "required":[ "collectionName", "media", "objectName" ], "properties":{ "collectionName":{ "type":"string", "example":"testCollectionName", "description":"The collection name (category) assigned to the object when it was archived. This parameter can be a null string; however this may result in an error if several objects have the same name." }, "instance":{ "type":"integer", "format":"int32", "example":0, "description":"The instance's identifier." }, "media":{ "type":"string", "example":"A Valid Media, ex: array_002_axf", "description":"The media (tape group or disk array) where the new instance will be located. If used with DIVA Connect the meda name may be prefixed with the target site name. Ex: site2_array_002_axf" }, "objectName":{ "type":"string", "example":"testObjectName", "description":"The name of the object to be copied." }, "options":{ "type":"string", "description":"An optional string attribute for specifying additional parameters to the request. When used with DIVA Connect the following optionsare supported: -site, -fromSite, -autocopy, -autodelaymins and -replaceTarget." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The level of priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority." } }, "description":"definition of a copy request" }, "CopyToNewRequestBody":{ "type":"object", "required":[ "collectionName", "newCollectionName", "newMedia", "newObjectName", "objectName" ], "properties":{ "collectionName":{ "type":"string", "example":"testCollectionName", "description":"The source object collection name (category)." }, "comments":{ "type":"string", "description":"Optional information describing the target object. If left empty the source object comments are inherited." }, "instance":{ "type":"integer", "format":"int32", "example":0, "description":"The Instance ID of the source object instance." }, "media":{ "type":"string", "example":"A Valid Media, ex: array_002_axf", "description":"The tape group or disk array of the source object instance" }, "newCollectionName":{ "type":"string", "example":"newTestCollectionName", "description":"The target collection name (category)." }, "newMedia":{ "type":"string", "example":"A Valid Media, ex: array_002_axf", "description":"The tape group or disk array where the object will be saved." }, "newObjectName":{ "type":"string", "example":"newTestObjectName", "description":"The target object name." }, "objectName":{ "type":"string", "example":"testObjectName", "description":"The source object name." }, "options":{ "type":"string", "description":"Optional string attribute for specifying additional parameters to the request. If connect to DIVA Connect, the -site option may be used to route the copy to a site other then the local site." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"Level of priority for this request. The possible values can be in the range zero to one hundred." } }, "description":"definition of a copy to new object request" }, "DBMigrationRequestBody":{ "type":"object", "required":[ "-dbMigration" ], "properties":{ "-batchSize":{ "type":"integer", "format":"int32", "description":"Migration data set batch size,parameter not passed will default to 1,000" }, "-category":{ "type":"string", "description":"Category name to Migrate, do not set to migrate all groups!" }, "-dbMigration":{ "type":"string", "description":"DB Migration version 8.1 or 8.2", "enum":[ "8.1", "8.2" ] }, "-metadataRoot":{ "type":"string", "description":"Required for -dbMigration 8.1 used to locate metadata files " }, "-report":{ "type":"string", "description":"Used to check on migration status. Default is null indicating new request.", "enum":[ "PROGRESS", "MIGRATE_LIST", "MIGRATED_LIST" ] } }, "description":"definition of a dbMigration request" }, "DIVAConfiguration":{ "type":"object", "properties":{ "brokerSettings":{ "$ref":"#/definitions/BrokerSettings" }, "cloneGroupFrequency":{ "type":"integer", "format":"int32" }, "complexObjectsDBLocation":{ "type":"string" }, "dashboardRefreshDelayMs":{ "type":"integer", "format":"int32" }, "dbBackupMonitorTimeoutMin":{ "type":"integer", "format":"int32" }, "dbBackupNotificationType":{ "type":"string", "example":"DISABLED", "description":"dbBackupNotificationType", "enum":[ "ERRORS and WARNINGS", "ERRORS", "DISABLED" ] }, "defaultChecksumType":{ "type":"string", "example":"MD5", "description":"defaultChecksumType", "enum":[ " ", "MD2", "MD5", "SHA", "SHA1", "MDC2", "RIPEMD160" ] }, "diskDiscoveryPublisherEndpoint":{ "type":"string" }, "divaCoreUUID":{ "type":"string" }, "emailAccount":{ "$ref":"#/definitions/EmailAccount" }, "isCancelRequestByOperatorEnabled":{ "type":"boolean" }, "isChangeRequestPriorityByOperatorEnabled":{ "type":"boolean" }, "isChecksumEnabled":{ "type":"boolean" }, "isDemo":{ "type":"boolean" }, "isEmailNotificationEnabled":{ "type":"boolean" }, "isExportOfEncryptionKeysEnabled":{ "type":"boolean" }, "isMetadataDBEnabled":{ "type":"boolean" }, "isRestoreWhenMetadataDBNotAvailableAllowed":{ "type":"boolean" }, "isRetryWithDifferentDriveOnFailedChecksumEnabled":{ "type":"boolean" }, "isUUIDPreservationEnabled":{ "type":"boolean" }, "maxAttemptsToLockObject":{ "type":"integer", "format":"int32" }, "maxIntervalBetweenAttemptsToLockObjectSec":{ "type":"integer", "format":"int32" }, "maxNumberOfRecordsInDPOperationsTable":{ "type":"integer", "format":"int64" }, "maxSimultaneousClones":{ "type":"integer", "format":"int32" }, "mediaSPMDelimiter":{ "type":"string" }, "metadataServiceURL":{ "type":"string" }, "metadataSourceType":{ "type":"string", "example":"REST Service", "description":"metadataSourceType", "enum":[ "File Database", "REST Service", "Both Services" ] }, "numRetriesOnFailedChecksum":{ "type":"integer", "format":"int32" }, "tapeEncryptionKeystorePassword":{ "type":"string" } } }, "DIVAEvent":{ "type":"object", "properties":{ "description":{ "type":"string", "example":"Unable to backup the database", "description":"description" }, "severity":{ "type":"string", "example":"ERROR", "description":"severity", "enum":[ "INFORMATION", "WARNING", "ERROR" ] }, "type":{ "type":"string", "example":"DB_BACKUP", "description":"source", "enum":[ "DB_BACKUP", "DB_BACKUPS_TAPES_LIST", "REQUEST", "CONFIG_NOTIFICATION", "MDS_ONLINE", "MDS_OFFLINE", "MDS_MONGODB_ONLINE", "MDS_MONGODB_OFFLINE", "MDS_SOLR_ONLINE", "MDS_SOLR_OFFLINE" ] } } }, "DIVAExclusionInstance":{ "type":"object", "properties":{ "category":{ "type":"string" }, "instanceID":{ "type":"integer", "format":"int32" }, "objectName":{ "type":"string" }, "options":{ "type":"string" } } }, "DIVAInstance":{ "type":"object", "properties":{ "category":{ "type":"string" }, "instanceID":{ "type":"integer", "format":"int32" }, "media":{ "type":"string" }, "objectName":{ "type":"string" }, "options":{ "type":"string" } } }, "DIVAObject":{ "type":"object", "properties":{ "category":{ "type":"string" }, "objectName":{ "type":"string" }, "options":{ "type":"string" } } }, "DIVAObject2":{ "type":"object", "properties":{ "collectionName":{ "type":"string" }, "objectName":{ "type":"string" }, "options":{ "type":"string" } } }, "DIVAObjectTuple":{ "type":"object", "properties":{ "objectName":{ "type":"string" }, "collectionName":{ "type":"string" } } }, "DIVAProtectConfiguration":{ "type":"object", "properties":{ "isEnableConfig":{ "type":"boolean" }, "isEnableDataCollection":{ "type":"boolean" }, "maxHistoryOfEventsInMonths":{ "type":"integer", "format":"int32" }, "maxNumberOfMetrics":{ "type":"integer", "format":"int32" }, "sizeTriggeringEventQueueDBFlush":{ "type":"integer", "format":"int32" }, "timeDelayTriggeringEventQueueDBFlush":{ "type":"integer", "format":"int32" } } }, "DIVAProtectEventDefinition":{ "type":"object", "properties":{ "description":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" }, "parameters":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAProtectEventParameter" } } } }, "DIVAProtectEventDefinitions":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "definitions":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAProtectEventDefinition" } } } }, "DIVAProtectEventDictionary":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "dictionary":{ "type":"object", "additionalProperties":{ "type":"array", "items":{ "type":"string" } } } } }, "DIVAProtectEventParameter":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" } } }, "DIVAProtectEventParameters":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "parameters":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAProtectEventParameter" } } } }, "DIVAProtectMetricCollectionType":{ "type":"object", "properties":{ "description":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" } } }, "DIVAProtectMetricCollectionTypes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "types":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAProtectMetricCollectionType" } } } }, "DIVAProtectMetricDefinition":{ "type":"object", "properties":{ "collectedEvents":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAProtectSimpleEventDefinition" } }, "collectionInterval":{ "type":"string" }, "collectionMetadataType":{ "type":"string" }, "collectionType":{ "type":"string" }, "description":{ "type":"string" }, "enabled":{ "type":"boolean" }, "name":{ "type":"string" }, "resourceType":{ "type":"string" }, "weightType":{ "type":"string" } } }, "DIVAProtectMetricDefinitions":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "definitions":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAProtectMetricDefinition" } } } }, "DIVAProtectMetricResourceType":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" } } }, "DIVAProtectMetricResourceTypes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "types":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAProtectMetricResourceType" } } } }, "DIVAProtectSimpleEventDefinition":{ "type":"object", "properties":{ "name":{ "type":"string" } } }, "DIVAProtectStorageIntervalUnits":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "values":{ "type":"array", "items":{ "type":"string" } } } }, "DIVAVersions":{ "type":"object", "properties":{ "APIVersion":{ "type":"string" }, "DIVABuildVersion":{ "type":"string" } } }, "DeleteFileForCategoryMaskStatus":{ "type":"object", "properties":{ "emptyObjects":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAObject" } }, "isMoreEmptyObjectsExist":{ "type":"boolean" }, "numberOfAffectedObjects":{ "type":"integer", "format":"int32" }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" } } }, "DeleteFileStatus":{ "type":"object", "properties":{ "emptyObjectNames":{ "type":"array", "items":{ "type":"string" } }, "isMoreEmptyObjectsExist":{ "type":"boolean" }, "numberOfAffectedObjects":{ "type":"integer", "format":"int32" }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" } } }, "DeleteRequestBody":{ "type":"object", "required":[ "objectName" ], "properties":{ "collectionName":{ "type":"string", "example":"testCollectionName", "description":"The collection name (category) assigned to the object when it was archived. This parameter can be a null string, however this may result in an error if several objects have the same name." }, "instance":{ "type":"integer", "format":"int32", "description":"The instance's identifier" }, "media":{ "type":"string", "example":"A Valid Media, ex: array_002_axf", "description":"Defines the media that contains the valid instance. If the instanceId is -1, the instance on the media will be deleted. If the media contains 2 or more instances, only one of the instances will be deleted." }, "objectName":{ "type":"string", "example":"testObjectName", "description":"The name of the object to be deleted." }, "options":{ "type":"string", "description":"An optional string attribute for specifying additional parameters to the request. When connected to DIVA Connect the -site option will remove instances from the specified site." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The level of priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority. " } }, "description":"definition of a delete request" }, "DestinationMediaInfo":{ "type":"object", "properties":{ "name":{ "type":"string" }, "requiredInstanceCount":{ "type":"integer", "format":"int32" } } }, "DetailedObjectInfo":{ "type":"object", "properties":{ "archiveDate":{ "type":"integer", "format":"int64" }, "collectionName":{ "type":"string" }, "comments":{ "type":"string" }, "complex":{ "type":"boolean" }, "externalized":{ "type":"boolean" }, "filesPathRoot":{ "type":"string" }, "instances":{ "type":"array", "items":{ "$ref":"#/definitions/InstanceInfo" } }, "lastReadDate":{ "type":"integer", "format":"int64" }, "locked":{ "type":"boolean" }, "nbInstances":{ "type":"integer", "format":"int32" }, "objectName":{ "type":"string" }, "sizeInKB":{ "type":"integer", "format":"int64" }, "source":{ "type":"string" }, "storagePlan":{ "type":"string" }, "uuid":{ "type":"string" } } }, "DiskArray":{ "type":"object", "properties":{ "bucketName":{ "type":"string", "description":"The name of the bucket for all instances of the array." }, "cloudQuota":{ "type":"integer", "format":"int64", "description":"The quota assigned to an unlimited size cloud array in KB. This value is only used to compute the remaining size and is only relevant to unlimited size cloud disks." }, "description":{ "type":"string", "example":"test array description", "description":"The description of the array." }, "disks":{ "$ref":"#/definitions/DisksForArray" }, "emc":{ "type":"boolean" }, "format":{ "type":"string", "example":"AXF_1_1", "description":"The format of the data on disks in this array. The value can be LEGACY, AXF_0_9, AXF_1_0, AXF_1_1, AXF_RF_1_1, FLASHNET_LOOSE, FLASHNET_DTOOL." }, "formatId":{ "type":"integer", "format":"int32", "example":3, "description":"The format (as integer) of the data on disks in this array. The value can be 0 (LEGACY), 1 (AXF_0_9), 2 (AXF_1_0), 3 (AXF_1_1), 4 (AXF_RF_1_1), 8 (FLASHNET_LOOSE), 9 (FLASHNET_DTOOL)." }, "id":{ "type":"integer", "format":"int64", "example":1, "description":"The id of the array." }, "isBucketKeyEnabled":{ "type":"boolean", "example":true, "description":"Whether bucket key is enabled. Please refer to AWS x-amz-server-side-encryption-bucket-key-enabled" }, "isCloud":{ "type":"boolean", "example":true, "description":"Whether an array is a cloud array." }, "isDisableETagVerification":{ "type":"boolean", "example":true, "description":"Whether to disable etag verification." }, "isUseRandomSMBAddress":{ "type":"boolean", "example":true, "description":"Whether to use a random SMB address." }, "isUseVirtualHostedStyle":{ "type":"boolean", "example":true, "description":"Whether to use virtual hosted style." }, "kmsKeyId":{ "type":"string", "example":"key", "description":"The KMS Key Id. Please refer to AWS x-amz-server-side-encryption-aws-kms-key-id" }, "maxDiskPercentForMigrate":{ "type":"integer", "format":"int32", "example":50, "description":"Percent of disk allocated to migrate" }, "maxDiskPercentForRepack":{ "type":"integer", "format":"int32", "example":50, "description":"Percent of disk allocated to repack requests" }, "maxInstancesPerContainer":{ "type":"integer", "format":"int32", "example":1000, "description":"The maximum number of instances per bucket / container" }, "name":{ "type":"string", "example":"test", "description":"The name of the array." }, "objectPathPrefix":{ "type":"string", "example":"NONE", "description":"The path prefix used to store an object. One of NONE, UUID, OBJECT_NAME, CATEGORY or NAME_AND_CATEGORY.", "enum":[ "NONE", "UUID", "OBJECT_NAME", "CATEGORY", "NAME_AND_CATEGORY" ] }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority level for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred the highest priority. " }, "restoreTier":{ "type":"string", "example":"NONE", "description":"The restore tier. One of: NONE, EXPEDITED, STANDARD, BULK, OSS_STANDARD or HIGH.", "enum":[ "NONE", "EXPEDITED", "STANDARD", "BULK", "OSS_STANDARD", "HIGH" ] }, "serverSideEncryption":{ "type":"string", "description":"The AWS server side encryption setting." }, "storageClass":{ "type":"string", "example":"STANDARD", "description":"The storage class. one of ARCHIVE, STANDARD, INTELLIGENT_TIERING, ONEZONE_IA, STANDARD_IA, GLACIER, GLACIER_IR, DEEP_ARCHIVE, OSS_STANDARD, OSS_IA, OSS_COLD_ARCHIVE, NEARLINE or COLDLINE,HOT, COOL", "enum":[ "NONE", "ARCHIVE", "STANDARD", "UNDEFINED", "INTELLIGENT_TIERING", "ONEZONE_IA", "STANDARD_IA", "GLACIER", "DEEP_ARCHIVE", "OSS_STANDARD", "OSS_IA", "NEARLINE", "COLDLINE", "HOT", "COOL", "OSS_COLD_ARCHIVE", "OSS_ARCHIVE", "GLACIER_IR" ] }, "storageLocation":{ "type":"string", "example":"S3", "description":"The storage location. One of LOCAL, OCI, S3, GCS and AZCS.", "enum":[ "LOCAL", "CLOUD", "OPC", "OCI", "UNDEFINED", "S3", "GCS", "AZCS" ] }, "storageOptions":{ "type":"string", "example":"-virtual_hosted_style", "description":"Various storage options including the storage class and location." }, "verifyWrite":{ "type":"boolean", "example":true, "description":"Whether verify write is enabled" } } }, "DiskArrayWODisks":{ "type":"object", "properties":{ "bucketName":{ "type":"string", "description":"bucketName" }, "cloudQuota":{ "type":"integer", "format":"int64", "description":"The quota assigned to an unlimited size cloud array in KB. This value is only used to compute the remaining size and is only relevant to unlimited size cloud disks." }, "description":{ "type":"string", "example":"test array description", "description":"description" }, "format":{ "type":"string", "example":"AXF_1_1", "description":"The format of the array. One of: LEGACY, AXF_0_9, AXF_1_0, AXF_1_1, AXF_RF_1_1, FLASHNET_LOOSE, FLASHNET_DTOOL." }, "isBucketKeyEnabled":{ "type":"boolean", "example":true, "description":"Whether bucket key is enabled. Please refer to AWS x-amz-server-side-encryption-bucket-key-enabled" }, "isDisableETagVerification":{ "type":"boolean", "example":true, "description":"Disable ETag verification." }, "isUseRandomSMBAddress":{ "type":"boolean", "example":true, "description":"Whether to use a random SMB address." }, "isUseVirtualHostedStyle":{ "type":"boolean", "example":true, "description":"isUseVirtualHostedStyle" }, "kmsKeyId":{ "type":"string", "example":"key", "description":"The KMS Key Id. Please refer to AWS x-amz-server-side-encryption-aws-kms-key-id" }, "maxDiskPercentForMigrate":{ "type":"integer", "format":"int32", "example":30, "description":"maxDiskPercentForMigrate" }, "maxDiskPercentForRepack":{ "type":"integer", "format":"int32", "example":100, "description":"maxDiskPercentForRepack" }, "maxInstancesPerContainer":{ "type":"integer", "format":"int32", "example":100000, "description":"maxInstancesPerContainer" }, "name":{ "type":"string", "example":"testarray", "description":"name" }, "objectPathPrefix":{ "type":"string", "example":"NONE", "description":"storageOptions", "enum":[ "NONE", "UUID", "OBJECT_NAME", "CATEGORY", "NAME_AND_CATEGORY" ] }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"priority" }, "restoreTier":{ "type":"string", "example":"NONE", "description":"restoreTier", "enum":[ "NONE", "EXPEDITED", "STANDARD", "BULK", "OSS_STANDARD", "HIGH" ] }, "serverSideEncryption":{ "type":"string", "description":"The AWS server side encryption setting." }, "storageClass":{ "type":"string", "example":"STANDARD", "description":"storageClass", "enum":[ "NONE", "ARCHIVE", "STANDARD", "UNDEFINED", "INTELLIGENT_TIERING", "ONEZONE_IA", "STANDARD_IA", "GLACIER", "DEEP_ARCHIVE", "OSS_STANDARD", "OSS_IA", "NEARLINE", "COLDLINE", "HOT", "COOL", "OSS_COLD_ARCHIVE", "OSS_ARCHIVE", "GLACIER_IR" ] }, "storageLocation":{ "type":"string", "example":"S3", "description":"storageLocation", "enum":[ "LOCAL", "CLOUD", "OPC", "OCI", "UNDEFINED", "S3", "GCS", "AZCS" ] }, "storageOptions":{ "type":"string", "example":"-virtual_hosted_style", "description":"storageOptions" }, "verifyWrite":{ "type":"boolean", "example":false, "description":"verifyWrite" } } }, "DiskArrays":{ "type":"object", "properties":{ "arrays":{ "type":"array", "description":"List of Array information", "items":{ "$ref":"#/definitions/DiskArray" } }, "count":{ "type":"integer", "format":"int32" } } }, "DiskComponentInfo":{ "type":"object", "properties":{ "diskName":{ "type":"string" }, "fileName":{ "type":"string" }, "isInserted":{ "type":"boolean" }, "path":{ "type":"string" } } }, "DiskFileInfo":{ "type":"object", "properties":{ "collection":{ "type":"string" }, "fileFolderType":{ "type":"string", "enum":[ "File", "Folder", "SymbolicLink" ] }, "name":{ "type":"string" }, "objectName":{ "type":"string" }, "path":{ "type":"string" }, "sizeBytes":{ "type":"integer", "format":"int64" } } }, "DiskFilesInfo":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "diskFilesInfo":{ "type":"array", "items":{ "$ref":"#/definitions/DiskFileInfo" } } }, "description":"Definition of Disk file information" }, "DiskForRead":{ "type":"object", "required":[ "id", "name", "status" ], "properties":{ "array":{ "type":"string", "example":"A valid array name", "description":"The name of the array to which the disk belongs." }, "id":{ "type":"integer", "format":"int32", "description":"id" }, "isCloud":{ "type":"boolean", "example":false, "description":"Flag indicating whether a disk is a cloud disk." }, "isWritable":{ "type":"boolean", "example":false, "description":"Flag indicating whether a disk is writable." }, "maxThroughput":{ "type":"integer", "format":"int64", "example":100000, "description":"The maximum throughput of the disk in Mb/sec." }, "minFreeSpaceMB":{ "type":"number", "example":0.0, "description":"The minimum free space in MB." }, "name":{ "type":"string", "example":"test", "description":"name" }, "site":{ "type":"string", "example":"A valid site name", "description":"The name of the site to which the disk belongs." }, "status":{ "type":"string", "example":"ONLINE", "description":"status", "enum":[ "ONLINE", "OFFLINE" ] }, "verifyWrite":{ "type":"string", "example":"OFF", "description":"Whether verify write is enabled." } } }, "DiskForWrite":{ "type":"object", "required":[ "id", "name", "status" ], "properties":{ "array":{ "type":"string", "example":"A valid array name", "description":"The name of the array to which the disk belongs." }, "id":{ "type":"integer", "format":"int32", "description":"id" }, "minFreeSpaceMB":{ "type":"number", "example":0.0, "description":"The minimum free space in MB." }, "name":{ "type":"string", "example":"test", "description":"name" }, "site":{ "type":"string", "example":"A valid site name", "description":"The name of the site to which the disk belongs." }, "status":{ "type":"string", "example":"ONLINE", "description":"status", "enum":[ "ONLINE", "OFFLINE" ] }, "verifyWrite":{ "type":"string", "example":"OFF", "description":"Whether verify write is enabled." } } }, "DiskInfo":{ "type":"object", "properties":{ "array":{ "type":"string" }, "availableSizeKB":{ "type":"integer", "format":"int64" }, "consumedSizeKB":{ "type":"integer", "format":"int64" }, "firstUtilizationDate":{ "type":"string", "format":"date-time" }, "id":{ "type":"integer", "format":"int32" }, "isCloud":{ "type":"boolean" }, "lastAccessDate":{ "type":"string", "format":"date-time" }, "lastErrorMessage":{ "type":"string" }, "lastReadDate":{ "type":"string", "format":"date-time" }, "lastWriteDate":{ "type":"string", "format":"date-time" }, "minFreeSpaceMB":{ "type":"number" }, "name":{ "type":"string" }, "scanDiskState":{ "type":"string", "enum":[ "RUNNING", "STOPPED", "NONE", "UNKNOWN" ] }, "site":{ "type":"string" }, "state":{ "type":"string", "enum":[ "Offline", "Online" ] }, "status":{ "type":"string", "enum":[ "Offline", "Online" ] }, "storageOptions":{ "type":"string" }, "totalSizeKB":{ "type":"integer", "format":"int64" }, "usedCapacity":{ "type":"number", "format":"float" }, "verifyWrite":{ "type":"string" }, "writable":{ "type":"boolean" } } }, "DiskInstanceInfo":{ "type":"object", "properties":{ "arrayName":{ "type":"string" }, "components":{ "type":"array", "items":{ "$ref":"#/definitions/DiskComponentInfo" } }, "id":{ "type":"integer", "format":"int32" }, "storageClass":{ "type":"string", "enum":[ "NONE", "ARCHIVE", "STANDARD", "UNDEFINED", "INTELLIGENT_TIERING", "ONEZONE_IA", "STANDARD_IA", "GLACIER", "DEEP_ARCHIVE", "OSS_STANDARD", "OSS_IA", "NEARLINE", "COLDLINE", "HOT", "COOL", "OSS_COLD_ARCHIVE", "OSS_ARCHIVE", "GLACIER_IR" ] }, "storageOptions":{ "type":"string" } } }, "Disks":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "disks":{ "type":"array", "items":{ "$ref":"#/definitions/DiskForRead" } } } }, "DisksForArray":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "records":{ "type":"array", "items":{ "$ref":"#/definitions/DiskForRead" } } } }, "DisksInfo":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "disksInfo":{ "type":"array", "items":{ "$ref":"#/definitions/DiskInfo" } } }, "description":"Definition of Disks Information" }, "Drive":{ "type":"object", "required":[ "id", "name", "status" ], "properties":{ "acs":{ "type":"integer", "format":"int32", "example":0, "description":"acs" }, "enabledOperations":{ "type":"string", "example":"A", "description":"enabledOperations" }, "enabledOperationsLabel":{ "type":"string", "example":"Standard & Repack", "description":"enabledOperationsLabel", "enum":[ "Standard & Repack", "Standard", "Repack", "None" ] }, "id":{ "type":"integer", "format":"int32", "description":"id" }, "lsm":{ "type":"integer", "format":"int32", "example":0, "description":"lsm" }, "name":{ "type":"string", "example":"test", "description":"name" }, "serialNumber":{ "type":"string", "example":"SIMU001", "description":"serialNumber" }, "status":{ "type":"string", "example":"ONLINE", "description":"status", "enum":[ "ONLINE", "OFFLINE" ] }, "tape":{ "type":"string", "example":"000000", "description":"tape" }, "type":{ "$ref":"#/definitions/DriveType" }, "used":{ "type":"string", "example":"Y", "description":"used" } } }, "DriveAlertLog":{ "type":"object", "properties":{ "alertId":{ "type":"integer", "format":"int32" }, "barcode":{ "type":"string" }, "date":{ "type":"string", "format":"date-time" }, "level":{ "type":"string" }, "message":{ "type":"string" }, "requestId":{ "type":"integer", "format":"int32" }, "serialNumber":{ "type":"string" } } }, "DriveAlertLogs":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "logs":{ "type":"array", "description":"List of drive alert logs.", "items":{ "$ref":"#/definitions/DriveAlertLog" } } } }, "DriveInfo":{ "type":"object", "properties":{ "acs":{ "type":"integer", "format":"int32" }, "id":{ "type":"integer", "format":"int32" }, "isAvailable":{ "type":"boolean" }, "isClassicEnabled":{ "type":"boolean" }, "isRepackEnabled":{ "type":"boolean" }, "lsm":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" }, "serialNumber":{ "type":"string" }, "state":{ "type":"string", "enum":[ "None", "mounting", "dismounting", "mounted" ] }, "tapeMounted":{ "type":"string" }, "type":{ "type":"string" }, "typeId":{ "type":"integer", "format":"int32" } } }, "DriveType":{ "type":"object", "properties":{ "blockSizeInBytes":{ "type":"integer", "format":"int32", "example":1024, "description":"blockSizeInBytes" }, "id":{ "type":"integer", "format":"int32", "example":1, "description":"id" }, "name":{ "type":"string", "example":"simu_IBM_LTO", "description":"name" } } }, "DriveTypes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "types":{ "type":"array", "items":{ "$ref":"#/definitions/DriveType" } } } }, "DriveTypesBody":{ "type":"object", "properties":{ "types":{ "type":"array", "items":{ "$ref":"#/definitions/DriveType" } } } }, "Drives":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "drives":{ "type":"array", "items":{ "$ref":"#/definitions/Drive" } } } }, "EjectTapeRequestBody":{ "type":"object", "required":[ "tapes" ], "properties":{ "comments":{ "type":"string", "description":"Externalization comment." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority." }, "release":{ "type":"boolean", "example":true, "description":"When true, perform a DIVA Core release on every instance located on the successfully ejected tapes." }, "tapes":{ "type":"array", "description":"List of VSNs for identifying the tapes to be ejected.", "items":{ "type":"string" } } }, "description":"definition of an eject tape request" }, "ElementInfo":{ "type":"object", "properties":{ "checksum":{ "type":"string" }, "elementNb":{ "type":"integer", "format":"int32" }, "elementSizeKB":{ "type":"integer", "format":"int64" }, "externalizationComment":{ "type":"string" }, "fileSizeKB":{ "type":"integer", "format":"int64" }, "filename":{ "type":"string" }, "isExternalized":{ "type":"boolean" }, "location":{ "type":"string" }, "markedDeleted":{ "type":"boolean" } } }, "EmailAccount":{ "type":"object", "properties":{ "accountName":{ "type":"string" }, "accountPassword":{ "type":"string" }, "divaadminEmailAddress":{ "type":"string" }, "emailNotificationDelay":{ "type":"integer", "format":"int32" }, "emailNotificationPeriod":{ "type":"integer", "format":"int32" }, "emailSubject":{ "type":"string" }, "isActorDiskOfflineNotificationEnabled":{ "type":"boolean" }, "isActorDriveOfflineNotificationEnabled":{ "type":"boolean" }, "isActorOfflineNotificationEnabled":{ "type":"boolean" }, "isDiskOfflineNotificationEnabled":{ "type":"boolean" }, "isDriveOfflineNotificationEnabled":{ "type":"boolean" }, "isSMTPOutgoingMailAuthenticationRequired":{ "type":"boolean" }, "maxAbortedRequestsNotificationEnabled":{ "type":"integer", "format":"int32" }, "minEmptyTapesNotificationEnabled":{ "type":"integer", "format":"int32" }, "minRemainingDiskSpaceMBNotificationEnabled":{ "type":"integer", "format":"int32" }, "notificationEmailRecipients":{ "type":"array", "items":{ "type":"string" } }, "smtpoutgoingMailHost":{ "type":"string" }, "smtpoutgoingMailPort":{ "type":"integer", "format":"int32" } } }, "EmptyEjectedTape":{ "type":"object", "required":[ "acs", "barcode", "lsm", "mediaTypeID", "setId" ], "properties":{ "acs":{ "type":"integer", "format":"int32", "example":0, "description":"acs" }, "barcode":{ "type":"string", "example":"000000", "description":"barcode" }, "lsm":{ "type":"integer", "format":"int32", "example":0, "description":"lsm" }, "mediaType":{ "type":"string", "example":"LTO-100G", "description":"mediaType" }, "mediaTypeID":{ "type":"integer", "format":"int32", "example":0, "description":"mediaTypeID" }, "setId":{ "type":"integer", "format":"int32", "example":0, "description":"setId" } } }, "EmptyEjectedTapes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "emptyEjectedTapes":{ "type":"array", "items":{ "$ref":"#/definitions/EmptyEjectedTape" } } }, "description":"Definition of Empty Ejected Tapes" }, "Enumeration«string»":{ "type":"object" }, "Event":{ "type":"object", "properties":{ "date":{ "type":"integer", "format":"int64" }, "description":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "requestId":{ "type":"integer", "format":"int32" }, "severity":{ "type":"string", "enum":[ "Information", "Warning", "Error", "Critical" ] }, "type":{ "type":"string", "enum":[ "Normal", "Decision", "Step" ] } } }, "EventForRequestInfo":{ "type":"object", "properties":{ "date":{ "type":"integer", "format":"int64" }, "description":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "requestId":{ "type":"integer", "format":"int32" }, "severity":{ "type":"string", "enum":[ "Information", "Warning", "Error", "Critical" ] }, "type":{ "type":"string", "enum":[ "Normal", "Decision", "Step" ] } } }, "Events":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "events":{ "type":"array", "items":{ "$ref":"#/definitions/Event" } } } }, "EventsV2":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "events":{ "type":"array", "items":{ "$ref":"#/definitions/Event" } } } }, "ExportTape":{ "type":"object", "properties":{ "barcode":{ "type":"string" }, "canBeRemoved":{ "type":"boolean" }, "reasonAdded":{ "type":"string" } } }, "ExportTapeRequestBody":{ "type":"object", "properties":{ "comments":{ "type":"string", "description":"Export comments." }, "deleteFromDb":{ "type":"boolean", "example":true, "description":"Whether to delete object information from database on export. Default value is false." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority." }, "tapes":{ "type":"array", "description":"List of tape barcodes to export.", "items":{ "type":"string" } } }, "description":"definition of an export tape request" }, "ExportTapes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "tapes":{ "type":"array", "items":{ "$ref":"#/definitions/ExportTape" } } }, "description":"Definition of Exported Tape Information" }, "ExportedTapeInstanceInfo":{ "type":"object", "properties":{ "category":{ "type":"string" }, "lastInstance":{ "type":"boolean" }, "objectName":{ "type":"string" } } }, "ExportedTapeInstancesInfo":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "exportedTapeInstancesInfo":{ "type":"array", "items":{ "$ref":"#/definitions/ExportedTapeInstanceInfo" } } }, "description":"Definition of Exported Tape Instances Information" }, "FileFolder":{ "type":"object", "properties":{ "name":{ "type":"string" }, "option":{ "type":"string" } } }, "FileFolderInfo":{ "type":"object", "properties":{ "checksums":{ "type":"array", "description":"List of checksums.", "items":{ "$ref":"#/definitions/CheckSumInfo" } }, "componentUUID":{ "type":"string", "description":"New component UUID (as of DIVA 8.1 release)" }, "directory":{ "type":"boolean" }, "fileFolderType":{ "type":"string", "description":"One of: File, Folder or SymbolicLink.", "enum":[ "File", "Folder", "SymbolicLink" ] }, "id":{ "type":"integer", "format":"int32", "description":"Component identifier." }, "name":{ "type":"string", "description":"Name of component." }, "symbolicLink":{ "type":"boolean" }, "totalFileAndFolderSizeInBytes":{ "type":"integer", "format":"int64", "description":"Total size in bytes of all components." }, "totalFileSizeInBytes":{ "type":"integer", "format":"int64", "description":"Total size in bytes of all files." }, "totalNumberOfFilesAndFolders":{ "type":"integer", "format":"int32", "description":"Total number of files and folders." } } }, "FilesAndFolders":{ "type":"object", "properties":{ "collectionName":{ "type":"string", "description":"The name of the collection (category) to be queried." }, "complex":{ "type":"boolean" }, "filesAndFoldersList":{ "type":"array", "description":"List of file and folders.", "items":{ "$ref":"#/definitions/FileFolderInfo" } }, "nextStartIndex":{ "type":"integer", "format":"int32", "description":"After the first and any subsequent call, the DIVA Core update this variable with the current position in the search. Use this value as the input parameter for subsequent calls." }, "objectName":{ "type":"string", "description":"The name of the object to be queried." }, "site":{ "type":"string", "description":"This contains the site name of the Manager that satisfied the request." }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" } } }, "FinishedRequests":{ "type":"object", "properties":{ "requests":{ "type":"array", "items":{ "$ref":"#/definitions/RequestInfo" } }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" }, "uid":{ "type":"string" } } }, "GlobalState":{ "type":"object", "properties":{ "stateCode":{ "type":"integer", "format":"int32" }, "stateDescription":{ "type":"string" }, "stateName":{ "type":"string" } } }, "Group":{ "type":"object", "required":[ "id", "name" ], "properties":{ "cloneGroup":{ "type":"string", "example":"a valid clone group name", "description":"The associated clone group, if any." }, "compressionEnabled":{ "type":"boolean", "example":false, "description":"Whether compression is enabled." }, "description":{ "type":"string", "example":"a description", "description":"Text describing the new group." }, "encryptionEnabled":{ "type":"boolean", "example":false, "description":"Whether encryption is enabled." }, "format":{ "type":"string", "example":"AXF_1_1", "description":"Format of the group. One of: LEGACY, AXF_0_9, AXF_1_0, AXF_1_1, AXF_RF_1_1, FLASHNET_ODA, FLASHNET_LTFS, AXF_1_1_LTFS, FLASHNET_DTOOL.", "enum":[ "Legacy", "AXF", "AXF_0_9", "AXF_1_0", "AXF_1_1", "AXF_RF_1_1", "FLASHNET_ODA", "FLASHNET_LTFS", "AXF_1_1_LTFS", "FLASHNET_LOOSE", "FLASHNET_DTOOL" ] }, "formatId":{ "type":"integer", "format":"int32", "example":3, "description":"Format of the group as integer. One of: 0 (LEGACY), 1 (AXF_0_9), 2 (AXF_1_0), 3 (AXF_1_1), 4 (AXF_RF_1_1), 5 (FLASHNET_ODA), 6 (FLASHNET_LTFS), 7 (AXF_1_1_LTFS), 9 (FLASHNET_DTOOL)." }, "id":{ "type":"integer", "format":"int32", "example":1, "description":"Id of group." }, "name":{ "type":"string", "example":"test", "description":"Name of the Group to be added." }, "numberOfTapesUsedForRepack":{ "type":"integer", "format":"int32", "example":1, "description":"Number of tapes reserved for Worst Fit Repack." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority of the group." }, "set":{ "type":"integer", "format":"int32", "example":1, "description":"Set of Tapes to associate with the new group. This value must be strictly greater than 0. " }, "usedForRepack":{ "type":"boolean", "example":false, "description":"If true, tapes belonging to this group are eligible for Automatic Repack." }, "verifyWrite":{ "type":"string", "example":"OFF", "description":"Whether verify write is enabled.", "enum":[ "NONE", "ON", "OFF" ] }, "worstFitEnabled":{ "type":"boolean", "example":false, "description":"If true, Worst Fit Policy (access speed optimization) will apply." } } }, "Groups":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "groups":{ "type":"array", "description":"List of groups.", "items":{ "$ref":"#/definitions/Group" } } } }, "HttpFields":{ "type":"object", "properties":{ "fieldNames":{ "$ref":"#/definitions/Enumeration«string»" }, "fieldNamesCollection":{ "type":"array", "items":{ "type":"string" } } } }, "HttpURI":{ "type":"object", "properties":{ "absolute":{ "type":"boolean" }, "authority":{ "type":"string" }, "decodedPath":{ "type":"string" }, "fragment":{ "type":"string" }, "host":{ "type":"string" }, "param":{ "type":"string" }, "path":{ "type":"string" }, "pathQuery":{ "type":"string" }, "port":{ "type":"integer", "format":"int32" }, "query":{ "type":"string" }, "scheme":{ "type":"string" }, "user":{ "type":"string" } } }, "ImportTapeRequestBody":{ "type":"object", "properties":{ "addAsInstanceIfObjectExists":{ "type":"boolean", "example":false, "description":"Add as instance if object exists. Default is false." }, "groupName":{ "type":"string", "description":"Group on which to import." }, "ignoreChecksums":{ "type":"boolean", "example":false, "description":"Ignore checksums. This is used in cases when no checksums are available for old DIVA objects. Default is false." }, "importFileNames":{ "type":"array", "description":"Exported XML file names to import.", "items":{ "type":"string" } }, "skipIfObjectExists":{ "type":"boolean", "example":false, "description":"Skip object if exists. Default is false." }, "updateChecksums":{ "type":"boolean", "example":false, "description":"Update checksums. This is used to update checksum values on import. Default is false." }, "useImportDateAsArchiveDate":{ "type":"boolean", "example":false, "description":"Use import date as archive date. Default is false." } }, "description":"definition of an import tape request" }, "InsertTapeRequestBody":{ "type":"object", "required":[ "acsId", "capID" ], "properties":{ "acsId":{ "type":"integer", "format":"int32", "example":0, "description":"The ACS ID." }, "capID":{ "type":"integer", "format":"int32", "example":0, "description":"The CAP ID." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority." }, "require":{ "type":"boolean", "example":false, "description":"Require Tape on insert. Default is false." } }, "description":"definition of an insert tape request" }, "InsertedProtectedTape":{ "type":"object", "required":[ "isProtected" ], "properties":{ "isProtected":{ "type":"boolean", "example":false, "description":"isProtected" } } }, "InsertedProtectedTapes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "insertedProtectedTapes":{ "type":"array", "items":{ "$ref":"#/definitions/InsertedProtectedTape" } } }, "description":"Definition of Inserted Protected Tapes" }, "InstanceInfo":{ "type":"object", "properties":{ "creationDate":{ "type":"integer", "format":"int64" }, "elements":{ "type":"array", "items":{ "$ref":"#/definitions/ElementInfo" } }, "format":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "isExternalized":{ "type":"boolean" }, "isRequired":{ "type":"boolean" }, "lastVerifyDate":{ "type":"integer", "format":"int64" }, "location":{ "type":"string" }, "media":{ "type":"string" }, "storageOptions":{ "type":"string" } } }, "InstanceTapeInfo":{ "type":"object", "properties":{ "instanceID":{ "type":"integer", "format":"int32" }, "listDate":{ "type":"integer", "format":"int64" }, "listType":{ "type":"string" }, "listTypeCode":{ "type":"integer", "format":"int32" }, "tapes":{ "type":"array", "items":{ "$ref":"#/definitions/TapeInfo" } } } }, "JournalEntries":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "journalEntries":{ "type":"array", "items":{ "$ref":"#/definitions/JournalEntry" } } }, "description":"Definition of Journal entries" }, "JournalEntry":{ "type":"object", "properties":{ "actorName":{ "type":"string" }, "diskName":{ "type":"string" }, "driveSerialNumber":{ "type":"string" }, "durationSec":{ "type":"integer", "format":"int32" }, "errorCode":{ "type":"integer", "format":"int32" }, "errorMessage":{ "type":"string" }, "errorRate":{ "type":"integer", "format":"int64" }, "eventDescription":{ "type":"string" }, "eventTime":{ "type":"string", "format":"date-time" }, "id":{ "type":"integer", "format":"int32" }, "librarySerialNumber":{ "type":"string" }, "objectCategory":{ "type":"string" }, "objectInstance":{ "type":"integer", "format":"int32" }, "objectName":{ "type":"string" }, "requestId":{ "type":"integer", "format":"int32" }, "severity":{ "type":"string" }, "sourceDestinationName":{ "type":"string" }, "startTime":{ "type":"string", "format":"date-time" }, "tapeBarcode":{ "type":"string" }, "transferRateMBPerSec":{ "type":"number" }, "transferSizeMB":{ "type":"number" } } }, "KeepAliveBody":{ "type":"object", "required":[ "minutes" ], "properties":{ "minutes":{ "type":"integer", "format":"int32", "example":60, "description":"Number of minutes to retain client queues from the current time" } }, "description":"definition of an client connected to broker" }, "LSMInfo":{ "type":"object", "properties":{ "available":{ "type":"boolean" }, "id":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" } } }, "LibraryAlertLog":{ "type":"object", "properties":{ "alertId":{ "type":"integer", "format":"int32" }, "date":{ "type":"string", "format":"date-time" }, "id":{ "type":"integer", "format":"int32" }, "level":{ "type":"string" }, "message":{ "type":"string" }, "serialNumber":{ "type":"string" } } }, "LibraryAlertLogs":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "logs":{ "type":"array", "description":"List of library alert logs.", "items":{ "$ref":"#/definitions/LibraryAlertLog" } } } }, "LibraryState":{ "type":"object", "properties":{ "stateCode":{ "type":"integer", "format":"int32" }, "stateDescription":{ "type":"string" }, "stateName":{ "type":"string" } } }, "License":{ "type":"object", "properties":{ "comments":{ "type":"string" }, "customerName":{ "type":"string" }, "divaVersion":{ "type":"string" }, "expirationDate":{ "type":"string", "format":"date-time" }, "featureAnalytics":{ "type":"boolean" }, "featureExternalization":{ "type":"boolean" }, "featureNumberOfAvidDet1Det2":{ "type":"integer", "format":"int32" }, "featureNumberOfAvidDhm":{ "type":"integer", "format":"int32" }, "featureNumberOfCloudAccounts":{ "type":"integer", "format":"int32" }, "featureNumberOfDcSites":{ "type":"integer", "format":"int32" }, "featureNumberOfExternalDiskSystems":{ "type":"integer", "format":"int32" }, "featureSpmUnlimited":{ "type":"boolean" }, "highWaterMark":{ "type":"integer", "format":"int32" }, "managerHostUuidList":{ "type":"array", "items":{ "type":"string" } }, "nearlineTB":{ "type":"number", "format":"float" }, "numberOfActors":{ "type":"integer", "format":"int32" }, "numberOfRobots":{ "type":"integer", "format":"int32" }, "prAvi":{ "type":"boolean" }, "prDif":{ "type":"boolean" }, "prGxf":{ "type":"boolean" }, "prLxf":{ "type":"boolean" }, "prMxf":{ "type":"boolean" }, "prQuicktime":{ "type":"boolean" }, "systemId":{ "type":"string" }, "tapeSlots":{ "type":"integer", "format":"int32" }, "validityDate":{ "type":"string" } } }, "LicenseHistories":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "licenses":{ "type":"array", "items":{ "$ref":"#/definitions/LicenseHistory" } } } }, "LicenseHistory":{ "type":"object", "properties":{ "expirationDate":{ "type":"string", "format":"date-time" }, "faclityId":{ "type":"string" }, "failureReason":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "importDate":{ "type":"string", "format":"date-time" }, "importReason":{ "type":"string" }, "importStatus":{ "type":"string" }, "importer":{ "type":"string" }, "settings":{ "type":"string" } } }, "LicenseInput":{ "type":"object", "properties":{ "importReason":{ "type":"string" }, "importer":{ "type":"string" }, "licenseFileContent":{ "type":"string", "description":"licenseFileContent" }, "managerAddress":{ "type":"string", "example":"127.0.0.1", "description":"managerAddress" }, "managerPort":{ "type":"integer", "format":"int32", "example":8000, "description":"managerPort" }, "notifyManagerAfterImport":{ "type":"boolean", "example":false, "description":"notifyManagerAfterImport" } } }, "LinkedObject":{ "type":"object", "properties":{ "collectionName":{ "type":"string", "description":"The name of the collection (category) of the object." }, "objectName":{ "type":"string", "description":"The name of the object." } } }, "LinkedObjects":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "objects":{ "type":"array", "items":{ "$ref":"#/definitions/LinkedObject" } }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" } } }, "Map«string,object»":{ "type":"object", "additionalProperties":{ "type":"object" } }, "MediaCompatibilities":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "mediaCompatibilities":{ "type":"array", "items":{ "$ref":"#/definitions/MediaCompatibility" } } } }, "MediaCompatibility":{ "type":"object", "required":[ "driveType", "mediaCompatibleType", "mediaType" ], "properties":{ "driveType":{ "type":"string", "example":"simu_IBM_LTO", "description":"driveType" }, "mediaCompatibleType":{ "type":"string", "example":"READ-WRITE", "description":"mediaCompatibleType", "enum":[ "READ-WRITE", "READ-ONLY" ] }, "mediaType":{ "type":"string", "example":"LTO-100G", "description":"mediaType" } } }, "MediaInfo":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "mediaInfo":{ "type":"array", "items":{ "$ref":"#/definitions/MediumInfo" } } }, "description":"Definition of Media Information" }, "MediaMapping":{ "type":"object", "required":[ "name" ], "properties":{ "fromMedia":{ "type":"string", "example":"a valid media name", "description":"fromMedia" }, "name":{ "type":"string", "example":"test", "description":"name" }, "toMedia":{ "type":"string", "example":"a valid media name", "description":"toMedia" }, "toSPM":{ "type":"string", "example":"a valid storage plan", "description":"toSPM" } } }, "MediaMappings":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "mediaMappings":{ "type":"array", "items":{ "$ref":"#/definitions/MediaMapping" } } } }, "MediaSize":{ "type":"object", "properties":{ "totalSpaceKB":{ "type":"integer", "format":"int64" }, "usedSpaceKB":{ "type":"integer", "format":"int64" } } }, "MediumInfo":{ "type":"object", "properties":{ "firstUtilizationDate":{ "type":"string", "format":"date-time" }, "lastUtilizationDate":{ "type":"string", "format":"date-time" }, "mediaFormat":{ "type":"string" }, "name":{ "type":"string" }, "sourceMediaPriority":{ "type":"integer", "format":"int32" }, "type":{ "type":"string" }, "usedSpaceKB":{ "type":"number", "format":"float" } } }, "MigrateJobBody":{ "type":"object", "required":[ "jobDescription", "jobName", "sourceMedia", "sourceType", "strategy" ], "properties":{ "destinationMedia":{ "type":"array", "description":"Destination media for migration. For CopyToSource, this will be set to source media with required instance count = 2.", "items":{ "$ref":"#/definitions/DestinationMediaInfo" } }, "diskBuffer":{ "type":"string", "description":"Name of disk disk to use as a buffer in the migration." }, "endDateTime":{ "type":"string", "description":"Scheduled time to end as dd-MM-yyyy-HH:mm in UTC (ended migration can be started again manually)." }, "excludedInstanceList":{ "type":"array", "description":"The list of instances to exclude from a migration job.", "items":{ "$ref":"#/definitions/DIVAExclusionInstance" } }, "jobDescription":{ "type":"string", "example":"Copies objects to another group", "description":"Description of migration job." }, "jobName":{ "type":"string", "example":"MigrateJob1", "description":"Name of migration job." }, "maxParallelDestinations":{ "type":"integer", "format":"int32", "description":"The concurrent destinations on which to migrate content." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority of the job. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred the highest priority" }, "sourceInstanceList":{ "type":"array", "description":"For a source type of InstancesList, the list of instances to migrate.", "items":{ "$ref":"#/definitions/DIVAInstance" } }, "sourceMedia":{ "type":"string", "example":"default", "description":"Name of media." }, "sourceTapeBarcodes":{ "type":"array", "description":"For a source type of Tapes, the list of tapes to migrate.", "items":{ "type":"string" } }, "sourceType":{ "type":"string", "example":"TapeGroup", "description":"Source of migration.", "enum":[ "TapeGroup", "DiskArray", "Tapes", "InstancesList", "CloudArray", "SourceDestination" ] }, "startDateTime":{ "type":"string", "description":"Scheduled time to start as dd-MM-yyyy-HH:mm in UTC." }, "strategy":{ "type":"string", "example":"Copy", "description":"Type of migration.", "enum":[ "Copy", "Move", "CopyToSource", "Unknown", "Restore", "Delete" ] }, "useAutoSource":{ "type":"boolean", "example":false, "description":"Whether to use an alternative source if original source is offline." }, "useRecoveryMode":{ "type":"boolean", "example":false, "description":"Whether to use recovery mode." } }, "description":"definition of an migration job" }, "MigrationJobInfo":{ "type":"object", "properties":{ "alternativeSoucesEnabled":{ "type":"boolean" }, "dataTransferred":{ "type":"integer", "format":"int64" }, "destinationType":{ "type":"string", "enum":[ "TapeGroup", "DiskArray", "Tapes", "InstancesList", "CloudArray", "SourceDestination", "Multiple" ] }, "destinations":{ "type":"array", "items":{ "type":"string" } }, "diskBuffer":{ "type":"string" }, "diskBufferEnabled":{ "type":"boolean" }, "events":{ "type":"array", "items":{ "$ref":"#/definitions/Event" } }, "excludedInstanceList":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAExclusionInstance" } }, "finishedAt":{ "type":"string", "format":"date-time" }, "id":{ "type":"integer", "format":"int32" }, "jobDescription":{ "type":"string" }, "jobName":{ "type":"string" }, "numberInstancesMigrated":{ "type":"integer", "format":"int32" }, "numberInstancesToMigrate":{ "type":"integer", "format":"int32" }, "priority":{ "type":"integer", "format":"int32" }, "progress":{ "type":"integer", "format":"int32" }, "recoveryModeEnabled":{ "type":"boolean" }, "scheduledEndAt":{ "type":"string", "format":"date-time" }, "scheduledStartedAt":{ "type":"string", "format":"date-time" }, "source":{ "type":"string" }, "sourceType":{ "type":"string", "enum":[ "TapeGroup", "DiskArray", "Tapes", "InstancesList", "CloudArray", "SourceDestination" ] }, "startedAt":{ "type":"string", "format":"date-time" }, "status":{ "type":"string", "enum":[ "Unknown", "Submitted", "Pending", "Initializing", "CleaningUp", "Paused", "Pausing", "Stopped", "Stopping", "Deleting", "Finalizing", "Cancelled", "Cancelling", "Aborted", "Completed", "PartiallyCompleted", "Resuming", "WaitingForResource", "Running" ] }, "statusCode":{ "type":"integer", "format":"int32" }, "statusName":{ "type":"string" }, "submittedAt":{ "type":"string", "format":"date-time" }, "type":{ "type":"string", "enum":[ "Copy", "Move", "CopyToSource", "Unknown", "Restore", "Delete" ] } } }, "MigrationJobInfoUI":{ "type":"object", "properties":{ "dataToTransfer":{ "type":"integer", "format":"int64" }, "dataTransferred":{ "type":"integer", "format":"int64" }, "destinationType":{ "type":"string", "enum":[ "TapeGroup", "DiskArray", "Tapes", "InstancesList", "CloudArray", "SourceDestination", "Multiple" ] }, "finishedAt":{ "type":"string", "format":"date-time" }, "id":{ "type":"integer", "format":"int32" }, "jobDescription":{ "type":"string" }, "jobName":{ "type":"string" }, "numberFailedInstances":{ "type":"integer", "format":"int32" }, "numberInstancesMigrated":{ "type":"integer", "format":"int32" }, "numberInstancesToMigrate":{ "type":"integer", "format":"int32" }, "progress":{ "type":"integer", "format":"int32" }, "sourceType":{ "type":"string", "enum":[ "TapeGroup", "DiskArray", "Tapes", "InstancesList", "CloudArray", "SourceDestination" ] }, "startedAt":{ "type":"string", "format":"date-time" }, "status":{ "type":"string", "enum":[ "Unknown", "Submitted", "Pending", "Initializing", "CleaningUp", "Paused", "Pausing", "Stopped", "Stopping", "Deleting", "Finalizing", "Cancelled", "Cancelling", "Aborted", "Completed", "PartiallyCompleted", "Resuming", "WaitingForResource", "Running" ] }, "type":{ "type":"string", "enum":[ "Copy", "Move", "CopyToSource", "Unknown", "Restore", "Delete" ] } } }, "MigrationJobOperationBody":{ "type":"object", "properties":{ "operation":{ "type":"string", "example":"Stop", "description":"The migration job operation. One of Pause, Stop, Resume, Rerun, Cancel, Delete. ", "enum":[ "Pause", "Stop", "Resume", "Rerun", "Cancel" ] } }, "description":"definition of a migration job update" }, "MigrationJobsInfoUI":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "migrationJobsInfo":{ "type":"array", "items":{ "$ref":"#/definitions/MigrationJobInfoUI" } } }, "description":"Definition of Migration Jobs Information" }, "MigrationSourceDestinationType":{ "type":"object", "properties":{ "name":{ "type":"string" } } }, "MigrationSourceDestinationTypes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "types":{ "type":"array", "items":{ "$ref":"#/definitions/MigrationSourceDestinationType" } } } }, "MultiCreateTapeStates":{ "type":"object", "properties":{ "barcodes":{ "type":"array", "items":{ "type":"string" } } } }, "MultiDrives":{ "type":"object", "properties":{ "drives":{ "type":"array", "items":{ "$ref":"#/definitions/Drive" } } } }, "MultiEditTapeStates":{ "type":"object", "required":[ "isEnabledForCloning", "isEnabledForRepack", "isEnabledForWriting" ], "properties":{ "barcodes":{ "type":"array", "items":{ "type":"string" } }, "isEnabledForCloning":{ "type":"boolean", "example":true, "description":"isEnabledForCloning" }, "isEnabledForRepack":{ "type":"boolean", "example":true, "description":"IsEnabledForRepack" }, "isEnabledForWriting":{ "type":"boolean", "example":true, "description":"isEnabledForWriting" } } }, "MultiEditToBeClearedTapes":{ "type":"object", "required":[ "barcodes" ], "properties":{ "barcodes":{ "type":"array", "example":"[\"000000\",\"000001\"]", "description":"barcodes", "items":{ "type":"string" } }, "toBeCleared":{ "type":"boolean", "example":true, "description":"toBeCleared" } }, "description":"Definition of To Be Cleared Tapes for multi-edit" }, "MultiEditUnusedTapes":{ "type":"object", "required":[ "barcodes", "setId" ], "properties":{ "barcodes":{ "type":"array", "example":"[\"000000\",\"000001\"]", "description":"barcodes", "items":{ "type":"string" } }, "setId":{ "type":"integer", "format":"int32", "example":2, "description":"setId" } }, "description":"Definition of Unused Tapes for multi-edit" }, "NRestoreRequestBody":{ "type":"object", "required":[ "collectionName", "destinationServers", "objectName" ], "properties":{ "collectionName":{ "type":"string", "example":"testCollectionName", "description":"The name of the collection of the object to N-Restore." }, "destinationServers":{ "type":"array", "example":"Valid destination server(s)", "description":"List of servers on which to restore.", "items":{ "type":"string" } }, "filePathRoots":{ "type":"array", "example":"Valid file path root(s)", "description":"List of file path roots of servers on which to restore.", "items":{ "type":"string" } }, "instance":{ "type":"integer", "format":"int32", "description":"The instance ID" }, "objectName":{ "type":"string", "example":"testObjectName", "description":"The name of the object to N-Restore." }, "options":{ "type":"string", "example":" ", "description":"Additional options that must be used for performing the transfer of data from DIVA Core to the destination. These options supersede any options specified in the DIVA Core configuration." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority." }, "qos":{ "type":"integer", "format":"int32", "example":0, "description":"One of the following codes: DIVA_QOS_DEFAULT (0) Restoring is performed according to the default Quality Of Service (currently direct and cache for restore operations). DIVA_QOS_CACHE_ONLY (1) Use cache restore only. DIVA_QOS_DIRECT_ONLY (2) Use direct restore only - no disk instance is created. DIVA_QOS_DIRECT_AND_CACHE (3) Use direct restore if available, or cache restore if direct restore is not available. DIVA_QOS_CACHE_AND_DIRECT (4) Use cache restore if available, or direct restore if cache restore is not available. Additional and optional services are available. To request those services use a logical OR between the previously documented Quality Of Service parameter and the following constants:\nDIVA_RESTORE_SERVICE_DO_NOT_OVERWRITE (0x0100): Do not overwrite existing files on the destination server.\nDIVA_RESTORE_SERVICE_DO_NOT_CHECK_EXISTENCE (0x0200): Do not check existence of the clip on the server.\nDIVA_RESTORE_SERVICE_DELETE_AND_WRITE (0x0400): Force delete and rewrite if object exists on the server.\nDIVA_RESTORE_SERVICE_DEFAULT (0x0800): Operate using the default setting in the Manager configuration." } }, "description":"definition of a n-restore request" }, "ObjectDetailsList":{ "type":"object", "properties":{ "listPosition":{ "type":"array", "description":"A list of strings. The elements of this list are for internal use only and do not need to be extracted by the user. ", "items":{ "type":"string" } }, "listType":{ "type":"integer", "format":"int32", "description":"One of: DIVA_OBJECTS_LIST (0) or DIVA_TAPE_INFO_LIST (1)" }, "listTypeName":{ "type":"string", "description":"One of: DIVA_OBJECTS_LIST or DIVA_TAPE_INFO_LIST" }, "objectInfoList":{ "type":"array", "description":"List of object information", "items":{ "$ref":"#/definitions/ObjectInformation" } }, "objectTapeInfoList":{ "type":"array", "description":"List of object tape information", "items":{ "$ref":"#/definitions/ObjectTapeInfo" } }, "site":{ "type":"string", "description":"The DIVArchive system name as configured in manager configuration." }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" } } }, "ObjectInfo":{ "type":"object", "properties":{ "archiveDate":{ "type":"integer", "format":"int64" }, "checksumStatus":{ "type":"string" }, "collection":{ "type":"string" }, "comments":{ "type":"string" }, "complex":{ "type":"boolean" }, "externalized":{ "type":"boolean" }, "lastReadDate":{ "type":"integer", "format":"int64" }, "locked":{ "type":"boolean" }, "numFiles":{ "type":"integer", "format":"int32" }, "numInstances":{ "type":"integer", "format":"int32" }, "objectName":{ "type":"string" }, "sizeKB":{ "type":"integer", "format":"int64" }, "storagePlan":{ "type":"string" } } }, "ObjectInformation":{ "type":"object", "properties":{ "archiveDate":{ "type":"integer", "format":"int64", "description":"The date of archive in number of seconds since January 1, 1970." }, "collectionName":{ "type":"string", "description":"The name of the collection (category) of the object." }, "comments":{ "type":"string", "description":"Comments associated with the object." }, "complex":{ "type":"boolean" }, "diskInstances":{ "type":"array", "description":"The list of disk instances of the object.", "items":{ "$ref":"#/definitions/DiskInstanceInfo" } }, "files":{ "type":"array", "description":"The list of files of the object.", "items":{ "type":"string" } }, "inserted":{ "type":"boolean" }, "locked":{ "type":"boolean" }, "modifiedOrDeleted":{ "type":"string", "description":"One of: UNDEFINED, DIVA_CREATED_OR_MODIFIED or DIVA_DELETED." }, "numberOfComplexFiles":{ "type":"integer", "format":"int32", "description":"This is the number of files in the object. This is used only for complex objects. The value is zero for non-complex objects." }, "numberOfComplexFolders":{ "type":"integer", "format":"int32", "description":"This is the number of folders in the object. This is used only for complex objects. The value is zero for non-complex objects." }, "objectName":{ "type":"string", "description":"The name of the object" }, "path":{ "type":"string", "description":"The root directory containing the object files on the source." }, "relatedRequests":{ "type":"array", "description":"List of non-terminated requests by ids.", "items":{ "type":"integer", "format":"int32" } }, "sizeInBytes":{ "type":"integer", "format":"int64" }, "sizeInKB":{ "type":"integer", "format":"int32" }, "source":{ "type":"string", "description":"The source system used to archive the object." }, "spm":{ "type":"string", "description":"Storage plan associated with object." }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" }, "tapeInstances":{ "type":"array", "description":"The list of tape instances of object", "items":{ "$ref":"#/definitions/TapeInstanceInfo" } }, "toBeRepacked":{ "type":"boolean" }, "uuid":{ "type":"string", "description":"Universally Unique Identifier to uniquely identify each object created in DIVArchive across all Oracle customer sites. This does not include objects created using CopyAs requests.An object created through a CopyAs request will contain the same UUID as that of the source object." } } }, "ObjectListByFileNameResponse2":{ "type":"object", "properties":{ "divaobjects":{ "type":"array", "items":{ "$ref":"#/definitions/DIVAObject2" } }, "moreExists":{ "type":"boolean" }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" } } }, "ObjectTapeInfo":{ "type":"object", "properties":{ "collectionName":{ "type":"string", "description":"The name of the collection (category) of the object." }, "instanceTapeInfoList":{ "type":"array", "description":"List of tape instance information.", "items":{ "$ref":"#/definitions/InstanceTapeInfo" } }, "objectName":{ "type":"string", "description":"The name of the object." } } }, "ObjectsInfo":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "objectsInfo":{ "type":"array", "items":{ "$ref":"#/definitions/ObjectInfo" } } }, "description":"Definition of Objects Information" }, "OffsetPair":{ "type":"object", "properties":{ "bytesBegin":{ "type":"integer", "format":"int64" }, "bytesEnd":{ "type":"integer", "format":"int64" }, "timeCode":{ "type":"boolean" }, "timeCodeBegin":{ "type":"string" }, "timeCodeEnd":{ "type":"string" } } }, "PartialRestoreOffset":{ "type":"object", "properties":{ "destinationFile":{ "type":"string", "description":"The file name to be used at the destination. Valid only when format is other than DIVA_FORMAT_FOLDER_BASED or DIVA_FORMAT_DPX." }, "fileFolder":{ "description":"The file or folder name. Used only when the format is DIVA_FORMAT_FOLDER_ BASED.", "$ref":"#/definitions/FileFolder" }, "offsetPairs":{ "type":"array", "description":"The vector of intervals to restore. The type of all offsets in all DIVA_OFFSET_ SOURCE_DEST structures must be compliant with the format parameter of the Partial File Restore request. Valid only when the format is other than DIVA_ FORMAT_FOLDER_BASED or DIVA_FORMAT_DPX.", "items":{ "$ref":"#/definitions/OffsetPair" } }, "range":{ "description":"The range of frames to be restored. Used only when the format is DIVA_FORMAT_ DPX.", "$ref":"#/definitions/Range" }, "sourceFile":{ "type":"string", "description":"The source file name when the format is other than DIVA_FORMAT_FOLDER_ BASED or DIVA_FORMAT_DPX." } } }, "PartialRestoreOffsets":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "offsets":{ "type":"array", "description":"Partial restore offsets", "items":{ "$ref":"#/definitions/PartialRestoreOffset" } } }, "description":"Definition of PartialRestoreOffsets" }, "PartialRestoreRequestBody":{ "type":"object", "required":[ "collectionName", "destinationServer", "objectName" ], "properties":{ "collectionName":{ "type":"string", "example":"testCollectionName", "description":"The name of the collection (category) assigned to the object when it was archived. This parameter can be a null string, which can result in an error if several objects have the same name." }, "destinationServer":{ "type":"string", "example":"Valid destination server", "description":"The destination (for example, a video server or browsing server) to put the object files. This name must be known by the DIVArchive configuration description." }, "filePathRoot":{ "type":"string", "example":"Valid file path root", "description":"The root folder on the destination where the object files will be placed. If this field is empty, the files will be placed in the folder specified when archiving the object." }, "format":{ "type":"integer", "format":"int32", "description":"One of the following: DIVA_FORMAT_BYTES (0), DIVA_FORMAT_BYTES_HEADER (1), DIVA_FORMAT_VIDEO_GXF (2), DIVA_FORMAT_VIDEO_SEA (3), DIVA_FORMAT_VIDEO_AVI_MATROX (4), DIVA_FORMAT_VIDEO_MPEG2_TS (5), DIVA_FORMAT_VIDEO_MXF (6), DIVA_FORMAT_VIDEO_PINNACLE (7), DIVA_FORMAT_VIDEO_OMNEON (8), DIVA_FORMAT_VIDEO_LEITCH (9), DIVA_FORMAT_VIDEO_QUANTEL (10), DIVA_FORMAT_AUTODETECT (11), DIVA_FORMAT_FOLDER_BASED (12), DIVA_FORMAT_DPX (13)" }, "instance":{ "type":"integer", "format":"int32", "description":"The ID of a non-spanned tape instance" }, "objectName":{ "type":"string", "example":"testObjectName", "description":"The name of the object to be partially restored." }, "offsets":{ "type":"array", "description":"List of offsets. Note: 0 and -1 can be used as begin and end timecodes, respectively, to restore from begin to end.", "items":{ "$ref":"#/definitions/PartialRestoreOffset" } }, "options":{ "type":"string", "example":" ", "description":"Additional options that must be used for performing the transfer of data from DIVArchive to the destination. These options supersede any options specified in the DIVArchive configuration database. " }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority level for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred the highest priority" }, "qos":{ "type":"integer", "format":"int32", "description":"One of the following codes: DIVA_QOS_DEFAULT (0) Restoring is performed according to the default Quality Of Service (currently direct and cache for restore operations). DIVA_QOS_CACHE_ONLY (1) Use cache archive only. DIVA_QOS_DIRECT_ONLY (2) Use direct restore only - no disk instance is created. DIVA_QOS_DIRECT_AND_CACHE (3) Use direct restore if available, or cache restore if direct restore is not available. DIVA_QOS_CACHE_AND_DIRECT (4) Use cache restore if available, or direct restore if cache restore is not available. Additional and optional services are available. Additional and optional services are available. To request those services use a logical OR between the previously documented Quality Of Service parameter and the following constants:\nDIVA_RESTORE_SERVICE_DO_NOT_OVERWRITE (0x0100): Do not overwrite existing files on the destination server.\nDIVA_RESTORE_SERVICE_DO_NOT_CHECK_EXISTENCE (0x0200): Do not check existence of the clip on the server.\nDIVA_RESTORE_SERVICE_DELETE_AND_WRITE (0x0400): Force delete and rewrite if object exists on the server.\nDIVA_RESTORE_SERVICE_DEFAULT (0x0800): Operate using the default setting in the Manager configuration. " } }, "description":"definition of a partial restore request" }, "PossibleTapeOperations":{ "type":"object", "properties":{ "types":{ "type":"array", "description":"List of possible tape operations. One of: READ, WRITE, MOUNT, DISMOUNT, POSITIONING, INSERT, INSERT, EJECT, IMPORT, EXPORT", "items":{ "type":"string", "enum":[ "READ", "WRITE", "MOUNT", "DISMOUNT", "POSITIONING", "INSERT", "EJECT", "IMPORT", "EXPORT" ] } } } }, "ProductionSystem":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" } } }, "ProductionSystems":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "productionSystems":{ "type":"array", "items":{ "$ref":"#/definitions/ProductionSystem" } } } }, "Range":{ "type":"object", "properties":{ "begin":{ "type":"integer", "format":"int32" }, "end":{ "type":"integer", "format":"int32" } } }, "RepackTapeRequestBody":{ "type":"object", "properties":{ "options":{ "type":"string", "description":"Request options." }, "priority":{ "type":"integer", "format":"int32", "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred the highest priority." }, "tapeBarcode":{ "type":"string", "description":"Barcode of tape to be cloned." } }, "description":"definition of an repack tape request" }, "Request":{ "type":"object", "properties":{ "abortReason":{ "description":"Reason for abort of request.", "$ref":"#/definitions/AbortionReason" }, "additionalInfo":{ "type":"string", "example":" ", "description":"Additional information in request" }, "collectionName":{ "type":"string", "example":"A valid collection (category) name", "description":"The name of the collection (category) of the object." }, "completionDate":{ "type":"integer", "format":"int64", "example":1, "description":"The date and time the request completed. This is UTC time in seconds and will be -1 if the request is still processing." }, "contentLength":{ "type":"integer", "format":"int64" }, "currentPriority":{ "type":"integer", "format":"int32", "example":90, "description":"The current priority of the request. This may differ from the initial priority at the time of submission, as priority may increase over time. The priority can be in the range 0 to one 100." }, "currentStep":{ "type":"string", "example":"MOUNT", "description":"The current request step. This is ONLY VALID for RUNNING requests. It is one of the following: NONE, TRANSFER, MOUNT, DISMOUNT, POSITIONING, READ, WRITE, DELETE, WAITING_FOR_RESOURCES, CLEANING_CACHE, WAITING_FOR_OPERATOR, ASSIGNING_SET, OBJECT_SIZE, CLEANING_SOURCE, COPY_DISK, TRANSCODE, ANALYZE, RUNNING_CHILD, WAITING_FOR_SYSTEM_NOTIFICATION, WAN_TRANSFER, TRANSFER_TO_DOWNLOAD_AREA_STARTED, TRANSFER_TO_DOWNLOAD_AREA_COMPLETED" }, "destinationTape":{ "type":"string", "example":"A valid tape", "description":"The destination tape of a request." }, "estimatedRetrievalDuration":{ "type":"string", "example":"1 hour", "description":"The estimated duration of the staging process (transfer to the download area)." }, "fields":{ "$ref":"#/definitions/HttpFields" }, "httpVersion":{ "type":"string", "enum":[ "HTTP/0.9", "HTTP/1.0", "HTTP/1.1", "HTTP/2.0" ] }, "id":{ "type":"integer", "format":"int32", "example":1, "description":"The request Identifier." }, "method":{ "type":"string" }, "objectName":{ "type":"string", "example":"A valid object name", "description":"The name of the object." }, "progress":{ "type":"integer", "format":"int32", "example":90, "description":"The progress of a request. Can be between 0 and 100." }, "request":{ "type":"boolean" }, "response":{ "type":"boolean" }, "servers":{ "type":"array", "example":"List of servers", "description":"The server (source/destination) associated with a request.", "items":{ "type":"string" } }, "sourceTape":{ "type":"string", "example":"A valid tape", "description":"The source tape of a request." }, "stateCode":{ "type":"integer", "format":"int32" }, "stateDescription":{ "type":"string" }, "stateName":{ "type":"string" }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" }, "submissionDate":{ "type":"integer", "format":"int64", "example":1, "description":"The date and time the request was submitted. This is UTC time in seconds (that is, seconds since January 1, 1970)." }, "thirdPartyId":{ "type":"string" }, "throughputMbPerSec":{ "type":"integer", "format":"int64", "example":1000, "description":"The throughput of a request in Mb / sec. " }, "trailerSupplier":{ "$ref":"#/definitions/Supplier«HttpFields»" }, "type":{ "type":"string" }, "typeCode":{ "type":"integer", "format":"int32" }, "typeDescription":{ "type":"string" }, "uri":{ "$ref":"#/definitions/HttpURI" }, "uristring":{ "type":"string" }, "version":{ "type":"string", "enum":[ "HTTP/0.9", "HTTP/1.0", "HTTP/1.1", "HTTP/2.0" ] } } }, "RequestInfo":{ "type":"object", "properties":{ "collectionName":{ "type":"string" }, "instanceId":{ "type":"integer", "format":"int32" }, "media":{ "type":"string" }, "objectName":{ "type":"string" }, "requestId":{ "type":"integer", "format":"int32" }, "status":{ "type":"string" }, "type":{ "type":"string" } } }, "RequestPriorityBody":{ "type":"object", "properties":{ "options":{ "type":"string", "example":" ", "description":"An optional string attribute for specifying additional parameters to the request." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The level of priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority. " } }, "description":"definition of a priority update" }, "RequestProperties":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int32" }, "properties":{ "type":"object" } } }, "RequestStatus":{ "type":"object", "properties":{ "requestId":{ "type":"integer", "format":"int32" }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" } } }, "RequestStep":{ "type":"object", "properties":{ "date":{ "type":"integer", "format":"int64" }, "description":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "requestId":{ "type":"integer", "format":"int32" }, "runningActor":{ "type":"string" }, "runningDrive":{ "type":"string" }, "runningState":{ "type":"string" }, "runningTape":{ "type":"string" }, "severity":{ "type":"string", "enum":[ "Information", "Warning", "Error", "Critical" ] }, "stepName":{ "type":"string" }, "type":{ "type":"string", "enum":[ "Normal", "Decision", "Step" ] } } }, "Requests":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "requests":{ "type":"array", "items":{ "$ref":"#/definitions/Request" } } } }, "RequestsInfo":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "requestsInfo":{ "type":"array", "items":{ "$ref":"#/definitions/RequestInfo" } } }, "description":"Definition of Requests Information" }, "RestoreRequestBody":{ "type":"object", "required":[ "destinationServer", "objectName" ], "properties":{ "collectionName":{ "type":"string", "example":"testCollectionName", "description":"Name of the collection (catgeory) of the object to be restored." }, "destinationServer":{ "type":"string", "example":"Valid destination server", "description":"The destination (for example, a video server or browsing server) where the object files will be restored. This name must be known by the DIVArchive configuration description." }, "filePathRoot":{ "type":"string", "example":"Valid file path root", "description":"Root folder on the destination where the object files will be placed." }, "instance":{ "type":"integer", "format":"int32", "description":"The instance identifier. If -1 is specified, the object will be restored (manager chooses instance). If an identifier >= 0 is specified, the specified instance will be restored. The default is to restore the object." }, "objectName":{ "type":"string", "example":"testObjectName", "description":"Name of the object to be restored." }, "options":{ "type":"string", "example":" ", "description":"Additional options that must be used for performing the transfer of data from DIVArchive to the destination. These options supersede any options specified in the DIVArchive configuration database." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority level for this request. The priority can be in the range zero to one hundred, or the value. The value zero is the lowest priority and one hundred the highest priority. " }, "qos":{ "type":"integer", "format":"int32", "description":"One of the following codes: DIVA_QOS_DEFAULT (0) Restoring is performed according to the default Quality Of Service (currently direct and cache for restore operations). DIVA_QOS_CACHE_ONLY (1) Use cache archive only. DIVA_QOS_DIRECT_ONLY (2) Use direct restore only - no disk instance is created. DIVA_QOS_DIRECT_AND_CACHE (3) Use direct restore if available, or cache restore if direct restore is not available. DIVA_QOS_CACHE_AND_DIRECT (4) Use cache restore if available, or direct restore if cache restore is not available. DIVA_QOS_NEARLINE_ONLY (5) Use nearline restore only. Nearline restore will restore from a disk instance if it exists, otherwise, it will create a disk instance and restore from the newly created disk instance. DIVA_QOS_NEARLINE_AND_DIRECT (6) Use Nearline restore if available, or direct restore if Nearline restore is not available. Additional and optional services are available. To request those services use a logical OR between the previously documented Quality Of Service parameter and the following constants:\nDIVA_RESTORE_SERVICE_DO_NOT_OVERWRITE (0x0100): Do not overwrite existing files on the destination server.\nDIVA_RESTORE_SERVICE_DO_NOT_CHECK_EXISTENCE (0x0200): Do not check existence of the clip on the server.\nDIVA_RESTORE_SERVICE_DELETE_AND_WRITE (0x0400): Force delete and rewrite if object exists on the server.\nDIVA_RESTORE_SERVICE_DEFAULT (0x0800): Operate using the default setting in the Manager configuration." } }, "description":"definition of a restore request" }, "Robot":{ "type":"object", "required":[ "id", "name" ], "properties":{ "address":{ "type":"string" }, "id":{ "type":"integer", "format":"int32", "description":"id" }, "name":{ "type":"string", "example":"test", "description":"name" }, "port":{ "type":"integer", "format":"int32" }, "site":{ "type":"string", "example":"A valid site name", "description":"site" } } }, "RobotAcs":{ "type":"object", "properties":{ "acs":{ "type":"integer", "format":"int32", "description":"acs" }, "name":{ "type":"string", "example":"A valid robot manager name", "description":"name" } } }, "RobotAcses":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "robotAcses":{ "type":"array", "items":{ "$ref":"#/definitions/RobotAcs" } } } }, "RobotForSyncDB":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"robot1", "description":"name" } } }, "Robots":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "robots":{ "type":"array", "items":{ "$ref":"#/definitions/Robot" } } } }, "RoleOutput":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"user", "description":"name" } } }, "RoleOutputs":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "roles":{ "type":"array", "items":{ "$ref":"#/definitions/RoleOutput" } } } }, "SPM":{ "type":"object", "properties":{ "defaultMedia":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "isAllowDeleteLastInstance":{ "type":"boolean" }, "name":{ "type":"string" }, "origin":{ "type":"string", "enum":[ "I", "E" ] } } }, "SPMAction":{ "type":"object", "properties":{ "collectionName":{ "type":"string" }, "comments":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "isEnabled":{ "type":"boolean" }, "numberOfFailures":{ "type":"integer", "format":"int32" }, "objectName":{ "type":"string" }, "requestId":{ "type":"integer", "format":"int32" }, "resultCode":{ "type":"integer", "format":"int32" }, "resultCodeName":{ "type":"string" }, "slotName":{ "type":"string" }, "startAt":{ "type":"integer", "format":"int64" }, "status":{ "type":"string", "enum":[ "Scheduled", "Processing", "Completed", "FailedLong", "FailedShort", "Loaded", "Postponed", "Rejected" ] }, "step":{ "type":"integer", "format":"int32" }, "taskName":{ "type":"string" }, "type":{ "type":"string", "enum":[ "Transcode", "Archive", "Restore", "Copy", "DeleteInstance", "DeleteObject" ] } } }, "SPMActions":{ "type":"object", "properties":{ "actions":{ "type":"array", "items":{ "$ref":"#/definitions/SPMAction" } }, "count":{ "type":"integer", "format":"int32" } }, "description":"Definition of SPM Actions" }, "SPMFilter":{ "type":"object", "properties":{ "categoryNameFilter":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "maximumObjectSize":{ "type":"integer", "format":"int64" }, "mediaFilter":{ "type":"string" }, "minimumObjectSize":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" }, "objectNameFilter":{ "type":"string" }, "sizeUnit":{ "type":"string", "enum":[ "B", "KB", "MB", "GB" ] }, "sourceDestFilter":{ "type":"string" }, "spm":{ "type":"string" } } }, "SPMFilters":{ "type":"object", "properties":{ "SPMFilters":{ "type":"array", "items":{ "$ref":"#/definitions/SPMFilter" } }, "count":{ "type":"integer", "format":"int32" } }, "description":"Definition of SPM Filters" }, "SPMMedia":{ "type":"object", "properties":{ "SPMMedia":{ "type":"array", "items":{ "$ref":"#/definitions/SPMMedium" } }, "count":{ "type":"integer", "format":"int32" } }, "description":"Definition of SPM Mediums" }, "SPMMedium":{ "type":"object", "properties":{ "cleaningStrategy":{ "type":"string", "enum":[ "", "By Archive Date", "By last access time", "By size" ] }, "id":{ "type":"integer", "format":"int32" }, "media":{ "type":"string" }, "name":{ "type":"string" }, "storageName":{ "type":"string" }, "watermarkedMode":{ "type":"string", "enum":[ "Y", "N", "M" ] } } }, "SPMSlot":{ "type":"object", "properties":{ "associatedMedia":{ "type":"string" }, "beginTimeInMinutes":{ "type":"integer", "format":"int64" }, "categoryNameFilter":{ "type":"string" }, "endTimeInMinutes":{ "type":"integer", "format":"int64" }, "executionBeginTimeInMinutes":{ "type":"integer", "format":"int32" }, "executionEndTimeInMinutes":{ "type":"integer", "format":"int32" }, "id":{ "type":"integer", "format":"int32" }, "isCascadeDeleteLinks":{ "type":"boolean" }, "isCascadeRestoreLinks":{ "type":"boolean" }, "isEnabled":{ "type":"boolean" }, "isOnceOnly":{ "type":"boolean" }, "name":{ "type":"string" }, "objectNameFilter":{ "type":"string" }, "priority":{ "type":"integer", "format":"int32" }, "qos":{ "type":"string", "enum":[ "Default", "CacheOnly", "DirectOnly", "CacheAndDirect", "DirectAndCache", "NearlineOnly", "NearlineAndDirect" ] }, "requestComments":{ "type":"string" }, "requestOptions":{ "type":"string" }, "requestPath":{ "type":"string" }, "requestType":{ "type":"string", "enum":[ "METADATA_ARCHIVE", "RESTORE", "STORAGE", "TRANSCODE_ARCHIVED" ] }, "requiredNumberOfInstances":{ "type":"integer", "format":"int32" }, "sourceDestFilter":{ "type":"string" }, "sourceDestination":{ "type":"string" }, "spm":{ "type":"string" }, "targetCategoryTemplate":{ "type":"string" }, "targetObjectNameTemplate":{ "type":"string" } } }, "SPMSlots":{ "type":"object", "properties":{ "SPMSlots":{ "type":"array", "items":{ "$ref":"#/definitions/SPMSlot" } }, "count":{ "type":"integer", "format":"int32" } }, "description":"Definition of SPM Slots" }, "SPMs":{ "type":"object", "properties":{ "SPMs":{ "type":"array", "items":{ "$ref":"#/definitions/SPM" } }, "count":{ "type":"integer", "format":"int32" } }, "description":"Definition of SPMs" }, "ScanDisk":{ "type":"object", "required":[ "diskName" ], "properties":{ "allowInstanceDeletion":{ "type":"boolean", "example":false, "description":"Allow instance deletion" }, "category":{ "type":"string", "example":"test", "description":"(AUTO-INDEXING ONLY) The category to use." }, "diskName":{ "type":"string", "example":"disk1", "description":"Name of disk to scan" }, "objectPathPrefix":{ "type":"string", "example":"NONE", "description":"(AUTO-INDEXING ONLY) The object path prefix. One of NONE, OBJECT_NAME, CATEGORY, NAME_AND_CATEGORY OR UUID.", "enum":[ "NONE", "UUID", "OBJECT_NAME", "CATEGORY", "NAME_AND_CATEGORY" ] }, "startDateTime":{ "type":"integer", "format":"int64", "example":1673051136, "description":"Start date-time of scan as epoch time in seconds" }, "storagePlanName":{ "type":"string", "example":"SP_DEFAULT", "description":"(AUTO-INDEXING ONLY) The name of the storage plan to use." }, "subPathFilter":{ "type":"string", "example":"test", "description":"(AUTO-INDEXING ONLY) The path filter to add to the prefix." }, "trialMode":{ "type":"boolean", "example":false, "description":"Test scan process without storing any objects to the database (will not persist any objects)." }, "type":{ "type":"string", "example":"AXF_SCAN", "description":"Type (One of: AXF_SCAN or AXF_INDEXING, AXF_SCAN is default)", "enum":[ "AXF_SCAN", "AXF_INDEXING" ] } }, "description":"Request body needed to initiate a scan disk" }, "ScanDiskEvent":{ "type":"object", "properties":{ "actorName":{ "type":"string" }, "category":{ "type":"string" }, "description":{ "type":"string" }, "diskName":{ "type":"string" }, "eventDate":{ "type":"integer", "format":"int64" }, "eventType":{ "type":"string", "enum":[ "START", "STOP", "RESOURCE_SELECTION", "SERVICE", "SCAN_STATISTICS", "INSTANCE_PERSISTED", "INSTANCE_NOT_PERSISTED", "ALL" ] }, "id":{ "type":"integer", "format":"int32" }, "lastScanDateTime":{ "type":"integer", "format":"int64" }, "lastScanDurationSec":{ "type":"integer", "format":"int64" }, "objectName":{ "type":"string" }, "scanId":{ "type":"integer", "format":"int32" }, "serviceId":{ "type":"integer", "format":"int32" }, "severity":{ "type":"string", "enum":[ "ALL", "INFORMATION", "WARNING", "ERROR", "CRITICAL" ] }, "successfullyProcessed":{ "type":"integer", "format":"int32" }, "type":{ "type":"string", "enum":[ "AXF_SCAN", "AXF_INDEXING" ] }, "unsuccessfullyProcessed":{ "type":"integer", "format":"int32" } } }, "ScanDiskEvents":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "events":{ "type":"array", "items":{ "$ref":"#/definitions/ScanDiskEvent" } } } }, "ScanDiskServiceInfo":{ "type":"object", "properties":{ "state":{ "type":"string" }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" } } }, "Server":{ "type":"object", "properties":{ "address":{ "type":"string", "example":"127.0.0.1", "description":"address" }, "checksumType":{ "type":"string", "example":"MD5", "description":"checksumType" }, "connectOptions":{ "type":"string", "example":"-allow_delete_on_source", "description":"connectOptions" }, "gcMode":{ "type":"string", "example":" ", "description":"gcMode" }, "isUseExternalChecksumSource":{ "type":"boolean", "example":false, "description":"isUseExternalChecksumSource" }, "isVFA":{ "type":"boolean", "example":false, "description":"isVFA" }, "isVFR":{ "type":"boolean", "example":false, "description":"isVFR" }, "maxAccesses":{ "type":"integer", "format":"int32", "example":10, "description":"maxAccesses" }, "maxReadAccesses":{ "type":"integer", "format":"int32", "example":10, "description":"maxReadAccesses" }, "maxThroughputMBPerSec":{ "type":"integer", "format":"int64", "example":12500, "description":"maxThroughputMBPerSec" }, "maxWriteAccesses":{ "type":"integer", "format":"int32", "example":10, "description":"maxWriteAccesses" }, "name":{ "type":"string", "example":"test", "description":"name" }, "productionSystem":{ "type":"string", "example":"a valid production system", "description":"productionSystem" }, "rootPath":{ "type":"string", "description":"rootPath" }, "site":{ "type":"string", "example":"a valid site", "description":"site" }, "sourcePassword":{ "type":"string", "description":"sourcePassword" }, "type":{ "type":"string", "example":"FTP_STANDARD", "description":"The type of server. One of: UNKNOWN, MSS, PDR, SEACHANGE_BMC, SEACHANGE_BML, SEACHANGE_FTP, LEITCH, FTP_STANDARD, SFTP, DISK, LOCAL, CIFS, OMNEON, simulation, MEDIAGRID, AVID_DHM, AVID_DET, AVID_AMC, QUANTEL_ISA, QUANTEL_QCP, SONY_HYPER_AGENT, METASOURCE, MOVIETOME, EXPEDAT, AVID_DIRECT, SWIFT, OCI, S3, GCS, AZCS, OBJSTORE_ON_DISK, DIVA_BRIDGE" }, "typeId":{ "type":"integer", "format":"int32", "example":7, "description":"The type of server as an enumerated value. One of: UNKNOWN = 0, MSS, PDR, SEACHANGE_BMC, SEACHANGE_BML, SEACHANGE_FTP, LEITCH, FTP_STANDARD, SFTP, DISK, LOCAL, CIFS, OMNEON, simulation, MEDIAGRID, AVID_DHM, AVID_DET, AVID_AMC, QUANTEL_ISA, QUANTEL_QCP, SONY_HYPER_AGENT, METASOURCE, MOVIETOME, EXPEDAT, AVID_DIRECT, SWIFT, OCI, S3, GCS, AZCS, OBJSTORE_ON_DISK, DIVA_BRIDGE" } } }, "ServerDeleteRequestBody":{ "type":"object", "properties":{ "files":{ "type":"array", "description":"List of files to delete.", "items":{ "type":"string" } }, "options":{ "type":"string", "description":"Request options." }, "path":{ "type":"string", "description":"Path from which to delete files." }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority." }, "source":{ "type":"string", "description":"Server from which to delete files." } }, "description":"Definition of a server delete request" }, "Servers":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "servers":{ "type":"array", "items":{ "$ref":"#/definitions/Server" } } } }, "Set":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int32" }, "numEmptyTapes":{ "type":"integer", "format":"int32", "description":"number of empty tapes belonging to this set id" }, "numTapes":{ "type":"integer", "format":"int32", "description":"number of tapes belonging to this set id" } } }, "Sets":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "sets":{ "type":"array", "items":{ "$ref":"#/definitions/Set" } } } }, "Site":{ "type":"object", "properties":{ "comment":{ "type":"string", "example":"some comment", "description":"name" }, "main":{ "type":"boolean", "example":false, "description":"name" }, "name":{ "type":"string", "example":"test", "description":"name" } } }, "Sites":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "sites":{ "type":"array", "items":{ "$ref":"#/definitions/Site" } } } }, "SpmActionOperationBody":{ "type":"object", "properties":{ "operation":{ "type":"string", "example":"Reschedule", "description":"The spm action operation. One of Reschedule or MarkCompleted.", "enum":[ "Reschedule", "MarkCompleted" ] } }, "description":"definition of a spm action update" }, "StageRequestBody":{ "type":"object", "required":[ "collectionName", "objectName", "targetMedia" ], "properties":{ "collectionName":{ "type":"string", "example":"testCollectionName", "description":"The collection name (category) assigned to the object when it was archived." }, "numDaysAvailable":{ "type":"integer", "format":"int32", "example":3, "description":"The number of days the object must be staged. The numDaysAvailable can be in the range 1 to 365 days. The default value is 1." }, "objectName":{ "type":"string", "example":"testObjectName", "description":"The name of the object to be staged." }, "options":{ "type":"string", "description":"Additional options for staging content. These options supersede any options specified in the DIVA Core configuration database. " }, "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority." }, "restoreTier":{ "type":"string", "example":"EXPEDITED", "description":"restoreTier", "enum":[ "NONE", "EXPEDITED", "STANDARD", "BULK", "OSS_STANDARD", "HIGH" ] }, "storageClass":{ "type":"string", "example":"STANDARD", "description":"storageClass", "enum":[ "NONE", "ARCHIVE", "STANDARD", "UNDEFINED", "INTELLIGENT_TIERING", "ONEZONE_IA", "STANDARD_IA", "GLACIER", "DEEP_ARCHIVE", "OSS_STANDARD", "OSS_IA", "NEARLINE", "COLDLINE", "HOT", "COOL", "OSS_COLD_ARCHIVE", "OSS_ARCHIVE", "GLACIER_IR" ] }, "targetMedia":{ "type":"string", "example":"testMedia", "description":"The target media on which to stage the object." } }, "description":"Definition of a stage request" }, "Status":{ "type":"object", "properties":{ "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" } } }, "StorageAccount":{ "type":"object", "properties":{ "compartmentId":{ "type":"string", "example":" ", "description":"compartmentId" }, "fingerprint":{ "type":"string", "example":"a valid fingerprint", "description":"fingerprint" }, "identityDomain":{ "type":"string", "example":"us-east-1", "description":"identityDomain" }, "keyPassword":{ "type":"string", "example":"a valid key password", "description":"keyPassword" }, "login":{ "type":"string", "example":"teststorageaccountlogin", "description":"login" }, "name":{ "type":"string", "example":"test", "description":"name" }, "namespace":{ "type":"string", "example":"5a65949b-244f-4258-ae13-de56f7fbbedd", "description":"namespace" }, "partSizeMB":{ "type":"integer", "format":"int32", "example":5, "description":"partSizeMB" }, "password":{ "type":"string", "example":"a valid password", "description":"password" }, "privateKey":{ "type":"string", "example":"a valid private key", "description":"privateKey" }, "proxy":{ "type":"string", "example":" ", "description":"proxy" }, "serviceName":{ "type":"string", "example":"S3", "description":"serviceName" }, "threadsPerTransfer":{ "type":"integer", "format":"int32", "example":5, "description":"threadsPerTransfer" }, "type":{ "type":"string", "example":"S3", "description":"type", "enum":[ "LOCAL", "CLOUD", "OPC", "OCI", "UNDEFINED", "S3", "GCS", "AZCS" ] }, "url":{ "type":"string", "example":"https://s3.amazonaws.com", "description":"url" }, "vendor":{ "type":"string", "example":"AMAZON", "description":"vendor", "enum":[ "ORACLE", "EMC", "UNDEFINED", "AMAZON", "GOOGLE", "MICROSOFT", "ALIBABA" ] } } }, "StorageAccounts":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "storageAccounts":{ "type":"array", "items":{ "$ref":"#/definitions/StorageAccount" } } } }, "Supplier«HttpFields»":{ "type":"object" }, "Tape":{ "type":"object", "required":[ "id", "status" ], "properties":{ "acs":{ "type":"integer", "format":"int32" }, "barcode":{ "type":"string" }, "blockSize":{ "type":"integer", "format":"int64" }, "cloneEnabled":{ "type":"boolean" }, "cloneSynchronized":{ "type":"boolean" }, "cloneTapeBarcode":{ "type":"string" }, "compressionEnabled":{ "type":"boolean" }, "ejectComment":{ "type":"string" }, "encryptionKey":{ "type":"string" }, "encryptionKeyHash":{ "type":"string" }, "encryptionKeySalt":{ "type":"string" }, "fillingRatio":{ "type":"integer", "format":"int32" }, "firstInsertionDate":{ "type":"string", "format":"date-time" }, "firstMountDate":{ "type":"string", "format":"date-time" }, "format":{ "type":"string" }, "fragmentationRatio":{ "type":"integer", "format":"int32" }, "group":{ "type":"string" }, "id":{ "type":"integer", "format":"int32", "description":"id" }, "inserted":{ "type":"boolean" }, "lastArchiveDate":{ "type":"string", "format":"date-time" }, "lastCloneDate":{ "type":"string", "format":"date-time" }, "lastRetentionDate":{ "type":"string", "format":"date-time" }, "lastWrittenBlock":{ "type":"integer", "format":"int64" }, "lsm":{ "type":"integer", "format":"int32" }, "mediaFormatId":{ "type":"integer", "format":"int32" }, "mediaType":{ "type":"string" }, "protected":{ "type":"boolean" }, "remainingSizeMB":{ "type":"number" }, "repackEnabled":{ "type":"boolean" }, "set":{ "type":"integer", "format":"int32" }, "status":{ "type":"string", "example":"ONLINE", "description":"status", "enum":[ "ONLINE", "OFFLINE" ] }, "toBeCleared":{ "type":"boolean" }, "totalSizeKB":{ "type":"integer", "format":"int64" }, "totalSizeMB":{ "type":"number" }, "used":{ "type":"boolean" }, "usedSizeKB":{ "type":"integer", "format":"int64" }, "writeEnabled":{ "type":"boolean" }, "writeOnce":{ "type":"boolean" } } }, "TapeFileInfo":{ "type":"object", "properties":{ "beginPositionOnTape":{ "type":"integer", "format":"int64" }, "checksumValue":{ "type":"string" }, "checksumVerified":{ "type":"boolean" }, "collection":{ "type":"string" }, "endPositionOnTape":{ "type":"integer", "format":"int64" }, "fileName":{ "type":"string" }, "fileSizeInKB":{ "type":"integer", "format":"int64" }, "instanceId":{ "type":"integer", "format":"int32" }, "objectName":{ "type":"string" }, "spanned":{ "type":"boolean" } } }, "TapeFilesInfo":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "files":{ "type":"array", "items":{ "$ref":"#/definitions/TapeFileInfo" } } } }, "TapeInfo":{ "type":"object", "properties":{ "barcode":{ "type":"string" }, "externalizationComments":{ "type":"string" }, "isGoingToBeRepacked":{ "type":"boolean" }, "isInserted":{ "type":"boolean" }, "mediaFormat":{ "type":"string" }, "mediaFormatId":{ "type":"integer", "format":"int32" } } }, "TapeInformation":{ "type":"object", "properties":{ "acs":{ "type":"integer", "format":"int32" }, "barcode":{ "type":"string" }, "encryptionKey":{ "type":"string" }, "externalizationComments":{ "type":"string" }, "files":{ "type":"array", "items":{ "$ref":"#/definitions/TapeFileInfo" } }, "fillingRatio":{ "type":"integer", "format":"int32" }, "fragmentationRatio":{ "type":"integer", "format":"int32" }, "goingToBeRepacked":{ "type":"boolean" }, "group":{ "type":"string" }, "inserted":{ "type":"boolean" }, "isCompressionEnabled":{ "type":"boolean" }, "lsm":{ "type":"integer", "format":"int32" }, "mediaFormat":{ "type":"string" }, "mediaFormatId":{ "type":"integer", "format":"int32" }, "protected":{ "type":"boolean" }, "remainingSize":{ "type":"integer", "format":"int64" }, "setID":{ "type":"integer", "format":"int32" }, "statusCode":{ "type":"integer", "format":"int32" }, "statusDescription":{ "type":"string" }, "statusName":{ "type":"string" }, "totalSize":{ "type":"integer", "format":"int64" }, "typeID":{ "type":"integer", "format":"int32" }, "typeName":{ "type":"string" }, "writable":{ "type":"boolean" } } }, "TapeInstanceInfo":{ "type":"object", "properties":{ "group":{ "type":"string" }, "id":{ "type":"integer", "format":"int32" }, "isInserted":{ "type":"boolean" }, "isRequired":{ "type":"boolean" }, "tapes":{ "type":"array", "items":{ "$ref":"#/definitions/TapeInfo" } } } }, "TapeLibraries":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "tapeLibraries":{ "type":"array", "items":{ "$ref":"#/definitions/TapeLibrary" } } } }, "TapeLibrariesBody":{ "type":"object", "properties":{ "tapeLibraries":{ "type":"array", "description":"List of tape libraries.", "items":{ "$ref":"#/definitions/TapeLibrary" } } } }, "TapeLibrariesInfo":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "librariesInfo":{ "type":"array", "items":{ "$ref":"#/definitions/TapeLibraryInfo" } } }, "description":"Definition of Tape Libraries Information" }, "TapeLibrary":{ "type":"object", "properties":{ "acs":{ "type":"integer", "format":"int32" }, "lsms":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "name":{ "type":"string" }, "serialNumber":{ "type":"string" }, "status":{ "type":"string", "enum":[ "ONLINE", "OFFLINE" ] }, "typeDescription":{ "type":"string" } } }, "TapeLibraryCapacity":{ "type":"object", "properties":{ "availableCapacityOfflineTB":{ "type":"number", "format":"float" }, "availableCapacityOnlineTB":{ "type":"number", "format":"float" }, "freeCapacityTB":{ "type":"number", "format":"float" }, "totalCapacityTB":{ "type":"number", "format":"float" } } }, "TapeLibraryCore":{ "type":"object", "properties":{ "acs":{ "type":"integer", "format":"int32" }, "firstUtilizationDate":{ "type":"string", "format":"date-time" }, "name":{ "type":"string" }, "serialNumber":{ "type":"string" }, "status":{ "type":"string" }, "type":{ "type":"string" } } }, "TapeLibraryData":{ "type":"object", "properties":{ "totalDataStoredMB":{ "type":"number", "format":"float" }, "totalDataStoredOfflineMB":{ "type":"number", "format":"float" }, "totalDataStoredOnlineMB":{ "type":"number", "format":"float" } } }, "TapeLibraryInfo":{ "type":"object", "properties":{ "capacity":{ "$ref":"#/definitions/TapeLibraryCapacity" }, "core":{ "$ref":"#/definitions/TapeLibraryCore" }, "data":{ "$ref":"#/definitions/TapeLibraryData" }, "objects":{ "$ref":"#/definitions/TapeLibraryObjects" }, "tapes":{ "$ref":"#/definitions/TapeLibraryTapes" } } }, "TapeLibraryObjects":{ "type":"object", "properties":{ "totalObjects":{ "type":"integer", "format":"int32" }, "totalObjectsOffline":{ "type":"integer", "format":"int32" }, "totalObjectsOnline":{ "type":"integer", "format":"int32" } } }, "TapeLibraryTapes":{ "type":"object", "properties":{ "nonWritableTapes":{ "type":"integer", "format":"int32" }, "totalEmptyTapes":{ "type":"integer", "format":"int32" }, "totalTapes":{ "type":"integer", "format":"int32" }, "totalTapesOffline":{ "type":"integer", "format":"int32" }, "totalTapesOnline":{ "type":"integer", "format":"int32" } } }, "TapeOperations":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "tapeOperations":{ "type":"array", "description":"List of tape operations.", "items":{ "$ref":"#/definitions/Map«string,object»" } } } }, "TapeState":{ "type":"object", "required":[ "isEnabledForCloning", "isEnabledForRepack", "isEnabledForWriting" ], "properties":{ "isEnabledForCloning":{ "type":"boolean", "example":true, "description":"isEnabledForCloning" }, "isEnabledForRepack":{ "type":"boolean", "example":true, "description":"IsEnabledForRepack" }, "isEnabledForWriting":{ "type":"boolean", "example":true, "description":"isEnabledForWriting" } } }, "TapeStates":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "tapeStates":{ "type":"array", "items":{ "$ref":"#/definitions/TapeState" } } } }, "TapeType":{ "type":"object", "properties":{ "blockSizeKB":{ "type":"number" }, "id":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" }, "totalSizeKB":{ "type":"integer", "format":"int64" } } }, "TapeTypes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "types":{ "type":"array", "items":{ "$ref":"#/definitions/TapeType" } } } }, "TapeTypesBody":{ "type":"object", "properties":{ "types":{ "type":"array", "description":"List of tape types.", "items":{ "$ref":"#/definitions/TapeType" } } } }, "Tapes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "tapes":{ "type":"array", "items":{ "$ref":"#/definitions/Tape" } } } }, "ToBeClearedTape":{ "type":"object", "required":[ "barcode", "isToBeCleared" ], "properties":{ "barcode":{ "type":"string", "example":"000000", "description":"barcode" }, "isToBeCleared":{ "type":"boolean", "example":false, "description":"isToBeCleared" } } }, "ToBeClearedTapes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "toBeClearedTapes":{ "type":"array", "items":{ "$ref":"#/definitions/ToBeClearedTape" } } }, "description":"Definition of To be cleared Tapes" }, "Token":{ "type":"object", "properties":{ "token":{ "type":"string" } } }, "TranscodeArchiveRequestBody":{ "type":"object", "properties":{ "cascadeDelete":{ "type":"boolean" }, "comments":{ "type":"string" }, "destinationCollectionName":{ "type":"string", "description":"Collection name (category) of the transcoded object." }, "destinationObjectName":{ "type":"string", "description":"Name of the resulting transcoded object from the transcoding operation." }, "media":{ "type":"string" }, "options":{ "type":"string", "description":"Additional options that must be used for performing the transfer of data from the source to DIVA Core. These options supersede any options specified in the DIVA Core configuration. Currently the possible values for options are: -tr_archive_format FORMAT Destination format of the retrieved object. This is required. -tr_names trans1 Names of the transcoders that have to perform this operation. If more than one transcoder is selected, the performing transcoder will be chosen based on the current loading. If this option is not specified, the performing transcoder will be chosen from all DIVArchive transcoders based on the current loading. This is optional. -tr_names trans1,trans2 Names of the transcoders that have to perform this operation. Multiple transcoders are identified in a comma separated list (trans1, trans2, and so on). If more than one transcoder is selected, the performing transcoder will be chosen based on the current loading. If this option is not specified, the performing transcoder will be chosen from all DIVArchive transcoders based on the current loading. This is optional." }, "priority":{ "type":"integer", "format":"int32", "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred the highest priority." }, "qos":{ "type":"integer", "format":"int32", "description":"One of the following codes: DIVA_QOS_DEFAULT (0) Restoring is performed according to the default Quality Of Service (currently cache for archive operations). DIVA_QOS_CACHE_ONLY (1) Use cache archive only. DIVA_QOS_DIRECT_ONLY (2) Use direct archive only - no disk instance is created. DIVA_QOS_DIRECT_AND_CACHE (3) Use direct archive if available, or cache archive if direct archive is not available.DIVA_QOS_CACHE_AND_DIRECT (4) Use cache archive if available, or direct archive if cache archive is not available. " }, "sourceCollectionName":{ "type":"string", "description":"Name of the collection of the original object to be transcoded." }, "sourceInstanceID":{ "type":"integer", "format":"int32", "example":-1, "description":"Instance of the original object." }, "sourceObjectName":{ "type":"string", "description":"Name of the original object to be transcoded." } } }, "Transcoder":{ "type":"object", "required":[ "name", "root" ], "properties":{ "executable":{ "type":"string", "example":"Transcoding\\RunTCode.exe", "description":"the execution path of the transcoder" }, "name":{ "type":"string", "example":"test", "description":"name of the transcoder" }, "numSimultaneousTranscodes":{ "type":"integer", "format":"int32", "example":1, "description":"the number of simultaneous transcodes that can be executed on this transcoder" }, "performance":{ "type":"integer", "format":"int32", "example":1, "description":"regulates usage by favoring higher performing transcoders" }, "port":{ "type":"integer", "format":"int32", "example":10000, "description":"the port used by the transcoder" }, "requestQueueSize":{ "type":"integer", "format":"int32", "example":1, "description":"the request queue size of the transcoder" }, "root":{ "type":"string", "example":"c:\\", "description":"working directory of the transcoder" }, "type":{ "type":"string", "example":"null", "description":"type of the transcoder" }, "version":{ "type":"string", "description":"the version of the transcoder" } } }, "Transcoders":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "transcoders":{ "type":"array", "items":{ "$ref":"#/definitions/Transcoder" } } } }, "TransferRequestBody":{ "type":"object", "properties":{ "components":{ "type":"array", "description":"List of file path names relative to the folder specified by the sourcePathRoot parameter. When the sourcePathRoot is null, path names must be absolute names.", "items":{ "type":"string" } }, "destinationRootPath":{ "type":"string", "description":"Root folder where the files will be placed at the destination." }, "destinationServer":{ "type":"string", "description":"Name of the destination (for example a video server or browsing server). This name must be known by the DIVA Core configuration description." }, "options":{ "type":"string", "description":"Request options." }, "priority":{ "type":"integer", "format":"int32", "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred the highest priority." }, "sourceRootPath":{ "type":"string", "description":"Root folder for the files specified by the filenamesList parameter." }, "sourceServer":{ "type":"string", "description":"Name of the source (for example, a video server or browsing server). This name must be known by the DIVA Core configuration description." } }, "description":"definition of an transfer request" }, "UnusedTape":{ "type":"object", "required":[ "setId" ], "properties":{ "setId":{ "type":"integer", "format":"int32", "example":2, "description":"setId" } } }, "UnusedTapes":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "unusedTapes":{ "type":"array", "items":{ "$ref":"#/definitions/UnusedTape" } } }, "description":"Definition of Unused Tapes" }, "UpdateObjectBody":{ "type":"object", "required":[ "objects", "storagePlanName" ], "properties":{ "objects":{ "type":"array", "description":"Objects to update.", "items":{ "$ref":"#/definitions/DIVAObjectTuple" } }, "storagePlanName":{ "type":"string", "example":"DefaultSPM", "description":"Name of storage plan." } }, "description":"definition of an object update" }, "UserLogin":{ "type":"object", "properties":{ "password":{ "type":"string" }, "username":{ "type":"string" } } }, "UserOutput":{ "type":"object", "properties":{ "role":{ "type":"string" }, "username":{ "type":"string" } } }, "UserOutputs":{ "type":"object", "properties":{ "count":{ "type":"integer", "format":"int32" }, "users":{ "type":"array", "items":{ "$ref":"#/definitions/UserOutput" } } } }, "UserPasswordUpdate":{ "type":"object", "properties":{ "newPassword":{ "type":"string" }, "oldPassword":{ "type":"string" } } }, "UserRegistration":{ "type":"object", "properties":{ "password":{ "type":"string" }, "role":{ "type":"string" }, "username":{ "type":"string" } } }, "UserRoleUpdate":{ "type":"object", "properties":{ "newRole":{ "type":"string" } } }, "VerifyTapeRequestBody":{ "type":"object", "properties":{ "priority":{ "type":"integer", "format":"int32", "example":50, "description":"The priority for this request. The priority can be in the range zero to one hundred. The value zero is the lowest priority and one hundred is the highest priority." }, "tapeBarcode":{ "type":"string", "description":"Barcode of tape to verify." } }, "description":"definition of an verify tape request" } } }