{ "opencollection": "1.0.0", "info": { "name": "Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Import Job Module API", "version": "V1" }, "items": [ { "info": { "name": "Import Job Module", "type": "folder" }, "items": [ { "info": { "name": "Import.Services.V1.ImportJobController.CreateAsync", "type": "http" }, "http": { "method": "POST", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/:importJobID/", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "importJobID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Import job identification GUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create import job." }, { "info": { "name": "Import.Services.V1.ImportJobController.CancelAsync", "type": "http" }, "http": { "method": "POST", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/:importJobID/cancel/", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "importJobID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Import job identification GUID." } ] }, "docs": "Cancel import job." }, { "info": { "name": "Import.Services.V1.ImportJobController.BeginAsync", "type": "http" }, "http": { "method": "POST", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/:importJobID/begin/", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "importJobID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Import job identification GUID." } ] }, "docs": "Begin import job." }, { "info": { "name": "Import.Services.V1.ImportJobController.EndAsync", "type": "http" }, "http": { "method": "POST", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/:importJobID/end/", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "importJobID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Import job identification GUID." } ] }, "docs": "End import job." }, { "info": { "name": "Import.Services.V1.ImportJobController.PauseAsync", "type": "http" }, "http": { "method": "POST", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/:importJobID/pause/", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "importJobID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Import job identification GUID." } ] }, "docs": "Pause import job." }, { "info": { "name": "Import.Services.V1.ImportJobController.ResumeAsync", "type": "http" }, "http": { "method": "POST", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/:importJobID/resume/", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "importJobID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Import job identification GUID." } ] }, "docs": "Resume previously paused import job." }, { "info": { "name": "Import.Services.V1.ImportJobController.GetProgressAsync", "type": "http" }, "http": { "method": "GET", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/:importJobID/progress/", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "importJobID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Import job identification GUID." } ] }, "docs": "Get import job progress." }, { "info": { "name": "Import.Services.V1.ImportJobController.GetDetailsAsync", "type": "http" }, "http": { "method": "GET", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/:importJobID/details/", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "importJobID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Import job identification GUID." } ] }, "docs": "Get import job details." }, { "info": { "name": "Import.Services.V1.ImportJobController.GetJobsAsync", "type": "http" }, "http": { "method": "GET", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/jobs/", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "start", "value": "0", "type": "query", "description": "Index from which import jobs will be read." }, { "name": "length", "value": "10", "type": "query", "description": "Number of returned import jobs in workspace." } ] }, "docs": "Get import jobs which exist in workspace." }, { "info": { "name": "Import.Services.V1.ImportJobController.GetDefaultLocationForWorkspaceAsync", "type": "http" }, "http": { "method": "GET", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/location", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." } ] }, "docs": "Gets the default location for the import files upload." }, { "info": { "name": "Import.Services.V1.ImportJobController.GetDefaultLocationForJobAsync", "type": "http" }, "http": { "method": "GET", "url": "/Relativity.REST/api/import-service/v1/workspaces/:workspaceID/import-jobs/:importJobID/location", "headers": [ { "name": "X-CSRF-Header", "value": "" } ], "params": [ { "name": "workspaceID", "value": "10000", "type": "path", "description": "Workspace identification number." }, { "name": "importJobID", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Import job identification GUID." } ] }, "docs": "Gets the default location for the import files upload." } ] } ], "bundled": true }