From 0682085a18db524924aa9d1d79f2fe24488ea4bb Mon Sep 17 00:00:00 2001 From: Robert Basti Date: Tue, 22 Oct 2024 13:08:02 +0200 Subject: [PATCH 1/6] doc --- Docs/deep_linking.md | 78 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 ++ 2 files changed, 81 insertions(+) create mode 100644 Docs/deep_linking.md diff --git a/Docs/deep_linking.md b/Docs/deep_linking.md new file mode 100644 index 000000000..2f50f4f1e --- /dev/null +++ b/Docs/deep_linking.md @@ -0,0 +1,78 @@ +# URL structure for deeplinking + + This describes the structure of the URL so that it is easy for developers to create deep links from other applications directly to a well/wellbore/object/curve data etc. + +## Common parameters: +### objectGroup + +This paramater can have values: + - BhaRun + - ChangeLog + - FluidsReport + - FormationMarker + - Message + - MudLog + - Log + - Rig + - Risk + - Trajectory + - Tubular + - WbGeometry + +### logType + +This paramater can have values: + - time + - depth + +### filterType + +This paramater can have values: + - Log + - Group + - ServiceCompany + +## Navigation paths: + +### Wells View +/servers/:serverUrl/wells + +### Wellbores View +/servers/:serverUrl/wells/:wellUid/wellbores + +### Object Groups +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups + +### Objects View +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/objects + +### Object View +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/objects/:objectUid + +### Log Types View +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes + +### Log Objects View +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid + +### Log Object View +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid/curvevalues + +### Log Curve Values View +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid/curvevalues + +### Multi Logs Curve Info List View +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs" + +### Multi Logs Curve Values +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs/curvevalues" + +### Jobs View +/servers/:serverUrl/jobs + +### Query View +/servers/:serverUrl/query + +### Search View +/servers/:serverUrl/search/:filterType + diff --git a/README.md b/README.md index 22f6ee4c7..f7741d8cc 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,9 @@ Please visit [API client access](/Docs/APICLIENT.md). ## Enable HTTP WITSML servers Please see [enable HTTP](/Docs/enable_http.md). +## URL structure for deeplinking +Please see [enable HTTP](/Docs/deep_linking.md). + ## Community Please read and respect the [CODE OF CONDUCT](/CODE_OF_CONDUCT.md) From e6c8c253e7a4069d1d745b239b6750f167bbbb28 Mon Sep 17 00:00:00 2001 From: Robert Basti Date: Wed, 23 Oct 2024 14:54:28 +0200 Subject: [PATCH 2/6] test --- Docs/deep_linking.md | 99 ++++++++++++++++++++++++++++++++++++++++++-- README.md | 2 +- 2 files changed, 96 insertions(+), 5 deletions(-) diff --git a/Docs/deep_linking.md b/Docs/deep_linking.md index 2f50f4f1e..f89cf6e72 100644 --- a/Docs/deep_linking.md +++ b/Docs/deep_linking.md @@ -2,6 +2,10 @@ This describes the structure of the URL so that it is easy for developers to create deep links from other applications directly to a well/wellbore/object/curve data etc. +## Paramemter encoding: + +All server and uid parameters must be URL encoded. + ## Common parameters: ### objectGroup @@ -28,9 +32,10 @@ This paramater can have values: ### filterType This paramater can have values: + - Wellbore - Log - - Group - - ServiceCompany + - Rig + - Service%20Company ## Navigation paths: @@ -53,20 +58,106 @@ This paramater can have values: /servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes ### Log Objects View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects ### Log Object View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid/curvevalues +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid + +### Filtering Rows Of Views + +Most pages can receive a filter to filter the rows of the table in that page. Those filters are added at the end of the url. +For example showing only rows where parameter "name" has value "test": + +?filter={"name":"test"} + +Url encoded version which needs to be used: + +%3Ffilter%3D%7B%22name%22%3A%22test%22%7D + ### Log Curve Values View /servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid/curvevalues +#### Additional params for searching + +If there is a need to search in result, following parameters need to be filled up: + + - startIndex + - endIndex + - mnemonics + +StartIndex and endIndex could be numbers for depth based logs or datetime in ISO format - "YYYY-MM-DDTHH:mm:ss.sssZ" for time based logs + +Samples: + +##### Time sample: +?startIndex=2024-09-06T00:00:00Z&endIndex=2024-09-06T00:01:00Z&mnemonics=["mnem1","mnem2","mnem3","mnem4"] + +url encoded version which should be used: +%3FstartIndex%3D2024-09-06T00%3A00%3A00Z%26endIndex%3D2024-09-06T00%3A01%3A00Z%26mnemonics%3D%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D + +In the sample above we combine mnemonics "mmem1", "mmem2", "mmem3", "mmen4" for the selected time interval + +##### Depth sample: + +?startIndex=1&endIndex=4&mnemonics=["mnem1","mnem2","mnem3","mnem4"] + +url encoded version which should be used: +%3FstartIndex%3D1%26endIndex%3D4%26mnemonics%3D%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D + ### Multi Logs Curve Info List View /servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs" + +#### Additional params for searching + +If there is a need to search in result, following parameter needs to be filled up: + + - logs + +StartIndex and endIndex could be numbers for depth based logs or datetime in ISO format - "YYYY-MM-DDTHH:mm:ss.sssZ" for time based logs + +Sample: + +?logs=["323f827b-c849-4b14-a1c3-ba207848f29c","701f5f00-bdb5-4937-8350-1975240ce432"] + +and url-encoded version, which should be used: + +?logs=%5B%22323f827b-c849-4b14-a1c3-ba207848f29c%22%2C%22701f5f00-bdb5-4937-8350-1975240ce432%22%5D + +In the sample above we combine 2 logs with uid "323f827b-c849-4b14-a1c3-ba207848f29c" and with uid "701f5f00-bdb5-4937-8350-1975240ce432". + + ### Multi Logs Curve Values /servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs/curvevalues" +#### Additional params for searching + +If there is a need to search in result, following parameters need to be filled up: + + - startIndex + - endIndex + - mnemonics + +StartIndex and endIndex could be numbers for depth based logs or datetime in ISO format - "YYYY-MM-DDTHH:mm:ss.sssZ" for time based logs + +Samples: + +##### Time sample: +?startIndex=2024-09-06T00:00:00.000Z&endIndex=2024-09-06T00:01:00.000Z&mnemonics={"323f827b-c849-4b14-a1c3-ba207848f29c":["mnem1"],"701f5f00-bdb5-4937-8350-1975240ce432":["mnem2"]} + +url encoded version which should be used: +%3FstartIndex%3D2024-09-06T00%3A00%3A00.000Z%26endIndex%3D2024-09-06T00%3A01%3A00.000Z%26mnemonics%3D%7B%22323f827b-c849-4b14-a1c3-ba207848f29c%22%3A%5B%22mnem1%22%5D%2C%22701f5f00-bdb5-4937-8350-1975240ce432%22%3A%5B%22mnem2%22%5D%7D + +In the sample above we combine mnemonics "mmem1" from log with uid "323f827b-c849-4b14-a1c3-ba207848f29c" and "mmem2" from log with uid "701f5f00-bdb5-4937-8350-1975240ce432". + +##### Depth sample: + +?1&endIndex=4&mnemonics={"55823e08-6232-43a8-8e77713bc469-6674":["mnem3"],"bc498d56-84f6-4c63-b1af-d845be3e6961":["mnem4"]} + +url encoded version which should be used: +%3F1%26endIndex%3D4%26mnemonics%3D%7B%2255823e08-6232-43a8-8e77713bc469-6674%22%3A%5B%22mnem3%22%5D%2C%22bc498d56-84f6-4c63-b1af-d845be3e6961%22%3A%5B%22mnem4%22%5D%7D + ### Jobs View /servers/:serverUrl/jobs diff --git a/README.md b/README.md index f7741d8cc..efe26acee 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Please visit [API client access](/Docs/APICLIENT.md). Please see [enable HTTP](/Docs/enable_http.md). ## URL structure for deeplinking -Please see [enable HTTP](/Docs/deep_linking.md). +Please see [deep linking](/Docs/deep_linking.md). ## Community Please read and respect the [CODE OF CONDUCT](/CODE_OF_CONDUCT.md) From 47a68df4bbaaa6cd850c5d0fb3a2e1945f9ae479 Mon Sep 17 00:00:00 2001 From: Robert Basti Date: Wed, 23 Oct 2024 19:10:43 +0200 Subject: [PATCH 3/6] test --- Docs/deep_linking.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/Docs/deep_linking.md b/Docs/deep_linking.md index f89cf6e72..2f190970b 100644 --- a/Docs/deep_linking.md +++ b/Docs/deep_linking.md @@ -72,15 +72,15 @@ For example showing only rows where parameter "name" has value "test": Url encoded version which needs to be used: -%3Ffilter%3D%7B%22name%22%3A%22test%22%7D +?filter=%7B%22name%22%3A%22test%22%7D ### Log Curve Values View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid/curvevalues +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid/curvevalues?startIndex=&endIndex=&mnemonics= -#### Additional params for searching +#### Additional params for limiting the data to the given range and mnemonics -If there is a need to search in result, following parameters need to be filled up: +If there is a need to limit the data in result, following parameters need to be filled up: - startIndex - endIndex @@ -94,7 +94,8 @@ Samples: ?startIndex=2024-09-06T00:00:00Z&endIndex=2024-09-06T00:01:00Z&mnemonics=["mnem1","mnem2","mnem3","mnem4"] url encoded version which should be used: -%3FstartIndex%3D2024-09-06T00%3A00%3A00Z%26endIndex%3D2024-09-06T00%3A01%3A00Z%26mnemonics%3D%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D + +?startIndex=2024-09-06T00%3A00%3A00Z&endIndex=2024-09-06T00%3A01%3A00Z&mnemonics=%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D In the sample above we combine mnemonics "mmem1", "mmem2", "mmem3", "mmen4" for the selected time interval @@ -103,15 +104,15 @@ In the sample above we combine mnemonics "mmem1", "mmem2", "mmem3", "mmen4" for ?startIndex=1&endIndex=4&mnemonics=["mnem1","mnem2","mnem3","mnem4"] url encoded version which should be used: -%3FstartIndex%3D1%26endIndex%3D4%26mnemonics%3D%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D +?startIndex=1&endIndex=5&mnemonics=%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D ### Multi Logs Curve Info List View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs" +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs?logs= -#### Additional params for searching +#### Additional params for limiting the data in result -If there is a need to search in result, following parameter needs to be filled up: +If there is a need to limit the in result, following parameter needs to be filled up: - logs @@ -129,11 +130,11 @@ In the sample above we combine 2 logs with uid "323f827b-c849-4b14-a1c3-ba207848 ### Multi Logs Curve Values -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs/curvevalues" +/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs/curvevalues?startIndex=&endIndex=&mnemonics= -#### Additional params for searching +#### Additional params for limiting the data in result -If there is a need to search in result, following parameters need to be filled up: +If there is a need to limit the data in result, following parameters need to be filled up: - startIndex - endIndex @@ -147,16 +148,17 @@ Samples: ?startIndex=2024-09-06T00:00:00.000Z&endIndex=2024-09-06T00:01:00.000Z&mnemonics={"323f827b-c849-4b14-a1c3-ba207848f29c":["mnem1"],"701f5f00-bdb5-4937-8350-1975240ce432":["mnem2"]} url encoded version which should be used: -%3FstartIndex%3D2024-09-06T00%3A00%3A00.000Z%26endIndex%3D2024-09-06T00%3A01%3A00.000Z%26mnemonics%3D%7B%22323f827b-c849-4b14-a1c3-ba207848f29c%22%3A%5B%22mnem1%22%5D%2C%22701f5f00-bdb5-4937-8350-1975240ce432%22%3A%5B%22mnem2%22%5D%7D + +?startIndex=2024-09-06T00%3A00%3A00.000Z&endIndex=2024-09-06T00%3A01%3A00.000Z&mnemonics=%7B%22323f827b-c849-4b14-a1c3-ba207848f29c%22%3A%5B%22mnem1%22%5D%2C%22701f5f00-bdb5-4937-8350-1975240ce432%22%3A%5B%22mnem2%22%5D%7D In the sample above we combine mnemonics "mmem1" from log with uid "323f827b-c849-4b14-a1c3-ba207848f29c" and "mmem2" from log with uid "701f5f00-bdb5-4937-8350-1975240ce432". ##### Depth sample: -?1&endIndex=4&mnemonics={"55823e08-6232-43a8-8e77713bc469-6674":["mnem3"],"bc498d56-84f6-4c63-b1af-d845be3e6961":["mnem4"]} +?startIndex=1&endIndex=4&mnemonics={"55823e08-6232-43a8-8e77713bc469-6674":["mnem3"],"bc498d56-84f6-4c63-b1af-d845be3e6961":["mnem4"]} url encoded version which should be used: -%3F1%26endIndex%3D4%26mnemonics%3D%7B%2255823e08-6232-43a8-8e77713bc469-6674%22%3A%5B%22mnem3%22%5D%2C%22bc498d56-84f6-4c63-b1af-d845be3e6961%22%3A%5B%22mnem4%22%5D%7D +?startIndex=1&endIndex=4&mnemonics=%7B%2255823e08-6232-43a8-8e77713bc469-6674%22%3A%5B%22mnem3%22%5D%2C%22bc498d56-84f6-4c63-b1af-d845be3e6961%22%3A%5B%22mnem4%22%5D%7D%0A ### Jobs View /servers/:serverUrl/jobs From 48b6572d9986a4a982a5d19f34bc814595cf4a3e Mon Sep 17 00:00:00 2001 From: Robert Basti Date: Wed, 23 Oct 2024 19:24:40 +0200 Subject: [PATCH 4/6] fix --- Docs/deep_linking.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Docs/deep_linking.md b/Docs/deep_linking.md index 2f190970b..3ba96798c 100644 --- a/Docs/deep_linking.md +++ b/Docs/deep_linking.md @@ -86,7 +86,8 @@ If there is a need to limit the data in result, following parameters need to be - endIndex - mnemonics -StartIndex and endIndex could be numbers for depth based logs or datetime in ISO format - "YYYY-MM-DDTHH:mm:ss.sssZ" for time based logs +StartIndex and endIndex could be numbers for depth based logs or datetime in ISO format - "YYYY-MM-DDTHH:mm:ss.sssZ" for time based logs. +Note that full url should not exceed the maximum url length accepted by most browsers - in Witsml Explorer we support maximum 2000 characters. Samples: From b27ed1937b387130e8c55b95af64e232e8341967 Mon Sep 17 00:00:00 2001 From: Robert Basti Date: Thu, 24 Oct 2024 09:36:32 +0200 Subject: [PATCH 5/6] test --- Docs/deep_linking.md | 62 +++++++++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 24 deletions(-) diff --git a/Docs/deep_linking.md b/Docs/deep_linking.md index 3ba96798c..17556d8f7 100644 --- a/Docs/deep_linking.md +++ b/Docs/deep_linking.md @@ -40,43 +40,52 @@ This paramater can have values: ## Navigation paths: ### Wells View -/servers/:serverUrl/wells + +```/servers/:serverUrl/wells``` ### Wellbores View -/servers/:serverUrl/wells/:wellUid/wellbores + +```/servers/:serverUrl/wells/:wellUid/wellbores``` ### Object Groups -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups + +```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups``` ### Objects View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/objects + +```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/objects``` ### Object View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/objects/:objectUid + +```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/objects/:objectUid``` ### Log Types View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes + +```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes``` ### Log Objects View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects + +```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects``` ### Log Object View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid + +```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid``` ### Filtering Rows Of Views Most pages can receive a filter to filter the rows of the table in that page. Those filters are added at the end of the url. For example showing only rows where parameter "name" has value "test": -?filter={"name":"test"} +```?filter={"name":"test"}``` Url encoded version which needs to be used: -?filter=%7B%22name%22%3A%22test%22%7D +```?filter=%7B%22name%22%3A%22test%22%7D``` ### Log Curve Values View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid/curvevalues?startIndex=&endIndex=&mnemonics= + +```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/objects/:objectUid/curvevalues?startIndex=&endIndex=&mnemonics=``` #### Additional params for limiting the data to the given range and mnemonics @@ -92,23 +101,26 @@ Note that full url should not exceed the maximum url length accepted by most bro Samples: ##### Time sample: -?startIndex=2024-09-06T00:00:00Z&endIndex=2024-09-06T00:01:00Z&mnemonics=["mnem1","mnem2","mnem3","mnem4"] + +```?startIndex=2024-09-06T00:00:00Z&endIndex=2024-09-06T00:01:00Z&mnemonics=["mnem1","mnem2","mnem3","mnem4"]``` url encoded version which should be used: -?startIndex=2024-09-06T00%3A00%3A00Z&endIndex=2024-09-06T00%3A01%3A00Z&mnemonics=%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D +```?startIndex=2024-09-06T00%3A00%3A00Z&endIndex=2024-09-06T00%3A01%3A00Z&mnemonics=%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D``` In the sample above we combine mnemonics "mmem1", "mmem2", "mmem3", "mmen4" for the selected time interval ##### Depth sample: -?startIndex=1&endIndex=4&mnemonics=["mnem1","mnem2","mnem3","mnem4"] +```?startIndex=1&endIndex=4&mnemonics=["mnem1","mnem2","mnem3","mnem4"]``` url encoded version which should be used: -?startIndex=1&endIndex=5&mnemonics=%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D + +```?startIndex=1&endIndex=5&mnemonics=%5B%22mnem1%22%2C%22mnem2%22%2C%22mnem3%22%2C%22mnem4%22%5D``` ### Multi Logs Curve Info List View -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs?logs= + +```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs?logs=``` #### Additional params for limiting the data in result @@ -121,17 +133,18 @@ StartIndex and endIndex could be numbers for depth based logs or datetime in ISO Sample: -?logs=["323f827b-c849-4b14-a1c3-ba207848f29c","701f5f00-bdb5-4937-8350-1975240ce432"] +```?logs=["323f827b-c849-4b14-a1c3-ba207848f29c","701f5f00-bdb5-4937-8350-1975240ce432"]``` and url-encoded version, which should be used: -?logs=%5B%22323f827b-c849-4b14-a1c3-ba207848f29c%22%2C%22701f5f00-bdb5-4937-8350-1975240ce432%22%5D +```?logs=%5B%22323f827b-c849-4b14-a1c3-ba207848f29c%22%2C%22701f5f00-bdb5-4937-8350-1975240ce432%22%5D``` In the sample above we combine 2 logs with uid "323f827b-c849-4b14-a1c3-ba207848f29c" and with uid "701f5f00-bdb5-4937-8350-1975240ce432". ### Multi Logs Curve Values -/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs/curvevalues?startIndex=&endIndex=&mnemonics= + +```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs/curvevalues?startIndex=&endIndex=&mnemonics=``` #### Additional params for limiting the data in result @@ -146,20 +159,22 @@ StartIndex and endIndex could be numbers for depth based logs or datetime in ISO Samples: ##### Time sample: -?startIndex=2024-09-06T00:00:00.000Z&endIndex=2024-09-06T00:01:00.000Z&mnemonics={"323f827b-c849-4b14-a1c3-ba207848f29c":["mnem1"],"701f5f00-bdb5-4937-8350-1975240ce432":["mnem2"]} + +```?startIndex=2024-09-06T00:00:00.000Z&endIndex=2024-09-06T00:01:00.000Z&mnemonics={"323f827b-c849-4b14-a1c3-ba207848f29c":["mnem1"],"701f5f00-bdb5-4937-8350-1975240ce432":["mnem2"]}``` url encoded version which should be used: -?startIndex=2024-09-06T00%3A00%3A00.000Z&endIndex=2024-09-06T00%3A01%3A00.000Z&mnemonics=%7B%22323f827b-c849-4b14-a1c3-ba207848f29c%22%3A%5B%22mnem1%22%5D%2C%22701f5f00-bdb5-4937-8350-1975240ce432%22%3A%5B%22mnem2%22%5D%7D +```?startIndex=2024-09-06T00%3A00%3A00.000Z&endIndex=2024-09-06T00%3A01%3A00.000Z&mnemonics=%7B%22323f827b-c849-4b14-a1c3-ba207848f29c%22%3A%5B%22mnem1%22%5D%2C%22701f5f00-bdb5-4937-8350-1975240ce432%22%3A%5B%22mnem2%22%5D%7D``` In the sample above we combine mnemonics "mmem1" from log with uid "323f827b-c849-4b14-a1c3-ba207848f29c" and "mmem2" from log with uid "701f5f00-bdb5-4937-8350-1975240ce432". ##### Depth sample: -?startIndex=1&endIndex=4&mnemonics={"55823e08-6232-43a8-8e77713bc469-6674":["mnem3"],"bc498d56-84f6-4c63-b1af-d845be3e6961":["mnem4"]} +```?startIndex=1&endIndex=4&mnemonics={"55823e08-6232-43a8-8e77713bc469-6674":["mnem3"],"bc498d56-84f6-4c63-b1af-d845be3e6961":["mnem4"]}``` url encoded version which should be used: -?startIndex=1&endIndex=4&mnemonics=%7B%2255823e08-6232-43a8-8e77713bc469-6674%22%3A%5B%22mnem3%22%5D%2C%22bc498d56-84f6-4c63-b1af-d845be3e6961%22%3A%5B%22mnem4%22%5D%7D%0A + +```?startIndex=1&endIndex=4&mnemonics=%7B%2255823e08-6232-43a8-8e77713bc469-6674%22%3A%5B%22mnem3%22%5D%2C%22bc498d56-84f6-4c63-b1af-d845be3e6961%22%3A%5B%22mnem4%22%5D%7D%0A``` ### Jobs View /servers/:serverUrl/jobs @@ -169,4 +184,3 @@ url encoded version which should be used: ### Search View /servers/:serverUrl/search/:filterType - From ee777ce90ad9910e668235cafb2025c019cfc16c Mon Sep 17 00:00:00 2001 From: Robert Basti Date: Thu, 24 Oct 2024 10:16:47 +0200 Subject: [PATCH 6/6] test --- Docs/deep_linking.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/Docs/deep_linking.md b/Docs/deep_linking.md index 17556d8f7..9dfc77a3e 100644 --- a/Docs/deep_linking.md +++ b/Docs/deep_linking.md @@ -123,13 +123,9 @@ url encoded version which should be used: ```/servers/:serverUrl/wells/:wellUid/wellbores/:wellboreUid/objectgroups/:objectGroup/logtypes/:logType/multilogs?logs=``` -#### Additional params for limiting the data in result - -If there is a need to limit the in result, following parameter needs to be filled up: +#### Additional params to specify which logs to combine - - logs - -StartIndex and endIndex could be numbers for depth based logs or datetime in ISO format - "YYYY-MM-DDTHH:mm:ss.sssZ" for time based logs +The logs param must be used to specify which logs should be combined in the multi-log view Sample: @@ -177,10 +173,13 @@ url encoded version which should be used: ```?startIndex=1&endIndex=4&mnemonics=%7B%2255823e08-6232-43a8-8e77713bc469-6674%22%3A%5B%22mnem3%22%5D%2C%22bc498d56-84f6-4c63-b1af-d845be3e6961%22%3A%5B%22mnem4%22%5D%7D%0A``` ### Jobs View -/servers/:serverUrl/jobs + +```/servers/:serverUrl/jobs``` ### Query View -/servers/:serverUrl/query + +```/servers/:serverUrl/query``` ### Search View -/servers/:serverUrl/search/:filterType + +```/servers/:serverUrl/search/:filterType```