From a4cb3a8f3fe3c7463dd10a96bf025506f43e0cd5 Mon Sep 17 00:00:00 2001 From: annasojkapal <107477565+annasojkapal@users.noreply.github.com> Date: Fri, 13 Jan 2023 15:17:59 +0100 Subject: [PATCH] Minor code fixes (#8) * Change endpoint name * Change names and comments * Comment changes * Change samples names * Correct spaces * Correct spaces --- .../Helpers/RelativityImportEndpoints.cs | 2 +- Samples/.Net7ClientConsole/Program.cs | 6 +++--- ...s.cs => Sample07_DirectImportSettingsForDocuments.cs} | 6 +++--- ...ages.cs => Sample11_DirectImportSettingsForImages.cs} | 6 +++--- ...ettings.cs => Sample14_DirectImportSettingsForRdo.cs} | 6 +++--- .../SampleCollection/Sample23_GetDataSourceErrors.cs | 2 +- Samples/KeplerClientConsole/Program.cs | 6 +++--- ...s.cs => Sample07_DirectImportSettingsForDocuments.cs} | 6 +++--- ...ages.cs => Sample11_DirectImportSettingsForImages.cs} | 6 +++--- ...ettings.cs => Sample14_DirectImportSettingsForRdo.cs} | 6 +++--- Samples/RestSamples/Helpers/EndpointsClass.ps1 | 4 ++-- Samples/RestSamples/Helpers/WriteInformationClass.ps1 | 2 +- .../SamplesCollection/sample01-import-native-files.ps1 | 2 +- .../sample02-import-documents-in-overlay-mode.ps1 | 2 +- .../sample03-import-from-two-data-sources.ps1 | 4 ++-- .../sample04-add-data-source-to-running-job.ps1 | 4 ++-- .../sample05-import-documents-with-extracted-text.ps1 | 2 +- .../sample06-import-documents-to-selected-folder.ps1 | 2 +- ...=> sample07-direct-import-settings-for-documents.ps1} | 4 ++-- .../SamplesCollection/sample08-import-images.ps1 | 2 +- .../sample09-import-production-files.ps1 | 2 +- .../sample10-import-images-in-append-overlay-mode.ps1 | 2 +- ...s1 => sample11-direct-import-settings-for-images.ps1} | 4 ++-- .../sample12-import-relativity-dynamic-object.ps1 | 2 +- .../sample13-import-rdo-with-parent.ps1 | 2 +- ...s.ps1 => sample14-direct-import-settings-for-rdo.ps1} | 4 ++-- .../SamplesCollection/sample18-get-data-source.ps1 | 2 +- .../sample19-get-import-job-details-and-progress.ps1 | 2 +- .../sample20-get-data-source-details-and-progress.ps1 | 2 +- .../SamplesCollection/sample21-cancel-started-job.ps1 | 2 +- .../SamplesCollection/sample22-read-response.ps1 | 2 +- .../sample23-get-data-source-errors.ps1 | 4 ++-- .../{run-sample-Import.ps1 => run-sample-import.ps1} | 9 ++++++--- 33 files changed, 61 insertions(+), 58 deletions(-) rename Samples/.Net7ClientConsole/SampleCollection/{Sample07_ImportDocumentSettingsForNatives.cs => Sample07_DirectImportSettingsForDocuments.cs} (94%) rename Samples/.Net7ClientConsole/SampleCollection/{Sample11_ImportDocumentSettingsForImages.cs => Sample11_DirectImportSettingsForImages.cs} (93%) rename Samples/.Net7ClientConsole/SampleCollection/{Sample14_ImportRdoSettings.cs => Sample14_DirectImportSettingsForRdo.cs} (94%) rename Samples/KeplerClientConsole/SamplesCollection/{Sample07_ImportDocumentSettingsForNatives.cs => Sample07_DirectImportSettingsForDocuments.cs} (94%) rename Samples/KeplerClientConsole/SamplesCollection/{Sample11_ImportDocumentSettingsForImages.cs => Sample11_DirectImportSettingsForImages.cs} (93%) rename Samples/KeplerClientConsole/SamplesCollection/{Sample14_ImportRdoSettings.cs => Sample14_DirectImportSettingsForRdo.cs} (93%) rename Samples/RestSamples/SamplesCollection/{sample07-import-document-settings-for-natives.ps1 => sample07-direct-import-settings-for-documents.ps1} (95%) rename Samples/RestSamples/SamplesCollection/{sample11-import-document-settings-for-images.ps1 => sample11-direct-import-settings-for-images.ps1} (94%) rename Samples/RestSamples/SamplesCollection/{sample14-import-rdo-settings.ps1 => sample14-direct-import-settings-for-rdo.ps1} (95%) rename Samples/RestSamples/{run-sample-Import.ps1 => run-sample-import.ps1} (82%) diff --git a/Samples/.Net7ClientConsole/Helpers/RelativityImportEndpoints.cs b/Samples/.Net7ClientConsole/Helpers/RelativityImportEndpoints.cs index f7f081e..fb0851f 100644 --- a/Samples/.Net7ClientConsole/Helpers/RelativityImportEndpoints.cs +++ b/Samples/.Net7ClientConsole/Helpers/RelativityImportEndpoints.cs @@ -36,7 +36,7 @@ public static class RelativityImportEndpoints public static string GetImportSourceProgressUri(int workspaceId, Guid importId, Guid sourceId) => $"api/import-service/v1/workspaces/{workspaceId}/import-jobs/{importId}/sources/{sourceId}/progress"; - public static string GetImportSourcesItemErrorsUri(int workspaceId, Guid importId, Guid sourceId, int start, int length) => $"api/import-service/v1/workspaces/{workspaceId}/import-jobs/{importId}/sources/{sourceId}/itemerrors?start={start}&length={length}"; + public static string GetImportSourceItemErrorsUri(int workspaceId, Guid importId, Guid sourceId, int start, int length) => $"api/import-service/v1/workspaces/{workspaceId}/import-jobs/{importId}/sources/{sourceId}/itemerrors?start={start}&length={length}"; } } diff --git a/Samples/.Net7ClientConsole/Program.cs b/Samples/.Net7ClientConsole/Program.cs index 16c6679..6b67ec8 100644 --- a/Samples/.Net7ClientConsole/Program.cs +++ b/Samples/.Net7ClientConsole/Program.cs @@ -36,7 +36,7 @@ private static void Main(string[] args) // await sampleCollection.Sample06_ImportDocumentsToSelectedFolder(); - // await sampleCollection.Sample07_ImportDocumentSettingsForNatives(); + // await sampleCollection.Sample07_DirectImportSettingsForDocuments(); // await sampleCollection.Sample08_ImportImages(); @@ -44,13 +44,13 @@ private static void Main(string[] args) // await sampleCollection.Sample10_ImportImagesInAppendOverlayMode(); - //await sampleCollection.Sample11_ImportDocumentSettingsForImages(); + //await sampleCollection.Sample11_DirectImportSettingsForImages(); // await sampleCollection.Sample12_ImportRelativityDynamicObject(); // await sampleCollection.Sample13_ImportRdoWithParent(); - // await sampleCollection.Sample14_ImportRdoSettings(); + // await sampleCollection.Sample14_DirectImportSettingsForRdo(); // await sampleCollection.Sample15_ReadImportRdoSettings(); diff --git a/Samples/.Net7ClientConsole/SampleCollection/Sample07_ImportDocumentSettingsForNatives.cs b/Samples/.Net7ClientConsole/SampleCollection/Sample07_DirectImportSettingsForDocuments.cs similarity index 94% rename from Samples/.Net7ClientConsole/SampleCollection/Sample07_ImportDocumentSettingsForNatives.cs rename to Samples/.Net7ClientConsole/SampleCollection/Sample07_DirectImportSettingsForDocuments.cs index 70771da..5d17471 100644 --- a/Samples/.Net7ClientConsole/SampleCollection/Sample07_ImportDocumentSettingsForNatives.cs +++ b/Samples/.Net7ClientConsole/SampleCollection/Sample07_DirectImportSettingsForDocuments.cs @@ -1,4 +1,4 @@ -// +// // © Relativity All Rights Reserved. // @@ -26,9 +26,9 @@ public partial class ImportServiceSample /// Settings dedicated for image import. /// /// A representing the result of the asynchronous operation. - public async Task Sample07_ImportDocumentSettingsForNatives() + public async Task Sample07_DirectImportSettingsForDocuments() { - Console.WriteLine($"Running {nameof(Sample07_ImportDocumentSettingsForNatives)}"); + Console.WriteLine($"Running {nameof(Sample07_DirectImportSettingsForDocuments)}"); // GUID identifiers for import job and data source. Guid importId = Guid.NewGuid(); diff --git a/Samples/.Net7ClientConsole/SampleCollection/Sample11_ImportDocumentSettingsForImages.cs b/Samples/.Net7ClientConsole/SampleCollection/Sample11_DirectImportSettingsForImages.cs similarity index 93% rename from Samples/.Net7ClientConsole/SampleCollection/Sample11_ImportDocumentSettingsForImages.cs rename to Samples/.Net7ClientConsole/SampleCollection/Sample11_DirectImportSettingsForImages.cs index 9b10e72..89175fe 100644 --- a/Samples/.Net7ClientConsole/SampleCollection/Sample11_ImportDocumentSettingsForImages.cs +++ b/Samples/.Net7ClientConsole/SampleCollection/Sample11_DirectImportSettingsForImages.cs @@ -1,4 +1,4 @@ -// +// // © Relativity All Rights Reserved. // @@ -25,9 +25,9 @@ public partial class ImportServiceSample /// Example of creating ImportDocumentSettings for image import manually - without using ImportDocumentSettingsBuilder. /// /// A representing the result of the asynchronous operation. - public async Task Sample11_ImportDocumentSettingsForImages() + public async Task Sample11_DirectImportSettingsForImages() { - Console.WriteLine($"Running {nameof(Sample11_ImportDocumentSettingsForImages)}"); + Console.WriteLine($"Running {nameof(Sample11_DirectImportSettingsForImages)}"); // GUID identifiers for import job and data source. Guid importId = Guid.NewGuid(); diff --git a/Samples/.Net7ClientConsole/SampleCollection/Sample14_ImportRdoSettings.cs b/Samples/.Net7ClientConsole/SampleCollection/Sample14_DirectImportSettingsForRdo.cs similarity index 94% rename from Samples/.Net7ClientConsole/SampleCollection/Sample14_ImportRdoSettings.cs rename to Samples/.Net7ClientConsole/SampleCollection/Sample14_DirectImportSettingsForRdo.cs index 5c3d5f1..d1cc83e 100644 --- a/Samples/.Net7ClientConsole/SampleCollection/Sample14_ImportRdoSettings.cs +++ b/Samples/.Net7ClientConsole/SampleCollection/Sample14_DirectImportSettingsForRdo.cs @@ -1,4 +1,4 @@ -// +// // © Relativity All Rights Reserved. // @@ -26,9 +26,9 @@ public partial class ImportServiceSample /// NOTE: Existing RDO "Domain" is used in this example. Please insert documents from sample01 first. /// /// A representing the result of the asynchronous operation. - public async Task Sample14_ImportRdoSettings() + public async Task Sample14_DirectImportSettingsForRdo() { - Console.WriteLine($"Running {nameof(Sample14_ImportRdoSettings)}"); + Console.WriteLine($"Running {nameof(Sample14_DirectImportSettingsForRdo)}"); // GUID identifiers for import job and data source. Guid importId = Guid.NewGuid(); diff --git a/Samples/.Net7ClientConsole/SampleCollection/Sample23_GetDataSourceErrors.cs b/Samples/.Net7ClientConsole/SampleCollection/Sample23_GetDataSourceErrors.cs index affb6b1..f91c88e 100644 --- a/Samples/.Net7ClientConsole/SampleCollection/Sample23_GetDataSourceErrors.cs +++ b/Samples/.Net7ClientConsole/SampleCollection/Sample23_GetDataSourceErrors.cs @@ -197,7 +197,7 @@ await ImportJobSampleHelper.WaitImportJobToBeFinished( // Get Item Errors for each source. // GET import-jobs/{importId}/sources/{sourceId}/itemerrors?{start}&{length}" - var getItemErrorUrl = RelativityImportEndpoints.GetImportSourcesItemErrorsUri(workspaceId, importId, sourceId,0 , 20); + var getItemErrorUrl = RelativityImportEndpoints.GetImportSourceItemErrorsUri(workspaceId, importId, sourceId,0 , 20); ValueResponse? valueResponseErrors = await httpClient.GetFromJsonAsync>(getItemErrorUrl); if (valueResponseErrors is {IsSuccess: true}) diff --git a/Samples/KeplerClientConsole/Program.cs b/Samples/KeplerClientConsole/Program.cs index e7ce716..2cd886d 100644 --- a/Samples/KeplerClientConsole/Program.cs +++ b/Samples/KeplerClientConsole/Program.cs @@ -37,7 +37,7 @@ private static void Main(string[] args) // await sampleCollection.Sample06_ImportDocumentsToSelectedFolder(); - // await sampleCollection.Sample07_ImportDocumentSettingsForNatives(); + // await sampleCollection.Sample07_DirectImportSettingsForDocuments(); // await sampleCollection.Sample08_ImportImages(); @@ -45,13 +45,13 @@ private static void Main(string[] args) // await sampleCollection.Sample10_ImportImagesInAppendOverlayMode(); - // await sampleCollection.Sample11_ImportDocumentSettingsForImages(); + // await sampleCollection.Sample11_DirectImportSettingsForImages(); // await sampleCollection.Sample12_ImportRelativityDynamicObject(); // await sampleCollection.Sample13_ImportRdoWithParent(); - // await sampleCollection.Sample14_ImportRdoSettings(); + // await sampleCollection.Sample14_DirectImportSettingsForRdo(); // await sampleCollection.Sample15_ReadImportRdoSettings(); diff --git a/Samples/KeplerClientConsole/SamplesCollection/Sample07_ImportDocumentSettingsForNatives.cs b/Samples/KeplerClientConsole/SamplesCollection/Sample07_DirectImportSettingsForDocuments.cs similarity index 94% rename from Samples/KeplerClientConsole/SamplesCollection/Sample07_ImportDocumentSettingsForNatives.cs rename to Samples/KeplerClientConsole/SamplesCollection/Sample07_DirectImportSettingsForDocuments.cs index d6c0c0c..052a06f 100644 --- a/Samples/KeplerClientConsole/SamplesCollection/Sample07_ImportDocumentSettingsForNatives.cs +++ b/Samples/KeplerClientConsole/SamplesCollection/Sample07_DirectImportSettingsForDocuments.cs @@ -1,4 +1,4 @@ -// +// // © Relativity All Rights Reserved. // @@ -21,9 +21,9 @@ public partial class ImportServiceSample /// Settings to be used to import images. /// /// A representing the result of the asynchronous operation. - public async Task Sample07_ImportDocumentSettingsForNatives() + public async Task Sample07_DirectImportSettingsForDocuments() { - Console.WriteLine($"Running {nameof(Sample07_ImportDocumentSettingsForNatives)}"); + Console.WriteLine($"Running {nameof(Sample07_DirectImportSettingsForDocuments)}"); // GUID identifiers for import job and data source. Guid importId = Guid.NewGuid(); diff --git a/Samples/KeplerClientConsole/SamplesCollection/Sample11_ImportDocumentSettingsForImages.cs b/Samples/KeplerClientConsole/SamplesCollection/Sample11_DirectImportSettingsForImages.cs similarity index 93% rename from Samples/KeplerClientConsole/SamplesCollection/Sample11_ImportDocumentSettingsForImages.cs rename to Samples/KeplerClientConsole/SamplesCollection/Sample11_DirectImportSettingsForImages.cs index 3ec346c..00a67d3 100644 --- a/Samples/KeplerClientConsole/SamplesCollection/Sample11_ImportDocumentSettingsForImages.cs +++ b/Samples/KeplerClientConsole/SamplesCollection/Sample11_DirectImportSettingsForImages.cs @@ -1,4 +1,4 @@ -// +// // © Relativity All Rights Reserved. // @@ -21,9 +21,9 @@ public partial class ImportServiceSample /// Example of creating ImportDocumentSettings for image import manually - without using ImportDocumentSettingsBuilder. /// /// A representing the result of the asynchronous operation. - public async Task Sample11_ImportDocumentSettingsForImages() + public async Task Sample11_DirectImportSettingsForImages() { - Console.WriteLine($"Running {nameof(Sample11_ImportDocumentSettingsForImages)}"); + Console.WriteLine($"Running {nameof(Sample11_DirectImportSettingsForImages)}"); // GUID identifiers for import job and data source. Guid importId = Guid.NewGuid(); diff --git a/Samples/KeplerClientConsole/SamplesCollection/Sample14_ImportRdoSettings.cs b/Samples/KeplerClientConsole/SamplesCollection/Sample14_DirectImportSettingsForRdo.cs similarity index 93% rename from Samples/KeplerClientConsole/SamplesCollection/Sample14_ImportRdoSettings.cs rename to Samples/KeplerClientConsole/SamplesCollection/Sample14_DirectImportSettingsForRdo.cs index fc5de6b..9eadc9a 100644 --- a/Samples/KeplerClientConsole/SamplesCollection/Sample14_ImportRdoSettings.cs +++ b/Samples/KeplerClientConsole/SamplesCollection/Sample14_DirectImportSettingsForRdo.cs @@ -1,4 +1,4 @@ -// +// // © Relativity All Rights Reserved. // @@ -21,9 +21,9 @@ public partial class ImportServiceSample /// NOTE: Existing RDO "Domain" is used in this example. Please insert documents from sample01 first. /// /// A representing the result of the asynchronous operation. - public async Task Sample14_ImportRdoSettings() + public async Task Sample14_DirectImportSettingsForRdo() { - Console.WriteLine($"Running {nameof(Sample14_ImportRdoSettings)}"); + Console.WriteLine($"Running {nameof(Sample14_DirectImportSettingsForRdo)}"); // GUID identifiers for import job and data source. Guid importId = Guid.NewGuid(); diff --git a/Samples/RestSamples/Helpers/EndpointsClass.ps1 b/Samples/RestSamples/Helpers/EndpointsClass.ps1 index e120eee..4e15843 100644 --- a/Samples/RestSamples/Helpers/EndpointsClass.ps1 +++ b/Samples/RestSamples/Helpers/EndpointsClass.ps1 @@ -41,7 +41,7 @@ class Endpoints { return $this.baseAddress + "/import-jobs/$importId/sources" } - [String] importSourceUri($importId, $sourceId){ + [String] importSourceAddUri($importId, $sourceId){ return $this.baseAddress + "/import-jobs/$importId/sources/$sourceId" } @@ -53,7 +53,7 @@ class Endpoints { return $this.baseAddress + "/import-jobs/$importId/sources/$sourceId/progress" } - [String] importSourcesItemErrorsUri($importId, $sourceId){ + [String] importSourceItemErrorsUri($importId, $sourceId){ return $this.baseAddress + "/import-jobs/$importId/sources/$sourceId/itemerrors" } diff --git a/Samples/RestSamples/Helpers/WriteInformationClass.ps1 b/Samples/RestSamples/Helpers/WriteInformationClass.ps1 index 6db77a0..96351b1 100644 --- a/Samples/RestSamples/Helpers/WriteInformationClass.ps1 +++ b/Samples/RestSamples/Helpers/WriteInformationClass.ps1 @@ -23,7 +23,7 @@ class WriteInformation { Write-Information -MessageData "Data source failed due to errors: $jobLevelErrors" -InformationAction Continue } elseif ($state -eq "CompletedWithItemErrors") { - $itemErrorsUri = $global:Endpoints.importSourcesItemErrorsUri($importId, $sourceId) + $itemErrorsUri = $global:Endpoints.importSourceItemErrorsUri($importId, $sourceId) $sourceItemErrorsResponse = $global:WebRequest.callGet($itemErrorsUri) $errors = $sourceItemErrorsResponse."Value"."Errors" | ConvertTo-Json -Depth 10 Write-Information -MessageData "Data source item errors: $errors" -InformationAction Continue diff --git a/Samples/RestSamples/SamplesCollection/sample01-import-native-files.ps1 b/Samples/RestSamples/SamplesCollection/sample01-import-native-files.ps1 index 6237db4..92f026a 100644 --- a/Samples/RestSamples/SamplesCollection/sample01-import-native-files.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample01-import-native-files.ps1 @@ -73,7 +73,7 @@ Context "Sample01 Import native files" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample02-import-documents-in-overlay-mode.ps1 b/Samples/RestSamples/SamplesCollection/sample02-import-documents-in-overlay-mode.ps1 index 8081ca9..b5bea2d 100644 --- a/Samples/RestSamples/SamplesCollection/sample02-import-documents-in-overlay-mode.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample02-import-documents-in-overlay-mode.ps1 @@ -83,7 +83,7 @@ Context "Sample 02 Import documents in overlay mode" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample03-import-from-two-data-sources.ps1 b/Samples/RestSamples/SamplesCollection/sample03-import-from-two-data-sources.ps1 index 3e557c0..920b6a8 100644 --- a/Samples/RestSamples/SamplesCollection/sample03-import-from-two-data-sources.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample03-import-from-two-data-sources.ps1 @@ -57,7 +57,7 @@ Context "Sample03 Import from two data sources" { } Describe "Add Source 01" { - $uri = $global:Endpoints.importSourceUri($importId, $source01Id) + $uri = $global:Endpoints.importSourceAddUri($importId, $source01Id) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFile01Path @@ -81,7 +81,7 @@ Context "Sample03 Import from two data sources" { } Describe "Add Source 02" { - $uri = $global:Endpoints.importSourceUri($importId, $source02Id) + $uri = $global:Endpoints.importSourceAddUri($importId, $source02Id) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFile02Path diff --git a/Samples/RestSamples/SamplesCollection/sample04-add-data-source-to-running-job.ps1 b/Samples/RestSamples/SamplesCollection/sample04-add-data-source-to-running-job.ps1 index fec425a..f3b307a 100644 --- a/Samples/RestSamples/SamplesCollection/sample04-add-data-source-to-running-job.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample04-add-data-source-to-running-job.ps1 @@ -57,7 +57,7 @@ Context "Sample04 Add data source to running import job" { } Describe "Add Source 01" { - $uri = $global:Endpoints.importSourceUri($importId, $source01Id) + $uri = $global:Endpoints.importSourceAddUri($importId, $source01Id) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFile01Path @@ -90,7 +90,7 @@ Context "Sample04 Add data source to running import job" { } Describe "Add Source 02" { - $uri = $global:Endpoints.importSourceUri($importId, $source02Id) + $uri = $global:Endpoints.importSourceAddUri($importId, $source02Id) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFile02Path diff --git a/Samples/RestSamples/SamplesCollection/sample05-import-documents-with-extracted-text.ps1 b/Samples/RestSamples/SamplesCollection/sample05-import-documents-with-extracted-text.ps1 index d7ceaab..5cfcf02 100644 --- a/Samples/RestSamples/SamplesCollection/sample05-import-documents-with-extracted-text.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample05-import-documents-with-extracted-text.ps1 @@ -66,7 +66,7 @@ Context "Sample05 Import documents with extracted text" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample06-import-documents-to-selected-folder.ps1 b/Samples/RestSamples/SamplesCollection/sample06-import-documents-to-selected-folder.ps1 index f855464..ce9bbe4 100644 --- a/Samples/RestSamples/SamplesCollection/sample06-import-documents-to-selected-folder.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample06-import-documents-to-selected-folder.ps1 @@ -59,7 +59,7 @@ Context "Sample06 Import documents to selected folder" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $loadFilePath = $loadFilePath.replace('\','\\') diff --git a/Samples/RestSamples/SamplesCollection/sample07-import-document-settings-for-natives.ps1 b/Samples/RestSamples/SamplesCollection/sample07-direct-import-settings-for-documents.ps1 similarity index 95% rename from Samples/RestSamples/SamplesCollection/sample07-import-document-settings-for-natives.ps1 rename to Samples/RestSamples/SamplesCollection/sample07-direct-import-settings-for-documents.ps1 index 7c418bd..3c71875 100644 --- a/Samples/RestSamples/SamplesCollection/sample07-import-document-settings-for-natives.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample07-direct-import-settings-for-documents.ps1 @@ -11,7 +11,7 @@ $sourceId = New-Guid $global:Endpoints = [Endpoints]::new($workspaceId) $global:WriteInformation = [WriteInformation]::new() -Context "Sample07 Import document settings for natives" { +Context "Sample07 Direct import settings for documents" { Describe "Create job" { $uri = $global:Endpoints.importJobCreateUri($importId) @@ -86,7 +86,7 @@ Context "Sample07 Import document settings for natives" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample08-import-images.ps1 b/Samples/RestSamples/SamplesCollection/sample08-import-images.ps1 index 77e398a..050c42e 100644 --- a/Samples/RestSamples/SamplesCollection/sample08-import-images.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample08-import-images.ps1 @@ -46,7 +46,7 @@ Context "Sample08 Import images" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ Path = $opticonFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample09-import-production-files.ps1 b/Samples/RestSamples/SamplesCollection/sample09-import-production-files.ps1 index d6324dc..1b6c84e 100644 --- a/Samples/RestSamples/SamplesCollection/sample09-import-production-files.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample09-import-production-files.ps1 @@ -47,7 +47,7 @@ Context "Sample09 Import production files" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ Path = $opticonFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample10-import-images-in-append-overlay-mode.ps1 b/Samples/RestSamples/SamplesCollection/sample10-import-images-in-append-overlay-mode.ps1 index 26da296..1badbcd 100644 --- a/Samples/RestSamples/SamplesCollection/sample10-import-images-in-append-overlay-mode.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample10-import-images-in-append-overlay-mode.ps1 @@ -48,7 +48,7 @@ Context "Sample10 Import images in append overlay mode" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ Path = $opticonFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample11-import-document-settings-for-images.ps1 b/Samples/RestSamples/SamplesCollection/sample11-direct-import-settings-for-images.ps1 similarity index 94% rename from Samples/RestSamples/SamplesCollection/sample11-import-document-settings-for-images.ps1 rename to Samples/RestSamples/SamplesCollection/sample11-direct-import-settings-for-images.ps1 index 3585623..10e9125 100644 --- a/Samples/RestSamples/SamplesCollection/sample11-import-document-settings-for-images.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample11-direct-import-settings-for-images.ps1 @@ -11,7 +11,7 @@ $sourceId = New-Guid $global:Endpoints = [Endpoints]::new($workspaceId) $global:WriteInformation = [WriteInformation]::new() -Context "Sample11 Import document settings for images" { +Context "Sample11 Direct import settings for images" { Describe "Create job" { $uri = $global:Endpoints.importJobCreateUri($importId) @@ -57,7 +57,7 @@ Context "Sample11 Import document settings for images" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ Path = $opticonFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample12-import-relativity-dynamic-object.ps1 b/Samples/RestSamples/SamplesCollection/sample12-import-relativity-dynamic-object.ps1 index 036d945..2aaf29a 100644 --- a/Samples/RestSamples/SamplesCollection/sample12-import-relativity-dynamic-object.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample12-import-relativity-dynamic-object.ps1 @@ -75,7 +75,7 @@ Context "Sample12 Import relativity dynamic object" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $loadFilePath = $loadFilePath.replace('\','\\') diff --git a/Samples/RestSamples/SamplesCollection/sample13-import-rdo-with-parent.ps1 b/Samples/RestSamples/SamplesCollection/sample13-import-rdo-with-parent.ps1 index 35d292a..b41fddc 100644 --- a/Samples/RestSamples/SamplesCollection/sample13-import-rdo-with-parent.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample13-import-rdo-with-parent.ps1 @@ -57,7 +57,7 @@ Context "Sample13 Import RDO with parent" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $loadFilePath = $loadFilePath.replace('\','\\') diff --git a/Samples/RestSamples/SamplesCollection/sample14-import-rdo-settings.ps1 b/Samples/RestSamples/SamplesCollection/sample14-direct-import-settings-for-rdo.ps1 similarity index 95% rename from Samples/RestSamples/SamplesCollection/sample14-import-rdo-settings.ps1 rename to Samples/RestSamples/SamplesCollection/sample14-direct-import-settings-for-rdo.ps1 index cef2dc1..9baa893 100644 --- a/Samples/RestSamples/SamplesCollection/sample14-import-rdo-settings.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample14-direct-import-settings-for-rdo.ps1 @@ -13,7 +13,7 @@ $global:WriteInformation = [WriteInformation]::new() # Example of import Relativity Dynamic Object (RDO). # NOTE: Existing RDO "Domain" is used in this example. Please insert documents from sample01 first. -Context "Sample14 Import RDO settings" { +Context "Sample14 Direct import settings for RDO" { Describe "Create job" { $uri = $global:Endpoints.importJobCreateUri($importId) @@ -80,7 +80,7 @@ Context "Sample14 Import RDO settings" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample18-get-data-source.ps1 b/Samples/RestSamples/SamplesCollection/sample18-get-data-source.ps1 index a0c66ce..c7814da 100644 --- a/Samples/RestSamples/SamplesCollection/sample18-get-data-source.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample18-get-data-source.ps1 @@ -61,7 +61,7 @@ Context "Sample18 Read Data sources for Import Job" { Describe "Add n data sources to the existing job." { for ($i = 0; $i -lt $sourcesCount; $i++) { $sourceId = New-Guid - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFilePath + $i diff --git a/Samples/RestSamples/SamplesCollection/sample19-get-import-job-details-and-progress.ps1 b/Samples/RestSamples/SamplesCollection/sample19-get-import-job-details-and-progress.ps1 index d902fb9..3b27c9c 100644 --- a/Samples/RestSamples/SamplesCollection/sample19-get-import-job-details-and-progress.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample19-get-import-job-details-and-progress.ps1 @@ -71,7 +71,7 @@ Context "Sample19 Get import job progress" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample20-get-data-source-details-and-progress.ps1 b/Samples/RestSamples/SamplesCollection/sample20-get-data-source-details-and-progress.ps1 index 11e4569..2084d8d 100644 --- a/Samples/RestSamples/SamplesCollection/sample20-get-data-source-details-and-progress.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample20-get-data-source-details-and-progress.ps1 @@ -73,7 +73,7 @@ Context "Sample20 Get data source details" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample21-cancel-started-job.ps1 b/Samples/RestSamples/SamplesCollection/sample21-cancel-started-job.ps1 index b742c2e..8bd62c8 100644 --- a/Samples/RestSamples/SamplesCollection/sample21-cancel-started-job.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample21-cancel-started-job.ps1 @@ -60,7 +60,7 @@ Context "Sample21 Cancel stared Job" { for ($i = 0; $i -lt $sourcesCount; $i++) { $sourceId = New-Guid - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ diff --git a/Samples/RestSamples/SamplesCollection/sample22-read-response.ps1 b/Samples/RestSamples/SamplesCollection/sample22-read-response.ps1 index f9153e7..7106318 100644 --- a/Samples/RestSamples/SamplesCollection/sample22-read-response.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample22-read-response.ps1 @@ -39,7 +39,7 @@ Context "Sample22 Read response with errors" { } Describe "Add Source" { - $uri = $global:Endpoints.importSourceUri($importId, $sourceId) + $uri = $global:Endpoints.importSourceAddUri($importId, $sourceId) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFilePath diff --git a/Samples/RestSamples/SamplesCollection/sample23-get-data-source-errors.ps1 b/Samples/RestSamples/SamplesCollection/sample23-get-data-source-errors.ps1 index c94f71f..43aaf2a 100644 --- a/Samples/RestSamples/SamplesCollection/sample23-get-data-source-errors.ps1 +++ b/Samples/RestSamples/SamplesCollection/sample23-get-data-source-errors.ps1 @@ -74,7 +74,7 @@ Context "Sample23 Get Data Source errors" { } Describe "Add Source 01" { - $uri = $global:Endpoints.importSourceUri($importId, $source01Id) + $uri = $global:Endpoints.importSourceAddUri($importId, $source01Id) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFile01Path @@ -98,7 +98,7 @@ Context "Sample23 Get Data Source errors" { } Describe "Add Source 02" { - $uri = $global:Endpoints.importSourceUri($importId, $source02Id) + $uri = $global:Endpoints.importSourceAddUri($importId, $source02Id) $dataSourceConfigurationBody = @{ dataSourceSettings = @{ path = $loadFile02Path diff --git a/Samples/RestSamples/run-sample-Import.ps1 b/Samples/RestSamples/run-sample-import.ps1 similarity index 82% rename from Samples/RestSamples/run-sample-Import.ps1 rename to Samples/RestSamples/run-sample-import.ps1 index 30d98c2..e30b705 100644 --- a/Samples/RestSamples/run-sample-Import.ps1 +++ b/Samples/RestSamples/run-sample-import.ps1 @@ -10,6 +10,9 @@ $password = "password!" $global:Auth = [Auth]::new($hostAddress, $userName, $password) $global:WebRequest = [WebRequest]::new($global:Auth) +# Uncomment the samples you wish to run: +# NOTE: Copy sample source files into destination location. + Describe "Sample import" { . "$global:rootDir\SamplesCollection\sample01-import-native-files.ps1" @@ -23,7 +26,7 @@ Describe "Sample import" { # . "$global:rootDir\SamplesCollection\sample06-import-documents-to-selected-folder.ps1" - # . "$global:rootDir\SamplesCollection\sample07-import-document-settings-for-natives.ps1" + # . "$global:rootDir\SamplesCollection\sample07-direct-import-settings-for-documents.ps1" # . "$global:rootDir\SamplesCollection\sample08-import-images.ps1" @@ -31,13 +34,13 @@ Describe "Sample import" { # . "$global:rootDir\SamplesCollection\sample10-import-images-in-append-overlay-mode.ps1" - # . "$global:rootDir\SamplesCollection\sample11-import-document-settings-for-images.ps1" + # . "$global:rootDir\SamplesCollection\sample11-direct-import-settings-for-images.ps1" # . "$global:rootDir\SamplesCollection\sample12-import-relativity-dynamic-object.ps1" # . "$global:rootDir\SamplesCollection\sample13-import-rdo-with-parent.ps1" - # . "$global:rootDir\SamplesCollection\sample14-import-rdo-settings.ps1" + # . "$global:rootDir\SamplesCollection\sample14-direct-import-settings-for-rdo.ps1" # . "$global:rootDir\SamplesCollection\sample15-read-import-rdo-settings.ps1"