{ "openapi": "3.0.1", "info": { "title": "Relativity.ARM.Services.Interfaces", "description": "Relativity.ARM.Services.Interfaces", "version": "V1,V3" }, "servers": [ { "url": "/Relativity.REST/api", "description": "The URL prefix for all Kepler services" } ], "paths": { "/relativity-arm/v3/restore-jobs": { "post": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Restore Manager V3", "operationId": "Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmRestoreJobManager_V3_CreateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRestoreJobResponse_V3" } } } } } } }, "/relativity-arm/v3/restore-jobs/{jobID}": { "get": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Restore Manager V3", "operationId": "Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreJobResponse_V3" } } } } } }, "put": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Restore Manager V3", "operationId": "Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmRestoreJobManager_V3_UpdateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRestoreJobResponse_V3" } } } } } }, "delete": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Restore Manager V3", "operationId": "Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } } } }, "/relativity-arm/v3/jobs/{jobID}/status": { "get": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Job Information Manager V3", "operationId": "Relativity.ARM.Services.Interfaces.V3.JobInformation.IArmJobInformationManager.GetJobStatusAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobProgressResponse_V3" } } } } } } }, "/relativity-arm/v3/jobs/{jobID}/cancel": { "post": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Job Actions Manager", "operationId": "Relativity.ARM.Services.Interfaces.V3.JobAction.IArmJobActionManager.CancelAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmJobActionManager_V3_CancelAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelJobResponse_V3" } } } } } } }, "/relativity-arm/v3/jobs/{jobID}/run": { "post": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Job Actions Manager", "operationId": "Relativity.ARM.Services.Interfaces.V3.JobAction.IArmJobActionManager.RunAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmJobActionManager_V3_RunAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunJobResponse_V3" } } } } } } }, "/relativity-arm/v3/archive-jobs": { "post": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Archive Manager V3", "operationId": "Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmArchiveJobManager_V3_CreateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateArchiveJobResponse_V3" } } } } } } }, "/relativity-arm/v3/archive-jobs/{jobID}": { "get": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Archive Manager V3", "operationId": "Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveJobResponse_V3" } } } } } }, "put": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Archive Manager V3", "operationId": "Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmArchiveJobManager_V3_UpdateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateArchiveJobResponse_V3" } } } } } }, "delete": { "tags": [ "ARM Module v3" ], "summary": "", "description": "[Public] ARM Archive Manager V3", "operationId": "Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } } } }, "/relativity-arm/v1/tasks/{taskId}/retry": { "post": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Task Actions Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.TaskAction.IArmTaskActionManager.RetryFailedTaskAsync", "parameters": [ { "$ref": "#/components/parameters/taskId" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } }, "/relativity-arm/v1/restore-jobs": { "post": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Restore Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Restore.IArmRestoreJobManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmRestoreJobManager_V1_CreateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "integer" } } } } }, "deprecated": true } }, "/relativity-arm/v1/restore-jobs/{jobID}": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Restore Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Restore.IArmRestoreJobManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreJobResponse_V1" } } } } }, "deprecated": true }, "put": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Restore Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Restore.IArmRestoreJobManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmRestoreJobManager_V1_UpdateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true }, "delete": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Restore Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Restore.IArmRestoreJobManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } }, "/relativity-arm/v1/move-jobs": { "post": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Move Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Move.IArmMoveJobManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmMoveJobManager_V1_CreateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "integer" } } } } }, "deprecated": true } }, "/relativity-arm/v1/move-jobs/{jobID}": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Move Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Move.IArmMoveJobManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveJobResponse_V1" } } } } }, "deprecated": true }, "put": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Move Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Move.IArmMoveJobManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmMoveJobManager_V1_UpdateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true }, "delete": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Move Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Move.IArmMoveJobManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } }, "/relativity-arm/v1/jobs/{jobID}/status": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] Arm Job Status Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.JobStatus.IArmJobStatusManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArmJobStatusResponse_V1" } } } } }, "deprecated": true } }, "/relativity-arm/v1/jobs/{jobID}/logs": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Job Information Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.JobInformation.IArmJobInformationManager.DownloadLogAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKeplerStream_V1" } } } } }, "deprecated": true } }, "/relativity-arm/v1/jobs/{jobExecutionId}/statistics": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Job Information Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.JobInformation.IArmJobInformationManager.GetJobStatisticsAsync", "parameters": [ { "$ref": "#/components/parameters/jobExecutionId" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatistics_V1" } } } } }, "deprecated": true } }, "/relativity-arm/v1/jobs/{jobExecutionID}/qualityCheckResult": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Job Information Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.JobInformation.IArmJobInformationManager.GetQualityCheckResultAsync", "parameters": [ { "$ref": "#/components/parameters/jobExecutionID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualityCheckResult_V1" } } } } } }, "deprecated": true } }, "/relativity-arm/v1/jobs/{jobID}/cancel": { "post": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Job Actions Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.JobAction.IArmJobActionManager.CancelAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } }, "/relativity-arm/v1/jobs/{jobID}/pause": { "post": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Job Actions Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.JobAction.IArmJobActionManager.PauseAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } }, "/relativity-arm/v1/jobs/{jobID}/run": { "post": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Job Actions Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.JobAction.IArmJobActionManager.RunAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } }, "/relativity-arm/v1/jobs/{jobID}/terminate": { "delete": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Job Actions Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.JobAction.IArmJobActionManager.TerminateJobAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } }, "/relativity-arm/v1/health-check": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Health Check", "operationId": "Relativity.ARM.Services.Interfaces.V1.HealthCheck.IArmHealthCheckManager.HealthCheckAsync", "parameters": [ { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } }, "/relativity-arm/v1/database-restore-jobs": { "post": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Database Restore Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.DatabaseRestore.IArmDatabaseRestoreJobManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmDatabaseRestoreJobManager_V1_CreateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "integer" } } } } }, "deprecated": true } }, "/relativity-arm/v1/database-restore-jobs/{jobID}": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Database Restore Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.DatabaseRestore.IArmDatabaseRestoreJobManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatabaseRestoreJobResponse_V1" } } } } }, "deprecated": true }, "put": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Database Restore Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.DatabaseRestore.IArmDatabaseRestoreJobManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmDatabaseRestoreJobManager_V1_UpdateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true }, "delete": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Database Restore Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.DatabaseRestore.IArmDatabaseRestoreJobManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } }, "/relativity-arm/v1/archive-information": { "post": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Archive Information Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.ArchiveInformation.IArmArchiveInformationManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmArchiveInformationManager_V1_ReadAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveInformationResponse_V1" } } } } }, "deprecated": true } }, "/relativity-arm/v1/archive-information/additional-files-directories/{workspaceId}": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED", "description": "[Public] ARM Archive Information Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.ArchiveInformation.IArmArchiveInformationManager.GetAdditionalFilesDirectoriesAsync", "parameters": [ { "$ref": "#/components/parameters/workspaceId" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdditionalFilesDirectoriesResponse_V1" } } } } }, "deprecated": true } }, "/relativity-arm/v1/archive-jobs": { "post": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Archive Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Archive.IArmArchiveJobManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmArchiveJobManager_V1_CreateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "integer" } } } } }, "deprecated": true } }, "/relativity-arm/v1/archive-jobs/{jobID}": { "get": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Archive Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Archive.IArmArchiveJobManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveJobResponse_V1" } } } } }, "deprecated": true }, "put": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Archive Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Archive.IArmArchiveJobManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IArmArchiveJobManager_V1_UpdateAsync_RequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true }, "delete": { "tags": [ "ARM Module v1" ], "summary": "DEPRECATED - Use V3 API instead", "description": "[Public] ARM Archive Manager", "operationId": "Relativity.ARM.Services.Interfaces.V1.Archive.IArmArchiveJobManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation" } }, "deprecated": true } } }, "components": { "schemas": { "IArmRestoreJobManager_V3_CreateAsync_RequestBody": { "title": "IArmRestoreJobManager_V3_CreateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/RestoreJobRequest_V3" } } }, "RestoreJobRequest_V3": { "title": "RestoreJobRequest_V3", "type": "object", "properties": { "ArchivePath": { "type": "string" }, "JobPriority": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "ExistingTargetDatabase": { "type": "string" }, "DestinationOptions": { "$ref": "#/components/schemas/RestoreDestinationOptions_V3" }, "MigratorOptions": { "$ref": "#/components/schemas/MigratorOptions_V3" }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V3" }, "UiJobActionsLocked": { "type": "boolean" } } }, "RestoreDestinationOptions_V3": { "title": "RestoreDestinationOptions_V3", "type": "object", "properties": { "MatterID": { "type": "integer" } } }, "MigratorOptions_V3": { "title": "MigratorOptions_V3", "type": "object", "additionalProperties": { "type": "object" }, "example": "\"Common\": {\"FileFirstFlow\": {\"IsFilesFirstFlow\": true, \"AdditionalFilesDirectoryPath\": \"path\"}},\"UserGroup\": {\"GroupMapping\": {\"AutoMapGroups\": false,\"GroupMappings\": [{\"ArchiveGroupID\": 1000000,\"InstanceGroupID\": 1000000}]},\"UserMapping\": {\"AutoMapUsers\": true,\"UserMappings\": [{\"ArchiveUserID\": 7000000,\"InstanceUserID\": 1000000}]}" }, "NotificationOptions_V3": { "title": "NotificationOptions_V3", "type": "object", "properties": { "NotifyJobCreator": { "type": "boolean" }, "NotifyJobExecutor": { "type": "boolean" } } }, "CreateRestoreJobResponse_V3": { "title": "CreateRestoreJobResponse_V3", "type": "object", "properties": { "JobID": { "type": "string" } } }, "RestoreJobResponse_V3": { "title": "RestoreJobResponse_V3", "type": "object", "properties": { "JobID": { "type": "string" }, "JobName": { "type": "string" }, "ArchivePath": { "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "SourceWorkspace": { "type": "string" }, "DestinationWorkspaceID": { "type": "integer", "nullable": true }, "ExistingTargetDatabase": { "type": "string" }, "JobDetails": { "$ref": "#/components/schemas/JobDetails_V3" }, "DestinationOptions": { "$ref": "#/components/schemas/RestoreDestinationOptions_V3" }, "MigratorOptions": { "$ref": "#/components/schemas/MigratorOptions_V3" }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V3" }, "UiJobActionsLocked": { "type": "boolean" } } }, "JobDetails_V3": { "title": "JobDetails_V3", "type": "object", "properties": { "Priority": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "ActionsHistory": { "type": "array", "items": { "$ref": "#/components/schemas/JobActions_V3" } } } }, "JobActions_V3": { "title": "JobActions_V3", "type": "object", "properties": { "Date": { "type": "string", "format": "date-time" }, "Type": { "type": "string" }, "UserName": { "type": "string" } } }, "IArmRestoreJobManager_V3_UpdateAsync_RequestBody": { "title": "IArmRestoreJobManager_V3_UpdateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/RestoreJobRequest_V3" } } }, "UpdateRestoreJobResponse_V3": { "title": "UpdateRestoreJobResponse_V3", "type": "object" }, "JobProgressResponse_V3": { "title": "JobProgressResponse_V3", "type": "object", "properties": { "JobId": { "type": "string" }, "JobState": { "enum": [ "NotStarted", "InProgress", "Paused", "Cancelling", "Cancelled", "Errored", "Completed" ], "type": "string" } } }, "IArmJobActionManager_V3_CancelAsync_RequestBody": { "title": "IArmJobActionManager_V3_CancelAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/CancelJobRequest_V3" } } }, "CancelJobRequest_V3": { "title": "CancelJobRequest_V3", "type": "object" }, "CancelJobResponse_V3": { "title": "CancelJobResponse_V3", "type": "object" }, "IArmJobActionManager_V3_RunAsync_RequestBody": { "title": "IArmJobActionManager_V3_RunAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/RunJobRequest_V3" } } }, "RunJobRequest_V3": { "title": "RunJobRequest_V3", "type": "object" }, "RunJobResponse_V3": { "title": "RunJobResponse_V3", "type": "object" }, "IArmArchiveJobManager_V3_CreateAsync_RequestBody": { "title": "IArmArchiveJobManager_V3_CreateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/ArchiveJobRequest_V3" } } }, "ArchiveJobRequest_V3": { "title": "ArchiveJobRequest_V3", "type": "object", "properties": { "WorkspaceID": { "type": "integer" }, "ArchiveDirectory": { "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "JobPriority": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "ExcludedMigrators": { "type": "array", "items": { "type": "string" }, "example": "[\"ADS\", \"Processing\", \"NonRepositoryFiles\", \"dtIndex\", \"analytics-core\", \"StructuredAnalytics\", \"Audit\", \"Database\"]" }, "MigratorOptions": { "$ref": "#/components/schemas/MigratorOptions_V3" }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V3" }, "UiJobActionsLocked": { "type": "boolean" } } }, "CreateArchiveJobResponse_V3": { "title": "CreateArchiveJobResponse_V3", "type": "object", "properties": { "JobID": { "type": "string" } } }, "ArchiveJobResponse_V3": { "title": "ArchiveJobResponse_V3", "type": "object", "properties": { "JobID": { "type": "string" }, "JobName": { "type": "string" }, "ArchivePath": { "type": "string" }, "WorkspaceID": { "type": "integer" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "JobDetails": { "$ref": "#/components/schemas/JobDetails_V3" }, "ExcludedMigrators": { "type": "array", "items": { "type": "string" } }, "MigratorOptions": { "$ref": "#/components/schemas/MigratorOptions_V3" }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V3" }, "UiJobActionsLocked": { "type": "boolean" } } }, "IArmArchiveJobManager_V3_UpdateAsync_RequestBody": { "title": "IArmArchiveJobManager_V3_UpdateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/ArchiveJobRequest_V3" } } }, "UpdateArchiveJobResponse_V3": { "title": "UpdateArchiveJobResponse_V3", "type": "object" }, "IArmRestoreJobManager_V1_CreateAsync_RequestBody": { "title": "IArmRestoreJobManager_V1_CreateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/RestoreJobRequest_V1" } } }, "RestoreJobRequest_V1": { "title": "RestoreJobRequest_V1", "type": "object", "properties": { "ArchivePath": { "type": "string" }, "JobPriority": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "ExistingTargetDatabase": { "type": "string" }, "DestinationOptions": { "$ref": "#/components/schemas/RestoreDestinationOptions_V1" }, "MigratorsDestinationOptions": { "$ref": "#/components/schemas/MigratorsDestinationOptions_V1" }, "AdvancedFileOptions": { "$ref": "#/components/schemas/AdvancedFileOptions_V1" }, "UserMapping": { "$ref": "#/components/schemas/UserMapping_V1" }, "GroupMapping": { "$ref": "#/components/schemas/GroupMapping_V1" }, "Applications": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationSettings_V1" } }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V1" }, "FileShareOptions": { "$ref": "#/components/schemas/FileShareOptions_V1" }, "UiJobActionsLocked": { "type": "boolean" }, "IncludeQualityCheck": { "type": "boolean" }, "IsFilesFirstFlow": { "type": "boolean" } } }, "RestoreDestinationOptions_V1": { "title": "RestoreDestinationOptions_V1", "type": "object" }, "MigratorsDestinationOptions_V1": { "title": "MigratorsDestinationOptions_V1", "type": "object" }, "AdvancedFileOptions_V1": { "title": "AdvancedFileOptions_V1", "type": "object", "properties": { "ReferenceFilesAsArchiveLinks": { "type": "boolean" }, "UpdateRepositoryFilePaths": { "type": "boolean" }, "UpdateLinkedFilePaths": { "type": "boolean" }, "AdditionalFilesDirectoryPath": { "type": "string" } } }, "UserMapping_V1": { "title": "UserMapping_V1", "type": "object" }, "GroupMapping_V1": { "title": "GroupMapping_V1", "type": "object" }, "ApplicationSettings_V1": { "title": "ApplicationSettings_V1", "type": "object", "properties": { "Guid": { "type": "string" }, "ShouldRestore": { "type": "boolean" } } }, "NotificationOptions_V1": { "title": "NotificationOptions_V1", "type": "object" }, "FileShareOptions_V1": { "title": "FileShareOptions_V1", "type": "object", "properties": { "Fqdn": { "type": "string" }, "SecretPath": { "type": "string" } } }, "RestoreJobResponse_V1": { "title": "RestoreJobResponse_V1", "type": "object", "properties": { "JobID": { "type": "integer" }, "JobName": { "type": "string" }, "JobExecutionID": { "type": "integer" }, "JobExecutionGuid": { "type": "string" }, "ArchivePath": { "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "SourceWorkspace": { "type": "string" }, "DestinationWorkspaceID": { "type": "integer", "nullable": true }, "ExistingTargetDatabase": { "type": "string" }, "JobDetails": { "$ref": "#/components/schemas/JobDetails_V1" }, "DestinationOptions": { "$ref": "#/components/schemas/RestoreDestinationOptions_V1" }, "MigratorsDestinationOptions": { "$ref": "#/components/schemas/MigratorsDestinationOptions_V1" }, "AdvancedFileOptions": { "$ref": "#/components/schemas/AdvancedFileOptions_V1" }, "UserMappings": { "type": "array", "items": { "$ref": "#/components/schemas/UserMap_V1" } }, "GroupMappings": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMap_V1" } }, "Applications": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationSettingsResponse_V1" } }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V1" }, "UiJobActionsLocked": { "type": "boolean" }, "IsFilesFirstFlow": { "type": "boolean" } } }, "JobDetails_V1": { "title": "JobDetails_V1", "type": "object" }, "UserMap_V1": { "title": "UserMap_V1", "type": "object" }, "GroupMap_V1": { "title": "GroupMap_V1", "type": "object" }, "ApplicationSettingsResponse_V1": { "title": "ApplicationSettingsResponse_V1", "type": "object" }, "IArmRestoreJobManager_V1_UpdateAsync_RequestBody": { "title": "IArmRestoreJobManager_V1_UpdateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/RestoreJobRequest_V1" } } }, "IArmMoveJobManager_V1_CreateAsync_RequestBody": { "title": "IArmMoveJobManager_V1_CreateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/MoveJobRequest_V1" } } }, "MoveJobRequest_V1": { "title": "MoveJobRequest_V1", "type": "object", "properties": { "SourceWorkspaceID": { "type": "integer" }, "JobPriority": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "FileOptions": { "$ref": "#/components/schemas/MoveFileOptions_V1" }, "DatabaseOptions": { "$ref": "#/components/schemas/DatabaseOptions_V1" }, "DestinationOptions": { "$ref": "#/components/schemas/DestinationOptions_V1" }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V1" }, "UiJobActionsLocked": { "type": "boolean" } } }, "MoveFileOptions_V1": { "title": "MoveFileOptions_V1", "type": "object", "properties": { "LinkToExistingDocuments": { "type": "boolean" }, "MissingFileBehavior": { "enum": [ "SkipFile", "StopJob" ], "type": "string" }, "LinkedFileBehavior": { "enum": [ "LeaveInPlace", "CopyToRepository", "MoveToRepository" ], "type": "string" } } }, "DatabaseOptions_V1": { "title": "DatabaseOptions_V1", "type": "object", "properties": { "IncludeDatabaseBackup": { "type": "boolean" }, "CustomDatabasePath": { "type": "string" } } }, "DestinationOptions_V1": { "title": "DestinationOptions_V1", "type": "object", "properties": { "ResourcePoolID": { "type": "integer" }, "DatabaseServerID": { "type": "integer" }, "CacheLocationID": { "type": "integer" }, "FileRepositoryID": { "type": "integer" }, "UseDefaultWorkspaceConfiguration": { "type": "boolean", "nullable": true } } }, "MoveJobResponse_V1": { "title": "MoveJobResponse_V1", "type": "object", "properties": { "JobID": { "type": "integer" }, "JobName": { "type": "string" }, "JobExecutionID": { "type": "integer" }, "JobExecutionGuid": { "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "JobDetails": { "$ref": "#/components/schemas/JobDetails_V1" }, "SourceOptions": { "$ref": "#/components/schemas/SourceOptions_V1" }, "DestinationOptions": { "$ref": "#/components/schemas/DestinationOptions_V1" }, "FileOptions": { "$ref": "#/components/schemas/MoveFileOptions_V1" }, "DatabaseOptions": { "$ref": "#/components/schemas/DatabaseOptions_V1" }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V1" }, "UiJobActionsLocked": { "type": "boolean" } } }, "SourceOptions_V1": { "title": "SourceOptions_V1", "type": "object", "properties": { "WorkspaceID": { "type": "integer" }, "ResourcePoolID": { "type": "integer" }, "DatabaseServerID": { "type": "integer" }, "CacheLocationID": { "type": "integer" }, "FileRepositoryID": { "type": "integer" } } }, "IArmMoveJobManager_V1_UpdateAsync_RequestBody": { "title": "IArmMoveJobManager_V1_UpdateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/MoveJobRequest_V1" } } }, "ArmJobStatusResponse_V1": { "title": "ArmJobStatusResponse_V1", "type": "object", "properties": { "JobType": { "enum": [ "Archive", "Move", "Restore", "DatabaseRestore" ], "type": "string" }, "JobState": { "enum": [ "ExecutionRequested", "Pending", "Processing", "ProcessingWithErrors", "Errored", "Complete", "CancellationRequested", "CancellationPending", "CancellationProcessing", "CancellationProcessingWithErrors", "CancellationErrored", "CancellationComplete", "Paused", "NotStarted", "PauseRequested", "RecoveryRequested", "CancellationRecoveryRequested", "Scheduled", "CleaningUp", "Recurring", "ProcessingButAvailable", "Unknown" ], "type": "string" }, "CurrentJobStage": { "$ref": "#/components/schemas/JobStage_V1" }, "TotalNumberOfStages": { "type": "integer" }, "TimeStarted": { "type": "string", "format": "date-time", "nullable": true }, "TimeCompleted": { "type": "string", "format": "date-time", "nullable": true }, "TimeElapsed": { "$ref": "#/components/schemas/TimeSpan_V1" } } }, "JobStage_V1": { "title": "JobStage_V1", "type": "object", "properties": { "Name": { "type": "string" }, "Order": { "type": "integer" }, "NumberOfSucceededTasks": { "type": "integer", "nullable": true }, "NumberOfFailedTasks": { "type": "integer", "nullable": true }, "TotalNumberOfTasks": { "type": "integer", "nullable": true }, "TimeStarted": { "type": "string", "format": "date-time", "nullable": true }, "TimeElapsed": { "$ref": "#/components/schemas/TimeSpan_V1" }, "PercentComplete": { "type": "integer" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/JobStageError_V1" } }, "UserActions": { "type": "array", "items": { "$ref": "#/components/schemas/DependencyUserAction_V1" } } } }, "TimeSpan_V1": { "title": "TimeSpan_V1", "type": "object" }, "JobStageError_V1": { "title": "JobStageError_V1", "type": "object", "properties": { "Message": { "type": "string" }, "Exception": { "type": "string" } } }, "DependencyUserAction_V1": { "title": "DependencyUserAction_V1", "type": "object" }, "IKeplerStream_V1": { "title": "IKeplerStream_V1", "type": "object", "properties": { "ContentType": { "type": "string" }, "ContentDisposition": { "type": "string" }, "CacheControl": { "type": "string" }, "StatusCode": { "enum": [ "Continue", "SwitchingProtocols", "Processing", "EarlyHints", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "Ambiguous", "MovedPermanently", "Moved", "Found", "Redirect", "SeeOther", "RedirectMethod", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "RedirectKeepVerb", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "MisdirectedRequest", "UnprocessableEntity", "UnprocessableContent", "Locked", "FailedDependency", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "UnavailableForLegalReasons", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "NotExtended", "NetworkAuthenticationRequired" ], "type": "string", "nullable": true }, "Headers": { "type": "array", "items": { "type": "string", "format": "NameValueCollection" } } } }, "JobStatistics_V1": { "title": "JobStatistics_V1", "type": "object", "properties": { "SourceName": { "type": "string" }, "DestinationName": { "type": "string" }, "JobTypeName": { "type": "string" }, "ArchiveItemsStatistics": { "type": "array", "items": { "$ref": "#/components/schemas/ArchiveItemStatistics_V1" } } } }, "ArchiveItemStatistics_V1": { "title": "ArchiveItemStatistics_V1", "type": "object", "properties": { "ItemTypeName": { "type": "string" }, "SourceItemCount": { "type": "integer", "nullable": true }, "DestinationItemCount": { "type": "integer", "nullable": true }, "MissingItemsCount": { "type": "integer", "nullable": true }, "MalwareItemsCount": { "type": "integer", "nullable": true } } }, "QualityCheckResult_V1": { "title": "QualityCheckResult_V1", "type": "object", "properties": { "Type": { "type": "string" }, "Status": { "type": "string" } } }, "IArmDatabaseRestoreJobManager_V1_CreateAsync_RequestBody": { "title": "IArmDatabaseRestoreJobManager_V1_CreateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/DatabaseRestoreJobRequest_V1" } } }, "DatabaseRestoreJobRequest_V1": { "title": "DatabaseRestoreJobRequest_V1", "type": "object", "properties": { "SourceDatabase": { "type": "string" }, "JobPriority": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "DestinationOptions": { "$ref": "#/components/schemas/RestoreDestinationOptions_V1" }, "UserMapping": { "$ref": "#/components/schemas/UserMapping_V1" }, "GroupMapping": { "$ref": "#/components/schemas/GroupMapping_V1" }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V1" }, "UiJobActionsLocked": { "type": "boolean" } } }, "DatabaseRestoreJobResponse_V1": { "title": "DatabaseRestoreJobResponse_V1", "type": "object", "properties": { "JobID": { "type": "integer" }, "JobName": { "type": "string" }, "JobExecutionID": { "type": "integer" }, "JobExecutionGuid": { "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "DestinationWorkspaceID": { "type": "integer", "nullable": true }, "JobDetails": { "$ref": "#/components/schemas/JobDetails_V1" }, "DestinationOptions": { "$ref": "#/components/schemas/RestoreDestinationOptions_V1" }, "UserMappings": { "type": "array", "items": { "$ref": "#/components/schemas/UserMap_V1" } }, "GroupMappings": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMap_V1" } }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V1" }, "UiJobActionsLocked": { "type": "boolean" } } }, "IArmDatabaseRestoreJobManager_V1_UpdateAsync_RequestBody": { "title": "IArmDatabaseRestoreJobManager_V1_UpdateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/DatabaseRestoreJobRequest_V1" } } }, "IArmArchiveInformationManager_V1_ReadAsync_RequestBody": { "title": "IArmArchiveInformationManager_V1_ReadAsync_RequestBody", "type": "object", "properties": { "archivePath": { "type": "string" } } }, "ArchiveInformationResponse_V1": { "title": "ArchiveInformationResponse_V1", "type": "object", "properties": { "Client": { "$ref": "#/components/schemas/ClientInfo_V1" }, "Matter": { "$ref": "#/components/schemas/MatterInfo_V1" } } }, "ClientInfo_V1": { "title": "ClientInfo_V1", "type": "object", "properties": { "Name": { "type": "string" }, "Number": { "type": "string" } } }, "MatterInfo_V1": { "title": "MatterInfo_V1", "type": "object", "properties": { "Name": { "type": "string" }, "Number": { "type": "string" } } }, "AdditionalFilesDirectoriesResponse_V1": { "title": "AdditionalFilesDirectoriesResponse_V1", "type": "object", "properties": { "WorkspaceId": { "type": "integer" }, "AdditionalFilesDirectories": { "type": "array", "items": { "type": "string" } } } }, "IArmArchiveJobManager_V1_CreateAsync_RequestBody": { "title": "IArmArchiveJobManager_V1_CreateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/ArchiveJobRequest_V1" } } }, "ArchiveJobRequest_V1": { "title": "ArchiveJobRequest_V1", "type": "object", "properties": { "WorkspaceID": { "type": "integer" }, "ArchiveDirectory": { "type": "string" }, "JobPriority": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "MigratorOptions": { "$ref": "#/components/schemas/MigratorOptions_V1" }, "FileOptions": { "$ref": "#/components/schemas/FileOptions_V1" }, "ProcessingOptions": { "$ref": "#/components/schemas/ProcessingOptions_V1" }, "ExtendedWorkspaceDataOptions": { "$ref": "#/components/schemas/ExtendedWorkspaceDataOptions_V1" }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V1" }, "UiJobActionsLocked": { "type": "boolean" }, "UseDefaultArchiveDirectory": { "type": "boolean" } } }, "MigratorOptions_V1": { "title": "MigratorOptions_V1", "type": "object", "properties": { "IncludeDatabaseBackup": { "type": "boolean" }, "IncludeDtSearch": { "type": "boolean" }, "IncludeConceptualAnalytics": { "type": "boolean" }, "IncludeStructuredAnalytics": { "type": "boolean" }, "IncludeDataGrid": { "type": "boolean" }, "IncludeQualityCheck": { "type": "boolean" } } }, "FileOptions_V1": { "title": "FileOptions_V1", "type": "object" }, "ProcessingOptions_V1": { "title": "ProcessingOptions_V1", "type": "object", "properties": { "IncludeProcessing": { "type": "boolean" }, "IncludeProcessingFiles": { "type": "boolean" }, "ProcessingMissingFileBehavior": { "enum": [ "SkipFile", "StopJob" ], "type": "string" } } }, "ExtendedWorkspaceDataOptions_V1": { "title": "ExtendedWorkspaceDataOptions_V1", "type": "object", "properties": { "IncludeExtendedWorkspaceData": { "type": "boolean" }, "ApplicationErrorExportBehavior": { "enum": [ "SkipApplication", "StopJob" ], "type": "string" } } }, "ArchiveJobResponse_V1": { "title": "ArchiveJobResponse_V1", "type": "object", "properties": { "JobID": { "type": "integer" }, "JobName": { "type": "string" }, "JobExecutionID": { "type": "integer" }, "JobExecutionGuid": { "type": "string" }, "ArchivePath": { "type": "string" }, "WorkspaceID": { "type": "integer" }, "WorkspaceName": { "type": "string" }, "ScheduledStartTime": { "type": "string", "format": "date-time", "nullable": true }, "JobDetails": { "$ref": "#/components/schemas/JobDetails_V1" }, "MigratorOptions": { "$ref": "#/components/schemas/MigratorOptions_V1" }, "FileOptions": { "$ref": "#/components/schemas/FileOptions_V1" }, "ProcessingOptions": { "$ref": "#/components/schemas/ProcessingOptions_V1" }, "ExtendedWorkspaceDataOptions": { "$ref": "#/components/schemas/ExtendedWorkspaceDataOptions_V1" }, "NotificationOptions": { "$ref": "#/components/schemas/NotificationOptions_V1" }, "UiJobActionsLocked": { "type": "boolean" } } }, "IArmArchiveJobManager_V1_UpdateAsync_RequestBody": { "title": "IArmArchiveJobManager_V1_UpdateAsync_RequestBody", "type": "object", "properties": { "request": { "$ref": "#/components/schemas/ArchiveJobRequest_V1" } } } }, "parameters": { "x-csrf-header": { "name": "x-csrf-header", "in": "header", "description": "", "required": true, "schema": { "type": "string", "default": "-" } }, "jobID": { "name": "jobID", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, "taskId": { "name": "taskId", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "jobExecutionId": { "name": "jobExecutionId", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "jobExecutionID": { "name": "jobExecutionID", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "workspaceId": { "name": "workspaceId", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } } } } }