{ "openapi": "3.0.1", "info": { "title": "RODA REST API", "description": "REST AIP for RODA", "contact": { "name": "KEEP SOLUTIONS", "url": "https://www.keep.pt/en/contacts-proposals-information-telephone-address", "email": "info@keep.pt" }, "license": { "name": "LGPLv3", "url": "http://www.gnu.org/licenses/lgpl-3.0.html" }, "version": "2.0.0" }, "servers": [ { "url": "http://localhost:8080", "description": "Generated server url" } ], "security": [ { "basicAuth": [] }, { "bearerAuth": [] } ], "paths": { "/api/v2/risks": { "put": { "tags": [ "v2 risks" ], "summary": "Update risk", "description": "Update existing risk", "operationId": "updateRisk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Risk" } } }, "required": true }, "responses": { "200": { "description": "Risk updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Risk" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 risks" ], "summary": "Creates a new risk", "description": "Creates a new risk", "operationId": "createRisk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Risk" } } }, "required": true }, "responses": { "201": { "description": "Risk created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Risk" } } } } } } }, "/api/v2/risks/{id}/versions/{version-id}/revert": { "put": { "tags": [ "v2 risks" ], "summary": "Reverts the risk to the an older version", "description": "Reverts the risk to the an older version", "operationId": "revertRiskVersion", "parameters": [ { "name": "id", "in": "path", "description": "The identifier of the risk to revert the version.", "required": true, "schema": { "type": "string" } }, { "name": "version-id", "in": "path", "description": "The identifier of the version to revert the risk.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reverted risk", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Risk" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/type": { "put": { "tags": [ "v2 representations" ], "summary": "Changes the representation type via search query", "operationId": "changeRepresentationType", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeTypeRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/status": { "put": { "tags": [ "v2 representations" ], "summary": "Changes the representation status", "description": "Changes representation status", "operationId": "changeRepresentationStatus", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRepresentationStatesRequest" } } }, "required": true }, "responses": { "200": { "description": "Representation status changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representation-information": { "put": { "tags": [ "v2 representation information" ], "summary": "Updates an existing representation information", "description": "Updates an existing representation information", "operationId": "updateRepresentationInformation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationInformationCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Representation information created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationInformation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Representation information not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 representation information" ], "summary": "Creates a representation information", "description": "Creates a representation information", "operationId": "createRepresentationInformation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationInformationCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Representation information created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationInformation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users": { "put": { "tags": [ "v2 members" ], "summary": "Update user", "description": "Updates a user", "operationId": "updateUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 members" ], "summary": "Create user", "description": "Creates a new user", "operationId": "createUser", "parameters": [ { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "schema": { "type": "string", "default": "en" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/update-my-user": { "put": { "tags": [ "v2 members" ], "summary": "Update my user", "description": "Updates my user", "operationId": "updateMyUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/groups": { "put": { "tags": [ "v2 members" ], "summary": "Update group", "description": "Updates a group", "operationId": "updateGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 members" ], "summary": "Create group", "description": "Creates a new group", "operationId": "createGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroupRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/incidences": { "put": { "tags": [ "v2 incidences" ], "summary": "Updates a single risk incidence", "description": "Updates an existing incidence", "operationId": "updateRiskIncidence", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskIncidence" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskIncidence" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/distributed-instances": { "get": { "tags": [ "v2 distributed instances" ], "summary": "Get distributed instances", "description": "Gets distributed instances list", "operationId": "getDistributedInstances", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributedInstances" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "put": { "tags": [ "v2 distributed instances" ], "summary": "Update distributed instance", "description": "Updates a new distributed instance", "operationId": "updateDistributedInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributedInstance" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributedInstance" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 distributed instances" ], "summary": "Create distributed instance", "description": "Creates a new distributed instance", "operationId": "createDistributedInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDistributedInstanceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributedInstance" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/distributed-instances/local": { "get": { "tags": [ "v2 distributed instances" ], "summary": "Get local instance", "description": "Gets a particular local instance", "operationId": "getLocalInstance", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalInstance" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "put": { "tags": [ "v2 distributed instances" ], "summary": "Update local instance configuration", "description": "Updates local instance configuration", "operationId": "updateLocalInstanceConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalInstance" } } }, "required": true }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalInstance" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 distributed instances" ], "summary": "Create local instance", "description": "Creates a new local instance", "operationId": "createLocalInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocalInstanceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalInstance" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/schedules": { "get": { "tags": [ "v2 disposal schedules" ], "summary": "List disposal schedules", "operationId": "listDisposalSchedules", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalSchedules" } } } } } }, "put": { "tags": [ "v2 disposal schedules" ], "summary": "Update disposal schedule", "description": "Update existing disposal schedule", "operationId": "updateDisposalSchedule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalSchedule" } } }, "required": true }, "responses": { "200": { "description": "Disposal schedule updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalSchedule" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 disposal schedules" ], "summary": "Create disposal schedule", "description": "Create a new schedule schedule", "operationId": "createDisposalSchedule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalSchedule" } } }, "required": true }, "responses": { "201": { "description": "Disposal schedule created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalSchedule" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/rules": { "get": { "tags": [ "v2 disposal rules" ], "summary": "List disposal rules", "operationId": "listDisposalRules", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalRules" } } } } } }, "put": { "tags": [ "v2 disposal rules" ], "summary": "Update disposal rule", "description": "Update existing disposal rule", "operationId": "updateDisposalRule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalRule" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalRule" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 disposal rules" ], "summary": "Create disposal rule", "description": "Create a new disposal rule", "operationId": "createDisposalRule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalRule" } } }, "required": true }, "responses": { "201": { "description": "Disposal rul created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalRule" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/holds": { "get": { "tags": [ "v2 disposal holds" ], "summary": "List disposal holds", "operationId": "listDisposalHolds", "responses": { "200": { "description": "Returns a list of disposal holds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalHolds" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "put": { "tags": [ "v2 disposal holds" ], "summary": "Update disposal hold", "description": "Update existing disposal hold", "operationId": "updateDisposalHold", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalHold" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalHold" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 disposal holds" ], "summary": "Create disposal hold", "description": "Create a new disposal hold", "operationId": "createDisposalHold", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalHold" } } }, "required": true }, "responses": { "201": { "description": "Disposal hold created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalHold" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/holds/{id}/lift": { "put": { "tags": [ "v2 disposal holds" ], "summary": "Lift specific disposal hold", "operationId": "liftDisposalHold", "parameters": [ { "name": "id", "in": "path", "description": "Disposal hold id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalHold" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Disposal hold not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 disposal holds" ], "summary": "Lift disposal holds from selected AIPs", "operationId": "liftDisposalHoldBySelectedItems", "parameters": [ { "name": "id", "in": "path", "description": "disposal hold id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/representation/{representation-id}metadata/descriptive/{descriptive-metadata-id}/versions/{version-id}/revert": { "put": { "tags": [ "v2 aips" ], "summary": "Reverts representation descriptive metadata to the an older version", "description": "Reverts representation descriptive metadata to the an older version", "operationId": "revertRepresentationDescriptiveMetadataVersion", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "description": "The representation identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "version-id", "in": "path", "description": "The version identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reverted descriptive metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadata" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/representation/{representation-id}/metadata/descriptive": { "put": { "tags": [ "v2 aips" ], "summary": "Updates a representation descriptive metadata", "operationId": "updateRepresentationDescriptiveMetadataFile", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "description": "The representation identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDescriptiveMetadataRequest" } } }, "required": true }, "responses": { "200": { "description": "Descriptive metadata updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadata" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 aips" ], "summary": "Creates a descriptive metadata under AIP representation", "description": "Create AIP descriptive metadata", "operationId": "createRepresentationDescriptiveMetadata", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDescriptiveMetadataRequest" } } }, "required": true }, "responses": { "201": { "description": "Descriptive metadata created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadata" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive": { "put": { "tags": [ "v2 aips" ], "summary": "Updates an AIP descriptive metadata", "operationId": "updateAIPDescriptiveMetadataFile", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDescriptiveMetadataRequest" } } }, "required": true }, "responses": { "200": { "description": "Descriptive metadata updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadata" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 aips" ], "summary": "Creates a descriptive metadata under the AIP", "description": "Create AIP descriptive metadata", "operationId": "createAIPDescriptiveMetadata", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDescriptiveMetadataRequest" } } }, "required": true }, "responses": { "201": { "description": "Descriptive metadata created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadata" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive/{descriptive-metadata-id}/versions/{version-id}/revert": { "put": { "tags": [ "v2 aips" ], "summary": "Reverts AIP descriptive metadata to the an older version", "description": "Reverts AIP descriptive metadata to the an older version", "operationId": "revertAIPDescriptiveMetadataVersion", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "version-id", "in": "path", "description": "The version identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reverted descriptive metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadata" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/suggest": { "post": { "tags": [ "v2 transfers" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/selected": { "post": { "tags": [ "v2 transfers" ], "summary": "List selected transferred resources", "description": "Gets a list of transferred resources", "operationId": "getSelectedTransferredResources", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/refresh": { "post": { "tags": [ "v2 transfers" ], "summary": "Refreshes transferred resource", "description": "Refreshes transferred resources", "operationId": "refreshTransferResource", "parameters": [ { "name": "path", "in": "query", "description": "Transfer resource relative path", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/v2/transfers/move": { "post": { "tags": [ "v2 transfers" ], "summary": "Move transferred resources", "description": "Gets a list of transferred resources", "operationId": "moveTransferredResources", "parameters": [ { "name": "uuid", "in": "query", "description": "The transferred resource uuid", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/find": { "post": { "tags": [ "v2 transfers" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/delete": { "post": { "tags": [ "v2 transfers" ], "summary": "Delete multiple transferred resource via search query", "description": "Deletes one or more transferred resources", "operationId": "deleteMultipleResources", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SelectedItemsFilterRequest" }, { "$ref": "#/components/schemas/SelectedItemsListRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Created job with the internal action to delete transferred resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/create/resource": { "post": { "tags": [ "v2 transfers" ], "summary": "Create transferred resource", "description": "Creates a new transferred resource", "operationId": "createTransferredResource", "parameters": [ { "name": "parent-uuid", "in": "query", "description": "The id of the parent", "required": false, "schema": { "type": "string" } }, { "name": "commit", "in": "query", "description": "Commit after creation", "required": false, "content": { "*/*": { "schema": { "type": "boolean" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "resource" ], "type": "object", "properties": { "resource": { "type": "string", "description": "Multipart file", "format": "binary" } } } } } }, "responses": { "201": { "description": "Transferred resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferredResource" } } } }, "409": { "description": "Already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/create/folder": { "post": { "tags": [ "v2 transfers" ], "summary": "Create transferred resource folder", "description": "Creates a new transferred resources folder", "operationId": "createTransferredResourcesFolder", "parameters": [ { "name": "parent-uuid", "in": "query", "description": "The id of the parent", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "The name of the directory to create", "required": true, "schema": { "type": "string" } }, { "name": "commit", "in": "query", "description": "Commit after creation", "required": true, "content": { "*/*": { "schema": { "type": "boolean" } } } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferredResource" } } } }, "409": { "description": "Already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/count": { "post": { "tags": [ "v2 transfers" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/risks/suggest": { "post": { "tags": [ "v2 risks" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_1", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/risks/find": { "post": { "tags": [ "v2 risks" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_1", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/risks/delete": { "post": { "tags": [ "v2 risks" ], "summary": "Delete multiple risks via search query", "description": "Deletes one or more risks via search query", "operationId": "deleteRisk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/risks/count": { "post": { "tags": [ "v2 risks" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_1", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/representations/{id}": { "post": { "tags": [ "v2 representations" ], "summary": "Create representation", "description": "Creates a new representation on an AIP", "operationId": "createRepresentation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The type of the new representation", "required": false, "schema": { "type": "string", "default": "MIXED" } }, { "name": "details", "in": "query", "description": "Reason to create representation", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Representation" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/suggest": { "post": { "tags": [ "v2 representations" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_2", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/identify": { "post": { "tags": [ "v2 representations" ], "summary": "Creates a preservation action to identify the file formats via search query", "description": "Identifies the file format for a set of files within the representation", "operationId": "createFormatIdentificationJob", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "Created job to identify the format associated to the files within the representation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/find": { "post": { "tags": [ "v2 representations" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_2", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/find-via-request": { "post": { "tags": [ "v2 representations" ], "summary": "Retrieves a representation using a dedicated request", "operationId": "retrieveIndexedRepresentationViaRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexedRepresentationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexedFile" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "File not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/delete": { "post": { "tags": [ "v2 representations" ], "summary": "Delete representation", "description": "Deletes a new representation on an AIP", "operationId": "deleteRepresentation", "parameters": [ { "name": "details", "in": "query", "description": "Reason to delete representation", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/count": { "post": { "tags": [ "v2 representations" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_2", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/representation-information/suggest": { "post": { "tags": [ "v2 representation information" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_3", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representation-information/find": { "post": { "tags": [ "v2 representation information" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_3", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representation-information/filter": { "post": { "tags": [ "v2 representation information" ], "summary": "Add a Filter to a set of selected representation information", "operationId": "addFilterToRepresentationInformation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationInformationFilterRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } } } } }, "/api/v2/representation-information/delete": { "post": { "tags": [ "v2 representation information" ], "summary": "Delete multiple representation information via search query", "description": "Deletes one or more representation information", "operationId": "deleteMultipleRepresentationInformation", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SelectedItemsFilterRequest" }, { "$ref": "#/components/schemas/SelectedItemsListRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } } } } }, "/api/v2/representation-information/count": { "post": { "tags": [ "v2 representation information" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_3", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/preservation/events/suggest": { "post": { "tags": [ "v2 preservation events" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_4", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/events/find": { "post": { "tags": [ "v2 preservation events" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_4", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/events/count": { "post": { "tags": [ "v2 preservation events" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_4", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/preservation/agents/suggest": { "post": { "tags": [ "v2 preservation agents" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_5", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/agents/find": { "post": { "tags": [ "v2 preservation agents" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_5", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/agents/count": { "post": { "tags": [ "v2 preservation agents" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_5", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/notifications/suggest": { "post": { "tags": [ "v2 notifications" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_6", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/v2/notifications/find": { "post": { "tags": [ "v2 notifications" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_6", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/notifications/count": { "post": { "tags": [ "v2 notifications" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_6", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/notifications/acknowledge": { "post": { "tags": [ "v2 notifications" ], "summary": "Acknowledge notification", "description": "Acknowledges a notification", "operationId": "acknowledgeNotification", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationAcknowledgeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericOkResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/{id}/send-verification": { "post": { "tags": [ "v2 members" ], "summary": "Send verification email", "description": "Sends verification email", "operationId": "sendEmailVerification", "parameters": [ { "name": "id", "in": "path", "description": "User identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } } } } }, "/api/v2/members/users/{id}/confirm": { "post": { "tags": [ "v2 members" ], "summary": "Confirm user email", "description": "Confirms a user email", "operationId": "confirmUserEmail", "parameters": [ { "name": "id", "in": "path", "description": "User identifier", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "token", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericOkResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/{id}/access-keys": { "get": { "tags": [ "v2 members" ], "summary": "Get user access keys list", "description": "Gets a particular user access keys", "operationId": "getAccessKeysByUser", "parameters": [ { "name": "id", "in": "path", "description": "The user identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessKeys" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "post": { "tags": [ "v2 members" ], "summary": "Create access key", "description": "Creates an access key", "operationId": "createAccessKey", "parameters": [ { "name": "id", "in": "path", "description": "Users identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccessKeyRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessKey" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/status": { "post": { "tags": [ "v2 members" ], "summary": "Activate or deactivate a RODA users via search query", "description": "Activates or deactivates RODA users", "operationId": "changeActive", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeUserStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/register": { "post": { "tags": [ "v2 members" ], "summary": "Register user", "description": "Registers a new user", "operationId": "registerUser", "parameters": [ { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "schema": { "type": "string", "default": "en" } }, { "name": "captcha", "in": "query", "description": "captcha", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } } }, "/api/v2/members/users/recover": { "post": { "tags": [ "v2 members" ], "summary": "Recover login", "description": "Sends an email to recover login", "operationId": "recoverLogin", "parameters": [ { "name": "email", "in": "query", "description": "User email", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "schema": { "type": "string", "default": "en" } }, { "name": "captcha", "in": "query", "description": "captcha", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericOkResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/login": { "post": { "tags": [ "v2 members" ], "summary": "Login", "description": "Logs in a user", "operationId": "login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/access-keys/revoke/{id}": { "post": { "tags": [ "v2 members" ], "summary": "Revoke access key", "description": "Revokes a access key", "operationId": "revokeAccessKey", "parameters": [ { "name": "id", "in": "path", "description": "The access key identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessKey" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/access-keys/regenerate/{id}": { "post": { "tags": [ "v2 members" ], "summary": "Regenerate access key", "description": "Regenerate a access key", "operationId": "regenerateAccessKey", "parameters": [ { "name": "id", "in": "path", "description": "The access key id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccessKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessKey" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/token": { "post": { "tags": [ "v2 members" ], "summary": "Authenticate using access key", "description": "Authenticates using access key", "operationId": "authenticate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessKey" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessToken" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/suggest": { "post": { "tags": [ "v2 members" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_7", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/find": { "post": { "tags": [ "v2 members" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_7", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/delete": { "post": { "tags": [ "v2 members" ], "summary": "Delete multiple RODA members via search query", "description": "Deletes one or more RODA members", "operationId": "deleteMultipleMembers", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/api/v2/members/count": { "post": { "tags": [ "v2 members" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_7", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/jobs": { "post": { "tags": [ "v2 jobs" ], "summary": "Create job", "description": "Creates a new job", "operationId": "createJob", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "required": true }, "responses": { "201": { "description": "Job created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "409": { "description": "Already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/suggest": { "post": { "tags": [ "v2 jobs" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_8", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/reject": { "post": { "tags": [ "v2 jobs" ], "summary": "Reject job", "description": "Rejects a job.", "operationId": "rejectJob", "parameters": [ { "name": "details", "in": "query", "description": "Justification for why the job was rejected", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/plugin-info": { "post": { "tags": [ "v2 jobs" ], "summary": "Get job plugin info", "description": "Gets the information about the plugins executed on the job", "operationId": "getJobPluginInfo", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginInfo" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/obtain-command": { "post": { "tags": [ "v2 jobs" ], "summary": "Obtains the cURL command for a job", "operationId": "obtainJobCommand", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "required": true }, "responses": { "200": { "description": "cURL command successfully built", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/jobs/find": { "post": { "tags": [ "v2 jobs" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_8", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/count": { "post": { "tags": [ "v2 jobs" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_8", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/jobs/approve": { "post": { "tags": [ "v2 jobs" ], "summary": "Approve job", "description": "Approves a job.", "operationId": "approveJob", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/job-reports/suggest": { "post": { "tags": [ "v2 job reports" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_9", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/job-reports/find": { "post": { "tags": [ "v2 job reports" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_9", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/job-reports/count": { "post": { "tags": [ "v2 job reports" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_9", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/incidences/suggest": { "post": { "tags": [ "v2 incidences" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_10", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/incidences/find": { "post": { "tags": [ "v2 incidences" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_10", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/incidences/delete": { "post": { "tags": [ "v2 incidences" ], "summary": "Deletes multiple incidences via search query", "description": "Deletes one or more incidence", "operationId": "deleteRiskIncidences", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/incidences/count": { "post": { "tags": [ "v2 incidences" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_10", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/files/upload": { "post": { "tags": [ "v2 files" ], "summary": "Uploads a file under a representation", "description": "Creates a new file resource under a representation", "operationId": "uploadFileResource", "parameters": [ { "name": "aip-id", "in": "query", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "query", "description": "The Representation identifier", "required": true, "schema": { "type": "string" } }, { "name": "folder", "in": "query", "description": "The parent directory where the File will be placed", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "details", "in": "query", "description": "Reason why upload the file", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "resource" ], "type": "object", "properties": { "resource": { "type": "string", "description": "Multipart file", "format": "binary" } } } } } }, "responses": { "201": { "description": "File resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexedFile" } } } }, "409": { "description": "Already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/suggest": { "post": { "tags": [ "v2 files" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_11", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/move": { "post": { "tags": [ "v2 files" ], "summary": "Create an internal action to move file(s) to another folder within the representation", "operationId": "moveFileToFolder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveFilesRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/format-identification": { "post": { "tags": [ "v2 files" ], "summary": "Creates a preservation action to identify the file formats via search query", "description": "Identifies the file format for a set of Files", "operationId": "identifyFileFormat", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SelectedItemsFilterRequest" }, { "$ref": "#/components/schemas/SelectedItemsListRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Created job to identify the format associated to the files", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } } } } }, "/api/v2/files/find": { "post": { "tags": [ "v2 files" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_11", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/find-via-request": { "post": { "tags": [ "v2 files" ], "summary": "Retrieves a file using a dedicated request", "operationId": "retrieveIndexedFileViaRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexedFileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexedFile" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "File not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/delete": { "post": { "tags": [ "v2 files" ], "summary": "Creates an internal action to delete file(s) from the representation", "operationId": "deleteFiles", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/create/folder": { "post": { "tags": [ "v2 files" ], "summary": "Creates a new folder under a representation", "operationId": "createFolderUnderRepresentation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFolderRequest" } } }, "required": true }, "responses": { "201": { "description": "Folder created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexedFile" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "AIP not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "409": { "description": "Resource already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/count": { "post": { "tags": [ "v2 files" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_11", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/distributed-instances/test-configuration": { "post": { "tags": [ "v2 distributed instances" ], "summary": "Test local instance configuration", "description": "Tests local instance configuration", "operationId": "testLocalInstanceConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalInstance" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/distributed-instances/local/synchronize": { "post": { "tags": [ "v2 distributed instances" ], "summary": "Synchronize instances", "description": "Synchronizes instances", "operationId": "synchronize", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalInstance" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/distributed-instances/local/subscribe": { "post": { "tags": [ "v2 distributed instances" ], "summary": "Subscribe local instance", "description": "Subscribes local instance", "operationId": "subscribeLocalInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalInstance" } } }, "required": true }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalInstance" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/schedules/{id}/associate": { "post": { "tags": [ "v2 disposal schedules" ], "summary": "Associate a disposal schedule to selected AIPs", "operationId": "associatedDisposalSchedule", "parameters": [ { "name": "id", "in": "path", "description": "Disposal schedule id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } } } } }, "/api/v2/disposal/schedules/disassociate": { "post": { "tags": [ "v2 disposal schedules" ], "summary": "Disassociate a disposal schedule from selected AIPs", "operationId": "disassociatedDisposalSchedule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } } } } }, "/api/v2/disposal/rules/apply": { "post": { "tags": [ "v2 disposal rules" ], "summary": "Apply disposal rule to repository", "description": "Applies the set of rules defined to the all repository. AIPs which their disposal schedule was manually associated may it can be override using the query parameter.", "operationId": "applyDisposalRules", "parameters": [ { "name": "includeManually", "in": "query", "description": "If true disposal schedules that were manually associated to an intellectual entity may be associated to a different disposal schedule", "required": false, "content": { "*/*": { "schema": { "type": "boolean" } } } } ], "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/holds/{id}/associate": { "post": { "tags": [ "v2 disposal holds" ], "summary": "Apply disposal hold to selected AIPs", "operationId": "applyDisposalHold", "parameters": [ { "name": "id", "in": "path", "description": "Disposal hold id", "required": true, "schema": { "type": "string" } }, { "name": "override", "in": "query", "description": "Lift all disposal holds associated and apply the selected disposal hold", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } } } } }, "/api/v2/disposal/holds/disassociate": { "post": { "tags": [ "v2 disposal holds" ], "summary": "Disassociate disposal hold from selected AIPs", "operationId": "disassociateDisposalHold", "parameters": [ { "name": "clear", "in": "query", "description": "Disassociate all disposal holds associated to AIP", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedItemsRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations": { "post": { "tags": [ "v2 disposal confirmations" ], "summary": "Creates a disposal confirmation", "operationId": "createDisposalConfirmation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalConfirmationCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/suggest": { "post": { "tags": [ "v2 disposal confirmations" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_12", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/restore": { "post": { "tags": [ "v2 disposal confirmations" ], "summary": "Restores disposal confirmations", "description": "Creates an internal job to restore the disposal confirmations", "operationId": "restoreDisposalConfirmation", "requestBody": { "content": { "application/json": { "schema": { "description": "Selected disposal confirmations", "oneOf": [ { "$ref": "#/components/schemas/SelectedItemsFilterRequest" }, { "$ref": "#/components/schemas/SelectedItemsListRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/recover": { "post": { "tags": [ "v2 disposal confirmations" ], "summary": "Recovers disposal confirmations", "description": "Creates an internal job to recover the disposal confirmations", "operationId": "recoverDisposalConfirmation", "requestBody": { "content": { "application/json": { "schema": { "description": "Selected disposal confirmations", "oneOf": [ { "$ref": "#/components/schemas/SelectedItemsFilterRequest" }, { "$ref": "#/components/schemas/SelectedItemsListRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/permanent": { "post": { "tags": [ "v2 disposal confirmations" ], "summary": "Permanently deletes the records in the disposal confirmations", "description": "Creates an internal job to permanently delete the records in the disposal confirmations", "operationId": "permanentlyDeleteRecordsInDisposalConfirmation", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SelectedItemsFilterRequest" }, { "$ref": "#/components/schemas/SelectedItemsListRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/find": { "post": { "tags": [ "v2 disposal confirmations" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_12", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/destroy": { "post": { "tags": [ "v2 disposal confirmations" ], "summary": "Destroys the records in the disposal confirmations", "description": "Creates an internal job to destroy the records in the disposal confirmations", "operationId": "destroyRecordsInDisposalConfirmation", "requestBody": { "content": { "application/json": { "schema": { "description": "Selected disposal confirmations", "oneOf": [ { "$ref": "#/components/schemas/SelectedItemsFilterRequest" }, { "$ref": "#/components/schemas/SelectedItemsListRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/delete": { "post": { "tags": [ "v2 disposal confirmations" ], "summary": "Deletes disposal rule", "description": "Creates an internal job to delete the disposal confirmations", "operationId": "deleteDisposalConfirmation", "parameters": [ { "name": "reason", "in": "query", "description": "Reason for deletion", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Selected disposal confirmations", "oneOf": [ { "$ref": "#/components/schemas/SelectedItemsFilterRequest" }, { "$ref": "#/components/schemas/SelectedItemsListRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/count": { "post": { "tags": [ "v2 disposal confirmations" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_12", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/dips/suggest": { "post": { "tags": [ "v2 dips" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_13", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/dips/permissions/update": { "post": { "tags": [ "v2 dips" ], "summary": "Creates an internal actions to update the permissions of DIP(s)", "operationId": "updatePermissions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePermissionsRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/dips/find": { "post": { "tags": [ "v2 dips" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_13", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/dips/delete": { "post": { "tags": [ "v2 dips" ], "summary": "Creates an internal action to delete file(s) from the representation", "operationId": "deleteIndexedDIPs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/dips/count": { "post": { "tags": [ "v2 dips" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_13", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/dip-files/suggest": { "post": { "tags": [ "v2 dip files" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_14", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/dip-files/find": { "post": { "tags": [ "v2 dip files" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_14", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/dip-files/count": { "post": { "tags": [ "v2 dip files" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_14", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/audit-logs/suggest": { "post": { "tags": [ "v2 audit logs" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_15", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/audit-logs/import": { "post": { "tags": [ "v2 audit logs" ], "summary": "Import audit logs from replica instances to the primary", "description": "In order to synchronized the audit logs between all RODA instances it is necessary that read-only RODA's send their logs to the read-write RODA.", "operationId": "importLogEntry", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericOkResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "409": { "description": "Already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/audit-logs/find": { "post": { "tags": [ "v2 audit logs" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_15", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/audit-logs/count": { "post": { "tags": [ "v2 audit logs" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_15", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/aips": { "post": { "tags": [ "v2 aips" ], "summary": "Creates an AIP", "description": "Creates a new AIP", "operationId": "createAIP", "parameters": [ { "name": "parent-aip-id", "in": "query", "description": "The parent AIP identifier", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of AIP", "required": false, "schema": { "type": "string", "default": "MIXED" } } ], "responses": { "201": { "description": "Returns the new AIP", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIP" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive/preview": { "post": { "tags": [ "v2 aips" ], "summary": "Gets a preview of descriptive metadata", "description": "Get AIP descriptive metadata preview", "operationId": "retrieveDescriptiveMetadataPreview", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadataPreviewRequest" } } }, "required": true }, "responses": { "200": { "description": "Descriptive metadata preview", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadataPreview" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/suggest": { "post": { "tags": [ "v2 aips" ], "summary": "Returns a set of suggestions giving a query", "description": "Returns a set of suggestions giving a query", "operationId": "suggest_16", "requestBody": { "description": "Suggest parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "List of suggestions", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/move": { "post": { "tags": [ "v2 aips" ], "summary": "Move AIP in the hierarchy", "description": "Moves an AIP in the hierarchy", "operationId": "moveAIPInHierarchy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/find": { "post": { "tags": [ "v2 aips" ], "summary": "Find indexed resources via search query", "description": "Finds existing indexed resources", "operationId": "find_16", "parameters": [ { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/export/csv": { "post": { "tags": [ "v2 aips" ], "summary": "Exports a set of finite elements to CSV", "operationId": "exportToCSV", "parameters": [ { "name": "findRequest", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } } } } }, "/api/v2/aips/delete": { "post": { "tags": [ "v2 aips" ], "summary": "Delete multiple AIPs via search query", "description": "Creates an internal action to delete the selected AIPs", "operationId": "deleteAIPs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/count": { "post": { "tags": [ "v2 aips" ], "summary": "Count indexed resources", "description": "Counts indexed resources", "operationId": "count_16", "requestBody": { "description": "Count parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the object counting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/aips/assessment": { "post": { "tags": [ "v2 aips" ], "summary": "Appraisal of transferred resource", "description": "Accepts or rejects assessment", "operationId": "appraisal", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/rename": { "patch": { "tags": [ "v2 transfers" ], "summary": "Rename transferred resource", "description": "Renames a transferred resource", "operationId": "renameTransferredResource", "parameters": [ { "name": "uuid", "in": "query", "description": "The transferred resource uuid", "required": true, "schema": { "type": "string" } }, { "name": "new-name", "in": "query", "description": "The new name", "required": true, "schema": { "type": "string" } }, { "name": "replace-existing", "in": "query", "description": "Replacing existent file", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferredResource" } } } }, "409": { "description": "Already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/{id}/reset-password": { "patch": { "tags": [ "v2 members" ], "summary": "Resets user password", "description": "Resets a user password", "operationId": "resetUserPassword", "parameters": [ { "name": "id", "in": "path", "description": "User identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } }, "required": true }, "responses": { "204": { "description": "Password changed" }, "400": { "description": "Bad request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/incidences/update": { "patch": { "tags": [ "v2 incidences" ], "summary": "Updates multiple risk incidences via search query", "description": "Updates multiple risk incidences", "operationId": "updateMultipleIncidences", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRiskIncidences" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/rename": { "patch": { "tags": [ "v2 files" ], "summary": "Rename folder", "description": "Renames a folder", "operationId": "renameFolder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameFolderRequest" } } }, "required": true }, "responses": { "200": { "description": "Folder renamed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexedFile" } } } }, "409": { "description": "Already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/type": { "patch": { "tags": [ "v2 aips" ], "summary": "Changes the AIP type via search query", "operationId": "changeAIPType", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeTypeRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/permissions/update": { "patch": { "tags": [ "v2 aips" ], "summary": "Creates an internal actions to update the permissions of AIP(s)", "operationId": "updatePermissions_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePermissionsRequest" } } }, "required": true }, "responses": { "200": { "description": "Job created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/{uuid}": { "get": { "tags": [ "v2 transfers" ], "summary": "Get transferred resource", "description": "Gets a particular transferred resource", "operationId": "getResource", "parameters": [ { "name": "uuid", "in": "path", "description": "The transferred resource uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferredResource" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/{uuid}/download": { "get": { "tags": [ "v2 transfers" ], "summary": "Downloads transferred resource", "description": "Download a particular transferred resource", "operationId": "downloadTransferredResource", "parameters": [ { "name": "uuid", "in": "path", "description": "The resource id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/reindex": { "get": { "tags": [ "v2 transfers" ], "summary": "Reindex transferred resource", "description": "Reindex a particular transferred resource", "operationId": "reindexResources", "parameters": [ { "name": "path", "in": "query", "description": "The path of the resource", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferredResource" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "409": { "description": "Still updating", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/transfers/find/{uuid}": { "get": { "tags": [ "v2 transfers" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/themes": { "get": { "tags": [ "v2 themes" ], "operationId": "getResource_1", "parameters": [ { "name": "resource-id", "in": "query", "description": "The resource id", "required": true, "schema": { "type": "string" } }, { "name": "default-resource-id", "in": "query", "description": "The default resource id", "required": false, "schema": { "type": "string" } }, { "name": "inline", "in": "query", "description": "If the resource is served inline", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "resource-type", "in": "query", "description": "The resource type, can be internal or plugin", "required": false, "schema": { "type": "string", "enum": [ "internal", "plugins" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } } } } }, "/api/v2/risks/{id}/versions": { "get": { "tags": [ "v2 risks" ], "summary": "Retrieves risk history", "description": "Retrieves previous risk versions", "operationId": "retrieveRiskVersions", "parameters": [ { "name": "id", "in": "path", "description": "The identifier of the risk to fetch the versioning.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of version of selected risk", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskVersions" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/risks/{id}/versions/{version-id}": { "get": { "tags": [ "v2 risks" ], "summary": "Retrieves a version of risk", "description": "Retrieves a specific risk version", "operationId": "retrieveRiskVersion", "parameters": [ { "name": "id", "in": "path", "description": "The identifier of the risk to fetch the version.", "required": true, "schema": { "type": "string" } }, { "name": "version-id", "in": "path", "description": "The identifier of the version to fetch the risk.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Historical risk", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Risk" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/risks/{id}/mitigation/terms": { "get": { "tags": [ "v2 risks" ], "summary": "Retrieves mitigation terms for the identified risk", "description": "Retrieves the pre-mitigation and pos-mitigation probabilities and impact terms", "operationId": "retrieveRiskMitigationTerms", "parameters": [ { "name": "id", "in": "path", "description": "The identifier of the risk to fetch the mitigation terms", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Mitigation terms", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskMitigationTerms" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/risks/find/{uuid}": { "get": { "tags": [ "v2 risks" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_1", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/risks/configuration/mitigation": { "get": { "tags": [ "v2 risks" ], "summary": "Retrieves risk mitigation configurations", "description": "Retrieves from the configuration the properties about mitigation probabilities and impact terms", "operationId": "retrieveRiskMitigationProperties", "responses": { "200": { "description": "Risk mitigation properties", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskMitigationProperties" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/{aip_id}/{representation_id}": { "get": { "tags": [ "v2 representations" ], "summary": "Get representation", "description": "Gets a representation", "operationId": "getRepresentation", "parameters": [ { "name": "aip_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "representation_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Representation" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/find/{uuid}": { "get": { "tags": [ "v2 representations" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_2", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/configuration/types": { "get": { "tags": [ "v2 representations" ], "summary": "Retrieves the types associated to representations", "description": "Returns a list of controlled vocabulary from RODA configuration or list of representation types available", "operationId": "getRepresentationTypeOptions", "parameters": [ { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationTypeOptions" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representations/configuration/rules": { "get": { "tags": [ "v2 representations" ], "summary": "Retrieves from the configuration the rules for the Representation information", "operationId": "retrieveRepresentationRuleProperties", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representation-information/{id}/family": { "get": { "tags": [ "v2 representation information" ], "summary": "Retrieves representation information family values", "description": "Retrieves metadata values about the representation information type of family that can be customizable", "operationId": "retrieveRepresentationInformationFamily", "parameters": [ { "name": "id", "in": "path", "description": "The representation information identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationInformationFamily" } } } }, "401": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Representation information not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representation-information/{id}/download": { "get": { "tags": [ "v2 representation information" ], "summary": "Downloads the representation information", "description": "Downloads the representation information from the storage", "operationId": "downloadRepresentationInformation", "parameters": [ { "name": "id", "in": "path", "description": "The representation information identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/StreamResponse" } } } }, "404": { "description": "Representation information not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representation-information/find/{uuid}": { "get": { "tags": [ "v2 representation information" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_3", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representation-information/configuration/relations": { "get": { "tags": [ "v2 representation information" ], "summary": "Retrieves from the configuration the internationalization of configurable relation types", "description": "Retrieves all information about the configured relation types properly internationalized", "operationId": "retrieveRepresentationInformationRelationOptions", "parameters": [ { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationInformationRelationOptions" } } } }, "401": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representation-information/configuration/families/{family-type}": { "get": { "tags": [ "v2 representation information" ], "summary": "Retrieves from the configuration the family metadata values", "description": "Retrieves the metadata values from the configuration files according to the family type", "operationId": "retrieveRepresentationInformationFamilyConfigurations", "parameters": [ { "name": "family-type", "in": "path", "description": "The type of family", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationInformationFamily" } } } }, "401": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Family type not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/representation-information/configuration/families/options": { "get": { "tags": [ "v2 representation information" ], "summary": "Retrieves from the configuration the options for the representation information family", "description": "Retrieve the representation information family possible values and internationalize the results", "operationId": "retrieveRepresentationInformationFamilyOptions", "parameters": [ { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentationInformationFamilyOptions" } } } }, "401": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/events/{id}/objects": { "get": { "tags": [ "v2 preservation events" ], "summary": "Gets linking objects associated to the preservation event", "description": "Gets linking objects associated to the preservation event", "operationId": "getLinkingIdentifierObjects", "parameters": [ { "name": "id", "in": "path", "description": "The preservation event id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Preservation events linking objects", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreservationEventsLinkingObjects" } } } }, "404": { "description": "Preservation event not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/events/{id}/download": { "get": { "tags": [ "v2 preservation events" ], "summary": "Downloads preservation event file", "operationId": "downloadPreservationEvent", "parameters": [ { "name": "id", "in": "path", "description": "The id of the preservation event", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/events/{id}/details/html": { "get": { "tags": [ "v2 preservation events" ], "summary": "Gets preservation event details in HTML format", "operationId": "getPreservationEventsDetails", "parameters": [ { "name": "id", "in": "path", "description": "The id of the preservation event", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/events/{id}/agents": { "get": { "tags": [ "v2 preservation events" ], "summary": "List preservation agents associated to the preservation event", "description": "Gets a list of preservation agents", "operationId": "getPreservationAgents", "parameters": [ { "name": "id", "in": "path", "description": "The preservation event id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of preservation agents", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexedPreservationAgent" } } } }, "404": { "description": "Preservation event not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/events/find/{uuid}": { "get": { "tags": [ "v2 preservation events" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_4", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/agents/{id}/download": { "get": { "tags": [ "v2 preservation agents" ], "summary": "Downloads preservation agent file", "operationId": "downloadPreservationAgent", "parameters": [ { "name": "id", "in": "path", "description": "The id of the preservation agent", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/preservation/agents/find/{uuid}": { "get": { "tags": [ "v2 preservation agents" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_5", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/notifications/{id}": { "get": { "tags": [ "v2 notifications" ], "summary": "Get notification", "description": "Gets a notification", "operationId": "getNotification", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/notifications/find/{uuid}": { "get": { "tags": [ "v2 notifications" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_6", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/metrics": { "get": { "tags": [ "v2 metrics" ], "summary": "Get RODA metrics", "description": "Gets a list of RODA metrics", "operationId": "getMetrics", "parameters": [ { "name": "metricsToObtain", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metrics" } } } } } } }, "/api/v2/members/users/{id}": { "get": { "tags": [ "v2 members" ], "summary": "Get user", "description": "Gets a particular user", "operationId": "getUser", "parameters": [ { "name": "id", "in": "path", "description": "The user identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "delete": { "tags": [ "v2 members" ], "summary": "Delete user", "description": "Deletes an existing user", "operationId": "deleteUser", "parameters": [ { "name": "id", "in": "path", "description": "The user identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/users/authenticated": { "get": { "tags": [ "v2 members" ], "summary": "Get authenticated user", "description": "Gets the authenticated user", "operationId": "getAuthenticatedUser", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } } }, "/api/v2/members/users/access-keys/{id}": { "get": { "tags": [ "v2 members" ], "summary": "Get access key", "description": "Gets an access key by its id", "operationId": "getAccessKey", "parameters": [ { "name": "id", "in": "path", "description": "The access key id ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessKey" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "delete": { "tags": [ "v2 members" ], "summary": "Delete access key", "description": "Deletes an access key", "operationId": "deleteAccessKey", "parameters": [ { "name": "id", "in": "path", "description": "The access key id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/groups/{id}": { "get": { "tags": [ "v2 members" ], "summary": "Get group", "description": "Gets a particular group", "operationId": "getGroup", "parameters": [ { "name": "id", "in": "path", "description": "The group identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "delete": { "tags": [ "v2 members" ], "summary": "Delete group", "description": "Deletes an existing group", "operationId": "deleteGroup", "parameters": [ { "name": "id", "in": "path", "description": "The group identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/find/{uuid}": { "get": { "tags": [ "v2 members" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_7", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/members/configuration/custom-form": { "get": { "tags": [ "v2 members" ], "summary": "Get default user extra", "description": "Gets the default extra form fields to create an user", "operationId": "getDefaultUserExtra", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "409": { "description": "Already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/{id}/stop": { "get": { "tags": [ "v2 jobs" ], "summary": "Stop job", "description": "Stops a job", "operationId": "stopJob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/{id}/reports": { "get": { "tags": [ "v2 jobs" ], "summary": "List job reports", "description": "Gets a list of job reports", "operationId": "listJobReports", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "job-just-failed", "in": "query", "description": "If just the failed reports should be included in the response or all the job reports", "required": false, "schema": { "type": "string", "default": "false" } }, { "name": "start", "in": "query", "description": "Index of the first element to return", "required": false, "schema": { "type": "string", "default": "0" } }, { "name": "limit", "in": "query", "description": "Maximum number of elements to return", "required": false, "schema": { "type": "string", "default": "100" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reports" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/{id}/report/{report-id}": { "get": { "tags": [ "v2 jobs" ], "summary": "Get job reports items", "description": "Gets job report items", "operationId": "getJobReport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "report-id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/{id}/attachment/{attachment-id}": { "get": { "tags": [ "v2 jobs" ], "summary": "Gets the Job attachment", "description": "Gets the attachments of a job", "operationId": "retrieveJobAttachment", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the existing job", "required": true, "schema": { "type": "string" } }, { "name": "attachment-id", "in": "path", "description": "The ID of the existing attachment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/zip": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/jobs/find/{uuid}": { "get": { "tags": [ "v2 jobs" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_8", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/job-reports/find/{uuid}": { "get": { "tags": [ "v2 job reports" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_9", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/incidences/find/{uuid}": { "get": { "tags": [ "v2 incidences" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_10", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/{uuid}/preview": { "get": { "tags": [ "v2 files" ], "summary": "Previews a file", "description": "Previews a particular file using streaming capabilities", "operationId": "previewBinary", "parameters": [ { "name": "uuid", "in": "path", "description": "The UUID of the existing file", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/{uuid}/download": { "get": { "tags": [ "v2 files" ], "summary": "Downloads file", "description": "Download a particular file", "operationId": "downloadBinary", "parameters": [ { "name": "uuid", "in": "path", "description": "The UUID of the existing file", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/find/{uuid}": { "get": { "tags": [ "v2 files" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_11", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/files/configuration/rules": { "get": { "tags": [ "v2 files" ], "summary": "Retrieves from the configuration the rules for the Representation information", "operationId": "retrieveFileRuleProperties", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/distributed-instances/{id}": { "get": { "tags": [ "v2 distributed instances" ], "summary": "Get distributed instance", "description": "Gets a particular distributed instance", "operationId": "getDistributedInstance", "parameters": [ { "name": "id", "in": "path", "description": "The distributed instance id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributedInstance" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "delete": { "tags": [ "v2 distributed instances" ], "summary": "Delete distributed instance", "description": "Deletes a distributed instance", "operationId": "deleteDistributedInstance", "parameters": [ { "name": "id", "in": "path", "description": "The distributed instance id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/distributed-instances/status/{id}": { "get": { "tags": [ "v2 distributed instances" ], "summary": "Get instance status", "description": "Gets instance status", "operationId": "status", "parameters": [ { "name": "id", "in": "path", "description": "The instance id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributedInstance" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/distributed-instances/remote_actions/{id}": { "get": { "tags": [ "v2 distributed instances" ], "summary": "Get instance status", "description": "Gets instance status", "operationId": "remoteActions", "parameters": [ { "name": "id", "in": "path", "description": "The instance id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/schedules/{id}": { "get": { "tags": [ "v2 disposal schedules" ], "summary": "Gets disposal schedule", "description": "Gets disposal schedule information", "operationId": "retrieveDisposalSchedule", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the disposal schedule to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalSchedule" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "delete": { "tags": [ "v2 disposal schedules" ], "summary": "Delete disposal rule", "description": "Delete disposal schedule", "operationId": "deleteDisposalSchedule", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the disposal schedule to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Resource deleted" }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/rules/{id}": { "get": { "tags": [ "v2 disposal rules" ], "summary": "Get disposal rule", "description": "Get disposal rule information", "operationId": "retrieveDisposalRule", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the disposal rule to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalRule" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } }, "delete": { "tags": [ "v2 disposal rules" ], "summary": "Delete disposal rule", "description": "Delete disposal rule", "operationId": "deleteDisposalRule", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the disposal rule to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Resource deleted" }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/holds/{id}": { "get": { "tags": [ "v2 disposal holds" ], "summary": "Get disposal hold", "description": "Get disposal hold information", "operationId": "retrieveDisposalHold", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the disposal hold to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a disposal hold", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalHold" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/holds/transitive/{aip-id}": { "get": { "tags": [ "v2 disposal holds" ], "summary": "List transitive holds", "operationId": "listTransitiveHolds", "parameters": [ { "name": "aip-id", "in": "path", "description": "AIP identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of transitive disposal holds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalTransitiveHoldsAIPMetadata" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/holds/associations/{aip-id}": { "get": { "tags": [ "v2 disposal holds" ], "summary": "List holds associations", "operationId": "listDisposalHoldsAssociation", "parameters": [ { "name": "aip-id", "in": "path", "description": "AIP identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of disposal holds associated to an AIP", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalHoldsAIPMetadata" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/{id}/report/html": { "get": { "tags": [ "v2 disposal confirmations" ], "summary": "Retrieves the disposal confirmation report", "operationId": "retrieveDisposalConfirmationReport", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the disposal confirmation", "required": true, "schema": { "type": "string" } }, { "name": "to-print", "in": "query", "description": "Use a print-friendly layout", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Returns the disposal confirmation report", "content": { "text/html": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/html": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "text/html": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "text/html": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/find/{uuid}": { "get": { "tags": [ "v2 disposal confirmations" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_12", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/disposal/confirmations/configurations/form": { "get": { "tags": [ "v2 disposal confirmations" ], "summary": "Retrieves from the configuration the custom disposal confirmation form", "description": "Retrieves the metadata values from the configuration files according to configured form", "operationId": "retrieveDisposalConfirmationForm", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisposalConfirmationForm" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/dips/{uuid}/download": { "get": { "tags": [ "v2 dips" ], "summary": "Downloads file", "description": "Downloads a DIP", "operationId": "downloadBinary_1", "parameters": [ { "name": "uuid", "in": "path", "description": "The UUID of the existing DIP", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/dips/find/{uuid}": { "get": { "tags": [ "v2 dips" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_13", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/dip-files/find/{uuid}": { "get": { "tags": [ "v2 dip files" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_14", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/configurations/viewers": { "get": { "tags": [ "v2 configurations" ], "summary": "Retrieves configuration properties for viewers", "operationId": "retrieveViewersProperties", "responses": { "200": { "description": "Returns viewers properties", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Viewers" } } } } } } }, "/api/v2/configurations/shared-properties": { "get": { "tags": [ "v2 configurations" ], "summary": "Retrieve shared properties from configuration files", "operationId": "retrieveSharedProperties", "parameters": [ { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns shared properties (key-value pairs)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedProperties" } } } } } } }, "/api/v2/configurations/plugins": { "get": { "tags": [ "v2 configurations" ], "summary": "Retrieves a list of plugins that matches a certain type", "operationId": "retrievePluginsInfo", "parameters": [ { "name": "type", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "INGEST", "INTERNAL", "SIP_TO_AIP", "AIP_TO_SIP", "AIP_TO_AIP", "MISC", "MULTI" ] } } } ], "responses": { "200": { "description": "Returns a set of plugin information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginInfoList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Access forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/configurations/plugins/{id}/conversion/profiles": { "get": { "tags": [ "v2 configurations" ], "summary": "Retrieves a list of conversion profiles from the configurations according to the plugin identifier", "operationId": "retrieveConversionProfiles", "parameters": [ { "name": "id", "in": "path", "description": "The plugin identifier", "required": true, "schema": { "type": "string" } }, { "name": "outcome", "in": "query", "description": "The type of outcome", "required": true, "content": { "*/*": { "schema": { "type": "string", "enum": [ "REPRESENTATION", "DISSEMINATION" ] } } } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns a set of conversion profiles for a specific plugin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DropdownPluginParameterItems" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Access forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/configurations/plugins/reindex": { "get": { "tags": [ "v2 configurations" ], "summary": "Retrieves a list of resources that are used by reindex plugins", "operationId": "retrieveReindexPluginObjectClasses", "responses": { "200": { "description": "Returns a set of objects classes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReindexPluginObjects" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Access forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/configurations/plugins/dropdown/{parameter-id}": { "get": { "tags": [ "v2 configurations" ], "summary": "Retrieves a list of items from the configurations according to the parameter identifier", "operationId": "retrieveDropdownPluginItems", "parameters": [ { "name": "parameter-id", "in": "path", "description": "The plugin parameter identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns a set of dropdown items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DropdownPluginParameterItems" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Access forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/configurations/object-fields": { "get": { "tags": [ "v2 configurations" ], "summary": "Retrieve configuration properties for draw the object class fields", "operationId": "retrieveObjectClassFields", "parameters": [ { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns a set of object class fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectClassFields" } } } } } } }, "/api/v2/configurations/exports/limit": { "get": { "tags": [ "v2 configurations" ], "summary": "Retrieves the export limit value", "operationId": "retrieveExportLimit", "responses": { "200": { "description": "Returns the export limit value", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LongResponse" } } } } } } }, "/api/v2/configurations/embedded-dip": { "get": { "tags": [ "v2 configurations" ], "summary": "Retrieves the configuration value associated to the property of show DIP embedded in system or externally", "operationId": "retrieveShowEmbeddedDIP", "responses": { "200": { "description": "Returns true or false", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/api/v2/classification-plans": { "get": { "tags": [ "v2 classification plans" ], "summary": "Retrieves the classification plan from Catalogue", "operationId": "getClassificationPlan", "parameters": [ { "name": "filename", "in": "query", "description": "Choose file name", "required": false, "schema": { "type": "string", "default": "plan.json" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } } } } }, "/api/v2/audit-logs/find/{uuid}": { "get": { "tags": [ "v2 audit logs" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_15", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/submission": { "get": { "tags": [ "v2 aips" ], "summary": "Get AIP submission", "description": "Queries if there are submissions associated with the AIP", "operationId": "getSubmissions", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns true if submission is present", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/representations/{representation-id}/metadata/descriptive": { "get": { "tags": [ "v2 aips" ], "summary": "Retrieves descriptive metadata information for a specific representation", "operationId": "retrieveRepresentationDescriptiveMetadata", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "description": "The representation identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns an object with all the representation descriptive metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadataInfos" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Representation not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/representations/{representation-id}/metadata/descriptive/{descriptive-metadata-id}/html": { "get": { "tags": [ "v2 aips" ], "summary": "Retrieves descriptive metadata result", "operationId": "retrieveRepresentationDescriptiveMetadataHTML", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "description": "The representation identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns an object ", "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/representation/{representation-id}/metadata/descriptive/{descriptive-metadata-id}/versions": { "get": { "tags": [ "v2 aips" ], "summary": "Get descriptive metadata versions from", "description": "Get descriptive metadata versions", "operationId": "retrieveRepresentationDescriptiveMetadataVersions", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "description": "The representation identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns an object with all the descriptive metadata versions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadataVersions" } } } }, "401": { "description": "Unauthorized access", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/representation/{representation-id}/metadata/descriptive/{descriptive-metadata-id}/values": { "get": { "tags": [ "v2 aips" ], "summary": "Get Supported metadata value", "description": "Get AIP metadata value", "operationId": "retrieveRepresentationSupportedMetadata", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "description": "The representation identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Supported Metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedMetadataValue" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/representation/{representation-id}/download": { "get": { "tags": [ "v2 aips" ], "summary": "Downloads representation", "description": "Download a particular representation", "operationId": "getRepresentationBinary", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the existing aip", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "description": "The ID of the existing representation", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive/{descriptive-metadata-id}/versions": { "get": { "tags": [ "v2 aips" ], "summary": "Get descriptive metadata versions", "description": "Get descriptive metadata versions", "operationId": "retrieveAIPDescriptiveMetadataVersions", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns an object with all the descriptive metadata versions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadataVersions" } } } }, "401": { "description": "Unauthorized access", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive/{descriptive-metadata-id}/values": { "get": { "tags": [ "v2 aips" ], "summary": "Get Supported metadata value", "description": "Get AIP metadata value", "operationId": "retrieveAIPSupportedMetadata", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Supported Metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedMetadataValue" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive/{descriptive-metadata-id}/html": { "get": { "tags": [ "v2 aips" ], "summary": "Retrieves descriptive metadata", "description": "Retrieves the descriptive metadata with the visualization template applied and internationalized", "operationId": "retrieveAIPDescriptiveMetadataHTML", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "version-id", "in": "query", "description": "The version identifier", "required": false, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns an object ", "content": { "text/html": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "text/html": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "text/html": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "text/html": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive/{descriptive-metadata-id}/download": { "get": { "tags": [ "v2 aips" ], "summary": "Retrieves descriptive metadata", "description": "Retrieves the XML descriptive metadata", "operationId": "downloadAIPDescriptiveMetadata", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "version-id", "in": "query", "description": "The version identifier", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an object ", "content": { "application/xml": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized access", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive/information": { "get": { "tags": [ "v2 aips" ], "summary": "Get descriptive metadata", "description": "Get descriptive metadata related to the aip", "operationId": "getDescriptiveMetadata", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Information related to AIP descriptive metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptiveMetadataInfos" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/lock/request": { "get": { "tags": [ "v2 aips" ], "summary": "Get AIP lock", "description": "Get the aip lock", "operationId": "requestAIPLock", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Aip lock availability", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/lock/release": { "get": { "tags": [ "v2 aips" ], "summary": "Get AIP lock", "description": "Get the aip lock", "operationId": "releaseAIPLock", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lock released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericOkResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/download": { "get": { "tags": [ "v2 aips" ], "summary": "Download AIP", "description": "Download intellectual entity", "operationId": "downloadAIP", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/download/submission": { "get": { "tags": [ "v2 aips" ], "summary": "Downloads submission", "description": "Downloads AIP submission", "operationId": "downloadAipSubmission", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/download/schemas": { "get": { "tags": [ "v2 aips" ], "summary": "Downloads schemas", "description": "Download AIP schemas", "operationId": "downloadAipSchema", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/download/preservation": { "get": { "tags": [ "v2 aips" ], "summary": "Downloads preservation metadata", "description": "Download AIP preservation metadata", "operationId": "downloadAipPreservationMetadata", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/download/documentation": { "get": { "tags": [ "v2 aips" ], "summary": "Downloads documentation", "description": "Download AIP documentation", "operationId": "downloadAipDocuments", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/documentation": { "get": { "tags": [ "v2 aips" ], "summary": "Get AIP documentation", "description": "Queries if there are documentation associated with the AIP", "operationId": "getDocumentation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns true if documentation is present", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/ancestors": { "get": { "tags": [ "v2 aips" ], "summary": "Retrieves AIP ancestors", "description": "Returns a list of AIPs", "operationId": "getAncestors", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AIPs", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{aip_id}/{representation_id}/other-metadata/binary": { "get": { "tags": [ "v2 aips" ], "summary": "Downloads representation", "description": "Download a particular representation", "operationId": "getRepresentationOtherMetadataBinary", "parameters": [ { "name": "aip_id", "in": "path", "description": "The ID of the existing aip", "required": true, "schema": { "type": "string" } }, { "name": "representation_id", "in": "path", "description": "The ID of the existing representation", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/find/{uuid}": { "get": { "tags": [ "v2 aips" ], "summary": "Find indexed resource using the object UUID", "description": "Finds existing indexed resources", "operationId": "findByUuid_16", "parameters": [ { "name": "uuid", "in": "path", "description": "The object UUID", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "language", "required": false, "content": { "*/*": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Returns the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexResult" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/configuration/types": { "get": { "tags": [ "v2 aips" ], "summary": "Retrieves the types associated to AIP", "description": "Returns a list of controlled vocabulary from RODA configuration or list of AIP types available", "operationId": "getTypeOptions", "parameters": [ { "name": "lang", "in": "query", "description": "The language to be used for internationalization", "required": false, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TypeOptionsInfo" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/configuration/rules": { "get": { "tags": [ "v2 aips" ], "summary": "Retrieves from the configuration the rules for the Representation information", "operationId": "retrieveAIPRuleProperties", "responses": { "200": { "description": "List of rules", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/configuration/descriptive/metadata": { "get": { "tags": [ "v2 aips" ], "summary": "Gets the descriptive metadata configured", "description": "Get AIP supported metadata", "operationId": "retrieveSupportedMetadataTypes", "parameters": [ { "name": "lang", "in": "query", "required": false, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Supported Metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredDescriptiveMetadataList" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/risks/{id}/versions/{version-id}/delete": { "delete": { "tags": [ "v2 risks" ], "summary": "Deletes an older version of the risk", "description": "Deletes an older version of the risk", "operationId": "deleteRiskVersion", "parameters": [ { "name": "id", "in": "path", "description": "The identifier of the risk to revert the version.", "required": true, "schema": { "type": "string" } }, { "name": "version-id", "in": "path", "description": "The identifier of the version to revert the risk.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Historical version of risk deleted" }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/distributed-instances/local/instance-configuration": { "delete": { "tags": [ "v2 distributed instances" ], "summary": "Delete local instance configuration", "description": "Deletes local instance configuration", "operationId": "deleteLocalInstanceConfiguration", "responses": { "204": { "description": "No content" }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/distributed-instances/local/configuration": { "delete": { "tags": [ "v2 distributed instances" ], "summary": "Delete local configuration", "description": "Deletes local configuration", "operationId": "deleteLocalConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalInstance" } } }, "required": true }, "responses": { "204": { "description": "No content" }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/representation/{representation-id}/metadata/descriptive/{descriptive-metadata-id}": { "delete": { "tags": [ "v2 aips" ], "summary": "Delete metadata file", "description": "Delete metadata file related to representation", "operationId": "deleteRepresentationDescriptiveMetadataFile", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "description": "The representation identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/representation/{representation-id}/metadata/descriptive/{descriptive-metadata-id}/versions/{version-id}/delete": { "delete": { "tags": [ "v2 aips" ], "summary": "Delete an AIP descriptive metadata version", "description": "Deletes a descriptive metadata version related to a representation", "operationId": "deleteRepresentationDescriptiveMetadataVersion", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "representation-id", "in": "path", "description": "The representation identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "version-id", "in": "path", "description": "The version identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized access", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive/{descriptive-metadata-id}": { "delete": { "tags": [ "v2 aips" ], "summary": "Delete metadata file", "description": "Delete metadata file related to AIP", "operationId": "deleteDescriptiveMetadataFile", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } }, "/api/v2/aips/{id}/metadata/descriptive/{descriptive-metadata-id}/versions/{version-id}/delete": { "delete": { "tags": [ "v2 aips" ], "summary": "Delete an AIP descriptive metadata version", "description": "Deletes a descriptive metadata version related to an AIP", "operationId": "deleteDescriptiveMetadataVersion", "parameters": [ { "name": "id", "in": "path", "description": "The AIP identifier", "required": true, "schema": { "type": "string" } }, { "name": "descriptive-metadata-id", "in": "path", "description": "The descriptive metadata identifier", "required": true, "schema": { "type": "string" } }, { "name": "version-id", "in": "path", "description": "The version identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized access", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponseMessage" } } } } } } } }, "components": { "schemas": { "Risk": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "identifiedOn": { "type": "string", "format": "date-time" }, "identifiedBy": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "string" }, "preMitigationProbability": { "type": "integer", "format": "int32" }, "preMitigationImpact": { "type": "integer", "format": "int32" }, "preMitigationSeverity": { "type": "integer", "format": "int32" }, "preMitigationSeverityLevel": { "type": "string", "enum": [ "LOW", "MODERATE", "HIGH" ] }, "preMitigationNotes": { "type": "string" }, "postMitigationProbability": { "type": "integer", "format": "int32" }, "postMitigationImpact": { "type": "integer", "format": "int32" }, "postMitigationSeverity": { "type": "integer", "format": "int32" }, "postMitigationSeverityLevel": { "type": "string", "enum": [ "LOW", "MODERATE", "HIGH" ] }, "postMitigationNotes": { "type": "string" }, "mitigationStrategy": { "type": "string" }, "mitigationOwnerType": { "type": "string" }, "mitigationOwner": { "type": "string" }, "mitigationRelatedEventIdentifierType": { "type": "string" }, "mitigationRelatedEventIdentifierValue": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "instanceId": { "type": "string" } }, "xml": { "name": "risk" } }, "ErrorResponseMessage": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32" }, "errorId": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "instance": { "type": "string" }, "objectDetails": { "type": "object" } } }, "AllFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" } ] }, "AndFiltersParameters": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" } ] }, "BasicSearchFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "value": { "type": "string" } } } ] }, "BlockJoinParentFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "blockMask": { "$ref": "#/components/schemas/FilterParameter" }, "someChildren": { "$ref": "#/components/schemas/FilterParameter" } } } ] }, "ChangeTypeRequest": { "type": "object", "properties": { "items": { "$ref": "#/components/schemas/SelectedItemsRequest" }, "type": { "type": "string" }, "details": { "type": "string" } } }, "DateIntervalFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "fromValue": { "type": "string", "format": "date-time" }, "toValue": { "type": "string", "format": "date-time" }, "toName": { "type": "string" }, "granularity": { "type": "string", "enum": [ "YEAR", "MONTH", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ] }, "timeZoneOffset": { "type": "integer", "format": "int32" }, "fromName": { "type": "string" } } } ] }, "DateRangeFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "fromValue": { "type": "string", "format": "date-time" }, "toValue": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "YEAR", "MONTH", "DAY", "HOUR", "MINUTE", "SECOND", "MILLISECOND" ] } } } ] }, "Filter": { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/FilterParameter" } } } }, "FilterParameter": { "required": [ "@type" ], "type": "object", "properties": { "name": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type", "mapping": { "BasicSearchFilterParameter": "#/components/schemas/BasicSearchFilterParameter", "LikeFilterParameter": "#/components/schemas/LikeFilterParameter", "NotSimpleFilterParameter": "#/components/schemas/NotSimpleFilterParameter", "OneOfManyFilterParameter": "#/components/schemas/OneOfManyFilterParameter", "DateIntervalFilterParameter": "#/components/schemas/DateIntervalFilterParameter", "DateRangeFilterParameter": "#/components/schemas/DateRangeFilterParameter", "LongRangeFilterParameter": "#/components/schemas/LongRangeFilterParameter", "StringRangeFilterParameter": "#/components/schemas/StringRangeFilterParameter", "SimpleFilterParameter": "#/components/schemas/SimpleFilterParameter", "OrFiltersParameters": "#/components/schemas/OrFiltersParameters", "AndFiltersParameters": "#/components/schemas/AndFiltersParameters", "AllFilterParameter": "#/components/schemas/AllFilterParameter", "BlockJoinParentFilterParameter": "#/components/schemas/BlockJoinParentFilterParameter" } } }, "LikeFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "expression": { "type": "string" } } } ] }, "LongRangeFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "fromValue": { "type": "integer", "format": "int64" }, "toValue": { "type": "integer", "format": "int64" } } } ] }, "NotSimpleFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "value": { "type": "string" } } } ] }, "OneOfManyFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } } ] }, "OrFiltersParameters": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" } ] }, "SelectedItemsFilterRequest": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SelectedItemsRequest" }, { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/Filter" }, "justActive": { "type": "boolean" } } } ] }, "SelectedItemsListRequest": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SelectedItemsRequest" }, { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } } } ] }, "SelectedItemsRequest": { "required": [ "@type" ], "type": "object", "properties": { "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type", "mapping": { "SelectedItemsListRequest": "#/components/schemas/SelectedItemsListRequest", "SelectedItemsFilterRequest": "#/components/schemas/SelectedItemsFilterRequest" } } }, "SimpleFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "value": { "type": "string" } } } ] }, "StringRangeFilterParameter": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilterParameter" }, { "type": "object", "properties": { "fromValue": { "type": "string" }, "toValue": { "type": "string" } } } ] }, "Job": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "state": { "type": "string", "enum": [ "CREATED", "STARTED", "COMPLETED", "FAILED_DURING_CREATION", "FAILED_TO_COMPLETE", "STOPPED", "STOPPING", "TO_BE_CLEANED", "PENDING_APPROVAL", "REJECTED", "SCHEDULED" ] }, "stateDetails": { "type": "string" }, "instanceId": { "type": "string" }, "jobUsersDetails": { "type": "array", "items": { "$ref": "#/components/schemas/JobUserDetails" } }, "instanceName": { "type": "string" }, "jobStats": { "$ref": "#/components/schemas/JobStats" }, "plugin": { "type": "string" }, "pluginType": { "type": "string", "enum": [ "INGEST", "INTERNAL", "SIP_TO_AIP", "AIP_TO_SIP", "AIP_TO_AIP", "MISC", "MULTI" ] }, "pluginParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "sourceObjects": { "$ref": "#/components/schemas/SelectedItemsObject" }, "outcomeObjectsClass": { "type": "string" }, "attachmentsList": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "priority": { "type": "string", "enum": [ "URGENT", "HIGH", "MEDIUM", "LOW" ] }, "parallelism": { "type": "string", "enum": [ "LIMITED", "NORMAL" ] }, "stopping": { "type": "boolean" }, "inFinalState": { "type": "boolean" } }, "xml": { "name": "job" } }, "JobStats": { "type": "object", "properties": { "completionPercentage": { "type": "integer", "format": "int32" }, "sourceObjectsCount": { "type": "integer", "format": "int32" }, "sourceObjectsBeingProcessed": { "type": "integer", "format": "int32" }, "sourceObjectsWaitingToBeProcessed": { "type": "integer", "format": "int32" }, "sourceObjectsProcessedWithSuccess": { "type": "integer", "format": "int32" }, "sourceObjectsProcessedWithPartialSuccess": { "type": "integer", "format": "int32" }, "sourceObjectsProcessedWithFailure": { "type": "integer", "format": "int32" }, "sourceObjectsProcessedWithSkipped": { "type": "integer", "format": "int32" }, "outcomeObjectsWithManualIntervention": { "type": "integer", "format": "int32" } } }, "JobUserDetails": { "type": "object", "properties": { "username": { "type": "string" }, "fullname": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" } } }, "SelectedItemsObject": { "required": [ "type" ], "type": "object", "properties": { "selectedClass": { "type": "string" }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "ChangeRepresentationStatesRequest": { "type": "object", "properties": { "items": { "$ref": "#/components/schemas/SelectedItemsRequest" }, "newStates": { "type": "array", "items": { "type": "string" } }, "details": { "type": "string" } } }, "MetadataValue": { "type": "object", "properties": { "id": { "type": "string" }, "options": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RepresentationInformation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "family": { "type": "string" }, "familyI18n": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "extras": { "type": "string" }, "support": { "type": "string", "enum": [ "KNOWN", "SUPPORTED", "UNSUPPORTED" ] }, "relations": { "type": "array", "xml": { "name": "relation" }, "items": { "$ref": "#/components/schemas/RepresentationInformationRelation" } }, "filters": { "type": "array", "items": { "type": "string" } }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "instanceId": { "type": "string" } }, "xml": { "name": "representation_information" } }, "RepresentationInformationCreateRequest": { "type": "object", "properties": { "representationInformation": { "$ref": "#/components/schemas/RepresentationInformation" }, "form": { "$ref": "#/components/schemas/RepresentationInformationCustomForm" } } }, "RepresentationInformationCustomForm": { "type": "object", "properties": { "values": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetadataValue" } } } }, "RepresentationInformationRelation": { "type": "object", "properties": { "relationType": { "type": "string" }, "objectType": { "type": "string", "enum": [ "AIP", "REPRESENTATION_INFORMATION", "WEB", "TEXT" ] }, "link": { "type": "string" }, "title": { "type": "string" }, "relationTypeI18n": { "type": "string" }, "objectTypeI18n": { "type": "string" } } }, "CreateUserRequest": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" }, "password": { "$ref": "#/components/schemas/SecureString" }, "values": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetadataValue" } } } }, "SecureString": { "type": "object", "properties": { "chars": { "type": "array", "items": { "type": "string" } }, "empty": { "type": "boolean" } } }, "User": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "active": { "type": "boolean" }, "allRoles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "directRoles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "groups": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "email": { "type": "string" }, "guest": { "type": "boolean" }, "ipAddress": { "type": "string" }, "resetPasswordToken": { "type": "string" }, "resetPasswordTokenExpirationDate": { "type": "string" }, "emailConfirmationToken": { "type": "string" }, "emailConfirmationTokenExpirationDate": { "type": "string" }, "extraLDAP": { "type": "string" }, "extra": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetadataValue" } }, "user": { "type": "boolean" }, "uuid": { "type": "string" } } }, "Group": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "active": { "type": "boolean" }, "allRoles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "directRoles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "type": { "type": "string" }, "users": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string" } }, "xml": { "name": "group" } }, "RiskIncidence": { "type": "object", "properties": { "id": { "type": "string" }, "aipId": { "type": "string" }, "representationId": { "type": "string" }, "filePath": { "type": "array", "items": { "type": "string" } }, "fileId": { "type": "string" }, "objectClass": { "type": "string" }, "riskId": { "type": "string" }, "description": { "type": "string" }, "byPlugin": { "type": "boolean" }, "status": { "type": "string", "enum": [ "UNMITIGATED", "MITIGATED", "ACCEPT_RISK", "FALSE_POSITIVE" ] }, "severity": { "type": "string", "enum": [ "LOW", "MODERATE", "HIGH" ] }, "detectedOn": { "type": "string", "format": "date-time" }, "detectedBy": { "type": "string" }, "mitigatedOn": { "type": "string", "format": "date-time" }, "mitigatedBy": { "type": "string" }, "mitigatedDescription": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "instanceId": { "type": "string" }, "instanceName": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" } }, "xml": { "name": "incidence" } }, "DistributedInstance": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "lastSynchronizationDate": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATED", "ACTIVE", "INACTIVE", "APPLYINGIDENTIFIER", "SYNCHRONIZING" ] }, "entitySummaryList": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySummary" } }, "description": { "type": "string" }, "accessKeyId": { "type": "string" }, "username": { "type": "string" }, "token": { "type": "string" } }, "xml": { "name": "distributed_instance" } }, "EntitySummary": { "type": "object", "properties": { "entityClass": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "countAddedUpdated": { "type": "integer", "format": "int32" }, "countRemoved": { "type": "integer", "format": "int32" }, "countIssues": { "type": "integer", "format": "int32" } } }, "LocalInstance": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "lastSynchronizationDate": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATED", "ACTIVE", "INACTIVE", "APPLYINGIDENTIFIER", "SYNCHRONIZING" ] }, "entitySummaryList": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySummary" } }, "accessKey": { "type": "string" }, "centralInstanceURL": { "type": "string" }, "isSubscribed": { "type": "boolean" } }, "xml": { "name": "local_instance" } }, "DisposalSchedule": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "mandate": { "type": "string" }, "scopeNotes": { "type": "string" }, "actionCode": { "type": "string", "enum": [ "RETAIN_PERMANENTLY", "REVIEW", "DESTROY" ] }, "retentionTriggerElementId": { "type": "string" }, "retentionPeriodIntervalCode": { "type": "string", "enum": [ "NO_RETENTION_PERIOD", "DAYS", "WEEKS", "MONTHS", "YEARS" ] }, "retentionPeriodDuration": { "type": "integer", "format": "int32" }, "firstTimeUsed": { "type": "string", "format": "date-time" }, "apiCounter": { "type": "integer", "format": "int64" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "state": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] } } }, "DisposalRule": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "IS_CHILD_OF", "METADATA_FIELD" ] }, "conditionKey": { "type": "string" }, "conditionValue": { "type": "string" }, "disposalScheduleId": { "type": "string" }, "disposalScheduleName": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" } }, "xml": { "name": "disposal_rule" } }, "DisposalHold": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "mandate": { "type": "string" }, "scopeNotes": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "originatedOn": { "type": "string", "format": "date-time" }, "originatedBy": { "type": "string" }, "liftedOn": { "type": "string", "format": "date-time" }, "liftedBy": { "type": "string" }, "firstTimeUsed": { "type": "string", "format": "date-time" }, "aipCounter": { "type": "integer", "format": "int64" }, "state": { "type": "string", "enum": [ "ACTIVE", "LIFTED" ] } }, "xml": { "name": "disposal_hold" } }, "DescriptiveMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "aipId": { "type": "string" }, "representationId": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } }, "xml": { "name": "descriptive_metadata" } }, "CreateDescriptiveMetadataRequest": { "required": [ "@type" ], "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "similar": { "type": "boolean" }, "permissions": { "$ref": "#/components/schemas/Permissions" }, "values": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetadataValue" } }, "xml": { "type": "string" }, "@type": { "type": "string" } }, "discriminator": { "propertyName": "@type", "mapping": { "DescriptiveMetadataRequestForm": "#/components/schemas/DescriptiveMetadataRequestForm", "DescriptiveMetadataRequestXML": "#/components/schemas/DescriptiveMetadataRequestXML" } } }, "DescriptiveMetadataRequestForm": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateDescriptiveMetadataRequest" } ] }, "DescriptiveMetadataRequestXML": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateDescriptiveMetadataRequest" } ] }, "Permissions": { "type": "object", "properties": { "users": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "groups": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } } }, "SuggestRequest": { "type": "object", "properties": { "field": { "type": "string" }, "query": { "type": "string" }, "allowPartial": { "type": "boolean" } } }, "FacetFieldResult": { "type": "object", "properties": { "field": { "type": "string" }, "totalCount": { "type": "integer", "format": "int64" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/FacetValue" } }, "selectedValues": { "type": "array", "items": { "type": "string" } } }, "xml": { "name": "facet_field_value" } }, "FacetValue": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "count": { "type": "integer", "format": "int64" } }, "xml": { "name": "facet_value" } }, "IndexResult": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int64" }, "limit": { "type": "integer", "format": "int64" }, "totalCount": { "type": "integer", "format": "int64" }, "results": { "type": "array", "xml": { "wrapped": true }, "items": { "type": "object" } }, "facetResults": { "type": "array", "items": { "$ref": "#/components/schemas/FacetFieldResult" } }, "date": { "type": "string", "format": "date-time" } }, "xml": { "name": "index_result" } }, "Collapse": { "type": "object", "properties": { "field": { "type": "string" }, "minMax": { "$ref": "#/components/schemas/MinMax" }, "sorter": { "$ref": "#/components/schemas/Sorter" }, "nullPolicy": { "type": "string", "enum": [ "ignore", "expand", "collapse" ] }, "hint": { "type": "string", "enum": [ "none", "top_fc", "block" ] }, "size": { "type": "integer", "format": "int64" }, "collectElevatedDocsWhenCollapsing": { "type": "boolean" } } }, "FacetParameter": { "required": [ "type" ], "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } }, "minCount": { "type": "integer", "format": "int32" }, "sort": { "type": "string", "enum": [ "INDEX", "COUNT" ] }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "Facets": { "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FacetParameter" } }, "query": { "type": "string" } } }, "FindRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/Filter" }, "onlyActive": { "type": "boolean" }, "sorter": { "$ref": "#/components/schemas/Sorter" }, "sublist": { "$ref": "#/components/schemas/Sublist" }, "facets": { "$ref": "#/components/schemas/Facets" }, "exportFacets": { "type": "boolean" }, "filename": { "type": "string" }, "fieldsToReturn": { "type": "array", "items": { "type": "string" } }, "collapse": { "$ref": "#/components/schemas/Collapse" }, "children": { "type": "boolean" } } }, "MinMax": { "type": "object", "properties": { "numericField": { "type": "string" }, "max": { "type": "boolean" } } }, "SortParameter": { "type": "object", "properties": { "name": { "type": "string" }, "descending": { "type": "boolean" } } }, "Sorter": { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/SortParameter" } } } }, "Sublist": { "type": "object", "properties": { "firstElementIndex": { "type": "integer", "format": "int32" }, "maximumElementCount": { "type": "integer", "format": "int32" } } }, "TransferredResource": { "type": "object", "properties": { "uuid": { "type": "string" }, "id": { "type": "string" }, "fullPath": { "type": "string" }, "relativePath": { "type": "string" }, "parentId": { "type": "string" }, "parentUUID": { "type": "string" }, "ancestorsPaths": { "type": "array", "items": { "type": "string" } }, "size": { "type": "integer", "format": "int64" }, "creationDate": { "type": "string", "format": "date-time" }, "lastScanDate": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "file": { "type": "boolean" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "parentPath": { "type": "string" } } }, "LongResponse": { "type": "object", "properties": { "result": { "type": "integer", "format": "int64" } } }, "CountRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/Filter" }, "onlyActive": { "type": "boolean" } } }, "Representation": { "type": "object", "properties": { "aipId": { "type": "string" }, "id": { "type": "string" }, "original": { "type": "boolean" }, "representationStates": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "instanceId": { "type": "string" }, "hasShallowFiles": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "descriptiveMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/DescriptiveMetadata" } } }, "xml": { "name": "representation" } }, "IndexedRepresentationRequest": { "type": "object", "properties": { "aipId": { "type": "string" }, "representationId": { "type": "string" } } }, "FileFormat": { "type": "object", "properties": { "formatDesignationName": { "type": "string" }, "formatDesignationVersion": { "type": "string" }, "formatDesignation": { "type": "string" }, "mimeType": { "type": "string" }, "pronom": { "type": "string" }, "extension": { "type": "string" }, "formatRegistries": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IndexedFile": { "type": "object", "properties": { "uuid": { "type": "string" }, "parentUUID": { "type": "string" }, "aipId": { "type": "string" }, "representationId": { "type": "string" }, "representationUUID": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "ancestorsPath": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "referenceUUID": { "type": "string" }, "referenceURL": { "type": "string" }, "referenceManifest": { "type": "string" }, "fileFormat": { "$ref": "#/components/schemas/FileFormat" }, "originalName": { "type": "string" }, "size": { "type": "integer", "format": "int64" }, "creatingApplicationName": { "type": "string" }, "creatingApplicationVersion": { "type": "string" }, "dateCreatedByApplication": { "type": "string" }, "hash": { "type": "array", "items": { "type": "string" } }, "storagePath": { "type": "string" }, "ancestors": { "type": "array", "items": { "type": "string" } }, "otherProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "instanceId": { "type": "string" }, "instanceName": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" }, "localInstance": { "type": "boolean" }, "reference": { "type": "boolean" }, "available": { "type": "boolean" }, "directory": { "type": "boolean" } }, "xml": { "name": "file" } }, "RepresentationInformationFilterRequest": { "type": "object", "properties": { "selectedItems": { "$ref": "#/components/schemas/SelectedItemsRepresentationInformation" }, "filterToAdd": { "type": "string" } } }, "SelectedItemsRepresentationInformation": { "required": [ "type" ], "type": "object", "properties": { "selectedClass": { "type": "string" }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "NotificationAcknowledgeRequest": { "type": "object", "properties": { "notificationUUID": { "type": "string" }, "token": { "type": "string" } } }, "GenericOkResponse": { "type": "object", "properties": { "timestamp": { "type": "string" }, "message": { "type": "string" } } }, "Notification": { "type": "object", "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "sentOn": { "type": "string", "format": "date-time" }, "fromUser": { "type": "string" }, "recipientUsers": { "type": "array", "items": { "type": "string" } }, "acknowledgeToken": { "type": "string" }, "acknowledgedUsers": { "type": "object", "additionalProperties": { "type": "string" } }, "state": { "type": "string", "enum": [ "CREATED", "COMPLETED", "FAILED" ] }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "instanceId": { "type": "string" }, "instanceName": { "type": "string" }, "acknowledged": { "type": "boolean" } }, "xml": { "name": "notification" } }, "CreateAccessKeyRequest": { "type": "object", "properties": { "name": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" } } }, "AccessKey": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "lastUsageDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "userName": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATED", "ACTIVE", "INACTIVE", "EXPIRED", "REVOKED" ] }, "claims": { "type": "object", "additionalProperties": { "type": "object" } }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" } }, "xml": { "name": "access_key" } }, "ChangeUserStatusRequest": { "type": "object", "properties": { "items": { "$ref": "#/components/schemas/SelectedItemsRequest" }, "activate": { "type": "boolean" } } }, "LoginRequest": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "$ref": "#/components/schemas/SecureString" } } }, "AccessToken": { "type": "object", "properties": { "token": { "type": "string" }, "expiresIn": { "type": "integer", "format": "int64" } }, "xml": { "name": "access_token" } }, "CreateGroupRequest": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "directRoles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "LicenseInfo": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } } }, "MarketInfo": { "type": "object", "properties": { "installation": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" }, "plugin": { "$ref": "#/components/schemas/plugin" }, "license": { "$ref": "#/components/schemas/LicenseInfo" }, "homepage": { "type": "string" }, "vendor": { "$ref": "#/components/schemas/vendor" }, "compatibility": { "type": "array", "items": { "type": "string" } } } }, "PluginInfo": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "INGEST", "INTERNAL", "SIP_TO_AIP", "AIP_TO_SIP", "AIP_TO_AIP", "MISC", "MULTI" ] }, "categories": { "type": "array", "items": { "type": "string" } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PluginParameter" } }, "objectClasses": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "hasLicenseFile": { "type": "boolean", "writeOnly": true }, "licenseFilePath": { "type": "string" }, "hasDocumentationFile": { "type": "boolean", "writeOnly": true }, "documentationFilePath": { "type": "string" }, "marketInfo": { "$ref": "#/components/schemas/MarketInfo" }, "verified": { "type": "boolean" }, "installed": { "type": "boolean" } } }, "PluginParameter": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "STRING", "BOOLEAN", "INTEGER", "PLUGIN_SIP_TO_AIP", "AIP_ID", "RISK_ID", "SEVERITY", "REPRESENTATION_TYPE", "RODA_OBJECT", "AIP_FIELDS", "REPRESENTATION_FIELDS", "FILE_FIELDS", "PERMISSION_TYPES", "DROPDOWN", "CONVERSION_PROFILE", "CONVERSION" ] }, "defaultValue": { "type": "string" }, "possibleValues": { "type": "array", "items": { "type": "string" } }, "mandatory": { "type": "boolean" }, "readonly": { "type": "boolean" }, "description": { "type": "string" }, "renderingHints": { "$ref": "#/components/schemas/RenderingHints" } } }, "RenderingHints": { "type": "object" }, "plugin": { "type": "object", "properties": { "objectClasses": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "categories": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "INGEST", "INTERNAL", "SIP_TO_AIP", "AIP_TO_SIP", "AIP_TO_AIP", "MISC", "MULTI" ] } } }, "vendor": { "type": "object", "properties": { "name": { "type": "string" }, "homepage": { "type": "string" } } }, "DeleteRequest": { "type": "object", "properties": { "itemsToDelete": { "$ref": "#/components/schemas/SelectedItemsRequest" }, "details": { "type": "string" } } }, "MoveFilesRequest": { "type": "object", "properties": { "aipId": { "type": "string" }, "representationId": { "type": "string" }, "fileUUIDtoMove": { "type": "string" }, "itemsToMove": { "$ref": "#/components/schemas/SelectedItemsIndexedFile" }, "details": { "type": "string" } } }, "SelectedItemsIndexedFile": { "required": [ "type" ], "type": "object", "properties": { "selectedClass": { "type": "string" }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "IndexedFileRequest": { "type": "object", "properties": { "aipId": { "type": "string" }, "representationId": { "type": "string" }, "directoryPaths": { "type": "array", "items": { "type": "string" } }, "fileId": { "type": "string" } } }, "CreateFolderRequest": { "type": "object", "properties": { "aipId": { "type": "string" }, "representationId": { "type": "string" }, "folderUUID": { "type": "string" }, "name": { "type": "string" }, "details": { "type": "string" } } }, "CreateDistributedInstanceRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } }, "CreateLocalInstanceRequest": { "type": "object", "properties": { "id": { "type": "string" }, "accessKey": { "type": "string" }, "centralInstanceURL": { "type": "string" }, "accessToken": { "type": "string", "writeOnly": true } } }, "DisposalConfirmationCreateRequest": { "type": "object", "properties": { "title": { "type": "string" }, "selectedItems": { "$ref": "#/components/schemas/SelectedItemsIndexedAIP" }, "form": { "$ref": "#/components/schemas/DisposalConfirmationForm" } } }, "DisposalConfirmationForm": { "type": "object", "properties": { "values": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetadataValue" } } } }, "SelectedItemsIndexedAIP": { "required": [ "type" ], "type": "object", "properties": { "selectedClass": { "type": "string" }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "UpdatePermissionsRequest": { "type": "object", "properties": { "itemsToUpdate": { "$ref": "#/components/schemas/SelectedItemsRequest" }, "details": { "type": "string" }, "permissions": { "$ref": "#/components/schemas/Permissions" }, "recursive": { "type": "boolean" } } }, "AIP": { "type": "object", "properties": { "id": { "type": "string" }, "parentId": { "type": "string" }, "type": { "type": "string" }, "state": { "type": "string", "enum": [ "CREATED", "INGEST_PROCESSING", "UNDER_APPRAISAL", "ACTIVE", "DELETED", "DESTROYED", "DESTROY_PROCESSING", "RESTORE_PROCESSING" ] }, "instanceId": { "type": "string" }, "permissions": { "$ref": "#/components/schemas/Permissions" }, "descriptiveMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/DescriptiveMetadata" } }, "representations": { "type": "array", "items": { "$ref": "#/components/schemas/Representation" } }, "ingestSIPUUID": { "type": "string" }, "ingestSIPIds": { "type": "array", "items": { "type": "string" } }, "ingestJobId": { "type": "string" }, "ingestUpdateJobIds": { "type": "array", "items": { "type": "string" } }, "ghost": { "type": "boolean" }, "hasShallowFiles": { "type": "boolean" }, "format": { "$ref": "#/components/schemas/AIPFormat" }, "relationships": { "type": "array", "items": { "$ref": "#/components/schemas/Relationship" } }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "disposal": { "$ref": "#/components/schemas/DisposalAIPMetadata" } }, "xml": { "name": "aip" } }, "AIPFormat": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" } } }, "DisposalAIPMetadata": { "type": "object", "properties": { "schedule": { "$ref": "#/components/schemas/DisposalScheduleAIPMetadata" }, "holds": { "type": "array", "items": { "$ref": "#/components/schemas/DisposalHoldAIPMetadata" } }, "transitiveHolds": { "type": "array", "items": { "$ref": "#/components/schemas/DisposalTransitiveHoldAIPMetadata" } }, "confirmation": { "$ref": "#/components/schemas/DisposalConfirmationAIPMetadata" } }, "xml": { "name": "disposal_aip_metadata" } }, "DisposalConfirmationAIPMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "confirmationOn": { "type": "string" }, "confirmationBy": { "type": "string" }, "destruction": { "$ref": "#/components/schemas/DisposalDestructionAIPMetadata" } }, "xml": { "name": "disposal_schedule_confirmation_aip_metadata" } }, "DisposalDestructionAIPMetadata": { "type": "object", "properties": { "destructionOn": { "type": "string", "format": "date-time" }, "destructionBy": { "type": "string" } }, "xml": { "name": "disposal_schedule_destruction_aip_metadata" } }, "DisposalHoldAIPMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "associatedOn": { "type": "string", "format": "date-time" }, "associatedBy": { "type": "string" } }, "xml": { "name": "disposal_schedule_hold_aip_metadata" } }, "DisposalScheduleAIPMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "associatedBy": { "type": "string" }, "associatedOn": { "type": "string", "format": "date-time" }, "associationType": { "type": "string", "enum": [ "MANUAL", "RULES" ] } }, "xml": { "name": "disposal_schedule_aip_metadata" } }, "DisposalTransitiveHoldAIPMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "fromAIPs": { "type": "array", "items": { "type": "string" } } } }, "Relationship": { "type": "object", "properties": { "relationType": { "type": "string" }, "relationName": { "type": "string" }, "relationObject": { "type": "string" } } }, "DescriptiveMetadataPreview": { "type": "object", "properties": { "preview": { "type": "string" } } }, "DescriptiveMetadataPreviewRequest": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetadataValue" } } } }, "MoveRequest": { "type": "object", "properties": { "parentId": { "type": "string" }, "itemsToMove": { "$ref": "#/components/schemas/SelectedItemsRequest" }, "details": { "type": "string" } } }, "StreamingResponseBody": { "type": "object" }, "AssessmentRequest": { "type": "object", "properties": { "items": { "$ref": "#/components/schemas/SelectedItemsRequest" }, "accept": { "type": "boolean" }, "rejectReason": { "type": "string" } } }, "ResetPasswordRequest": { "type": "object", "properties": { "token": { "type": "string" }, "newPassword": { "$ref": "#/components/schemas/SecureString" } } }, "UpdateRiskIncidences": { "type": "object", "properties": { "selectedItems": { "$ref": "#/components/schemas/SelectedItemsRequest" }, "mitigatedDescription": { "type": "string" }, "severity": { "type": "string" }, "status": { "type": "string" } } }, "RenameFolderRequest": { "type": "object", "properties": { "folderUUID": { "type": "string" }, "renameTo": { "type": "string" }, "details": { "type": "string" } } }, "ResourceVersion": { "type": "object", "properties": { "id": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "properties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RiskVersions": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceVersion" } } } }, "RiskMitigationTerms": { "type": "object", "properties": { "preMitigationProbability": { "type": "string" }, "preMitigationImpact": { "type": "string" }, "posMitigationProbability": { "type": "string" }, "posMitigationImpact": { "type": "string" }, "severityLowLimit": { "type": "integer", "format": "int32" }, "severityHighLimit": { "type": "integer", "format": "int32" } } }, "RiskMitigationProperties": { "type": "object", "properties": { "probabilities": { "type": "array", "items": { "type": "string" } }, "impacts": { "type": "array", "items": { "type": "string" } }, "severityLowLimit": { "type": "integer", "format": "int32" }, "severityHighLimit": { "type": "integer", "format": "int32" } } }, "RepresentationTypeOptions": { "type": "object", "properties": { "types": { "type": "array", "items": { "type": "string" } }, "controlledVocabulary": { "type": "boolean" } } }, "RepresentationInformationFamily": { "type": "object", "properties": { "familyValues": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetadataValue" } } } }, "ConsumesOutputStream": { "type": "object", "properties": { "mediaType": { "type": "string" }, "size": { "type": "integer", "format": "int64" }, "fileName": { "type": "string" }, "lastModified": { "type": "string", "format": "date-time" } } }, "StreamResponse": { "type": "object", "properties": { "filename": { "type": "string" }, "mediaType": { "type": "string" }, "fileSize": { "type": "integer", "format": "int64" }, "lastModified": { "type": "string", "format": "date-time" }, "stream": { "$ref": "#/components/schemas/ConsumesOutputStream" } } }, "RepresentationInformationRelationOptions": { "type": "object", "properties": { "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "RepresentationInformationFamilyOptions": { "type": "object", "properties": { "options": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IndexedAIP": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "CREATED", "INGEST_PROCESSING", "UNDER_APPRAISAL", "ACTIVE", "DELETED", "DESTROYED", "DESTROY_PROCESSING", "RESTORE_PROCESSING" ] }, "type": { "type": "string" }, "instanceId": { "type": "string" }, "instanceName": { "type": "string" }, "level": { "type": "string" }, "title": { "type": "string" }, "dateInitial": { "type": "string", "format": "date-time" }, "dateFinal": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "description": { "type": "string" }, "parentID": { "type": "string" }, "ancestors": { "type": "array", "items": { "type": "string" } }, "permissions": { "$ref": "#/components/schemas/Permissions" }, "numberOfSubmissionFiles": { "type": "integer", "format": "int64" }, "numberOfDocumentationFiles": { "type": "integer", "format": "int64" }, "numberOfSchemaFiles": { "type": "integer", "format": "int64" }, "hasRepresentations": { "type": "boolean" }, "ghost": { "type": "boolean" }, "hasShallowFiles": { "type": "boolean", "writeOnly": true }, "ingestSIPIds": { "type": "array", "items": { "type": "string" } }, "ingestJobId": { "type": "string" }, "ingestUpdateJobIds": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "disposalScheduleId": { "type": "string" }, "disposalScheduleName": { "type": "string" }, "disposalHoldsId": { "type": "array", "items": { "type": "string" } }, "transitiveDisposalHoldsId": { "type": "array", "items": { "type": "string" } }, "destroyedOn": { "type": "string", "format": "date-time" }, "destroyedBy": { "type": "string" }, "disposalAction": { "type": "string", "enum": [ "RETAIN_PERMANENTLY", "REVIEW", "DESTROY" ] }, "scheduleAssociationType": { "type": "string", "enum": [ "MANUAL", "RULES" ] }, "retentionPeriodDuration": { "type": "integer", "format": "int32" }, "retentionPeriodInterval": { "type": "string", "enum": [ "NO_RETENTION_PERIOD", "DAYS", "WEEKS", "MONTHS", "YEARS" ] }, "overdueDate": { "type": "string", "format": "date-time" }, "retentionPeriodStartDate": { "type": "string", "format": "date-time" }, "retentionPeriodDetails": { "type": "string" }, "onHold": { "type": "boolean" }, "disposalConfirmationId": { "type": "string" }, "localInstance": { "type": "boolean" }, "allUpdateJobIds": { "$ref": "#/components/schemas/IndexedAIP" }, "retentionPeriodState": { "type": "string", "enum": [ "ERROR", "SUCCESS" ] } }, "xml": { "name": "aip" } }, "IndexedRepresentation": { "type": "object", "properties": { "aipId": { "type": "string" }, "id": { "type": "string" }, "original": { "type": "boolean" }, "representationStates": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "instanceId": { "type": "string" }, "hasShallowFiles": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "updatedOn": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "descriptiveMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/DescriptiveMetadata" } }, "uuid": { "type": "string" }, "title": { "type": "string" }, "sizeInBytes": { "type": "integer", "format": "int64" }, "numberOfDataFiles": { "type": "integer", "format": "int64" }, "numberOfDataFolders": { "type": "integer", "format": "int64" }, "numberOfDocumentationFiles": { "type": "integer", "format": "int64" }, "numberOfSchemaFiles": { "type": "integer", "format": "int64" }, "instanceName": { "type": "string" }, "ancestors": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "localInstance": { "type": "boolean" } }, "xml": { "name": "representation" } }, "LinkingIdentifier": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "PreservationEventsLinkingObjects": { "type": "object", "properties": { "aips": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IndexedAIP" } }, "representations": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IndexedRepresentation" } }, "files": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IndexedFile" } }, "transferredResources": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TransferredResource" } }, "sourceObjectIds": { "type": "array", "items": { "$ref": "#/components/schemas/LinkingIdentifier" } }, "outcomeObjectIds": { "type": "array", "items": { "$ref": "#/components/schemas/LinkingIdentifier" } }, "uris": { "type": "array", "items": { "type": "string" } } } }, "IndexedPreservationAgent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" }, "type": { "type": "string" }, "note": { "type": "string" }, "extension": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "instanceId": { "type": "string" }, "instanceName": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" } } }, "Metrics": { "type": "object", "properties": { "metrics": { "type": "object", "additionalProperties": { "type": "string" } } }, "xml": { "name": "metrics" } }, "AccessKeys": { "type": "object", "properties": { "access_keys": { "type": "array", "xml": { "name": "access_key" }, "items": { "$ref": "#/components/schemas/AccessKey" } } } }, "Report": { "type": "object", "properties": { "id": { "type": "string" }, "jobId": { "type": "string" }, "sourceObjectId": { "type": "string", "deprecated": true }, "sourceObjectClass": { "type": "string", "deprecated": true }, "sourceObjectOriginalIds": { "type": "array", "items": { "type": "string" } }, "sourceObjectOriginalName": { "type": "string" }, "outcomeObjectId": { "type": "string", "deprecated": true }, "outcomeObjectClass": { "type": "string", "deprecated": true }, "outcomeObjectState": { "type": "string", "enum": [ "CREATED", "INGEST_PROCESSING", "UNDER_APPRAISAL", "ACTIVE", "DELETED", "DESTROYED", "DESTROY_PROCESSING", "RESTORE_PROCESSING" ] }, "title": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "ingestType": { "type": "string" }, "completionPercentage": { "type": "integer", "format": "int32" }, "stepsCompleted": { "type": "integer", "format": "int32" }, "totalSteps": { "type": "integer", "format": "int32" }, "plugin": { "type": "string" }, "pluginName": { "type": "string" }, "pluginVersion": { "type": "string" }, "pluginState": { "type": "string", "enum": [ "SUCCESS", "PARTIAL_SUCCESS", "FAILURE", "RUNNING", "SKIPPED" ] }, "pluginIsMandatory": { "type": "boolean" }, "pluginDetails": { "type": "string" }, "htmlPluginDetails": { "type": "boolean" }, "instanceId": { "type": "string" }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } }, "lineSeparator": { "type": "string" } } }, "Reports": { "type": "object", "properties": { "reports": { "type": "array", "xml": { "name": "report" }, "items": { "$ref": "#/components/schemas/Report" } } }, "xml": { "name": "reports" } }, "DistributedInstances": { "type": "object", "properties": { "distributed_instances": { "type": "array", "xml": { "name": "distributed_instance" }, "items": { "$ref": "#/components/schemas/DistributedInstance" } } }, "xml": { "name": "distributed_instances" } }, "EntityTag": { "type": "object", "properties": { "value": { "type": "string" }, "weak": { "type": "boolean" } } }, "Link": { "type": "object", "properties": { "uri": { "type": "string", "format": "uri" }, "rel": { "type": "string" }, "uriBuilder": { "$ref": "#/components/schemas/UriBuilder" }, "rels": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "type": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MediaType": { "type": "object", "properties": { "type": { "type": "string" }, "subtype": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "wildcardType": { "type": "boolean" }, "wildcardSubtype": { "type": "boolean" } } }, "NewCookie": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "path": { "type": "string" }, "domain": { "type": "string" }, "comment": { "type": "string" }, "maxAge": { "type": "integer", "format": "int32" }, "expiry": { "type": "string", "format": "date-time" }, "secure": { "type": "boolean" }, "httpOnly": { "type": "boolean" }, "sameSite": { "type": "string", "enum": [ "NONE", "LAX", "STRICT" ] } } }, "Response": { "type": "object", "properties": { "links": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "allowedMethods": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "statusInfo": { "$ref": "#/components/schemas/StatusType" }, "stringHeaders": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "entity": { "type": "object" }, "entityTag": { "$ref": "#/components/schemas/EntityTag" }, "mediaType": { "$ref": "#/components/schemas/MediaType" }, "closed": { "type": "boolean" }, "metadata": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "cookies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NewCookie" } }, "status": { "type": "integer", "format": "int32" }, "length": { "type": "integer", "format": "int32" }, "location": { "type": "string", "format": "uri" }, "language": { "type": "object", "properties": { "language": { "type": "string" }, "displayName": { "type": "string" }, "country": { "type": "string" }, "variant": { "type": "string" }, "script": { "type": "string" }, "unicodeLocaleAttributes": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "unicodeLocaleKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "displayLanguage": { "type": "string" }, "displayScript": { "type": "string" }, "displayCountry": { "type": "string" }, "displayVariant": { "type": "string" }, "extensionKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "iso3Language": { "type": "string" }, "iso3Country": { "type": "string" } } }, "date": { "type": "string", "format": "date-time" }, "lastModified": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "additionalProperties": { "type": "array", "items": { "type": "object" } } } } }, "StatusType": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "reasonPhrase": { "type": "string" }, "family": { "type": "string", "enum": [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] } } }, "UriBuilder": { "type": "object" }, "DisposalSchedules": { "type": "object", "properties": { "disposalSchedules": { "type": "array", "items": { "$ref": "#/components/schemas/DisposalSchedule" } } } }, "DisposalRules": { "type": "object", "properties": { "disposalRules": { "type": "array", "items": { "$ref": "#/components/schemas/DisposalRule" } } } }, "DisposalHolds": { "type": "object", "properties": { "disposalHolds": { "type": "array", "items": { "$ref": "#/components/schemas/DisposalHold" } } } }, "DisposalTransitiveHoldsAIPMetadata": { "type": "object", "properties": { "disposalTransitiveHolds": { "type": "array", "items": { "$ref": "#/components/schemas/DisposalTransitiveHoldAIPMetadata" } } } }, "DisposalHoldsAIPMetadata": { "type": "object", "properties": { "disposalHoldsAIPMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/DisposalHoldAIPMetadata" } } } }, "Viewers": { "type": "object", "properties": { "pronoms": { "type": "object", "additionalProperties": { "type": "string" } }, "mimetypes": { "type": "object", "additionalProperties": { "type": "string" } }, "extensions": { "type": "object", "additionalProperties": { "type": "string" } }, "textLimit": { "type": "string" }, "options": { "type": "string" } } }, "SharedProperties": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "PluginInfoList": { "type": "object", "properties": { "pluginInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/PluginInfo" } } } }, "DropdownPluginParameterItem": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } } }, "DropdownPluginParameterItems": { "type": "object", "properties": { "items": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DropdownPluginParameterItem" } } } }, "ReindexPluginObject": { "type": "object", "properties": { "simpleName": { "type": "string" }, "name": { "type": "string" } } }, "ReindexPluginObjects": { "type": "object", "properties": { "pluginsObjects": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ReindexPluginObject" } } } }, "ObjectClassFields": { "type": "object", "properties": { "translations": { "type": "object", "additionalProperties": { "type": "string" } }, "objectClassFields": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "DescriptiveMetadataInfo": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "hasHistory": { "type": "boolean" } } }, "DescriptiveMetadataInfos": { "type": "object", "properties": { "descriptiveMetadataInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/DescriptiveMetadataInfo" } } } }, "DescriptiveMetadataVersions": { "type": "object", "properties": { "descriptiveMetadata": { "$ref": "#/components/schemas/DescriptiveMetadataInfo" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceVersion" } }, "permissions": { "$ref": "#/components/schemas/Permissions" } } }, "SupportedMetadataValue": { "type": "object", "properties": { "value": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetadataValue" } } } }, "TypeOptionsInfo": { "type": "object", "properties": { "types": { "type": "array", "items": { "type": "string" } }, "controlled": { "type": "boolean" } } }, "ConfiguredDescriptiveMetadata": { "type": "object", "properties": { "label": { "type": "string" }, "id": { "type": "string" } } }, "ConfiguredDescriptiveMetadataList": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/components/schemas/ConfiguredDescriptiveMetadata" } } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" }, "bearerAuth": { "type": "http", "scheme": "bearer" } } } }