Introduction
This documentation describes Solo REST API which provides access to Solo objects. Using Solo REST API, you can easily create your own powerful integration.
Your use of the Solo REST API is subject to this License Agreement
Access Solo REST API
To access Solo REST API you must issue token.
API URL
Once you have a token you can use this URL to access Solo objects. Pass the token in the Authorization: Bearer <access_token> header of every request.
https://solo.cloud/public/api/v1/
Solo objects
Solo objects in Solo REST API are presented in the same hierarchy as is Starsteer. The top level is Project, with the following structure:
- Project
- Lateral
- Interpretation
- Horizon
- Earth model
- Nested well (PAPI term for Well Plan)
- Topset
- Top
- Event group
- Event
- Topset
- Log
- Image log
- Mudlog
- Topset
- Top
- Image
- Target line
- Comment
- Comment box
- Completion
- Folder
- Hole section
- BHA run
- Torque and drag model
- Casing
- Torque and drag model
- Roadmap
- Daily drilling report
- Operation
- Summary
- Mud check
- Event group
- Event
- Interpretation
- Typewell
- Log
- Mudlog
- Topset
- Top
- Completion
- Folder
- Event group
- Event
- Event category
- Grid
- Polygon
- Stick
- Log family
- Reference list
- Lateral
Double values
Has a value
HTTP/1.1 200 OK
"data" : {
"val" : 16.581
}
Not a number value
HTTP/1.1 200 OK
"data" : {
"undefined": true
}
Double value consists of two fields:
val- field holds a valueundefined- field which istrueif a value is not a number value
A response contains only one of the two fields. In requests, send {"undefined": true} for a not a number value. Most endpoints also treat an object without val as a not a number value, but image log data upload rejects it with 400.
Paging
HTTP/1.1 200 OK
{
"content" : [ ],
"offset" : 0,
"limit" : 20,
"first" : true,
"last" : true,
"total" : 3
}
Many of the Solo REST API endpoints return a pageable structure:
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
total |
Number |
Total number of records |
The range is set by the offset and limit query parameters, most paged endpoints require both of them and reject a request without them with 400. A negative offset is treated as 0, a limit of 0 or less means the default of 100, and a limit above the server maximum (200 by default) is reduced to that maximum. The response returns the applied offset and limit, read the next range until last is true. For trial companies some lists return only the first 50 records, and total is capped accordingly.
0. Authentication
Issue token
Authentication using OAuth 2.0. Get an access token with grant_type=password and get a new one with grant_type=refresh_token when it expires (see expires_in). Pass the access token in the Authorization: Bearer <access_token> header of every API request. A rejected token request returns 401 (wrong credentials, client or grant) or 403 (access denied) with an OAuth 2.0 error body: error, error_description and, when known, type and message
Request
$ curl 'https://solo.cloud/oauth/token' -i -u 'solo-api-client-id:solo-api-secret' -X POST \
-H 'Content-Type: application/x-www-form-urlencoded; charset=ISO-8859-1' \
-d 'grant_type=password&username=test%2Bapi%40test.com&password=password'
POST /oauth/token HTTP/1.1
Authorization: Basic c29sby1hcGktY2xpZW50LWlkOnNvbG8tYXBpLXNlY3JldA==
Content-Type: application/x-www-form-urlencoded; charset=ISO-8859-1
Host: solo.cloud
grant_type=password&username=test%2Bapi%40test.com&password=password
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 1a0aa2b91ae5bf7bd62541b7adeda070
X-Solo-Device-Identifier: PPsqW32/Dk/9yiiefsKqxpdojptQ4H3gR9yBimLdR4bc45BlI+0qFaYVc78eqqnIE5vG+gr3PvXg0BUHjcCiYg==
Set-Cookie: device-identifier=PPsqW32/Dk/9yiiefsKqxpdojptQ4H3gR9yBimLdR4bc45BlI+0qFaYVc78eqqnIE5vG+gr3PvXg0BUHjcCiYg==; Domain=rogii.net; Path=/auth/api/v2; HttpOnly; SameSite=Strict
Set-Cookie: SESSION=NDk5NjE2MDUtMmQwOS00MWE1LWJhMDYtOTBjMzBmNGViZWU1; Max-Age=2147483647; Expires=Sat, 4 Dec 2094 10:40:43 GMT; Path=/; HttpOnly; SameSite=Strict
Set-Cookie: SSO-SESSION=NDk5NjE2MDUtMmQwOS00MWE1LWJhMDYtOTBjMzBmNGViZWU1; Max-Age=2147483647; Expires=Sat, 4 Dec 2094 10:40:43 GMT; Domain=rogii.com; Path=/; HttpOnly; SameSite=Strict
Set-Cookie: SSO-SESSION=NDk5NjE2MDUtMmQwOS00MWE1LWJhMDYtOTBjMzBmNGViZWU1; Max-Age=2147483647; Expires=Sat, 4 Dec 2094 10:40:43 GMT; Domain=solo.cloud; Path=/; HttpOnly; SameSite=Strict
Set-Cookie: SSO-SESSION=NDk5NjE2MDUtMmQwOS00MWE1LWJhMDYtOTBjMzBmNGViZWU1; Max-Age=2147483647; Expires=Sat, 4 Dec 2094 10:40:43 GMT; Domain=testsolo.rogii.net; Path=/; HttpOnly; SameSite=Strict
Authorization: 49961605-2d09-41a5-ba06-90c30f4ebee5
Content-Type: application/json;charset=UTF-8
{
"access_token" : "eyJraWQiOiJvRDd2aGVEcUJ6RWh2R0RGUDBZYy1Gc0hQS3lDS0lfYWhZRU83NFBQRVdnIiwiYWxnIjoiUlMyNTYifQ.eyJjb21wYW55X2lkIjoyMDAwMywiY2xpZW50X2FwcF9pZCI6InBhcGkiLCJwZXJzb25fdHlwZSI6IlNUQUZGIiwidXNlcl9uYW1lIjoidGVzdCthcGlAdGVzdC5jb20iLCJjbGllbnRfaW5pdF9pcCI6IjEwLjQyLjAuMTc2IiwiaXNzIjoiaHR0cHM6Ly9sb3NvbG8tc3NvLnJvZ2lpLm5ldCIsInVzZXJfZGlnZXN0IjoiOGI5ZWVhMzc3NyIsImF1dGhvcml0aWVzIjpbIlJPTEVfU1RBRkYiXSwiY2xpZW50X2lkIjoic29sby1hcGktY2xpZW50LWlkIiwiYXVkIjoic29sby1wdWJsaWMtYXBpIiwidXNlcl9pZCI6MTQ5Nywic2NvcGUiOlsicmVhZCJdLCJleHAiOjE3OTQ4MjM5OTYsImlhdCI6MTc5NDgxMzk5NiwianRpIjoiYjE4NjM4ZDMtNGZkZi00MDliLTkwYzUtMDc5NmI4OWEyOTE2In0.sdJ1FLLdMzSQXhr2lcTalfYshxxi4VvSsFdRzoCQbLCNrfw1m4NGMACkVXdZMJOpG67WKyR7cSUnp_saox5aANE3LkzeU835mhtq-U7UVIX8YAC1j3aH0IQDjpKYmYXf9FoyZw8fk0STlANtEDkFIjpiI5Ii-gnBAnxTdclN-crP6qHWlmJeGYiJ9fOCgGZiWvQQWo345jUWrK6OSpkTNj9I4h2uKbiWNIgOuSTon67GpgpQFEKXYpeogpwxm5muLZwCTaAYd-zK1O5SrPYAtzLCNJ6cg0sgormMFi7Gygzu_MNUUha6kwQHIRYvUcSz4OeNS5W16EUPOUnO9-txag",
"refresh_token" : "eyJraWQiOiJvRDd2aGVEcUJ6RWh2R0RGUDBZYy1Gc0hQS3lDS0lfYWhZRU83NFBQRVdnIiwiYWxnIjoiUlMyNTYifQ.eyJjb21wYW55X2lkIjoyMDAwMywiY2xpZW50X2FwcF9pZCI6InBhcGkiLCJwZXJzb25fdHlwZSI6IlNUQUZGIiwidXNlcl9uYW1lIjoidGVzdCthcGlAdGVzdC5jb20iLCJjbGllbnRfaW5pdF9pcCI6IjEwLjQyLjAuMTc2IiwiaXNzIjoiaHR0cHM6Ly9sb3NvbG8tc3NvLnJvZ2lpLm5ldCIsInVzZXJfZGlnZXN0IjoiOGI5ZWVhMzc3NyIsImF1dGhvcml0aWVzIjpbIlJPTEVfU1RBRkYiXSwiY2xpZW50X2lkIjoic29sby1hcGktY2xpZW50LWlkIiwiYXVkIjoic29sby1wdWJsaWMtYXBpIiwidXNlcl9pZCI6MTQ5Nywic2NvcGUiOlsicmVhZCJdLCJleHAiOjE3OTQ4NDM5OTYsImlhdCI6MTc5NDgxMzk5NiwianRpIjoiYjRlOTA5MjQtZjFmZS00OGVjLTljYjQtZjIzNTM2MjRkNDkxIn0.PORd4PyQHBkqjmEJW1BosX5tyBQ0SEGrtwJrIPTGU1DoqC3xf5_4rGnKXGaaGze9tR9e1-yKuzn7WL8s2rPjIdqDycAn7aKl1EARYZdxidG1T6xAUpCOcG0h-0rBQ5trlbueIC2ScDHMVnu32iB7PAYOvk6IyDXfo4E0JVHPOi_YbwdVrZhJfxGuVBi8MP8lyBF-JIHmKV7Sx-1qWqIGrvex3zNilqeMhXBHe9_go95joU7bIh3K_9HlMWrhcVqb-PYj-TVXiqrqTTxgh15mpiTVzrbLjUzSnupaVsI7B3pzUIIm93ivjojJdhfP39DgN9w67oJtsc90PeikuJiVTg",
"scope" : "read",
"token_type" : "Bearer",
"expires_in" : 9999,
"iat" : 1794813996,
"jti" : "b18638d3-4fdf-409b-90c5-0796b89a2916"
}
POST /oauth/token
| Parameter | Description |
|---|---|
grant_type |
The type of grant being presented in exchange for an access and refresh token: password (requires username and password) or refresh_token (requires the refresh_token parameter instead) |
username |
Solo user login |
password |
Solo user password |
| Header | Description |
|---|---|
Authorization |
Authorization header in the following format Basic credentialscredentials is a client_id:secret string encoded in base64 (standard http basic authorization).client_id is a unique client identifier to access the public api. secret is a unique client secret string to access the public api. |
Response body
| Path | Type | Description |
|---|---|---|
access_token |
String |
Access token issued by the authorization server |
token_type |
String |
Token type |
refresh_token |
String |
Refresh token associated with the access token. Pass it as the refresh_token parameter with grant_type=refresh_token to get a new access token |
expires_in |
Number |
Lifetime in seconds of the access token. For example, the value 3600 denotes that the access token will expire in one hour from the time the response was generated |
scope |
String |
Space-separated scopes of the token |
iat |
Number |
Time at which the token was issued, in seconds since the Unix epoch |
jti |
String |
Unique identifier (JWT ID) of the access token |
Solo-hosted login for external integrations
In addition to the OAuth 2.0 token methods described above, Solo supports a browser-based, Solo-hosted login flow for external applications. This flow is suitable for integrations that want to present a "Sign in with Solo" button, redirect the user to Solo for authentication, and receive an authorization code that can be exchanged for tokens.
Download sample project
A runnable sample project is available as a reference implementation. It demonstrates the hosted login redirect, callback handling, token exchange, refresh token handling, and local setup with .env.example.
Download: Solo-auth-sample.zip
1. Projects
Create virtual project
Create a virtual project in the global project with the given UUID. User group roles of the global project are copied to the new virtual project. The new virtual project contains no wells, grids, polygons or sticks (the log families of the global project are added automatically), add them with Add virtual project entities. Returns the UUID of the created virtual project
Request
$ curl 'https://solo.cloud/public/api/v1/projects/717415ac-391a-4a83-a112-547bf738e6d1/virtual' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Virtual project name",
"description" : "Virtual project description"
}'
POST /public/api/v1/projects/717415ac-391a-4a83-a112-547bf738e6d1/virtual HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 86
{
"name" : "Virtual project name",
"description" : "Virtual project description"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 07f8c52acffbf3380ebc2d82a2cc6037
Content-Type: application/json
{
"uuid" : "b55a16dc-0426-4056-83d7-c474062daa06"
}
POST /public/api/v1/projects/{uuid}/virtual
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Virtual project name, required, up to 200 characters, a request without it or with a blank name is rejected with 400 |
description |
String |
Virtual project description, up to 255 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created virtual project UUID |
Add virtual project entities
Add laterals, typewells, grids, polygons and sticks of the parent global project to the virtual project by virtual project UUID. Typewells linked to an added lateral are added too. UUIDs that are not found in the parent project are ignored, objects that are already in the virtual project stay as they are
Request
$ curl 'https://solo.cloud/public/api/v1/projects/virtual/b55a16dc-0426-4056-83d7-c474062daa06/entities' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"wells" : [ "dc01fd86-1913-4dd7-bbd8-58f12dfddb9f", "bc791e3e-85b7-4be9-af1a-2668563ea53f" ],
"typewells" : [ "1df2f0b2-b2a9-4f4e-b35a-97639f132146", "ef2dae21-6379-40b2-ad0f-082c95445e0e" ],
"grids" : [ "0104c357-a18d-41fa-8244-49168f557213" ],
"polygons" : [ "780d97a8-a019-463c-b4ff-9c8e7e0453b6" ],
"sticks" : [ "9998e829-66ee-4004-bdda-78a3f80ca058" ]
}'
POST /public/api/v1/projects/virtual/b55a16dc-0426-4056-83d7-c474062daa06/entities HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 370
{
"wells" : [ "dc01fd86-1913-4dd7-bbd8-58f12dfddb9f", "bc791e3e-85b7-4be9-af1a-2668563ea53f" ],
"typewells" : [ "1df2f0b2-b2a9-4f4e-b35a-97639f132146", "ef2dae21-6379-40b2-ad0f-082c95445e0e" ],
"grids" : [ "0104c357-a18d-41fa-8244-49168f557213" ],
"polygons" : [ "780d97a8-a019-463c-b4ff-9c8e7e0453b6" ],
"sticks" : [ "9998e829-66ee-4004-bdda-78a3f80ca058" ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 704ea9b59723e104074e91e4a4000735
POST /public/api/v1/projects/virtual/{uuid}/entities
| Path parameter | Description |
|---|---|
uuid |
Virtual project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
wells |
Array |
Optional list of lateral UUIDs to add to the virtual project. Typewells linked to these laterals are added too |
typewells |
Array |
Optional list of typewell UUIDs to add to the virtual project |
grids |
Array |
Optional list of grid UUIDs to add to the virtual project |
polygons |
Array |
Optional list of polygon UUIDs to add to the virtual project |
sticks |
Array |
Optional list of stick UUIDs to add to the virtual project |
Response body
Empty body
Get projects
Get a list of global projects of the company that the current user has access to with pagination, sorted by name. Virtual projects are returned by Get virtual projects. Available to company users only, support and machine accounts get 403
Request
$ curl 'https://solo.cloud/public/api/v1/projects?filter=pApi&offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/projects?filter=pApi&offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 2c37dda84345d22a356b11df58f9d20a
Content-Type: application/json
{
"content" : [ {
"uuid" : "de20af11-0057-4534-a6fc-156d09dc7f2c",
"name" : "Papi test project 1",
"measure_unit" : "FOOT",
"role" : "MANAGER",
"accessed_on" : "2026-11-16T07:26:31Z",
"modified_on" : "2026-11-16T07:26:31Z"
}, {
"uuid" : "649c90c1-579e-4e7e-a9b8-89dd435efb26",
"name" : "Papi test project 2",
"measure_unit" : "METER",
"role" : "MANAGER",
"geo_crs" : {
"code" : 2000,
"authority" : "EPSG",
"name" : "Anguilla 1957 / British West Indies Grid",
"measure_unit" : "METER"
},
"accessed_on" : "2026-11-16T07:26:32Z",
"modified_on" : "2026-11-16T07:26:32Z"
}, {
"uuid" : "717415ac-391a-4a83-a112-547bf738e6d1",
"name" : "Papi test project 3",
"measure_unit" : "FOOT",
"role" : "MANAGER",
"geo_crs" : {
"code" : 2270,
"authority" : "EPSG",
"name" : "NAD83 / Oregon South (ft)",
"measure_unit" : "FOOT"
},
"accessed_on" : "2026-11-16T07:26:32Z",
"modified_on" : "2026-11-16T07:26:32Z"
} ],
"offset" : 0,
"limit" : 20,
"total" : 3,
"first" : true,
"last" : true
}
GET /public/api/v1/projects
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the projects whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Project UUID |
content[].name |
String |
Project name |
content[].measure_unit |
String |
Project measure unit: METER, FOOT or METER_FOOT (depths in feet, horizontal coordinates and distances in meters) |
content[].role |
String |
Role of the current user in the project, for example VIEWER, INTERPRETER, POWER_INTERPRETER, DATA_MANAGER or MANAGER |
content[].accessed_on |
String |
Date/time project last accessed at |
content[].modified_on |
String |
Date/time project last modified at |
content[].geo_crs |
Object |
Project coordinate reference system (CRS), absent if the project has no CRS |
content[].geo_crs.code |
Varies |
CRS code |
content[].geo_crs.authority |
Varies |
CRS authority |
content[].geo_crs.name |
Varies |
CRS name |
content[].geo_crs.measure_unit |
Varies |
CRS length unit: METER, MILLIMETER, FOOT, FOOT_US or INCH_US |
Get virtual projects
Get a list of company virtual projects that the current user has access to with pagination, sorted by name. Virtual projects use a subset of data from a Global Project and have their own access roles defined in the SOLO Admin Panel. They can be easily managed for specific users and any changes made are updated across the database. Data added to a Virtual Project is also added to the corresponding Global Project. Available to company users only, support and machine accounts get 403
Request
$ curl 'https://solo.cloud/public/api/v1/projects/virtual?filter=pApi&offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/projects/virtual?filter=pApi&offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: c6f11b1f0c1e7a67afc7ca33f366ad48
Content-Type: application/json
{
"content" : [ {
"uuid" : "e9b9bbf1-473a-4d93-bf8d-93e3b4ac7ef9",
"name" : "Virtual Papi test project 1",
"measure_unit" : "FOOT",
"role" : "MANAGER",
"parent_uuid" : "de20af11-0057-4534-a6fc-156d09dc7f2c",
"parent_name" : "Papi test project 1",
"virtual" : true,
"modified_on" : "2026-11-16T07:26:31Z"
}, {
"uuid" : "fdde19bc-8503-494d-a37a-5c9c14f2593e",
"name" : "Virtual Papi test project 2",
"measure_unit" : "METER",
"role" : "MANAGER",
"geo_crs" : {
"code" : 2000,
"authority" : "EPSG",
"name" : "Anguilla 1957 / British West Indies Grid",
"measure_unit" : "METER"
},
"parent_uuid" : "649c90c1-579e-4e7e-a9b8-89dd435efb26",
"parent_name" : "Papi test project 2",
"virtual" : true,
"modified_on" : "2026-11-16T07:26:32Z"
}, {
"uuid" : "904998d9-54dc-43fd-bfae-dad5be273435",
"name" : "Virtual Papi test project 3",
"measure_unit" : "FOOT",
"role" : "MANAGER",
"geo_crs" : {
"code" : 2270,
"authority" : "EPSG",
"name" : "NAD83 / Oregon South (ft)",
"measure_unit" : "FOOT"
},
"parent_uuid" : "717415ac-391a-4a83-a112-547bf738e6d1",
"parent_name" : "Papi test project 3",
"virtual" : true,
"modified_on" : "2026-11-16T07:26:32Z"
} ],
"offset" : 0,
"limit" : 20,
"total" : 3,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/virtual
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the virtual projects whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Virtual project UUID |
content[].name |
String |
Virtual project name |
content[].measure_unit |
String |
Measure unit of the parent project: METER, FOOT or METER_FOOT (depths in feet, horizontal coordinates and distances in meters) |
content[].role |
String |
Role of the current user in the virtual project, for example VIEWER, INTERPRETER, POWER_INTERPRETER, DATA_MANAGER or MANAGER |
content[].accessed_on |
String |
Date/time the virtual project was last accessed at |
content[].modified_on |
String |
Date/time the parent project was last modified at |
content[].geo_crs |
Object |
Coordinate reference system (CRS) of the parent project, absent if the project has no CRS |
content[].parent_uuid |
String |
UUID of the global project the virtual project belongs to |
content[].parent_name |
String |
Name of the global project the virtual project belongs to |
content[].virtual |
Boolean |
Always true for a virtual project |
content[].geo_crs.code |
Varies |
CRS code |
content[].geo_crs.authority |
Varies |
CRS authority |
content[].geo_crs.name |
Varies |
CRS name |
content[].geo_crs.measure_unit |
Varies |
CRS length unit: METER, MILLIMETER, FOOT, FOOT_US or INCH_US |
Get project
Get a global or virtual project by UUID. For a virtual project the response also has the parent_uuid, parent_name and virtual fields described in Get virtual projects. Returns 403 if the project does not exist or is not accessible
Request
$ curl 'https://solo.cloud/public/api/v1/projects/717415ac-391a-4a83-a112-547bf738e6d1' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/projects/717415ac-391a-4a83-a112-547bf738e6d1 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7efe8f3da9c7b54794f9e4a50fe34c14
Content-Type: application/json
{
"uuid" : "717415ac-391a-4a83-a112-547bf738e6d1",
"name" : "Papi test project 3",
"measure_unit" : "FOOT",
"role" : "MANAGER",
"geo_crs" : {
"code" : 2270,
"authority" : "EPSG",
"name" : "NAD83 / Oregon South (ft)",
"measure_unit" : "FOOT"
},
"accessed_on" : "2026-11-16T07:26:32Z",
"modified_on" : "2026-11-16T07:26:32Z"
}
GET /public/api/v1/projects/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Project UUID |
name |
String |
Project name |
measure_unit |
String |
Project measure unit: METER, FOOT or METER_FOOT (depths in feet, horizontal coordinates and distances in meters) |
role |
String |
Role of the current user in the project, for example VIEWER, INTERPRETER, POWER_INTERPRETER, DATA_MANAGER or MANAGER |
accessed_on |
String |
Date/time project last accessed at |
modified_on |
String |
Date/time project last modified at |
geo_crs |
Object |
Project coordinate reference system (CRS), absent if the project has no CRS |
geo_crs.code |
Number |
CRS code |
geo_crs.authority |
String |
CRS authority |
geo_crs.name |
String |
CRS name |
geo_crs.measure_unit |
String |
CRS length unit: METER, MILLIMETER, FOOT, FOOT_US or INCH_US |
Get recently updated objects
Get laterals (WELL) and typewells (TYPEWELL) of a global or virtual project that were created, updated or deleted after modified_since. Other object types are not reported, and a well that was created and deleted within the interval is not reported at all. For a virtual project, adding a well to it is reported as CREATE and removing it as DELETE. If modified_since is not earlier than the last project modification, content is empty. Pass the returned modified_on as modified_since in the next request
Request
$ curl 'https://solo.cloud/public/api/v1/projects/717415ac-391a-4a83-a112-547bf738e6d1/changes' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"modified_since" : "2026-11-16T07:25:32.220Z"
}'
POST /public/api/v1/projects/717415ac-391a-4a83-a112-547bf738e6d1/changes HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 51
{
"modified_since" : "2026-11-16T07:25:32.220Z"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: c6136f46dc27a521c856baeed673eb54
Content-Type: application/json
{
"content" : [ {
"uuid" : "dc01fd86-1913-4dd7-bbd8-58f12dfddb9f",
"type" : "WELL",
"operation" : "CREATE"
}, {
"uuid" : "1df2f0b2-b2a9-4f4e-b35a-97639f132146",
"type" : "TYPEWELL",
"operation" : "CREATE"
} ],
"modified_on" : "2026-11-16T07:26:32.681Z",
"modified_at" : "2026-11-16T07:26:32.681+00:00"
}
POST /public/api/v1/projects/{uuid}/changes
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
modified_since |
String |
Return changes made after this date/time, ISO 8601, for example 2026-03-12T12:00:00.000Z |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
modified_on |
String |
Date/time the project was last modified at, with milliseconds. Pass it as modified_since in the next request to get only newer changes |
modified_at |
String |
Deprecated, the same date/time as modified_on |
content[].uuid |
String |
Lateral or typewell UUID |
content[].type |
String |
Object type: WELL (lateral) or TYPEWELL |
content[].operation |
String |
Change of the object since modified_since: CREATE, UPDATE or DELETE |
Get project history
Get the change history of a global or virtual project with pagination, one item per revision, oldest first. All request body filters are optional and are combined, modified_since and modified_to are inclusive. Revisions made by service users are not returned
Request
$ curl 'https://solo.cloud/public/api/v1/projects/8703082f-d258-444e-896f-fe1a16b770e4/history?offset=0&limit=4' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"modified_since" : "2026-03-12T12:00:00.000+00:00",
"modified_to" : "2026-03-12T13:00:00.000+00:00",
"user_name" : "Bot Manager",
"user_email" : "a.bortnikov+manager@rogii.com",
"well_name" : "Typewell",
"well_ids" : [ "755135f6-6634-49bb-ad1f-093bf4efcc9c" ],
"sources" : [ "ANY" ]
}'
POST /public/api/v1/projects/8703082f-d258-444e-896f-fe1a16b770e4/history?offset=0&limit=4 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 300
{
"modified_since" : "2026-03-12T12:00:00.000+00:00",
"modified_to" : "2026-03-12T13:00:00.000+00:00",
"user_name" : "Bot Manager",
"user_email" : "a.bortnikov+manager@rogii.com",
"well_name" : "Typewell",
"well_ids" : [ "755135f6-6634-49bb-ad1f-093bf4efcc9c" ],
"sources" : [ "ANY" ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7403cb7037470b35
Content-Type: application/json
{
"content" : [ {
"modified_at" : "2026-03-12T12:00:04.441+00:00",
"user_email" : "a.bortnikov+manager@rogii.com",
"user_name" : "Bot Manager",
"source" : "portal",
"well_id" : "755135f6-6634-49bb-ad1f-093bf4efcc9c",
"well_name" : "Typewell",
"well_type" : "TYPEWELL",
"changes" : [ {
"operation" : "CREATE",
"object_id" : "755135f6-6634-49bb-ad1f-093bf4efcc9c",
"object_type" : "TYPEWELL",
"object_name" : "Typewell"
}, {
"operation" : "CREATE",
"object_id" : "00000000-0000-0000-0000-000000000001",
"object_type" : "WELLHEADER",
"object_name" : "Name"
}, {
"operation" : "CREATE",
"object_id" : "00000000-0000-0000-0000-000000000002",
"object_type" : "WELLHEADER",
"object_name" : "API"
}, {
"operation" : "CREATE",
"object_id" : "00000000-0000-0000-0000-000000000004",
"object_type" : "WELLHEADER",
"object_name" : "Operator"
}, {
"operation" : "CREATE",
"object_id" : "00000000-0000-0000-0000-000000000007",
"object_type" : "WELLHEADER",
"object_name" : "KB"
}, {
"operation" : "CREATE",
"object_id" : "00000000-0000-0000-0000-000000000008",
"object_type" : "WELLHEADER",
"object_name" : "Azimuth VS"
}, {
"operation" : "CREATE",
"object_id" : "00000000-0000-0000-0000-000000000009",
"object_type" : "WELLHEADER",
"object_name" : "Convergence"
}, {
"operation" : "CREATE",
"object_id" : "00000000-0000-0000-0000-000000000012",
"object_type" : "WELLHEADER",
"object_name" : "X-srf"
}, {
"operation" : "CREATE",
"object_id" : "00000000-0000-0000-0000-000000000013",
"object_type" : "WELLHEADER",
"object_name" : "Y-srf"
} ]
}, {
"modified_at" : "2026-03-12T12:00:05.488+00:00",
"user_email" : "a.bortnikov+manager@rogii.com",
"user_name" : "Bot Manager",
"source" : "portal",
"well_id" : "755135f6-6634-49bb-ad1f-093bf4efcc9c",
"well_name" : "Typewell",
"well_type" : "TYPEWELL",
"changes" : [ {
"operation" : "CREATE",
"object_id" : "489bce1c-333d-486d-b84d-89670505f9f3",
"object_type" : "LOG",
"object_name" : "Log"
} ]
}, {
"modified_at" : "2026-03-12T12:00:05.634+00:00",
"user_email" : "a.bortnikov+manager@rogii.com",
"user_name" : "Bot Manager",
"source" : "portal",
"well_id" : "755135f6-6634-49bb-ad1f-093bf4efcc9c",
"well_name" : "Typewell",
"well_type" : "TYPEWELL",
"changes" : [ {
"operation" : "CREATE",
"object_id" : "3bd00b21-c7d9-407e-83e9-347d50cef95d",
"object_type" : "TOPSET",
"object_name" : "Top Set"
} ]
}, {
"modified_at" : "2026-03-12T12:00:05.982+00:00",
"user_email" : "a.bortnikov+manager@rogii.com",
"user_name" : "Bot Manager",
"source" : "portal",
"well_id" : "755135f6-6634-49bb-ad1f-093bf4efcc9c",
"well_name" : "Typewell",
"well_type" : "TYPEWELL",
"changes" : [ {
"operation" : "CREATE",
"object_id" : "1b97e61f-f57e-4fa4-8df1-21ee3a1b0244",
"object_type" : "MUDLOG",
"object_name" : "Mud Log"
} ]
} ],
"offset" : 0,
"limit" : 4,
"total" : 32,
"last" : false,
"first" : true
}
POST /public/api/v1/projects/{uuid}/history
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
modified_since |
String |
Return revisions made at or after this date/time, ISO 8601 with a time zone offset |
modified_to |
String |
Return revisions made at or before this date/time, ISO 8601 with a time zone offset |
user_name |
String |
Filter by the name of the user who made the changes (full-text match) |
user_email |
String |
Filter by the email of the user who made the changes (full-text match) |
well_name |
String |
Filter by lateral or typewell name (full-text match) |
well_ids |
Array |
Filter by lateral or typewell UUIDs |
object_name |
String |
Filter by the name of a changed object (full-text match) |
object_ids |
Array |
Filter by UUIDs of changed objects |
sources |
Array |
Filter by client applications that made the changes. ANY or an empty list disables the filter. Allowed values: ACTIVITY_LOG, ALERTS, ANY, DATA_MANAGER, DRILLSPOT, DRILLSPOT_FEED, DRILLSPOT_SOLO_FEED, FEED_OUTPUT, FEED_SAAS_OUTPUT, FEED_WELLVIEW, LANDING, PAPI, PETREL, PYTHON_SDK, SAAS_STARSTEER, SOLOBOX, SOLO_CONNECT, SOLO_CONNECT_CLOUD, SOLO_FEED, STARFRAC, STARSTEER, SYSTEM_ROBOT, TLOG, WEB_ADMIN, WEB_FREE_VIEWER_NATIVE_ANDROID, WEB_FREE_VIEWER_NATIVE_IOS, WEB_PORTAL, WEB_SUPPORT_MANAGEMENT, WEB_VIEWER, WEB_VIEWER_MOBILE, WEB_VIEWER_NATIVE_ANDROID, WEB_VIEWER_NATIVE_IOS, WITSML, WITSML_SERVER, WS_RTM, WS_RTM_NATIVE_ANDROID, WS_RTM_NATIVE_IOS |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].modified_at |
String |
Date/time of the revision |
content[].user_email |
String |
User email |
content[].user_name |
String |
User name |
content[].source |
String |
Identifier of the client application that made the changes, for example portal for WEB_PORTAL or papi for PAPI |
content[].well_id |
String |
UUID of the lateral or typewell changed in the revision, absent if no well was changed |
content[].well_name |
String |
Name of the lateral or typewell changed in the revision |
content[].well_type |
String |
Type of the changed well: WELL (lateral) or TYPEWELL |
content[].changes |
Array |
Objects changed in the revision |
content[].changes[].operation |
String |
Operation performed on the object, for example CREATE, UPDATE, DELETE, LOCKED or UNLOCKED |
content[].changes[].object_id |
String |
Object UUID |
content[].changes[].object_type |
String |
Type of the changed object, for example WELL, TYPEWELL or LOG |
content[].changes[].object_name |
String |
Object name |
Delete virtual project
Delete virtual project by virtual project UUID. Only the virtual project is deleted, the objects of the global project are not affected
Request
$ curl 'https://solo.cloud/public/api/v1/projects/virtual/b55a16dc-0426-4056-83d7-c474062daa06' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/projects/virtual/b55a16dc-0426-4056-83d7-c474062daa06 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 311b5316579149a6097a1e70dc257d14
DELETE /public/api/v1/projects/virtual/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Virtual project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
2. Laterals
Create lateral
Create lateral by project UUID
Request
$ curl 'https://solo.cloud/public/api/v1/projects/ae0b9a51-08da-41fd-a73d-7e81c00d73c6/wells' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Lateral name",
"operator" : "operator",
"api" : "api",
"convergence" : {
"val" : 90.0
},
"azimuth" : {
"val" : 45.0
},
"kb" : {
"val" : 0.3
},
"tieintvd" : {
"val" : 0.4
},
"tieinns" : {
"val" : 0.5
},
"tieinew" : {
"val" : 0.6
},
"xsrfreal" : {
"val" : 100.0
},
"ysrfreal" : {
"val" : 500.0
}
}'
POST /public/api/v1/projects/ae0b9a51-08da-41fd-a73d-7e81c00d73c6/wells HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 377
{
"name" : "Lateral name",
"operator" : "operator",
"api" : "api",
"convergence" : {
"val" : 90.0
},
"azimuth" : {
"val" : 45.0
},
"kb" : {
"val" : 0.3
},
"tieintvd" : {
"val" : 0.4
},
"tieinns" : {
"val" : 0.5
},
"tieinew" : {
"val" : 0.6
},
"xsrfreal" : {
"val" : 100.0
},
"ysrfreal" : {
"val" : 500.0
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d26040232d5635628980315c121a9017
Content-Type: application/json
{
"uuid" : "eee79904-734e-4216-b0e0-3fb86960eaf6"
}
POST /public/api/v1/projects/{uuid}/wells
| Path parameter | Description |
|---|---|
uuid |
Project UUID (a virtual project UUID is also accepted) |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Lateral name |
operator |
String |
Operator name |
api |
String |
API lateral number |
convergence.val |
Number |
Grid convergence angle in degrees |
azimuth.val |
Number |
Vertical section azimuth in degrees |
kb.val |
Number |
Kelly bushing (KB) elevation above MSL in project units |
tieintvd.val |
Number |
Tie-in point TVD in project units |
tieinns.val |
Number |
Tie-in point NS in project units |
tieinew.val |
Number |
Tie-in point EW in project units |
xsrfreal.val |
Number |
X surface coordinate in project units |
ysrfreal.val |
Number |
Y surface coordinate in project units |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created lateral UUID |
Get laterals by project
Get a list of laterals by project UUID with pagination, sorted by name. A virtual project UUID is also accepted, then only the laterals added to that virtual project are listed
Request
$ curl 'https://solo.cloud/public/api/v1/projects/ae0b9a51-08da-41fd-a73d-7e81c00d73c6/wells?offset=0&limit=10&filter=oNe' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/ae0b9a51-08da-41fd-a73d-7e81c00d73c6/wells?offset=0&limit=10&filter=oNe HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5e54f20d2060d3e2d416fec60fec32f2
Content-Type: application/json
{
"content" : [ {
"uuid" : "d20e5353-94d2-42b2-b20b-5f1eb1fc314a",
"name" : "Lateral one",
"api" : "api lateral one",
"flags" : {
"has_logs" : false,
"has_topsets" : false,
"has_interpretations" : false,
"has_nested_wells" : false,
"has_mudlogs" : false,
"has_target_lines" : false
}
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/wells
| Path parameter | Description |
|---|---|
uuid |
Project UUID (a virtual project UUID is also accepted) |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the laterals whose name or API contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Lateral UUID |
content[].name |
String |
Lateral name |
content[].api |
String |
API lateral number |
content[].flags.has_logs |
Boolean |
true if the lateral has at least one log with data |
content[].flags.has_topsets |
Boolean |
true if the lateral has at least one topset |
content[].flags.has_interpretations |
Boolean |
true if the lateral has at least one interpretation that is neither private nor a service (AUTO) one |
content[].flags.has_nested_wells |
Boolean |
true if the lateral has at least one nested well |
content[].flags.has_mudlogs |
Boolean |
true if the lateral has at least one mudlog with data |
content[].flags.has_target_lines |
Boolean |
true if the lateral has at least one target line |
Get laterals by API filter
Search laterals by API number with pagination: returns the laterals whose api contains filter (case insensitive) from all company projects where the caller has a role other than NO_ACCESS, directly or through a virtual project, in lateral creation order. Available to company users only, support and machine accounts get 403
Request
$ curl 'https://solo.cloud/public/api/v1/wells/api-filtered?offset=0&limit=10&filter=lateral%20t' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/api-filtered?offset=0&limit=10&filter=lateral%20t HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4e6793ea70595d11075c1398d72c0bfb
Content-Type: application/json
{
"content" : [ {
"uuid" : "1d5f2500-ab6f-4219-8508-9aa22b97f6af",
"name" : "Lateral two",
"api" : "api lateral two",
"flags" : {
"has_logs" : false,
"has_topsets" : false,
"has_interpretations" : false,
"has_nested_wells" : false,
"has_mudlogs" : false,
"has_target_lines" : false
},
"project_uuid" : "ae0b9a51-08da-41fd-a73d-7e81c00d73c6",
"project_role" : "MANAGER"
}, {
"uuid" : "f050d597-42cf-4653-8bec-af1a461a6f8b",
"name" : "Lateral three",
"api" : "api lateral three",
"flags" : {
"has_logs" : false,
"has_topsets" : false,
"has_interpretations" : false,
"has_nested_wells" : false,
"has_mudlogs" : false,
"has_target_lines" : false
},
"project_uuid" : "ae0b9a51-08da-41fd-a73d-7e81c00d73c6",
"project_role" : "MANAGER"
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/api-filtered
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Required. Returns only the laterals whose API contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Lateral UUID |
content[].name |
String |
Lateral name |
content[].api |
String |
API lateral number |
content[].flags.has_logs |
Boolean |
true if the lateral has at least one log with data |
content[].flags.has_topsets |
Boolean |
true if the lateral has at least one topset |
content[].flags.has_interpretations |
Boolean |
true if the lateral has at least one interpretation that is neither private nor a service (AUTO) one |
content[].flags.has_nested_wells |
Boolean |
true if the lateral has at least one nested well |
content[].flags.has_mudlogs |
Boolean |
true if the lateral has at least one mudlog with data |
content[].flags.has_target_lines |
Boolean |
true if the lateral has at least one target line |
content[].project_uuid |
String |
UUID of the project the lateral belongs to, or of the virtual project when the caller has access to the lateral only through it |
content[].project_role |
String |
Role of the caller in the project (or virtual project) given by project_uuid |
Get lateral metadata
Get lateral metadata
Request
$ curl 'https://solo.cloud/public/api/v1/wells/f050d597-42cf-4653-8bec-af1a461a6f8b' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/f050d597-42cf-4653-8bec-af1a461a6f8b HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4cefbab34fbaf8cc0b56c9aee139c429
Content-Type: application/json
{
"uuid" : "f050d597-42cf-4653-8bec-af1a461a6f8b",
"name" : "Lateral three",
"operator" : "string",
"api" : "api lateral three",
"xsrf" : {
"val" : 19.68503937007874
},
"ysrf" : {
"val" : 32.808398950131235
},
"kb" : {
"val" : 22.96587926509186
},
"convergence" : {
"val" : 0.0
},
"azimuth" : {
"val" : 0.0
},
"tie_in_tvd" : {
"val" : 0.0
},
"tie_in_ns" : {
"val" : 3.280839895013123
},
"tie_in_ew" : {
"val" : 0.0
}
}
GET /public/api/v1/wells/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Lateral UUID |
name |
String |
Lateral name |
operator |
String |
Operator name |
api |
String |
API lateral number |
xsrf.val |
Number |
X surface coordinate in project units |
ysrf.val |
Number |
Y surface coordinate in project units |
kb.val |
Number |
Kelly bushing (KB) elevation above MSL in project units |
azimuth.val |
Number |
Vertical section azimuth in degrees |
convergence.val |
Number |
Grid convergence angle in degrees |
tie_in_tvd.val |
Number |
Tie-in point TVD in project units |
tie_in_ns.val |
Number |
Tie-in point NS in project units |
tie_in_ew.val |
Number |
Tie-in point EW in project units |
last_feed_stream_date |
String |
Timestamp of last update by Solo Feed |
Get lateral ellipses
Get lateral ellipses data by lateral UUID. Returns 404 if no ellipses are stored for the lateral
Request
$ curl 'https://solo.cloud/public/api/v1/laterals/0e94ae28-7ee1-410c-b74b-69c22dabe22b/ellipses' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/laterals/0e94ae28-7ee1-410c-b74b-69c22dabe22b/ellipses HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 6c9eeb36e5610baba2c649134eda319d
Content-Type: application/json
{
"content" : [ {
"index" : 10.0,
"value" : {
"nev" : [ 14.99, 98.23, 41.2, 67.78, 23.89, 12.31, 55.43, 11.23, 34.33 ],
"messages" : [ ]
}
} ]
}
GET /public/api/v1/laterals/{lateralUuid}/ellipses
| Path parameter | Description |
|---|---|
lateralUuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Ellipses points array sorted by index ascending |
content[].index |
Number |
Measured Depth value of the point |
content[].value.nev |
Array |
Ellipse attributes |
content[].value.messages |
Array |
Comments |
Get starred objects
Get starred objects by lateral UUID. A field is omitted when nothing of that type is starred or the starred object no longer exists
Request
$ curl 'https://solo.cloud/public/api/v1/wells/1961a244-0ea6-4c32-8b89-cffe5051f0e5/starred' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/wells/1961a244-0ea6-4c32-8b89-cffe5051f0e5/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f40f9ca92e35ce46c60f276431e92cfb
Content-Type: application/json
{
"target_line" : "3f022685-3a9e-411d-a0fc-78f854455e68",
"nested_well" : "5817b018-c79e-439b-91db-17e90d0614f8",
"interpretation" : "733c3e84-dc8b-4c1c-afd6-d3ed01225314",
"topset" : "2ce8ceea-c785-40bb-835c-fe3830206262"
}
GET /public/api/v1/wells/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
target_line |
String |
Starred target line UUID, absent if none is starred |
nested_well |
String |
Starred nested well UUID, absent if none is starred |
interpretation |
String |
Starred interpretation UUID, absent if none is starred |
topset |
String |
Starred topset UUID, absent if none is starred |
Get linked typewells
Get a list of typewells linked to the lateral with pagination, in link creation order. Inactive links are not listed
Request
$ curl 'https://solo.cloud/public/api/v1/wells/737b2dd2-cb9c-49e8-a4cf-7ab7bd660ac0/linked?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/wells/737b2dd2-cb9c-49e8-a4cf-7ab7bd660ac0/linked?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f0c25c412472d8b7ff0cc8e087d91ed6
Content-Type: application/json
{
"content" : [ {
"shift" : {
"val" : 1640.4199475065616
},
"typewell_id" : "860039a9-efee-4768-b12f-e51c53fd6540"
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/linked
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].shift.val |
Number |
Typewell shift in project units |
content[].typewell_id |
String |
Typewell UUID |
Get bit projection
Get bit projection by lateral UUID. Returns 406 if the lateral has no bit projection
Request
$ curl 'https://solo.cloud/public/api/v1/wells/10273846-8954-4727-880a-f9029b8725a0/bitprojection' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/wells/10273846-8954-4727-880a-f9029b8725a0/bitprojection HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: af159c2b3f4d60407eedaf3fdb3ca4fe
Content-Type: application/json
{
"mode" : "CALCULATED",
"sub_mode" : "DLS_TF",
"distance_to_bit" : {
"val" : 30.0
},
"dls" : {
"val" : 9.499999999999998
},
"tool_face" : {
"val" : 120.49999999999999
},
"continuous_inclination_log" : "00000000-0000-0000-0000-000000000000",
"last_log_point_log" : "00000000-0000-0000-0000-000000000000"
}
GET /public/api/v1/wells/{uuid}/bitprojection
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
mode |
String |
Can be [OFF, CALCULATED, PREDEFINED, DRILLSPOT_MULTIPOINT], the last one cannot be set via this API |
sub_mode |
String |
Can be [TREND, DLS_TF, CONT_INCL_LOG] |
distance_to_bit.val |
Number |
Distance to bit in meters, not converted to project units, range [0; 100000] |
dls.val |
Number |
Dogleg Severity value in degrees per 30 m for meter projects or per 100 ft for other projects (range [0; 60]) |
tool_face.val |
Number |
Tool face value in degrees (range [-180; 180]) |
continuous_inclination_log |
String |
Continuous inclination log UUID (00000000-0000-0000-0000-000000000000 if no log is selected) |
last_log_point_log |
String |
UUID of the log the projection is based on (00000000-0000-0000-0000-000000000000 for the last survey) |
Update lateral metadata
Update lateral metadata by UUID. name is required. Values are in project units, angles in degrees. Returns 403 if the lateral is locked or is a private lateral of another user
Request
$ curl 'https://solo.cloud/public/api/v1/wells/d20e5353-94d2-42b2-b20b-5f1eb1fc314a' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Lateral name",
"api" : "api lateral",
"operator" : "string",
"xsrf" : {
"val" : 60.5
},
"ysrf" : {
"val" : 100.0
},
"kb" : {
"val" : 70.0
},
"azimuth" : {
"val" : 0.0
},
"convergence" : {
"val" : 0.0
},
"tie_in_tvd" : {
"val" : 0.0
},
"tie_in_ns" : {
"val" : 1.0
},
"tie_in_ew" : {
"val" : 0.0
}
}'
PATCH /public/api/v1/wells/d20e5353-94d2-42b2-b20b-5f1eb1fc314a HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 379
{
"name" : "Lateral name",
"api" : "api lateral",
"operator" : "string",
"xsrf" : {
"val" : 60.5
},
"ysrf" : {
"val" : 100.0
},
"kb" : {
"val" : 70.0
},
"azimuth" : {
"val" : 0.0
},
"convergence" : {
"val" : 0.0
},
"tie_in_tvd" : {
"val" : 0.0
},
"tie_in_ns" : {
"val" : 1.0
},
"tie_in_ew" : {
"val" : 0.0
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: fe4c4732678d1ec453c211cdbe73e3be
PATCH /public/api/v1/wells/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Lateral name, required and not blank (at most 200 characters) |
operator |
String |
Operator name (at most 200 characters) |
api |
String |
API lateral number (at most 200 characters) |
xsrf.val |
Number |
X surface coordinate in project units |
ysrf.val |
Number |
Y surface coordinate in project units |
kb.val |
Number |
Kelly bushing (KB) elevation above MSL in project units |
azimuth.val |
Number |
Vertical section azimuth in degrees |
convergence.val |
Number |
Grid convergence angle in degrees |
tie_in_tvd.val |
Number |
Tie-in point TVD in project units |
tie_in_ns.val |
Number |
Tie-in point NS in project units |
tie_in_ew.val |
Number |
Tie-in point EW in project units |
Response body
Empty body
Set starred objects
Set starred objects by lateral UUID. Omitted fields keep their current value, 00000000-0000-0000-0000-000000000000 resets a field. Every other UUID must belong to an object of this lateral, otherwise 406 is returned. A private lateral of another user is rejected with 403
Request
$ curl 'https://solo.cloud/public/api/v1/wells/1961a244-0ea6-4c32-8b89-cffe5051f0e5/starred' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"targetline" : "3f022685-3a9e-411d-a0fc-78f854455e68",
"nestedwell" : "5817b018-c79e-439b-91db-17e90d0614f8",
"interpretation" : "733c3e84-dc8b-4c1c-afd6-d3ed01225314",
"topset" : "2ce8ceea-c785-40bb-835c-fe3830206262"
}'
PUT /public/api/v1/wells/1961a244-0ea6-4c32-8b89-cffe5051f0e5/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 230
{
"targetline" : "3f022685-3a9e-411d-a0fc-78f854455e68",
"nestedwell" : "5817b018-c79e-439b-91db-17e90d0614f8",
"interpretation" : "733c3e84-dc8b-4c1c-afd6-d3ed01225314",
"topset" : "2ce8ceea-c785-40bb-835c-fe3830206262"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 73f382da6d85b0323e613c5d902c6d36
PUT /public/api/v1/wells/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
targetline |
String |
UUID of a target line of this lateral to set starred (use "00000000-0000-0000-0000-000000000000" to reset, omit to keep the current one) |
nestedwell |
String |
UUID of a nested well of this lateral to set starred (use "00000000-0000-0000-0000-000000000000" to reset, omit to keep the current one) |
interpretation |
String |
UUID of an interpretation of this lateral to set starred (use "00000000-0000-0000-0000-000000000000" to reset, omit to keep the current one) |
topset |
String |
UUID of a topset of this lateral to set starred (use "00000000-0000-0000-0000-000000000000" to reset, omit to keep the current one) |
Response body
Empty body
Set bit projection
Set bit projection by lateral UUID. mode is required, a request without it is rejected with 400. For OFF and PREDEFINED modes send mode only. CALCULATED mode requires sub_mode and distance_to_bit plus the fields of the sub-mode: last_log_point_log for TREND, last_log_point_log, dls and tool_face for DLS_TF, continuous_inclination_log for CONT_INCL_LOG. Fields of other sub-modes must not be sent, a log UUID must be a log of this lateral. Parameters that are not sent keep their stored values. Requests that break these rules are rejected with 406
Request
$ curl 'https://solo.cloud/public/api/v1/wells/d18dd92d-90a4-46e9-802a-f3fbafeff99e/bitprojection' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"mode" : "CALCULATED",
"sub_mode" : "DLS_TF",
"distance_to_bit" : {
"val" : 30.0
},
"dls" : {
"val" : 9.5
},
"tool_face" : {
"val" : 120.5
},
"last_log_point_log" : "00000000-0000-0000-0000-000000000000"
}'
PUT /public/api/v1/wells/d18dd92d-90a4-46e9-802a-f3fbafeff99e/bitprojection HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 237
{
"mode" : "CALCULATED",
"sub_mode" : "DLS_TF",
"distance_to_bit" : {
"val" : 30.0
},
"dls" : {
"val" : 9.5
},
"tool_face" : {
"val" : 120.5
},
"last_log_point_log" : "00000000-0000-0000-0000-000000000000"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 17bf683a1b6d28b11f69ef1d60a3c6d7
PUT /public/api/v1/wells/{uuid}/bitprojection
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
mode |
String |
Can be [OFF, CALCULATED, PREDEFINED]. For OFF and PREDEFINED no other field is allowed |
sub_mode |
String |
Can be [TREND, DLS_TF, CONT_INCL_LOG], required for CALCULATED mode |
distance_to_bit.val |
Number |
Distance to bit in meters, not converted to project units, range [0; 100000], required for CALCULATED mode |
dls.val |
Number |
Dogleg Severity value in degrees per 30 m for meter projects or per 100 ft for other projects (range [0; 60]), required for DLS_TF sub-mode and not allowed for other sub-modes |
tool_face.val |
Number |
Tool face value in degrees (range [-180; 180]), required for DLS_TF sub-mode and not allowed for other sub-modes |
continuous_inclination_log |
String |
UUID of a log of this lateral or 00000000-0000-0000-0000-000000000000 for no log, required for CONT_INCL_LOG sub-mode and not allowed for other sub-modes |
last_log_point_log |
String |
UUID of a log of this lateral or 00000000-0000-0000-0000-000000000000 for the last survey, required for TREND and DLS_TF sub-modes and not allowed for CONT_INCL_LOG |
Response body
Empty body
Link typewell
Link a typewell to the lateral by lateral UUID, or update the shift of an existing link. shift is in project depth units, an omitted shift is stored as undefined. A deactivated link is activated again. typewell_id is required, a request without it or with a typewell of another project is rejected with 400. Returns 404 if the typewell does not exist and 409 if the link cannot be saved, for example because of a concurrent change. Linked typewells are returned by Get linked typewells. Requires the permission to create well references in the project
Request
$ curl 'https://solo.cloud/public/api/v1/wells/d20e5353-94d2-42b2-b20b-5f1eb1fc314a/linked' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"typewell_id" : "9809310b-c58f-4bd2-a5f6-c62c8144633a",
"shift" : {
"val" : 500.0
}
}'
POST /public/api/v1/wells/d20e5353-94d2-42b2-b20b-5f1eb1fc314a/linked HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 97
{
"typewell_id" : "9809310b-c58f-4bd2-a5f6-c62c8144633a",
"shift" : {
"val" : 500.0
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: b0e615e87c7dfca9c5ea9d844a155e6a
POST /public/api/v1/wells/{uuid}/linked
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
typewell_id |
String |
UUID of the typewell to link to the lateral |
shift |
Object |
Typewell shift. If present val is set, otherwise undefined is true. An omitted shift is stored as undefined |
shift.val |
Number |
Typewell shift value in project units |
shift.undefined |
Boolean |
Set to true if the shift is undefined |
Response body
Empty body
Lock lateral
Lock lateral by UUID. Metadata and trajectory updates and the deletion of a locked lateral are rejected with 403 until it is unlocked. A private lateral cannot be locked (403). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/wells/2fb2cfb9-3618-4a15-ac96-b4541e492f47/lock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/wells/2fb2cfb9-3618-4a15-ac96-b4541e492f47/lock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 33d08b23c27b716cfd35828f0fb8b8b4
PATCH /public/api/v1/wells/{uuid}/lock
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Unlock lateral
Unlock lateral by UUID. A private lateral cannot be unlocked (403). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/wells/241ea4a4-9fce-4e87-b676-1aaf408559b8/unlock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/wells/241ea4a4-9fce-4e87-b676-1aaf408559b8/unlock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: cd8d4d198e529c55afc5882e5bd2b967
PATCH /public/api/v1/wells/{uuid}/unlock
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Delete lateral
Delete lateral by UUID. The lateral is also removed from virtual projects and well lists. Returns 403 if the lateral is locked or is a private lateral of another user
Request
$ curl 'https://solo.cloud/public/api/v1/wells/6fc5a2d5-ec9b-4a05-82ea-aa70d492d1db' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/wells/6fc5a2d5-ec9b-4a05-82ea-aa70d492d1db HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 6b2ef38d2f10044af572737f1d8a0057
DELETE /public/api/v1/wells/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
3. Interpretations
Create interpretation
Create an empty public interpretation owned by the caller by lateral UUID. Add segments with Add interpretation segment or Write interpretation segments in bulk
Request
$ curl 'https://solo.cloud/public/api/v1/wells/58bf9c71-3b05-48ce-9285-0b031124102e/interpretations' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Interpretation name"
}'
POST /public/api/v1/wells/58bf9c71-3b05-48ce-9285-0b031124102e/interpretations HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 36
{
"name" : "Interpretation name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: e25fcda6b3c79d7aae5482318c1cd25b
Content-Type: application/json
{
"uuid" : "3247d472-a3ce-4f55-b1ec-f386c6a56d08"
}
POST /public/api/v1/wells/{uuid}/interpretations
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Interpretation name, required, not blank, at most 255 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created interpretation UUID |
Write interpretation segments in bulk
Create or overwrite one interpretation of the lateral with all its segments in a single request. Either the whole interpretation is written or nothing is, a refused request leaves the target as it was.
The target is addressed by uuid, or by name when uuid is omitted. An existing target gets its segments fully replaced and the response carries created: false. When no interpretation with such name exists, a new one is created as a copy of source_interpretation_uuid (horizons included, owner is the caller, privacy is taken from private) and the response carries created: true; source_interpretation_uuid is required in this case. Sending the same request twice therefore yields one interpretation written twice, so a retry is safe. Concurrent writes to one lateral are not supported, upload laterals in parallel but write each of them sequentially.
The interpretation name must start with the prefix configured on the server (AI_ by default), so a bulk write never overwrites an interpretation made by a user. It is at most 255 characters long, carries no control characters and neither starts nor ends with whitespace. A lateral holding several interpretations with the requested name is rejected with 400 listing the UUIDs of those the caller may address (other users' private ones are only counted), address the target by uuid instead. A locked target and a private interpretation of another user (as the target or as the source) are rejected with 403. The call requires both CREATE and UPDATE permissions on interpretations.
Segment rules:
- segments must be in strictly increasing
start_mdorder, everystart_mdmust lie within the trajectory MD range, gaps between consecutive segments and from the last segment to the trajectory end must be at least 0.1 ft; - a boundary between two segments is continuous when
|previous end_shift - start_shift| <= 0.01project units, the segment then starts from the previousend_shiftand the submittedstart_shiftis not used; - a larger step makes a fault, such segments are named
Fault1,Fault2, ... in the order they are written; - the first segment always keeps its
start_shift.
One request carries at most 10000 segments (a server setting), a larger request is rejected with 400 naming the limit. Segment values are in project units, the same as the other segment endpoints. Note that a segment is described by its start MD and the vertical shifts at its ends, not by the md, dip and throw of Add interpretation segment.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/89344878-b622-46a9-bb0f-959701caa94a/interpretations/bulk' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "AI_interpretation 1",
"source_interpretation_uuid" : "ba935065-6614-4b70-9f81-bb7c621e3bf1",
"private" : false,
"segments" : [ {
"start_md" : 1000.0,
"start_shift" : 0.0,
"end_shift" : 2.5
}, {
"start_md" : 1500.0,
"start_shift" : 2.5,
"end_shift" : 4.0
} ]
}'
PUT /public/api/v1/wells/89344878-b622-46a9-bb0f-959701caa94a/interpretations/bulk HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 307
{
"name" : "AI_interpretation 1",
"source_interpretation_uuid" : "ba935065-6614-4b70-9f81-bb7c621e3bf1",
"private" : false,
"segments" : [ {
"start_md" : 1000.0,
"start_shift" : 0.0,
"end_shift" : 2.5
}, {
"start_md" : 1500.0,
"start_shift" : 2.5,
"end_shift" : 4.0
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a84d4382d3c7ae55161acf903830bb09
Content-Type: application/json
{
"uuid" : "a9f992d2-5521-4264-96b0-7872a1bb09ad",
"name" : "AI_interpretation 1",
"segments_written" : 2,
"created" : true
}
PUT /public/api/v1/wells/{uuid}/interpretations/bulk
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Target interpretation name, at most 255 characters, no control characters, no whitespace at either end. Must start with the configured prefix (AI_ by default), otherwise the request is rejected with 400 |
uuid |
String |
Target interpretation UUID. When omitted, the target is looked up by name among the lateral's interpretations; when present, name must match the interpretation name |
source_interpretation_uuid |
String |
Interpretation of the same lateral the target is copied from, horizons included. Required only when the target does not exist yet and has to be created, ignored when the target exists |
private |
Boolean |
Privacy of the created interpretation (false by default). Ignored when an existing interpretation is overwritten |
segments |
Array |
Segments to write, at least one, in strictly increasing start_md order, the existing segments of the target are fully replaced |
segments[].start_md |
Number |
Segment start measured depth in project units, within the trajectory MD range |
segments[].start_shift |
Number |
Vertical shift at the segment start in project units. Used for the first segment and for a fault boundary only, otherwise the previous segment's end_shift is taken |
segments[].end_shift |
Number |
Vertical shift at the segment end in project units |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Target interpretation UUID |
name |
String |
Target interpretation name |
segments_written |
Number |
Number of segments the interpretation holds after the write |
created |
Boolean |
true if the interpretation was created, false if an existing interpretation was overwritten |
Add interpretation segment
Add segment by interpretation UUID. The segment is set by md, dip and throw, its vertical section is calculated by the server. A locked interpretation and a private interpretation of another user are rejected with 403. A service (AUTO) interpretation is rejected with 400
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/efd88113-8a94-4462-88ad-ef62f24c1286/segments?horizontal_scale=MD' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"uuid" : "27c67762-fc2e-44e3-bf29-d141feee97ad",
"md" : {
"val" : 1500.0
},
"dip" : {
"val" : 30.0
},
"throw" : {
"val" : 15.0
}
}'
POST /public/api/v1/interpretations/efd88113-8a94-4462-88ad-ef62f24c1286/segments?horizontal_scale=MD HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 158
{
"uuid" : "27c67762-fc2e-44e3-bf29-d141feee97ad",
"md" : {
"val" : 1500.0
},
"dip" : {
"val" : 30.0
},
"throw" : {
"val" : 15.0
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7ba14cc85802984d9c2c42641638918e
POST /public/api/v1/interpretations/{uuid}/segments
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Parameter | Description |
|---|---|
horizontal_scale |
Horizontal scale for segment calculations. Available values: MD, THL, VS |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
uuid |
String |
Segment UUID. On add it is ignored and the server assigns the UUID of the new segment. On modification it selects the segment to change, an unknown UUID is rejected with 400 |
md.val |
Number |
Segment start measured depth in project units |
dip.val |
Number |
Dip value in degrees |
throw.val |
Number |
Throw value in project units |
Response body
Empty body
Get interpretations by lateral
Get a list of interpretations by lateral UUID with pagination, sorted by name
The list carries the public and locked interpretations of the lateral, and the private ones belonging to the caller - somebody else's private interpretation is not listed. Service (AUTO) interpretations are not listed either. Clients that identify themselves by User-Agent as SoloConnect before 4.3.0, SoloConnectCloud before 1.3.0 or PythonSDK before 0.4.0 (default server settings) get only interpretations in the old (v1) format.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/58bf9c71-3b05-48ce-9285-0b031124102e/interpretations?filter=test&offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/wells/58bf9c71-3b05-48ce-9285-0b031124102e/interpretations?filter=test&offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4f2ecdf9759fe77f605c1c02b2e9b119
Content-Type: application/json
{
"content" : [ {
"uuid" : "a51223ed-00a5-4903-b00b-43a7e7ea47f2",
"name" : "test interpretation 1",
"format" : {
"extension_grid_uuid" : "00000000-0000-0000-0000-000000000000",
"reverse_extension" : false,
"auto_typewell_shift" : true
},
"mode" : "PUBLIC"
}, {
"uuid" : "81d6c2a7-57f5-4106-ae59-6667174bcc40",
"name" : "test interpretation 2",
"format" : {
"extension_grid_uuid" : "00000000-0000-0000-0000-000000000000",
"reverse_extension" : false,
"auto_typewell_shift" : true
},
"mode" : "PUBLIC"
} ],
"offset" : 0,
"limit" : 20,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/interpretations
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the interpretations whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Interpretation name |
content[].uuid |
String |
Interpretation UUID |
content[].format.extension_grid_uuid |
String |
Extension grid UUID, 00000000-0000-0000-0000-000000000000 when not set |
content[].format.reverse_extension |
Boolean |
If true, the interpretation extension is reversed, false when not set |
content[].format.auto_typewell_shift |
Boolean |
StarSteer "Auto typewell shift" setting of the Geosteering mode, true unless it was turned off. If true, tops and horizons with the same name always match in the TVT scale |
content[].mode |
String |
PUBLIC, PRIVATE or LOCKED. A PRIVATE interpretation is listed only for its owner |
Get segments by interpretation
Get a list of segments by interpretation UUID. A private interpretation of another user is rejected with 403
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/45868cc7-ec2b-4255-8724-a3088e679dd7/segments?horizontal_scale=MD' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/interpretations/45868cc7-ec2b-4255-8724-a3088e679dd7/segments?horizontal_scale=MD HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7dd0f77d72ab70eccf8682d5ae886be5
Content-Type: application/json
{
"content" : [ {
"uuid" : "f502029a-dc8e-4cd7-b330-717e5b83059b",
"md" : {
"val" : 0.0
},
"vs" : {
"val" : 3.280839895013123
},
"dip" : {
"val" : 97.19791814183668
},
"dip_equal_thickness" : false,
"throw_equal_thickness" : true,
"throw" : {
"val" : 0.0
}
}, {
"uuid" : "4a33ea73-6641-4dc8-aa19-cd003a9f1cdd",
"md" : {
"val" : 328.0839895013123
},
"vs" : {
"val" : -0.615877064815856
},
"dip" : {
"val" : 90.00000000000594
},
"dip_equal_thickness" : true,
"throw_equal_thickness" : false,
"throw" : {
"val" : 0.49212598425196846
}
}, {
"uuid" : "70fa0fef-4350-4d7e-bdde-9f79c6fd2cec",
"md" : {
"val" : 1500.0000000000005
},
"vs" : {
"val" : -24.350204919093997
},
"dip" : {
"undefined" : true
},
"dip_equal_thickness" : false,
"throw_equal_thickness" : false,
"throw" : {
"undefined" : true
}
} ]
}
GET /public/api/v1/interpretations/{uuid}/segments
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Parameter | Description |
|---|---|
horizontal_scale |
Horizontal scale for segment calculations. Available values: MD, THL, VS |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
content[].uuid |
String |
Segment UUID |
content[].md.val |
Number |
Segment start measured depth in project units |
content[].vs.val |
Number |
Vertical section at the segment start in project units |
content[].dip.val |
Number |
Dip value in degrees |
content[].dip.undefined |
Boolean |
If true, dip value is undefined |
content[].dip_equal_thickness |
Boolean |
If true, dip is calculated with equal thickness |
content[].throw.val |
Number |
Throw value in project units |
content[].throw.undefined |
Boolean |
If true, throw value is undefined |
content[].throw_equal_thickness |
Boolean |
If true, throw is calculated with equal thickness |
Get faults by interpretation
Get the faults of an interpretation by interpretation UUID in MD order. A fault is a segment start StarSteer marks as a fault boundary: a bulk write marks one where a segment does not continue the previous one, adding or modifying a segment so that its throw changes (a new segment starts with throw 0) marks its start and the next segment start. A segment keeps its fault name after its fault is removed and is then not listed. uuid is the fault's own, segment_uuid addresses its segment. md and throw are calculated as in Get segments by interpretation. throw is the step of the horizons at the fault, the segment's start shift minus the previous segment's end shift: positive when they lie deeper past the fault in MD order. If they step differently it is the step most of them share and throw_equal_thickness is false. On the first segment, which has no previous one, throw is its start shift and throw_equal_thickness is true. format.line_width is a display width, not a length. A private interpretation of another user is rejected with 403
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/fecc91f9-1d02-4f12-9f26-bc9df05bdfd2/faults' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/interpretations/fecc91f9-1d02-4f12-9f26-bc9df05bdfd2/faults HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a6640c319cd889d3ea396a9316b80e3c
Content-Type: application/json
{
"content" : [ {
"uuid" : "65ce4a3b-15ba-476f-9254-80c99a4aebf4",
"name" : "Fault1",
"segment_uuid" : "229246be-7363-4ff6-91c9-0b1f7f56a190",
"md" : {
"val" : 1500.0000000000002
},
"throw_equal_thickness" : true,
"format" : {
"line_color" : "#ff000000",
"line_width" : 1.0,
"line_type" : "SOLID",
"label_location" : "UP"
},
"throw" : {
"val" : 3.5
}
} ]
}
GET /public/api/v1/interpretations/{uuid}/faults
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Faults of the interpretation in MD order |
content[].uuid |
String |
Fault UUID, the fault's own and not the segment UUID |
content[].name |
String |
Fault name |
content[].segment_uuid |
String |
UUID of the segment whose start boundary is the fault |
content[].md.val |
Number |
Fault measured depth in project units |
content[].throw.val |
Number |
Fault throw in project units, positive when the horizons past the fault lie deeper |
content[].throw.undefined |
Boolean |
If true, the throw is undefined: a shift it is calculated from is not defined |
content[].throw_equal_thickness |
Boolean |
true when every horizon steps by the throw, false when it is the step most of them share, always true on the first segment |
content[].format.line_color |
String |
Line color, #AARRGGBB, #ff000000 when not set |
content[].format.line_width |
Number |
Line display width from 0 to 10, 1 unless both the width and the line type are set |
content[].format.line_type |
String |
Line type: NONE, SOLID, DASH, DOT, DASH_DOT or DASH_DOT_DOT, SOLID unless both the width and the line type are set |
content[].format.label_location |
String |
Fault label location: UP or DOWN, UP when not set |
Get starred objects
Get starred objects by interpretation UUID
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/b8a52310-1891-4c39-8d3f-e461b410c1d4/starred' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/interpretations/b8a52310-1891-4c39-8d3f-e461b410c1d4/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5cb280145146a78f697182b77ee14c6e
Content-Type: application/json
{
"top" : "b3328609-87b0-4987-9d64-cd83eefa733a",
"center" : "f8b9fbb1-98bb-4f1a-9294-50bc100d0e14",
"bottom" : "7e97e0ef-0daa-432f-9885-7d2254b5c9f9"
}
GET /public/api/v1/interpretations/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
top |
String |
Starred top horizon UUID, absent when not set or when the horizon no longer exists |
center |
String |
Starred center horizon UUID, absent when not set or when the horizon no longer exists |
bottom |
String |
Starred bottom horizon UUID, absent when not set or when the horizon no longer exists |
Set starred objects
Set the starred top, center and bottom horizons by interpretation UUID. All three values are required and replace the current ones, 00000000-0000-0000-0000-000000000000 resets a position. A private interpretation of another user is rejected with 403. A service (AUTO) interpretation is rejected with 400
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/b8a52310-1891-4c39-8d3f-e461b410c1d4/starred' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"top" : "b3328609-87b0-4987-9d64-cd83eefa733a",
"center" : "f8b9fbb1-98bb-4f1a-9294-50bc100d0e14",
"bottom" : "7e97e0ef-0daa-432f-9885-7d2254b5c9f9"
}'
PUT /public/api/v1/interpretations/b8a52310-1891-4c39-8d3f-e461b410c1d4/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 158
{
"top" : "b3328609-87b0-4987-9d64-cd83eefa733a",
"center" : "f8b9fbb1-98bb-4f1a-9294-50bc100d0e14",
"bottom" : "7e97e0ef-0daa-432f-9885-7d2254b5c9f9"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9c9d68e93c1d1863d05f8adc611bfc5e
PUT /public/api/v1/interpretations/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
top |
String |
Required. UUID of a horizon of this interpretation to be set as starred top, 00000000-0000-0000-0000-000000000000 resets it. Any other UUID is rejected with 400 |
center |
String |
Required. UUID of a horizon of this interpretation to be set as starred center, 00000000-0000-0000-0000-000000000000 resets it. Any other UUID is rejected with 400 |
bottom |
String |
Required. UUID of a horizon of this interpretation to be set as starred bottom, 00000000-0000-0000-0000-000000000000 resets it. Any other UUID is rejected with 400 |
Response body
Empty body
Get auto-typewells by interpretation
Get a list of auto-typewells by interpretation UUID, as StarSteer marks them. A typewell linked to the lateral is listed when, in one of its topsets, the last top by MD lies deeper than the first one in TVD of the typewell by the TVD span from the shallowest to the deepest horizon, within 0.001 in project units. Private typewells, topsets and tops of another user are skipped. The list is empty when the interpretation has fewer than two horizons with a TVD
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/c6c0b924-0a86-4446-8353-1cee096adcf3/autotypewells' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/interpretations/c6c0b924-0a86-4446-8353-1cee096adcf3/autotypewells HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: ff9a1c2a355bba5a9f26f09d82325826
Content-Type: application/json
{
"content" : [ {
"auto_typewell_uuid" : "5a503ca5-35bc-456a-bc1b-9289666c718c"
} ]
}
GET /public/api/v1/interpretations/{uuid}/autotypewells
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
content[].auto_typewell_uuid |
String |
Auto-typewell UUID |
Set auto typewell shift
Turn the StarSteer "Auto typewell shift" setting of the Geosteering mode on or off for an interpretation. The current value is returned as format.auto_typewell_shift by "Get interpretations by lateral". Other interpretation settings are kept. A locked interpretation and a private interpretation of another user are rejected with 403. A service (AUTO) interpretation is rejected with 400
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/32446771-f004-4b6c-a598-308737f28747/autotypewellshift' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"enabled" : false
}'
PUT /public/api/v1/interpretations/32446771-f004-4b6c-a598-308737f28747/autotypewellshift HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 23
{
"enabled" : false
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 1dd3489b7a8fd62c30c8a25f97e0bfbc
PUT /public/api/v1/interpretations/{uuid}/autotypewellshift
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
enabled |
Boolean |
Required. true turns the StarSteer "Auto typewell shift" setting on for the interpretation, false turns it off, other values (including the strings "true" and "false") are rejected with 400. The current value is returned as format.auto_typewell_shift by the interpretations list |
Response body
Empty body
Modify interpretation segment
Modify segment by interpretation UUID. The segment is selected by uuid in the request body, an unknown segment UUID is rejected with 400. md, dip and throw are set, the vertical section is calculated by the server. A locked interpretation and a private interpretation of another user are rejected with 403. A service (AUTO) interpretation is rejected with 400
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/f68d3314-c845-4fe6-a084-a17127236137/segments?horizontal_scale=MD' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"uuid" : "ef1246ee-8647-48dd-b67e-b51e67108370",
"md" : {
"val" : 1500.0
},
"dip" : {
"val" : 60.0
},
"throw" : {
"val" : 25.0
}
}'
PATCH /public/api/v1/interpretations/f68d3314-c845-4fe6-a084-a17127236137/segments?horizontal_scale=MD HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 158
{
"uuid" : "ef1246ee-8647-48dd-b67e-b51e67108370",
"md" : {
"val" : 1500.0
},
"dip" : {
"val" : 60.0
},
"throw" : {
"val" : 25.0
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 6886fff584fb4538df03d7d3ab15424b
PATCH /public/api/v1/interpretations/{uuid}/segments
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Parameter | Description |
|---|---|
horizontal_scale |
Horizontal scale for segment calculations. Available values: MD, THL, VS |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
uuid |
String |
Segment UUID. On add it is ignored and the server assigns the UUID of the new segment. On modification it selects the segment to change, an unknown UUID is rejected with 400 |
md.val |
Number |
Segment start measured depth in project units |
dip.val |
Number |
Dip value in degrees |
throw.val |
Number |
Throw value in project units |
Response body
Empty body
Delete interpretation segment
Delete segment by interpretation UUID. A locked interpretation and a private interpretation of another user are rejected with 403. A service (AUTO) interpretation is rejected with 400
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/9f2f5986-f88b-4a98-976e-8c948ae65b9b/segments/fac8bf02-fc59-424c-aa32-3a66110975f4' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/interpretations/9f2f5986-f88b-4a98-976e-8c948ae65b9b/segments/fac8bf02-fc59-424c-aa32-3a66110975f4 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9745d5752961a07d351f5af52e5c05ef
DELETE /public/api/v1/interpretations/{uuid}/segments/{segmentUuid}
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
segmentUuid |
Segment UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Lock interpretation
Lock interpretation by UUID. Segment, auto typewell shift, bulk and earth model writes of a locked interpretation are rejected with 403 until it is unlocked. A private interpretation cannot be locked (403). A service (AUTO) interpretation cannot be locked (400). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/b5cf88a2-b1b7-4b85-ac15-39f3321ec609/lock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/interpretations/b5cf88a2-b1b7-4b85-ac15-39f3321ec609/lock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9fcf1fe950973337c4d3b3cfb32b1182
PATCH /public/api/v1/interpretations/{uuid}/lock
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Unlock interpretation
Unlock interpretation by UUID, the interpretation becomes public. A private interpretation cannot be unlocked (403). A service (AUTO) interpretation cannot be unlocked (400). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/12359219-25a8-40c0-9827-ae8e695f7954/unlock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/interpretations/12359219-25a8-40c0-9827-ae8e695f7954/unlock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 2456f9623c4bdf6f2f59577f9784726e
PATCH /public/api/v1/interpretations/{uuid}/unlock
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
4. Horizons
Get horizons metadata
Get a list of horizons by interpretation UUID with pagination, sorted by name
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/2da403b0-e574-4ebd-9c16-cf2b4b9b1fd1/horizons?filter=tEst&offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/interpretations/2da403b0-e574-4ebd-9c16-cf2b4b9b1fd1/horizons?filter=tEst&offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: dcf6094725bc5982e8aba3c9291eee49
Content-Type: application/json
{
"content" : [ {
"name" : "Test horizon 1",
"uuid" : "d1444c91-1567-4c99-8c51-ed066da863a7"
}, {
"name" : "Test horizon 2",
"uuid" : "59bd4346-e76d-455b-ba87-0be3e0cf7b10"
}, {
"name" : "Test horizon 3",
"uuid" : "de60a314-f058-45be-b844-9bad05a855cf"
} ],
"offset" : 0,
"limit" : 20,
"total" : 3,
"first" : true,
"last" : true
}
GET /public/api/v1/interpretations/{uuid}/horizons
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the horizons whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Horizon name |
content[].uuid |
String |
Horizon UUID |
Get horizons data by interpretation
Get calculated horizons data by interpretation UUID. Points are returned along the lateral from the start of the first interpretation segment to the trajectory end: at that start, at every MD multiple of spacing in between and at the trajectory end, each with the well position and the TVDSS of every horizon of the interpretation
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/26f5774c-655b-4080-a8dc-43833ff0f203/horizons/data/spacing/5000' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/interpretations/26f5774c-655b-4080-a8dc-43833ff0f203/horizons/data/spacing/5000 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 8b735eb0a2aa3860e9c38888fdf9ee7c
Content-Type: application/json
{
"content" : [ {
"azimuth" : {
"val" : 71.543
},
"horizons" : [ {
"name" : "!new Hor",
"tvdss" : {
"val" : 22.965879265091868
},
"uuid" : "a71056dd-3448-4ea0-a484-fa420e353d43"
}, {
"name" : "Horizon1",
"tvdss" : {
"val" : -3257.8740157480324
},
"uuid" : "8a25e76a-22d8-4ce0-9390-c57ec9ce45a0"
} ],
"inclination" : {
"val" : 0
},
"kb" : {
"val" : 22.965879265091868
},
"md" : {
"val" : 0
},
"tvt" : {
"val" : 0
},
"vs_azim" : {
"azimuth" : {
"val" : 0
},
"vs" : {
"val" : 3.280839895013124
}
},
"well_name" : "Lateral",
"x" : {
"val" : 19.68503937007874
},
"y" : {
"val" : 36.08923884514436
},
"z" : {
"val" : 22.965879265091868
}
}, {
"azimuth" : {
"val" : 149.253
},
"horizons" : [ {
"name" : "!new Hor",
"tvdss" : {
"val" : 22.965879265091868
},
"uuid" : "a71056dd-3448-4ea0-a484-fa420e353d43"
}, {
"name" : "Horizon1",
"tvdss" : {
"val" : -3257.8740157480324
},
"uuid" : "8a25e76a-22d8-4ce0-9390-c57ec9ce45a0"
} ],
"inclination" : {
"val" : 1.33
},
"kb" : {
"val" : 22.965879265091868
},
"md" : {
"val" : 3280.839895013124
},
"tvt" : {
"val" : 3280.0196063852154
},
"vs_azim" : {
"azimuth" : {
"val" : 0
},
"vs" : {
"val" : -60.07861128428071
}
},
"well_name" : "Lateral",
"x" : {
"val" : 53.715600823725445
},
"y" : {
"val" : -27.270212334149477
},
"z" : {
"val" : -3257.0537271201238
}
} ]
}
GET /public/api/v1/interpretations/{uuid}/horizons/data/spacing/{spacing}
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
spacing |
MD step of the returned points in project units (points are placed at MD multiples of it), an integer in [1;100000], other values are rejected with 400 |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content[].azimuth.val |
Number |
Well azimuth (degrees) |
content[].inclination.val |
Number |
Well inclination (degrees) |
content[].kb.val |
Number |
KB (project units) |
content[].md.val |
Number |
MD (project units) |
content[].tvt.val |
Number |
TVT (project units) |
content[].well_name |
String |
Well name |
content[].x.val |
Number |
X (project units) |
content[].y.val |
Number |
Y (project units) |
content[].z.val |
Number |
Z (project units) |
content[].vs_azim.azimuth.val |
Number |
Vertical section azimuth of the lateral (degrees) |
content[].vs_azim.vs.val |
Number |
VS (project units) |
content[].horizons[].name |
String |
Horizon name |
content[].horizons[].tvdss.val |
Number |
TVDSS (project units) |
content[].horizons[].uuid |
String |
Horizon UUID |
Get horizons data by lateral
Get calculated horizons data by lateral UUID, one interpretation per page: offset selects the interpretation among those Get interpretations by lateral returns (sorted by name, the caller's own private interpretations included, the same User-Agent rule applied), interpretation names it and content carries its points as in Get horizons data by interpretation
Request
$ curl 'https://solo.cloud/public/api/v1/wells/9f047a39-4f8b-4330-97be-944bd934a486/horizons/data/spacing/5000?offset=0' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/wells/9f047a39-4f8b-4330-97be-944bd934a486/horizons/data/spacing/5000?offset=0 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: c6f359fa7da63e1f71e4f3c2f1e2bd23
Content-Type: application/json
{
"content" : [ {
"azimuth" : {
"val" : 71.543
},
"horizons" : [ {
"name" : "!new Hor",
"tvdss" : {
"val" : 22.965879265091868
},
"uuid" : "a71056dd-3448-4ea0-a484-fa420e353d43"
}, {
"name" : "Horizon1",
"tvdss" : {
"val" : -3257.8740157480324
},
"uuid" : "8a25e76a-22d8-4ce0-9390-c57ec9ce45a0"
} ],
"inclination" : {
"val" : 0
},
"kb" : {
"val" : 22.965879265091868
},
"md" : {
"val" : 0
},
"tvt" : {
"val" : 0
},
"vs_azim" : {
"azimuth" : {
"val" : 0
},
"vs" : {
"val" : 3.280839895013124
}
},
"well_name" : "Lateral",
"x" : {
"val" : 19.68503937007874
},
"y" : {
"val" : 36.08923884514436
},
"z" : {
"val" : 22.965879265091868
}
}, {
"azimuth" : {
"val" : 149.253
},
"horizons" : [ {
"name" : "!new Hor",
"tvdss" : {
"val" : 22.965879265091868
},
"uuid" : "a71056dd-3448-4ea0-a484-fa420e353d43"
}, {
"name" : "Horizon1",
"tvdss" : {
"val" : -3257.8740157480324
},
"uuid" : "8a25e76a-22d8-4ce0-9390-c57ec9ce45a0"
} ],
"inclination" : {
"val" : 1.33
},
"kb" : {
"val" : 22.965879265091868
},
"md" : {
"val" : 3280.839895013124
},
"tvt" : {
"val" : 3280.0196063852154
},
"vs_azim" : {
"azimuth" : {
"val" : 0
},
"vs" : {
"val" : -60.07861128428071
}
},
"well_name" : "Lateral",
"x" : {
"val" : 53.715600823725445
},
"y" : {
"val" : -27.270212334149477
},
"z" : {
"val" : -3257.0537271201238
}
} ],
"interpretation" : {
"name" : "Interpretation",
"uuid" : "26f5774c-655b-4080-a8dc-43833ff0f203"
},
"offset" : 0,
"limit" : 1,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/horizons/data/spacing/{spacing}
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
spacing |
MD step of the returned points in project units (points are placed at MD multiples of it), an integer in [1;100000], other values are rejected with 400 |
| Parameter | Description |
|---|---|
offset |
Index of the interpretation to calculate the horizons for, in [0;total - 1], over the interpretations Get interpretations by lateral returns, sorted by name. An index beyond the last interpretation returns an empty content and no interpretation |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Calculated points of the selected interpretation |
offset |
Number |
Index of the selected interpretation, as requested. An index beyond the last interpretation returns an empty content and no interpretation |
limit |
Number |
Always 1 |
total |
Number |
Number of interpretations |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].azimuth.val |
Number |
Well azimuth (degrees) |
content[].inclination.val |
Number |
Well inclination (degrees) |
content[].kb.val |
Number |
KB (project units) |
content[].md.val |
Number |
MD (project units) |
content[].tvt.val |
Number |
TVT (project units) |
content[].well_name |
String |
Well name |
content[].x.val |
Number |
X (project units) |
content[].y.val |
Number |
Y (project units) |
content[].z.val |
Number |
Z (project units) |
content[].vs_azim.azimuth.val |
Number |
Vertical section azimuth of the lateral (degrees) |
content[].vs_azim.vs.val |
Number |
VS (project units) |
content[].horizons[].name |
String |
Horizon name |
content[].horizons[].tvdss.val |
Number |
TVDSS (project units) |
content[].horizons[].uuid |
String |
Horizon UUID |
interpretation.name |
String |
Interpretation name |
interpretation.uuid |
String |
Interpretation UUID |
5. Nested wells
Create nested well
Create nested well. Another term for a Nested well is a well plan. It's often referred to as a 'well plan object' in StarSteer and Solo
Request
$ curl 'https://solo.cloud/public/api/v1/wells/0a162bfc-5c6e-40b0-b7be-ca99934c7b0b/nestedwells' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Nested well name",
"operator" : "operator",
"api" : "api",
"xsrf" : {
"val" : 0.1
},
"ysrf" : {
"val" : 0.2
},
"kb" : {
"val" : 0.3
},
"tie_in_tvd" : {
"val" : 0.4
},
"tie_in_ns" : {
"val" : 0.5
},
"tie_in_ew" : {
"val" : 0.6
}
}'
POST /public/api/v1/wells/0a162bfc-5c6e-40b0-b7be-ca99934c7b0b/nestedwells HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 295
{
"name" : "Nested well name",
"operator" : "operator",
"api" : "api",
"xsrf" : {
"val" : 0.1
},
"ysrf" : {
"val" : 0.2
},
"kb" : {
"val" : 0.3
},
"tie_in_tvd" : {
"val" : 0.4
},
"tie_in_ns" : {
"val" : 0.5
},
"tie_in_ew" : {
"val" : 0.6
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 8ac45e5a521d204ca570c4aa54bacbe8
Content-Type: application/json
{
"uuid" : "1a793e74-ed24-4cd2-aade-69e39868965e"
}
POST /public/api/v1/wells/{uuid}/nestedwells
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Nested well name |
operator |
String |
Operator name |
api |
String |
API nested well number |
xsrf.val |
Number |
X surface coordinate in project units |
ysrf.val |
Number |
Y surface coordinate in project units |
kb.val |
Number |
Kelly bushing (KB) elevation above MSL in project units |
tie_in_ew.val |
Number |
Tie-in point EW in project units |
tie_in_ns.val |
Number |
Tie-in point NS in project units |
tie_in_tvd.val |
Number |
Tie-in point TVD in project units |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created nested well UUID |
Get nested wells by lateral
Get a list of nested wells by lateral UUID with pagination, sorted by name
Request
$ curl 'https://solo.cloud/public/api/v1/wells/dac6b8dc-1641-4bdc-87d3-30d074e021ee/nestedwells?offset=0&limit=10&filter=oNe' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/dac6b8dc-1641-4bdc-87d3-30d074e021ee/nestedwells?offset=0&limit=10&filter=oNe HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f6c0e12a55b690bcceaf68f8c1fd05cd
Content-Type: application/json
{
"content" : [ {
"uuid" : "7c4507d8-1fbf-40a4-80e0-d66893508ef3",
"name" : "Nested well one",
"api" : "api nested well",
"flags" : {
"has_topsets" : false
}
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/nestedwells
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the nested wells whose name or API contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Nested well UUID |
content[].name |
String |
Nested well name |
content[].api |
String |
API nested well number |
content[].flags.has_topsets |
Boolean |
Flag indicating the presence of topsets |
Get nested well metadata
Get nested well metadata by UUID. Values except the corridor ones are in project units. xsrf, ysrf and kb that are not set for the nested well (as parent) are returned from its lateral
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/19de62c7-aadf-416a-8ac9-e52249aed0e7' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/nestedwells/19de62c7-aadf-416a-8ac9-e52249aed0e7 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: fab2c4ad353c045f741c8612e085dbae
Content-Type: application/json
{
"name" : "Nested well one",
"operator" : "string",
"api" : "api nested well",
"xsrf" : {
"val" : 6.0
},
"ysrf" : {
"val" : 10.0
},
"kb" : {
"val" : 22.96587926509186
},
"tie_in_tvd" : {
"val" : 0.0
},
"tie_in_ns" : {
"val" : 3.280839895013123
},
"tie_in_ew" : {
"val" : 0.0
}
}
GET /public/api/v1/nestedwells/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
name |
String |
Nested well name |
operator |
String |
Operator name |
api |
String |
API nested well number |
xsrf.val |
Number |
X surface coordinate in project units. If it is not set for the nested well, the lateral value is returned |
ysrf.val |
Number |
Y surface coordinate in project units. If it is not set for the nested well, the lateral value is returned |
kb.val |
Number |
Kelly bushing (KB) elevation above MSL in project units. If it is not set for the nested well, the lateral value is returned |
tie_in_tvd.val |
Number |
Tie-in point TVD in project units |
tie_in_ns.val |
Number |
Tie-in point NS in project units |
tie_in_ew.val |
Number |
Tie-in point EW in project units |
corridor_top.val |
Number |
Well plan corridor top value as stored in the well plan properties, not converted to project units |
corridor_base.val |
Number |
Well plan corridor base value as stored in the well plan properties, not converted to project units |
corridor_left.val |
Number |
Well plan corridor left value as stored in the well plan properties, not converted to project units |
corridor_right.val |
Number |
Well plan corridor right value as stored in the well plan properties, not converted to project units |
Get nested well ellipses
Get nested well ellipses data by nested well UUID. Returns 404 if no ellipses are stored for the nested well
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/c305fc9a-f475-454c-ae31-aaac4b071e7d/ellipses' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/nestedwells/c305fc9a-f475-454c-ae31-aaac4b071e7d/ellipses HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 077fe2ec52c7ba2a1269ed394a603a05
Content-Type: application/json
{
"content" : [ {
"index" : 10.0,
"value" : {
"nev" : [ 14.99, 98.23, 41.2, 67.78, 23.89, 12.31, 55.43, 11.23, 34.33 ],
"messages" : [ ]
}
} ]
}
GET /public/api/v1/nestedwells/{nestedWellUuid}/ellipses
| Path parameter | Description |
|---|---|
nestedWellUuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Ellipses points array sorted by index ascending |
content[].index |
Number |
Measured Depth value of the point |
content[].value.nev |
Array |
Ellipse attributes |
content[].value.messages |
Array |
Comments |
Get starred topset
Get starred topset by nested well UUID
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/8bd625cd-d817-4de4-818d-82893c1c16a6/starred' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/nestedwells/8bd625cd-d817-4de4-818d-82893c1c16a6/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 97c6547aa896c2bcd71090694f7fa502
Content-Type: application/json
{
"topset" : "982142ab-5353-498f-9658-8bfb8a623285"
}
GET /public/api/v1/nestedwells/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
topset |
String |
Starred topset UUID. Absent when no topset is starred or the starred topset was deleted |
Update nested well metadata
Update nested well metadata by UUID. Fields that are not sent keep their current values. Values are in project units. Returns 403 if the nested well is locked or is a private nested well of another user
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/5feeb42f-c812-4996-9da5-fe75159fe5dd' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Nested well new name",
"api" : "api nested well",
"operator" : "string",
"xsrf" : {
"val" : 6.0
},
"ysrf" : {
"val" : 10.0
},
"kb" : {
"val" : 7.0
},
"tie_in_tvd" : {
"val" : 0.0
},
"tie_in_ns" : {
"val" : 1.0
},
"tie_in_ew" : {
"val" : 0.0
}
}'
PATCH /public/api/v1/nestedwells/5feeb42f-c812-4996-9da5-fe75159fe5dd HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 310
{
"name" : "Nested well new name",
"api" : "api nested well",
"operator" : "string",
"xsrf" : {
"val" : 6.0
},
"ysrf" : {
"val" : 10.0
},
"kb" : {
"val" : 7.0
},
"tie_in_tvd" : {
"val" : 0.0
},
"tie_in_ns" : {
"val" : 1.0
},
"tie_in_ew" : {
"val" : 0.0
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 2e7336e4a15d4fc4ce18d9804d43bbbd
PATCH /public/api/v1/nestedwells/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Nested well name, up to 200 characters, must not be blank if sent |
operator |
String |
Operator name, up to 200 characters |
api |
String |
API nested well number, up to 200 characters |
xsrf.val |
Number |
X surface coordinate in project units |
xsrf.undefined |
Boolean |
If true then X surface coordinate will be set as parent (the lateral value is returned) |
ysrf.val |
Number |
Y surface coordinate in project units |
ysrf.undefined |
Boolean |
If true then Y surface coordinate will be set as parent (the lateral value is returned) |
kb.val |
Number |
Kelly bushing (KB) elevation above MSL in project units |
kb.undefined |
Boolean |
If true then KB will be set as parent (the lateral value is returned) |
tie_in_tvd.val |
Number |
Tie-in point TVD in project units |
tie_in_tvd.undefined |
Boolean |
If true then tie in TVD will be set undefined |
tie_in_ns.val |
Number |
Tie-in point NS in project units |
tie_in_ns.undefined |
Boolean |
If true then tie in NS will be set undefined |
tie_in_ew.val |
Number |
Tie-in point EW in project units |
tie_in_ew.undefined |
Boolean |
If true then tie in EW will be set undefined |
Response body
Empty body
Set starred topset
Set starred topset by nested well UUID. The topset must belong to the nested well, the zero UUID 00000000-0000-0000-0000-000000000000 resets the starred topset. Any other UUID is rejected with 406. A private nested well of another user is rejected with 403
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/2159983e-cea4-426e-bd3e-27b132ac87d8/starred' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"topset" : "41d438fc-b9f4-4fa8-89a6-cce9472e97f4"
}'
PUT /public/api/v1/nestedwells/2159983e-cea4-426e-bd3e-27b132ac87d8/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 55
{
"topset" : "41d438fc-b9f4-4fa8-89a6-cce9472e97f4"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 466c85533b9316652081b27c5c389943
PUT /public/api/v1/nestedwells/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
topset |
String |
UUID of a topset of this nested well to set starred (use "00000000-0000-0000-0000-000000000000" to reset). Any other UUID is rejected with 406 |
Response body
Empty body
Lock nested well
Lock nested well by UUID. The metadata and trajectory of a locked nested well cannot be updated and the nested well cannot be deleted (403) until it is unlocked. A private nested well cannot be locked (403). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/b8e48e78-3ddf-45bc-9694-4a71a901cecd/lock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/nestedwells/b8e48e78-3ddf-45bc-9694-4a71a901cecd/lock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d37d12aebdf11cc5e586e517a2af77ad
PATCH /public/api/v1/nestedwells/{uuid}/lock
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Unlock nested well
Unlock nested well by UUID. A private nested well cannot be unlocked (403). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/2511a781-a0f9-4c99-89bf-e1717d35577d/unlock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/nestedwells/2511a781-a0f9-4c99-89bf-e1717d35577d/unlock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: e92c3c54990d99bffacd9fb11900a228
PATCH /public/api/v1/nestedwells/{uuid}/unlock
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Delete nested well
Delete nested well by UUID. Returns 403 if the nested well is locked or is a private nested well of another user
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/1b6c0098-8514-49af-b05c-4710b6b16e3b' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/nestedwells/1b6c0098-8514-49af-b05c-4710b6b16e3b HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a0c71d1a6795fa446461ad29c770ebc7
DELETE /public/api/v1/nestedwells/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
6. Typewells
Create typewell
Create typewell by project UUID
Request
$ curl 'https://solo.cloud/public/api/v1/projects/4dc52b57-0b02-458c-88b0-b825819d7e8c/typewells' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Typewell name",
"operator" : "operator",
"api" : "api",
"convergence" : {
"val" : 90.0
},
"azimuth" : {
"val" : 45.0
},
"kb" : {
"val" : 0.3
},
"tieintvd" : {
"val" : 0.4
},
"tieinns" : {
"val" : 0.5
},
"tieinew" : {
"val" : 0.6
},
"xsrfreal" : {
"val" : 100.0
},
"ysrfreal" : {
"val" : 500.0
}
}'
POST /public/api/v1/projects/4dc52b57-0b02-458c-88b0-b825819d7e8c/typewells HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 378
{
"name" : "Typewell name",
"operator" : "operator",
"api" : "api",
"convergence" : {
"val" : 90.0
},
"azimuth" : {
"val" : 45.0
},
"kb" : {
"val" : 0.3
},
"tieintvd" : {
"val" : 0.4
},
"tieinns" : {
"val" : 0.5
},
"tieinew" : {
"val" : 0.6
},
"xsrfreal" : {
"val" : 100.0
},
"ysrfreal" : {
"val" : 500.0
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a918333aabd6501d8f20ba64f8dd4345
Content-Type: application/json
{
"uuid" : "37397b56-df13-45e4-9d2f-77bb0dcf1779"
}
POST /public/api/v1/projects/{uuid}/typewells
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Typewell name |
operator |
String |
Operator name |
api |
String |
API typewell number |
convergence.val |
Number |
Grid convergence angle in degrees |
azimuth.val |
Number |
Vertical section azimuth in degrees |
kb.val |
Number |
Kelly bushing (KB) elevation above MSL in project units |
tieintvd.val |
Number |
Tie-in point TVD in project units |
tieinns.val |
Number |
Tie-in point NS in project units |
tieinew.val |
Number |
Tie-in point EW in project units |
xsrfreal.val |
Number |
X surface coordinate in project units |
ysrfreal.val |
Number |
Y surface coordinate in project units |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created typewell UUID |
Get typewells by project
Get a list of typewells by project UUID with pagination, sorted by name. A virtual project UUID is also accepted, then only the typewells added to that virtual project are listed
Request
$ curl 'https://solo.cloud/public/api/v1/projects/4dc52b57-0b02-458c-88b0-b825819d7e8c/typewells?offset=0&limit=10&filter=oNe' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/4dc52b57-0b02-458c-88b0-b825819d7e8c/typewells?offset=0&limit=10&filter=oNe HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9060c7b2a06a09839ccd69ff193180e0
Content-Type: application/json
{
"content" : [ {
"uuid" : "bb4803a4-8986-4abf-b0bf-c2a13308c548",
"name" : "Typewell one",
"api" : "api typewell one",
"flags" : {
"has_logs" : false,
"has_topsets" : false,
"has_mudlogs" : false
}
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/typewells
| Path parameter | Description |
|---|---|
uuid |
Project UUID (a virtual project UUID is also accepted) |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the typewells whose name or API contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Typewell UUID |
content[].name |
String |
Typewell name |
content[].api |
String |
API typewell number |
content[].flags.has_logs |
Boolean |
Flag indicating the presence of logs with data (logs without data are not counted) |
content[].flags.has_topsets |
Boolean |
Flag indicating the presence of topsets |
content[].flags.has_mudlogs |
Boolean |
Flag indicating the presence of mudlogs with data (mudlogs without data are not counted) |
Get typewell metadata
Get typewell metadata by UUID. Values are in project units, convergence is in degrees
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/8dfafa80-dfa1-4646-9bd0-0c0b66183e6f' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/typewells/8dfafa80-dfa1-4646-9bd0-0c0b66183e6f HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 92f858ce720e7c576129e5dda7a6e0bd
Content-Type: application/json
{
"uuid" : "8dfafa80-dfa1-4646-9bd0-0c0b66183e6f",
"name" : "Typewell",
"operator" : "string",
"api" : "string",
"xsrf" : {
"val" : 19.68503937007874
},
"ysrf" : {
"val" : 32.808398950131235
},
"kb" : {
"val" : 22.96587926509186
},
"convergence" : {
"val" : 0.0
},
"tie_in_tvd" : {
"val" : 0.0
},
"tie_in_ns" : {
"val" : 3.280839895013123
},
"tie_in_ew" : {
"val" : 0.0
}
}
GET /public/api/v1/typewells/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Typewell UUID |
name |
String |
Typewell name |
operator |
String |
Operator name |
api |
String |
API typewell number |
xsrf.val |
Number |
X surface coordinate in project units |
ysrf.val |
Number |
Y surface coordinate in project units |
kb.val |
Number |
Kelly bushing (KB) elevation above MSL in project units |
convergence.val |
Number |
Grid convergence angle in degrees |
tie_in_tvd.val |
Number |
Tie-in point TVD in project units |
tie_in_ns.val |
Number |
Tie-in point NS in project units |
tie_in_ew.val |
Number |
Tie-in point EW in project units |
Get typewell ellipses
Get typewell ellipses data by typewell UUID. Returns 404 if no ellipses are stored for the typewell
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/78c97155-2d04-4c3b-8d70-1c8df635661c/ellipses' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/78c97155-2d04-4c3b-8d70-1c8df635661c/ellipses HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d2dbaf97c8d5e2ab0d051eb3e284fb52
Content-Type: application/json
{
"content" : [ {
"index" : 10.0,
"value" : {
"nev" : [ 14.99, 98.23, 41.2, 67.78, 23.89, 12.31, 55.43, 11.23, 34.33 ],
"messages" : [ ]
}
} ]
}
GET /public/api/v1/typewells/{typewellUuid}/ellipses
| Path parameter | Description |
|---|---|
typewellUuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Ellipses points array sorted by index ascending |
content[].index |
Number |
Measured Depth value of the point |
content[].value.nev |
Array |
Ellipse attributes |
content[].value.messages |
Array |
Comments |
Get starred topset
Get starred topset by typewell UUID
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/8dfafa80-dfa1-4646-9bd0-0c0b66183e6f/starred' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/typewells/8dfafa80-dfa1-4646-9bd0-0c0b66183e6f/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 55eeaf1bca0b2822e75624be7b72f0d8
Content-Type: application/json
{
"topset" : "630a6bb6-5fe1-4ad3-ba2c-d942986f12c2"
}
GET /public/api/v1/typewells/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
topset |
String |
Starred topset UUID. Absent when no topset is starred or the starred topset was deleted |
Get linked laterals
Get laterals linked to the typewell by typewell UUID with pagination. Only active links are returned, in the order the links were created. shift is in project units
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/d046ef0e-ddbb-4b96-a8c4-3f1f78ecfb74/linked?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/typewells/d046ef0e-ddbb-4b96-a8c4-3f1f78ecfb74/linked?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f1c30a2cd1e481944c7c6e0c7a623740
Content-Type: application/json
{
"content" : [ {
"shift" : {
"val" : 1640.4199475065616
},
"lateral_id" : "495eb379-4f98-4c29-a7cc-e9952f44bedb"
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/typewells/{uuid}/linked
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].shift.val |
Number |
Typewell shift for the linked lateral in project units |
content[].lateral_id |
String |
Linked lateral UUID |
Update typewell metadata
Update typewell metadata by UUID. Fields that are not sent keep their current values. Values are in project units, convergence is in degrees. Returns 403 if the typewell is locked or is a private typewell of another user
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/bb4803a4-8986-4abf-b0bf-c2a13308c548' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Typewell one",
"api" : "api typewell",
"operator" : "string",
"xsrf" : {
"val" : 6.0
},
"ysrf" : {
"val" : 10.0
},
"kb" : {
"val" : 7.0
},
"convergence" : {
"val" : 0.0
},
"tie_in_tvd" : {
"val" : 0.0
},
"tie_in_ns" : {
"val" : 1.0
},
"tie_in_ew" : {
"val" : 0.0
}
}'
PATCH /public/api/v1/typewells/bb4803a4-8986-4abf-b0bf-c2a13308c548 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 340
{
"name" : "Typewell one",
"api" : "api typewell",
"operator" : "string",
"xsrf" : {
"val" : 6.0
},
"ysrf" : {
"val" : 10.0
},
"kb" : {
"val" : 7.0
},
"convergence" : {
"val" : 0.0
},
"tie_in_tvd" : {
"val" : 0.0
},
"tie_in_ns" : {
"val" : 1.0
},
"tie_in_ew" : {
"val" : 0.0
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d17f766fc48f63d84e59283b12b5a78b
PATCH /public/api/v1/typewells/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Typewell name, up to 200 characters, must not be blank if sent |
operator |
String |
Operator name, up to 200 characters |
api |
String |
API typewell number, up to 200 characters |
xsrf.val |
Number |
X surface coordinate in project units |
ysrf.val |
Number |
Y surface coordinate in project units |
kb.val |
Number |
Kelly bushing (KB) elevation above MSL in project units |
convergence.val |
Number |
Grid convergence angle in degrees |
tie_in_tvd.val |
Number |
Tie-in point TVD in project units |
tie_in_ns.val |
Number |
Tie-in point NS in project units |
tie_in_ew.val |
Number |
Tie-in point EW in project units |
Response body
Empty body
Set starred topset
Set starred topset by typewell UUID. The topset must belong to the typewell, the zero UUID 00000000-0000-0000-0000-000000000000 resets the starred topset. Any other UUID is rejected with 406. A private typewell of another user is rejected with 403
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/8dfafa80-dfa1-4646-9bd0-0c0b66183e6f/starred' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"topset" : "630a6bb6-5fe1-4ad3-ba2c-d942986f12c2"
}'
PUT /public/api/v1/typewells/8dfafa80-dfa1-4646-9bd0-0c0b66183e6f/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 55
{
"topset" : "630a6bb6-5fe1-4ad3-ba2c-d942986f12c2"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: e5411ab588f5e4df5886f89410139f5c
PUT /public/api/v1/typewells/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
topset |
String |
UUID of a topset of this typewell to set starred (use "00000000-0000-0000-0000-000000000000" to reset). Any other UUID is rejected with 406 |
Response body
Empty body
Lock typewell
Lock typewell by UUID. The metadata and trajectory of a locked typewell cannot be updated and the typewell cannot be deleted (403) until it is unlocked. A private typewell cannot be locked (403). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/2af687b2-c887-45b6-939e-a7544d27ab78/lock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/typewells/2af687b2-c887-45b6-939e-a7544d27ab78/lock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 8cff056c773c36963aa98537c4f3dcd1
PATCH /public/api/v1/typewells/{uuid}/lock
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Unlock typewell
Unlock typewell by UUID. A private typewell cannot be unlocked (403). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/f1290add-8ff0-4811-9de7-fe9bf1ce606a/unlock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/typewells/f1290add-8ff0-4811-9de7-fe9bf1ce606a/unlock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4cf35302e1dd4f6358c8bfd774e84d0e
PATCH /public/api/v1/typewells/{uuid}/unlock
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Delete typewell
Delete typewell by UUID. The links of laterals to the typewell are deactivated, the typewell is also removed from virtual projects and well lists. Returns 403 if the typewell is locked or is a private typewell of another user
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/6882f4f0-b095-4b45-9fed-de1c7b96c9af' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/typewells/6882f4f0-b095-4b45-9fed-de1c7b96c9af HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 48df610e2ca521e42ee1623bf3c73cda
DELETE /public/api/v1/typewells/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
7. Topsets
Create lateral topset
Create topset by lateral UUID
Request
$ curl 'https://solo.cloud/public/api/v1/wells/1c0623d2-25aa-40c8-8b7a-52ce1f7f17b7/topsets' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Topset name"
}'
POST /public/api/v1/wells/1c0623d2-25aa-40c8-8b7a-52ce1f7f17b7/topsets HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 28
{
"name" : "Topset name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 12e856f2aa75ff069a6af1a3356a9ab9
Content-Type: application/json
{
"uuid" : "9bbdeab5-ed5a-428e-ac72-13de03d62b70"
}
POST /public/api/v1/wells/{uuid}/topsets
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Topset name (up to 1000 characters) |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created topset UUID |
Create typewell topset
Create topset by typewell UUID
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/0ee6ee27-234f-4ba2-8d9a-cdf077a5853a/topsets' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Topset name"
}'
POST /public/api/v1/typewells/0ee6ee27-234f-4ba2-8d9a-cdf077a5853a/topsets HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 28
{
"name" : "Topset name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: fa9ee86d5782fd29df10e7dfbc8824e0
Content-Type: application/json
{
"uuid" : "db5c9da9-c439-418a-9422-76969dc69164"
}
POST /public/api/v1/typewells/{uuid}/topsets
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Topset name (up to 1000 characters) |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created topset UUID |
Create nested well topset
Create topset by nested well UUID
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/74632ed5-27dd-41cd-8a9d-afa194694646/topsets' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Topset name"
}'
POST /public/api/v1/nestedwells/74632ed5-27dd-41cd-8a9d-afa194694646/topsets HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 28
{
"name" : "Topset name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 786f44ab6ddb305f38d5c354442f1f4b
Content-Type: application/json
{
"uuid" : "d58b3efe-fa3d-454b-a6c4-2f164ab5f3c9"
}
POST /public/api/v1/nestedwells/{uuid}/topsets
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Topset name (up to 1000 characters) |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created topset UUID |
Create lateral topset with tops
Create a topset together with its tops by lateral UUID in one request. Each top takes the same fields as in Create top, invalid attribute values are rejected with 400. md is in project units and must be in [0;100000] range, otherwise the request is rejected with 406. An undefined md is stored as 0. The response holds the UUIDs of the created topset and tops, top_uuids is not guaranteed to follow the order of the request
Request
$ curl 'https://solo.cloud/public/api/v1/wells/1c0623d2-25aa-40c8-8b7a-52ce1f7f17b7/topsets/bulk' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Topset with tops",
"tops" : [ {
"name" : "Top 1",
"md" : {
"val" : 100.0
},
"dip" : {
"val" : 4.2
},
"azimuth" : {
"val" : 127.3
},
"dip_classification" : "bedding",
"confidence" : {
"val" : 0.94
},
"source" : "ai",
"model_info" : "WI_BeddingPlane_v2.1"
}, {
"name" : "Top 2",
"md" : {
"val" : 200.0
}
} ]
}'
POST /public/api/v1/wells/1c0623d2-25aa-40c8-8b7a-52ce1f7f17b7/topsets/bulk HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 417
{
"name" : "Topset with tops",
"tops" : [ {
"name" : "Top 1",
"md" : {
"val" : 100.0
},
"dip" : {
"val" : 4.2
},
"azimuth" : {
"val" : 127.3
},
"dip_classification" : "bedding",
"confidence" : {
"val" : 0.94
},
"source" : "ai",
"model_info" : "WI_BeddingPlane_v2.1"
}, {
"name" : "Top 2",
"md" : {
"val" : 200.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 8421f12393209a2cfee530f81e507574
Content-Type: application/json
{
"topset_uuid" : "3255c37a-c390-42cc-bbf4-aa43573183c8",
"top_uuids" : [ "6b802704-936c-4281-bfcb-88dac2ef75e7", "f992a6ca-c40a-4911-800f-e0df26240de2" ]
}
POST /public/api/v1/wells/{uuid}/topsets/bulk
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Topset name (up to 1000 characters, required) |
tops |
Array |
Tops to create in the topset, at least one |
tops[].name |
String |
Top name (up to 1000 characters, required) |
tops[].md |
Object |
Measured depth (required). If present val is set, otherwise undefined is true |
tops[].md.val |
Number |
Measured depth value in project units, must be in [0;100000] range, otherwise 406 is returned |
tops[].md.undefined |
Boolean |
Set to true if MD is undefined, MD is then stored as 0 |
tops[].dip |
Object |
Dip. If present val is set, otherwise undefined is true |
tops[].dip.val |
Number |
Dip value in degrees, must be in [0;90] range, otherwise 400 is returned |
tops[].dip.undefined |
Boolean |
Set to true if dip is undefined |
tops[].azimuth |
Object |
Azimuth. If present val is set, otherwise undefined is true |
tops[].azimuth.val |
Number |
Azimuth value in degrees, must be in [0;360) range, otherwise 400 is returned |
tops[].azimuth.undefined |
Boolean |
Set to true if azimuth is undefined |
tops[].dip_classification |
String |
Dip classification, must be null or one of: bedding, thin_bed, fault, fracture_open, fracture_healed, fracture_induced, otherwise 400 is returned |
tops[].confidence |
Object |
Confidence. If present val is set, otherwise undefined is true |
tops[].confidence.val |
Number |
Confidence value, must be in [0;1] range, otherwise 400 is returned |
tops[].confidence.undefined |
Boolean |
Set to true if confidence is undefined |
tops[].source |
String |
Top source, must be null or one of: manual, ai, otherwise 400 is returned |
tops[].model_info |
String |
Model info |
Response body
| Path | Type | Description |
|---|---|---|
topset_uuid |
String |
Created topset UUID |
top_uuids |
Array |
UUIDs of the created tops |
Create typewell topset with tops
Create a topset together with its tops by typewell UUID in one request. Each top takes the same fields as in Create top, invalid attribute values are rejected with 400. md is in project units and must be in [0;100000] range, otherwise the request is rejected with 406. An undefined md is stored as 0. The response holds the UUIDs of the created topset and tops, top_uuids is not guaranteed to follow the order of the request
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/0ee6ee27-234f-4ba2-8d9a-cdf077a5853a/topsets/bulk' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Topset with tops",
"tops" : [ {
"name" : "Top 1",
"md" : {
"val" : 100.0
},
"dip" : {
"val" : 4.2
},
"azimuth" : {
"val" : 127.3
},
"dip_classification" : "bedding",
"confidence" : {
"val" : 0.94
},
"source" : "ai",
"model_info" : "WI_BeddingPlane_v2.1"
}, {
"name" : "Top 2",
"md" : {
"val" : 200.0
}
} ]
}'
POST /public/api/v1/typewells/0ee6ee27-234f-4ba2-8d9a-cdf077a5853a/topsets/bulk HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 417
{
"name" : "Topset with tops",
"tops" : [ {
"name" : "Top 1",
"md" : {
"val" : 100.0
},
"dip" : {
"val" : 4.2
},
"azimuth" : {
"val" : 127.3
},
"dip_classification" : "bedding",
"confidence" : {
"val" : 0.94
},
"source" : "ai",
"model_info" : "WI_BeddingPlane_v2.1"
}, {
"name" : "Top 2",
"md" : {
"val" : 200.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 268219dbeb5b6eb209b5d9fb54241bc2
Content-Type: application/json
{
"topset_uuid" : "627c6008-9040-4cfb-a2ee-c56050489f96",
"top_uuids" : [ "5bb00ba7-bb7f-46c0-8c17-539275b03cca", "cfc4622a-0da2-4afc-83d2-b0e6f38cfe67" ]
}
POST /public/api/v1/typewells/{uuid}/topsets/bulk
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Topset name (up to 1000 characters, required) |
tops |
Array |
Tops to create in the topset, at least one |
tops[].name |
String |
Top name (up to 1000 characters, required) |
tops[].md |
Object |
Measured depth (required). If present val is set, otherwise undefined is true |
tops[].md.val |
Number |
Measured depth value in project units, must be in [0;100000] range, otherwise 406 is returned |
tops[].md.undefined |
Boolean |
Set to true if MD is undefined, MD is then stored as 0 |
tops[].dip |
Object |
Dip. If present val is set, otherwise undefined is true |
tops[].dip.val |
Number |
Dip value in degrees, must be in [0;90] range, otherwise 400 is returned |
tops[].dip.undefined |
Boolean |
Set to true if dip is undefined |
tops[].azimuth |
Object |
Azimuth. If present val is set, otherwise undefined is true |
tops[].azimuth.val |
Number |
Azimuth value in degrees, must be in [0;360) range, otherwise 400 is returned |
tops[].azimuth.undefined |
Boolean |
Set to true if azimuth is undefined |
tops[].dip_classification |
String |
Dip classification, must be null or one of: bedding, thin_bed, fault, fracture_open, fracture_healed, fracture_induced, otherwise 400 is returned |
tops[].confidence |
Object |
Confidence. If present val is set, otherwise undefined is true |
tops[].confidence.val |
Number |
Confidence value, must be in [0;1] range, otherwise 400 is returned |
tops[].confidence.undefined |
Boolean |
Set to true if confidence is undefined |
tops[].source |
String |
Top source, must be null or one of: manual, ai, otherwise 400 is returned |
tops[].model_info |
String |
Model info |
Response body
| Path | Type | Description |
|---|---|---|
topset_uuid |
String |
Created topset UUID |
top_uuids |
Array |
UUIDs of the created tops |
Create nested well topset with tops
Create a topset together with its tops by nested well UUID in one request. Each top takes the same fields as in Create top, invalid attribute values are rejected with 400. md is in project units and must be in [0;100000] range, otherwise the request is rejected with 406. An undefined md is stored as 0. The response holds the UUIDs of the created topset and tops, top_uuids is not guaranteed to follow the order of the request
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/74632ed5-27dd-41cd-8a9d-afa194694646/topsets/bulk' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Topset with tops",
"tops" : [ {
"name" : "Top 1",
"md" : {
"val" : 100.0
},
"dip" : {
"val" : 4.2
},
"azimuth" : {
"val" : 127.3
},
"dip_classification" : "bedding",
"confidence" : {
"val" : 0.94
},
"source" : "ai",
"model_info" : "WI_BeddingPlane_v2.1"
}, {
"name" : "Top 2",
"md" : {
"val" : 200.0
}
} ]
}'
POST /public/api/v1/nestedwells/74632ed5-27dd-41cd-8a9d-afa194694646/topsets/bulk HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 417
{
"name" : "Topset with tops",
"tops" : [ {
"name" : "Top 1",
"md" : {
"val" : 100.0
},
"dip" : {
"val" : 4.2
},
"azimuth" : {
"val" : 127.3
},
"dip_classification" : "bedding",
"confidence" : {
"val" : 0.94
},
"source" : "ai",
"model_info" : "WI_BeddingPlane_v2.1"
}, {
"name" : "Top 2",
"md" : {
"val" : 200.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3a50e6d0d29d7a5363a4a5f9b7734e90
Content-Type: application/json
{
"topset_uuid" : "337eae66-850d-4566-acd9-9c1360b810e2",
"top_uuids" : [ "2843f8a1-8183-4c7f-b0d3-de1576c7dfe7", "968e70e7-449d-4f4d-aecc-27c7104b0613" ]
}
POST /public/api/v1/nestedwells/{uuid}/topsets/bulk
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Topset name (up to 1000 characters, required) |
tops |
Array |
Tops to create in the topset, at least one |
tops[].name |
String |
Top name (up to 1000 characters, required) |
tops[].md |
Object |
Measured depth (required). If present val is set, otherwise undefined is true |
tops[].md.val |
Number |
Measured depth value in project units, must be in [0;100000] range, otherwise 406 is returned |
tops[].md.undefined |
Boolean |
Set to true if MD is undefined, MD is then stored as 0 |
tops[].dip |
Object |
Dip. If present val is set, otherwise undefined is true |
tops[].dip.val |
Number |
Dip value in degrees, must be in [0;90] range, otherwise 400 is returned |
tops[].dip.undefined |
Boolean |
Set to true if dip is undefined |
tops[].azimuth |
Object |
Azimuth. If present val is set, otherwise undefined is true |
tops[].azimuth.val |
Number |
Azimuth value in degrees, must be in [0;360) range, otherwise 400 is returned |
tops[].azimuth.undefined |
Boolean |
Set to true if azimuth is undefined |
tops[].dip_classification |
String |
Dip classification, must be null or one of: bedding, thin_bed, fault, fracture_open, fracture_healed, fracture_induced, otherwise 400 is returned |
tops[].confidence |
Object |
Confidence. If present val is set, otherwise undefined is true |
tops[].confidence.val |
Number |
Confidence value, must be in [0;1] range, otherwise 400 is returned |
tops[].confidence.undefined |
Boolean |
Set to true if confidence is undefined |
tops[].source |
String |
Top source, must be null or one of: manual, ai, otherwise 400 is returned |
tops[].model_info |
String |
Model info |
Response body
| Path | Type | Description |
|---|---|---|
topset_uuid |
String |
Created topset UUID |
top_uuids |
Array |
UUIDs of the created tops |
Get topsets by lateral
Get a list of topsets by lateral UUID with pagination, sorted by name
Request
$ curl 'https://solo.cloud/public/api/v1/wells/1c0623d2-25aa-40c8-8b7a-52ce1f7f17b7/topsets?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/1c0623d2-25aa-40c8-8b7a-52ce1f7f17b7/topsets?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3ff277dc8a568643895243690f18c9e9
Content-Type: application/json
{
"content" : [ {
"name" : "C Log TopSet tkAmsLCbTM",
"uuid" : "9b0c1699-1620-4cbc-ad8e-d6e3029769c2"
}, {
"name" : "D Well wgOTrlclDO",
"uuid" : "e8bc5d6c-cd66-4cdb-9737-c7c9164d4648"
}, {
"name" : "Top Set",
"uuid" : "364af948-f50b-4a86-8cfa-5eb0cc0ffda6"
}, {
"name" : "TopSet Log gkrbmddzZc",
"uuid" : "db8109d4-99dd-4831-9afc-dba9486097b5"
}, {
"name" : "TopSetMSkbBaUoCs",
"uuid" : "78a5e550-1278-4696-a077-44556daaaf55"
} ],
"offset" : 0,
"limit" : 10,
"total" : 5,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/topsets
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Topset name |
content[].uuid |
String |
Topset UUID |
Get topsets by typewell
Get a list of topsets by typewell UUID with pagination, sorted by name
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/0ee6ee27-234f-4ba2-8d9a-cdf077a5853a/topsets?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/0ee6ee27-234f-4ba2-8d9a-cdf077a5853a/topsets?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 59b662618154e04ba401e411c231ba97
Content-Type: application/json
{
"content" : [ {
"name" : "C Log TopSet jrvFIsRHSp",
"uuid" : "ea754a98-b602-4064-bed5-d5f60499a89c"
}, {
"name" : "D Well exWKptqCfq",
"uuid" : "3b6712e6-e966-4fb5-8231-2ef271066185"
}, {
"name" : "TopSet Log zqNourSVdx",
"uuid" : "6cfcca4b-12ec-4fe1-8384-c776284b7409"
}, {
"name" : "TopSetlqpPEyJpCV",
"uuid" : "8a523136-9d71-43cd-b9de-df4969620dd4"
} ],
"offset" : 0,
"limit" : 10,
"total" : 4,
"first" : true,
"last" : true
}
GET /public/api/v1/typewells/{uuid}/topsets
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Topset name |
content[].uuid |
String |
Topset UUID |
Get topsets by nested well
Get a list of topsets by nested well UUID with pagination, sorted by name
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/74632ed5-27dd-41cd-8a9d-afa194694646/topsets?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/nestedwells/74632ed5-27dd-41cd-8a9d-afa194694646/topsets?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 50060c7051701fc9314a40f56d043dd5
Content-Type: application/json
{
"content" : [ {
"name" : "C Log TopSet VcKfhgszhn",
"uuid" : "c8ecb357-14fb-443d-8997-7ef1f36f6e18"
}, {
"name" : "D Well lMZNqXZEIE",
"uuid" : "b2133c2c-df7b-4a5b-be6c-40b9e8367fe3"
}, {
"name" : "TopSet Log rLdkChAzOd",
"uuid" : "a359799b-9fd2-47ca-b699-486bcd7b35bf"
}, {
"name" : "Topset name",
"uuid" : "d58b3efe-fa3d-454b-a6c4-2f164ab5f3c9"
}, {
"name" : "Topset with tops",
"uuid" : "337eae66-850d-4566-acd9-9c1360b810e2"
}, {
"name" : "TopSetZtmsGBxanl",
"uuid" : "937cc0d2-16f9-4c07-904e-a8f5e77ac787"
} ],
"offset" : 0,
"limit" : 10,
"total" : 6,
"first" : true,
"last" : true
}
GET /public/api/v1/nestedwells/{uuid}/topsets
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Topset name |
content[].uuid |
String |
Topset UUID |
Get zones by topset
Get a list of zones by topset UUID with pagination, sorted by name
Request
$ curl 'https://solo.cloud/public/api/v1/topsets/d1a827be-8304-421a-a892-0050ab142625/zones?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/topsets/d1a827be-8304-421a-a892-0050ab142625/zones?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 0cec6869118413580003d5379f7f5729
Content-Type: application/json
{
"content" : [ {
"name" : "zone1",
"top_start" : "start",
"top_end" : "end",
"zone_id" : "b9028cb8-2b0e-418e-a76b-818e9392583c"
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/topsets/{uuid}/zones
| Path parameter | Description |
|---|---|
uuid |
Topset UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].zone_id |
String |
Zone UUID |
content[].name |
String |
Zone name |
content[].top_start |
String |
Name of the zone start top |
content[].top_end |
String |
Name of the zone end top |
content[].from_tvd_offset |
Object |
TVD offset of the zone start in meters, not converted to project units. If present val is set, otherwise undefined is true |
content[].to_tvd_offset |
Object |
TVD offset of the zone end in meters, not converted to project units. If present val is set, otherwise undefined is true |
Get starred objects
Get the starred top, center and bottom tops by topset UUID. A position that is not set, or whose top was deleted, is omitted from the response
Request
$ curl 'https://solo.cloud/public/api/v1/topsets/364af948-f50b-4a86-8cfa-5eb0cc0ffda6/starred' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/topsets/364af948-f50b-4a86-8cfa-5eb0cc0ffda6/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 915f0af4a14d7877f1df1b425ae6266a
Content-Type: application/json
{
"top" : "25f93d99-6050-4a9d-9655-ca595d2e7375",
"center" : "67ec21f9-2f4f-4908-84dc-9045617eca47",
"bottom" : "4217b4c2-30bc-4ad4-90dc-4d498390b622"
}
GET /public/api/v1/topsets/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Topset UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
top |
String |
UUID of the starred top, absent when not set or when the top no longer exists |
center |
String |
UUID of the starred center top, absent when not set or when the top no longer exists |
bottom |
String |
UUID of the starred bottom top, absent when not set or when the top no longer exists |
Set starred objects
Set the starred top, center and bottom tops by topset UUID. All three fields are required and replace the current values. Each value must be a top of this topset, or 00000000-0000-0000-0000-000000000000 to reset the position. One top cannot be starred in two positions. A request that breaks these rules is rejected with 400. A private topset of another user is rejected with 403
Request
$ curl 'https://solo.cloud/public/api/v1/topsets/364af948-f50b-4a86-8cfa-5eb0cc0ffda6/starred' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"top" : "25f93d99-6050-4a9d-9655-ca595d2e7375",
"center" : "67ec21f9-2f4f-4908-84dc-9045617eca47",
"bottom" : "4217b4c2-30bc-4ad4-90dc-4d498390b622"
}'
PUT /public/api/v1/topsets/364af948-f50b-4a86-8cfa-5eb0cc0ffda6/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 158
{
"top" : "25f93d99-6050-4a9d-9655-ca595d2e7375",
"center" : "67ec21f9-2f4f-4908-84dc-9045617eca47",
"bottom" : "4217b4c2-30bc-4ad4-90dc-4d498390b622"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4da2133dc11b4666a96c9801748ce65c
PUT /public/api/v1/topsets/{uuid}/starred
| Path parameter | Description |
|---|---|
uuid |
Topset UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
top |
String |
UUID of a top of this topset to be set as starred top (use "00000000-0000-0000-0000-000000000000" to reset) |
center |
String |
UUID of a top of this topset to be set as starred center (use "00000000-0000-0000-0000-000000000000" to reset) |
bottom |
String |
UUID of a top of this topset to be set as starred bottom (use "00000000-0000-0000-0000-000000000000" to reset) |
Response body
Empty body
Update topset
Update topset name by UUID. Returns 403 if the topset is locked or is a private topset of another user
Request
$ curl 'https://solo.cloud/public/api/v1/topsets/364af948-f50b-4a86-8cfa-5eb0cc0ffda6' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "New topset name"
}'
PATCH /public/api/v1/topsets/364af948-f50b-4a86-8cfa-5eb0cc0ffda6 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 32
{
"name" : "New topset name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 571221082c0722c46454694af053401a
PATCH /public/api/v1/topsets/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Topset UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Topset name (up to 1000 characters) |
Response body
Empty body
Lock topset
Lock topset by UUID. A locked topset cannot be renamed or deleted, and its tops cannot be created, updated or deleted (403) until it is unlocked. A private topset cannot be locked (403). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/topsets/7ddb3626-0387-4198-bced-807fe0b5f0d7/lock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/topsets/7ddb3626-0387-4198-bced-807fe0b5f0d7/lock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 506d7383dedf6cef924f2bd5ba3522fe
PATCH /public/api/v1/topsets/{uuid}/lock
| Path parameter | Description |
|---|---|
uuid |
Topset UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Unlock topset
Unlock topset by UUID. A private topset cannot be unlocked (403). Requires the permission to lock objects
Request
$ curl 'https://solo.cloud/public/api/v1/topsets/d1a827be-8304-421a-a892-0050ab142625/unlock' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>'
PATCH /public/api/v1/topsets/d1a827be-8304-421a-a892-0050ab142625/unlock HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 73752c376cf7e0269cc5d4ac798397ea
PATCH /public/api/v1/topsets/{uuid}/unlock
| Path parameter | Description |
|---|---|
uuid |
Topset UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Delete topset
Delete topset by UUID together with its tops and zones. Returns 403 if the topset is locked or is a private topset of another user
Request
$ curl 'https://solo.cloud/public/api/v1/topsets/364af948-f50b-4a86-8cfa-5eb0cc0ffda6' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/topsets/364af948-f50b-4a86-8cfa-5eb0cc0ffda6 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f858705e935a6a61feb99e6933ff2a0a
DELETE /public/api/v1/topsets/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Topset UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
8. Tops
Create top
Create top by topset UUID. Returns 403 if the topset is locked or is a private topset of another user
Request
$ curl 'https://solo.cloud/public/api/v1/topsets/f05dd5ea-f720-4fb9-957d-13fc2671d65d/tops' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Top name",
"md" : {
"val" : 100.5
},
"dip" : {
"val" : 45.0
},
"azimuth" : {
"val" : 180.0
},
"dip_classification" : "bedding",
"confidence" : {
"val" : 0.95
},
"source" : "manual",
"model_info" : "human"
}'
POST /public/api/v1/topsets/f05dd5ea-f720-4fb9-957d-13fc2671d65d/tops HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 258
{
"name" : "Top name",
"md" : {
"val" : 100.5
},
"dip" : {
"val" : 45.0
},
"azimuth" : {
"val" : 180.0
},
"dip_classification" : "bedding",
"confidence" : {
"val" : 0.95
},
"source" : "manual",
"model_info" : "human"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 76096a0b91cf6d4aa57dc38af99d2309
Content-Type: application/json
{
"uuid" : "bfabcd39-d2d6-4801-9f9f-1c28945fe9cb"
}
POST /public/api/v1/topsets/{uuid}/tops
| Path parameter | Description |
|---|---|
uuid |
Topset UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Top name (up to 1000 characters, required on create) |
md |
Object |
Measured depth (required on create). If present val is set, otherwise undefined is true |
md.val |
Number |
Measured depth value in project units, must be in [0;100000] range, otherwise 406 is returned |
md.undefined |
Boolean |
Set to true if MD is undefined, MD is then stored as 0 |
dip |
Object |
Dip. If present val is set, otherwise undefined is true |
dip.val |
Number |
Dip value in degrees, must be in [0;90] range, otherwise 400 is returned |
dip.undefined |
Boolean |
Set to true if dip is undefined |
azimuth |
Object |
Azimuth. If present val is set, otherwise undefined is true |
azimuth.val |
Number |
Azimuth value in degrees, must be in [0;360) range, otherwise 400 is returned |
azimuth.undefined |
Boolean |
Set to true if azimuth is undefined |
dip_classification |
String |
Dip classification, must be null or one of: bedding, thin_bed, fault, fracture_open, fracture_healed, fracture_induced, otherwise 400 is returned |
confidence |
Object |
Confidence. If present val is set, otherwise undefined is true |
confidence.val |
Number |
Confidence value, must be in [0;1] range, otherwise 400 is returned |
confidence.undefined |
Boolean |
Set to true if confidence is undefined |
source |
String |
Top source, must be null or one of: manual, ai, otherwise 400 is returned |
model_info |
String |
Model info |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created top UUID |
Get tops by topset
Get a list of tops by topset UUID with pagination, in creation order
Request
$ curl 'https://solo.cloud/public/api/v1/topsets/70d3d47a-09f7-4808-b5c4-d43cb78e1d90/tops?offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/topsets/70d3d47a-09f7-4808-b5c4-d43cb78e1d90/tops?offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: b8faebfdbc53759b1231eb2bfeb002c9
Content-Type: application/json
{
"content" : [ {
"uuid" : "c6122180-1cfc-4190-8d6a-cd2b08a313b8",
"name" : "Top",
"topset_name" : "Top Set",
"md" : {
"val" : 9.84251968503937
},
"dip" : {
"val" : 114.59155902616465
},
"azimuth" : {
"val" : 57.29577951308232
},
"dip_classification" : "dip classification",
"confidence" : {
"val" : 0.5
},
"source" : "source",
"model_info" : "model info"
}, {
"uuid" : "6f33573e-4f47-4135-8200-d54002c87e37",
"name" : "Update Top",
"topset_name" : "Top Set",
"md" : {
"val" : 13.123359580052492
},
"dip" : {
"val" : 171.88733853924697
},
"azimuth" : {
"val" : 114.59155902616465
},
"dip_classification" : "update dip classification",
"confidence" : {
"val" : 0.5
},
"source" : "update source",
"model_info" : "update model info"
} ],
"offset" : 0,
"limit" : 20,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/topsets/{uuid}/tops
| Path parameter | Description |
|---|---|
uuid |
Topset UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Top UUID |
content[].name |
String |
Top name |
content[].topset_name |
String |
Topset name |
content[].md.val |
Number |
Measured depth value in project units |
content[].dip.val |
Number |
Dip value in degrees |
content[].azimuth.val |
Number |
Azimuth value in degrees |
content[].dip_classification |
String |
Dip classification |
content[].confidence.val |
Number |
Confidence value |
content[].source |
String |
Top source (manual when not set) |
content[].model_info |
String |
Model info |
Get tops by lateral
Get a list of tops of all lateral topsets by lateral UUID with pagination, in creation order
Request
$ curl 'https://solo.cloud/public/api/v1/wells/e70f4cba-4a7a-435d-8f22-887edd297707/tops?offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/e70f4cba-4a7a-435d-8f22-887edd297707/tops?offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9b1b1fbad345960ec228bb0e8e4127f2
Content-Type: application/json
{
"content" : [ {
"uuid" : "19692f07-33da-4891-a608-005a1e2276d3",
"name" : "Top",
"topset_name" : "Top Set",
"md" : {
"val" : 9.84251968503937
},
"dip" : {
"val" : 114.59155902616465
},
"azimuth" : {
"val" : 57.29577951308232
},
"dip_classification" : "dip classification",
"confidence" : {
"val" : 0.5
},
"source" : "source",
"model_info" : "model info"
}, {
"uuid" : "b092a61d-ac01-4e4f-a6cb-41c7c46912b1",
"name" : "Update Top",
"topset_name" : "Top Set",
"md" : {
"val" : 13.123359580052492
},
"dip" : {
"val" : 171.88733853924697
},
"azimuth" : {
"val" : 114.59155902616465
},
"dip_classification" : "update dip classification",
"confidence" : {
"val" : 0.5
},
"source" : "update source",
"model_info" : "update model info"
} ],
"offset" : 0,
"limit" : 20,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/tops
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Top UUID |
content[].name |
String |
Top name |
content[].topset_name |
String |
Topset name |
content[].md.val |
Number |
Measured depth value in project units |
content[].dip.val |
Number |
Dip value in degrees |
content[].azimuth.val |
Number |
Azimuth value in degrees |
content[].dip_classification |
String |
Dip classification |
content[].confidence.val |
Number |
Confidence value |
content[].source |
String |
Top source (manual when not set) |
content[].model_info |
String |
Model info |
Get tops by typewell
Get a list of tops of all typewell topsets by typewell UUID with pagination, in creation order
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/c581cc1a-9de0-45fc-8a8d-b0bc613f3832/tops?offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/c581cc1a-9de0-45fc-8a8d-b0bc613f3832/tops?offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: b9e6d8a73c79ae182c692bcf9ac15e9e
Content-Type: application/json
{
"content" : [ {
"uuid" : "1020d6a2-0d66-41f9-93bd-5f7ea2294aea",
"name" : "Top",
"topset_name" : "Top Set",
"md" : {
"val" : 9.84251968503937
},
"dip" : {
"val" : 114.59155902616465
},
"azimuth" : {
"val" : 57.29577951308232
},
"dip_classification" : "dip classification",
"confidence" : {
"val" : 0.5
},
"source" : "source",
"model_info" : "model info"
}, {
"uuid" : "4c4f9d4d-7db5-438d-aff2-6e728e2bc9e8",
"name" : "Update Top",
"topset_name" : "Top Set",
"md" : {
"val" : 13.123359580052492
},
"dip" : {
"val" : 171.88733853924697
},
"azimuth" : {
"val" : 114.59155902616465
},
"dip_classification" : "update dip classification",
"confidence" : {
"val" : 0.5
},
"source" : "update source",
"model_info" : "update model info"
} ],
"offset" : 0,
"limit" : 20,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/typewells/{uuid}/tops
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Top UUID |
content[].name |
String |
Top name |
content[].topset_name |
String |
Topset name |
content[].md.val |
Number |
Measured depth value in project units |
content[].dip.val |
Number |
Dip value in degrees |
content[].azimuth.val |
Number |
Azimuth value in degrees |
content[].dip_classification |
String |
Dip classification |
content[].confidence.val |
Number |
Confidence value |
content[].source |
String |
Top source (manual when not set) |
content[].model_info |
String |
Model info |
Get tops by nested well
Get a list of tops of all nested well topsets by nested well UUID with pagination, in creation order
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/383b4e5b-a35d-4a96-ab0b-38296e6fe196/tops?offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/nestedwells/383b4e5b-a35d-4a96-ab0b-38296e6fe196/tops?offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a1c9ba71c20c9885c8e861de39b7ef39
Content-Type: application/json
{
"content" : [ {
"uuid" : "f6121b93-2b61-4444-b3e3-2614b0042a0f",
"name" : "Top",
"topset_name" : "Top Set",
"md" : {
"val" : 9.84251968503937
},
"dip" : {
"val" : 114.59155902616465
},
"azimuth" : {
"val" : 57.29577951308232
},
"dip_classification" : "dip classification",
"confidence" : {
"val" : 0.5
},
"source" : "source",
"model_info" : "model info"
}, {
"uuid" : "3b3f2447-5ed6-4487-85b5-98c0eeaf1a85",
"name" : "Update Top",
"topset_name" : "Top Set",
"md" : {
"val" : 13.123359580052492
},
"dip" : {
"val" : 171.88733853924697
},
"azimuth" : {
"val" : 114.59155902616465
},
"dip_classification" : "update dip classification",
"confidence" : {
"val" : 0.5
},
"source" : "update source",
"model_info" : "update model info"
} ],
"offset" : 0,
"limit" : 20,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/nestedwells/{uuid}/tops
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Top UUID |
content[].name |
String |
Top name |
content[].topset_name |
String |
Topset name |
content[].md.val |
Number |
Measured depth value in project units |
content[].dip.val |
Number |
Dip value in degrees |
content[].azimuth.val |
Number |
Azimuth value in degrees |
content[].dip_classification |
String |
Dip classification |
content[].confidence.val |
Number |
Confidence value |
content[].source |
String |
Top source (manual when not set) |
content[].model_info |
String |
Model info |
Update top
Update top by UUID. Omitted or null fields keep their current values. Returns 403 if the topset is locked or is a private topset of another user
Request
$ curl 'https://solo.cloud/public/api/v1/tops/b092a61d-ac01-4e4f-a6cb-41c7c46912b1' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "New top name",
"md" : {
"val" : 999.5
},
"dip" : {
"val" : 90.0
},
"azimuth" : {
"val" : 359.999
},
"dip_classification" : "thin_bed",
"confidence" : {
"val" : 0.98
},
"source" : "ai",
"model_info" : "model-v1"
}'
PATCH /public/api/v1/tops/b092a61d-ac01-4e4f-a6cb-41c7c46912b1 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 264
{
"name" : "New top name",
"md" : {
"val" : 999.5
},
"dip" : {
"val" : 90.0
},
"azimuth" : {
"val" : 359.999
},
"dip_classification" : "thin_bed",
"confidence" : {
"val" : 0.98
},
"source" : "ai",
"model_info" : "model-v1"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 97d8739dde76467c50a8cb67c24e1f4c
PATCH /public/api/v1/tops/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Top UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Top name (up to 1000 characters, required on create) |
md |
Object |
Measured depth (required on create). If present val is set, otherwise undefined is true |
md.val |
Number |
Measured depth value in project units, must be in [0;100000] range, otherwise 406 is returned |
md.undefined |
Boolean |
Set to true if MD is undefined, MD is then stored as 0 |
dip |
Object |
Dip. If present val is set, otherwise undefined is true |
dip.val |
Number |
Dip value in degrees, must be in [0;90] range, otherwise 400 is returned |
dip.undefined |
Boolean |
Set to true if dip is undefined |
azimuth |
Object |
Azimuth. If present val is set, otherwise undefined is true |
azimuth.val |
Number |
Azimuth value in degrees, must be in [0;360) range, otherwise 400 is returned |
azimuth.undefined |
Boolean |
Set to true if azimuth is undefined |
dip_classification |
String |
Dip classification, must be null or one of: bedding, thin_bed, fault, fracture_open, fracture_healed, fracture_induced, otherwise 400 is returned |
confidence |
Object |
Confidence. If present val is set, otherwise undefined is true |
confidence.val |
Number |
Confidence value, must be in [0;1] range, otherwise 400 is returned |
confidence.undefined |
Boolean |
Set to true if confidence is undefined |
source |
String |
Top source, must be null or one of: manual, ai, otherwise 400 is returned |
model_info |
String |
Model info |
Response body
Empty body
Delete top
Delete top by UUID. Returns 403 if the topset is locked or is a private topset of another user
Request
$ curl 'https://solo.cloud/public/api/v1/tops/b092a61d-ac01-4e4f-a6cb-41c7c46912b1' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/tops/b092a61d-ac01-4e4f-a6cb-41c7c46912b1 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 93b3411070a769db2ef4aa1410629156
DELETE /public/api/v1/tops/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Top UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
9. Target lines
Create target line
Create target line from origin and target points by lateral UUID. All fields are required, all coordinates must be defined. A missing field returns 400, an undefined coordinate 406
Request
$ curl 'https://solo.cloud/public/api/v1/wells/7b5e708e-8dd2-4ea0-a19a-45706146a1ad/targetlines' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Target line name",
"origin_x" : {
"val" : 100.5
},
"origin_y" : {
"val" : 200.5
},
"origin_z" : {
"val" : 300.5
},
"target_x" : {
"val" : 400.5
},
"target_y" : {
"val" : 500.5
},
"target_z" : {
"val" : 600.5
}
}'
POST /public/api/v1/wells/7b5e708e-8dd2-4ea0-a19a-45706146a1ad/targetlines HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 273
{
"name" : "Target line name",
"origin_x" : {
"val" : 100.5
},
"origin_y" : {
"val" : 200.5
},
"origin_z" : {
"val" : 300.5
},
"target_x" : {
"val" : 400.5
},
"target_y" : {
"val" : 500.5
},
"target_z" : {
"val" : 600.5
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 1138d99a03e67cddd495ee1356fb44f6
Content-Type: application/json
{
"uuid" : "dd3b244c-7361-4fc3-abeb-6a9f88f598f6"
}
POST /public/api/v1/wells/{uuid}/targetlines
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Target line name (up to 1000 characters) |
origin_x.val |
Number |
Origin point X coordinate (project units) |
origin_y.val |
Number |
Origin point Y coordinate (project units) |
origin_z.val |
Number |
Origin point Z coordinate (project units) |
target_x.val |
Number |
Target point X coordinate (project units) |
target_y.val |
Number |
Target point Y coordinate (project units) |
target_z.val |
Number |
Target point Z coordinate (project units) |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created target line UUID |
Create target line from waypoints
Create target line from waypoints by lateral UUID. At least two waypoints with defined coordinates and unique order values are required. A missing field returns 400, an undefined coordinate 406, fewer than two waypoints or duplicate order values return 400
Request
$ curl 'https://solo.cloud/public/api/v1/wells/f0c0bb41-76d3-497a-8290-1ffd339f05a7/targetlines/fromwaypoints' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Target line name",
"waypoints" : [ {
"name" : "Waypoint1",
"break" : false,
"order" : 2,
"x" : {
"val" : 30.0
},
"y" : {
"val" : 10.0
},
"z" : {
"val" : 40.0
}
}, {
"name" : "Waypoint2",
"break" : false,
"order" : 3,
"x" : {
"val" : 70.0
},
"y" : {
"val" : 80.0
},
"z" : {
"val" : 90.0
}
} ]
}'
POST /public/api/v1/wells/f0c0bb41-76d3-497a-8290-1ffd339f05a7/targetlines/fromwaypoints HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 421
{
"name" : "Target line name",
"waypoints" : [ {
"name" : "Waypoint1",
"break" : false,
"order" : 2,
"x" : {
"val" : 30.0
},
"y" : {
"val" : 10.0
},
"z" : {
"val" : 40.0
}
}, {
"name" : "Waypoint2",
"break" : false,
"order" : 3,
"x" : {
"val" : 70.0
},
"y" : {
"val" : 80.0
},
"z" : {
"val" : 90.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 999d5b9ee34d23290a5301313702d50f
Content-Type: application/json
{
"uuid" : "93727f4c-356f-42d7-a215-eebcfce7c893"
}
POST /public/api/v1/wells/{uuid}/targetlines/fromwaypoints
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Target line name (up to 1000 characters) |
waypoints |
Array |
Target line waypoints, at least two |
waypoints[].name |
String |
Waypoint name (up to 200 characters). Get target lines by lateral returns generated names instead |
waypoints[].order |
Number |
Waypoint order: waypoints are sorted by it, values must be unique |
waypoints[].x.val |
Number |
Waypoint X coordinate (project units) |
waypoints[].y.val |
Number |
Waypoint Y coordinate (project units) |
waypoints[].z.val |
Number |
Waypoint Z coordinate (project units) |
waypoints[].break |
Boolean |
Is the waypoint break point or not |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created target line UUID |
Get target lines by lateral
Get a list of target lines with their waypoints by lateral UUID with pagination, in creation order. Waypoints are returned sorted by order, renumbered from 0 and named Origin, WP1, WP2, ..., Target
Request
$ curl 'https://solo.cloud/public/api/v1/wells/091dee97-27db-42ca-b677-d6b7b633d4ef/targetlines?offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/091dee97-27db-42ca-b677-d6b7b633d4ef/targetlines?offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 1eccca5ef895b519c286814b1ba5911c
Content-Type: application/json
{
"content" : [ {
"uuid" : "10a341fd-82e4-4e8f-8acd-f7bdf1f6facc",
"name" : "Target Line",
"waypoints" : [ {
"name" : "Origin",
"order" : 0,
"x" : {
"val" : 3.280839895013123
},
"y" : {
"val" : 6.561679790026246
},
"z" : {
"val" : 9.84251968503937
},
"top_corridor_tvd" : {
"undefined" : true
},
"base_corridor_tvd" : {
"undefined" : true
},
"left_corridor" : {
"undefined" : true
},
"right_corridor" : {
"undefined" : true
},
"break" : false
}, {
"name" : "Target",
"order" : 1,
"x" : {
"val" : 13.123359580052492
},
"y" : {
"val" : 16.404199475065617
},
"z" : {
"val" : 19.68503937007874
},
"top_corridor_tvd" : {
"val" : 25.0
},
"base_corridor_tvd" : {
"val" : 25.0
},
"left_corridor" : {
"val" : 25.0
},
"right_corridor" : {
"val" : 25.0
},
"break" : false
} ]
}, {
"uuid" : "4cdee81c-2f4f-4e22-9e1e-e052a37b27f2",
"name" : "Update Target Line",
"waypoints" : [ {
"name" : "Origin",
"order" : 0,
"x" : {
"val" : 36.41732283464567
},
"y" : {
"val" : 39.69816272965879
},
"z" : {
"val" : 42.979002624671914
},
"top_corridor_tvd" : {
"undefined" : true
},
"base_corridor_tvd" : {
"undefined" : true
},
"left_corridor" : {
"undefined" : true
},
"right_corridor" : {
"undefined" : true
},
"break" : false
}, {
"name" : "Target",
"order" : 1,
"x" : {
"val" : 46.25984251968504
},
"y" : {
"val" : 49.54068241469816
},
"z" : {
"val" : 52.82152230971129
},
"top_corridor_tvd" : {
"val" : 28.608923884514432
},
"base_corridor_tvd" : {
"val" : 28.608923884514432
},
"left_corridor" : {
"val" : 25.0
},
"right_corridor" : {
"val" : 25.0
},
"break" : false
} ]
} ],
"offset" : 0,
"limit" : 20,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/targetlines
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Target line UUID |
content[].name |
String |
Target line name |
content[].waypoints |
Array |
Target line waypoints sorted by order |
content[].waypoints[].name |
String |
Waypoint name: Origin for the first waypoint, Target for the last one, WP1, WP2, ... for the others |
content[].waypoints[].order |
Number |
Zero-based index of the waypoint in the list |
content[].waypoints[].x.val |
Number |
Waypoint X coordinate (project units) |
content[].waypoints[].y.val |
Number |
Waypoint Y coordinate (project units) |
content[].waypoints[].z.val |
Number |
Waypoint Z coordinate (project units) |
content[].waypoints[].top_corridor_tvd |
Object |
Waypoint top corridor: vertical distance above the target line. If present val is set, otherwise undefined is true (always for the first waypoint) |
content[].waypoints[].top_corridor_tvd.val |
Number |
Waypoint top corridor value (project units) |
content[].waypoints[].base_corridor_tvd |
Object |
Waypoint base corridor: vertical distance below the target line. If present val is set, otherwise undefined is true (always for the first waypoint) |
content[].waypoints[].base_corridor_tvd.val |
Number |
Waypoint base corridor value (project units) |
content[].waypoints[].left_corridor |
Object |
Waypoint left corridor width. If present val is set, otherwise undefined is true (always for the first waypoint) |
content[].waypoints[].left_corridor.val |
Number |
Waypoint left corridor value (project units) |
content[].waypoints[].right_corridor |
Object |
Waypoint right corridor width. If present val is set, otherwise undefined is true (always for the first waypoint) |
content[].waypoints[].right_corridor.val |
Number |
Waypoint right corridor value (project units) |
content[].waypoints[].break |
Boolean |
Is the waypoint break point or not |
Get target line data
Get calculated data of a target line by target line UUID. The content array holds one element
Request
$ curl 'https://solo.cloud/public/api/v1/targetlines/8b7bb5d6-4e72-452f-a772-57cbf03bdb70/data' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/targetlines/8b7bb5d6-4e72-452f-a772-57cbf03bdb70/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: dd12de7188ffd6845f8c6a00d0609fae
Content-Type: application/json
{
"content" : [ {
"azimuth" : {
"val" : 45
},
"delta_tvd" : {
"val" : -9.842519685039372
},
"delta_vs" : {
"val" : 9.842519685039374
},
"inclination" : {
"val" : 125.26438968275465
},
"length" : {
"val" : 17.047744168985016
},
"name" : "Target Line",
"origin_base_corridor_tvd" : {
"val" : 38.1233595800525
},
"origin_md" : {
"val" : 1594.0953719875106
},
"origin_top_corridor_tvd" : {
"val" : -11.876640419947508
},
"origin_tvd" : {
"val" : 13.123359580052496
},
"origin_vs" : {
"val" : -26.246719160104988
},
"origin_x" : {
"val" : 3.280839895013124
},
"origin_y" : {
"val" : 6.561679790026248
},
"origin_z" : {
"val" : 9.842519685039372
},
"target_base_corridor_tvd" : {
"val" : 28.280839895013127
},
"target_md" : {
"val" : 1106.7125786029799
},
"target_top_corridor_tvd" : {
"val" : -21.71916010498688
},
"target_tvd" : {
"val" : 3.2808398950131235
},
"target_vs" : {
"val" : -16.404199475065614
},
"target_x" : {
"val" : 13.123359580052496
},
"target_y" : {
"val" : 16.40419947506562
},
"target_z" : {
"val" : 19.685039370078744
},
"tvd_vs" : {
"val" : -13.123359580052487
},
"uuid" : "8b7bb5d6-4e72-452f-a772-57cbf03bdb70"
} ]
}
GET /public/api/v1/targetlines/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Target line UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content[].name |
String |
Target line name |
content[].uuid |
String |
Target line UUID |
content[].azimuth.val |
Number |
Azimuth (degrees) |
content[].inclination.val |
Number |
Inclination (degrees) |
content[].length.val |
Number |
Length (project units) |
content[].delta_tvd.val |
Number |
Target TVD minus origin TVD (project units) |
content[].delta_vs.val |
Number |
Target VS minus origin VS (project units) |
content[].tvd_vs.val |
Number |
TVD of the target line at zero VS (TVD@0VS) |
content[].origin_vs.val |
Number |
Origin point VS (project units) |
content[].origin_tvd.val |
Number |
Origin point TVD (project units) |
content[].origin_x.val |
Number |
Origin point X coordinate (project units) |
content[].origin_y.val |
Number |
Origin point Y coordinate (project units) |
content[].origin_z.val |
Number |
Origin point Z coordinate (project units) |
content[].origin_md |
Object |
Origin MD value. If target line belongs to trajectory val is set, otherwise undefined is true |
content[].origin_md.val |
Number |
Origin MD value (project units) |
content[].origin_md.undefined |
Boolean |
true if origin MD undefined |
content[].origin_base_corridor_tvd |
Object |
Base corridor origin TVD. If present val is set, otherwise undefined is true |
content[].origin_base_corridor_tvd.val |
Number |
Base corridor origin TVD value (project units) |
content[].origin_base_corridor_tvd.undefined |
Boolean |
true if base corridor origin is undefined |
content[].origin_top_corridor_tvd |
Object |
Top corridor origin TVD. If present val is set, otherwise undefined is true |
content[].origin_top_corridor_tvd.val |
Number |
Top corridor origin TVD (project units) |
content[].origin_top_corridor_tvd.undefined |
Boolean |
true if top TVD corridor is undefined |
content[].target_vs.val |
Number |
Target point VS (project units) |
content[].target_tvd.val |
Number |
Target point TVD (project units) |
content[].target_x.val |
Number |
Target point X coordinate (project units) |
content[].target_y.val |
Number |
Target point Y coordinate (project units) |
content[].target_z.val |
Number |
Target point Z coordinate (project units) |
content[].target_md |
Object |
Target MD. If target line belongs to trajectory val is set, otherwise undefined is true |
content[].target_md.val |
Number |
Target MD value (project units) |
content[].target_md.undefined |
Boolean |
true if target MD is undefined |
content[].target_base_corridor_tvd |
Object |
Base corridor target TVD. If present val is set, otherwise undefined is true |
content[].target_base_corridor_tvd.val |
Number |
Base corridor target TVD (project units) |
content[].target_base_corridor_tvd.undefined |
Boolean |
true if base corridor target TVD is undefined |
content[].target_top_corridor_tvd |
Object |
Top corridor target TVD. If present val is set, otherwise undefined is true |
content[].target_top_corridor_tvd.val |
Number |
Top corridor target TVD (project units) |
content[].target_top_corridor_tvd.undefined |
Boolean |
true if top corridor target TVD is undefined |
Get target lines data by lateral
Get calculated data of all lateral target lines by lateral UUID with pagination, sorted by target line name
Request
$ curl 'https://solo.cloud/public/api/v1/wells/c3da69ea-27f7-4ee9-8b53-5df1e8f9003b/targetlines/data?offset=0&limit=20' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/c3da69ea-27f7-4ee9-8b53-5df1e8f9003b/targetlines/data?offset=0&limit=20 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 883a500ea309441403be0eca914f9016
Content-Type: application/json
{
"content" : [ {
"azimuth" : {
"val" : 45
},
"delta_tvd" : {
"val" : -9.842519685039372
},
"delta_vs" : {
"val" : 9.842519685039374
},
"inclination" : {
"val" : 125.26438968275465
},
"length" : {
"val" : 17.047744168985016
},
"name" : "Target Line",
"origin_base_corridor_tvd" : {
"val" : 38.1233595800525
},
"origin_md" : {
"val" : 1594.0953719875106
},
"origin_top_corridor_tvd" : {
"val" : -11.876640419947508
},
"origin_tvd" : {
"val" : 13.123359580052496
},
"origin_vs" : {
"val" : -26.246719160104988
},
"origin_x" : {
"val" : 3.280839895013124
},
"origin_y" : {
"val" : 6.561679790026248
},
"origin_z" : {
"val" : 9.842519685039372
},
"target_base_corridor_tvd" : {
"val" : 28.280839895013127
},
"target_md" : {
"val" : 1106.7125786029799
},
"target_top_corridor_tvd" : {
"val" : -21.71916010498688
},
"target_tvd" : {
"val" : 3.2808398950131235
},
"target_vs" : {
"val" : -16.404199475065614
},
"target_x" : {
"val" : 13.123359580052496
},
"target_y" : {
"val" : 16.40419947506562
},
"target_z" : {
"val" : 19.685039370078744
},
"tvd_vs" : {
"val" : -13.123359580052487
},
"uuid" : "42abe6f1-3455-430c-86c6-b79e7e0cc40e"
} ],
"offset" : 0,
"limit" : 20,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/targetlines/data
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Target line name |
content[].uuid |
String |
Target line UUID |
content[].azimuth.val |
Number |
Azimuth (degrees) |
content[].inclination.val |
Number |
Inclination (degrees) |
content[].length.val |
Number |
Length (project units) |
content[].delta_tvd.val |
Number |
Target TVD minus origin TVD (project units) |
content[].delta_vs.val |
Number |
Target VS minus origin VS (project units) |
content[].tvd_vs.val |
Number |
TVD of the target line at zero VS (TVD@0VS) |
content[].origin_vs.val |
Number |
Origin point VS (project units) |
content[].origin_tvd.val |
Number |
Origin point TVD (project units) |
content[].origin_x.val |
Number |
Origin point X coordinate (project units) |
content[].origin_y.val |
Number |
Origin point Y coordinate (project units) |
content[].origin_z.val |
Number |
Origin point Z coordinate (project units) |
content[].origin_md |
Object |
Origin MD value. If target line belongs to trajectory val is set, otherwise undefined is true |
content[].origin_md.val |
Number |
Origin MD value (project units) |
content[].origin_md.undefined |
Boolean |
true if origin MD undefined |
content[].origin_base_corridor_tvd |
Object |
Base corridor origin TVD. If present val is set, otherwise undefined is true |
content[].origin_base_corridor_tvd.val |
Number |
Base corridor origin TVD value (project units) |
content[].origin_base_corridor_tvd.undefined |
Boolean |
true if base corridor origin is undefined |
content[].origin_top_corridor_tvd |
Object |
Top corridor origin TVD. If present val is set, otherwise undefined is true |
content[].origin_top_corridor_tvd.val |
Number |
Top corridor origin TVD (project units) |
content[].origin_top_corridor_tvd.undefined |
Boolean |
true if top TVD corridor is undefined |
content[].target_vs.val |
Number |
Target point VS (project units) |
content[].target_tvd.val |
Number |
Target point TVD (project units) |
content[].target_x.val |
Number |
Target point X coordinate (project units) |
content[].target_y.val |
Number |
Target point Y coordinate (project units) |
content[].target_z.val |
Number |
Target point Z coordinate (project units) |
content[].target_md |
Object |
Target MD. If target line belongs to trajectory val is set, otherwise undefined is true |
content[].target_md.val |
Number |
Target MD value (project units) |
content[].target_md.undefined |
Boolean |
true if target MD is undefined |
content[].target_base_corridor_tvd |
Object |
Base corridor target TVD. If present val is set, otherwise undefined is true |
content[].target_base_corridor_tvd.val |
Number |
Base corridor target TVD (project units) |
content[].target_base_corridor_tvd.undefined |
Boolean |
true if base corridor target TVD is undefined |
content[].target_top_corridor_tvd |
Object |
Top corridor target TVD. If present val is set, otherwise undefined is true |
content[].target_top_corridor_tvd.val |
Number |
Top corridor target TVD (project units) |
content[].target_top_corridor_tvd.undefined |
Boolean |
true if top corridor target TVD is undefined |
Get starred target line by lateral
Get starred target line by lateral UUID. Returns 404 if the lateral has no starred target line
Request
$ curl 'https://solo.cloud/public/api/v1/wells/aa147215-ec2b-4c0a-8699-b259aacee391/targetlines/starred' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/aa147215-ec2b-4c0a-8699-b259aacee391/targetlines/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 1ffbd9aa5dbba7c440390dc1c38f2df0
Content-Type: application/json
{
"name" : "Target Line",
"uuid" : "c7cdeac7-673c-4c28-a666-f68d188c0d17"
}
GET /public/api/v1/wells/{uuid}/targetlines/starred
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Target line UUID |
name |
String |
Target line name |
Update target line
Update target line name, origin and target points by UUID. All fields are required, all coordinates must be defined. A missing field returns 400, an undefined coordinate 406
For a line with more than two waypoints, the origin and target points are written to its first two waypoints (Origin and WP1 in Get target lines by lateral) and the other waypoints are kept. Use Update target line from waypoints to change any waypoint
Request
$ curl 'https://solo.cloud/public/api/v1/targetlines/9460ed99-3d0f-4a7d-b7d9-c1322fa276f6' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "New target line name",
"origin_x" : {
"val" : 1000.5
},
"origin_y" : {
"val" : 2000.5
},
"origin_z" : {
"val" : 3000.5
},
"target_x" : {
"val" : 4000.5
},
"target_y" : {
"val" : 5000.5
},
"target_z" : {
"val" : 6000.5
}
}'
PATCH /public/api/v1/targetlines/9460ed99-3d0f-4a7d-b7d9-c1322fa276f6 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 283
{
"name" : "New target line name",
"origin_x" : {
"val" : 1000.5
},
"origin_y" : {
"val" : 2000.5
},
"origin_z" : {
"val" : 3000.5
},
"target_x" : {
"val" : 4000.5
},
"target_y" : {
"val" : 5000.5
},
"target_z" : {
"val" : 6000.5
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 422d9619348a2ed892aea140cd071073
PATCH /public/api/v1/targetlines/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Target line UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Target line name (up to 1000 characters) |
origin_x.val |
Number |
Origin point X coordinate (project units) |
origin_y.val |
Number |
Origin point Y coordinate (project units) |
origin_z.val |
Number |
Origin point Z coordinate (project units) |
target_x.val |
Number |
Target point X coordinate (project units) |
target_y.val |
Number |
Target point Y coordinate (project units) |
target_z.val |
Number |
Target point Z coordinate (project units) |
Response body
Empty body
Update target line from waypoints
Replace target line name and waypoints by UUID. At least two waypoints with defined coordinates and unique order values are required. A missing field returns 400, an undefined coordinate 406, fewer than two waypoints or duplicate order values return 400
Request
$ curl 'https://solo.cloud/public/api/v1/targetlines/7889c46b-6fa9-46ee-a468-9ff3c47318cd/fromwaypoints' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Target line updated name",
"waypoints" : [ {
"name" : "Waypoint100",
"break" : false,
"order" : 2,
"x" : {
"val" : 30.0
},
"y" : {
"val" : 10.0
},
"z" : {
"val" : 40.0
}
}, {
"name" : "Waypoint500",
"break" : false,
"order" : 3,
"x" : {
"val" : 70.0
},
"y" : {
"val" : 80.0
},
"z" : {
"val" : 90.0
}
} ]
}'
PATCH /public/api/v1/targetlines/7889c46b-6fa9-46ee-a468-9ff3c47318cd/fromwaypoints HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 433
{
"name" : "Target line updated name",
"waypoints" : [ {
"name" : "Waypoint100",
"break" : false,
"order" : 2,
"x" : {
"val" : 30.0
},
"y" : {
"val" : 10.0
},
"z" : {
"val" : 40.0
}
}, {
"name" : "Waypoint500",
"break" : false,
"order" : 3,
"x" : {
"val" : 70.0
},
"y" : {
"val" : 80.0
},
"z" : {
"val" : 90.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5a95d4984bcdf8c6992adc777697626d
PATCH /public/api/v1/targetlines/{uuid}/fromwaypoints
| Path parameter | Description |
|---|---|
uuid |
Target line UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Target line name (up to 1000 characters) |
waypoints |
Array |
Target line waypoints, at least two |
waypoints[].name |
String |
Waypoint name (up to 200 characters). Get target lines by lateral returns generated names instead |
waypoints[].order |
Number |
Waypoint order: waypoints are sorted by it, values must be unique |
waypoints[].x.val |
Number |
Waypoint X coordinate (project units) |
waypoints[].y.val |
Number |
Waypoint Y coordinate (project units) |
waypoints[].z.val |
Number |
Waypoint Z coordinate (project units) |
waypoints[].break |
Boolean |
Is the waypoint break point or not |
Response body
Empty body
Delete target line
Delete target line by UUID. Returns 403 if the target line is locked or is a private target line of another user
Request
$ curl 'https://solo.cloud/public/api/v1/targetlines/ba3d3c8d-0fb8-4aa7-ae12-e3947b65257a' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/targetlines/ba3d3c8d-0fb8-4aa7-ae12-e3947b65257a HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f75459afe5be6c591bad086cef26bfb9
DELETE /public/api/v1/targetlines/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Target line UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
10. Logs
Create lateral log
Create log by lateral UUID. The log is created without data and is not listed by Get logs by lateral until data is uploaded with Extend log data or Replace log data
Request
$ curl 'https://solo.cloud/public/api/v1/wells/1c2b479c-aeeb-4025-b84f-5daf11b055cb/logs' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Log name"
}'
POST /public/api/v1/wells/1c2b479c-aeeb-4025-b84f-5daf11b055cb/logs HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 25
{
"name" : "Log name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 68e8576e8599b3c31d9b0ab737a0b61d
Content-Type: application/json
{
"uuid" : "09afc3fe-ee04-44e7-8fe4-6ef28137c9d1"
}
POST /public/api/v1/wells/{uuid}/logs
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Log name, up to 200 characters |
unit |
String |
Measure unit of the log data values, up to 100 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created log UUID |
Create typewell log
Create log by typewell UUID. The log is created without data and is not listed by Get logs by typewell until data is uploaded with Extend log data or Replace log data
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/b28e7bdb-8ca5-4690-8878-774d6d91b575/logs' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Log name"
}'
POST /public/api/v1/typewells/b28e7bdb-8ca5-4690-8878-774d6d91b575/logs HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 25
{
"name" : "Log name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 6b0f3b75f87367064c4cd06b9eff910f
Content-Type: application/json
{
"uuid" : "8b6169b8-24cf-42d4-bdc7-9209030f73df"
}
POST /public/api/v1/typewells/{uuid}/logs
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Log name, up to 200 characters |
unit |
String |
Measure unit of the log data values, up to 100 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created log UUID |
Get logs by lateral
Get a list of logs by lateral UUID with pagination, in creation order. Logs that do not contain data will not be included in the response. After creating the log, you need to fill it with data using the commands Extend log data or Replace log data
Request
$ curl 'https://solo.cloud/public/api/v1/wells/a04d1ef2-0a34-4f6e-afe4-e5b2eac38a60/logs?offset=0&limit=10&filter=mMa' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/a04d1ef2-0a34-4f6e-afe4-e5b2eac38a60/logs?offset=0&limit=10&filter=mMa HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 1efed390520d0ab352a2a93ab22ebb5f
Content-Type: application/json
{
"content" : [ {
"uuid" : "dfa836d3-f860-46a3-a5bf-58ba0e83da7f",
"name" : "Gamma Ray",
"is_discrete" : false
}, {
"uuid" : "6c2754ec-e148-48ad-bad2-ae0a5a844647",
"name" : "Gamma Discrete",
"is_discrete" : true,
"discrete_log_palette" : {
"palette_pairs" : [ {
"palette" : {
"name" : "Name 1",
"color" : "#ffffff00"
},
"discrete_value" : 1
}, {
"palette" : {
"name" : "Name 2",
"color" : "#ff008000"
},
"discrete_value" : 2
}, {
"palette" : {
"name" : "Name 3",
"color" : "#ff000000"
},
"discrete_value" : 3
}, {
"palette" : {
"name" : "Name 4",
"color" : "#ff00bfff"
},
"discrete_value" : 4
} ],
"out_of_range_color" : "#ff8f9ac1"
}
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/logs
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the logs whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Log name |
content[].unit |
String |
Measure unit of the log data values. Absent when not set |
content[].is_discrete |
Boolean |
true for discrete logs, otherwise false |
content[].discrete_log_palette |
Object |
Discrete log palette settings. Present only for discrete logs |
content[].discrete_log_palette.palette_pairs |
Array |
Palette mappings for discrete values |
content[].discrete_log_palette.palette_pairs[].palette |
Object |
Palette item for the discrete value |
content[].discrete_log_palette.palette_pairs[].palette.name |
String |
Palette item name |
content[].discrete_log_palette.palette_pairs[].palette.color |
String |
Palette item color: # followed by 8 hex digits, e.g. #ff00bfff |
content[].discrete_log_palette.palette_pairs[].discrete_value |
Number |
Discrete value mapped to the palette item |
content[].discrete_log_palette.out_of_range_color |
String |
Out-of-range color for discrete log palette |
content[].uuid |
String |
Log UUID |
Get logs by typewell
Get a list of logs by typewell UUID with pagination, in creation order. Logs that do not contain data will not be included in the response. After creating the log, you need to fill it with data using the commands Extend log data or Replace log data
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/ba5191af-34f8-453f-a17e-c4ae46d57068/logs?offset=0&limit=10&filter=mMa' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/ba5191af-34f8-453f-a17e-c4ae46d57068/logs?offset=0&limit=10&filter=mMa HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3358404b35fe556e64e80994dd17a20d
Content-Type: application/json
{
"content" : [ {
"uuid" : "bdb98a32-dd5a-4494-a1d6-28de74e000a3",
"name" : "Gamma Ray",
"is_discrete" : false
}, {
"uuid" : "28a7972c-db6d-47a8-b38f-eebd924ab932",
"name" : "Gamma Discrete",
"is_discrete" : true,
"discrete_log_palette" : {
"palette_pairs" : [ {
"palette" : {
"name" : "Name 1",
"color" : "#ffffff00"
},
"discrete_value" : 1
}, {
"palette" : {
"name" : "Name 2",
"color" : "#ff008000"
},
"discrete_value" : 2
}, {
"palette" : {
"name" : "Name 3",
"color" : "#ff000000"
},
"discrete_value" : 3
}, {
"palette" : {
"name" : "Name 4",
"color" : "#ff00bfff"
},
"discrete_value" : 4
} ],
"out_of_range_color" : "#ff8f9ac1"
}
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/typewells/{uuid}/logs
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the logs whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Log name |
content[].unit |
String |
Measure unit of the log data values. Absent when not set |
content[].is_discrete |
Boolean |
true for discrete logs, otherwise false |
content[].discrete_log_palette |
Object |
Discrete log palette settings. Present only for discrete logs |
content[].discrete_log_palette.palette_pairs |
Array |
Palette mappings for discrete values |
content[].discrete_log_palette.palette_pairs[].palette |
Object |
Palette item for the discrete value |
content[].discrete_log_palette.palette_pairs[].palette.name |
String |
Palette item name |
content[].discrete_log_palette.palette_pairs[].palette.color |
String |
Palette item color: # followed by 8 hex digits, e.g. #ff00bfff |
content[].discrete_log_palette.palette_pairs[].discrete_value |
Number |
Discrete value mapped to the palette item |
content[].discrete_log_palette.out_of_range_color |
String |
Out-of-range color for discrete log palette |
content[].uuid |
String |
Log UUID |
Get log data
Get log data by UUID. MD values are returned in the project depth unit, data values as stored. An undefined value is returned as {"undefined": true} instead of {"val": ...}. Returns 404 if the log has no data yet
Request
$ curl 'https://solo.cloud/public/api/v1/logs/2bd93796-45b2-429e-9d1b-cababae7fda8/data' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/logs/2bd93796-45b2-429e-9d1b-cababae7fda8/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 2a31e6c31354e82854eac5fba64be325
Content-Type: application/json
{
"log_points" : [ {
"data" : {
"val" : -3688.6927
},
"md" : {
"val" : 744.6263999999999
}
}, {
"data" : {
"val" : 16.581
},
"md" : {
"val" : 744.7787999999999
}
}, {
"data" : {
"val" : -11.85
},
"md" : {
"val" : 744.9311999999999
}
}, {
"data" : {
"val" : 15.187
},
"md" : {
"val" : 745.0835999999999
}
}, {
"data" : {
"val" : -4.363
},
"md" : {
"val" : 745.2359999999999
}
}, {
"data" : {
"val" : -40.475
},
"md" : {
"val" : 745.3883999999999
}
}, {
"data" : {
"val" : 61.463
},
"md" : {
"val" : 745.5407999999999
}
}, {
"data" : {
"val" : 82.305
},
"md" : {
"val" : 745.6931999999999
}
}, {
"data" : {
"val" : 114.139
},
"md" : {
"val" : 745.8455999999999
}
}, {
"data" : {
"val" : 144.503
},
"md" : {
"val" : 745.9979999999999
}
} ]
}
GET /public/api/v1/logs/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Log UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
log_points |
Array |
Points array |
log_points[].data |
Object |
Point data. For an undefined (null) value it is {"undefined": true} without val |
log_points[].data.val |
Number |
Point data value in the log unit, as stored |
log_points[].md |
Object |
Point MD |
log_points[].md.val |
Number |
Point MD value in the project depth unit (m or ft) |
Update log metadata
Update log metadata by UUID. Only the fields present in the request are changed. To make a log discrete, pass is_discrete = true together with discrete_log_palette: the log data must hold integer values only, and the set of palette discrete_value values must be equal to the set of defined log data values. Making a log discrete also sets its display range to the minimum and maximum palette discrete_value
Request
$ curl 'https://solo.cloud/public/api/v1/logs/6edefce5-25d3-481e-9878-35a879fc6b80' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "New log name",
"is_discrete" : true,
"discrete_log_palette" : {
"palette_pairs" : [ {
"palette" : {
"name" : "Name 1",
"color" : "#ffffff00"
},
"discrete_value" : 1
}, {
"palette" : {
"name" : "Name 2",
"color" : "#ff008000"
},
"discrete_value" : 2
}, {
"palette" : {
"name" : "Name 3",
"color" : "#ff000000"
},
"discrete_value" : 3
}, {
"palette" : {
"name" : "Name 4",
"color" : "#ff00bfff"
},
"discrete_value" : 4
} ],
"out_of_range_color" : "#ff8f9ac1"
}
}'
PATCH /public/api/v1/logs/6edefce5-25d3-481e-9878-35a879fc6b80 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 640
{
"name" : "New log name",
"is_discrete" : true,
"discrete_log_palette" : {
"palette_pairs" : [ {
"palette" : {
"name" : "Name 1",
"color" : "#ffffff00"
},
"discrete_value" : 1
}, {
"palette" : {
"name" : "Name 2",
"color" : "#ff008000"
},
"discrete_value" : 2
}, {
"palette" : {
"name" : "Name 3",
"color" : "#ff000000"
},
"discrete_value" : 3
}, {
"palette" : {
"name" : "Name 4",
"color" : "#ff00bfff"
},
"discrete_value" : 4
} ],
"out_of_range_color" : "#ff8f9ac1"
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d3cc4e3f428103151a7a60715bcdd05e
PATCH /public/api/v1/logs/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Log UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
New log name, up to 200 characters. Omit it to keep the current name |
unit |
String |
Measure unit of the log data values, up to 100 characters. The values themselves are not converted |
is_discrete |
Boolean |
true to make the log discrete (requires discrete_log_palette and log data), false to make it non-discrete. Omit it to keep the current setting |
discrete_log_palette |
Object |
Discrete log palette settings. Required when is_discrete is true, ignored otherwise |
discrete_log_palette.palette_pairs |
Array |
Palette mappings for discrete values, 1 to 50 items. The set of discrete_value values must be equal to the set of defined log data values, which must all be integers |
discrete_log_palette.palette_pairs[].palette |
Object |
Palette item for the discrete value |
discrete_log_palette.palette_pairs[].palette.name |
String |
Palette item name |
discrete_log_palette.palette_pairs[].palette.color |
String |
Palette item color: # followed by 8 hex digits, e.g. #ff00bfff |
discrete_log_palette.palette_pairs[].discrete_value |
Number |
Discrete value mapped to the palette item: an integer, unique within the palette |
discrete_log_palette.out_of_range_color |
String |
Out-of-range color for discrete log palette: # followed by 8 hex digits |
Response body
Empty body
Extend log data
Append points to the log data. Only the request points with MD greater than the last MD of the existing data are added, the other request points are ignored. If the log has no data yet, all points are stored. The new data can become visible in Get log data with a short delay after a successful response. Returns 409 (CONFLICT) if another upload to the same log, such as a real-time feed, was applied at the same moment: nothing of the request is applied, repeat the request
Request
$ curl 'https://solo.cloud/public/api/v1/logs/ce5defed-2fa3-4a6a-8b59-5dbe92ed5175/data' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"log_points" : [ {
"value" : {
"val" : 96.36
},
"index" : {
"val" : 6494.5
}
}, {
"value" : {
"val" : 16.36
},
"index" : {
"val" : -999.25
}
} ],
"value_unit" : "ft",
"index_unit" : "ft"
}'
PATCH /public/api/v1/logs/ce5defed-2fa3-4a6a-8b59-5dbe92ed5175/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 256
{
"log_points" : [ {
"value" : {
"val" : 96.36
},
"index" : {
"val" : 6494.5
}
}, {
"value" : {
"val" : 16.36
},
"index" : {
"val" : -999.25
}
} ],
"value_unit" : "ft",
"index_unit" : "ft"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5b2ea038bef96b0848756936f47dd7f4
PATCH /public/api/v1/logs/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Log UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
index_unit |
String |
Measure unit of the point MD (index) values: m, ft or ftUS (case-sensitive). Defaults to the project depth unit |
value_unit |
String |
Measure unit of the point data values, up to 100 characters. The values are not converted to another unit. When it differs from the current log unit, the log unit is updated. Omit it to keep the current log unit |
log_points |
Array |
Log points array, at least one point with a defined index, otherwise 400 is returned. Each point must contain both index and value |
log_points[].value.val |
Number |
Point data value. For an undefined (null) value pass {"undefined": true} as value. Null-value markers such as -999.25, -999, -9999, -32767 and -99999 are stored as undefined values |
log_points[].index.val |
Number |
Point MD value in index_unit |
Response body
Empty body
Replace log data
Replace all points of the log data with the points of the request. The new data can become visible in Get log data with a short delay after a successful response. Returns 409 (CONFLICT) if another upload to the same log, such as a real-time feed, was applied at the same moment: nothing of the request is applied, repeat the request
Request
$ curl 'https://solo.cloud/public/api/v1/logs/2bd93796-45b2-429e-9d1b-cababae7fda8/data' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"log_points" : [ {
"value" : {
"val" : 96.36
},
"index" : {
"val" : 6494.5
}
}, {
"value" : {
"val" : 16.36
},
"index" : {
"val" : -999.25
}
} ],
"value_unit" : "ft",
"index_unit" : "ft"
}'
PUT /public/api/v1/logs/2bd93796-45b2-429e-9d1b-cababae7fda8/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 256
{
"log_points" : [ {
"value" : {
"val" : 96.36
},
"index" : {
"val" : 6494.5
}
}, {
"value" : {
"val" : 16.36
},
"index" : {
"val" : -999.25
}
} ],
"value_unit" : "ft",
"index_unit" : "ft"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: e5cde04c915df1e641d98c1ebcb83075
PUT /public/api/v1/logs/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Log UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
index_unit |
String |
Measure unit of the point MD (index) values: m, ft or ftUS (case-sensitive). Defaults to the project depth unit |
value_unit |
String |
Measure unit of the point data values, up to 100 characters. The values are not converted to another unit. When it differs from the current log unit, the log unit is updated. Omit it to keep the current log unit |
log_points |
Array |
Log points array, at least one point with a defined index, otherwise 400 is returned. Each point must contain both index and value |
log_points[].value.val |
Number |
Point data value. For an undefined (null) value pass {"undefined": true} as value. Null-value markers such as -999.25, -999, -9999, -32767 and -99999 are stored as undefined values |
log_points[].index.val |
Number |
Point MD value in index_unit |
Response body
Empty body
Move log to well folder
Move log into a folder (at any nesting level) of the lateral or typewell it belongs to, or to the well root when folder is null or omitted. A folder that is not found or belongs to another well returns 400
Request
$ curl 'https://solo.cloud/public/api/v1/logs/e2af6f86-2c7b-434f-854e-381170aff958/folder' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"folder" : "f7580eab-d5dc-4bd2-bef5-2f517500014e"
}'
PUT /public/api/v1/logs/e2af6f86-2c7b-434f-854e-381170aff958/folder HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 55
{
"folder" : "f7580eab-d5dc-4bd2-bef5-2f517500014e"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9d6403cf524fe0e6cf8ef4532036eba2
PUT /public/api/v1/logs/{uuid}/folder
| Path parameter | Description |
|---|---|
uuid |
Log UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
folder |
String |
UUID of a folder of the lateral or typewell the log belongs to. Pass null or omit it to move the log to the well root |
Response body
Empty body
Delete log
Delete log by UUID. Returns 403 if the log is locked or is a private log of another user
Request
$ curl 'https://solo.cloud/public/api/v1/logs/e2af6f86-2c7b-434f-854e-381170aff958' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/logs/e2af6f86-2c7b-434f-854e-381170aff958 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9115f0cdfed06168c243441f7b405fe6
DELETE /public/api/v1/logs/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Log UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
11. Images
Create image
Create image by lateral UUID. The image is placed on the lateral vertical section by its bottom_left and top_right corners (VS in the project horizontal unit, TVDSS in the project depth unit, for METER_FOOT VS is in meters and TVDSS in feet), bottom_left values must be less than the top_right ones. The image is created without content, upload it with Upload image
Request
$ curl 'https://solo.cloud/public/api/v1/wells/49aa0f62-7ac4-4514-a17c-1a11581f476d/images' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "image name",
"azimuth" : {
"val" : 0.0
},
"bottom_left" : {
"vs" : {
"val" : -30.0
},
"tvdss" : {
"val" : -67.0
}
},
"top_right" : {
"vs" : {
"val" : 50.0
},
"tvdss" : {
"val" : -50.0
}
}
}'
POST /public/api/v1/wells/49aa0f62-7ac4-4514-a17c-1a11581f476d/images HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 275
{
"name" : "image name",
"azimuth" : {
"val" : 0.0
},
"bottom_left" : {
"vs" : {
"val" : -30.0
},
"tvdss" : {
"val" : -67.0
}
},
"top_right" : {
"vs" : {
"val" : 50.0
},
"tvdss" : {
"val" : -50.0
}
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: bee81fee208e06e212a1dd4334768c18
Content-Type: application/json
{
"uuid" : "f82567ef-d2c9-4e6b-aae7-104efa288f4c"
}
POST /public/api/v1/wells/{uuid}/images
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Image name, 2 to 200 characters, must not start or end with a whitespace character |
azimuth.val |
Number |
Azimuth (degrees) the image applies to. If omitted, the lateral azimuth (0 if the lateral has none) is applied (on update the current image azimuth is not kept) |
bottom_left |
Object |
Bottom left corner of the image. Its vs and tvdss must be less than those of top_right |
top_right |
Object |
Top right corner of the image |
bottom_left.vs.val |
Number |
VS point coordinate value in the project horizontal unit (meters for METER_FOOT) |
bottom_left.tvdss.val |
Number |
TVDSS point coordinate value in the project depth unit (feet for METER_FOOT) |
top_right.vs.val |
Number |
VS point coordinate value in the project horizontal unit (meters for METER_FOOT) |
top_right.tvdss.val |
Number |
TVDSS point coordinate value in the project depth unit (feet for METER_FOOT) |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created image UUID |
Update image
Update image name, azimuth and corners by UUID. The image content is not changed. If azimuth is omitted, the lateral azimuth is applied. name, bottom_left and top_right with defined vs and tvdss are required, otherwise 400 is returned
Request
$ curl 'https://solo.cloud/public/api/v1/images/56061496-ae87-4d33-a99c-82e2df4945b3' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "new image name",
"azimuth" : {
"val" : 0.0
},
"bottom_left" : {
"vs" : {
"val" : -100.0
},
"tvdss" : {
"val" : -50.0
}
},
"top_right" : {
"vs" : {
"val" : -50.0
},
"tvdss" : {
"val" : -40.0
}
}
}'
PUT /public/api/v1/images/56061496-ae87-4d33-a99c-82e2df4945b3 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 281
{
"name" : "new image name",
"azimuth" : {
"val" : 0.0
},
"bottom_left" : {
"vs" : {
"val" : -100.0
},
"tvdss" : {
"val" : -50.0
}
},
"top_right" : {
"vs" : {
"val" : -50.0
},
"tvdss" : {
"val" : -40.0
}
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 402896522d0bb2e205fd42780cfcf76f
PUT /public/api/v1/images/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Image UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Image name, 2 to 200 characters, must not start or end with a whitespace character |
azimuth.val |
Number |
Azimuth (degrees) the image applies to. If omitted, the lateral azimuth (0 if the lateral has none) is applied (on update the current image azimuth is not kept) |
bottom_left |
Object |
Bottom left corner of the image. Its vs and tvdss must be less than those of top_right |
top_right |
Object |
Top right corner of the image |
bottom_left.vs.val |
Number |
VS point coordinate value in the project horizontal unit (meters for METER_FOOT) |
bottom_left.tvdss.val |
Number |
TVDSS point coordinate value in the project depth unit (feet for METER_FOOT) |
top_right.vs.val |
Number |
VS point coordinate value in the project horizontal unit (meters for METER_FOOT) |
top_right.tvdss.val |
Number |
TVDSS point coordinate value in the project depth unit (feet for METER_FOOT) |
Response body
Empty body
Upload image
Upload image content by UUID, replacing the previous content. The request body is the image file. Only PNG images are accepted (the format is detected from the content), width and height must not exceed 10000 pixels by default, otherwise 400 is returned. Send the file as raw bytes, e.g. curl --data-binary @image.png -H 'Content-Type: image/png' ...
Request
$ curl 'https://solo.cloud/public/api/v1/images/78a32ccb-773b-4fe6-a4a3-26c988958a8a/data' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: image/png; charset=ISO-8859-1' \
-d '<binary image data>'
PUT /public/api/v1/images/78a32ccb-773b-4fe6-a4a3-26c988958a8a/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: image/png; charset=ISO-8859-1
Host: solo.cloud
Content-Length: 19
<binary image data>
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: e55d8469376af0287e972dedf06973ec
PUT /public/api/v1/images/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Image UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Content-Type |
Must be image/png, the request body is the PNG file |
Response body
Empty body
Upload image (multipart)
Same as Upload image, but the file is sent in the image part of a multipart/form-data request
Request
$ curl 'https://solo.cloud/public/api/v1/images/a7b27283-288a-47e3-b293-132e31cf9075/data' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: multipart/form-data' \
-F 'image=<binary image data>;type=image/png'
PUT /public/api/v1/images/a7b27283-288a-47e3-b293-132e31cf9075/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: solo.cloud
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=image
Content-Type: image/png
<binary image data>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 2b40d7c9afe941e81b380e9053f4173d
PUT /public/api/v1/images/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Image UUID |
| Part | Description |
|---|---|
image |
Request part containing PNG image |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
12. Mudlogs
Create lateral mudlog
Create an empty mudlog by lateral UUID. Mudlog names do not have to be unique. The mudlog is not listed by Get mudlogs by lateral until its data is uploaded
Request
$ curl 'https://solo.cloud/public/api/v1/wells/2d3274d0-1c1f-48d6-be36-25397c2c67e0/mudlogs' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Mudlog name"
}'
POST /public/api/v1/wells/2d3274d0-1c1f-48d6-be36-25397c2c67e0/mudlogs HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 28
{
"name" : "Mudlog name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 94460e479f6c6fe4cb83d8c124261c3f
Content-Type: application/json
{
"uuid" : "370d8000-75ea-4d8e-bac6-a3b85d1e9254"
}
POST /public/api/v1/wells/{uuid}/mudlogs
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Mudlog name, up to 200 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created mudlog UUID |
Create typewell mudlog
Create an empty mudlog by typewell UUID. Mudlog names do not have to be unique. The mudlog is not listed by Get mudlogs by typewell until its data is uploaded
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/24cd7b87-7f7e-473d-b83e-700c3aa69399/mudlogs' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Mudlog name"
}'
POST /public/api/v1/typewells/24cd7b87-7f7e-473d-b83e-700c3aa69399/mudlogs HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 28
{
"name" : "Mudlog name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7a61f8cab482179213ff57321714c284
Content-Type: application/json
{
"uuid" : "a95e76c5-3e32-4791-900f-a5ffd686bd20"
}
POST /public/api/v1/typewells/{uuid}/mudlogs
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Mudlog name, up to 200 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created mudlog UUID |
Get mudlogs by lateral
Get a list of mudlogs by lateral UUID with pagination, in creation order. Mudlogs that do not contain data will not be included in the response
Request
$ curl 'https://solo.cloud/public/api/v1/wells/2d3274d0-1c1f-48d6-be36-25397c2c67e0/mudlogs?offset=0&limit=10&filter=mMa' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/2d3274d0-1c1f-48d6-be36-25397c2c67e0/mudlogs?offset=0&limit=10&filter=mMa HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 14a93c9d4475dbfc682cc4828be046c0
Content-Type: application/json
{
"content" : [ {
"name" : "Gamma Ray",
"uuid" : "905d7680-eaf2-4c19-9290-5916c9b6761b"
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/mudlogs
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the mudlogs whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Mudlog name |
content[].uuid |
String |
Mudlog UUID |
Get mudlogs by typewell
Get a list of mudlogs by typewell UUID with pagination, in creation order. Mudlogs that do not contain data will not be included in the response
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/24cd7b87-7f7e-473d-b83e-700c3aa69399/mudlogs?offset=0&limit=10&filter=mMa' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/24cd7b87-7f7e-473d-b83e-700c3aa69399/mudlogs?offset=0&limit=10&filter=mMa HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 84a7cdc7b6d14cbded6e5ff9a3739ca9
Content-Type: application/json
{
"content" : [ {
"name" : "Gamma Ray",
"uuid" : "90fa3279-2220-4f1f-a9ff-895d9ddc8f89"
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/typewells/{uuid}/mudlogs
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the mudlogs whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].name |
String |
Mudlog name |
content[].uuid |
String |
Mudlog UUID |
Get mudlog data
Get mudlog data by UUID. MD values are returned in project depth units. Channel display settings (lithology_type, solid_color, pattern_color) are not returned. Returns 400 if the mudlog has no data
Request
$ curl 'https://solo.cloud/public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9/data' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3c63174735f1763b8eea9dc37a3bdb2e
Content-Type: application/json
{
"logs" : [ {
"uuid" : "f868d503-a8ad-4d53-b623-ff2fcc54af51",
"name" : "Mudlog channel1",
"unit" : "Mudlog channel1 unit",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"undefined" : true
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"val" : 2.0
}
} ]
}, {
"uuid" : "31c82f6b-5a95-442c-86d7-1c8ba57f0c88",
"name" : "Mudlog channel2",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"val" : 178.0
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"undefined" : true
}
} ]
}, {
"uuid" : "0cef15a3-4f46-42c6-9d24-e3e3c68a5419",
"name" : "Mudlog channel1",
"unit" : "Mudlog channel1 unit",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"undefined" : true
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"val" : 2.0
}
} ]
}, {
"uuid" : "f62d18e1-28cb-41ff-995b-7f32b9fbe94f",
"name" : "Mudlog channel2",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"val" : 178.0
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"undefined" : true
}
} ]
} ]
}
GET /public/api/v1/mudlogs/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Mudlog UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
logs[].uuid |
String |
Channel UUID, generated by the server for data uploaded through the public upload and append endpoints |
logs[].name |
String |
Channel name |
logs[].unit |
String |
Channel unit |
logs[].log_points |
Array |
Channel points |
logs[].log_points[].md.val |
Number |
Point MD value (project depth units) |
logs[].log_points[].data.val |
Number |
Point data value |
logs[].log_points[].data.undefined |
Boolean |
true if point data value is undefined |
Update mudlog metadata
Rename mudlog by UUID. Only name can be changed, the mudlog data is not changed
Request
$ curl 'https://solo.cloud/public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Updated mudlog name"
}'
PATCH /public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 36
{
"name" : "Updated mudlog name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 49dca4d5e164fed01d2cbc29127cf3cd
PATCH /public/api/v1/mudlogs/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Mudlog UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
New mudlog name, up to 200 characters |
Response body
Empty body
Upload\replace mudlog data
Upload mudlog data by UUID, replacing all existing channels. MD values are in project depth units, all channels of the request must have the same set of MD values, points are stored sorted by MD. Channel UUIDs are assigned by the server, the mudlog display settings are rebuilt from defaults with the channel lithology_type, solid_color and pattern_color of the request and visual_bound_max applied
Request
$ curl 'https://solo.cloud/public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9/data?visual_bound_max=100.5' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"logs" : [ {
"name" : "Mudlog channel1",
"unit" : "Mudlog channel1 unit",
"lithology_type" : "HALITE",
"solid_color" : "BLUE",
"pattern_color" : "GREEN",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"undefined" : true
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"val" : 2.0
}
} ]
}, {
"name" : "Mudlog channel2",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"val" : 178.0
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"undefined" : true
}
} ]
} ]
}'
PUT /public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9/data?visual_bound_max=100.5 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 684
{
"logs" : [ {
"name" : "Mudlog channel1",
"unit" : "Mudlog channel1 unit",
"lithology_type" : "HALITE",
"solid_color" : "BLUE",
"pattern_color" : "GREEN",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"undefined" : true
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"val" : 2.0
}
} ]
}, {
"name" : "Mudlog channel2",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"val" : 178.0
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"undefined" : true
}
} ]
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f14d15d1c238445d1cd92e37dcd227d2
PUT /public/api/v1/mudlogs/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Mudlog UUID |
| Parameter | Description |
|---|---|
visual_bound_max |
Optional. Upper bound of the mudlog display scale, applied only if greater than 0. If not set, it is calculated from the uploaded data |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
logs |
Array |
Mudlog channels that replace all existing channels of the mudlog. All channels must have the same set of MD values |
logs[].name |
String |
Channel name, up to 200 characters |
logs[].unit |
String |
Optional. Channel unit, up to 100 characters |
logs[].lithology_type |
String |
Optional. Channel lithology, sets the fill pattern of the channel. Allowed values are 'EMPTY', 'CLAY_SHALE', 'SAND_SANDSTONE', 'ARGILLACEOUS_OR_SHALY_SAND', 'LIMESTONE', 'SANDY_LIMESTONE', 'DOLOMITE', 'GYPSUM', 'SALT', 'CHALK', 'HALITE', 'BRECCIA', 'OPEN_UPWARD_TRIANGLES', 'SANDY_OR_SILTY_SHALE', 'SILTY_LIMESTONE', 'ARGILLACEOUS_SHALY_LIMESTONE', 'DOLOMITIC_LIMESTONE_LIMY_DOLOMITE', 'SANDY_DOLOMITE', 'SILTY_DOLOMITE', 'ARGILLACEOUS_SHALY_DOLOMITE', 'SILT_SILTSTONE', 'DOLOMITIC_SILTSTONE', 'ANHYDRITE', 'IGNEOUS', 'METAMORPHIC', 'CALCARENITE', 'CALCARENITE_DOLOMITE', 'CALCARENITIC_LIMESTONE', 'MARL', 'COARSE_CLASTIC_CARBONATE', 'DOLOMITIC_SAND', 'SILTSTONE', 'INGE', 'HAL', 'TILL', 'CEMENT', 'MARLSTONE', 'CLAY', 'SHALE', 'SCHOL', 'SHGY', 'IGNVOLC', 'CHERT', 'CONGLOMERATE', 'CGL', 'META', 'BENT', 'ANHY', 'GYP', 'SANDSTONE', 'CONGLOMERATIC_SANDSTONE', 'BENTONITE', 'BRECCIAS', 'MARLS', 'PACKSTONE', 'WACKESTONE' |
logs[].solid_color |
String |
Optional. Channel fill color. Allowed values are 'CYAN_BLUE', 'BLUE', 'INDIGO', 'GREEN', 'TEAL_GREEN', 'TEAL', 'OLIVE_YELLOW', 'GOLD', 'ORANGE', 'RED_ORANGE', 'RED', 'PINK', 'MAGENTA', 'DARK_BLUE_GRAY', 'GRAY' |
logs[].pattern_color |
String |
Optional. Color of the channel fill pattern. Allowed values are 'CYAN_BLUE', 'BLUE', 'INDIGO', 'GREEN', 'TEAL_GREEN', 'TEAL', 'OLIVE_YELLOW', 'GOLD', 'ORANGE', 'RED_ORANGE', 'RED', 'PINK', 'MAGENTA', 'DARK_BLUE_GRAY', 'GRAY' |
logs[].log_points |
Array |
Channel points, each point must have md and data |
logs[].log_points[].md.val |
Number |
Point MD value (project depth units). Must be defined, non-negative and unique within the channel |
logs[].log_points[].data.val |
Number |
Point data value |
logs[].log_points[].data.undefined |
Boolean |
true if point data value is undefined |
Response body
Empty body
Append mudlog data
Append the channels of the request to the mudlog with the given UUID, the existing channels are kept unchanged. A channel is not merged into an existing channel with the same name, it is added as another channel. The request format is the same as in Upload\replace mudlog data. For a mudlog without data it works as upload
Request
$ curl 'https://solo.cloud/public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9/data?visual_bound_max=100.5' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"logs" : [ {
"name" : "Mudlog channel1",
"unit" : "Mudlog channel1 unit",
"lithology_type" : "HALITE",
"solid_color" : "BLUE",
"pattern_color" : "GREEN",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"undefined" : true
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"val" : 2.0
}
} ]
}, {
"name" : "Mudlog channel2",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"val" : 178.0
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"undefined" : true
}
} ]
} ]
}'
PATCH /public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9/data?visual_bound_max=100.5 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 684
{
"logs" : [ {
"name" : "Mudlog channel1",
"unit" : "Mudlog channel1 unit",
"lithology_type" : "HALITE",
"solid_color" : "BLUE",
"pattern_color" : "GREEN",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"undefined" : true
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"val" : 2.0
}
} ]
}, {
"name" : "Mudlog channel2",
"log_points" : [ {
"md" : {
"val" : 100.0
},
"data" : {
"val" : 178.0
}
}, {
"md" : {
"val" : 200.0
},
"data" : {
"undefined" : true
}
} ]
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7a7458f0ced9daaed3ebb6c61a4663ba
PATCH /public/api/v1/mudlogs/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Mudlog UUID |
| Parameter | Description |
|---|---|
visual_bound_max |
Optional. Upper bound of the mudlog display scale, applied only if greater than 0. If not set, the current value is kept, or it is calculated from the uploaded data if the mudlog has no data yet |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
logs |
Array |
Mudlog channels to add to the existing channels of the mudlog. All channels in the request must have the same set of MD values |
logs[].name |
String |
Channel name, up to 200 characters |
logs[].unit |
String |
Optional. Channel unit, up to 100 characters |
logs[].lithology_type |
String |
Optional. Channel lithology, sets the fill pattern of the channel. Allowed values are 'EMPTY', 'CLAY_SHALE', 'SAND_SANDSTONE', 'ARGILLACEOUS_OR_SHALY_SAND', 'LIMESTONE', 'SANDY_LIMESTONE', 'DOLOMITE', 'GYPSUM', 'SALT', 'CHALK', 'HALITE', 'BRECCIA', 'OPEN_UPWARD_TRIANGLES', 'SANDY_OR_SILTY_SHALE', 'SILTY_LIMESTONE', 'ARGILLACEOUS_SHALY_LIMESTONE', 'DOLOMITIC_LIMESTONE_LIMY_DOLOMITE', 'SANDY_DOLOMITE', 'SILTY_DOLOMITE', 'ARGILLACEOUS_SHALY_DOLOMITE', 'SILT_SILTSTONE', 'DOLOMITIC_SILTSTONE', 'ANHYDRITE', 'IGNEOUS', 'METAMORPHIC', 'CALCARENITE', 'CALCARENITE_DOLOMITE', 'CALCARENITIC_LIMESTONE', 'MARL', 'COARSE_CLASTIC_CARBONATE', 'DOLOMITIC_SAND', 'SILTSTONE', 'INGE', 'HAL', 'TILL', 'CEMENT', 'MARLSTONE', 'CLAY', 'SHALE', 'SCHOL', 'SHGY', 'IGNVOLC', 'CHERT', 'CONGLOMERATE', 'CGL', 'META', 'BENT', 'ANHY', 'GYP', 'SANDSTONE', 'CONGLOMERATIC_SANDSTONE', 'BENTONITE', 'BRECCIAS', 'MARLS', 'PACKSTONE', 'WACKESTONE' |
logs[].solid_color |
String |
Optional. Channel fill color. Allowed values are 'CYAN_BLUE', 'BLUE', 'INDIGO', 'GREEN', 'TEAL_GREEN', 'TEAL', 'OLIVE_YELLOW', 'GOLD', 'ORANGE', 'RED_ORANGE', 'RED', 'PINK', 'MAGENTA', 'DARK_BLUE_GRAY', 'GRAY' |
logs[].pattern_color |
String |
Optional. Color of the channel fill pattern. Allowed values are 'CYAN_BLUE', 'BLUE', 'INDIGO', 'GREEN', 'TEAL_GREEN', 'TEAL', 'OLIVE_YELLOW', 'GOLD', 'ORANGE', 'RED_ORANGE', 'RED', 'PINK', 'MAGENTA', 'DARK_BLUE_GRAY', 'GRAY' |
logs[].log_points |
Array |
Channel points, each point must have md and data |
logs[].log_points[].md.val |
Number |
Point MD value (project depth units). Must be defined, non-negative and unique within the channel |
logs[].log_points[].data.val |
Number |
Point data value |
logs[].log_points[].data.undefined |
Boolean |
true if point data value is undefined |
Response body
Empty body
Delete mudlog
Delete mudlog by UUID. Returns 403 if the mudlog is locked or is a private mudlog of another user
Request
$ curl 'https://solo.cloud/public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/mudlogs/e0c02908-6f83-47c5-b062-7de288ff28b9 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 40b3f4beafde91113635f429dec6ad5a
DELETE /public/api/v1/mudlogs/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Mudlog UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
13. Drilling traces
Get traces collection
Get the list of traces available to the user's company: system traces, including robot-calculated ones (Rig Activity, KPIs, Slide Sheet), and custom traces of the company
Request
$ curl 'https://solo.cloud/public/api/v1/traces' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/traces HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 295b4808f4eec8b90580c7886d0f128f
Content-Type: application/json
{
"content" : [ {
"uuid" : "f18afa65-7b06-4f6a-9494-746b3f10272f",
"name" : "Axial Shock"
}, {
"uuid" : "97e29152-c59d-4055-b7e3-7d823e3eb122",
"name" : "Axial Vibration"
}, {
"uuid" : "a415fee9-3992-4915-9ba2-262b084500f9",
"name" : "Azimuth"
}, {
"uuid" : "f93bf5a7-9755-4163-9c44-6d107967db4b",
"name" : "Bit depth"
}, {
"uuid" : "508ac83a-8d7e-45e6-b8c7-be7aa5dccbec",
"name" : "Bit Depth Vertical"
}, {
"uuid" : "6a300b55-f00c-49ff-926a-7654a18731b2",
"name" : "Bit on Bottom"
}, {
"uuid" : "cbfc47a9-4bb0-4a69-9747-136b5b5fa453",
"name" : "Block position"
}, {
"uuid" : "1690e9e7-3c19-4053-8788-6935a0b2d034",
"name" : "Block Velocity"
}, {
"uuid" : "a3fcfa5d-8881-499d-91e8-48a7b3dc2215",
"name" : "MWD Continuous Inclination"
}, {
"uuid" : "512cf80d-8872-435f-8e88-bed593b12670",
"name" : "MWD Continuous Azimuth"
}, {
"uuid" : "19d0f8f5-fd1c-41f8-86c4-939a5dada63e",
"name" : "Caliper"
}, {
"uuid" : "e5145f9f-e946-432c-ab0b-6bf0fbe9188c",
"name" : "Casing Pressure"
}, {
"uuid" : "cc9ad146-13ae-4127-801c-4a689be7487d",
"name" : "Choke Pressure"
}, {
"uuid" : "274c2682-91d7-4a31-b0e3-8928ef561f0a",
"name" : "Circulation hours"
}, {
"uuid" : "b7f8a98c-e6b5-46cf-ac77-fcb2a52588f8",
"name" : "Collar RPM"
}, {
"uuid" : "e1f88165-de61-4da0-be1a-ce2d9d788cf3",
"name" : "D-exponent"
}, {
"uuid" : "fd5fdd95-2cd8-4879-8403-2509ee3f66ee",
"name" : "Density"
}, {
"uuid" : "544e3dd7-1464-4196-825b-b4da1085e4ff",
"name" : "Depth of Cut"
}, {
"uuid" : "5e3a4999-9c76-4857-8cbf-eccf51539bbf",
"name" : "Differential Pressure"
}, {
"uuid" : "2fd13e54-cfb7-477a-9c56-55c20b2cadb8",
"name" : "Dip Angle"
}, {
"uuid" : "15be30d7-5ade-4595-ba27-e5ce9d1bf83e",
"name" : "Downhole MSE"
}, {
"uuid" : "1e96aa39-75b9-4990-8042-a02a61a08646",
"name" : "Downhole TQ"
}, {
"uuid" : "627bb479-067b-4e60-b4de-7679c48c6d0f",
"name" : "Downhole WOB"
}, {
"uuid" : "78b342b0-ec47-4d9b-ae3a-0df49448c1ec",
"name" : "PWD ECD"
}, {
"uuid" : "992a7d4e-f854-424d-911a-c674ef8e87f4",
"name" : "Flow Out %"
}, {
"uuid" : "bda8a0dd-ced2-46bd-a82a-1db75b62653c",
"name" : "Gamma Ray"
}, {
"uuid" : "cf0042b1-9c10-4eca-8aa6-3954147f4fad",
"name" : "Total Gas"
}, {
"uuid" : "45fbab1e-efb3-420d-9786-6f3d6f2214ed",
"name" : "Gas C1"
}, {
"uuid" : "fb2bceaf-d7c6-4921-b20b-1f6152f57060",
"name" : "Gas C2"
}, {
"uuid" : "643fbb3b-fe7f-4fda-a276-295fc65ceb67",
"name" : "Gas C3"
}, {
"uuid" : "cb23ab73-57c3-4344-af71-4a1c60cc024c",
"name" : "Gas C4"
}, {
"uuid" : "20853910-11ea-46fb-b3a7-582e63625085",
"name" : "Gas C5"
}, {
"uuid" : "5525d952-8db1-4641-b2fa-18fd185b7c9d",
"name" : "Gas CO2"
}, {
"uuid" : "3ed2dacd-93ac-4e38-95ed-0a7b8b82c60e",
"name" : "Gas H2S"
}, {
"uuid" : "27784730-2602-4442-ac2a-9ec9822baa6c",
"name" : "Gas iso-C4"
}, {
"uuid" : "4b2627a3-6a3d-4751-b818-ce1f95cb3d6a",
"name" : "Gas iso-C5"
}, {
"uuid" : "ecec68ec-9a33-44c6-bedb-609b69c7f022",
"name" : "Gas nor-C4"
}, {
"uuid" : "3f85640e-889e-456e-93bc-3a2a567cd5f9",
"name" : "Gas nor-C5"
}, {
"uuid" : "6a5faaf0-a756-4065-99a9-d84d1fe0bfd2",
"name" : "Gravity Total"
}, {
"uuid" : "f86e140e-b5d0-4b5f-98de-951200fd8038",
"name" : "GTF"
}, {
"uuid" : "d635c218-3d17-4f5d-98b4-026085c4f584",
"name" : "Hole Depth"
}, {
"uuid" : "2d9cbed5-4d21-4243-89e6-586f1bb961ff",
"name" : "Hole Depth Vertical"
}, {
"uuid" : "dfdf09da-5be0-495f-b802-15840ce93066",
"name" : "Hookload"
}, {
"uuid" : "3a655e25-ff42-4c56-b083-9d6cc77a7a8c",
"name" : "In Slips"
}, {
"uuid" : "624e443b-6a3b-4247-a648-53db39d19f1b",
"name" : "Inclination"
}, {
"uuid" : "b2a12c8b-dc98-4b9d-96d6-6e020736ca1b",
"name" : "Lateral Vibration"
}, {
"uuid" : "b6c70cd5-aff7-4bd7-bef6-dfb663c12da9",
"name" : "Magnetic Field"
}, {
"uuid" : "03c53157-8443-40d8-8ef4-087f3205da5f",
"name" : "Motor RPM"
}, {
"uuid" : "805070d4-e80a-4d0d-83d6-430ba7ab00bf",
"name" : "MTF"
}, {
"uuid" : "702c9494-7666-435f-ad46-9c6a3f24faa3",
"name" : "Flow In Rate"
}, {
"uuid" : "65c71407-9a65-484d-aeed-b4ef14b91582",
"name" : "Flow Out Rate"
}, {
"uuid" : "4457de71-ae74-4fd6-ad87-c0f19275806e",
"name" : "Mud Weight In"
}, {
"uuid" : "999d98fd-b761-488f-9af8-dca909ec7bd8",
"name" : "Mud Weight Out"
}, {
"uuid" : "101c98d0-2643-4b75-8012-738faa9025f7",
"name" : "MWD Turbine RPM"
}, {
"uuid" : "92e27c5f-3277-4a5c-a478-b9a989944671",
"name" : "On bottom hours"
}, {
"uuid" : "5f527ef9-c86b-4e55-84c0-2b8df74de1c1",
"name" : "Oscillate status"
}, {
"uuid" : "b7f3fdd3-ad94-4aa4-8e94-50f5ad4dee29",
"name" : "Pit 1 Volume"
}, {
"uuid" : "f1b5479f-4488-47fe-9338-12591f2d48f9",
"name" : "Pit 2 Volume"
}, {
"uuid" : "e5568169-182c-466e-99e0-6957159fe08c",
"name" : "Pit 3 Volume"
}, {
"uuid" : "2f03c515-d6ff-41be-b7d4-83a77c13e6c3",
"name" : "Pit 4 Volume"
}, {
"uuid" : "18accea3-a188-4189-bec9-3e78a207591e",
"name" : "Pit 5 Volume"
}, {
"uuid" : "cce31e79-5444-4e8d-bcae-774314ac6958",
"name" : "Pit 6 Volume"
}, {
"uuid" : "278c87fd-7b22-4118-8b12-84d6474cff5d",
"name" : "Pit 7 Volume"
}, {
"uuid" : "45b1afbb-6d6c-4db5-93ff-0ffa94b802da",
"name" : "Pit 8 Volume"
}, {
"uuid" : "ce850617-0391-4346-8834-1449a32722df",
"name" : "Pump 1 Cumulative Strokes"
}, {
"uuid" : "27a591db-8db8-4148-9115-49d5df10ac7e",
"name" : "Pump 1 Mud Flow In"
}, {
"uuid" : "328949d9-a0db-41fa-9c84-4064137315c7",
"name" : "Pump 2 Cumulative Strokes"
}, {
"uuid" : "5286505c-c31c-4bb8-b3c7-f0900cce9fba",
"name" : "Pump 2 Mud Flow In"
}, {
"uuid" : "a3ddb237-cd23-4f5d-999f-2a3e9f6821ee",
"name" : "Pump 3 Cumulative Strokes"
}, {
"uuid" : "1e15c542-3673-4140-8165-1ad534e2b3dc",
"name" : "Pump 3 Mud Flow In"
}, {
"uuid" : "30ad129a-4854-4bb5-8e1d-3c9065605fe2",
"name" : "Pump Stroke Count"
}, {
"uuid" : "8f46e726-06b1-4c71-b638-203868bc4451",
"name" : "PWD Annular Pressure"
}, {
"uuid" : "4265ba32-99d0-490b-a1a1-b8798206a82a",
"name" : "Rate of Penetration Instantaneous"
}, {
"uuid" : "c4d4b89e-5e6c-404f-9d8d-5ca8b2c26885",
"name" : "Resistivity"
}, {
"uuid" : "78334ca1-783e-4dc3-9f86-c86c391d6bac",
"name" : "Rig State"
}, {
"uuid" : "b68b2510-7858-4dcb-b242-57fcd584e0aa",
"name" : "ROP"
}, {
"uuid" : "f4b9e8ea-ada1-4aaf-b638-064916ece1d3",
"name" : "RSS Toolface"
}, {
"uuid" : "f49024eb-cdf9-42a4-beca-974dc8348281",
"name" : "Lateral Shock"
}, {
"uuid" : "98e64813-b867-400a-be7c-a8f31cb56047",
"name" : "SPM1"
}, {
"uuid" : "9f50ec96-0d33-46c2-8b11-c1628fe39658",
"name" : "SPM2"
}, {
"uuid" : "52a79823-4947-4796-b423-545ccd8194b6",
"name" : "SPM3"
}, {
"uuid" : "0f936580-1edd-449c-b760-9142097dfec6",
"name" : "SPM Total"
}, {
"uuid" : "f764306b-302e-4500-8518-4f149f839a85",
"name" : "Standpipe Pressure"
}, {
"uuid" : "3d1105fa-a8de-4e54-981f-105b75142937",
"name" : "StickSlip"
}, {
"uuid" : "30652f8a-15d2-4a10-9e86-2943a7bd5687",
"name" : "Surface RPM"
}, {
"uuid" : "de8ce461-cf26-4e38-ac68-e2e228c331ab",
"name" : "Surface Torque"
}, {
"uuid" : "8b6023ce-d4d7-46be-b9e1-d9ebc92b2711",
"name" : "Surface Torque Max"
}, {
"uuid" : "354dbda4-8dc0-40e8-9723-8b63b794a003",
"name" : "Survey MD"
}, {
"uuid" : "7a76ccd8-e64f-4155-9184-d5f66ac3a58a",
"name" : "Temperature In"
}, {
"uuid" : "9d444b75-4c6b-496c-a945-f75f003e7a0a",
"name" : "Temperature Out"
}, {
"uuid" : "ac3cc40c-6055-4efa-a4fa-6a9f787bcd9d",
"name" : "Tool Temperature"
}, {
"uuid" : "957a4437-2806-43d6-9b2e-2fdb612be1de",
"name" : "Torsional Vibration"
}, {
"uuid" : "f0ad751b-5c66-4961-b6b9-965b282d38d8",
"name" : "Total MSE"
}, {
"uuid" : "5a89a54f-3c8e-40c9-8fae-fdb7437b8adb",
"name" : "Bit RPM"
}, {
"uuid" : "6565f21c-0d1e-4ce6-bbcf-da4b7900f2f4",
"name" : "Total Tank Volume"
}, {
"uuid" : "86e72bb4-8f89-405b-855b-117e6fdf5f24",
"name" : "Total Volume Active"
}, {
"uuid" : "92e712cc-2fe4-4ebe-967c-603828f1bea5",
"name" : "Trip Speed"
}, {
"uuid" : "107b71c0-ebe1-484f-91c3-c5f57a5ee2ba",
"name" : "Trip Tank Volume"
}, {
"uuid" : "7392915c-10e3-4bd0-8717-3efd4eb2943f",
"name" : "Time of Penetration"
}, {
"uuid" : "5ab9a650-9ccc-4709-a76e-10d5d3ede25a",
"name" : "RSS Steering Ratio"
}, {
"uuid" : "44596b6b-f833-4299-aaf7-519c7b27e8e1",
"name" : "WOB"
}, {
"uuid" : "8595db67-37e0-4389-8f29-6753c9a9e2f7",
"name" : "WOB Max"
}, {
"uuid" : "c1ca14ae-6d00-48cb-9c6f-f0d9840c76b1",
"name" : "X Accelerometer"
}, {
"uuid" : "05c50fad-d7e0-4752-be56-9c610c86e246",
"name" : "X Magnetometer"
}, {
"uuid" : "1ceca6eb-2b67-4015-8930-8f4f64578bba",
"name" : "Y Accelerometer"
}, {
"uuid" : "87cbf376-966b-4252-8368-0428bbeccf7a",
"name" : "Y Magnetometer"
}, {
"uuid" : "8d4a8cb5-80cc-46fa-83c6-783c21598014",
"name" : "Z Accelerometer"
}, {
"uuid" : "4fbd96a1-8606-4067-8b7f-c92a4f8d777d",
"name" : "Z Magnetometer"
}, {
"uuid" : "c6e1722b-2a02-4470-b2d7-bf00f5506719",
"name" : "Depth of Cut"
}, {
"uuid" : "89e07b1a-d50e-4b99-ada9-023f784767d8",
"name" : "Downhole MSE"
}, {
"uuid" : "a1a0e98e-9e28-438e-9c7e-254e68d0c636",
"name" : "Total MSE"
}, {
"uuid" : "5d4acff6-85ea-4dd7-aac1-bbe982f7bdfc",
"name" : "Recommended WOB"
}, {
"uuid" : "3ffc495e-0d17-46a5-b688-e3242884bf67",
"name" : "Recommended RPM"
}, {
"uuid" : "0eef088a-ce96-4670-8b21-4b090f76d177",
"name" : "Recommended MFI"
}, {
"uuid" : "68a640b5-f885-4bea-a07e-49536fa2b93d",
"name" : "Predicted WOB"
}, {
"uuid" : "2d348260-372a-4e87-a8b3-82d66d95196e",
"name" : "Predicted RPM"
}, {
"uuid" : "8be6cd16-906a-465c-a04d-f1fd9459458e",
"name" : "Predicted MFI"
}, {
"uuid" : "027be8e3-7fcb-4fd3-b064-1f50f5c4749b",
"name" : "Predicted ROP"
}, {
"uuid" : "5fe2a454-86ad-4fdc-abbf-686e4f67a4fa",
"name" : "Trip Out: Connection"
}, {
"uuid" : "f65f24d3-a306-4a1c-9765-5b8359aed7c3",
"name" : "Trip Out: Running"
}, {
"uuid" : "43b1d9c6-4420-4866-9c1f-c3f9d1d5f543",
"name" : "Weight to Weight"
}, {
"uuid" : "e3c996b6-9cdb-4876-ac99-0aab694b801a",
"name" : "Rig Activity"
}, {
"uuid" : "6906b6ba-5ad3-4df7-8176-dbc844d02d54",
"name" : "Slide Sheet"
}, {
"uuid" : "0cc5b768-8a11-4e11-9ef2-135344f7b1a2",
"name" : "RSS DLink"
}, {
"uuid" : "07700dd6-bdaf-477a-8b79-c48631b653d6",
"name" : "RSS Desired TF"
}, {
"uuid" : "36f79b61-728b-4524-bc87-b2d97f558be2",
"name" : "RSS Target Inclination"
}, {
"uuid" : "89211184-204e-4f3d-a655-bc742743ccf4",
"name" : "RSS Target Azimuth"
}, {
"uuid" : "6ea4cf91-c576-4941-9515-25fec2014f6d",
"name" : "RSS Status Word 1"
}, {
"uuid" : "3677c17f-bad2-44ca-95bb-6265b9898965",
"name" : "RSS Status Word 2"
}, {
"uuid" : "d2271377-87d2-49b3-b40c-c4fb91d55c37",
"name" : "RSS Status Word 3"
}, {
"uuid" : "b673ea0c-eee0-49b4-99ce-8bb8843365f2",
"name" : "Zeroed WOB"
}, {
"uuid" : "d181ddaf-7921-476a-a45c-fc3206a07198",
"name" : "Zeroed Differential Pressure"
}, {
"uuid" : "2adc5cd8-a1de-48ca-916a-3236ed6ece9a",
"name" : "Trip Out: Reaming"
}, {
"uuid" : "2326a7a3-bb68-4924-a9e5-a16b7b87d192",
"name" : "Trip In: Reaming"
}, {
"uuid" : "ab7e5866-a3da-4e6c-b584-523799719b34",
"name" : "Slip to slip"
}, {
"uuid" : "eb85cf68-047e-43b0-bbbb-75548c8e700e",
"name" : "Trip In: Connection"
}, {
"uuid" : "fed6681e-1f21-466c-bf91-55fed528a07d",
"name" : "Trip In: Running"
}, {
"uuid" : "db16f0ac-2c69-4237-933d-7f6ce24fa1dc",
"name" : "Trip In: Washing"
}, {
"uuid" : "08e28406-7ade-4fb2-8dca-1628936f2b36",
"name" : "Trip Out: Washing"
}, {
"uuid" : "4545b4f1-4f71-41aa-86c3-b87961459f5f",
"name" : "Rotary Build Rate"
}, {
"uuid" : "1f0a45f4-1b62-11f0-902e-77c4b3b98667",
"name" : "Rotary Turn Rate"
}, {
"uuid" : "f09337a9-ca89-411d-a2e6-aad17746b4ee",
"name" : "Slack off & Drag"
}, {
"uuid" : "bf7c700d-de08-41c5-b20b-cb32d649d8e8",
"name" : "Erratic Torque"
}, {
"uuid" : "f0519265-7a47-488a-978a-24997705844e",
"name" : "Time from Last Connection"
}, {
"uuid" : "7136da25-7a78-4558-864e-8dd21623fbe9",
"name" : "Time From Last Survey"
}, {
"uuid" : "b9e0a067-ab3a-4e59-8ec6-c14f33346df4",
"name" : "Time On Bottom"
}, {
"uuid" : "69471b8a-c20a-449e-abc9-0147adaf6d14",
"name" : "Static Time"
}, {
"uuid" : "265d885d-567d-4d27-843e-c9fa39800c1d",
"name" : "Time to top"
}, {
"uuid" : "ef5b8413-dcec-4c4c-b607-6b4200142f7d",
"name" : "Forecast Confidence"
}, {
"uuid" : "11b703b5-b0d2-43c5-a370-d509a9d4604b",
"name" : "Drill Zone"
}, {
"uuid" : "44161596-6117-47bc-ae86-05561b38c773",
"name" : "Recommended ROP"
}, {
"uuid" : "261cea68-1b62-11f0-8a2e-cbc9b8e5e876",
"name" : "Motor Yield"
}, {
"uuid" : "11584aba-59fb-4a81-a12e-cf52e1d819c5",
"name" : "KPI: Pumps On to Bottom"
}, {
"uuid" : "4e2f64a1-eaf9-4d7f-9e3f-616c68084bfd",
"name" : "KPI: On Bottom to Slips"
}, {
"uuid" : "3084fd0c-0ea0-42b6-8024-768c8c26566d",
"name" : "KPI: Slips to On Bottom"
}, {
"uuid" : "9a81e86b-2e78-4d23-87bb-b76232df40f2",
"name" : "Motor Stall"
}, {
"uuid" : "01851a5a-9071-43df-86fc-673655c8f211",
"name" : "RSS Continuous Azimuth"
}, {
"uuid" : "c7d0f834-b1cf-437f-94a6-ca8f07a1f8c9",
"name" : "RSS Continious Inclination"
}, {
"uuid" : "5b30ffb3-2cbe-46ed-a9ec-87c5582ae1eb",
"name" : "Rig State"
}, {
"uuid" : "51cae7eb-6edb-424f-b062-8f86b2532825",
"name" : "Trip In: Connection Open Hole"
}, {
"uuid" : "6ae48c7b-9ba1-4005-920f-f732cf5ea3c5",
"name" : "Trip In: Connection Cased Hole"
}, {
"uuid" : "891a0323-0a88-4ef5-9ddc-ea08fa813d95",
"name" : "Trip Out: Connection Open Hole"
}, {
"uuid" : "e435c663-d8c0-44e7-9b81-35e375797095",
"name" : "Trip Out: Connection Cased Hole"
}, {
"uuid" : "78dc9d6d-8645-47fb-84c3-2b9d1554f41a",
"name" : "Trip In: Speed"
}, {
"uuid" : "46a520d5-ea4d-4c68-889c-8bea1196a3d9",
"name" : "Trip In: Speed Open Hole"
}, {
"uuid" : "a0d13920-55ae-42ff-90ce-ed61f15bf592",
"name" : "Trip In: Speed Cased Hole"
}, {
"uuid" : "1e7d617b-cd89-4d61-bb5f-120dedad77f4",
"name" : "Trip In: Connection Speed"
}, {
"uuid" : "c12fc1c7-97dd-41fe-8c69-8e8ff06918ec",
"name" : "Trip In: Connection Speed Open Hole"
}, {
"uuid" : "08a0ad9d-10ba-484d-9fb2-5ea1ba3b939f",
"name" : "Trip In: Connection Speed Cased Hole"
}, {
"uuid" : "0d22fd91-8af1-4a21-a3fd-ad2f5614ba55",
"name" : "Trip Out: Speed"
}, {
"uuid" : "1ccd4e03-6642-42db-a7a0-80330107f4e1",
"name" : "Trip Out: Speed Open Hole"
}, {
"uuid" : "9c696a89-83c2-461c-88f1-5201bd45eea6",
"name" : "Trip Out: Speed Cased Hole"
}, {
"uuid" : "c6fb2cce-94dc-47d6-bd06-e0e4d84e7904",
"name" : "Trip Out: Connection Speed"
}, {
"uuid" : "aea16bb5-bb27-4564-9aa9-1a673cff29c0",
"name" : "Trip Out: Connection Speed Open Hole"
}, {
"uuid" : "b99f5364-8cbb-4e53-8985-2b69f27c8e31",
"name" : "Trip Out: Connection Speed Cased Hole"
}, {
"uuid" : "cfb51db6-fea7-457a-b5e2-db62f12fb296",
"name" : "Block Speed"
}, {
"uuid" : "488e3f62-1199-46dc-95ed-1f5480487453",
"name" : "Hookload Raw PU"
}, {
"uuid" : "318df66c-f069-4f5c-9308-0786b90691e1",
"name" : "Hookload Raw SO"
}, {
"uuid" : "40ab5113-06c5-4708-9501-aa52b4006745",
"name" : "Hookload Raw ROB"
}, {
"uuid" : "e8d4afac-06c2-41e7-bafe-74483343cb96",
"name" : "Hookload Raw WU"
}, {
"uuid" : "2dc184b9-2009-47e5-8186-44083515ad06",
"name" : "Hookload Raw WD"
}, {
"uuid" : "099e0969-553a-43d7-859e-096301aa3430",
"name" : "Hookload Raw RU"
}, {
"uuid" : "a632b8e2-9dc7-4968-862e-5061fe7812db",
"name" : "Hookload Raw RD"
}, {
"uuid" : "d27be59e-e0b6-4f45-9f7b-5526a378ccf9",
"name" : "Surface Torque Raw ROB"
}, {
"uuid" : "443be365-8a27-4974-bb64-676a09241887",
"name" : "Surface Torque Raw RU"
}, {
"uuid" : "64846188-56c2-4c55-b846-977b431a1d8d",
"name" : "Surface Torque Raw RD"
}, {
"uuid" : "8ee91db3-2634-4dbc-b8e8-d5a52360d019",
"name" : "MPD Backpressure"
}, {
"uuid" : "90871ae0-2e72-4511-adfc-a3eceb104105",
"name" : "PWD Internal Pressure"
}, {
"uuid" : "55bf988e-89bb-4f13-8c70-bdb6b0abb168",
"name" : "Coriolis Flow In Rate"
}, {
"uuid" : "bce6471c-8a84-4cbe-8d6f-a94461a334e3",
"name" : "Coriolis Flow Out Rate"
}, {
"uuid" : "cfb01556-3656-486d-a19b-2966933c2769",
"name" : "Coriolis Mud Weight Out"
}, {
"uuid" : "14b59892-d24f-4bf9-b5e2-3fbfbcaf6bb8",
"name" : "MPD Choke 1 Position"
}, {
"uuid" : "57c975f1-41fa-457c-a3ae-ef0818bf7f32",
"name" : "MPD Choke 2 Position"
} ]
}
GET /public/api/v1/traces
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
System traces (including robot-calculated ones such as Rig Activity) and custom traces of the user's company |
content[].uuid |
String |
Trace UUID |
content[].name |
String |
Trace name |
Get mapped time traces by lateral
Get the list of traces mapped to a lateral. type=TIME returns time traces: WITSML-mapped traces and robot-calculated point traces that have time data. type=CALC returns all robot-calculated traces of the lateral with their hash and time range, without unit and null_value
Request
$ curl 'https://solo.cloud/public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/mapped?type=TIME' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/mapped?type=TIME HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4d430dc40867c7d483c08e414eb29433
Content-Type: application/json
{
"content" : [ {
"uuid" : "30652f8a-15d2-4a10-9e86-2943a7bd5687",
"name" : "Surface RPM",
"hash" : "c5de3d850a61f687fa66bd0ce64b4f8c",
"unit" : "1/s",
"null_value" : "-999.25",
"start_date_time_index" : "2020-12-29T08:00:00Z",
"last_date_time_index" : "2020-12-29T08:50:00Z"
}, {
"uuid" : "702c9494-7666-435f-ad46-9c6a3f24faa3",
"name" : "Flow In Rate",
"hash" : "3620d7a872fe12e7737e6475438b6b20",
"unit" : "m3/s",
"null_value" : "-999.25",
"start_date_time_index" : "2020-12-29T08:00:00Z",
"last_date_time_index" : "2020-12-29T08:50:00Z"
}, {
"uuid" : "d635c218-3d17-4f5d-98b4-026085c4f584",
"name" : "Hole Depth",
"hash" : "e6537fc4f7a7ba74bacb5d92e712e9ec",
"unit" : "m",
"null_value" : "-999.25",
"start_date_time_index" : "2020-12-29T08:00:00Z",
"last_date_time_index" : "2020-12-29T08:50:00Z"
}, {
"uuid" : "dfdf09da-5be0-495f-b802-15840ce93066",
"name" : "Hookload",
"hash" : "b4795ec62ce001d3d628997f2f0e0188",
"unit" : "N",
"null_value" : "-999.25",
"start_date_time_index" : "2020-12-29T08:00:00Z",
"last_date_time_index" : "2020-12-29T08:50:00Z"
}, {
"uuid" : "f93bf5a7-9755-4163-9c44-6d107967db4b",
"name" : "Bit depth",
"hash" : "b64f3f2c6edccc30413ff30fc4cf2d31",
"unit" : "m",
"null_value" : "-999.25",
"start_date_time_index" : "2020-12-29T08:00:00Z",
"last_date_time_index" : "2020-12-29T08:50:00Z"
} ]
}
GET /public/api/v1/wells/{uuid}/traces/mapped
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
type |
Trace type: TIME - mapped time traces (WITSML-mapped traces and robot-calculated point traces that have time data), CALC - all robot-calculated traces of the lateral (Rig Activity, KPIs, Slide Sheet, point traces), returned without unit and null_value |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Mapped traces |
content[].uuid |
String |
Trace UUID |
content[].name |
String |
Trace name |
content[].hash |
String |
Hash of the current trace mapping, can be passed as hash to the trace data endpoints |
content[].unit |
String |
UOM of the trace values: UOM of the mapped curve, base SI unit for robot-calculated traces |
content[].null_value |
String |
Null value of the mapped curve |
content[].start_date_time_index |
String |
Date time of the first data point, absent when there is no data |
content[].last_date_time_index |
String |
Date time of the last data point, absent when there is no data |
Get mapped depth traces by lateral
Get the list of depth traces mapped to a lateral: WITSML-mapped traces and robot-calculated point traces that have depth data. Depth values of a trace are in its index_unit, not in project units
Request
$ curl 'https://solo.cloud/public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/mapped?type=DEPTH' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/mapped?type=DEPTH HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f17f477cf97e8ca267461fc42cc4e3cd
Content-Type: application/json
{
"content" : [ {
"uuid" : "d635c218-3d17-4f5d-98b4-026085c4f584",
"name" : "Hole Depth",
"hash" : "7c4ac340afdbf033eac118faa16f3f5f",
"unit" : "m",
"index_unit" : "m",
"null_value" : "-999.25",
"start_depth_index" : 1.0,
"last_depth_index" : 4.0
} ]
}
GET /public/api/v1/wells/{uuid}/traces/mapped
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
type |
Trace type: DEPTH - mapped depth traces (WITSML-mapped traces and robot-calculated point traces that have depth data) |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Mapped traces |
content[].uuid |
String |
Trace UUID |
content[].name |
String |
Trace name |
content[].hash |
String |
Hash of the current trace mapping, can be passed as hash to the trace data endpoints |
content[].unit |
String |
UOM of the trace values: UOM of the mapped curve, base SI unit for robot-calculated traces |
content[].index_unit |
String |
Depth index UOM of the mapped curve (m for robot-calculated traces). start_depth_index, last_depth_index and the depth data from/to are in this UOM, not in project units |
content[].null_value |
String |
Null value of the mapped curve |
content[].start_depth_index |
Number |
Depth of the first data point in index_unit, absent when there is no data |
content[].last_depth_index |
Number |
Depth of the last data point in index_unit, absent when there is no data |
Get time series data by lateral and trace
Get time series data of a mapped trace by lateral UUID and trace UUID. The requested range is clipped to the trace data range, a range outside of it returns an empty content. Points are sorted by time, at most limit points are returned. 404 is returned if the trace has no time mapping on the lateral or hash does not match
Request
$ curl 'https://solo.cloud/public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/d635c218-3d17-4f5d-98b4-026085c4f584/data/time?from=2020-12-29T08%3A00%3A00Z&to=2020-12-29T08%3A50%3A00Z' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/d635c218-3d17-4f5d-98b4-026085c4f584/data/time?from=2020-12-29T08%3A00%3A00Z&to=2020-12-29T08%3A50%3A00Z HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f32d17cd1b6720253c75bbac6282d5fe
Content-Type: application/json
{
"content" : [ {
"index" : "2020-12-29T08:00:00.000Z",
"value" : "20341.2"
}, {
"index" : "2020-12-29T08:00:01.000Z",
"value" : "20341.2"
}, {
"index" : "2020-12-29T08:00:02.000Z",
"value" : "20341.2"
}, {
"index" : "2020-12-29T08:00:03.000Z",
"value" : "20341.2"
}, {
"index" : "2020-12-29T08:00:04.000Z",
"value" : "20341.2"
}, {
"index" : "2020-12-29T08:00:05.000Z",
"value" : "20341.2"
}, {
"index" : "2020-12-29T08:00:06.000Z",
"value" : "20341.2"
}, {
"index" : "2020-12-29T08:00:07.000Z",
"value" : "20341.3"
}, {
"index" : "2020-12-29T08:00:08.000Z",
"value" : "20341.3"
}, {
"index" : "2020-12-29T08:00:09.000Z",
"value" : "20341.3"
}, {
"index" : "2020-12-29T08:00:10.000Z",
"value" : "20341.3"
}, {
"index" : "2020-12-29T08:00:11.000Z",
"value" : "20341.3"
}, {
"index" : "2020-12-29T08:00:12.000Z",
"value" : "20341.3"
}, {
"index" : "2020-12-29T08:00:13.000Z",
"value" : "20341.3"
}, {
"index" : "2020-12-29T08:00:14.000Z",
"value" : "20341.3"
}, {
"index" : "2020-12-29T08:00:15.000Z",
"value" : "20341.3"
}, {
"index" : "2020-12-29T08:00:16.000Z",
"value" : "20341.4"
}, {
"index" : "2020-12-29T08:00:17.000Z",
"value" : "20341.4"
}, {
"index" : "2020-12-29T08:00:18.000Z",
"value" : "20341.4"
}, {
"index" : "2020-12-29T08:00:19.000Z",
"value" : "20341.4"
}, {
"index" : "2020-12-29T08:00:20.000Z",
"value" : "20341.4"
}, {
"index" : "2020-12-29T08:00:21.000Z",
"value" : "20341.4"
}, {
"index" : "2020-12-29T08:00:22.000Z",
"value" : "20341.5"
}, {
"index" : "2020-12-29T08:00:23.000Z",
"value" : "20341.5"
}, {
"index" : "2020-12-29T08:00:24.000Z",
"value" : "20341.5"
}, {
"index" : "2020-12-29T08:00:25.000Z",
"value" : "20341.5"
}, {
"index" : "2020-12-29T08:00:26.000Z",
"value" : "20341.5"
}, {
"index" : "2020-12-29T08:00:27.000Z",
"value" : "20341.5"
}, {
"index" : "2020-12-29T08:00:28.000Z",
"value" : "20341.6"
}, {
"index" : "2020-12-29T08:00:29.000Z",
"value" : "20341.6"
}, {
"index" : "2020-12-29T08:00:30.000Z",
"value" : "20341.6"
}, {
"index" : "2020-12-29T08:00:31.000Z",
"value" : "20341.6"
}, {
"index" : "2020-12-29T08:00:32.000Z",
"value" : "20341.6"
}, {
"index" : "2020-12-29T08:00:33.000Z",
"value" : "20341.6"
}, {
"index" : "2020-12-29T08:00:34.000Z",
"value" : "20341.6"
}, {
"index" : "2020-12-29T08:00:35.000Z",
"value" : "20341.6"
}, {
"index" : "2020-12-29T08:00:36.000Z",
"value" : "20341.7"
}, {
"index" : "2020-12-29T08:00:37.000Z",
"value" : "20341.7"
}, {
"index" : "2020-12-29T08:00:38.000Z",
"value" : "20341.7"
}, {
"index" : "2020-12-29T08:00:39.000Z",
"value" : "20341.7"
}, {
"index" : "2020-12-29T08:00:40.000Z",
"value" : "20341.7"
}, {
"index" : "2020-12-29T08:00:41.000Z",
"value" : "20341.7"
}, {
"index" : "2020-12-29T08:00:42.000Z",
"value" : "20341.7"
}, {
"index" : "2020-12-29T08:00:43.000Z",
"value" : "20341.8"
}, {
"index" : "2020-12-29T08:00:44.000Z",
"value" : "20341.8"
}, {
"index" : "2020-12-29T08:00:45.000Z",
"value" : "20341.8"
}, {
"index" : "2020-12-29T08:00:46.000Z",
"value" : "20341.8"
}, {
"index" : "2020-12-29T08:00:47.000Z",
"value" : "20341.8"
}, {
"index" : "2020-12-29T08:00:48.000Z",
"value" : "20341.9"
}, {
"index" : "2020-12-29T08:00:49.000Z",
"value" : "20341.9"
}, {
"index" : "2020-12-29T08:00:50.000Z",
"value" : "20341.9"
}, {
"index" : "2020-12-29T08:00:51.000Z",
"value" : "20341.9"
}, {
"index" : "2020-12-29T08:00:52.000Z",
"value" : "20341.9"
}, {
"index" : "2020-12-29T08:00:53.000Z",
"value" : "20341.9"
}, {
"index" : "2020-12-29T08:00:54.000Z",
"value" : "20341.9"
}, {
"index" : "2020-12-29T08:00:55.000Z",
"value" : "20341.9"
}, {
"index" : "2020-12-29T08:00:56.000Z",
"value" : "20341.9"
}, {
"index" : "2020-12-29T08:00:57.000Z",
"value" : "20342"
}, {
"index" : "2020-12-29T08:00:58.000Z",
"value" : "20342"
}, {
"index" : "2020-12-29T08:00:59.000Z",
"value" : "20342"
}, {
"index" : "2020-12-29T08:01:00.000Z",
"value" : "20342"
}, {
"index" : "2020-12-29T08:01:01.000Z",
"value" : "20342"
}, {
"index" : "2020-12-29T08:01:02.000Z",
"value" : "20342"
}, {
"index" : "2020-12-29T08:01:03.000Z",
"value" : "20342"
}, {
"index" : "2020-12-29T08:01:04.000Z",
"value" : "20342"
}, {
"index" : "2020-12-29T08:01:05.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:06.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:07.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:08.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:09.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:10.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:11.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:12.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:13.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:14.000Z",
"value" : "20342.1"
}, {
"index" : "2020-12-29T08:01:15.000Z",
"value" : "20342.2"
}, {
"index" : "2020-12-29T08:01:16.000Z",
"value" : "20342.2"
}, {
"index" : "2020-12-29T08:01:17.000Z",
"value" : "20342.2"
}, {
"index" : "2020-12-29T08:01:18.000Z",
"value" : "20342.2"
}, {
"index" : "2020-12-29T08:01:19.000Z",
"value" : "20342.2"
}, {
"index" : "2020-12-29T08:01:20.000Z",
"value" : "20342.2"
}, {
"index" : "2020-12-29T08:01:21.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:22.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:23.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:24.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:25.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:26.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:27.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:28.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:29.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:30.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:31.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:32.000Z",
"value" : "20342.3"
}, {
"index" : "2020-12-29T08:01:33.000Z",
"value" : "20342.4"
}, {
"index" : "2020-12-29T08:01:34.000Z",
"value" : "20342.4"
}, {
"index" : "2020-12-29T08:01:35.000Z",
"value" : "20342.4"
}, {
"index" : "2020-12-29T08:01:36.000Z",
"value" : "20342.4"
}, {
"index" : "2020-12-29T08:01:37.000Z",
"value" : "20342.4"
}, {
"index" : "2020-12-29T08:01:38.000Z",
"value" : "20342.4"
}, {
"index" : "2020-12-29T08:01:39.000Z",
"value" : "20342.4"
}, {
"index" : "2020-12-29T08:01:40.000Z",
"value" : "20342.4"
}, {
"index" : "2020-12-29T08:01:41.000Z",
"value" : "20342.5"
}, {
"index" : "2020-12-29T08:01:42.000Z",
"value" : "20342.5"
}, {
"index" : "2020-12-29T08:01:43.000Z",
"value" : "20342.5"
}, {
"index" : "2020-12-29T08:01:44.000Z",
"value" : "20342.5"
}, {
"index" : "2020-12-29T08:01:45.000Z",
"value" : "20342.5"
}, {
"index" : "2020-12-29T08:01:46.000Z",
"value" : "20342.5"
}, {
"index" : "2020-12-29T08:01:47.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:48.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:49.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:50.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:51.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:52.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:53.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:54.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:55.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:56.000Z",
"value" : "20342.6"
}, {
"index" : "2020-12-29T08:01:57.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:01:58.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:01:59.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:00.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:01.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:02.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:03.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:04.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:05.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:06.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:07.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:08.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:09.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:10.000Z",
"value" : "20342.7"
}, {
"index" : "2020-12-29T08:02:11.000Z",
"value" : "20342.8"
}, {
"index" : "2020-12-29T08:02:12.000Z",
"value" : "20342.8"
}, {
"index" : "2020-12-29T08:02:13.000Z",
"value" : "20342.8"
}, {
"index" : "2020-12-29T08:02:14.000Z",
"value" : "20342.8"
}, {
"index" : "2020-12-29T08:02:15.000Z",
"value" : "20342.8"
}, {
"index" : "2020-12-29T08:02:16.000Z",
"value" : "20342.8"
}, {
"index" : "2020-12-29T08:02:17.000Z",
"value" : "20342.8"
}, {
"index" : "2020-12-29T08:02:18.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:19.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:20.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:21.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:22.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:23.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:24.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:25.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:26.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:27.000Z",
"value" : "20342.9"
}, {
"index" : "2020-12-29T08:02:28.000Z",
"value" : "20343"
}, {
"index" : "2020-12-29T08:02:29.000Z",
"value" : "20343"
}, {
"index" : "2020-12-29T08:02:30.000Z",
"value" : "20343"
}, {
"index" : "2020-12-29T08:02:31.000Z",
"value" : "20343"
}, {
"index" : "2020-12-29T08:02:32.000Z",
"value" : "20343"
}, {
"index" : "2020-12-29T08:02:33.000Z",
"value" : "20343"
}, {
"index" : "2020-12-29T08:02:34.000Z",
"value" : "20343"
}, {
"index" : "2020-12-29T08:02:35.000Z",
"value" : "20343.1"
}, {
"index" : "2020-12-29T08:02:36.000Z",
"value" : "20343.1"
}, {
"index" : "2020-12-29T08:02:37.000Z",
"value" : "20343.1"
}, {
"index" : "2020-12-29T08:02:38.000Z",
"value" : "20343.1"
}, {
"index" : "2020-12-29T08:02:39.000Z",
"value" : "20343.1"
}, {
"index" : "2020-12-29T08:02:40.000Z",
"value" : "20343.1"
}, {
"index" : "2020-12-29T08:02:41.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:42.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:43.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:44.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:45.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:46.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:47.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:48.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:49.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:50.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:51.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:52.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:53.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:54.000Z",
"value" : "20343.2"
}, {
"index" : "2020-12-29T08:02:55.000Z",
"value" : "20343.3"
}, {
"index" : "2020-12-29T08:02:56.000Z",
"value" : "20343.3"
}, {
"index" : "2020-12-29T08:02:57.000Z",
"value" : "20343.3"
}, {
"index" : "2020-12-29T08:02:58.000Z",
"value" : "20343.3"
}, {
"index" : "2020-12-29T08:02:59.000Z",
"value" : "20343.4"
}, {
"index" : "2020-12-29T08:03:00.000Z",
"value" : "20343.4"
}, {
"index" : "2020-12-29T08:03:01.000Z",
"value" : "20343.5"
}, {
"index" : "2020-12-29T08:03:02.000Z",
"value" : "20343.5"
}, {
"index" : "2020-12-29T08:03:03.000Z",
"value" : "20343.5"
}, {
"index" : "2020-12-29T08:03:04.000Z",
"value" : "20343.6"
}, {
"index" : "2020-12-29T08:03:05.000Z",
"value" : "20343.6"
}, {
"index" : "2020-12-29T08:03:06.000Z",
"value" : "20343.6"
}, {
"index" : "2020-12-29T08:03:07.000Z",
"value" : "20343.7"
}, {
"index" : "2020-12-29T08:03:08.000Z",
"value" : "20343.7"
}, {
"index" : "2020-12-29T08:03:09.000Z",
"value" : "20343.7"
}, {
"index" : "2020-12-29T08:03:10.000Z",
"value" : "20343.7"
}, {
"index" : "2020-12-29T08:03:11.000Z",
"value" : "20343.8"
}, {
"index" : "2020-12-29T08:03:12.000Z",
"value" : "20343.8"
}, {
"index" : "2020-12-29T08:03:13.000Z",
"value" : "20343.8"
}, {
"index" : "2020-12-29T08:03:14.000Z",
"value" : "20343.8"
}, {
"index" : "2020-12-29T08:03:15.000Z",
"value" : "20343.8"
}, {
"index" : "2020-12-29T08:03:16.000Z",
"value" : "20343.8"
}, {
"index" : "2020-12-29T08:03:17.000Z",
"value" : "20343.8"
}, {
"index" : "2020-12-29T08:03:18.000Z",
"value" : "20343.8"
}, {
"index" : "2020-12-29T08:03:19.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:20.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:21.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:22.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:23.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:24.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:25.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:26.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:27.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:28.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:29.000Z",
"value" : "20343.9"
}, {
"index" : "2020-12-29T08:03:30.000Z",
"value" : "20344"
}, {
"index" : "2020-12-29T08:03:31.000Z",
"value" : "20344"
}, {
"index" : "2020-12-29T08:03:32.000Z",
"value" : "20344"
}, {
"index" : "2020-12-29T08:03:33.000Z",
"value" : "20344"
}, {
"index" : "2020-12-29T08:03:34.000Z",
"value" : "20344"
}, {
"index" : "2020-12-29T08:03:35.000Z",
"value" : "20344"
}, {
"index" : "2020-12-29T08:03:36.000Z",
"value" : "20344.1"
}, {
"index" : "2020-12-29T08:03:37.000Z",
"value" : "20344.1"
}, {
"index" : "2020-12-29T08:03:38.000Z",
"value" : "20344.1"
}, {
"index" : "2020-12-29T08:03:39.000Z",
"value" : "20344.1"
}, {
"index" : "2020-12-29T08:03:40.000Z",
"value" : "20344.1"
}, {
"index" : "2020-12-29T08:03:41.000Z",
"value" : "20344.1"
}, {
"index" : "2020-12-29T08:03:42.000Z",
"value" : "20344.2"
}, {
"index" : "2020-12-29T08:03:43.000Z",
"value" : "20344.2"
}, {
"index" : "2020-12-29T08:03:44.000Z",
"value" : "20344.2"
}, {
"index" : "2020-12-29T08:03:45.000Z",
"value" : "20344.2"
}, {
"index" : "2020-12-29T08:03:46.000Z",
"value" : "20344.2"
}, {
"index" : "2020-12-29T08:03:47.000Z",
"value" : "20344.2"
}, {
"index" : "2020-12-29T08:03:48.000Z",
"value" : "20344.2"
}, {
"index" : "2020-12-29T08:03:49.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:50.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:51.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:52.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:53.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:54.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:55.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:56.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:57.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:58.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:03:59.000Z",
"value" : "20344.3"
}, {
"index" : "2020-12-29T08:04:00.000Z",
"value" : "20344.4"
}, {
"index" : "2020-12-29T08:04:01.000Z",
"value" : "20344.4"
}, {
"index" : "2020-12-29T08:04:02.000Z",
"value" : "20344.4"
}, {
"index" : "2020-12-29T08:04:03.000Z",
"value" : "20344.4"
}, {
"index" : "2020-12-29T08:04:04.000Z",
"value" : "20344.4"
}, {
"index" : "2020-12-29T08:04:05.000Z",
"value" : "20344.5"
}, {
"index" : "2020-12-29T08:04:06.000Z",
"value" : "20344.5"
}, {
"index" : "2020-12-29T08:04:07.000Z",
"value" : "20344.5"
}, {
"index" : "2020-12-29T08:04:08.000Z",
"value" : "20344.5"
}, {
"index" : "2020-12-29T08:04:09.000Z",
"value" : "20344.5"
}, {
"index" : "2020-12-29T08:04:10.000Z",
"value" : "20344.5"
}, {
"index" : "2020-12-29T08:04:11.000Z",
"value" : "20344.6"
}, {
"index" : "2020-12-29T08:04:12.000Z",
"value" : "20344.6"
}, {
"index" : "2020-12-29T08:04:13.000Z",
"value" : "20344.6"
}, {
"index" : "2020-12-29T08:04:14.000Z",
"value" : "20344.6"
}, {
"index" : "2020-12-29T08:04:15.000Z",
"value" : "20344.6"
}, {
"index" : "2020-12-29T08:04:16.000Z",
"value" : "20344.6"
}, {
"index" : "2020-12-29T08:04:17.000Z",
"value" : "20344.6"
}, {
"index" : "2020-12-29T08:04:18.000Z",
"value" : "20344.7"
}, {
"index" : "2020-12-29T08:04:19.000Z",
"value" : "20344.7"
}, {
"index" : "2020-12-29T08:04:20.000Z",
"value" : "20344.7"
}, {
"index" : "2020-12-29T08:04:21.000Z",
"value" : "20344.7"
}, {
"index" : "2020-12-29T08:04:22.000Z",
"value" : "20344.7"
}, {
"index" : "2020-12-29T08:04:23.000Z",
"value" : "20344.7"
}, {
"index" : "2020-12-29T08:04:24.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:25.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:26.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:27.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:28.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:29.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:30.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:31.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:32.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:33.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:34.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:35.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:36.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:37.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:38.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:39.000Z",
"value" : "20344.8"
}, {
"index" : "2020-12-29T08:04:40.000Z",
"value" : "20344.9"
}, {
"index" : "2020-12-29T08:04:41.000Z",
"value" : "20344.9"
}, {
"index" : "2020-12-29T08:04:42.000Z",
"value" : "20344.9"
}, {
"index" : "2020-12-29T08:04:43.000Z",
"value" : "20344.9"
}, {
"index" : "2020-12-29T08:04:44.000Z",
"value" : "20345"
}, {
"index" : "2020-12-29T08:04:45.000Z",
"value" : "20345"
}, {
"index" : "2020-12-29T08:04:46.000Z",
"value" : "20345"
}, {
"index" : "2020-12-29T08:04:47.000Z",
"value" : "20345"
}, {
"index" : "2020-12-29T08:04:48.000Z",
"value" : "20345"
}, {
"index" : "2020-12-29T08:04:49.000Z",
"value" : "20345"
}, {
"index" : "2020-12-29T08:04:50.000Z",
"value" : "20345"
}, {
"index" : "2020-12-29T08:04:51.000Z",
"value" : "20345"
}, {
"index" : "2020-12-29T08:04:52.000Z",
"value" : "20345.1"
}, {
"index" : "2020-12-29T08:04:53.000Z",
"value" : "20345.1"
}, {
"index" : "2020-12-29T08:04:54.000Z",
"value" : "20345.1"
}, {
"index" : "2020-12-29T08:04:55.000Z",
"value" : "20345.1"
}, {
"index" : "2020-12-29T08:04:56.000Z",
"value" : "20345.1"
}, {
"index" : "2020-12-29T08:04:57.000Z",
"value" : "20345.1"
}, {
"index" : "2020-12-29T08:04:58.000Z",
"value" : "20345.1"
}, {
"index" : "2020-12-29T08:04:59.000Z",
"value" : "20345.1"
}, {
"index" : "2020-12-29T08:05:00.000Z",
"value" : "20345.1"
}, {
"index" : "2020-12-29T08:05:01.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:02.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:03.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:04.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:05.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:06.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:07.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:08.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:09.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:10.000Z",
"value" : "20345.2"
}, {
"index" : "2020-12-29T08:05:11.000Z",
"value" : "20345.3"
}, {
"index" : "2020-12-29T08:05:12.000Z",
"value" : "20345.3"
}, {
"index" : "2020-12-29T08:05:13.000Z",
"value" : "20345.3"
}, {
"index" : "2020-12-29T08:05:14.000Z",
"value" : "20345.3"
}, {
"index" : "2020-12-29T08:05:15.000Z",
"value" : "20345.3"
}, {
"index" : "2020-12-29T08:05:16.000Z",
"value" : "20345.3"
}, {
"index" : "2020-12-29T08:05:17.000Z",
"value" : "20345.3"
}, {
"index" : "2020-12-29T08:05:18.000Z",
"value" : "20345.3"
}, {
"index" : "2020-12-29T08:05:19.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:20.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:21.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:22.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:23.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:24.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:25.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:26.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:27.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:28.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:29.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:30.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:31.000Z",
"value" : "20345.4"
}, {
"index" : "2020-12-29T08:05:32.000Z",
"value" : "20345.5"
}, {
"index" : "2020-12-29T08:05:33.000Z",
"value" : "20345.5"
}, {
"index" : "2020-12-29T08:05:34.000Z",
"value" : "20345.5"
}, {
"index" : "2020-12-29T08:05:35.000Z",
"value" : "20345.5"
}, {
"index" : "2020-12-29T08:05:36.000Z",
"value" : "20345.5"
}, {
"index" : "2020-12-29T08:05:37.000Z",
"value" : "20345.5"
}, {
"index" : "2020-12-29T08:05:38.000Z",
"value" : "20345.6"
}, {
"index" : "2020-12-29T08:05:39.000Z",
"value" : "20345.6"
}, {
"index" : "2020-12-29T08:05:40.000Z",
"value" : "20345.6"
}, {
"index" : "2020-12-29T08:05:41.000Z",
"value" : "20345.6"
}, {
"index" : "2020-12-29T08:05:42.000Z",
"value" : "20345.6"
}, {
"index" : "2020-12-29T08:05:43.000Z",
"value" : "20345.6"
}, {
"index" : "2020-12-29T08:05:44.000Z",
"value" : "20345.6"
}, {
"index" : "2020-12-29T08:05:45.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:46.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:47.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:48.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:49.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:50.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:51.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:52.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:53.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:54.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:55.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:56.000Z",
"value" : "20345.7"
}, {
"index" : "2020-12-29T08:05:57.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:05:58.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:05:59.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:06:00.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:06:01.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:06:02.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:06:03.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:06:04.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:06:05.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:06:06.000Z",
"value" : "20345.8"
}, {
"index" : "2020-12-29T08:06:07.000Z",
"value" : "20345.9"
}, {
"index" : "2020-12-29T08:06:08.000Z",
"value" : "20345.9"
}, {
"index" : "2020-12-29T08:06:09.000Z",
"value" : "20345.9"
}, {
"index" : "2020-12-29T08:06:10.000Z",
"value" : "20345.9"
}, {
"index" : "2020-12-29T08:06:11.000Z",
"value" : "20345.9"
}, {
"index" : "2020-12-29T08:06:12.000Z",
"value" : "20345.9"
}, {
"index" : "2020-12-29T08:06:13.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:14.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:15.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:16.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:17.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:18.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:19.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:20.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:21.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:22.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:23.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:24.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:25.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:26.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:27.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:28.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:29.000Z",
"value" : "20346"
}, {
"index" : "2020-12-29T08:06:30.000Z",
"value" : "20346.1"
}, {
"index" : "2020-12-29T08:06:31.000Z",
"value" : "20346.1"
}, {
"index" : "2020-12-29T08:06:32.000Z",
"value" : "20346.1"
}, {
"index" : "2020-12-29T08:06:33.000Z",
"value" : "20346.1"
}, {
"index" : "2020-12-29T08:06:34.000Z",
"value" : "20346.1"
}, {
"index" : "2020-12-29T08:06:35.000Z",
"value" : "20346.1"
}, {
"index" : "2020-12-29T08:06:36.000Z",
"value" : "20346.2"
}, {
"index" : "2020-12-29T08:06:37.000Z",
"value" : "20346.2"
}, {
"index" : "2020-12-29T08:06:38.000Z",
"value" : "20346.2"
}, {
"index" : "2020-12-29T08:06:39.000Z",
"value" : "20346.2"
}, {
"index" : "2020-12-29T08:06:40.000Z",
"value" : "20346.2"
}, {
"index" : "2020-12-29T08:06:41.000Z",
"value" : "20346.2"
}, {
"index" : "2020-12-29T08:06:42.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:43.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:44.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:45.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:46.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:47.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:48.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:49.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:50.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:51.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:52.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:53.000Z",
"value" : "20346.3"
}, {
"index" : "2020-12-29T08:06:54.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:06:55.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:06:56.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:06:57.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:06:58.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:06:59.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:00.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:01.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:02.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:03.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:04.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:05.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:06.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:07.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:08.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:09.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:10.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:11.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:12.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:13.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:14.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:15.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:16.000Z",
"value" : "20346.4"
}, {
"index" : "2020-12-29T08:07:17.000Z",
"value" : "20346.5"
}, {
"index" : "2020-12-29T08:07:18.000Z",
"value" : "20346.5"
}, {
"index" : "2020-12-29T08:07:19.000Z",
"value" : "20346.5"
}, {
"index" : "2020-12-29T08:07:20.000Z",
"value" : "20346.6"
}, {
"index" : "2020-12-29T08:07:21.000Z",
"value" : "20346.6"
}, {
"index" : "2020-12-29T08:07:22.000Z",
"value" : "20346.6"
}, {
"index" : "2020-12-29T08:07:23.000Z",
"value" : "20346.6"
}, {
"index" : "2020-12-29T08:07:24.000Z",
"value" : "20346.6"
}, {
"index" : "2020-12-29T08:07:25.000Z",
"value" : "20346.6"
}, {
"index" : "2020-12-29T08:07:26.000Z",
"value" : "20346.7"
}, {
"index" : "2020-12-29T08:07:27.000Z",
"value" : "20346.7"
}, {
"index" : "2020-12-29T08:07:28.000Z",
"value" : "20346.7"
}, {
"index" : "2020-12-29T08:07:29.000Z",
"value" : "20346.7"
}, {
"index" : "2020-12-29T08:07:30.000Z",
"value" : "20346.7"
}, {
"index" : "2020-12-29T08:07:31.000Z",
"value" : "20346.7"
}, {
"index" : "2020-12-29T08:07:32.000Z",
"value" : "20346.7"
}, {
"index" : "2020-12-29T08:07:33.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:34.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:35.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:36.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:37.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:38.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:39.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:40.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:41.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:42.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:43.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:44.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:45.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:46.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:47.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:48.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:49.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:50.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:51.000Z",
"value" : "20346.8"
}, {
"index" : "2020-12-29T08:07:52.000Z",
"value" : "20346.9"
}, {
"index" : "2020-12-29T08:07:53.000Z",
"value" : "20346.9"
}, {
"index" : "2020-12-29T08:07:54.000Z",
"value" : "20346.9"
}, {
"index" : "2020-12-29T08:07:55.000Z",
"value" : "20346.9"
}, {
"index" : "2020-12-29T08:07:56.000Z",
"value" : "20347"
}, {
"index" : "2020-12-29T08:07:57.000Z",
"value" : "20347"
}, {
"index" : "2020-12-29T08:07:58.000Z",
"value" : "20347"
}, {
"index" : "2020-12-29T08:07:59.000Z",
"value" : "20347"
}, {
"index" : "2020-12-29T08:08:00.000Z",
"value" : "20347"
}, {
"index" : "2020-12-29T08:08:01.000Z",
"value" : "20347.1"
}, {
"index" : "2020-12-29T08:08:02.000Z",
"value" : "20347.1"
}, {
"index" : "2020-12-29T08:08:03.000Z",
"value" : "20347.1"
}, {
"index" : "2020-12-29T08:08:04.000Z",
"value" : "20347.1"
}, {
"index" : "2020-12-29T08:08:05.000Z",
"value" : "20347.1"
}, {
"index" : "2020-12-29T08:08:06.000Z",
"value" : "20347.1"
}, {
"index" : "2020-12-29T08:08:07.000Z",
"value" : "20347.2"
}, {
"index" : "2020-12-29T08:08:08.000Z",
"value" : "20347.2"
}, {
"index" : "2020-12-29T08:08:09.000Z",
"value" : "20347.2"
}, {
"index" : "2020-12-29T08:08:30.000Z",
"value" : "20347.4"
}, {
"index" : "2020-12-29T08:08:31.000Z",
"value" : "20347.5"
}, {
"index" : "2020-12-29T08:08:32.000Z",
"value" : "20347.5"
}, {
"index" : "2020-12-29T08:08:33.000Z",
"value" : "20347.5"
}, {
"index" : "2020-12-29T08:08:34.000Z",
"value" : "20347.5"
}, {
"index" : "2020-12-29T08:08:35.000Z",
"value" : "20347.5"
}, {
"index" : "2020-12-29T08:08:36.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:37.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:38.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:39.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:40.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:41.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:42.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:43.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:44.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:45.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:46.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:47.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:48.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:49.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:50.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:51.000Z",
"value" : "20347.6"
}, {
"index" : "2020-12-29T08:08:52.000Z",
"value" : "20347.7"
}, {
"index" : "2020-12-29T08:08:53.000Z",
"value" : "20347.7"
}, {
"index" : "2020-12-29T08:08:54.000Z",
"value" : "20347.7"
}, {
"index" : "2020-12-29T08:08:55.000Z",
"value" : "20347.7"
}, {
"index" : "2020-12-29T08:08:56.000Z",
"value" : "20347.7"
}, {
"index" : "2020-12-29T08:08:57.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:08:58.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:08:59.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:09:00.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:09:01.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:09:02.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:09:03.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:09:04.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:09:05.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:09:06.000Z",
"value" : "20347.8"
}, {
"index" : "2020-12-29T08:09:07.000Z",
"value" : "20347.9"
}, {
"index" : "2020-12-29T08:09:08.000Z",
"value" : "20347.9"
}, {
"index" : "2020-12-29T08:09:09.000Z",
"value" : "20347.9"
}, {
"index" : "2020-12-29T08:09:10.000Z",
"value" : "20347.9"
}, {
"index" : "2020-12-29T08:09:11.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:12.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:13.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:14.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:15.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:16.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:17.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:18.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:19.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:20.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:21.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:22.000Z",
"value" : "20348"
}, {
"index" : "2020-12-29T08:09:23.000Z",
"value" : "20348.1"
}, {
"index" : "2020-12-29T08:09:24.000Z",
"value" : "20348.1"
}, {
"index" : "2020-12-29T08:09:25.000Z",
"value" : "20348.1"
}, {
"index" : "2020-12-29T08:09:26.000Z",
"value" : "20348.1"
}, {
"index" : "2020-12-29T08:09:27.000Z",
"value" : "20348.1"
}, {
"index" : "2020-12-29T08:09:28.000Z",
"value" : "20348.1"
}, {
"index" : "2020-12-29T08:09:29.000Z",
"value" : "20348.1"
}, {
"index" : "2020-12-29T08:09:30.000Z",
"value" : "20348.1"
}, {
"index" : "2020-12-29T08:09:31.000Z",
"value" : "20348.1"
}, {
"index" : "2020-12-29T08:09:32.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:33.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:34.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:35.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:36.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:37.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:38.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:39.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:40.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:41.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:42.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:43.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:44.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:45.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:46.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:47.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:48.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:49.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:50.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:51.000Z",
"value" : "20348.2"
}, {
"index" : "2020-12-29T08:09:52.000Z",
"value" : "20348.3"
}, {
"index" : "2020-12-29T08:09:53.000Z",
"value" : "20348.3"
}, {
"index" : "2020-12-29T08:09:54.000Z",
"value" : "20348.3"
}, {
"index" : "2020-12-29T08:09:55.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:09:56.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:09:57.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:09:58.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:09:59.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:10:00.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:10:01.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:10:02.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:10:03.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:10:04.000Z",
"value" : "20348.4"
}, {
"index" : "2020-12-29T08:10:05.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:06.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:07.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:08.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:09.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:10.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:11.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:12.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:13.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:14.000Z",
"value" : "20348.5"
}, {
"index" : "2020-12-29T08:10:15.000Z",
"value" : "20348.6"
}, {
"index" : "2020-12-29T08:10:16.000Z",
"value" : "20348.6"
}, {
"index" : "2020-12-29T08:10:17.000Z",
"value" : "20348.6"
}, {
"index" : "2020-12-29T08:10:18.000Z",
"value" : "20348.6"
}, {
"index" : "2020-12-29T08:10:19.000Z",
"value" : "20348.6"
}, {
"index" : "2020-12-29T08:10:20.000Z",
"value" : "20348.6"
}, {
"index" : "2020-12-29T08:10:21.000Z",
"value" : "20348.6"
}, {
"index" : "2020-12-29T08:10:22.000Z",
"value" : "20348.7"
}, {
"index" : "2020-12-29T08:10:23.000Z",
"value" : "20348.7"
}, {
"index" : "2020-12-29T08:10:24.000Z",
"value" : "20348.7"
}, {
"index" : "2020-12-29T08:10:25.000Z",
"value" : "20348.7"
}, {
"index" : "2020-12-29T08:10:26.000Z",
"value" : "20348.7"
}, {
"index" : "2020-12-29T08:10:27.000Z",
"value" : "20348.7"
}, {
"index" : "2020-12-29T08:10:28.000Z",
"value" : "20348.7"
}, {
"index" : "2020-12-29T08:10:29.000Z",
"value" : "20348.7"
}, {
"index" : "2020-12-29T08:10:30.000Z",
"value" : "20348.7"
}, {
"index" : "2020-12-29T08:10:31.000Z",
"value" : "20348.8"
}, {
"index" : "2020-12-29T08:10:32.000Z",
"value" : "20348.8"
}, {
"index" : "2020-12-29T08:10:33.000Z",
"value" : "20348.8"
}, {
"index" : "2020-12-29T08:10:34.000Z",
"value" : "20348.8"
}, {
"index" : "2020-12-29T08:10:35.000Z",
"value" : "20348.8"
}, {
"index" : "2020-12-29T08:10:36.000Z",
"value" : "20348.8"
}, {
"index" : "2020-12-29T08:10:37.000Z",
"value" : "20348.8"
}, {
"index" : "2020-12-29T08:10:38.000Z",
"value" : "20348.8"
}, {
"index" : "2020-12-29T08:10:39.000Z",
"value" : "20348.9"
}, {
"index" : "2020-12-29T08:10:40.000Z",
"value" : "20348.9"
}, {
"index" : "2020-12-29T08:10:41.000Z",
"value" : "20348.9"
}, {
"index" : "2020-12-29T08:10:42.000Z",
"value" : "20348.9"
}, {
"index" : "2020-12-29T08:10:43.000Z",
"value" : "20348.9"
}, {
"index" : "2020-12-29T08:10:44.000Z",
"value" : "20348.9"
}, {
"index" : "2020-12-29T08:10:45.000Z",
"value" : "20348.9"
}, {
"index" : "2020-12-29T08:10:46.000Z",
"value" : "20349"
}, {
"index" : "2020-12-29T08:10:47.000Z",
"value" : "20349"
}, {
"index" : "2020-12-29T08:10:48.000Z",
"value" : "20349"
}, {
"index" : "2020-12-29T08:10:49.000Z",
"value" : "20349"
}, {
"index" : "2020-12-29T08:10:50.000Z",
"value" : "20349"
}, {
"index" : "2020-12-29T08:10:51.000Z",
"value" : "20349"
}, {
"index" : "2020-12-29T08:10:52.000Z",
"value" : "20349"
}, {
"index" : "2020-12-29T08:10:53.000Z",
"value" : "20349"
}, {
"index" : "2020-12-29T08:10:54.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:10:55.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:10:56.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:10:57.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:10:58.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:10:59.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:00.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:01.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:02.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:03.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:04.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:05.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:06.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:07.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:08.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:09.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:10.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:11.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:12.000Z",
"value" : "20349.1"
}, {
"index" : "2020-12-29T08:11:13.000Z",
"value" : "20349.2"
}, {
"index" : "2020-12-29T08:11:14.000Z",
"value" : "20349.2"
}, {
"index" : "2020-12-29T08:11:15.000Z",
"value" : "20349.2"
}, {
"index" : "2020-12-29T08:11:16.000Z",
"value" : "20349.2"
}, {
"index" : "2020-12-29T08:11:17.000Z",
"value" : "20349.2"
}, {
"index" : "2020-12-29T08:11:18.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:19.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:20.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:21.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:22.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:23.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:24.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:25.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:26.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:27.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:28.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:29.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:30.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:31.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:32.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:33.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:34.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:35.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:36.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:37.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:38.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:39.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:40.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:41.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:42.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:43.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:44.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:45.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:46.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:47.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:48.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:49.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:50.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:51.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:52.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:53.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:54.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:55.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:56.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:57.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:58.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:11:59.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:00.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:01.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:02.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:03.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:04.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:05.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:06.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:07.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:08.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:09.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:10.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:11.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:12.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:13.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:14.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:15.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:16.000Z",
"value" : "20349.3"
}, {
"index" : "2020-12-29T08:12:17.000Z",
"value" : "20349.4"
}, {
"index" : "2020-12-29T08:12:18.000Z",
"value" : "20349.4"
}, {
"index" : "2020-12-29T08:12:19.000Z",
"value" : "20349.4"
}, {
"index" : "2020-12-29T08:12:20.000Z",
"value" : "20349.5"
}, {
"index" : "2020-12-29T08:12:21.000Z",
"value" : "20349.5"
}, {
"index" : "2020-12-29T08:12:22.000Z",
"value" : "20349.5"
}, {
"index" : "2020-12-29T08:12:23.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:24.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:25.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:26.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:27.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:28.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:29.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:30.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:31.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:32.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:33.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:34.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:35.000Z",
"value" : "20349.6"
}, {
"index" : "2020-12-29T08:12:36.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:37.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:38.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:39.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:40.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:41.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:42.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:43.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:44.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:45.000Z",
"value" : "20349.7"
}, {
"index" : "2020-12-29T08:12:46.000Z",
"value" : "20349.8"
}, {
"index" : "2020-12-29T08:12:47.000Z",
"value" : "20349.8"
}, {
"index" : "2020-12-29T08:12:48.000Z",
"value" : "20349.8"
}, {
"index" : "2020-12-29T08:12:49.000Z",
"value" : "20349.9"
}, {
"index" : "2020-12-29T08:12:50.000Z",
"value" : "20349.9"
}, {
"index" : "2020-12-29T08:12:51.000Z",
"value" : "20349.9"
}, {
"index" : "2020-12-29T08:12:52.000Z",
"value" : "20349.9"
}, {
"index" : "2020-12-29T08:12:53.000Z",
"value" : "20349.9"
}, {
"index" : "2020-12-29T08:12:54.000Z",
"value" : "20349.9"
}, {
"index" : "2020-12-29T08:12:55.000Z",
"value" : "20349.9"
}, {
"index" : "2020-12-29T08:12:56.000Z",
"value" : "20349.9"
}, {
"index" : "2020-12-29T08:12:57.000Z",
"value" : "20350"
}, {
"index" : "2020-12-29T08:12:58.000Z",
"value" : "20350"
}, {
"index" : "2020-12-29T08:12:59.000Z",
"value" : "20350"
}, {
"index" : "2020-12-29T08:13:00.000Z",
"value" : "20350"
}, {
"index" : "2020-12-29T08:13:01.000Z",
"value" : "20350"
}, {
"index" : "2020-12-29T08:13:02.000Z",
"value" : "20350"
}, {
"index" : "2020-12-29T08:13:03.000Z",
"value" : "20350.1"
}, {
"index" : "2020-12-29T08:13:04.000Z",
"value" : "20350.1"
}, {
"index" : "2020-12-29T08:13:05.000Z",
"value" : "20350.1"
}, {
"index" : "2020-12-29T08:13:06.000Z",
"value" : "20350.1"
}, {
"index" : "2020-12-29T08:13:07.000Z",
"value" : "20350.1"
}, {
"index" : "2020-12-29T08:13:08.000Z",
"value" : "20350.1"
}, {
"index" : "2020-12-29T08:13:09.000Z",
"value" : "20350.1"
}, {
"index" : "2020-12-29T08:13:10.000Z",
"value" : "20350.1"
}, {
"index" : "2020-12-29T08:13:11.000Z",
"value" : "20350.1"
}, {
"index" : "2020-12-29T08:13:12.000Z",
"value" : "20350.2"
}, {
"index" : "2020-12-29T08:13:13.000Z",
"value" : "20350.2"
}, {
"index" : "2020-12-29T08:13:14.000Z",
"value" : "20350.2"
}, {
"index" : "2020-12-29T08:13:15.000Z",
"value" : "20350.2"
}, {
"index" : "2020-12-29T08:13:16.000Z",
"value" : "20350.2"
}, {
"index" : "2020-12-29T08:13:17.000Z",
"value" : "20350.2"
}, {
"index" : "2020-12-29T08:13:18.000Z",
"value" : "20350.2"
}, {
"index" : "2020-12-29T08:13:19.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:20.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:21.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:22.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:23.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:24.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:25.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:26.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:27.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:28.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:29.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:30.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:31.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:32.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:33.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:34.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:35.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:36.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:37.000Z",
"value" : "20350.3"
}, {
"index" : "2020-12-29T08:13:38.000Z",
"value" : "20350.4"
}, {
"index" : "2020-12-29T08:13:39.000Z",
"value" : "20350.4"
}, {
"index" : "2020-12-29T08:13:40.000Z",
"value" : "20350.4"
}, {
"index" : "2020-12-29T08:13:41.000Z",
"value" : "20350.4"
}, {
"index" : "2020-12-29T08:13:42.000Z",
"value" : "20350.5"
}, {
"index" : "2020-12-29T08:13:43.000Z",
"value" : "20350.5"
}, {
"index" : "2020-12-29T08:13:44.000Z",
"value" : "20350.5"
}, {
"index" : "2020-12-29T08:13:45.000Z",
"value" : "20350.6"
}, {
"index" : "2020-12-29T08:13:46.000Z",
"value" : "20350.6"
}, {
"index" : "2020-12-29T08:13:47.000Z",
"value" : "20350.6"
}, {
"index" : "2020-12-29T08:13:48.000Z",
"value" : "20350.6"
}, {
"index" : "2020-12-29T08:13:49.000Z",
"value" : "20350.6"
}, {
"index" : "2020-12-29T08:13:50.000Z",
"value" : "20350.6"
}, {
"index" : "2020-12-29T08:13:51.000Z",
"value" : "20350.6"
}, {
"index" : "2020-12-29T08:13:52.000Z",
"value" : "20350.6"
}, {
"index" : "2020-12-29T08:13:53.000Z",
"value" : "20350.6"
}, {
"index" : "2020-12-29T08:13:54.000Z",
"value" : "20350.7"
}, {
"index" : "2020-12-29T08:13:55.000Z",
"value" : "20350.7"
}, {
"index" : "2020-12-29T08:13:56.000Z",
"value" : "20350.7"
}, {
"index" : "2020-12-29T08:13:57.000Z",
"value" : "20350.7"
}, {
"index" : "2020-12-29T08:13:58.000Z",
"value" : "20350.7"
}, {
"index" : "2020-12-29T08:13:59.000Z",
"value" : "20350.7"
}, {
"index" : "2020-12-29T08:14:00.000Z",
"value" : "20350.8"
}, {
"index" : "2020-12-29T08:14:01.000Z",
"value" : "20350.8"
}, {
"index" : "2020-12-29T08:14:02.000Z",
"value" : "20350.8"
}, {
"index" : "2020-12-29T08:14:03.000Z",
"value" : "20350.8"
}, {
"index" : "2020-12-29T08:14:04.000Z",
"value" : "20350.8"
}, {
"index" : "2020-12-29T08:14:05.000Z",
"value" : "20350.8"
}, {
"index" : "2020-12-29T08:14:06.000Z",
"value" : "20350.8"
}, {
"index" : "2020-12-29T08:14:07.000Z",
"value" : "20350.8"
}, {
"index" : "2020-12-29T08:14:08.000Z",
"value" : "20350.8"
}, {
"index" : "2020-12-29T08:14:09.000Z",
"value" : "20350.9"
}, {
"index" : "2020-12-29T08:14:10.000Z",
"value" : "20350.9"
}, {
"index" : "2020-12-29T08:14:11.000Z",
"value" : "20350.9"
}, {
"index" : "2020-12-29T08:14:12.000Z",
"value" : "20350.9"
}, {
"index" : "2020-12-29T08:14:13.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:14.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:15.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:16.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:17.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:18.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:19.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:20.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:21.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:22.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:23.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:24.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:25.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:26.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:27.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:28.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:29.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:30.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:31.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:32.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:33.000Z",
"value" : "20351"
}, {
"index" : "2020-12-29T08:14:34.000Z",
"value" : "20351.1"
}, {
"index" : "2020-12-29T08:14:35.000Z",
"value" : "20351.1"
}, {
"index" : "2020-12-29T08:14:36.000Z",
"value" : "20351.1"
}, {
"index" : "2020-12-29T08:14:37.000Z",
"value" : "20351.1"
}, {
"index" : "2020-12-29T08:14:38.000Z",
"value" : "20351.1"
}, {
"index" : "2020-12-29T08:14:39.000Z",
"value" : "20351.2"
}, {
"index" : "2020-12-29T08:14:40.000Z",
"value" : "20351.2"
}, {
"index" : "2020-12-29T08:14:41.000Z",
"value" : "20351.2"
}, {
"index" : "2020-12-29T08:14:42.000Z",
"value" : "20351.3"
}, {
"index" : "2020-12-29T08:14:43.000Z",
"value" : "20351.3"
}, {
"index" : "2020-12-29T08:14:44.000Z",
"value" : "20351.3"
}, {
"index" : "2020-12-29T08:14:45.000Z",
"value" : "20351.4"
}, {
"index" : "2020-12-29T08:14:46.000Z",
"value" : "20351.4"
}, {
"index" : "2020-12-29T08:14:47.000Z",
"value" : "20351.4"
}, {
"index" : "2020-12-29T08:14:48.000Z",
"value" : "20351.5"
}, {
"index" : "2020-12-29T08:14:49.000Z",
"value" : "20351.5"
}, {
"index" : "2020-12-29T08:14:50.000Z",
"value" : "20351.5"
}, {
"index" : "2020-12-29T08:14:51.000Z",
"value" : "20351.6"
}, {
"index" : "2020-12-29T08:14:52.000Z",
"value" : "20351.6"
}, {
"index" : "2020-12-29T08:14:53.000Z",
"value" : "20351.7"
}, {
"index" : "2020-12-29T08:14:54.000Z",
"value" : "20351.7"
}, {
"index" : "2020-12-29T08:14:55.000Z",
"value" : "20351.7"
}, {
"index" : "2020-12-29T08:14:56.000Z",
"value" : "20351.7"
}, {
"index" : "2020-12-29T08:14:57.000Z",
"value" : "20351.8"
}, {
"index" : "2020-12-29T08:14:58.000Z",
"value" : "20351.8"
}, {
"index" : "2020-12-29T08:14:59.000Z",
"value" : "20351.9"
}, {
"index" : "2020-12-29T08:15:00.000Z",
"value" : "20351.9"
}, {
"index" : "2020-12-29T08:15:01.000Z",
"value" : "20351.9"
}, {
"index" : "2020-12-29T08:15:02.000Z",
"value" : "20352"
}, {
"index" : "2020-12-29T08:15:03.000Z",
"value" : "20352"
}, {
"index" : "2020-12-29T08:15:04.000Z",
"value" : "20352"
}, {
"index" : "2020-12-29T08:15:05.000Z",
"value" : "20352"
}, {
"index" : "2020-12-29T08:15:06.000Z",
"value" : "20352.1"
}, {
"index" : "2020-12-29T08:15:07.000Z",
"value" : "20352.1"
}, {
"index" : "2020-12-29T08:15:08.000Z",
"value" : "20352.1"
}, {
"index" : "2020-12-29T08:15:09.000Z",
"value" : "20352.2"
}, {
"index" : "2020-12-29T08:15:10.000Z",
"value" : "20352.2"
}, {
"index" : "2020-12-29T08:15:11.000Z",
"value" : "20352.2"
}, {
"index" : "2020-12-29T08:15:12.000Z",
"value" : "20352.2"
}, {
"index" : "2020-12-29T08:15:13.000Z",
"value" : "20352.2"
}, {
"index" : "2020-12-29T08:15:14.000Z",
"value" : "20352.3"
}, {
"index" : "2020-12-29T08:15:15.000Z",
"value" : "20352.3"
}, {
"index" : "2020-12-29T08:15:16.000Z",
"value" : "20352.3"
}, {
"index" : "2020-12-29T08:15:17.000Z",
"value" : "20352.3"
}, {
"index" : "2020-12-29T08:15:18.000Z",
"value" : "20352.4"
}, {
"index" : "2020-12-29T08:15:19.000Z",
"value" : "20352.4"
}, {
"index" : "2020-12-29T08:15:20.000Z",
"value" : "20352.4"
}, {
"index" : "2020-12-29T08:15:21.000Z",
"value" : "20352.4"
}, {
"index" : "2020-12-29T08:15:22.000Z",
"value" : "20352.4"
}, {
"index" : "2020-12-29T08:15:23.000Z",
"value" : "20352.5"
}, {
"index" : "2020-12-29T08:15:24.000Z",
"value" : "20352.5"
}, {
"index" : "2020-12-29T08:15:25.000Z",
"value" : "20352.5"
}, {
"index" : "2020-12-29T08:15:26.000Z",
"value" : "20352.5"
}, {
"index" : "2020-12-29T08:15:27.000Z",
"value" : "20352.5"
}, {
"index" : "2020-12-29T08:15:28.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:29.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:30.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:31.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:32.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:33.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:34.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:35.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:36.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:37.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:38.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:39.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:40.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:41.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:42.000Z",
"value" : "20352.6"
}, {
"index" : "2020-12-29T08:15:43.000Z",
"value" : "20352.7"
}, {
"index" : "2020-12-29T08:15:44.000Z",
"value" : "20352.7"
}, {
"index" : "2020-12-29T08:15:45.000Z",
"value" : "20352.7"
}, {
"index" : "2020-12-29T08:15:46.000Z",
"value" : "20352.7"
}, {
"index" : "2020-12-29T08:15:47.000Z",
"value" : "20352.8"
}, {
"index" : "2020-12-29T08:15:48.000Z",
"value" : "20352.8"
}, {
"index" : "2020-12-29T08:15:49.000Z",
"value" : "20352.8"
}, {
"index" : "2020-12-29T08:15:50.000Z",
"value" : "20352.8"
}, {
"index" : "2020-12-29T08:15:51.000Z",
"value" : "20352.8"
}, {
"index" : "2020-12-29T08:15:52.000Z",
"value" : "20352.9"
}, {
"index" : "2020-12-29T08:15:53.000Z",
"value" : "20352.9"
}, {
"index" : "2020-12-29T08:15:54.000Z",
"value" : "20352.9"
}, {
"index" : "2020-12-29T08:15:55.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:15:56.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:15:57.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:15:58.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:15:59.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:00.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:01.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:02.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:03.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:04.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:05.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:06.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:07.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:08.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:09.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:10.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:11.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:12.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:13.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:14.000Z",
"value" : "20353"
}, {
"index" : "2020-12-29T08:16:15.000Z",
"value" : "20353.1"
}, {
"index" : "2020-12-29T08:16:16.000Z",
"value" : "20353.1"
}, {
"index" : "2020-12-29T08:16:17.000Z",
"value" : "20353.1"
}, {
"index" : "2020-12-29T08:16:18.000Z",
"value" : "20353.2"
}, {
"index" : "2020-12-29T08:16:19.000Z",
"value" : "20353.2"
}, {
"index" : "2020-12-29T08:16:20.000Z",
"value" : "20353.2"
}, {
"index" : "2020-12-29T08:16:21.000Z",
"value" : "20353.2"
}, {
"index" : "2020-12-29T08:16:22.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:23.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:24.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:25.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:26.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:27.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:28.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:29.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:30.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:31.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:32.000Z",
"value" : "20353.3"
}, {
"index" : "2020-12-29T08:16:33.000Z",
"value" : "20353.4"
}, {
"index" : "2020-12-29T08:16:34.000Z",
"value" : "20353.4"
}, {
"index" : "2020-12-29T08:16:35.000Z",
"value" : "20353.4"
}, {
"index" : "2020-12-29T08:16:36.000Z",
"value" : "20353.4"
}, {
"index" : "2020-12-29T08:16:37.000Z",
"value" : "20353.4"
}, {
"index" : "2020-12-29T08:16:38.000Z",
"value" : "20353.4"
}, {
"index" : "2020-12-29T08:16:39.000Z",
"value" : "20353.4"
}, {
"index" : "2020-12-29T08:16:40.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:41.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:42.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:43.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:44.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:45.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:46.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:47.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:48.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:49.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:50.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:51.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:52.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:53.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:54.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:55.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:56.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:57.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:58.000Z",
"value" : "20353.5"
}, {
"index" : "2020-12-29T08:16:59.000Z",
"value" : "20353.6"
} ]
}
GET /public/api/v1/wells/{lateralUuid}/traces/{traceUuid}/data/time
| Path parameter | Description |
|---|---|
lateralUuid |
Lateral UUID |
traceUuid |
Trace UUID |
| Parameter | Description |
|---|---|
from |
Optional. Start date, for example: 2020-11-01T00:00:00.000Z. Default - the first data point of the trace |
to |
Optional. End date, for example: 2020-11-01T00:02:00.000Z. Default - the last data point of the trace. from after to returns 400 |
hash |
Optional. Trace hash from the mapped traces response. 404 is returned if it does not match the current mapping |
valueUnit |
Optional. UOM symbol to convert the values to, for example ft. 400 is returned if it is not convertible from the trace unit, ignored when the trace has no unit |
limit |
Optional. Maximum number of points to return, in [1;1000000], default 1000. Points are returned in ascending time order starting from from |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Trace data points |
content[].index |
String |
Date time of the point |
content[].value |
String |
Trace value in the trace unit, or in valueUnit if set |
Get depth series data by lateral and trace
Get depth series data of a mapped trace by lateral UUID and trace UUID. from, to and the returned index are in the trace index_unit (see Get mapped depth traces by lateral), indexUnit and valueUnit convert the returned indexes and values. The requested range is clipped to the trace data range, a range outside of it returns an empty content. Points are sorted by depth, at most limit points are returned. 404 is returned if the trace has no depth mapping on the lateral or hash does not match
Request
$ curl 'https://solo.cloud/public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/d635c218-3d17-4f5d-98b4-026085c4f584/data/depth?from=1.0&to=4.0' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/d635c218-3d17-4f5d-98b4-026085c4f584/data/depth?from=1.0&to=4.0 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: e49ae3b5652795c09329475da945b790
Content-Type: application/json
{
"content" : [ {
"index" : "1",
"value" : "10"
}, {
"index" : "2",
"value" : "20"
}, {
"index" : "3",
"value" : "30"
}, {
"index" : "4",
"value" : "40"
} ]
}
GET /public/api/v1/wells/{lateralUuid}/traces/{traceUuid}/data/depth
| Path parameter | Description |
|---|---|
lateralUuid |
Lateral UUID |
traceUuid |
Trace UUID |
| Parameter | Description |
|---|---|
from |
Optional. Start md in the trace index_unit (see mapped depth traces), for example: 0.0. Default - the first data point of the trace |
to |
Optional. End md in the trace index_unit, for example: 2300. Default - the last data point of the trace. from greater than to returns 400 |
hash |
Optional. Trace hash from the mapped traces response. 404 is returned if it does not match the current mapping |
indexUnit |
Optional. Length UOM symbol to convert the returned index values to, for example ft. from and to are not converted |
valueUnit |
Optional. UOM symbol to convert the values to. 400 is returned if it is not convertible from the trace unit, ignored when the trace has no unit |
limit |
Optional. Maximum number of points to return, in [1;1000000], default 1000. Points are returned in ascending depth order starting from from |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Trace data points |
content[].index |
String |
Md of the point in the trace index_unit, or in indexUnit if set |
content[].value |
String |
Trace value in the trace unit, or in valueUnit if set |
Get Rig Activity and KPIs (by time) by lateral and trace
Get intervals of a robot-calculated trace (Rig Activity, KPIs, etc.) by lateral UUID and trace UUID. All intervals overlapping the requested time range are returned, sorted by start time, without paging. The range defaults to the trace data range. 404 is returned if the trace is not mapped to the lateral or hash does not match. For Rig Activity value is the rig activity code: 0 In Slips, 11 In Slips - Pump, 21 Drilling, 22 Slide Drill, 23 Slide Oscillate Drill, 31 Reaming, 32 Back Reaming, 50 Static, 51 Static - Rotate&Pump, 52 Static - Pump, 53 Static - Rotate, 54 Surface Operations, 61 Run In - Tripping, 62 Run In - Pump, 63 Run In - Rotate, 64 Pull Up - Pump, 65 Pull Up - Rotate, 66 Pull Up - Trip Out, 98 Unknown, 99 Missing Input
Request
$ curl 'https://solo.cloud/public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/e3c996b6-9cdb-4876-ac99-0aab694b801a/data/calculated/time' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/e3c996b6-9cdb-4876-ac99-0aab694b801a/data/calculated/time HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 760a4176b877e375c6cbf46e72fd192b
Content-Type: application/json
{
"content" : [ {
"start" : "2020-11-01T00:00:00Z",
"end" : "2020-11-01T01:00:02Z",
"value" : "21"
}, {
"start" : "2020-12-29T08:00:00Z",
"end" : "2020-12-29T08:50:00Z",
"value" : "21"
} ]
}
GET /public/api/v1/wells/{lateralUuid}/traces/{traceUuid}/data/calculated/time
| Path parameter | Description |
|---|---|
lateralUuid |
Lateral UUID |
traceUuid |
Robot-calculated trace UUID |
| Parameter | Description |
|---|---|
from |
Optional. Start date, for example: 2020-11-01T00:00:00.000Z. Default - the start of the trace data |
to |
Optional. End date, for example: 2020-11-01T00:02:00.000Z. Default - the end of the trace data. from after to returns 400 |
hash |
Optional. Trace hash from the mapped traces response (type=CALC). 404 is returned if it does not match the current mapping |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Intervals overlapping the requested time range, sorted by start time |
content[].start |
String |
Interval start date time |
content[].end |
String |
Interval end date time |
content[].value |
String |
Interval value, for Rig Activity - the rig activity code |
Get Rig Activity and KPIs (by depth) by lateral and trace
Get intervals of a robot-calculated trace by lateral UUID and trace UUID whose depth range overlaps from-to, sorted by start depth, without paging. from, to, start and end are in meters regardless of the project unit. Intervals without depth are not returned. 404 is returned if the trace is not mapped to the lateral or hash does not match
Request
$ curl 'https://solo.cloud/public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/e3c996b6-9cdb-4876-ac99-0aab694b801a/data/calculated/depth?from=1.0&to=10.0' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/884e8457-77ff-42fd-8ecb-0b88957afb6e/traces/e3c996b6-9cdb-4876-ac99-0aab694b801a/data/calculated/depth?from=1.0&to=10.0 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 1fa9aa0d0383d33ecc84142f7c8548e6
Content-Type: application/json
{
"content" : [ {
"start" : 1.0,
"end" : 10.0,
"value" : "21"
} ]
}
GET /public/api/v1/wells/{lateralUuid}/traces/{traceUuid}/data/calculated/depth
| Path parameter | Description |
|---|---|
lateralUuid |
Lateral UUID |
traceUuid |
Robot-calculated trace UUID |
| Parameter | Description |
|---|---|
from |
Start depth in meters, regardless of the project unit |
to |
End depth in meters. from greater than to returns 400 |
hash |
Optional. Trace hash from the mapped traces response (type=CALC). 404 is returned if it does not match the current mapping |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Intervals whose depth range overlaps the requested range, intervals without depth are not returned |
content[].start |
Number |
Interval start depth in meters |
content[].end |
Number |
Interval end depth in meters |
content[].value |
String |
Interval value, for Rig Activity - the rig activity code |
14. Directional Drilling
Get slide sheet intervals
Get Slide Sheet robot intervals by lateral UUID whose depth range overlaps from-to (project depth units), sorted by start depth, without paging. Depths and lengths are returned in project depth units, angles in degrees, other values in the units listed in the response fields. Intervals without slide sheet data are not returned. An empty content is returned if the lateral has no Slide Sheet data
Request
$ curl 'https://solo.cloud/public/api/v1/wells/5070df7e-d3b2-4fd2-98f9-8328e8a5b03f/intervals/slide-sheet?from=200.0&to=500.0' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/5070df7e-d3b2-4fd2-98f9-8328e8a5b03f/intervals/slide-sheet?from=200.0&to=500.0 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3e82f972eba927cf6b42b23c910ba957
Content-Type: application/json
{
"content" : [ {
"depth_from" : 407.8224,
"depth_to" : 421.15130400000004,
"from" : "2023-04-25T03:00:15Z",
"to" : "2023-04-25T03:12:37Z",
"mode" : "ROTARY",
"distance" : 13.328904000000023,
"rop_avg" : 64.66853692722383,
"mfi_avg" : 37.97616657081958,
"diff_pressure_avg" : 28.50240282152303,
"rpm_avg" : 40.55567116396066
}, {
"depth_from" : 421.15130400000004,
"depth_to" : 426.579792,
"from" : "2023-04-25T03:18:17Z",
"to" : "2023-04-25T03:22:35Z",
"mode" : "ROTARY",
"distance" : 5.428487999999959,
"rop_avg" : 75.74634418604595,
"mfi_avg" : 44.301426562745654,
"diff_pressure_avg" : 27.84057092289668,
"rpm_avg" : 40.826889387984245
}, {
"depth_from" : 426.579792,
"depth_to" : 433.09946400000007,
"from" : "2023-04-25T03:31:29Z",
"to" : "2023-04-25T03:40:34Z",
"mode" : "SLIDE",
"distance" : 6.519672000000071,
"rop_avg" : 43.065723302752765,
"mfi_avg" : 44.29881991412529,
"diff_pressure_avg" : 18.090786997094895,
"rpm_avg" : 0.11454885460497963,
"gtf_avg" : -4188.322087125122,
"mtf_avg" : 12844.874388918157
}, {
"depth_from" : 433.09946400000007,
"depth_to" : 449.61962400000004,
"from" : "2023-04-25T03:41:42Z",
"to" : "2023-04-25T03:53:30Z",
"mode" : "ROTARY",
"distance" : 16.520159999999976,
"rop_avg" : 84.00081355932191,
"mfi_avg" : 44.29301571640074,
"diff_pressure_avg" : 36.554082604907975,
"rpm_avg" : 40.80610147601478
}, {
"depth_from" : 449.61962400000004,
"depth_to" : 454.758552,
"from" : "2023-04-25T03:59:48Z",
"to" : "2023-04-25T04:02:40Z",
"mode" : "ROTARY",
"distance" : 5.138927999999964,
"rop_avg" : 107.55895813953414,
"mfi_avg" : 56.44465664867975,
"diff_pressure_avg" : 34.757457553000386,
"rpm_avg" : 60.42781138790041
}, {
"depth_from" : 454.758552,
"depth_to" : 455.983848,
"from" : "2023-04-25T04:04:08Z",
"to" : "2023-04-25T04:06:15Z",
"mode" : "SLIDE",
"distance" : 1.2252960000000144,
"rop_avg" : 34.73280000000041,
"mfi_avg" : 56.48777290420894,
"diff_pressure_avg" : 13.452906542095633,
"rpm_avg" : 0.1718407960196003,
"gtf_avg" : -4188.322087125122,
"mtf_avg" : 12177.835638050661,
"rotary_build_rate" : -33.10848744832925,
"rotary_turn_rate" : -17.52802276676857,
"motor_yield" : 212205.26330565757
}, {
"depth_from" : 455.99604,
"depth_to" : 460.711296,
"from" : "2023-04-25T04:06:15Z",
"to" : "2023-04-25T04:11:22Z",
"mode" : "OSCILLATION_SLIDE",
"distance" : 4.715256000000011,
"rop_avg" : 55.29290423452781,
"mfi_avg" : 56.677411506534895,
"diff_pressure_avg" : 21.57243815705851,
"rpm_avg" : 6.967925016160347,
"gtf_avg" : -4188.322087125122,
"mtf_avg" : 14358.09873929123,
"tf_control" : 7850.0,
"burned_distance" : 3.4,
"survey_md" : 1274.8155148800001,
"incl" : 5193.290204884008,
"azimuth" : 20604.1382455686
} ]
}
GET /public/api/v1/wells/{lateralUuid}/intervals/slide-sheet
| Path parameter | Description |
|---|---|
lateralUuid |
Lateral UUID |
| Parameter | Description |
|---|---|
from |
Optional. Start depth in project depth units, default - no lower bound |
to |
Optional. End depth in project depth units, default - no upper bound. from greater than to returns 400 |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Slide sheet intervals whose depth range overlaps the requested range |
content[].depth_from |
Number |
Interval start depth in project depth units |
content[].depth_to |
Number |
Interval end depth in project depth units |
content[].from |
String |
Interval start time |
content[].to |
String |
Interval end time |
content[].mode |
String |
Drilling mode: ROTARY, SLIDE, OSCILLATION_SLIDE, MANUAL_TF, POWER_V, IH, HIA or AUTO_CURVE |
content[].distance |
Number |
Distance drilled in project depth units |
content[].rop_avg |
Number |
Average rate of penetration, m/h in meter projects, ft/h otherwise |
content[].wob_avg |
Number |
Average weight on bit in the project force unit template if set, otherwise tonf[metric] in meter projects and klbf otherwise |
content[].mfi_avg |
Number |
Average mud flow in, in the project flow rate unit template if set, otherwise L/s in meter projects and gal[US]/min otherwise |
content[].diff_pressure_avg |
Number |
Average differential pressure in the project pressure unit template if set, otherwise atm in meter projects and psi otherwise |
content[].rpm_avg |
Number |
Average rotary speed, RPM |
content[].gtf_avg |
Number |
Average gravity tool face, degrees |
content[].mtf_avg |
Number |
Average magnetic tool face, degrees |
content[].gtf_effective |
Number |
Effective gravity tool face, degrees |
content[].tf_control |
Number |
Tool face control, % |
content[].burned_distance |
Number |
Burned distance in project depth units |
content[].survey_md |
Number |
Survey measured depth in project depth units |
content[].incl |
Number |
Inclination, degrees |
content[].azimuth |
Number |
Azimuth, degrees |
content[].tvd |
Number |
True vertical depth in project depth units |
content[].dls |
Number |
Dog leg severity, deg/30m in meter projects, deg/100ft otherwise |
content[].rotary_build_rate |
Number |
Rotary build rate, deg/30m in meter projects, deg/100ft otherwise |
content[].rotary_turn_rate |
Number |
Rotary turn rate, deg/30m in meter projects, deg/100ft otherwise |
content[].motor_yield |
Number |
Motor yield, deg/30m in meter projects, deg/100ft otherwise |
content[].rss_dlink |
String |
RSS D-link |
content[].rss_dtf |
Number |
RSS DTF, degrees |
content[].rss_sr |
Number |
RSS steering ratio |
content[].rss_tinc |
Number |
RSS target inclination, degrees |
content[].rss_taz |
Number |
RSS target azimuth, degrees |
15. Well attributes
Create custom well attribute
Create a custom well attribute by project UUID. name, type and group_uuid are required. A name already used in the project returns 400.
For a LIST-type attribute initial options can be passed in the options field.
An IDENTIFIER-type attribute holds a string value that must be unique within the project (see the update value endpoints for the conflict behavior)
Request
$ curl 'https://solo.cloud/public/api/v1/projects/53f8699c-b621-4ac9-97e2-638ce45d54c9/wellattributes' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Custom attribute name",
"group_uuid" : "caeb5bb2-18ea-4191-9c36-f2e252259371",
"type" : "VARCHAR",
"unit" : "DISTANCE"
}'
POST /public/api/v1/projects/53f8699c-b621-4ac9-97e2-638ce45d54c9/wellattributes HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 140
{
"name" : "Custom attribute name",
"group_uuid" : "caeb5bb2-18ea-4191-9c36-f2e252259371",
"type" : "VARCHAR",
"unit" : "DISTANCE"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: fd78bbd929e03f3ad62dac49cc9d4b0a
Content-Type: application/json
{
"id" : 10005,
"uuid" : "039bc3c5-0570-4743-b9d6-1fbbcfc564d3",
"name" : "Custom attribute name"
}
POST /public/api/v1/projects/{projectUuid}/wellattributes
| Path parameter | Description |
|---|---|
projectUuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Well attribute name, up to 200 characters, unique (case-insensitive) among the project's custom and the predefined attributes |
name_short |
String |
Well attribute short name, up to 200 characters, defaults to name |
type |
String |
Well attribute type (VARCHAR, INTEGER, FLOAT, ENUM, DATE, IDENTIFIER, LIST); an IDENTIFIER attribute holds a string value that must be unique within the project |
unit |
String |
Well attribute domain (POSITION, DISTANCE, DEPTH, ANGLE, VOLUME) |
range |
Varies |
Allowed values of an ENUM attribute, optional: when present, a non-empty array of non-blank strings, unique case-insensitively, values are trimmed. Kept as is for other types |
group_uuid |
String |
Well attribute group UUID |
options |
Array |
Initial list option names for a LIST attribute; request order becomes the display order. Rejected for other types |
Response body
| Path | Type | Description |
|---|---|---|
id |
Number |
Created well attribute Id |
uuid |
String |
Created well attribute UUID |
name |
String |
Created well attribute name (trimmed, inner whitespace collapsed) |
Create well attribute list option
Create a new option of a LIST-type well attribute by well attribute UUID.
sort_order is an ordering weight, not a strict position: duplicates are allowed, options with equal weight are ordered by name (case-insensitive).
A locked attribute is rejected with 403, an attribute that is not LIST-type with 400
Request
$ curl 'https://solo.cloud/public/api/v1/wellattributes/aa6cb7bd-66af-4339-9921-79501eff3045/listoptions' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Crew C",
"sort_order" : 2
}'
POST /public/api/v1/wellattributes/aa6cb7bd-66af-4339-9921-79501eff3045/listoptions HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 43
{
"name" : "Crew C",
"sort_order" : 2
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7ad1373002fdf40c05278f8e1396680c
Content-Type: application/json
{
"id" : 4,
"uuid" : "91eab53d-3add-4d2c-bbdd-6abbe40d4b05",
"sort_order" : 2
}
POST /public/api/v1/wellattributes/{wellAttributeUuid}/listoptions
| Path parameter | Description |
|---|---|
wellAttributeUuid |
LIST-type well attribute UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
List option name, up to 200 characters, unique within the attribute (case-insensitive), a duplicate is rejected with 409 |
sort_order |
Number |
Ordering weight (non-negative integer), not a strict position: duplicates are allowed, options with equal weight are ordered by name (case-insensitive). Appended after the last option when omitted |
Response body
| Path | Type | Description |
|---|---|---|
id |
Number |
List option Id |
uuid |
String |
List option UUID |
sort_order |
Number |
Ordering weight of the created option |
Get well attribute groups
Get a list of well attribute groups
Request
$ curl 'https://solo.cloud/public/api/v1/attributegroups' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/attributegroups HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 70c3c2599de1b6a4827c5409fc545138
Content-Type: application/json
[ {
"name" : "General",
"uuid" : "caeb5bb2-18ea-4191-9c36-f2e252259371"
}, {
"name" : "Location",
"uuid" : "b7ef6059-d428-4f35-9d4a-a786ffff1d83"
}, {
"name" : "Well Status",
"uuid" : "47f0b746-16e4-4959-a722-91a03c9d3aaf"
}, {
"name" : "Dates",
"uuid" : "a7bf5d85-6294-403e-8909-1ab9fda006f4"
}, {
"name" : "Production",
"uuid" : "a5b4f651-1212-4bf2-9ec5-f279480ffdad"
}, {
"name" : "Completion",
"uuid" : "d2bde9e4-2042-48b4-a3a2-eb49146c8145"
}, {
"name" : "Development characteristics",
"uuid" : "b995079d-7f89-4054-9276-93c69b70a6f5"
} ]
GET /public/api/v1/attributegroups
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
[].name |
String |
Well attribute group name |
[].uuid |
String |
Well attribute group UUID |
Get predefined well attributes by group
Get a list of predefined well attributes by group UUID.
When the optional project_uuid query parameter is passed, options of predefined LIST-type attributes (list_options)
are resolved from that project's dictionaries and included in display order
Request
$ curl 'https://solo.cloud/public/api/v1/attributegroups/caeb5bb2-18ea-4191-9c36-f2e252259371/wellattributes?project_uuid=53f8699c-b621-4ac9-97e2-638ce45d54c9' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/attributegroups/caeb5bb2-18ea-4191-9c36-f2e252259371/wellattributes?project_uuid=53f8699c-b621-4ac9-97e2-638ce45d54c9 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7c6bc2a4a604fbb041728e84e59b312f
Content-Type: application/json
[ {
"id" : 1,
"uuid" : "00000000-0000-0000-0000-000000000001",
"name" : "Name",
"name_short" : "Name",
"type" : "VARCHAR"
}, {
"id" : 2,
"uuid" : "00000000-0000-0000-0000-000000000002",
"name" : "API",
"name_short" : "API",
"type" : "VARCHAR"
}, {
"id" : 3,
"uuid" : "00000000-0000-0000-0000-000000000003",
"name" : "Well Type",
"name_short" : "Type",
"type" : "ENUM",
"range" : [ "Horizontal", "Deviated", "Vertical", "Directional" ]
}, {
"id" : 4,
"uuid" : "00000000-0000-0000-0000-000000000004",
"name" : "Operator",
"name_short" : "OP",
"type" : "VARCHAR"
}, {
"id" : 5,
"uuid" : "00000000-0000-0000-0000-000000000005",
"name" : "Field",
"name_short" : "Field",
"type" : "VARCHAR"
}, {
"id" : 6,
"uuid" : "00000000-0000-0000-0000-000000000006",
"name" : "Basin",
"name_short" : "Basin",
"type" : "VARCHAR"
}, {
"id" : 8,
"uuid" : "00000000-0000-0000-0000-000000000008",
"name" : "Azimuth VS",
"name_short" : "Az",
"type" : "FLOAT",
"unit" : "ANGLE",
"range" : {
"client" : {
"max" : 360,
"min" : 0
}
}
}, {
"id" : 9,
"uuid" : "00000000-0000-0000-0000-000000000009",
"name" : "Convergence",
"name_short" : "Conv",
"type" : "FLOAT",
"unit" : "ANGLE",
"range" : {
"client" : {
"max" : 180,
"min" : -180
},
"server" : {
"max" : 360,
"min" : 0
}
}
}, {
"id" : 7,
"uuid" : "00000000-0000-0000-0000-000000000007",
"name" : "KB",
"name_short" : "KB",
"type" : "FLOAT",
"unit" : "DEPTH"
}, {
"id" : 60,
"uuid" : "00000000-0000-0000-0000-000000000060",
"name" : "Source",
"name_short" : "Source",
"type" : "ENUM",
"range" : [ "PN", "TGS", "Solo Data Factory" ]
}, {
"id" : 58,
"uuid" : "00000000-0000-0000-0000-000000000058",
"name" : "Well System",
"name_short" : "System",
"type" : "VARCHAR"
}, {
"id" : 59,
"uuid" : "00000000-0000-0000-0000-000000000059",
"name" : "Pad",
"name_short" : "Pad",
"type" : "VARCHAR"
}, {
"id" : 65,
"uuid" : "00000000-0000-0000-0000-000000000065",
"name" : "Rig Type",
"name_short" : "Rig Type",
"type" : "ENUM",
"range" : [ "LAND", "OFFSHORE" ]
}, {
"id" : 66,
"uuid" : "00000000-0000-0000-0000-000000000066",
"name" : "Air gap",
"name_short" : "Air gap",
"type" : "FLOAT"
}, {
"id" : 67,
"uuid" : "00000000-0000-0000-0000-000000000067",
"name" : "Ground level",
"name_short" : "Ground level",
"type" : "FLOAT"
}, {
"id" : 68,
"uuid" : "00000000-0000-0000-0000-000000000068",
"name" : "Water depth",
"name_short" : "Water depth",
"type" : "FLOAT"
}, {
"id" : 69,
"uuid" : "00000000-0000-0000-0000-000000000069",
"name" : "Magnetic sample date",
"name_short" : "Magnetic sample date",
"type" : "DATE"
}, {
"id" : 70,
"uuid" : "00000000-0000-0000-0000-000000000070",
"name" : "Magnetic model name",
"name_short" : "Magnetic model name",
"type" : "VARCHAR"
}, {
"id" : 71,
"uuid" : "00000000-0000-0000-0000-000000000071",
"name" : "Magnetic field strength",
"name_short" : "Magnetic field strength",
"type" : "FLOAT"
}, {
"id" : 72,
"uuid" : "00000000-0000-0000-0000-000000000072",
"name" : "Magnetic dip angle",
"name_short" : "Magnetic dip angle",
"type" : "FLOAT"
}, {
"id" : 73,
"uuid" : "00000000-0000-0000-0000-000000000073",
"name" : "Magnetic declination",
"name_short" : "Magnetic declination",
"type" : "FLOAT"
}, {
"id" : 74,
"uuid" : "00000000-0000-0000-0000-000000000074",
"name" : "Survey program",
"name_short" : "Survey program",
"type" : "VARCHAR"
}, {
"id" : 77,
"uuid" : "00000000-0000-0000-0000-000000000077",
"name" : "Rig",
"name_short" : "Rig",
"type" : "VARCHAR"
}, {
"id" : 78,
"uuid" : "cd2a61fa-7864-497b-bc0a-03ee2ae8b1bb",
"name" : "CONVERGENCE_AUTO",
"name_short" : "CONVERGENCE_AUTO",
"type" : "INTEGER"
} ]
GET /public/api/v1/attributegroups/{uuid}/wellattributes
| Path parameter | Description |
|---|---|
uuid |
Well attribute group UUID |
| Parameter | Description |
|---|---|
project_uuid |
Project UUID; when passed, options of predefined LIST-type attributes (list_options) are resolved from this project's dictionaries and included |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
[].name |
String |
Well attribute name |
[].name_short |
String |
Well attribute short name |
[].id |
Number |
Well attribute Id |
[].uuid |
String |
Well attribute UUID |
[].type |
String |
Well attribute type (VARCHAR, INTEGER, FLOAT, ENUM, DATE, IDENTIFIER, LIST); an IDENTIFIER attribute carries a string value unique within the project |
[].unit |
String |
Well attribute domain (POSITION, DISTANCE, DEPTH, ANGLE, VOLUME) |
[].range |
Varies |
Well attribute range: the array of allowed values for ENUM, value limits (client) for some predefined numeric attributes |
[].range.client |
Object |
Value limits to check before updating the value; angle limits are in degrees |
[].range.client.min |
Number |
Minimum value |
[].range.client.max |
Number |
Maximum value |
[].list_options |
Array |
Options of a LIST attribute in display order, present only for LIST attributes and only when the project_uuid query parameter is passed |
[].list_options[].id |
Number |
List option Id |
[].list_options[].name |
String |
List option name |
[].list_options[].sort_order |
Number |
List option ordering weight (display order: by weight, then by name) |
Get custom well attributes by group and project
Get a list of custom well attributes by group UUID and project UUID.
A LIST-type attribute is returned together with its options (list_options) in display order
Request
$ curl 'https://solo.cloud/public/api/v1/attributegroups/caeb5bb2-18ea-4191-9c36-f2e252259371/projects/53f8699c-b621-4ac9-97e2-638ce45d54c9/wellattributes' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/attributegroups/caeb5bb2-18ea-4191-9c36-f2e252259371/projects/53f8699c-b621-4ac9-97e2-638ce45d54c9/wellattributes HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 596f135f0c726e389a62dd4b332d1ab8
Content-Type: application/json
[ {
"id" : 10000,
"uuid" : "c8bf056a-9074-42d4-a02a-cd79adc971b8",
"name" : "Well attribute name",
"type" : "ENUM",
"unit" : "POSITION",
"range" : [ "Top", "Middle", "Bottom" ]
}, {
"id" : 10001,
"uuid" : "aa6cb7bd-66af-4339-9921-79501eff3045",
"name" : "Frac Crew",
"type" : "LIST",
"list_options" : [ {
"id" : 1,
"name" : "Crew A",
"sort_order" : 0
}, {
"id" : 2,
"name" : "Crew B",
"sort_order" : 1
}, {
"id" : 4,
"name" : "Crew C",
"sort_order" : 2
}, {
"id" : 5,
"name" : "Crew D updated",
"sort_order" : 10
} ]
}, {
"id" : 10002,
"uuid" : "17a562d6-b3f4-48df-9b8b-9a68fcbab1f4",
"name" : "UWI",
"type" : "IDENTIFIER"
}, {
"id" : 10005,
"uuid" : "039bc3c5-0570-4743-b9d6-1fbbcfc564d3",
"name" : "Custom attribute name",
"name_short" : "Custom attribute name",
"type" : "VARCHAR",
"unit" : "DISTANCE"
} ]
GET /public/api/v1/attributegroups/{uuid}/projects/{projectUuid}/wellattributes
| Path parameter | Description |
|---|---|
uuid |
Well attribute group UUID |
projectUuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
[].name |
String |
Well attribute name |
[].name_short |
String |
Well attribute short name |
[].id |
Number |
Well attribute Id |
[].uuid |
String |
Well attribute uuid |
[].type |
String |
Well attribute type (VARCHAR, INTEGER, FLOAT, ENUM, DATE, IDENTIFIER, LIST); an IDENTIFIER attribute carries a string value unique within the project |
[].unit |
String |
Well attribute domain (POSITION, DISTANCE, DEPTH, ANGLE, VOLUME) |
[].range |
Varies |
Well attribute range: the array of allowed values for ENUM, value limits (client) for some predefined numeric attributes |
[].range.client |
Object |
Value limits to check before updating the value; angle limits are in degrees |
[].range.client.min |
Number |
Minimum value |
[].range.client.max |
Number |
Maximum value |
[].list_options |
Array |
Options of a LIST attribute in display order; absent for other types |
[].list_options[].id |
Number |
List option Id |
[].list_options[].name |
String |
List option name |
[].list_options[].sort_order |
Number |
List option ordering weight (display order: by weight, then by name) |
Get well attribute values by lateral
Get well attribute values by lateral UUID as an object keyed by well attribute name. The KB, lateral length, final MD, final TVD and final TVDSS values are returned in project units, the azimuth VS and convergence values in degrees, X-srf and Y-srf in project units, other numeric values are returned as stored. A value of a LIST-type attribute is returned as the resolved list option object; null if the option no longer exists
Request
$ curl 'https://solo.cloud/public/api/v1/wells/701b9e97-6b49-46ff-a6de-049fcedd4273/attributevalues/v2' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/701b9e97-6b49-46ff-a6de-049fcedd4273/attributevalues/v2 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: b52e7fa8478d30b2964485a537135d8d
Content-Type: application/json
{
"Name" : {
"value" : "nameWell",
"attribute_id" : 1
},
"API" : {
"value" : "api",
"attribute_id" : 2
},
"Well Type" : {
"value" : "Deviated",
"attribute_id" : 3
},
"Operator" : {
"value" : "operator",
"attribute_id" : 4
},
"KB" : {
"value" : {
"val" : 3445.211614173228
},
"attribute_id" : 7
},
"Azimuth VS" : {
"value" : {
"val" : 114.59155902616465
},
"attribute_id" : 8
},
"Convergence" : {
"value" : {
"val" : 171.88733853924697
},
"attribute_id" : 9
},
"State (Province)" : {
"value" : "Penguin State ",
"attribute_id" : 10
},
"X-srf" : {
"value" : {
"val" : 13.123359580052492
},
"attribute_id" : 12
},
"Y-srf" : {
"value" : {
"val" : 16.404199475065617
},
"attribute_id" : 13
},
"Spud date" : {
"value" : "2023-12-18T14:16:32.001+00:00",
"attribute_id" : 17
},
"# of Stages" : {
"value" : 20,
"attribute_id" : 43
},
"Frac Fluid" : {
"value" : "X-link",
"attribute_id" : 46
},
"Final TVD" : {
"value" : {
"val" : 1.6076115485564304
},
"attribute_id" : 49
},
"Final TVDSS" : {
"value" : {
"val" : -1.6404199475065615
},
"attribute_id" : 50
},
"Formation" : {
"value" : "test51",
"attribute_id" : 51
},
"Net pay" : {
"value" : {
"val" : 52.0
},
"attribute_id" : 52
},
"Frac Crew" : {
"value" : {
"id" : 1,
"name" : "Crew A",
"sort_order" : 0
},
"attribute_id" : 10001
},
"UWI" : {
"value" : "UWI-0001",
"attribute_id" : 10002
}
}
GET /public/api/v1/wells/{uuid}/attributevalues/v2
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
.value |
Object |
Well attribute value: a string for VARCHAR, ENUM, IDENTIFIER (unique within the project) and DATE (ISO 8601 date-time), a number for INTEGER, a double value object for FLOAT, a list option object for LIST; null when the value is cleared or the list option no longer exists |
.value.val |
Number |
Value of a FLOAT attribute; KB, lateral length and final MD/TVD/TVDSS are in project units, azimuth VS and convergence in degrees |
.value.undefined |
Boolean |
true when a FLOAT value is not set |
.value.id |
Number |
Resolved list option Id (for LIST type) |
.value.name |
String |
Resolved list option name (for LIST type) |
.value.sort_order |
Number |
Resolved list option ordering weight (for LIST type) |
*.attribute_id |
Number |
Well attribute Id |
Get well attribute values by nestedwell
Get well attribute values by nested well UUID as an object keyed by well attribute name. The KB, lateral length, final MD, final TVD and final TVDSS values are returned in project units, the azimuth VS and convergence values in degrees, X-srf and Y-srf in project units, other numeric values are returned as stored. A value of a LIST-type attribute is returned as the resolved list option object; null if the option no longer exists
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/03c709fa-535c-47ce-90c3-8cc39530b685/attributevalues/v2' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/nestedwells/03c709fa-535c-47ce-90c3-8cc39530b685/attributevalues/v2 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 11bfdbd374d92e92ff02eea4f18770ff
Content-Type: application/json
{
"Name" : {
"value" : "nestedName",
"attribute_id" : 1
},
"API" : {
"value" : "nestedApi",
"attribute_id" : 2
},
"Operator" : {
"value" : "nestedOperator",
"attribute_id" : 4
},
"KB" : {
"value" : {
"val" : 328.4120734908136
},
"attribute_id" : 7
},
"Azimuth VS" : {
"value" : {
"val" : 5.729577951308232
},
"attribute_id" : 8
},
"Convergence" : {
"value" : {
"val" : 11.459155902616464
},
"attribute_id" : 9
},
"X-srf" : {
"value" : {
"val" : 103.1
},
"attribute_id" : 12
},
"Y-srf" : {
"value" : {
"val" : 104.1
},
"attribute_id" : 13
}
}
GET /public/api/v1/nestedwells/{uuid}/attributevalues/v2
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
.value |
Object |
Well attribute value: a string for VARCHAR, ENUM, IDENTIFIER (unique within the project) and DATE (ISO 8601 date-time), a number for INTEGER, a double value object for FLOAT, a list option object for LIST; null when the value is cleared or the list option no longer exists |
.value.val |
Number |
Value of a FLOAT attribute; KB, lateral length and final MD/TVD/TVDSS are in project units, azimuth VS and convergence in degrees |
.value.undefined |
Boolean |
true when a FLOAT value is not set |
.value.id |
Number |
Resolved list option Id (for LIST type) |
.value.name |
String |
Resolved list option name (for LIST type) |
.value.sort_order |
Number |
Resolved list option ordering weight (for LIST type) |
*.attribute_id |
Number |
Well attribute Id |
Get well attribute values by typewell
Get well attribute values by typewell UUID as an object keyed by well attribute name. The KB, lateral length, final MD, final TVD and final TVDSS values are returned in project units, the azimuth VS and convergence values in degrees, X-srf and Y-srf in project units, other numeric values are returned as stored. A value of a LIST-type attribute is returned as the resolved list option object; null if the option no longer exists
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/72a3eb23-be84-4910-ab14-69aac23cb75e/attributevalues/v2' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/72a3eb23-be84-4910-ab14-69aac23cb75e/attributevalues/v2 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9afed26a62a20fe43ea89476c8be890a
Content-Type: application/json
{
"Name" : {
"value" : "nameWell",
"attribute_id" : 1
},
"API" : {
"value" : "api",
"attribute_id" : 2
},
"Well Type" : {
"value" : "Deviated",
"attribute_id" : 3
},
"Operator" : {
"value" : "operator",
"attribute_id" : 4
},
"KB" : {
"value" : {
"val" : 3.280839895013123
},
"attribute_id" : 7
},
"Azimuth VS" : {
"value" : {
"val" : 114.59155902616465
},
"attribute_id" : 8
},
"Convergence" : {
"value" : {
"val" : 171.88733853924697
},
"attribute_id" : 9
},
"X-srf" : {
"value" : {
"val" : 13.123359580052492
},
"attribute_id" : 12
},
"Y-srf" : {
"value" : {
"val" : 16.404199475065617
},
"attribute_id" : 13
},
"Spud date" : {
"value" : "2022-11-17T13:15:31.000+00:00",
"attribute_id" : 17
},
"# of Stages" : {
"value" : 43,
"attribute_id" : 43
},
"Final TVD" : {
"value" : {
"val" : 1.6076115485564304
},
"attribute_id" : 49
},
"Final TVDSS" : {
"value" : {
"val" : -1.6404199475065615
},
"attribute_id" : 50
},
"Formation" : {
"value" : "test51",
"attribute_id" : 51
},
"Net pay" : {
"value" : {
"val" : 52.0
},
"attribute_id" : 52
}
}
GET /public/api/v1/typewells/{uuid}/attributevalues/v2
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
.value |
Object |
Well attribute value: a string for VARCHAR, ENUM, IDENTIFIER (unique within the project) and DATE (ISO 8601 date-time), a number for INTEGER, a double value object for FLOAT, a list option object for LIST; null when the value is cleared or the list option no longer exists |
.value.val |
Number |
Value of a FLOAT attribute; KB, lateral length and final MD/TVD/TVDSS are in project units, azimuth VS and convergence in degrees |
.value.undefined |
Boolean |
true when a FLOAT value is not set |
.value.id |
Number |
Resolved list option Id (for LIST type) |
.value.name |
String |
Resolved list option name (for LIST type) |
.value.sort_order |
Number |
Resolved list option ordering weight (for LIST type) |
*.attribute_id |
Number |
Well attribute Id |
Update custom well attribute
Update custom well attribute by UUID. At least one field must be present, an absent field keeps its current value. A locked attribute is rejected with 403
Request
$ curl 'https://solo.cloud/public/api/v1/wellattributes/741519f9-b8e0-4e4f-b93b-52941d1dd387' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Updated well attribute name",
"name_short" : "New short name",
"group_uuid" : "b7ef6059-d428-4f35-9d4a-a786ffff1d83"
}'
PATCH /public/api/v1/wellattributes/741519f9-b8e0-4e4f-b93b-52941d1dd387 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 136
{
"name" : "Updated well attribute name",
"name_short" : "New short name",
"group_uuid" : "b7ef6059-d428-4f35-9d4a-a786ffff1d83"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 095e07732cd8145f80801ea51b586e89
PATCH /public/api/v1/wellattributes/{wellAttributeUuid}
| Path parameter | Description |
|---|---|
wellAttributeUuid |
Well attribute UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
New well attribute name, unique (case-insensitive) among the project's custom and the predefined attributes |
name_short |
String |
New well attribute short name |
group_uuid |
String |
Well attribute group UUID to place the attribute in |
Response body
Empty body
Update well attribute list option
Update a list option of a LIST-type well attribute by well attribute UUID and option Id.
Both fields are optional, but at least one must be present; an absent field keeps its current value.
sort_order is an ordering weight, not a strict position: duplicates are allowed, options with equal weight are ordered by name (case-insensitive).
A locked attribute is rejected with 403, an attribute that is not LIST-type with 400. An option Id that does not exist returns 400 with type NOT_FOUND
Request
$ curl 'https://solo.cloud/public/api/v1/wellattributes/aa6cb7bd-66af-4339-9921-79501eff3045/listoptions/5' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Crew D updated",
"sort_order" : 10
}'
PATCH /public/api/v1/wellattributes/aa6cb7bd-66af-4339-9921-79501eff3045/listoptions/5 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 52
{
"name" : "Crew D updated",
"sort_order" : 10
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: b688a79b898b84efd38742869cb10c5d
PATCH /public/api/v1/wellattributes/{wellAttributeUuid}/listoptions/{optionId}
| Path parameter | Description |
|---|---|
wellAttributeUuid |
LIST-type well attribute UUID |
optionId |
List option Id |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
New list option name, up to 200 characters, unique within the attribute (case-insensitive), a duplicate is rejected with 409 |
sort_order |
Number |
New ordering weight (non-negative integer): duplicates are allowed, options with equal weight are ordered by name (case-insensitive) |
Response body
Empty body
Update well attribute values by lateral
Update well attribute values by lateral UUID. Only the listed attributes are changed, the values of locked attributes are ignored. Returns 403 if the lateral is locked or is a private lateral of another user.
The values to be changed must be pre-checked for validity using the range constraints returned by Get predefined well attributes by group and Get custom well attributes by group and project (if applicable).
This path takes the KB, lateral length, final MD, final TVD and final TVDSS values in meters and the azimuth VS and convergence values in radians, without conversion, /wells/{uuid}/attributevalues/v2 takes them in project units and degrees, as returned by Get well attribute values by lateral. Other values are stored as submitted. For this path compare the azimuth VS and convergence values with the range limits converted to radians.
For a LIST-type attribute pass the Id of one of the attribute's list options as the value; null clears the value.
An unknown attribute_id, a LIST value that is not an Id of the attribute's options, a negative KB, lateral length, final MD or final TVD, and an azimuth VS outside [0; 360] degrees or a convergence outside [-180; 180] degrees (radians on this path) are rejected with 406. A value whose JSON type does not match the attribute type is rejected with 400.
For an IDENTIFIER-type attribute the value must be unique within the project (case-insensitive, leading/trailing spaces ignored; laterals and typewells share one uniqueness scope): a duplicate is rejected with 409 (NOT_ACCEPTED), null clears the value and releases it
Request
$ curl 'https://solo.cloud/public/api/v1/wells/701b9e97-6b49-46ff-a6de-049fcedd4273/attributevalues' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '[ {
"value" : "Penguin State ",
"attribute_id" : 10
}, {
"value" : {
"val" : 1050.1005
},
"attribute_id" : 7
}, {
"value" : 20,
"attribute_id" : 43
}, {
"value" : "2023-12-18T14:16:32.001+00:00",
"attribute_id" : 17
}, {
"value" : "X-link",
"attribute_id" : 46
} ]'
PATCH /public/api/v1/wells/701b9e97-6b49-46ff-a6de-049fcedd4273/attributevalues HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 290
[ {
"value" : "Penguin State ",
"attribute_id" : 10
}, {
"value" : {
"val" : 1050.1005
},
"attribute_id" : 7
}, {
"value" : 20,
"attribute_id" : 43
}, {
"value" : "2023-12-18T14:16:32.001+00:00",
"attribute_id" : 17
}, {
"value" : "X-link",
"attribute_id" : 46
} ]
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5b2ce8eab1d1ff44a2720925c856ce48
PATCH /public/api/v1/wells/{uuid}/attributevalues
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
[].attribute_id |
Number |
Well attribute Id; attributes that are not listed keep their values |
[].value |
Varies |
New value: a string for VARCHAR, ENUM and IDENTIFIER, an ISO 8601 date-time string for DATE, an integer for INTEGER, a double value object for FLOAT, a list option Id for LIST; null clears the value |
[].value.val |
Number |
Value of a FLOAT attribute; on this path KB, lateral length and final MD/TVD/TVDSS are in meters, azimuth VS and convergence in radians |
[].value.undefined |
Boolean |
Set to true to store an undefined FLOAT value |
Response body
Empty body
Update well attribute values by typewell
Update well attribute values by typewell UUID. Only the listed attributes are changed, the values of locked attributes are ignored. Returns 403 if the typewell is locked or is a private typewell of another user.
The values to be changed must be pre-checked for validity using the range constraints returned by Get predefined well attributes by group and Get custom well attributes by group and project (if applicable).
This path takes the KB, lateral length, final MD, final TVD and final TVDSS values in meters and the azimuth VS and convergence values in radians, without conversion, /typewells/{uuid}/attributevalues/v2 takes them in project units and degrees, as returned by Get well attribute values by typewell. Other values are stored as submitted. For this path compare the azimuth VS and convergence values with the range limits converted to radians.
For a LIST-type attribute pass the Id of one of the attribute's list options as the value; null clears the value.
An unknown attribute_id, a LIST value that is not an Id of the attribute's options, a negative KB, lateral length, final MD or final TVD, and an azimuth VS outside [0; 360] degrees or a convergence outside [-180; 180] degrees (radians on this path) are rejected with 406. A value whose JSON type does not match the attribute type is rejected with 400.
For an IDENTIFIER-type attribute the value must be unique within the project (case-insensitive, leading/trailing spaces ignored; laterals and typewells share one uniqueness scope): a duplicate is rejected with 409 (NOT_ACCEPTED), null clears the value and releases it
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/72a3eb23-be84-4910-ab14-69aac23cb75e/attributevalues' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '[ {
"value" : "Penguin State ",
"attribute_id" : 10
}, {
"value" : {
"val" : 1050.1005
},
"attribute_id" : 7
}, {
"value" : 20,
"attribute_id" : 43
}, {
"value" : "2023-12-18T14:16:32.001+00:00",
"attribute_id" : 17
}, {
"value" : "X-link",
"attribute_id" : 46
} ]'
PATCH /public/api/v1/typewells/72a3eb23-be84-4910-ab14-69aac23cb75e/attributevalues HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 290
[ {
"value" : "Penguin State ",
"attribute_id" : 10
}, {
"value" : {
"val" : 1050.1005
},
"attribute_id" : 7
}, {
"value" : 20,
"attribute_id" : 43
}, {
"value" : "2023-12-18T14:16:32.001+00:00",
"attribute_id" : 17
}, {
"value" : "X-link",
"attribute_id" : 46
} ]
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 98ccf0eda6887144081cf0419a6b5da7
PATCH /public/api/v1/typewells/{uuid}/attributevalues
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
[].attribute_id |
Number |
Well attribute Id; attributes that are not listed keep their values |
[].value |
Varies |
New value: a string for VARCHAR, ENUM and IDENTIFIER, an ISO 8601 date-time string for DATE, an integer for INTEGER, a double value object for FLOAT, a list option Id for LIST; null clears the value |
[].value.val |
Number |
Value of a FLOAT attribute; on this path KB, lateral length and final MD/TVD/TVDSS are in meters, azimuth VS and convergence in radians |
[].value.undefined |
Boolean |
Set to true to store an undefined FLOAT value |
Response body
Empty body
Delete custom well attribute
Delete custom well attribute by UUID. Its values are no longer returned for wells. A locked attribute is rejected with 403
Request
$ curl 'https://solo.cloud/public/api/v1/wellattributes/e101b2f0-e5b0-4b1b-9a1c-ecd42879f6e0' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/wellattributes/e101b2f0-e5b0-4b1b-9a1c-ecd42879f6e0 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3e91aad36d519e174dfbffcc1fdb039a
DELETE /public/api/v1/wellattributes/{wellAttributeUuid}
| Path parameter | Description |
|---|---|
wellAttributeUuid |
Well attribute UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Delete well attribute list option
Delete a list option of a LIST-type well attribute by well attribute UUID and option Id.
Well attribute values that reference the deleted option are returned as null.
A locked attribute is rejected with 403, an attribute that is not LIST-type with 400. An option Id that does not exist returns 400 with type NOT_FOUND
Request
$ curl 'https://solo.cloud/public/api/v1/wellattributes/aa6cb7bd-66af-4339-9921-79501eff3045/listoptions/3' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/wellattributes/aa6cb7bd-66af-4339-9921-79501eff3045/listoptions/3 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 569d11e2d563da7778c4343b8b04a77a
DELETE /public/api/v1/wellattributes/{wellAttributeUuid}/listoptions/{optionId}
| Path parameter | Description |
|---|---|
wellAttributeUuid |
LIST-type well attribute UUID |
optionId |
List option Id |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
16. Grids
Create grid
Create an empty grid by project UUID (a virtual project UUID is also accepted). The grid is not listed by Get grids by project until its data is uploaded. A grid created with a virtual project UUID belongs to the global project and is added to the virtual project only if its first data upload is made with Upload grid data to VP
Request
$ curl 'https://solo.cloud/public/api/v1/projects/ae09b3cd-2220-4f64-ad7e-24aefebf28f7/grids' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Grid name"
}'
POST /public/api/v1/projects/ae09b3cd-2220-4f64-ad7e-24aefebf28f7/grids HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 26
{
"name" : "Grid name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5f0ecff8268159a7f5d1ef5fc3d9e729
Content-Type: application/json
{
"uuid" : "3c7804ab-25ef-4930-b785-86532e441539"
}
POST /public/api/v1/projects/{uuid}/grids
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Grid name. Must not be blank, up to 200 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created grid UUID |
Get grids by project
Get a list of grids by project UUID with pagination, sorted by name. For a virtual project UUID, only grids of the virtual project are returned. Grids that do not contain data will not be included in the response
Request
$ curl 'https://solo.cloud/public/api/v1/projects/ae09b3cd-2220-4f64-ad7e-24aefebf28f7/grids?offset=0&limit=10&filter=oNe' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/ae09b3cd-2220-4f64-ad7e-24aefebf28f7/grids?offset=0&limit=10&filter=oNe HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 432678458ff15084f3038a77d5abb4e5
Content-Type: application/json
{
"content" : [ {
"name" : "Grid one",
"uuid" : "c74c262b-4759-4ee2-8229-17eb74f88aa9"
}, {
"name" : "One more grid",
"uuid" : "cc233de1-a6d7-4fc4-8687-79d933650662"
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/grids
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the grids whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Grid UUID |
content[].name |
String |
Grid name |
Get grid metadata
Get grid metadata by UUID. Coordinates and steps are in project units, the angle is in degrees. Returns 404 if the grid has no data
Request
$ curl 'https://solo.cloud/public/api/v1/grids/22566b34-2e23-4df7-a85f-de6102916300/metadata' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/grids/22566b34-2e23-4df7-a85f-de6102916300/metadata HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: ba97e339d039ba19d107dca977063301
Content-Type: application/json
{
"start_x" : 1761026.4432000222,
"start_y" : 508018.38319997117,
"step_x" : 50.00000000089999,
"step_y" : 50.000899999999994,
"angle" : 3.4377511537473244E-4,
"columns" : 10,
"rows" : 5
}
GET /public/api/v1/grids/{uuid}/metadata
| Path parameter | Description |
|---|---|
uuid |
Grid UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
start_x |
Number |
X coordinate of the grid origin in project units |
start_y |
Number |
Y coordinate of the grid origin in project units |
step_x |
Number |
Grid X-axis step in project units |
step_y |
Number |
Grid Y-axis step in project units |
angle |
Number |
Grid rotation angle (degrees) |
columns |
Number |
Number of grid columns (values in each row) |
rows |
Number |
Number of grid rows |
Get grid data
Get grid metadata and values by UUID. data contains rows rows numbered from 1, each with columns values. Grid values are returned as stored, without unit conversion. Returns 404 if the grid has no data
Request
$ curl 'https://solo.cloud/public/api/v1/grids/22566b34-2e23-4df7-a85f-de6102916300/data' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/grids/22566b34-2e23-4df7-a85f-de6102916300/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 98607fcde0f291c62fba282ebf9d92cb
Content-Type: application/json
{
"metadata" : {
"start_x" : 1761026.4432000222,
"start_y" : 508018.38319997117,
"step_x" : 50.00000000089999,
"step_y" : 50.000899999999994,
"angle" : 3.4377511537473244E-4,
"columns" : 10,
"rows" : 5
},
"data" : [ {
"row_number" : 1,
"values" : [ -4004.1541, -4005.4883, -4006.1639, -4004.9126, -4003.3309, -4001.4009, -3998.938, -3996.5938, -3994.3135, -3991.4742 ]
}, {
"row_number" : 2,
"values" : [ -4006.5755, -4007.4856, -4008.077, -4006.9102, -4005.2642, -4002.824, -4000.285, -3998.0855, -3996.1604, -3993.5733 ]
}, {
"row_number" : 3,
"values" : [ -4009.1927, -4010.4065, -4011.1248, -4009.6104, -4007.5018, -4004.8636, -4002.7835, -4000.7776, -3998.6927, -3994.7417 ]
}, {
"row_number" : 4,
"values" : [ -4012.2437, -4013.699, -4014.2129, -4012.1336, -4009.8895, -4007.2583, -4005.5298, -4003.5118, -3999.9412, -3995.8165 ]
}, {
"row_number" : 5,
"values" : [ -4016.2227, -4016.9622, -4016.6907, -4014.7264, -4012.2242, -4009.7496, -4008.4166, -4005.1592, -4001.252, -3996.7496 ]
} ]
}
GET /public/api/v1/grids/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Grid UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
metadata.start_x |
Number |
X coordinate of the grid origin in project units |
metadata.start_y |
Number |
Y coordinate of the grid origin in project units |
metadata.step_x |
Number |
Grid X-axis step in project units |
metadata.step_y |
Number |
Grid Y-axis step in project units |
metadata.angle |
Number |
Grid rotation angle (degrees) |
metadata.columns |
Number |
Number of grid columns (values in each row) |
metadata.rows |
Number |
Number of grid rows |
data |
Array |
Grid rows in row_number order |
data[].row_number |
Number |
Row number, starting from 1 |
data[].values |
Array |
Row values, one per column. Returned as stored, without unit conversion |
Upload grid data to GP
Upload grid data by grid UUID, replacing the existing grid data. metadata must be the first field of the body and data the second one. The grid must have at least 5 rows, 5 columns and 50 nodes, data must contain exactly rows rows numbered 1, 2, ... in order, each with exactly columns values. A body that breaks these rules or cannot be read, including a row without values, is rejected with 406 (INVALID_REQUEST_BODY_FORMAT). If the data cannot be saved, the error status of the Solo data service is returned (type INVALID_REQUEST). Coordinates and steps are in project units, the angle is in degrees, grid values are stored without unit conversion. Requires the Update permission in the global project
Request
$ curl 'https://solo.cloud/public/api/v1/grids/22566b34-2e23-4df7-a85f-de6102916300/data' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"metadata" : {
"start_x" : 111.5,
"start_y" : 555.1,
"step_x" : 10,
"step_y" : 20,
"angle" : 120,
"columns" : 10,
"rows" : 5
},
"data" : [ {
"row_number" : 1,
"values" : [ -4004.1541, -4005.4883, -4006.1639, -4004.9126, -4003.3309, -4001.4009, -3998.938, -3996.5938, -3994.3135, -3991.4742 ]
}, {
"row_number" : 2,
"values" : [ -4006.5755, -4007.4856, -4008.077, -4006.9102, -4005.2642, -4002.824, -4000.285, -3998.0855, -3996.1604, -3993.5733 ]
}, {
"row_number" : 3,
"values" : [ -4009.1927, -4010.4065, -4011.1248, -4009.6104, -4007.5018, -4004.8636, -4002.7835, -4000.7776, -3998.6927, -3994.7417 ]
}, {
"row_number" : 4,
"values" : [ -4012.2437, -4013.699, -4014.2129, -4012.1336, -4009.8895, -4007.2583, -4005.5298, -4003.5118, -3999.9412, -3995.8165 ]
}, {
"row_number" : 5,
"values" : [ -4016.2227, -4016.9622, -4016.6907, -4014.7264, -4012.2242, -4009.7496, -4008.4166, -4005.1592, -4001.252, -3996.7496 ]
} ]
}'
PUT /public/api/v1/grids/22566b34-2e23-4df7-a85f-de6102916300/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 1006
{
"metadata" : {
"start_x" : 111.5,
"start_y" : 555.1,
"step_x" : 10,
"step_y" : 20,
"angle" : 120,
"columns" : 10,
"rows" : 5
},
"data" : [ {
"row_number" : 1,
"values" : [ -4004.1541, -4005.4883, -4006.1639, -4004.9126, -4003.3309, -4001.4009, -3998.938, -3996.5938, -3994.3135, -3991.4742 ]
}, {
"row_number" : 2,
"values" : [ -4006.5755, -4007.4856, -4008.077, -4006.9102, -4005.2642, -4002.824, -4000.285, -3998.0855, -3996.1604, -3993.5733 ]
}, {
"row_number" : 3,
"values" : [ -4009.1927, -4010.4065, -4011.1248, -4009.6104, -4007.5018, -4004.8636, -4002.7835, -4000.7776, -3998.6927, -3994.7417 ]
}, {
"row_number" : 4,
"values" : [ -4012.2437, -4013.699, -4014.2129, -4012.1336, -4009.8895, -4007.2583, -4005.5298, -4003.5118, -3999.9412, -3995.8165 ]
}, {
"row_number" : 5,
"values" : [ -4016.2227, -4016.9622, -4016.6907, -4014.7264, -4012.2242, -4009.7496, -4008.4166, -4005.1592, -4001.252, -3996.7496 ]
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9b91352ccad0fd386a8999c29e963dd6
PUT /public/api/v1/grids/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Grid UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
metadata.start_x |
Number |
X coordinate of the grid origin in project units |
metadata.start_y |
Number |
Y coordinate of the grid origin in project units |
metadata.step_x |
Number |
Grid X-axis step in project units |
metadata.step_y |
Number |
Grid Y-axis step in project units |
metadata.angle |
Number |
Grid rotation angle in degrees, range [-180; 180] |
metadata.columns |
Number |
Number of grid columns (values in each row), at least 5 |
metadata.rows |
Number |
Number of grid rows, at least 5. rows * columns must be at least 50 |
data |
Array |
Grid rows, exactly rows elements. Must follow metadata in the body |
data[].row_number |
Number |
Row number. Rows must go in order 1, 2, ..., rows |
data[].values |
Array |
Row values, exactly columns numbers. Stored as is, without unit conversion |
Response body
Empty body
Upload grid data to VP
Upload grid data by grid UUID and virtual project UUID, with the same body and rules as Upload grid data to GP. The grid must belong to the global project of the virtual project, otherwise 400 is returned. The Update permission is checked in the virtual project. Grid data is shared, so the upload replaces the data seen in the global project and in all its virtual projects. If the grid had no data before, it is also added to the given virtual project
Request
$ curl 'https://solo.cloud/public/api/v1/projects/c6db4581-bab8-4c50-a8ec-586a896deca6/grids/cc233de1-a6d7-4fc4-8687-79d933650662/data' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"metadata" : {
"start_x" : 111.5,
"start_y" : 555.1,
"step_x" : 10,
"step_y" : 20,
"angle" : 120,
"columns" : 10,
"rows" : 5
},
"data" : [ {
"row_number" : 1,
"values" : [ -4004.1541, -4005.4883, -4006.1639, -4004.9126, -4003.3309, -4001.4009, -3998.938, -3996.5938, -3994.3135, -3991.4742 ]
}, {
"row_number" : 2,
"values" : [ -4006.5755, -4007.4856, -4008.077, -4006.9102, -4005.2642, -4002.824, -4000.285, -3998.0855, -3996.1604, -3993.5733 ]
}, {
"row_number" : 3,
"values" : [ -4009.1927, -4010.4065, -4011.1248, -4009.6104, -4007.5018, -4004.8636, -4002.7835, -4000.7776, -3998.6927, -3994.7417 ]
}, {
"row_number" : 4,
"values" : [ -4012.2437, -4013.699, -4014.2129, -4012.1336, -4009.8895, -4007.2583, -4005.5298, -4003.5118, -3999.9412, -3995.8165 ]
}, {
"row_number" : 5,
"values" : [ -4016.2227, -4016.9622, -4016.6907, -4014.7264, -4012.2242, -4009.7496, -4008.4166, -4005.1592, -4001.252, -3996.7496 ]
} ]
}'
PUT /public/api/v1/projects/c6db4581-bab8-4c50-a8ec-586a896deca6/grids/cc233de1-a6d7-4fc4-8687-79d933650662/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 1006
{
"metadata" : {
"start_x" : 111.5,
"start_y" : 555.1,
"step_x" : 10,
"step_y" : 20,
"angle" : 120,
"columns" : 10,
"rows" : 5
},
"data" : [ {
"row_number" : 1,
"values" : [ -4004.1541, -4005.4883, -4006.1639, -4004.9126, -4003.3309, -4001.4009, -3998.938, -3996.5938, -3994.3135, -3991.4742 ]
}, {
"row_number" : 2,
"values" : [ -4006.5755, -4007.4856, -4008.077, -4006.9102, -4005.2642, -4002.824, -4000.285, -3998.0855, -3996.1604, -3993.5733 ]
}, {
"row_number" : 3,
"values" : [ -4009.1927, -4010.4065, -4011.1248, -4009.6104, -4007.5018, -4004.8636, -4002.7835, -4000.7776, -3998.6927, -3994.7417 ]
}, {
"row_number" : 4,
"values" : [ -4012.2437, -4013.699, -4014.2129, -4012.1336, -4009.8895, -4007.2583, -4005.5298, -4003.5118, -3999.9412, -3995.8165 ]
}, {
"row_number" : 5,
"values" : [ -4016.2227, -4016.9622, -4016.6907, -4014.7264, -4012.2242, -4009.7496, -4008.4166, -4005.1592, -4001.252, -3996.7496 ]
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9eff68e3baeae71e523a1c8962b02ed8
PUT /public/api/v1/projects/{projectUuid}/grids/{gridUuid}/data
| Path parameter | Description |
|---|---|
projectUuid |
Virtual project UUID |
gridUuid |
UUID of a grid of the global project of the virtual project |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
metadata.start_x |
Number |
X coordinate of the grid origin in project units |
metadata.start_y |
Number |
Y coordinate of the grid origin in project units |
metadata.step_x |
Number |
Grid X-axis step in project units |
metadata.step_y |
Number |
Grid Y-axis step in project units |
metadata.angle |
Number |
Grid rotation angle in degrees, range [-180; 180] |
metadata.columns |
Number |
Number of grid columns (values in each row), at least 5 |
metadata.rows |
Number |
Number of grid rows, at least 5. rows * columns must be at least 50 |
data |
Array |
Grid rows, exactly rows elements. Must follow metadata in the body |
data[].row_number |
Number |
Row number. Rows must go in order 1, 2, ..., rows |
data[].values |
Array |
Row values, exactly columns numbers. Stored as is, without unit conversion |
Response body
Empty body
17. Polygons
Create polygon
Create an empty polygon by project UUID (a virtual project UUID is also accepted). The polygon is not listed by Get polygons by project until its data is uploaded. A polygon created with a virtual project UUID belongs to the global project and is added to the virtual project only if its first data upload is made with Upload polygon data to VP. Returns 409 if the polygon cannot be saved
Request
$ curl 'https://solo.cloud/public/api/v1/projects/eaea4727-fa7a-4172-b844-66f0283998fc/polygons' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Polygon name"
}'
POST /public/api/v1/projects/eaea4727-fa7a-4172-b844-66f0283998fc/polygons HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 29
{
"name" : "Polygon name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: b4f6d457bd9b12d42efff84763e6a1d3
Content-Type: application/json
{
"uuid" : "0a15f9bd-c78d-4afb-b834-ac93860fc7eb"
}
POST /public/api/v1/projects/{uuid}/polygons
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Polygon name. Must not be blank, up to 200 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created polygon UUID |
Get polygons by project
Get a list of polygons by project UUID with pagination, sorted by name. For a virtual project UUID, only polygons of the virtual project are returned. Polygons that do not contain data will not be included in the response
Request
$ curl 'https://solo.cloud/public/api/v1/projects/eaea4727-fa7a-4172-b844-66f0283998fc/polygons?offset=0&limit=10&filter=oNe' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/eaea4727-fa7a-4172-b844-66f0283998fc/polygons?offset=0&limit=10&filter=oNe HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: ac3f6026c829152a2e8a9025f3b16900
Content-Type: application/json
{
"content" : [ {
"name" : "One more polygon",
"uuid" : "399dafa9-c36d-4ad4-888d-2606e03314bc"
}, {
"name" : "Polygon one",
"uuid" : "02a4b527-f654-4ae2-aa6a-17343513f07c"
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/polygons
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the polygons whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Polygon UUID |
content[].name |
String |
Polygon name |
Get polygon data
Get the polylines of a polygon by UUID. Coordinates are in project units. Returns 404 if the polygon has no data
Request
$ curl 'https://solo.cloud/public/api/v1/polygons/3b8b0ca0-93ee-40b4-9783-e067bd5cc185/data' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/polygons/3b8b0ca0-93ee-40b4-9783-e067bd5cc185/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 19a71965b3010c39c1a1d2c8ea6b3bd5
Content-Type: application/json
[ {
"label" : "",
"points_count" : 24,
"xyz_points" : [ {
"x" : 1791071.9272422243,
"y" : 2.505124146981627E7,
"z" : 1.6404199507874015E8
}, {
"x" : 1789698.1627296587,
"y" : 2.505965649606299E7,
"z" : -1.6404199507874015E8
}, {
"x" : 1795150.2624671916,
"y" : 2.504813877952756E7,
"z" : -5389.763779527559
}, {
"x" : 1796545.93175853,
"y" : 2.5044033464566927E7,
"z" : -5406.496062992126
}, {
"x" : 1790436.0236220472,
"y" : 2.50544937664042E7,
"z" : -5390.419947506562
}, {
"x" : 1798453.7401574801,
"y" : 2.5044123031496063E7,
"z" : -5395.997375328084
}, {
"x" : 1788395.9973753279,
"y" : 2.505090649606299E7,
"z" : -5406.824146981627
}, {
"x" : 1794440.6167979,
"y" : 2.5046503280839894E7,
"z" : -5392.716535433071
}, {
"x" : 1786367.4540682416,
"y" : 2.5062931430446193E7,
"z" : -5452.755905511811
}, {
"x" : 1788224.7375328084,
"y" : 2.5057265748031493E7,
"z" : -5404.85564304462
}, {
"x" : 1789879.2650918632,
"y" : 2.50643156167979E7,
"z" : -5464.238845144357
}, {
"x" : 1796062.6640419948,
"y" : 2.5055903871391077E7,
"z" : -5512.795275590551
}, {
"x" : 1789700.1312335955,
"y" : 2.5059661089238845E7,
"z" : -5548.884514435695
}, {
"x" : 1796443.2414698163,
"y" : 2.5047924212598424E7,
"z" : -5404.199475065617
}, {
"x" : 1782251.968503937,
"y" : 2.505876902887139E7,
"z" : -5779.85564304462
}, {
"x" : 1793879.2650918635,
"y" : 2.5047021325459316E7,
"z" : -5394.028871391076
}, {
"x" : 1795888.1233595798,
"y" : 2.5046238845144354E7,
"z" : -5369.422572178477
}, {
"x" : 1794775.2624671916,
"y" : 2.5049992782152228E7,
"z" : -5404.527559055117
}, {
"x" : 1793214.2388451442,
"y" : 2.5048931102362204E7,
"z" : -5332.677165354331
}, {
"x" : 1797323.490813648,
"y" : 2.5047011811023623E7,
"z" : -5422.900262467192
}, {
"x" : 1789103.3464566926,
"y" : 2.505270866141732E7,
"z" : -5341.535433070866
}, {
"x" : 1788217.847769029,
"y" : 2.505421062992126E7,
"z" : -5350.0656167979005
}, {
"x" : 1789805.4461942255,
"y" : 2.5062502952755906E7,
"z" : -5399.278215223097
}, {
"x" : 1788417.3228346454,
"y" : 2.5061791994750656E7,
"z" : -5383.202099737532
} ]
} ]
GET /public/api/v1/polygons/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Polygon UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
[].label |
String |
Polyline label, an empty string if the label is not set |
[].points_count |
Number |
Number of points in the polyline |
[].xyz_points |
Array |
Polyline XYZ points |
[].xyz_points[].x |
Number |
Point X coordinate (project units) |
[].xyz_points[].y |
Number |
Point Y coordinate (project units) |
[].xyz_points[].z |
Number |
Point Z coordinate (project depth units) |
Upload polygon data to GP
Upload polygon data by polygon UUID, replacing all polylines of the polygon. The body is an array of polylines, a polyline with an empty xyz_points array is skipped. An unreadable body, for example a polyline without xyz_points, is rejected with 406. If the data cannot be saved, the error status of the Solo data service is returned (type INVALID_REQUEST). Coordinates are in project units. Requires the Update permission in the global project
Request
$ curl 'https://solo.cloud/public/api/v1/polygons/3b8b0ca0-93ee-40b4-9783-e067bd5cc185/data' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '[ {
"label" : "polyline1",
"xyz_points" : [ {
"x" : 178821.8,
"y" : 250542.6,
"z" : -5350.0
}, {
"x" : 178980.4,
"y" : 250625.7,
"z" : -5399.2
}, {
"x" : 178841.3,
"y" : 250617.9,
"z" : -5383.5
} ]
}, {
"xyz_points" : [ {
"x" : 17.0,
"y" : 25.0,
"z" : -53.1
}, {
"x" : 11.0,
"y" : 225.7,
"z" : -154.0
} ]
} ]'
PUT /public/api/v1/polygons/3b8b0ca0-93ee-40b4-9783-e067bd5cc185/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 384
[ {
"label" : "polyline1",
"xyz_points" : [ {
"x" : 178821.8,
"y" : 250542.6,
"z" : -5350.0
}, {
"x" : 178980.4,
"y" : 250625.7,
"z" : -5399.2
}, {
"x" : 178841.3,
"y" : 250617.9,
"z" : -5383.5
} ]
}, {
"xyz_points" : [ {
"x" : 17.0,
"y" : 25.0,
"z" : -53.1
}, {
"x" : 11.0,
"y" : 225.7,
"z" : -154.0
} ]
} ]
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 60ee9789ff31a1c7126ca0c16169beab
PUT /public/api/v1/polygons/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Polygon UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
[].label |
String |
Polyline label |
[].xyz_points |
Array |
Polyline XYZ points. A polyline with an empty array is skipped |
[].xyz_points[].x |
Number |
Point X coordinate (project units) |
[].xyz_points[].y |
Number |
Point Y coordinate (project units) |
[].xyz_points[].z |
Number |
Point Z coordinate (project depth units) |
Response body
Empty body
Upload polygon data to VP
Upload polygon data by polygon UUID and virtual project UUID, with the same body and rules as Upload polygon data to GP. The polygon must belong to the global project of the virtual project, otherwise 400 is returned. The Update permission is checked in the virtual project. Polygon data is shared, so the upload replaces the data seen in the global project and in all its virtual projects. If the polygon had no data before, it is also added to the given virtual project
Request
$ curl 'https://solo.cloud/public/api/v1/projects/900018b5-d5ca-4c01-8679-40b774084aab/polygons/399dafa9-c36d-4ad4-888d-2606e03314bc/data' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '[ {
"label" : "polyline1",
"xyz_points" : [ {
"x" : 178821.8,
"y" : 250542.6,
"z" : -5350.0
}, {
"x" : 178980.4,
"y" : 250625.7,
"z" : -5399.2
}, {
"x" : 178841.3,
"y" : 250617.9,
"z" : -5383.5
} ]
}, {
"xyz_points" : [ {
"x" : 17.0,
"y" : 25.0,
"z" : -53.1
}, {
"x" : 11.0,
"y" : 225.7,
"z" : -154.0
} ]
} ]'
PUT /public/api/v1/projects/900018b5-d5ca-4c01-8679-40b774084aab/polygons/399dafa9-c36d-4ad4-888d-2606e03314bc/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 384
[ {
"label" : "polyline1",
"xyz_points" : [ {
"x" : 178821.8,
"y" : 250542.6,
"z" : -5350.0
}, {
"x" : 178980.4,
"y" : 250625.7,
"z" : -5399.2
}, {
"x" : 178841.3,
"y" : 250617.9,
"z" : -5383.5
} ]
}, {
"xyz_points" : [ {
"x" : 17.0,
"y" : 25.0,
"z" : -53.1
}, {
"x" : 11.0,
"y" : 225.7,
"z" : -154.0
} ]
} ]
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 62887a952c81466619b9382f5626b936
PUT /public/api/v1/projects/{projectUuid}/polygons/{polygonUuid}/data
| Path parameter | Description |
|---|---|
projectUuid |
Virtual project UUID |
polygonUuid |
UUID of a polygon of the global project of the virtual project |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
[].label |
String |
Polyline label |
[].xyz_points |
Array |
Polyline XYZ points. A polyline with an empty array is skipped |
[].xyz_points[].x |
Number |
Point X coordinate (project units) |
[].xyz_points[].y |
Number |
Point Y coordinate (project units) |
[].xyz_points[].z |
Number |
Point Z coordinate (project depth units) |
Response body
Empty body
18. Sticks
Create stick
Create stick with its trajectory by project UUID (a virtual project UUID is also accepted, the stick is then added to the virtual project). Coordinates and TVDSS are in project units. The trajectory must contain at least one point
Request
$ curl 'https://solo.cloud/public/api/v1/projects/131bb31b-1569-46ee-9ae8-14e8f30345b1/sticks' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Stick name",
"trajectory" : [ {
"tvdss" : {
"undefined" : true
},
"type" : "SHL",
"x" : {
"undefined" : true
},
"y" : {
"undefined" : true
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "LP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -305263.133640553
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "TD",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -300263.133640553
}
} ]
}'
POST /public/api/v1/projects/131bb31b-1569-46ee-9ae8-14e8f30345b1/sticks HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 548
{
"name" : "Stick name",
"trajectory" : [ {
"tvdss" : {
"undefined" : true
},
"type" : "SHL",
"x" : {
"undefined" : true
},
"y" : {
"undefined" : true
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "LP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -305263.133640553
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "TD",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -300263.133640553
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5ca433f73901bf434b66eab8447860d5
Content-Type: application/json
{
"uuid" : "67e2b1d6-d0e0-4abe-a736-82a160bc482f"
}
POST /public/api/v1/projects/{uuid}/sticks
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Stick name. Must not be blank, up to 200 characters |
trajectory |
Array |
Trajectory points in order, see type for the order rules. Every point needs defined x, y and tvdss, only an SHL may have all three undefined, else 406 |
trajectory[].x.val |
Number |
X coordinate (project units) |
trajectory[].y.val |
Number |
Y coordinate (project units) |
trajectory[].tvdss.val |
Number |
True vertical depth below sea level (project units) |
trajectory[].type |
String |
Required. Point type (possible values: SHL for Surface Hole Location, LP for Landing Point, TD for Total Depth, WP). SHL must be the first point. LP and TD are optional and allowed once each, TD must be the last point and requires a preceding LP. A point without a type or a trajectory that breaks these rules is rejected with 406 |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created stick UUID |
Get sticks by project
Get a list of sticks with their trajectories by project UUID with pagination, in creation order. For a virtual project UUID, only sticks of the virtual project are returned
Request
$ curl 'https://solo.cloud/public/api/v1/projects/131bb31b-1569-46ee-9ae8-14e8f30345b1/sticks?offset=0&limit=10&filter=oNe' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/131bb31b-1569-46ee-9ae8-14e8f30345b1/sticks?offset=0&limit=10&filter=oNe HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 488d9ea74bef5b82dd790b8842bfbb7e
Content-Type: application/json
{
"content" : [ {
"uuid" : "80470626-3358-4dd5-8e79-e9920bcd0044",
"name" : "Stick one",
"trajectory" : [ {
"type" : "SHL",
"x" : {
"val" : 0.7935475097531784
},
"y" : {
"val" : 0.5999713512316145
},
"tvdss" : {
"val" : 1.7041867975299099
}
}, {
"type" : "LP",
"x" : {
"val" : 0.719642893431834
},
"y" : {
"val" : 0.44700344257758495
},
"tvdss" : {
"val" : 0.5166957115699943
}
}, {
"type" : "TD",
"x" : {
"val" : 0.9499826970778237
},
"y" : {
"val" : 0.18301202915390136
},
"tvdss" : {
"val" : 1.9626503951789438
}
} ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/sticks
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the sticks whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Stick UUID |
content[].name |
String |
Stick name |
content[].trajectory |
Array |
Trajectory points |
content[].trajectory[].x.val |
Number |
X coordinate (project units) |
content[].trajectory[].y.val |
Number |
Y coordinate (project units) |
content[].trajectory[].tvdss.val |
Number |
True vertical depth below sea level (project units) |
content[].trajectory[].type |
String |
Point type (possible values: SHL for Surface Hole Location, LP for Landing Point, TD for Total Depth, WP) |
Update stick
Replace the name and the trajectory of a stick by UUID. Both name and trajectory are required, the trajectory is replaced as a whole
Request
$ curl 'https://solo.cloud/public/api/v1/sticks/80470626-3358-4dd5-8e79-e9920bcd0044' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Updated stick name",
"trajectory" : [ {
"tvdss" : {
"undefined" : true
},
"type" : "SHL",
"x" : {
"undefined" : true
},
"y" : {
"undefined" : true
}
}, {
"tvdss" : {
"val" : -1524
},
"type" : "WP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -305263.133640553
}
}, {
"tvdss" : {
"val" : -2286
},
"type" : "WP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -305263.133640553
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "LP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -305263.133640553
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "WP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -301513.133640553
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "TD",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -300263.133640553
}
} ]
}'
PATCH /public/api/v1/sticks/80470626-3358-4dd5-8e79-e9920bcd0044 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 1063
{
"name" : "Updated stick name",
"trajectory" : [ {
"tvdss" : {
"undefined" : true
},
"type" : "SHL",
"x" : {
"undefined" : true
},
"y" : {
"undefined" : true
}
}, {
"tvdss" : {
"val" : -1524
},
"type" : "WP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -305263.133640553
}
}, {
"tvdss" : {
"val" : -2286
},
"type" : "WP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -305263.133640553
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "LP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -305263.133640553
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "WP",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -301513.133640553
}
}, {
"tvdss" : {
"val" : -3048
},
"type" : "TD",
"x" : {
"val" : 617886.755760369
},
"y" : {
"val" : -300263.133640553
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 508356d509771e5d8139baef587595f2
PATCH /public/api/v1/sticks/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Stick UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Stick name. Must not be blank, up to 200 characters |
trajectory |
Array |
Trajectory points in order, see type for the order rules. Every point needs defined x, y and tvdss, only an SHL may have all three undefined, else 406 |
trajectory[].x.val |
Number |
X coordinate (project units) |
trajectory[].y.val |
Number |
Y coordinate (project units) |
trajectory[].tvdss.val |
Number |
True vertical depth below sea level (project units) |
trajectory[].type |
String |
Required. Point type (possible values: SHL for Surface Hole Location, LP for Landing Point, TD for Total Depth, WP). SHL must be the first point. LP and TD are optional and allowed once each, TD must be the last point and requires a preceding LP. A point without a type or a trajectory that breaks these rules is rejected with 406 |
Response body
Empty body
Delete stick
Delete stick by UUID. Returns 403 if the stick is locked or is a private stick of another user
Request
$ curl 'https://solo.cloud/public/api/v1/sticks/213ee26a-2654-48d5-b3c5-807cf29c18b4' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/sticks/213ee26a-2654-48d5-b3c5-807cf29c18b4 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: c02d332ce946bec1904718b26ed70b54
DELETE /public/api/v1/sticks/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Stick UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
19. Earth models
Create earth model
Create earth model by interpretation UUID. The earth model is created without data and is not listed by Get earth models by interpretation until its data is uploaded. Returns 403 if the interpretation is locked or is a private interpretation of another user. A service (AUTO) interpretation is rejected with 400
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/f0aba689-cf88-41ee-b147-4cfaa2251879/earthmodels' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Earth model name"
}'
POST /public/api/v1/interpretations/f0aba689-cf88-41ee-b147-4cfaa2251879/earthmodels HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 33
{
"name" : "Earth model name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 53492f2e9ab447c69f74bea927460dc1
Content-Type: application/json
{
"uuid" : "3883a3d3-71ef-4493-ac55-ff25273eee95"
}
POST /public/api/v1/interpretations/{uuid}/earthmodels
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Earth model name, required, not blank, at most 200 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created earth model UUID |
Get earth models by interpretation
Get a list of earth models by interpretation UUID with pagination, sorted by name. Earth models that do not contain data will not be included in the response
Request
$ curl 'https://solo.cloud/public/api/v1/interpretations/f0aba689-cf88-41ee-b147-4cfaa2251879/earthmodels?offset=0&limit=10&filter=EM' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/interpretations/f0aba689-cf88-41ee-b147-4cfaa2251879/earthmodels?offset=0&limit=10&filter=EM HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d05a910709ba8a4b642dc229f0590260
Content-Type: application/json
{
"content" : [ {
"name" : "EM 1",
"uuid" : "7432e98a-06ea-4f40-ad76-5c52d9f46d57"
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/interpretations/{uuid}/earthmodels
| Path parameter | Description |
|---|---|
uuid |
Interpretation UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the earth models whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Earth model UUID |
content[].name |
String |
Earth model name |
Get earth model data
Get earth model data by UUID
Request
$ curl 'https://solo.cloud/public/api/v1/earthmodels/7432e98a-06ea-4f40-ad76-5c52d9f46d57/data' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/earthmodels/7432e98a-06ea-4f40-ad76-5c52d9f46d57/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 0ea971ea488f0a402a66729e451bf2c1
Content-Type: application/json
{
"sections" : [ {
"layers" : [ ],
"md" : {
"val" : 0.0
}
}, {
"layers" : [ ],
"md" : {
"val" : 328.0839895013124
}
} ]
}
GET /public/api/v1/earthmodels/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Earth model UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
sections |
Array |
Earth model sections |
sections[].md.val |
Number |
Measured Depth value (project units) |
sections[].layers |
Array |
Earth model section layers |
sections[].layers[].resistivity_horizontal.val |
Number |
Horizontal resistivity value |
sections[].layers[].resistivity_vertical.val |
Number |
Vertical resistivity value |
sections[].layers[].tvd.val |
Number |
True vertical depth value (project units) |
Upload earth model data
Upload earth model data by UUID. The uploaded sections replace the current data of the earth model, depths are in project units. Every section requires md and layers, every layer requires tvd, resistivity_horizontal and resistivity_vertical. md and the layer values are double value objects. The anisotropy of a layer, resistivity_vertical / resistivity_horizontal, must be from 1 to 25. A request that breaks these rules is rejected with 400. A layer the calculation refuses is named in the message by its TVD in project units. Returns 403 if the interpretation is locked or is a private interpretation of another user. A service (AUTO) interpretation is rejected with 400
Request
$ curl 'https://solo.cloud/public/api/v1/earthmodels/7432e98a-06ea-4f40-ad76-5c52d9f46d57/data' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"sections" : [ {
"layers" : [ {
"resistivity_horizontal" : {
"val" : 10.0
},
"resistivity_vertical" : {
"val" : 10.0
},
"tvd" : {
"val" : -100000
}
}, {
"resistivity_horizontal" : {
"val" : 994.0
},
"resistivity_vertical" : {
"val" : 1988.0
},
"tvd" : {
"val" : 16.4592
}
}, {
"resistivity_horizontal" : {
"val" : 994.0
},
"resistivity_vertical" : {
"val" : 1988.0
},
"tvd" : {
"val" : 30.48
}
} ],
"md" : {
"val" : 10.0
}
}, {
"layers" : [ {
"resistivity_horizontal" : {
"val" : 20.0
},
"resistivity_vertical" : {
"val" : 20.0
},
"tvd" : {
"val" : -100000
}
}, {
"resistivity_horizontal" : {
"val" : 99.0
},
"resistivity_vertical" : {
"val" : 988.0
},
"tvd" : {
"val" : 31
}
} ],
"md" : {
"val" : 30.0
}
} ]
}'
PUT /public/api/v1/earthmodels/7432e98a-06ea-4f40-ad76-5c52d9f46d57/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 1074
{
"sections" : [ {
"layers" : [ {
"resistivity_horizontal" : {
"val" : 10.0
},
"resistivity_vertical" : {
"val" : 10.0
},
"tvd" : {
"val" : -100000
}
}, {
"resistivity_horizontal" : {
"val" : 994.0
},
"resistivity_vertical" : {
"val" : 1988.0
},
"tvd" : {
"val" : 16.4592
}
}, {
"resistivity_horizontal" : {
"val" : 994.0
},
"resistivity_vertical" : {
"val" : 1988.0
},
"tvd" : {
"val" : 30.48
}
} ],
"md" : {
"val" : 10.0
}
}, {
"layers" : [ {
"resistivity_horizontal" : {
"val" : 20.0
},
"resistivity_vertical" : {
"val" : 20.0
},
"tvd" : {
"val" : -100000
}
}, {
"resistivity_horizontal" : {
"val" : 99.0
},
"resistivity_vertical" : {
"val" : 988.0
},
"tvd" : {
"val" : 31
}
} ],
"md" : {
"val" : 30.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: c0a73605c66ad3fa7a65980741b6bbc9
PUT /public/api/v1/earthmodels/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Earth model UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
sections |
Array |
Earth model sections |
sections[].md.val |
Number |
Measured Depth value (project units) |
sections[].layers |
Array |
Earth model section layers |
sections[].layers[].resistivity_horizontal.val |
Number |
Horizontal resistivity value |
sections[].layers[].resistivity_vertical.val |
Number |
Vertical resistivity value |
sections[].layers[].tvd.val |
Number |
True vertical depth value (project units) |
Response body
Empty body
20. Reference lists
Get reference list categories
Get a list of reference list categories
Request
$ curl 'https://solo.cloud/public/api/v1/referencelistcategories' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/referencelistcategories HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 2f05524aa632d5ac4b286174b076c7f4
Content-Type: application/json
[ {
"name" : "welllist",
"uuid" : "f6665da9-e922-42a7-ae92-a45a5b367eaf",
"applicable_to" : [ "laterals", "typewells" ]
} ]
GET /public/api/v1/referencelistcategories
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
[].name |
String |
Reference list category name |
[].uuid |
String |
Reference list category UUID |
[].applicable_to |
Array |
Object types the category applies to, for example laterals, typewells |
Get reference lists with items
Get a list of reference lists with the UUIDs of their objects by project UUID and category UUID with pagination, sorted by name. For a virtual project UUID, only lists of the virtual project are returned and object_ids contains only objects included in it. Returns 404 for an unknown category
Request
$ curl 'https://solo.cloud/public/api/v1/projects/c7a1c1e7-3d2c-4dcc-a712-d048cc98e23c/listcategories/f6665da9-e922-42a7-ae92-a45a5b367eaf/referencelists?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/c7a1c1e7-3d2c-4dcc-a712-d048cc98e23c/listcategories/f6665da9-e922-42a7-ae92-a45a5b367eaf/referencelists?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9effc953a0b69abd5ac76079d0e3281d
Content-Type: application/json
{
"content" : [ {
"uuid" : "5c5cfb1f-1851-458c-bc89-2694daa91dbf",
"name" : "name",
"owner" : {
"description" : "",
"email" : "a.zhuravlev+support@rogii.com",
"first_name" : "AAAAAA",
"last_name" : "BBB"
},
"object_ids" : [ ]
}, {
"uuid" : "4fdf2cff-d5e5-4c8d-908e-fb8e49e20908",
"name" : "Reference List Name",
"owner" : {
"description" : "Bot manager",
"email" : "a.bortnikov+manager@rogii.com",
"first_name" : "Bot",
"last_name" : "Manager"
},
"object_ids" : [ "41d09183-63e1-4aed-8dbc-79881d541b95", "9a5a3495-73f9-48aa-b7ad-c87425c64312" ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{projectUuid}/listcategories/{categoryUuid}/referencelists
| Path parameter | Description |
|---|---|
projectUuid |
Project UUID (a virtual project UUID is also accepted) |
categoryUuid |
Reference list category UUID, see Get reference list categories |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Reference list UUID |
content[].name |
String |
Reference list name |
content[].object_ids |
Array |
UUIDs of the objects in the list. For a virtual project, only objects included in the virtual project |
content[].owner |
Object |
User info of the reference list owner (absent if the list has no owner or the owner user no longer exists) |
content[].owner.description |
String |
User description |
content[].owner.email |
String |
User email |
content[].owner.first_name |
String |
User first name |
content[].owner.last_name |
String |
User last name |
Get well lists with items
Get a list of well lists with the UUIDs of their objects by project UUID with pagination, sorted by name. For a virtual project UUID, only well lists of the virtual project are returned and object_ids contains only objects included in it
Request
$ curl 'https://solo.cloud/public/api/v1/projects/c7a1c1e7-3d2c-4dcc-a712-d048cc98e23c/welllists?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/c7a1c1e7-3d2c-4dcc-a712-d048cc98e23c/welllists?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 83d1d0dccb0f42f1bf680978b83991e8
Content-Type: application/json
{
"content" : [ {
"uuid" : "5c5cfb1f-1851-458c-bc89-2694daa91dbf",
"name" : "name",
"owner" : {
"description" : "",
"email" : "a.zhuravlev+support@rogii.com",
"first_name" : "AAAAAA",
"last_name" : "BBB"
},
"object_ids" : [ ]
}, {
"uuid" : "4fdf2cff-d5e5-4c8d-908e-fb8e49e20908",
"name" : "Reference List Name",
"owner" : {
"description" : "Bot manager",
"email" : "a.bortnikov+manager@rogii.com",
"first_name" : "Bot",
"last_name" : "Manager"
},
"object_ids" : [ "41d09183-63e1-4aed-8dbc-79881d541b95", "9a5a3495-73f9-48aa-b7ad-c87425c64312" ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{projectUuid}/welllists
| Path parameter | Description |
|---|---|
projectUuid |
Project UUID (a virtual project UUID is also accepted) |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Well list UUID |
content[].name |
String |
Well list name |
content[].object_ids |
Array |
UUIDs of the objects in the well list. For a virtual project, only objects included in the virtual project |
content[].owner |
Object |
User info of the well list owner (absent if the list has no owner or the owner user no longer exists) |
content[].owner.description |
String |
User description |
content[].owner.email |
String |
User email |
content[].owner.first_name |
String |
User first name |
content[].owner.last_name |
String |
User last name |
Get well list wells
Get wells of a well list by well list UUID, sorted by name. Available to any user of the company that owns the well list's project. Returns 404 if the list does not exist, is not a well list or belongs to another company
Request
$ curl 'https://solo.cloud/public/api/v1/welllists/4fdf2cff-d5e5-4c8d-908e-fb8e49e20908' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/welllists/4fdf2cff-d5e5-4c8d-908e-fb8e49e20908 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 91b77fb74c94d077eefd4e077250ed00
Content-Type: application/json
{
"name" : "Reference List Name",
"owner" : {
"description" : "Bot manager",
"email" : "a.bortnikov+manager@rogii.com",
"first_name" : "Bot",
"last_name" : "Manager"
},
"wells" : [ {
"name" : "Lateral 22H",
"api" : "42-501-20130",
"uuid" : "41d09183-63e1-4aed-8dbc-79881d541b95",
"type" : "WELL"
}, {
"name" : "Typewell A",
"uuid" : "9a5a3495-73f9-48aa-b7ad-c87425c64312",
"type" : "TYPEWELL"
} ]
}
GET /public/api/v1/welllists/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Well list UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
name |
String |
Well list name |
owner |
Object |
User info of the well list owner (absent if the list has no owner or the owner user no longer exists) |
owner.description |
String |
User description |
owner.email |
String |
User email |
owner.first_name |
String |
User first name |
owner.last_name |
String |
User last name |
wells |
Array |
Wells included in the well list, sorted by name |
wells[].name |
String |
Well name |
wells[].api |
String |
Well API number (absent if not set) |
wells[].uuid |
String |
Well UUID |
wells[].type |
String |
Well type: WELL, TYPEWELL or NESTEDWELL |
21. Comments
Create comment
Create comment by lateral UUID, returns its UUID. Comment names do not have to be unique
Request
$ curl 'https://solo.cloud/public/api/v1/wells/189ab6e5-d306-43ec-b7d5-739e5c7e2390/comments' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Comment name"
}'
POST /public/api/v1/wells/189ab6e5-d306-43ec-b7d5-739e5c7e2390/comments HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 29
{
"name" : "Comment name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 984fad6fb620a43ebf0ec51c45b5de99
Content-Type: application/json
{
"uuid" : "e9196fc1-295e-4574-a8a5-11ce63cba438"
}
POST /public/api/v1/wells/{uuid}/comments
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Comment name, required, not blank, up to 200 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created comment UUID |
Create comment box
Create comment box by comment UUID, returns its UUID. anchor_md is in project depth units, when it is omitted the box has no MD anchor
Request
$ curl 'https://solo.cloud/public/api/v1/comments/cc0b5bd2-4f08-4568-a6f4-f408f5426598/commentboxes' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"text" : "Comment box text",
"anchor_md" : {
"val" : 1205.8
}
}'
POST /public/api/v1/comments/cc0b5bd2-4f08-4568-a6f4-f408f5426598/commentboxes HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 75
{
"text" : "Comment box text",
"anchor_md" : {
"val" : 1205.8
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4f1bd813dc038943e143eb802d31a3cb
Content-Type: application/json
{
"uuid" : "b6dd91be-2a28-413c-ab5d-4c416f68d523"
}
POST /public/api/v1/comments/{uuid}/commentboxes
| Path parameter | Description |
|---|---|
uuid |
Comment UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
text |
String |
Comment box text, up to 8192 characters |
anchor_md.val |
Number |
Comment box placement measured depth value in project units |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created comment box UUID |
Get comments
Get comments with comment boxes by lateral UUID with pagination, in creation order. anchor_md is returned in project depth units
Request
$ curl 'https://solo.cloud/public/api/v1/wells/189ab6e5-d306-43ec-b7d5-739e5c7e2390/comments?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
GET /public/api/v1/wells/189ab6e5-d306-43ec-b7d5-739e5c7e2390/comments?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 037cb911905f774386255553f6b9b73b
Content-Type: application/json
{
"content" : [ {
"comment_id" : "cc0b5bd2-4f08-4568-a6f4-f408f5426598",
"name" : "Updated comment name",
"comment_boxes" : [ {
"commentbox_id" : "c57084b8-cc6f-431c-9b50-7f906780943d",
"text" : "New Comment Text",
"anchor_md" : {
"val" : 2375.2755905511813
}
}, {
"commentbox_id" : "b6dd91be-2a28-413c-ab5d-4c416f68d523",
"text" : "Comment box text",
"anchor_md" : {
"val" : 1205.8
}
} ]
}, {
"comment_id" : "e9249456-8182-4c88-b8a6-d59cb96115ad",
"name" : "Comment",
"comment_boxes" : [ {
"commentbox_id" : "6d9d5946-5ce4-4332-879c-ed25b43073d3",
"text" : "New Comment Text",
"anchor_md" : {
"val" : 2375.2755905511813
}
}, {
"commentbox_id" : "46689fcb-9b8e-4ef7-babe-d4e4d6ee1411",
"text" : "New Comment Text",
"anchor_md" : {
"val" : 2375.2755905511813
}
} ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/comments
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].comment_id |
String |
Comment UUID |
content[].name |
String |
Comment name |
content[].comment_boxes[].commentbox_id |
String |
Comment box UUID |
content[].comment_boxes[].text |
String |
Comment box text |
content[].comment_boxes[].anchor_md.val |
Number |
Comment box placement measured depth value in project units |
Update comment
Rename comment by UUID. name is required
Request
$ curl 'https://solo.cloud/public/api/v1/comments/cc0b5bd2-4f08-4568-a6f4-f408f5426598' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Updated comment name"
}'
PATCH /public/api/v1/comments/cc0b5bd2-4f08-4568-a6f4-f408f5426598 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 37
{
"name" : "Updated comment name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4f5de828731e6712fdf0c316e790f757
PATCH /public/api/v1/comments/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Comment UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
New comment name, required, not blank, up to 200 characters |
Response body
Empty body
Update comment box
Update comment box by UUID. Omitted fields are not changed. Setting text discards the rich text formatting of the box
Request
$ curl 'https://solo.cloud/public/api/v1/commentboxes/c57084b8-cc6f-431c-9b50-7f906780943d' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"text" : "Updated comment box text",
"anchor_md" : {
"val" : 333.8
}
}'
PATCH /public/api/v1/commentboxes/c57084b8-cc6f-431c-9b50-7f906780943d HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 82
{
"text" : "Updated comment box text",
"anchor_md" : {
"val" : 333.8
}
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f1d331c6210537bd661f4804a131f6d2
PATCH /public/api/v1/commentboxes/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Comment box UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
text |
String |
New comment box text, up to 8192 characters. Not changed when omitted, setting it discards the rich text formatting of the box |
anchor_md.val |
Number |
New comment box placement measured depth value in project units. Not changed when anchor_md is omitted |
Response body
Empty body
Delete comment
Delete comment by UUID together with all its comment boxes. Returns 403 if the comment or one of its comment boxes is locked or is a private object of another user
Request
$ curl 'https://solo.cloud/public/api/v1/comments/cc0b5bd2-4f08-4568-a6f4-f408f5426598' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/comments/cc0b5bd2-4f08-4568-a6f4-f408f5426598 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: ccad5fea371620f89d86ea5c4c802912
DELETE /public/api/v1/comments/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Comment UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Delete comment box
Delete comment box by UUID. Returns 403 if the comment box is locked or is a private comment box of another user
Request
$ curl 'https://solo.cloud/public/api/v1/commentboxes/c57084b8-cc6f-431c-9b50-7f906780943d' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json'
DELETE /public/api/v1/commentboxes/c57084b8-cc6f-431c-9b50-7f906780943d HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9b201252670c8de233e183fd95e4c194
DELETE /public/api/v1/commentboxes/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Comment box UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
22. Log families
Get laterals log families list
Get log families of the project that match at least one lateral log, with pagination, in creation order. A log matches a log family when the log name equals one of the family mnemonics, case-insensitive. Mudlog and image log families are not returned
Request
$ curl 'https://solo.cloud/public/api/v1/projects/42b6968b-bdba-440e-ac07-ff2f822329b5/wells/logs/logfamilies?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/42b6968b-bdba-440e-ac07-ff2f822329b5/wells/logs/logfamilies?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 2c448c2be8a1742dba08055b73b6982e
Content-Type: application/json
{
"content" : [ {
"uuid" : "c59a4738-3bbc-4437-8722-11f8dbdd5cb9",
"name" : "Log Family",
"group_mnemonics" : [ "mnemonic1", "mnemonic2", "mnemonic3" ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/wells/logs/logfamilies
| Path parameter | Description |
|---|---|
uuid |
Project UUID (a virtual project UUID is also accepted) |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the log families whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Log family UUID |
content[].name |
String |
Log family name |
content[].group_mnemonics |
Array |
Mnemonics list |
Get typewells log families list
Get log families of the project that match at least one typewell log, with pagination, in creation order. A log matches a log family when the log name equals one of the family mnemonics, case-insensitive. Mudlog and image log families are not returned
Request
$ curl 'https://solo.cloud/public/api/v1/projects/42b6968b-bdba-440e-ac07-ff2f822329b5/typewells/logs/logfamilies?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/42b6968b-bdba-440e-ac07-ff2f822329b5/typewells/logs/logfamilies?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: b79d5df5e8b9cef7ed6c2e5ee788346f
Content-Type: application/json
{
"content" : [ {
"uuid" : "c59a4738-3bbc-4437-8722-11f8dbdd5cb9",
"name" : "Log Family",
"group_mnemonics" : [ "mnemonic1", "mnemonic2", "mnemonic3" ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/typewells/logs/logfamilies
| Path parameter | Description |
|---|---|
uuid |
Project UUID (a virtual project UUID is also accepted) |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
filter |
Optional. Returns only the log families whose name contains this substring, case insensitive |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Log family UUID |
content[].name |
String |
Log family name |
content[].group_mnemonics |
Array |
Mnemonics list |
Get laterals log list by log family in specific project
Get lateral logs of the project that match the log family, that is logs whose name equals one of the family mnemonics, case-insensitive, with pagination, in creation order. Returns 400 if the log family belongs to another project and 404 for an unknown log family
Request
$ curl 'https://solo.cloud/public/api/v1/projects/42b6968b-bdba-440e-ac07-ff2f822329b5/logfamilies/c59a4738-3bbc-4437-8722-11f8dbdd5cb9/wells/logs?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/42b6968b-bdba-440e-ac07-ff2f822329b5/logfamilies/c59a4738-3bbc-4437-8722-11f8dbdd5cb9/wells/logs?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 109ef28e2a1c14263a247d7b49c81454
Content-Type: application/json
{
"content" : [ {
"uuid" : "dc91bb30-b357-4334-b6b4-6948e2791e45",
"name" : "mnemonic1"
}, {
"uuid" : "821ad847-c798-4a8c-b410-6006a1a8b338",
"name" : "mnemonic3"
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{project_id}/logfamilies/{log_family_id}/wells/logs
| Path parameter | Description |
|---|---|
project_id |
Project UUID (a virtual project UUID is also accepted) |
log_family_id |
Log family UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Log UUID |
content[].name |
String |
Log name |
Get typewells log list by log family in specific project
Get typewell logs of the project that match the log family, that is logs whose name equals one of the family mnemonics, case-insensitive, with pagination, in creation order. Returns 400 if the log family belongs to another project and 404 for an unknown log family
Request
$ curl 'https://solo.cloud/public/api/v1/projects/42b6968b-bdba-440e-ac07-ff2f822329b5/logfamilies/c59a4738-3bbc-4437-8722-11f8dbdd5cb9/typewells/logs?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/42b6968b-bdba-440e-ac07-ff2f822329b5/logfamilies/c59a4738-3bbc-4437-8722-11f8dbdd5cb9/typewells/logs?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 56772f34b673798360159e6572ed7f97
Content-Type: application/json
{
"content" : [ {
"uuid" : "da4b20f6-834b-4fff-b025-004fe8d52156",
"name" : "mnemonic1"
}, {
"uuid" : "5ed92e17-f9b1-4100-a4c8-4be5a1fccd3d",
"name" : "mnemonic3"
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{project_id}/logfamilies/{log_family_id}/typewells/logs
| Path parameter | Description |
|---|---|
project_id |
Project UUID (a virtual project UUID is also accepted) |
log_family_id |
Log family UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Log UUID |
content[].name |
String |
Log name |
23. Objects update info
Get update info by lateral
Get update info of the lateral and its child objects by lateral UUID. The lateral itself is returned without parent_uuid. Deleted objects are not returned, so a child object missing from the response no longer exists. Only objects of the types listed for type are returned
Request
$ curl 'https://solo.cloud/public/api/v1/wells/95318395-4093-49ab-9500-c6dc739ef2aa/updateinfo' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/95318395-4093-49ab-9500-c6dc739ef2aa/updateinfo HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: e444a4fb25ebebd0ec97f9c434c08f0c
Content-Type: application/json
{
"content" : [ {
"type" : "TOP",
"updated_at" : "2026-11-16T07:27:23.471884Z",
"parent_uuid" : "c4da363f-b2f6-47f2-bdb8-8c3c59fe5e9c",
"modified_at" : "2026-11-16T07:27:23.471884Z",
"uuid" : "239fcb2d-0734-4edb-8307-d2105ec5064d"
}, {
"type" : "LOG",
"updated_at" : "2026-11-16T07:27:22.852806Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:22.852806Z",
"uuid" : "8c0544ba-58ec-4e57-9251-6d4d71057950"
}, {
"type" : "IMAGELOG",
"updated_at" : "2026-11-16T07:27:22.918281Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:22.918281Z",
"uuid" : "4de6ba16-3d48-46e0-ad4a-1c82469e38de"
}, {
"type" : "IMAGE",
"updated_at" : "2026-11-16T07:27:23.013402Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:23.013402Z",
"uuid" : "7f53e0d0-fda1-4b1f-bb66-02da5eb986b7"
}, {
"type" : "NESTEDWELL",
"updated_at" : "2026-11-16T07:27:23.379695Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:23.413878Z",
"uuid" : "066e56f7-ca62-48ae-8e76-59a02c1efa13"
}, {
"type" : "TARGETLINE",
"updated_at" : "2026-11-16T07:27:23.632706Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:23.632706Z",
"uuid" : "5405eea8-a402-456b-8ffd-dd6e7483f23c"
}, {
"type" : "TOPSET",
"updated_at" : "2026-11-16T07:27:23.413878Z",
"parent_uuid" : "066e56f7-ca62-48ae-8e76-59a02c1efa13",
"modified_at" : "2026-11-16T07:27:23.413878Z",
"uuid" : "8592f488-d0d6-449f-a292-5905d13ff49c"
}, {
"type" : "IMAGE",
"updated_at" : "2026-11-16T07:27:23.199017Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:23.199017Z",
"uuid" : "b1dd3211-4fe9-449d-91c2-c16a7743df50"
}, {
"type" : "COMMENT",
"updated_at" : "2026-11-16T07:27:23.529132Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:23.529132Z",
"uuid" : "0e2d2732-80fe-49ab-bb01-ff4208a99c9a"
}, {
"type" : "MUDLOG",
"updated_at" : "2026-11-16T07:27:23.275565Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:23.275565Z",
"uuid" : "7275108c-2c86-4121-808f-b84eeab6c708"
}, {
"type" : "TOPSET",
"updated_at" : "2026-11-16T07:27:23.436501Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:24.037871Z",
"uuid" : "c4da363f-b2f6-47f2-bdb8-8c3c59fe5e9c"
}, {
"type" : "EARTHMODEL",
"updated_at" : "2026-11-16T07:27:23.716119Z",
"parent_uuid" : "9a7dcadc-58bd-44fb-ad08-d5b8de91232b",
"modified_at" : "2026-11-16T07:27:23.778798Z",
"uuid" : "e3e87f78-58a7-4418-ac2f-97a2e6166372"
}, {
"type" : "INTERPRETATION",
"updated_at" : "2026-11-16T07:27:23.057644Z",
"parent_uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"modified_at" : "2026-11-16T07:27:23.778798Z",
"uuid" : "9a7dcadc-58bd-44fb-ad08-d5b8de91232b"
}, {
"type" : "WELL",
"updated_at" : "2026-11-16T07:27:22.747935Z",
"modified_at" : "2026-11-16T07:27:24.037871Z",
"uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa"
} ]
}
GET /public/api/v1/wells/{uuid}/updateinfo
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
content[].uuid |
String |
The object UUID |
content[].type |
String |
Object type: WELL, TYPEWELL, GRID, POLYGON, STICK, LOG, IMAGE, IMAGELOG, INTERPRETATION, MUDLOG, NESTEDWELL, TOPSET, TOP, COMMENT, TARGETLINE, EARTHMODEL or WELLATTRIBUTE |
content[].parent_uuid |
String |
Parent object UUID, absent for the requested object itself |
content[].updated_at |
String |
Timestamp showing when the object itself was updated (UTC time) |
content[].modified_at |
String |
Timestamp showing when either one of the child objects or object itself was updated (UTC time) |
Get update info by typewell
Get update info of the typewell and its child objects by typewell UUID. The typewell itself is returned without parent_uuid. Deleted objects are not returned, so a child object missing from the response no longer exists. Only objects of the types listed for type are returned
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/77e00aec-9bf9-40a4-ad78-20b4ffa35247/updateinfo' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/77e00aec-9bf9-40a4-ad78-20b4ffa35247/updateinfo HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5f819fd24d5149e857342a4a0582b07e
Content-Type: application/json
{
"content" : [ {
"type" : "TYPEWELL",
"updated_at" : "2026-11-16T07:27:22.426026Z",
"modified_at" : "2026-11-16T07:27:22.678442Z",
"uuid" : "77e00aec-9bf9-40a4-ad78-20b4ffa35247"
}, {
"type" : "LOG",
"updated_at" : "2026-11-16T07:27:22.505762Z",
"parent_uuid" : "77e00aec-9bf9-40a4-ad78-20b4ffa35247",
"modified_at" : "2026-11-16T07:27:22.505762Z",
"uuid" : "4f1ae4ca-d65c-424b-b4db-bd647665564c"
}, {
"type" : "TOPSET",
"updated_at" : "2026-11-16T07:27:22.535791Z",
"parent_uuid" : "77e00aec-9bf9-40a4-ad78-20b4ffa35247",
"modified_at" : "2026-11-16T07:27:22.678442Z",
"uuid" : "c2853c49-2b92-4a1e-aa29-7edbccb7837a"
}, {
"type" : "MUDLOG",
"updated_at" : "2026-11-16T07:27:22.611161Z",
"parent_uuid" : "77e00aec-9bf9-40a4-ad78-20b4ffa35247",
"modified_at" : "2026-11-16T07:27:22.611161Z",
"uuid" : "7e62c6ed-d98f-4262-ba1f-4cab6bd39666"
}, {
"type" : "TOP",
"updated_at" : "2026-11-16T07:27:22.678442Z",
"parent_uuid" : "c2853c49-2b92-4a1e-aa29-7edbccb7837a",
"modified_at" : "2026-11-16T07:27:22.678442Z",
"uuid" : "e87b6727-de13-4327-a19b-9ff60a846b45"
} ]
}
GET /public/api/v1/typewells/{uuid}/updateinfo
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
content[].uuid |
String |
The object UUID |
content[].type |
String |
Object type: WELL, TYPEWELL, GRID, POLYGON, STICK, LOG, IMAGE, IMAGELOG, INTERPRETATION, MUDLOG, NESTEDWELL, TOPSET, TOP, COMMENT, TARGETLINE, EARTHMODEL or WELLATTRIBUTE |
content[].parent_uuid |
String |
Parent object UUID, absent for the requested object itself |
content[].updated_at |
String |
Timestamp showing when the object itself was updated (UTC time) |
content[].modified_at |
String |
Timestamp showing when either one of the child objects or object itself was updated (UTC time) |
Get grid update info
Get grid update info by UUID
Request
$ curl 'https://solo.cloud/public/api/v1/grids/5c1e2c3d-751d-40a1-aa13-56e0bfe654c4/updateinfo' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/grids/5c1e2c3d-751d-40a1-aa13-56e0bfe654c4/updateinfo HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a32a85f7def3a797dfc4a071e1aee6d5
Content-Type: application/json
{
"content" : [ {
"type" : "GRID",
"updated_at" : "2026-11-16T07:27:24.306514Z",
"modified_at" : "2026-11-16T07:27:24.306514Z",
"uuid" : "5c1e2c3d-751d-40a1-aa13-56e0bfe654c4"
} ]
}
GET /public/api/v1/grids/{uuid}/updateinfo
| Path parameter | Description |
|---|---|
uuid |
Grid UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
content[].uuid |
String |
The object UUID |
content[].type |
String |
Object type: WELL, TYPEWELL, GRID, POLYGON, STICK, LOG, IMAGE, IMAGELOG, INTERPRETATION, MUDLOG, NESTEDWELL, TOPSET, TOP, COMMENT, TARGETLINE, EARTHMODEL or WELLATTRIBUTE |
content[].parent_uuid |
String |
Parent object UUID, absent for the requested object itself |
content[].updated_at |
String |
Timestamp showing when the object itself was updated (UTC time) |
content[].modified_at |
String |
Timestamp showing when either one of the child objects or object itself was updated (UTC time) |
Get polygon update info
Get polygon update info by UUID
Request
$ curl 'https://solo.cloud/public/api/v1/polygons/2ddbc6a5-9364-4cb5-b3a1-c5ec1e16c3e7/updateinfo' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/polygons/2ddbc6a5-9364-4cb5-b3a1-c5ec1e16c3e7/updateinfo HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: ba32f06dac55a730e12449771641a05c
Content-Type: application/json
{
"content" : [ {
"type" : "POLYGON",
"updated_at" : "2026-11-16T07:27:24.184124Z",
"modified_at" : "2026-11-16T07:27:24.184124Z",
"uuid" : "2ddbc6a5-9364-4cb5-b3a1-c5ec1e16c3e7"
} ]
}
GET /public/api/v1/polygons/{uuid}/updateinfo
| Path parameter | Description |
|---|---|
uuid |
Polygon UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
content[].uuid |
String |
The object UUID |
content[].type |
String |
Object type: WELL, TYPEWELL, GRID, POLYGON, STICK, LOG, IMAGE, IMAGELOG, INTERPRETATION, MUDLOG, NESTEDWELL, TOPSET, TOP, COMMENT, TARGETLINE, EARTHMODEL or WELLATTRIBUTE |
content[].parent_uuid |
String |
Parent object UUID, absent for the requested object itself |
content[].updated_at |
String |
Timestamp showing when the object itself was updated (UTC time) |
content[].modified_at |
String |
Timestamp showing when either one of the child objects or object itself was updated (UTC time) |
Get stick update info
Get stick update info by UUID
Request
$ curl 'https://solo.cloud/public/api/v1/sticks/879084fc-7600-4d58-b46f-c8afb16d38dc/updateinfo' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/sticks/879084fc-7600-4d58-b46f-c8afb16d38dc/updateinfo HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: c79a61144d1ea67c846a46c2eb749735
Content-Type: application/json
{
"content" : [ {
"type" : "STICK",
"updated_at" : "2026-11-16T07:27:24.354073Z",
"modified_at" : "2026-11-16T07:27:24.354073Z",
"uuid" : "879084fc-7600-4d58-b46f-c8afb16d38dc"
} ]
}
GET /public/api/v1/sticks/{uuid}/updateinfo
| Path parameter | Description |
|---|---|
uuid |
Stick UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
content[].uuid |
String |
The object UUID |
content[].type |
String |
Object type: WELL, TYPEWELL, GRID, POLYGON, STICK, LOG, IMAGE, IMAGELOG, INTERPRETATION, MUDLOG, NESTEDWELL, TOPSET, TOP, COMMENT, TARGETLINE, EARTHMODEL or WELLATTRIBUTE |
content[].parent_uuid |
String |
Parent object UUID, absent for the requested object itself |
content[].updated_at |
String |
Timestamp showing when the object itself was updated (UTC time) |
content[].modified_at |
String |
Timestamp showing when either one of the child objects or object itself was updated (UTC time) |
Get last change user info
Get information about users who made the last changes to specified objects. At most 1000 distinct UUIDs are accepted per request (a server setting), otherwise 400 is returned. Objects that are not found in the company of the current user are skipped. Deleted objects are also returned, with their last change before deletion. Objects without a known updating user are skipped
Request
$ curl 'https://solo.cloud/public/api/v1/lastchange/userinfo' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"object_uuids" : [ "95318395-4093-49ab-9500-c6dc739ef2aa", "77e00aec-9bf9-40a4-ad78-20b4ffa35247", "5c1e2c3d-751d-40a1-aa13-56e0bfe654c4" ]
}'
POST /public/api/v1/lastchange/userinfo HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 145
{
"object_uuids" : [ "95318395-4093-49ab-9500-c6dc739ef2aa", "77e00aec-9bf9-40a4-ad78-20b4ffa35247", "5c1e2c3d-751d-40a1-aa13-56e0bfe654c4" ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 219af76bea5b2aa325fc00dd25fb9eca
Content-Type: application/json
{
"content" : [ {
"uuid" : "77e00aec-9bf9-40a4-ad78-20b4ffa35247",
"type" : "TYPEWELL",
"updated_at" : "2026-11-16T07:27:22.426026Z",
"modified_at" : "2026-11-16T07:27:22.678442Z",
"updated_by" : {
"description" : "Bot manager",
"email" : "a.bortnikov+manager@rogii.com",
"first_name" : "Bot",
"last_name" : "Manager"
},
"modified_by" : {
"description" : "Bot manager",
"email" : "a.bortnikov+manager@rogii.com",
"first_name" : "Bot",
"last_name" : "Manager"
}
}, {
"uuid" : "95318395-4093-49ab-9500-c6dc739ef2aa",
"type" : "WELL",
"updated_at" : "2026-11-16T07:27:22.747935Z",
"modified_at" : "2026-11-16T07:27:24.037871Z",
"updated_by" : {
"description" : "Bot manager",
"email" : "a.bortnikov+manager@rogii.com",
"first_name" : "Bot",
"last_name" : "Manager"
},
"modified_by" : {
"description" : "Bot manager",
"email" : "a.bortnikov+manager@rogii.com",
"first_name" : "Bot",
"last_name" : "Manager"
}
}, {
"uuid" : "5c1e2c3d-751d-40a1-aa13-56e0bfe654c4",
"type" : "GRID",
"updated_at" : "2026-11-16T07:27:24.306514Z",
"modified_at" : "2026-11-16T07:27:24.306514Z",
"updated_by" : {
"description" : "Bot manager",
"email" : "a.bortnikov+manager@rogii.com",
"first_name" : "Bot",
"last_name" : "Manager"
},
"modified_by" : {
"description" : "Bot manager",
"email" : "a.bortnikov+manager@rogii.com",
"first_name" : "Bot",
"last_name" : "Manager"
}
} ]
}
POST /public/api/v1/lastchange/userinfo
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
object_uuids |
Array |
List of object UUIDs, at most 1000 distinct values. Objects that are not found in the company of the current user are skipped |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
content[].uuid |
String |
The object UUID |
content[].type |
String |
Object type, for example WELL, TYPEWELL, GRID or LOG |
content[].updated_at |
String |
Timestamp showing when the object itself was updated (UTC time) |
content[].modified_at |
String |
Timestamp showing when either one of the child objects or object itself was updated (UTC time) |
content[].updated_by |
Object |
User info of who last updated the object |
content[].updated_by.description |
String |
User description |
content[].updated_by.email |
String |
User email |
content[].updated_by.first_name |
String |
User first name |
content[].updated_by.last_name |
String |
User last name |
content[].modified_by |
Object |
User info of who last modified the object or its children |
content[].modified_by.description |
String |
User description |
content[].modified_by.email |
String |
User email |
content[].modified_by.first_name |
String |
User first name |
content[].modified_by.last_name |
String |
User last name |
24. Toolcodes
Get toolcodes
Get built-in toolcodes and custom toolcodes of the user's company, sorted by prefix and short_name
Request
$ curl 'https://solo.cloud/public/api/v1/toolcodes' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/toolcodes HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 2d7292e636a61a4836021bad196f15d7
Content-Type: application/json
[ {
"short_name" : "MWD+SRGM",
"description" : "MWD using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with no additional corrections",
"prefix" : "A001Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+SRGM_Fl",
"description" : "MWD using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with no additional corrections on a Floating Rig",
"prefix" : "A001Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+SRGM+SAG",
"description" : "MWD using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) and Sag Correction",
"prefix" : "A002Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+SRGM+SAG_Fl",
"description" : "MWD using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) and Sag Correction on a Floating Rig",
"prefix" : "A002Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "TEST_TOOLCODE",
"description" : "A002Mb/ISC4: BGGM dec + sag corrections",
"prefix" : "A002Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : true
}, {
"short_name" : "MWD+SRGM+AX",
"description" : "MWD using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction",
"prefix" : "A003Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+SRGM+AX_Fl",
"description" : "MWD using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction on a Floating Rig",
"prefix" : "A003Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+SRGM+AX+SAG",
"description" : "MWD using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction and Sag Correction",
"prefix" : "A004Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+SRGM+AX+SAG_Fl",
"description" : "MWD using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "A004Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction)",
"prefix" : "A005Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1_Fl",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) on a Floating Rig",
"prefix" : "A005Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+AX",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) and Axial Correction",
"prefix" : "A006Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+AX_Fl",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) and Axial Correction on a Floating Rig",
"prefix" : "A006Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+AX+SAG",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) and Axial Correction and Sag Correction",
"prefix" : "A007Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+AX+SAG_Fl",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) and Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "A007Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+MS",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) and Multi-Station Correction. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "A008Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+MS_Fl",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) and Multi-Station Correction on a Floating Rig. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "A008Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+SAG",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) and Sag Correction",
"prefix" : "A009Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+SAG_Fl",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) and Sag Correction on a Floating Rig",
"prefix" : "A009Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+SAG+MS",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) with Sag and Multi-Station Correction. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "A010Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR1+SAG+MS_Fl",
"description" : "MWD with IFR1 (IFR or Crustal Anomaly Correction) with Sag and Multi-Station Correction on a Floating Rig. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "A010Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR2+AX+SAG",
"description" : "MWD with IFR2 (IIFR or Crustal Anomaly with Time Varying Corrections) and Axial Correction and Sag Correction",
"prefix" : "A011Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "IFR2",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR2+AX+SAG_Fl",
"description" : "MWD with IFR2 (IIFR or Crustal Anomaly with Time Varying Corrections) and Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "A011Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "IFR2",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR2+SAG",
"description" : "MWD with IFR2 (IIFR or Crustal Anomaly with Time Varying Corrections) and Sag Correction",
"prefix" : "A012Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"geomagnetic_reference" : "IFR2",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR2+SAG_Fl",
"description" : "MWD with IFR2 (IIFR or Crustal Anomaly with Time Varying Corrections) and Sag Correction on a Floating Rig",
"prefix" : "A012Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"geomagnetic_reference" : "IFR2",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR2+SAG+MS",
"description" : "MWD with IFR2 (IIFR or Crustal Anomaly with Time Varying Corrections) with Sag and Multi-Station Correction. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "A013Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "IFR2",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+IFR2+SAG+MS_Fl",
"description" : "MWD with IFR2 (IIFR or Crustal Anomaly with Time Varying Corrections) with Sag and Multi-Station Correction on a Floating Rig. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "A013Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "IFR2",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+SRGM",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with no additional corrections",
"prefix" : "A014Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+SRGM_Fl",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with no additional corrections on a Floating Rig",
"prefix" : "A014Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+SRGM+AX",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction",
"prefix" : "A015Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+SRGM+AX_Fl",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction on a Floating Rig",
"prefix" : "A015Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+SRGM+AX+SAG",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction and Sag Correction",
"prefix" : "A016Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+SRGM+AX+SAG_Fl",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "A016Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+SRGM+SAG",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) and Sag Correction",
"prefix" : "A017Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+SRGM+SAG_Fl",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) and Sag Correction on a Floating Rig",
"prefix" : "A017Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "DIPMETER",
"description" : "Wireline logging tool survey data e.g. Schlumberger GPIT OBDT BGT or Atlas ORIT",
"prefix" : "A018Mb",
"tool_category" : "Magnetic",
"tool_type" : "Dipmeter",
"rig_type" : "Fixed",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "DIPMETER_Fl",
"description" : "Wireline logging tool survey data e.g. Schlumberger GPIT OBDT BGT or Atlas ORIT on a Floating Rig",
"prefix" : "A018Mb",
"tool_category" : "Magnetic",
"tool_type" : "Dipmeter",
"rig_type" : "Floating",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "GYRO-MWD",
"description" : "Generic Gyro MWD. CARE TO BE TAKEN - Tool model fails at 90 deg inclination.",
"prefix" : "A019Gb",
"tool_category" : "Gyro",
"tool_type" : "Gyro MWD",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "GYRO-MWD_Fl",
"description" : "Generic Gyro MWD on a Floating Rig. CARE TO BE TAKEN - Tool model fails at 90 deg inclination.",
"prefix" : "A019Gb",
"tool_category" : "Gyro",
"tool_type" : "Gyro MWD",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "GYRO-NS",
"description" : "Generic North Seeking Gyrocompass Gyro. CARE TO BE TAKEN - Tool model fails at 90 deg inclination.",
"prefix" : "A020Gb",
"tool_category" : "Gyro",
"tool_type" : "Gyro Compass",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "GYRO-NS_Fl",
"description" : "Generic North Seeking Gyrocompass Gyro on a Floating Rig. CARE TO BE TAKEN - Tool model fails at 90 deg inclination.",
"prefix" : "A020Gb",
"custom" : false
}, {
"short_name" : "GYRO-NS-CT",
"description" : "Generic Hybrid Static Gyrocompass and Continuous Survey",
"prefix" : "A021Gc",
"tool_category" : "Gyro",
"tool_type" : "Continuous",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "GYRO-NS-CT_Fl",
"description" : "Generic Hybrid Static Gyrocompass and Continuous Survey on a Floating Rig",
"prefix" : "A021Gc",
"tool_category" : "Gyro",
"tool_type" : "Continuous",
"rig_type" : "Floating",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "CB_Film_GMS",
"description" : "Conventional free gyro e.g. Level Rotor Gyro (LRG). CARE TO BE TAKEN – Tool model fails at 90 deg inclination.",
"prefix" : "A022Gb",
"tool_category" : "Gyro",
"tool_type" : "Camera Based",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "CB_Film_GMS_Fl",
"description" : "Conventional free gyro e.g. Level Rotor Gyro (LRG) on a Floating Rig. CARE TO BE TAKEN – Tool model fails at 90 deg inclination.",
"prefix" : "A022Gb",
"tool_category" : "Gyro",
"tool_type" : "Camera Based",
"rig_type" : "Floating",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "CB_Film_GSS",
"description" : "Conventional free gyro e.g. Level Rotor Gyro (LRG). CARE TO BE TAKEN – Tool model fails at 90 deg inclination.",
"prefix" : "A023Gb",
"tool_category" : "Gyro",
"tool_type" : "Camera Based",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "CB_Film_GSS_Fl",
"description" : "Conventional free gyro e.g. Level Rotor Gyro (LRG) on a Floating Rig. CARE TO BE TAKEN – Tool model fails at 90 deg inclination.",
"prefix" : "A023Gb",
"tool_category" : "Gyro",
"tool_type" : "Camera Based",
"rig_type" : "Floating",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "CB_Film_MMS",
"description" : "Camera Based Film Magnetic Multi-Shot with adequate length and spacing in NMDC",
"prefix" : "A024Mb",
"tool_category" : "Magnetic",
"tool_type" : "Camera Based",
"rig_type" : "Fixed",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "CB_Film_MMS_Fl",
"description" : "Camera Based Film Magnetic Multi-Shot with adequate length and spacing in NMDC on a Floating Rig",
"prefix" : "A024Mb",
"tool_category" : "Magnetic",
"tool_type" : "Camera Based",
"rig_type" : "Floating",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "CB_Film_MSS",
"description" : "Camera Based Film Magnetic Single Shot with adequate length and spacing in NMDC",
"prefix" : "A025Mb",
"tool_category" : "Magnetic",
"tool_type" : "Camera Based",
"rig_type" : "Fixed",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "CB_Film_MSS_Fl",
"description" : "Camera Based Film Magnetic Single Shot with adequate length and spacing in NMDC on a Floating Rig",
"prefix" : "A025Mb",
"tool_category" : "Magnetic",
"tool_type" : "Camera Based",
"rig_type" : "Floating",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "BLIND",
"description" : "Where no survey information was recorded or where the information no longer exists and there is no other supporting information to justify the use of another error model.",
"prefix" : "A026Ua",
"tool_category" : "Utility",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "BLIND_Fl",
"description" : "Where no survey information was recorded or where the information no longer exists and there is no other supporting information to justify the use of another error model. On a Floating Rig",
"prefix" : "A026Ua",
"tool_category" : "Utility",
"rig_type" : "Floating",
"revision" : "ISCWSA Rev1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "INC-ONLY",
"description" : "Inclination only surveys for vertical wells with inclinations less than 5 deg (e.g. Totco Teledrift and Anderdrift)",
"prefix" : "A027Ub",
"tool_category" : "Utility",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "INC-ONLY_Fl",
"description" : "Inclination only surveys for vertical wells with inclinations less than 5 deg (e.g. Totco Teledrift and Anderdrift) on a Floating Rig",
"prefix" : "A027Ub",
"tool_category" : "Utility",
"rig_type" : "Floating",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "INC-ONLY_PLANNED",
"description" : "Inclination only surveys for planned vertical wells with inclinations less than 5 deg (e.g. Totco Teledrift and Anderdrift)",
"prefix" : "A028Ub",
"tool_category" : "Utility",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "INC-ONLY_PLANNED_Fl",
"description" : "Inclination only surveys for planned vertical wells with inclinations less than 5 deg (e.g. Totco Teledrift and Anderdrift) on a Floating Rig",
"prefix" : "A028Ub",
"tool_category" : "Utility",
"rig_type" : "Floating",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "UNKNOWN",
"description" : "For use when survey data exists at any interval not exceeding 200ft but the origin or legacy quality of the data is unknown",
"prefix" : "A029Ub",
"tool_category" : "Utility",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "UNKNOWN_Fl",
"description" : "For use when survey data exists at any interval not exceeding 200ft but the origin or legacy quality of the data is unknown. On a Floating Rig",
"prefix" : "A029Ub",
"tool_category" : "Utility",
"rig_type" : "Floating",
"revision" : "ISCWSA Rev5",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "ZERO-ERROR",
"description" : "To give zero position uncertainty down to a particular depth.",
"prefix" : "A030Ua",
"tool_category" : "Utility",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM",
"description" : "MWD using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD)",
"prefix" : "B001Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM_Fl",
"description" : "MWD using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) on a Floating Rig",
"prefix" : "B001Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM+AX",
"description" : "MWD using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) with Axial Correction",
"prefix" : "B002Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM+AX_Fl",
"description" : "MWD using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) with Axial Correction on a Floating Rig",
"prefix" : "B002Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM+AX+SAG",
"description" : "MWD using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) with Axial Correction and Sag Correction",
"prefix" : "B003Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM+AX+SAG_Fl",
"description" : "MWD using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) with Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "B003Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM+SAG",
"description" : "MWD using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) and Sag Correction",
"prefix" : "B004Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM+SAG_Fl",
"description" : "MWD using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) and Sag Correction on a Floating Rig",
"prefix" : "B004Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM+SAG+MS",
"description" : "MWD Using a High Resolution Geomagnetic Model (HRGM) with spherical harmonic degree of 720 or higher (e.g. HDGM or MVHD) with Sag Correction and Multi-Station Correction. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "B005Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+HRGM+SAG+MS_Fl",
"description" : "MWD Using a High Resolution Geomagnetic Model (HRGM) with spherical harmonic degree of 720 or higher (e.g. HDGM or MVHD) with Sag Correction and Multi-Station Correction on a Floating Rig. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "B005Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+LRGM",
"description" : "MWD using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM)",
"prefix" : "B006Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+LRGM_Fl",
"description" : "MWD using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) on a Floating Rig",
"prefix" : "B006Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+LRGM+AX",
"description" : "MWD using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Axial Correction",
"prefix" : "B007Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+LRGM+AX_Fl",
"description" : "MWD using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Axial Correction on a Floating Rig",
"prefix" : "B007Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+LRGM+AX+SAG",
"description" : "MWD using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Axial Correction and Sag Correction",
"prefix" : "B008Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+LRGM+AX+SAG_Fl",
"description" : "MWD using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "B008Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+LRGM+SAG",
"description" : "MWD using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Sag Correction",
"prefix" : "B009Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "MWD+LRGM+SAG_Fl",
"description" : "MWD using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Sag Correction on a Floating Rig",
"prefix" : "B009Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+IFR1+AX+SAG",
"description" : "EMS with IFR1 (IFR or Crustal Anomaly Correction) and Axial Correction and Sag Correction",
"prefix" : "B010Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+IFR1+AX+SAG_Fl",
"description" : "EMS with IFR1 (IFR or Crustal Anomaly Correction) and Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "B010Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+IFR1+SAG",
"description" : "EMS with IFR1 (IFR or Crustal Anomaly Correction) and Sag Correction",
"prefix" : "B011Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+IFR1+SAG_Fl",
"description" : "EMS with IFR1 (IFR or Crustal Anomaly Correction) and Sag Correction on a Floating Rig",
"prefix" : "B011Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+IFR1+SAG+MS",
"description" : "EMS with IFR1 (IFR or Crustal Anomaly Correction) with Sag and Multi-Station Correction. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "B012Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+IFR1+SAG+MS_Fl",
"description" : "EMS with IFR1 (IFR or Crustal Anomaly Correction) with Sag and Multi-Station Correction on a Floating Rig. CARE TO BE TAKEN WHILE PLANNING A WELL – Refer to Survey Management Specialist to ensure MS is valid.",
"prefix" : "B012Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "MS",
"geomagnetic_reference" : "IFR1",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+HRGM",
"description" : "EMS using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD)",
"prefix" : "B013Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+HRGM_Fl",
"description" : "EMS using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) on a Floating Rig",
"prefix" : "B013Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+HRGM+AX",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction",
"prefix" : "B014Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+HRGM+AX_Fl",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction on a Floating Rig",
"prefix" : "B014Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+HRGM+AX+SAG",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction and Sag Correction",
"prefix" : "B015Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+HRGM+AX+SAG_Fl",
"description" : "EMS using 1-Year Standard Resolution Geomagnetic Mode (e.g. BGGM up to 2018, MVSD) with Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "B015Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+HRGM+SAG",
"description" : "EMS using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) with Sag Correction",
"prefix" : "B016Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+HRGM+SAG_Fl",
"description" : "EMS using 1-year High Resolution Geomagnetic Model with spherical harmonic degree of 720 or higher (e.g. BGGM2019+, HDGM, MVHD) with Sag Correction on a Floating Rig",
"prefix" : "B016Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"geomagnetic_reference" : "HRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+LRGM",
"description" : "EMS using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM)",
"prefix" : "B017Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+LRGM_Fl",
"description" : "EMS using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) on a Floating Rig",
"prefix" : "B017Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+LRGM+AX",
"description" : "EMS using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Axial Correction",
"prefix" : "B018Md",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+LRGM+AX_Fl",
"description" : "EMS using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Axial Correction on a Floating Rig",
"prefix" : "B018Md",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EEMS+LRGM+AX+SAG_Fl",
"description" : "EMS using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "B019Md",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+LRGM+AX+SAG",
"description" : "EMS using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Axial Correction and Sag Correction on a Floating Rig",
"prefix" : "B019Md",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+LRGM+SAG",
"description" : "EMS using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Sag Correction",
"prefix" : "B020Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "EMS+LRGM+SAG_Fl",
"description" : "EMS using Low Resolution Geomagnetic Model (e.g. Updated less frequently than yearly, EMM, CGRF, IGRF, WMM) with Sag Correction on a Floating Rig",
"prefix" : "B020Mc",
"tool_category" : "Magnetic",
"tool_type" : "EMS",
"rig_type" : "Floating",
"sag_correction" : "SAG",
"geomagnetic_reference" : "LRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "FINDS",
"description" : "Ferranti FINDS Inertial Surveys",
"prefix" : "B021Ga",
"tool_category" : "Utility",
"tool_type" : "Utility",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev1",
"revision_date" : "2022-09-23",
"custom" : false
}, {
"short_name" : "BLIND+TREND",
"description" : "Where no survey information was recorded but where some other information exists such as the BHA records or Bit-run summaries or some other relevant formation or drilling knowledge exists concerning the expected trends of the wellpath. May only be assigned for specific cases with a Dispensation.",
"prefix" : "B022Ua",
"tool_category" : "Utility",
"tool_type" : "Utility",
"rig_type" : "Fixed",
"revision" : "ISCWSA Rev1",
"revision_date" : "2022-09-23",
"custom" : false
} ]
GET /public/api/v1/toolcodes
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
[].short_name |
String |
Toolcode short name |
[].description |
String |
Description |
[].prefix |
String |
Prefix |
[].tool_category |
String |
Tool category |
[].tool_type |
String |
Tool type |
[].rig_type |
String |
Rig type |
[].sag_correction |
String |
Sag correction |
[].magnetic_correction |
String |
Magnetic correction |
[].geomagnetic_reference |
String |
Geomagnetic reference |
[].revision |
String |
Revision |
[].revision_date |
String |
Revision date, yyyy-MM-dd |
[].custom |
Boolean |
true for a custom toolcode of the user's company, false for a built-in toolcode |
Get toolcode terms
Get the error model terms of a built-in or custom toolcode by short name as plain text: the uploaded toolcode file without the lines starting with #. 404 is returned if there is no such toolcode. Encode + in the short name as %2B
Request
$ curl 'https://solo.cloud/public/api/v1/toolcodes/terms?short_name=MWD%252BSRGM' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/toolcodes/terms?short_name=MWD%252BSRGM HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 830879b606d759f6e9d969be57c46299
Content-Type: text/plain;charset=UTF-8
drfr e r m 0.35 1.0
dsfs e s - 0.00056 tmd
dstg e g im 2.5e-007 tmd*tvd
xym1 i s d 0.1 abs(sin(inc))
xym2 a s d 0.1 -1.0
xym3e i r d 0.3 cos(inc)*cos(azi)*max(1,sqrt(10/smd))
xym3e a r d 0.3 -(cos(inc)*sin(azi)/sin(inc))*max(1,sqrt(10/smd))
xym4e i r d 0.3 cos(inc)*sin(azi)*max(1,sqrt(10/smd))
xym4e a r d 0.3 (cos(inc)*cos(azi)/sin(inc))*max(1,sqrt(10/smd))
sage i s d 0.2 (sin(inc))^0.25
decu a w d 0.16 1.0
decos a g d 0.24 1.0
decoh a g d 0.21 1.0
decoi a g d 0.05 1.0
decr a r d 0.1 1.0
dbhu a w dnt 2350 1.0/(mtot*cos(dip))
dbhos a g dnt 3359 1.0/(mtot*cos(dip))
dbhoh a g dnt 2840 1.0/(mtot*cos(dip))
dbhoi a g dnt 356 1.0/(mtot*cos(dip))
dbhr a r dnt 3000 1.0/(mtot*cos(dip))
amil a s nt 220 sin(inc)*sin(azm)/(mtot*cos(dip))
abxy_ti1 i s - 0.004 (-cos(inc))/gtot
abxy_ti1 a s - 0.004 (tan(dip)*cos(inc)*sin(azm))/gtot
abxy_ti2 a s - 0.004 ((tan((pi()/2)-inc))-tan(dip)*cos(azm))/gtot
abz i s - 0.004 (-sin(inc))/gtot
abz a s - 0.004 (tan(dip)*sin(inc)*sin(azm))/gtot
asxy_ti1 i s - 0.0005 (sin(inc)*cos(inc))/(2^0.5)
asxy_ti1 a s - 0.0005 (-(tan(dip)*sin(inc)*cos(inc)*sin(azm)))/(2^0.5)
asxy_ti2 i s - 0.0005 (sin(inc)*cos(inc))/2
asxy_ti2 a s - 0.0005 (-(tan(dip)*sin(inc)*cos(inc)*sin(azm)))/2
asxy_ti3 a s - 0.0005 (tan(dip)*sin(inc)*cos(azm)-cos(inc))/2
asz i s - 0.0005 (-sin(inc)*cos(inc))
asz a s - 0.0005 (tan(dip)*sin(inc)*cos(inc)*sin(azm))
mbxy_ti1 a s nt 70 (-(cos(inc)*sin(azm)))/(mtot*cos(dip))
mbxy_ti2 a s nt 70 (cos(azm))/(mtot*cos(dip))
mbz a s nt 70 (-sin(inc)*sin(azm))/(mtot*cos(dip))
msxy_ti1 a s - 0.0016 (sin(inc)*sin(azm)*(tan(dip)*cos(inc)+sin(inc)*cos(azm)))/(2^0.5)
msxy_ti2 a s - 0.0016 (sin(azm)*(tan(dip)*sin(inc)*cos(inc)-(cos(inc))^2*cos(azm)-cos(azm)))/2
msxy_ti3 a s - 0.0016 (cos(inc)*(cos(azm))^2-cos(inc)*(sin(azm))^2-tan(dip)*sin(inc)*cos(azm))/2
msz a s - 0.0016 (-(sin(inc)*cos(azm)+tan(dip)*cos(inc))*sin(inc)*sin(azm))
xcla a r - 0.167 max(sin(abs(daz)),0.00018*smd/sin(inc))
xclh i r - 0.167 max(abs(dic),0.00018*smd)
GET /public/api/v1/toolcodes/terms
| Parameter | Description |
|---|---|
short_name |
Short name of a built-in or custom toolcode, encode + as %2B |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Create or update toolcode
Create a custom toolcode of the user's company from a toolcode file, or completely replace the custom toolcode with the same ShortName (fields missing in the file are cleared). A built-in toolcode cannot be replaced, 400 is returned. Returns the saved toolcode
Request
$ curl 'https://solo.cloud/public/api/v1/toolcodes' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: multipart/form-data' \
-F 'data=@toolcode_with_all_fields.txt;type=application/octet-stream'
PUT /public/api/v1/toolcodes HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: solo.cloud
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=data; filename=toolcode_with_all_fields.txt
Content-Type: application/octet-stream
#ShortName:TEST_TOOLCODE
#Prefix:A002Mc
#Description:A002Mb/ISC4: BGGM dec + sag corrections
#ToolCategory:Magnetic
#ToolType:MWD
#RigType:Fixed
#SagCorrection:SAG
#MagneticCorrection:AX
#GeomagneticReference:SRGM
#Revision:ISCWSA Rev5.1
#RevisionDate:23/09/2022
#Name Vector Tie-On Unit Value Formula
drfr e r m 0.35 1.0
dsfs e s - 0.00056 tmd
dstg e g im 2.5e-007 tmd*tvd
xym1 i s d 0.1 abs(sin(inc))
xym2 a s d 0.1 -1.0
xym3e i r d 0.3 cos(inc)*cos(azi)*max(1,sqrt(10/smd))
xym3e a r d 0.3 -(cos(inc)*sin(azi)/sin(inc))*max(1,sqrt(10/smd))
xym4e i r d 0.3 cos(inc)*sin(azi)*max(1,sqrt(10/smd))
xym4e a r d 0.3 (cos(inc)*cos(azi)/sin(inc))*max(1,sqrt(10/smd))
sage i s d 0.08 (sin(inc))^0.25
decu a w d 0.16 1.0
decos a g d 0.24 1.0
decoh a g d 0.21 1.0
decoi a g d 0.05 1.0
decr a r d 0.1 1.0
dbhu a w dnt 2350 1.0/(mtot*cos(dip))
dbhos a g dnt 3359 1.0/(mtot*cos(dip))
dbhoh a g dnt 2840 1.0/(mtot*cos(dip))
dbhoi a g dnt 356 1.0/(mtot*cos(dip))
dbhr a r dnt 3000 1.0/(mtot*cos(dip))
amil a s nt 220 sin(inc)*sin(azm)/(mtot*cos(dip))
abxy_ti1 i s - 0.004 (-cos(inc))/gtot
abxy_ti1 a s - 0.004 (tan(dip)*cos(inc)*sin(azm))/gtot
abxy_ti2 a s - 0.004 ((tan((pi()/2)-inc))-tan(dip)*cos(azm))/gtot
abz i s - 0.004 (-sin(inc))/gtot
abz a s - 0.004 (tan(dip)*sin(inc)*sin(azm))/gtot
asxy_ti1 i s - 0.0005 (sin(inc)*cos(inc))/(2^0.5)
asxy_ti1 a s - 0.0005 (-(tan(dip)*sin(inc)*cos(inc)*sin(azm)))/(2^0.5)
asxy_ti2 i s - 0.0005 (sin(inc)*cos(inc))/2
asxy_ti2 a s - 0.0005 (-(tan(dip)*sin(inc)*cos(inc)*sin(azm)))/2
asxy_ti3 a s - 0.0005 (tan(dip)*sin(inc)*cos(azm)-cos(inc))/2
asz i s - 0.0005 (-sin(inc)*cos(inc))
asz a s - 0.0005 (tan(dip)*sin(inc)*cos(inc)*sin(azm))
mbxy_ti1 a s nt 70 (-(cos(inc)*sin(azm)))/(mtot*cos(dip))
mbxy_ti2 a s nt 70 (cos(azm))/(mtot*cos(dip))
mbz a s nt 70 (-sin(inc)*sin(azm))/(mtot*cos(dip))
msxy_ti1 a s - 0.0016 (sin(inc)*sin(azm)*(tan(dip)*cos(inc)+sin(inc)*cos(azm)))/(2^0.5)
msxy_ti2 a s - 0.0016 (sin(azm)*(tan(dip)*sin(inc)*cos(inc)-(cos(inc))^2*cos(azm)-cos(azm)))/2
msxy_ti3 a s - 0.0016 (cos(inc)*(cos(azm))^2-cos(inc)*(sin(azm))^2-tan(dip)*sin(inc)*cos(azm))/2
msz a s - 0.0016 (-(sin(inc)*cos(azm)+tan(dip)*cos(inc))*sin(inc)*sin(azm))
xcla a r - 0.167 max(sin(abs(daz)),0.00018*smd/sin(inc))
xclh i r - 0.167 max(abs(dic),0.00018*smd)
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a289f0d4312ea467416ba7b0efd5301a
Content-Type: application/json
{
"short_name" : "TEST_TOOLCODE",
"description" : "A002Mb/ISC4: BGGM dec + sag corrections",
"prefix" : "A002Mc",
"tool_category" : "Magnetic",
"tool_type" : "MWD",
"rig_type" : "Fixed",
"sag_correction" : "SAG",
"magnetic_correction" : "AX",
"geomagnetic_reference" : "SRGM",
"revision" : "ISCWSA Rev5.1",
"revision_date" : "2022-09-23",
"custom" : true
}
PUT /public/api/v1/toolcodes
| Part | Description |
|---|---|
data |
Toolcode file: #Key:Value header lines (ShortName and Description are required, optional Prefix, ToolCategory, ToolType, RigType, SagCorrection, MagneticCorrection, GeomagneticReference, Revision, RevisionDate as dd/MM/yyyy) followed by the error model terms, up to 10000 characters |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
short_name |
String |
Toolcode short name |
description |
String |
Description |
prefix |
String |
Prefix |
tool_category |
String |
Tool category |
tool_type |
String |
Tool type |
rig_type |
String |
Rig type |
sag_correction |
String |
Sag correction |
magnetic_correction |
String |
Magnetic correction |
geomagnetic_reference |
String |
Geomagnetic reference |
revision |
String |
Revision |
revision_date |
String |
Revision date, yyyy-MM-dd |
custom |
Boolean |
true for a custom toolcode of the user's company, false for a built-in toolcode |
Delete toolcode
Delete a custom toolcode of the user's company by short name. A built-in toolcode cannot be deleted, 400 is returned. Deleting a missing toolcode also returns 204
Request
$ curl 'https://solo.cloud/public/api/v1/toolcodes?short_name=TEST_TOOLCODE' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/toolcodes?short_name=TEST_TOOLCODE HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 204 No Content
X-Solo-Trace-Id: 1c354e2b120d89490fda17c3f10ce453
DELETE /public/api/v1/toolcodes
| Parameter | Description |
|---|---|
short_name |
Short name of a custom toolcode of the user's company, encode + as %2B |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
25. Trajectories
Get lateral trajectory
Get lateral trajectory data by lateral UUID. A lateral without a trajectory answers 400 with the type NOT_FOUND
Request
$ curl 'https://solo.cloud/public/api/v1/wells/240be51d-6033-43c1-bfbe-4e94e710d4ea/trajectory' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/240be51d-6033-43c1-bfbe-4e94e710d4ea/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5b0cfa0671af6ed8cf645f7f01c89f91
Content-Type: application/json
{
"content" : [ {
"md" : {
"val" : 0.0
},
"incl" : {
"val" : 0.0
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 3280.839895013124
},
"incl" : {
"val" : 0.4583662361046284
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 4921.259842519686
},
"incl" : {
"val" : 84.79775367935625
},
"azim" : {
"val" : 9.740282517223354
}
}, {
"md" : {
"val" : 13123.359580052496
},
"incl" : {
"val" : 89.95437383553333
},
"azim" : {
"val" : 9.740282517223354
}
} ]
}
GET /public/api/v1/wells/{uuid}/trajectory
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Trajectory points array |
content[].md.val |
Number |
Measured Depth value in project units |
content[].incl.val |
Number |
Inclination value (degrees) |
content[].azim.val |
Number |
Azimuth value (degrees) |
Extend lateral trajectory
Extend lateral trajectory with the sent stations. Sent stations shallower than the first existing station are ignored, as are stations with an undefined incl or azi. Existing stations from the first to the last remaining sent station (by MD) are replaced by them, stations outside that range are kept. md_uom, incl_uom and azi_uom are required, the stations array must not be empty, every station must have md, incl and azi (azim can be used instead of azi, if both are sent azim is used). Returns 403 if the lateral is locked or is a private lateral of another user
Request
$ curl 'https://solo.cloud/public/api/v1/wells/d20e5353-94d2-42b2-b20b-5f1eb1fc314a/trajectory' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}'
PATCH /public/api/v1/wells/d20e5353-94d2-42b2-b20b-5f1eb1fc314a/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 344
{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 548321c711ef0bc702f0caa8ea5cd79e
PATCH /public/api/v1/wells/{uuid}/trajectory
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
md_uom |
String |
Required. Measure unit of the station md values. Accepted values (case-sensitive): m, ft, ftUS |
incl_uom |
String |
Required. Measure unit of the station incl values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
azi_uom |
String |
Required. Measure unit of the station azi values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
trajectory_stations |
Array |
Lateral trajectory stations array, must not be empty |
trajectory_stations[].md.val |
Number |
Station measured depth in md_uom units, required |
trajectory_stations[].incl.val |
Number |
Station inclination in incl_uom units, required |
trajectory_stations[].azi.val |
Number |
Station azimuth in azi_uom units, required. azim is accepted instead of azi, if both are sent azim is used |
Response body
Empty body
Replace lateral trajectory
Replace lateral trajectory with the sent stations. md_uom, incl_uom and azi_uom are required, the stations array must not be empty, every station must have md, incl and azi (azim can be used instead of azi, if both are sent azim is used). Returns 403 if the lateral is locked or is a private lateral of another user
Request
$ curl 'https://solo.cloud/public/api/v1/wells/d20e5353-94d2-42b2-b20b-5f1eb1fc314a/trajectory' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}'
PUT /public/api/v1/wells/d20e5353-94d2-42b2-b20b-5f1eb1fc314a/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 344
{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 485d2828ba189968b7498d68f695b70d
PUT /public/api/v1/wells/{uuid}/trajectory
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
md_uom |
String |
Required. Measure unit of the station md values. Accepted values (case-sensitive): m, ft, ftUS |
incl_uom |
String |
Required. Measure unit of the station incl values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
azi_uom |
String |
Required. Measure unit of the station azi values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
trajectory_stations |
Array |
Lateral trajectory stations array, must not be empty |
trajectory_stations[].md.val |
Number |
Station measured depth in md_uom units, required |
trajectory_stations[].incl.val |
Number |
Station inclination in incl_uom units, required |
trajectory_stations[].azi.val |
Number |
Station azimuth in azi_uom units, required. azim is accepted instead of azi, if both are sent azim is used |
Response body
Empty body
Get typewell trajectory
Get typewell trajectory data by typewell UUID. A typewell without a trajectory answers 400 with the type NOT_FOUND
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/bc6d19f2-761b-4e6f-bfa9-a2cfce20fdba/trajectory' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/bc6d19f2-761b-4e6f-bfa9-a2cfce20fdba/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 0087a4d3db3ae1bbf360407a93a11a16
Content-Type: application/json
{
"content" : [ {
"md" : {
"val" : 0.0
},
"incl" : {
"val" : 0.0
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 3280.839895013124
},
"incl" : {
"val" : 0.4583662361046284
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 4921.259842519686
},
"incl" : {
"val" : 84.79775367935625
},
"azim" : {
"val" : 9.740282517223354
}
}, {
"md" : {
"val" : 13123.359580052496
},
"incl" : {
"val" : 89.95437383553333
},
"azim" : {
"val" : 9.740282517223354
}
} ]
}
GET /public/api/v1/typewells/{uuid}/trajectory
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Trajectory points array |
content[].md.val |
Number |
Measured Depth value in project units |
content[].incl.val |
Number |
Inclination value (degrees) |
content[].azim.val |
Number |
Azimuth value (degrees) |
Extend typewell trajectory
Extend typewell trajectory with the sent stations. Sent stations shallower than the first existing station are ignored, as are stations with an undefined incl or azi. Existing stations from the first to the last remaining sent station (by MD) are replaced by them, stations outside that range are kept. md_uom, incl_uom and azi_uom are required, the stations array must not be empty, every station must have md, incl and azi (azim can be used instead of azi, if both are sent azim is used). Returns 403 if the typewell is locked or is a private typewell of another user
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/bb4803a4-8986-4abf-b0bf-c2a13308c548/trajectory' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}'
PATCH /public/api/v1/typewells/bb4803a4-8986-4abf-b0bf-c2a13308c548/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 344
{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 0516a3e6900a7e3c0cbfaf0f4b19f265
PATCH /public/api/v1/typewells/{uuid}/trajectory
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
md_uom |
String |
Required. Measure unit of the station md values. Accepted values (case-sensitive): m, ft, ftUS |
incl_uom |
String |
Required. Measure unit of the station incl values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
azi_uom |
String |
Required. Measure unit of the station azi values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
trajectory_stations |
Array |
Typewell trajectory stations array, must not be empty |
trajectory_stations[].md.val |
Number |
Station measured depth in md_uom units, required |
trajectory_stations[].incl.val |
Number |
Station inclination in incl_uom units, required |
trajectory_stations[].azi.val |
Number |
Station azimuth in azi_uom units, required. azim is accepted instead of azi, if both are sent azim is used |
Response body
Empty body
Replace typewell trajectory
Replace typewell trajectory with the sent stations. md_uom, incl_uom and azi_uom are required, the stations array must not be empty, every station must have md, incl and azi (azim can be used instead of azi, if both are sent azim is used). Returns 403 if the typewell is locked or is a private typewell of another user
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/bb4803a4-8986-4abf-b0bf-c2a13308c548/trajectory' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}'
PUT /public/api/v1/typewells/bb4803a4-8986-4abf-b0bf-c2a13308c548/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 344
{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4119251141997dc8b36a3271735c8521
PUT /public/api/v1/typewells/{uuid}/trajectory
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
md_uom |
String |
Required. Measure unit of the station md values. Accepted values (case-sensitive): m, ft, ftUS |
incl_uom |
String |
Required. Measure unit of the station incl values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
azi_uom |
String |
Required. Measure unit of the station azi values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
trajectory_stations |
Array |
Typewell trajectory stations array, must not be empty |
trajectory_stations[].md.val |
Number |
Station measured depth in md_uom units, required |
trajectory_stations[].incl.val |
Number |
Station inclination in incl_uom units, required |
trajectory_stations[].azi.val |
Number |
Station azimuth in azi_uom units, required. azim is accepted instead of azi, if both are sent azim is used |
Response body
Empty body
Get nested well trajectory
Get nested well trajectory data by nested well UUID. A nested well without a trajectory answers 400 with the type NOT_FOUND
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/1947bcb4-1252-47aa-9b9c-fe7fd1b45d79/trajectory' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/nestedwells/1947bcb4-1252-47aa-9b9c-fe7fd1b45d79/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4c9364ef2b776ff60f9b7d8cb62d1ce6
Content-Type: application/json
{
"content" : [ {
"md" : {
"val" : 0.0
},
"incl" : {
"val" : 0.0
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 3280.839895013124
},
"incl" : {
"val" : 0.4583662361046284
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 4921.259842519686
},
"incl" : {
"val" : 84.79775367935625
},
"azim" : {
"val" : 9.740282517223354
}
}, {
"md" : {
"val" : 13123.359580052496
},
"incl" : {
"val" : 89.95437383553333
},
"azim" : {
"val" : 9.740282517223354
}
} ]
}
GET /public/api/v1/nestedwells/{uuid}/trajectory
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Trajectory points array |
content[].md.val |
Number |
Measured Depth value in project units |
content[].incl.val |
Number |
Inclination value (degrees) |
content[].azim.val |
Number |
Azimuth value (degrees) |
Extend nested well trajectory
Extend nested well trajectory with the sent stations. Sent stations shallower than the first existing station are ignored, as are stations with an undefined incl or azi. Existing stations from the first to the last remaining sent station (by MD) are replaced by them, stations outside that range are kept. md_uom, incl_uom and azi_uom are required, the stations array must not be empty, every station must have md, incl and azi (azim can be used instead of azi, if both are sent azim is used). Returns 403 if the nested well is locked or is a private nested well of another user
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/6ed9588a-d610-44e7-b2da-6242e660252f/trajectory' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}'
PATCH /public/api/v1/nestedwells/6ed9588a-d610-44e7-b2da-6242e660252f/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 344
{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7720b268e0452dddb946e8114f62f64e
PATCH /public/api/v1/nestedwells/{uuid}/trajectory
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
md_uom |
String |
Required. Measure unit of the station md values. Accepted values (case-sensitive): m, ft, ftUS |
incl_uom |
String |
Required. Measure unit of the station incl values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
azi_uom |
String |
Required. Measure unit of the station azi values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
trajectory_stations |
Array |
Nested well trajectory stations array, must not be empty |
trajectory_stations[].md.val |
Number |
Station measured depth in md_uom units, required |
trajectory_stations[].incl.val |
Number |
Station inclination in incl_uom units, required |
trajectory_stations[].azi.val |
Number |
Station azimuth in azi_uom units, required. azim is accepted instead of azi, if both are sent azim is used |
Response body
Empty body
Replace nested well trajectory
Replace nested well trajectory with the sent stations. md_uom, incl_uom and azi_uom are required, the stations array must not be empty, every station must have md, incl and azi (azim can be used instead of azi, if both are sent azim is used). Returns 403 if the nested well is locked or is a private nested well of another user
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/cd84bd8b-6930-4bc5-b850-b324672933b7/trajectory' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}'
PUT /public/api/v1/nestedwells/cd84bd8b-6930-4bc5-b850-b324672933b7/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 344
{
"md_uom" : "m",
"incl_uom" : "dega",
"azi_uom" : "rad",
"trajectory_stations" : [ {
"md" : {
"val" : 1389
},
"incl" : {
"val" : 1.1
},
"azi" : {
"val" : 1.63
}
}, {
"md" : {
"val" : 1489
},
"incl" : {
"val" : 2.1
},
"azi" : {
"val" : 1.43
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3d6382471af1cc926d2eac3ecd04c336
PUT /public/api/v1/nestedwells/{uuid}/trajectory
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
md_uom |
String |
Required. Measure unit of the station md values. Accepted values (case-sensitive): m, ft, ftUS |
incl_uom |
String |
Required. Measure unit of the station incl values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
azi_uom |
String |
Required. Measure unit of the station azi values. Accepted values (case-sensitive): dega (degrees), rad (radians) |
trajectory_stations |
Array |
Nested well trajectory stations array, must not be empty |
trajectory_stations[].md.val |
Number |
Station measured depth in md_uom units, required |
trajectory_stations[].incl.val |
Number |
Station inclination in incl_uom units, required |
trajectory_stations[].azi.val |
Number |
Station azimuth in azi_uom units, required. azim is accepted instead of azi, if both are sent azim is used |
Response body
Empty body
Get multiple trajectories
Get multiple trajectories by their UUIDs. At most 100 distinct UUIDs can be requested in total, otherwise 400 is returned. UUIDs that are not found, not accessible or listed under a wrong type are skipped (even if also listed under the right one), as are wells without a readable trajectory, a UUID listed twice in the same array is returned once, the order of the result is not guaranteed
Request
$ curl 'https://solo.cloud/public/api/v1/trajectories' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"wells" : [ "240be51d-6033-43c1-bfbe-4e94e710d4ea", "c703c763-8b69-4d40-9179-ef98737a5f60" ],
"typewells" : [ "bc6d19f2-761b-4e6f-bfa9-a2cfce20fdba" ],
"nestedwells" : [ "1947bcb4-1252-47aa-9b9c-fe7fd1b45d79" ]
}'
POST /public/api/v1/trajectories HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 220
{
"wells" : [ "240be51d-6033-43c1-bfbe-4e94e710d4ea", "c703c763-8b69-4d40-9179-ef98737a5f60" ],
"typewells" : [ "bc6d19f2-761b-4e6f-bfa9-a2cfce20fdba" ],
"nestedwells" : [ "1947bcb4-1252-47aa-9b9c-fe7fd1b45d79" ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 2db4a18d33c721d715cf48e8fee3e77f
Content-Type: application/json
{
"content" : [ {
"uuid" : "c703c763-8b69-4d40-9179-ef98737a5f60",
"trajectory" : [ {
"md" : {
"val" : 0.0
},
"incl" : {
"val" : 0.0
},
"azim" : {
"val" : 71.543
}
}, {
"md" : {
"val" : 61.198660000000004
},
"incl" : {
"val" : 0.35
},
"azim" : {
"val" : 176.083
}
}, {
"md" : {
"val" : 100.42002000000001
},
"incl" : {
"val" : 0.25
},
"azim" : {
"val" : 259.043
}
}, {
"md" : {
"val" : 124.93996000000001
},
"incl" : {
"val" : 0.28
},
"azim" : {
"val" : 227.59299999999996
}
}, {
"md" : {
"val" : 174.66991
},
"incl" : {
"val" : 1.13
},
"azim" : {
"val" : 154.423
}
}, {
"md" : {
"val" : 201.38989
},
"incl" : {
"val" : 1.2599999999999998
},
"azim" : {
"val" : 140.38299999999998
}
}, {
"md" : {
"val" : 225.35998000000004
},
"incl" : {
"val" : 1.2999999999999998
},
"azim" : {
"val" : 153.713
}
}, {
"md" : {
"val" : 3280.839895013124
},
"incl" : {
"val" : 1.33
},
"azim" : {
"val" : 149.253
}
} ]
}, {
"uuid" : "240be51d-6033-43c1-bfbe-4e94e710d4ea",
"trajectory" : [ {
"md" : {
"val" : 0.0
},
"incl" : {
"val" : 0.0
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 3280.839895013124
},
"incl" : {
"val" : 0.4583662361046284
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 4921.259842519686
},
"incl" : {
"val" : 84.79775367935625
},
"azim" : {
"val" : 9.740282517223354
}
}, {
"md" : {
"val" : 13123.359580052496
},
"incl" : {
"val" : 89.95437383553333
},
"azim" : {
"val" : 9.740282517223354
}
} ]
}, {
"uuid" : "1947bcb4-1252-47aa-9b9c-fe7fd1b45d79",
"trajectory" : [ {
"md" : {
"val" : 0.0
},
"incl" : {
"val" : 0.0
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 3280.839895013124
},
"incl" : {
"val" : 0.4583662361046284
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 4921.259842519686
},
"incl" : {
"val" : 84.79775367935625
},
"azim" : {
"val" : 9.740282517223354
}
}, {
"md" : {
"val" : 13123.359580052496
},
"incl" : {
"val" : 89.95437383553333
},
"azim" : {
"val" : 9.740282517223354
}
} ]
}, {
"uuid" : "bc6d19f2-761b-4e6f-bfa9-a2cfce20fdba",
"trajectory" : [ {
"md" : {
"val" : 0.0
},
"incl" : {
"val" : 0.0
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 3280.839895013124
},
"incl" : {
"val" : 0.4583662361046284
},
"azim" : {
"val" : 0.0
}
}, {
"md" : {
"val" : 4921.259842519686
},
"incl" : {
"val" : 84.79775367935625
},
"azim" : {
"val" : 9.740282517223354
}
}, {
"md" : {
"val" : 13123.359580052496
},
"incl" : {
"val" : 89.95437383553333
},
"azim" : {
"val" : 9.740282517223354
}
} ]
} ]
}
POST /public/api/v1/trajectories
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
wells |
Array |
Lateral UUIDs to download trajectories for |
typewells |
Array |
Typewell UUIDs to download trajectories for |
nestedwells |
Array |
Nested well UUIDs to download trajectories for |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
List of trajectories, one per found and accessible object, in no particular order |
content[].uuid |
String |
Lateral, typewell or nested well UUID |
content[].trajectory |
Array |
Trajectory points of the lateral, typewell or nested well |
content[].trajectory[].md.val |
Number |
Measured depth value in project units |
content[].trajectory[].incl.val |
Number |
Inclination value (degrees) |
content[].trajectory[].azim.val |
Number |
Azimuth value (degrees) |
26. Public data
Get nearby wells
Search wells of the Solo public data projects whose surface location is within radius_miles of the given point. The point is given, and the well latitude and longitude are returned, in degrees in the geographic CRS set by epsg_mnemonic or epsg_crs_code. The response is not paged, at most 50000 wells are returned. KB elevation is returned in the units of the well's project (measure_unit). Returns 406 if neither or both of epsg_mnemonic and epsg_crs_code are set or radius_miles is greater than 100 (a server setting), and 400 if a value is out of range or the CRS cannot be transformed
Request
$ curl 'https://solo.cloud/public/api/v1/publicdata/nearbywells' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"epsg_mnemonic" : "NAD83",
"latitude" : 30.9807,
"longitude" : -115.9835,
"radius_miles" : 5.0
}'
POST /public/api/v1/publicdata/nearbywells HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 106
{
"epsg_mnemonic" : "NAD83",
"latitude" : 30.9807,
"longitude" : -115.9835,
"radius_miles" : 5.0
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4620c128273eb05694f478f6d1653f40
Content-Type: application/json
{
"content" : [ {
"uuid" : "5ca4ea43-ffbf-43d1-a1fa-a4eef7b0b05f",
"name" : "Lateral",
"api" : "string",
"operator" : "string",
"latitude" : 30.980717619255476,
"longitude" : -115.98346038234884,
"latitude_wgs84" : 30.980717618422293,
"longitude_wgs84" : -115.98346038234884,
"project_uuid" : "543f66a8-dc0f-475a-968a-965dd329b214",
"measure_unit" : "FOOT",
"elevation" : {
"val" : 22.96587926509186
},
"tvd" : {
"val" : 10000.0
},
"convergence" : {
"val" : 0.0
},
"is_true_north_azimuth" : false,
"state" : "Baja California",
"county" : "Mexico",
"type" : "WELL"
} ]
}
POST /public/api/v1/publicdata/nearbywells
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
epsg_mnemonic |
String |
EPSG mnemonic: NAD27 (EPSG:4267) or NAD83 (EPSG:4269). Exactly one of 'epsg_mnemonic' and 'epsg_crs_code' must be set |
epsg_crs_code |
Number |
EPSG code of a geographic CRS (degrees) in which the search center is given and the well latitude and longitude are returned |
latitude |
Number |
Latitude of the search center in degrees in the request CRS, range [-90; 90] |
longitude |
Number |
Longitude of the search center in degrees in the request CRS, range [-180; 180] |
radius_miles |
Number |
Search radius in miles, greater than 0 and not greater than 100 |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Wells of the Solo public data projects whose surface location is within the radius. The list is not paged, at most 50000 wells are returned |
content[].uuid |
String |
Well UUID |
content[].name |
String |
Well name |
content[].api |
String |
Well API number |
content[].operator |
String |
Well operator |
content[].latitude |
Number |
Well surface latitude in degrees in the request CRS |
content[].longitude |
Number |
Well surface longitude in degrees in the request CRS |
content[].latitude_wgs84 |
Number |
Well surface latitude in WGS84 (degrees) |
content[].longitude_wgs84 |
Number |
Well surface longitude in WGS84 (degrees) |
content[].project_uuid |
String |
UUID of the public data project of the well |
content[].measure_unit |
String |
Project measure unit: FOOT, METER or METER_FOOT |
content[].elevation.val |
Number |
Well KB elevation (project units) |
content[].tvd.val |
Number |
Well final TVD value (project units) |
content[].convergence.val |
Number |
Well convergence angle in degrees, range [-180; 180) |
content[].is_true_north_azimuth |
Boolean |
true if the well convergence is set and non-zero, otherwise false |
content[].state |
String |
State or province of the well surface location, absent if not determined |
content[].county |
String |
Country (not county) of the well surface location, absent if not determined |
content[].type |
String |
Well type: WELL, TYPEWELL or NESTEDWELL |
27. Image logs
Create image log by lateral
Create an empty image log by lateral UUID. The image log is not listed by Get image logs by lateral until its data is uploaded
Request
$ curl 'https://solo.cloud/public/api/v1/wells/9c0c404f-6a57-4b53-a638-12e0ac46c87a/imagelogs' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Image log name"
}'
POST /public/api/v1/wells/9c0c404f-6a57-4b53-a638-12e0ac46c87a/imagelogs HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 31
{
"name" : "Image log name"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4cea143bb8642c8dd4884e4a24584270
Content-Type: application/json
{
"uuid" : "4aabaceb-dcd6-4bd4-a6e5-9a36da08c0f1"
}
POST /public/api/v1/wells/{uuid}/imagelogs
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Image log name, up to 200 characters |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created image log UUID |
Get image logs by lateral
Get a list of image logs by lateral UUID with pagination, in creation order. Image logs that do not contain data will not be included in the response
Request
$ curl 'https://solo.cloud/public/api/v1/wells/81269743-cd54-416a-bb20-2fc90463d749/imagelogs?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/81269743-cd54-416a-bb20-2fc90463d749/imagelogs?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: b5be005d9470ab83450759d16859127b
Content-Type: application/json
{
"content" : [ {
"uuid" : "e0efe6c3-8116-42ef-868d-41bc05f4748d",
"name" : "Acoustic Image"
}, {
"uuid" : "10fc2d70-8874-4302-86ce-ce8be75df38f",
"name" : "Resistivity Image",
"is_data_content_outdated" : false,
"data_content" : [ {
"order_index" : 0,
"log_uid" : "RES_UID0",
"log_name" : "RES_NAME0",
"sector" : "Up",
"unit" : "OHMM"
}, {
"order_index" : 1,
"log_uid" : "RES_UID1",
"log_name" : "RES_NAME1",
"sector" : "Down",
"unit" : "OHMM"
} ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/imagelogs
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Image log UUID |
content[].name |
String |
Image log name |
content[].is_data_content_outdated |
Boolean |
true if data_content was recorded for an older version of the image log data than the current one. Absent if there is no data_content |
content[].data_content |
Array |
Source logs the image log was assembled from by real-time streaming, taken from the latest data version that has them. Absent if the image log has no such data |
content[].data_content[].order_index |
Number |
Order index of the log inside image log data content |
content[].data_content[].log_uid |
String |
UID of the log used as a source for image log data content |
content[].data_content[].log_name |
String |
Name of the log used as a source for image log data content |
content[].data_content[].sector |
String |
Sector of the log used as a source for image log data content |
content[].data_content[].unit |
String |
Unit of the log used as a source for image log data content |
Get image log data
Get image log data by UUID. MD values are returned in project depth units. Returns 404 if the image log has no data
Request
$ curl 'https://solo.cloud/public/api/v1/imagelogs/7822c713-3508-45ad-8822-e59ba630781f/data' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/imagelogs/7822c713-3508-45ad-8822-e59ba630781f/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 44375f242655661503712871e48e7f5d
Content-Type: application/json
{
"log_points" : [ {
"channels" : [ {
"data" : [ {
"val" : -83.6675
}, {
"val" : 61.808
}, {
"val" : 61.808
}, {
"val" : 61.808
}, {
"val" : 68.125
}, {
"val" : 68.125
}, {
"val" : 75.144
}, {
"val" : 75.144
}, {
"val" : 73.038
}, {
"val" : 65.318
} ],
"description" : "",
"mnemonic" : ""
}, {
"data" : [ {
"val" : -83.6675
}, {
"val" : 61.808
}, {
"val" : 61.808
}, {
"val" : 61.808
}, {
"val" : 68.125
}, {
"val" : 68.125
}, {
"val" : 75.144
}, {
"val" : 75.144
}, {
"val" : 73.038
}, {
"val" : 65.318
} ],
"description" : "",
"mnemonic" : ""
}, {
"data" : [ {
"val" : -83.6675
}, {
"val" : 61.808
}, {
"val" : 61.808
}, {
"val" : 61.808
}, {
"val" : 68.125
}, {
"val" : 68.125
}, {
"val" : 75.144
}, {
"val" : 75.144
}, {
"val" : 73.038
}, {
"val" : 65.318
} ],
"description" : "",
"mnemonic" : ""
}, {
"data" : [ {
"val" : -83.6675
}, {
"val" : 61.808
}, {
"val" : 61.808
}, {
"val" : 61.808
}, {
"val" : 68.125
}, {
"val" : 68.125
}, {
"val" : 75.144
}, {
"val" : 75.144
}, {
"val" : 73.038
}, {
"val" : 65.318
} ],
"description" : "",
"mnemonic" : ""
} ],
"md" : [ {
"val" : 2478.4999999999995
}, {
"val" : 2480.4999999999995
}, {
"val" : 2480.9999999999995
}, {
"val" : 2481.4999999999995
}, {
"val" : 2481.9999999999995
}, {
"val" : 2482.4999999999995
}, {
"val" : 2482.9999999999995
}, {
"val" : 2483.4999999999995
}, {
"val" : 2483.9999999999995
}, {
"val" : 2484.4999999999995
} ]
} ]
}
GET /public/api/v1/imagelogs/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Image log UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
log_points |
Array |
Image log points array |
log_points[].md |
Array |
Measured depth values array |
log_points[].md[].val |
Number |
Measured depth value in project depth units |
log_points[].channels |
Array |
Image log point data channels array |
log_points[].channels[].mnemonic |
String |
Data channel mnemonic |
log_points[].channels[].description |
String |
Data channel description |
log_points[].channels[].data |
Array |
Data channel values array |
log_points[].channels[].data[].val |
Number |
Data value, absent if the value is undefined |
log_points[].channels[].data[].undefined |
Boolean |
true if the data value is undefined |
Upload\replace image log data
Upload image log data by UUID, replacing the existing data. log_points must contain exactly one element with the md array and at least one channel. MD values are in project depth units, they must be defined and non-decreasing, every channel data array must have the same length as md. A request that breaks these rules is rejected with 400, an unreadable body with 406
Request
$ curl 'https://solo.cloud/public/api/v1/imagelogs/5b7e8ced-0dec-4991-a062-265f3c1e592b/data' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"log_points" : [ {
"md" : [ {
"val" : 100.0
}, {
"val" : 101.0
} ],
"channels" : [ {
"mnemonic" : "GR",
"description" : "Gamma Ray",
"data" : [ {
"val" : 45.0
}, {
"val" : 46.0
} ]
}, {
"mnemonic" : "RES",
"description" : "Resistivity",
"data" : [ {
"val" : 12.0
}, {
"val" : 13.0
} ]
} ]
} ]
}'
PUT /public/api/v1/imagelogs/5b7e8ced-0dec-4991-a062-265f3c1e592b/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 428
{
"log_points" : [ {
"md" : [ {
"val" : 100.0
}, {
"val" : 101.0
} ],
"channels" : [ {
"mnemonic" : "GR",
"description" : "Gamma Ray",
"data" : [ {
"val" : 45.0
}, {
"val" : 46.0
} ]
}, {
"mnemonic" : "RES",
"description" : "Resistivity",
"data" : [ {
"val" : 12.0
}, {
"val" : 13.0
} ]
} ]
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: af106f20995df03b7b2a26b881f308ac
PUT /public/api/v1/imagelogs/{uuid}/data
| Path parameter | Description |
|---|---|
uuid |
Image log UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
log_points |
Array |
Array with exactly one element that holds the MD array and the channels |
log_points[].md |
Array |
Measured depth values array, at least one value |
log_points[].md[].val |
Number |
Measured depth value in project depth units. Values must be defined and non-decreasing |
log_points[].channels |
Array |
Image log channels array, at least one channel |
log_points[].channels[].mnemonic |
String |
Data channel mnemonic, required string |
log_points[].channels[].description |
String |
Data channel description, required string |
log_points[].channels[].data |
Array |
Data channel values array, one value per MD value (same length as md) |
log_points[].channels[].data[].val |
Number |
Data value, when it is undefined omit it and send "undefined": true |
log_points[].channels[].data[].undefined |
Boolean |
true if the data value is undefined |
Response body
Empty body
Delete image log
Delete image log by UUID. Returns 403 if the image log is locked or is a private image log of another user
Request
$ curl 'https://solo.cloud/public/api/v1/imagelogs/7b04b6ab-18d2-45ba-9e1e-cc6634848aef' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/imagelogs/7b04b6ab-18d2-45ba-9e1e-cc6634848aef HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 129135158f2df885b335376c5ea80c1b
DELETE /public/api/v1/imagelogs/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Image log UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
28. Folders
Create lateral folder
Create lateral folder
Request
$ curl 'https://solo.cloud/public/api/v1/wells/6a4effe0-5c20-463a-bd06-d4d882d720f9/folders' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "New lateral nested folder",
"parent_folder" : "f85bcc37-5211-4786-8138-c3fbef4285a8"
}'
POST /public/api/v1/wells/6a4effe0-5c20-463a-bd06-d4d882d720f9/folders HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 102
{
"name" : "New lateral nested folder",
"parent_folder" : "f85bcc37-5211-4786-8138-c3fbef4285a8"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 03bb6d09f783675f6ee9cd18d9711577
Content-Type: application/json
{
"uuid" : "9dee2b53-8abf-458c-b489-be34c35ad274"
}
POST /public/api/v1/wells/{uuid}/folders
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Folder name, up to 200 characters |
parent_folder |
String |
UUID of the parent folder of the same lateral or typewell. Omit it or pass null to create a top-level folder. An unknown folder or a folder of another well is rejected with 400 |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created folder UUID |
Create typewell folder
Create typewell folder
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/55a5177e-f4dd-4334-bbcb-89ba751e1b32/folders' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "New typewell root folder"
}'
POST /public/api/v1/typewells/55a5177e-f4dd-4334-bbcb-89ba751e1b32/folders HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 41
{
"name" : "New typewell root folder"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: ce975217705b2a0865c4379f4355b3f5
Content-Type: application/json
{
"uuid" : "c49edeb5-c45b-4f8e-af9e-f0483427177a"
}
POST /public/api/v1/typewells/{uuid}/folders
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Folder name, up to 200 characters |
parent_folder |
String |
UUID of the parent folder of the same lateral or typewell. Omit it or pass null to create a top-level folder. An unknown folder or a folder of another well is rejected with 400 |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created folder UUID |
Get folders by lateral
Get a list of all folders of the lateral (at any nesting level) with pagination, in creation order. Use relative_path to rebuild the folder tree
Request
$ curl 'https://solo.cloud/public/api/v1/wells/6a4effe0-5c20-463a-bd06-d4d882d720f9/folders?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/6a4effe0-5c20-463a-bd06-d4d882d720f9/folders?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a86be20441fd72e561944e034f3b7ff8
Content-Type: application/json
{
"content" : [ {
"uuid" : "0e80c1ac-a8c7-4afd-b113-06a431ec123a",
"name" : "Lateral folder"
}, {
"uuid" : "c6378d00-46cd-4ac2-b797-3eec5fbedc74",
"name" : "Nested folder",
"relative_path" : [ "0e80c1ac-a8c7-4afd-b113-06a431ec123a" ]
}, {
"uuid" : "f85bcc37-5211-4786-8138-c3fbef4285a8",
"name" : "Deeply nested folder",
"relative_path" : [ "0e80c1ac-a8c7-4afd-b113-06a431ec123a", "c6378d00-46cd-4ac2-b797-3eec5fbedc74" ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 3,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/folders
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Folder UUID |
content[].name |
String |
Folder name |
content[].relative_path |
Array |
UUIDs of the ancestor folders, from the top-level folder down to the parent folder. Absent for top-level folders |
Get folders by typewell
Get a list of all folders of the typewell (at any nesting level) with pagination, in creation order. Use relative_path to rebuild the folder tree
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/55a5177e-f4dd-4334-bbcb-89ba751e1b32/folders?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/55a5177e-f4dd-4334-bbcb-89ba751e1b32/folders?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a0f223dbf2e7ff758b38921e8249abd4
Content-Type: application/json
{
"content" : [ {
"uuid" : "91f665ef-bb4f-4e6d-b196-63575dc3b1bd",
"name" : "Typewell folder"
}, {
"uuid" : "5219d12f-e0a3-4447-bbdb-ee10230a90c1",
"name" : "Typewell nested folder",
"relative_path" : [ "91f665ef-bb4f-4e6d-b196-63575dc3b1bd" ]
}, {
"uuid" : "7e93ecfa-def9-4ca2-9fea-9beb0a35c188",
"name" : "Typewell deeply nested folder",
"relative_path" : [ "91f665ef-bb4f-4e6d-b196-63575dc3b1bd", "5219d12f-e0a3-4447-bbdb-ee10230a90c1" ]
}, {
"uuid" : "c49edeb5-c45b-4f8e-af9e-f0483427177a",
"name" : "New typewell root folder"
} ],
"offset" : 0,
"limit" : 10,
"total" : 4,
"first" : true,
"last" : true
}
GET /public/api/v1/typewells/{uuid}/folders
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Folder UUID |
content[].name |
String |
Folder name |
content[].relative_path |
Array |
UUIDs of the ancestor folders, from the top-level folder down to the parent folder. Absent for top-level folders |
29. Completions
Create completion by lateral
Create completion by lateral UUID
Request
$ curl 'https://solo.cloud/public/api/v1/wells/6ce636e7-6602-40dd-999a-77a416bcdf6a/completions' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Public lateral completion",
"stages" : [ {
"name" : "Public lateral stage",
"top_md" : {
"val" : 200.0
},
"base_md" : {
"val" : 225.5
}
} ]
}'
POST /public/api/v1/wells/6ce636e7-6602-40dd-999a-77a416bcdf6a/completions HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 191
{
"name" : "Public lateral completion",
"stages" : [ {
"name" : "Public lateral stage",
"top_md" : {
"val" : 200.0
},
"base_md" : {
"val" : 225.5
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7cf52cbacaa442adbf38a33d08c3efe9
Content-Type: application/json
{
"uuid" : "0a64a8a5-cfb0-46f6-970c-bea3eb418969"
}
POST /public/api/v1/wells/{uuid}/completions
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Completion name, up to 200 characters |
stages |
Array |
Completion stages |
stages[].name |
String |
Stage name, required, up to 200 characters |
stages[].top_md.val |
Number |
Stage top MD value in project units, required, in range [0;100000] |
stages[].base_md.val |
Number |
Stage base MD value in project units, required, in range [0;100000] |
stages[].properties |
String |
Ignored: stages are always created with the default display properties |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created completion UUID |
Create completion by typewell
Create completion by typewell UUID
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/49d9d1e9-cb10-42a2-b925-f4c7035d5f3b/completions' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Public typewell completion",
"stages" : [ {
"name" : "Public typewell stage",
"top_md" : {
"val" : 300.0
},
"base_md" : {
"val" : 330.0
}
} ]
}'
POST /public/api/v1/typewells/49d9d1e9-cb10-42a2-b925-f4c7035d5f3b/completions HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 193
{
"name" : "Public typewell completion",
"stages" : [ {
"name" : "Public typewell stage",
"top_md" : {
"val" : 300.0
},
"base_md" : {
"val" : 330.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: b43a0421a1668026aafcaa4de0fe0dd2
Content-Type: application/json
{
"uuid" : "95bcd876-17b8-4cfd-9728-98820fd6d1c3"
}
POST /public/api/v1/typewells/{uuid}/completions
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Completion name, up to 200 characters |
stages |
Array |
Completion stages |
stages[].name |
String |
Stage name, required, up to 200 characters |
stages[].top_md.val |
Number |
Stage top MD value in project units, required, in range [0;100000] |
stages[].base_md.val |
Number |
Stage base MD value in project units, required, in range [0;100000] |
stages[].properties |
String |
Ignored: stages are always created with the default display properties |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created completion UUID |
Create completion attribute
Create completion stage attribute by completion UUID. The attribute is created with the FLOAT type, its stage values are set with Create completion stages and Update completion stage
Request
$ curl 'https://solo.cloud/public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8/attributes' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Treating pressure"
}'
POST /public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8/attributes HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 34
{
"name" : "Treating pressure"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 521635fc1a1c1c180c3a7147a0b0dfc5
Content-Type: application/json
{
"uuid" : "23537d70-f62e-4542-9934-05b9ce3da639"
}
POST /public/api/v1/completions/{uuid}/attributes
| Path parameter | Description |
|---|---|
uuid |
Completion UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Attribute name, up to 200 characters; length (case-insensitive) is reserved |
properties |
String |
Attribute display properties JSON string; the default properties are used when omitted |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Created attribute UUID |
Create completion stages
Create completion stages by completion UUID
Request
$ curl 'https://solo.cloud/public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8/stages' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"stages" : [ {
"name" : "Public created stage",
"top_md" : {
"val" : 400.0
},
"base_md" : {
"val" : 425.25
},
"attribute_values" : [ {
"attribute_uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"value" : {
"val" : 12.25
}
} ]
} ]
}'
POST /public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8/stages HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 303
{
"stages" : [ {
"name" : "Public created stage",
"top_md" : {
"val" : 400.0
},
"base_md" : {
"val" : 425.25
},
"attribute_values" : [ {
"attribute_uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"value" : {
"val" : 12.25
}
} ]
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f50181dcb0de05dbf398b1753d18c9ee
Content-Type: application/json
{
"uuids" : [ "c84f749d-d680-4a24-8623-c625d69781e1" ]
}
POST /public/api/v1/completions/{uuid}/stages
| Path parameter | Description |
|---|---|
uuid |
Completion UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
stages |
Array |
Completion stages to create, at least one |
stages[].name |
String |
Stage name, required, up to 200 characters |
stages[].top_md.val |
Number |
Stage top MD value in project units, in range [0;100000] |
stages[].base_md.val |
Number |
Stage base MD value in project units, in range [0;100000] |
stages[].properties |
String |
Ignored: stages are always created with the default display properties |
stages[].attribute_values |
Array |
Stage attribute values; each attribute must be a FLOAT attribute of this completion and may be listed once |
stages[].attribute_values[].attribute_uuid |
String |
Attribute UUID |
stages[].attribute_values[].value.val |
Number |
Attribute value in range [-1000000000;1000000000]; an entry without a value is skipped |
Response body
| Path | Type | Description |
|---|---|---|
uuids |
Array |
Created stage UUIDs in request order |
Get completions by project and name
Get a list of completions of the project wells whose name exactly matches the name query parameter, with pagination, in creation order. For a virtual project UUID, only completions of the virtual project wells are returned. Completion names do not have to be unique. The name, offset and limit parameters are required.
Only stages that have both top and base MD are returned, sorted by base MD descending. Only user-defined FLOAT stage attributes are returned, and a stage lists values only for the attributes that have one
Request
$ curl 'https://solo.cloud/public/api/v1/projects/97566c11-9f78-42ef-a452-89254e886ab3/completions?name=Lateral%20completion&offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/97566c11-9f78-42ef-a452-89254e886ab3/completions?name=Lateral%20completion&offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 72753da147509522390a9c261e365827
Content-Type: application/json
{
"content" : [ {
"uuid" : "62326a56-c640-492c-8425-82d0681302d8",
"name" : "Lateral completion",
"parent_well" : {
"uuid" : "31766c45-a82b-420c-8989-87ae427c554b",
"name" : "Completion lateral",
"type" : "WELL"
},
"attributes" : [ {
"uuid" : "23537d70-f62e-4542-9934-05b9ce3da639",
"name" : "Treating pressure",
"type" : "FLOAT"
}, {
"uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"name" : "Proppant concentration",
"type" : "FLOAT"
} ],
"stages" : [ {
"uuid" : "c84f749d-d680-4a24-8623-c625d69781e1",
"name" : "Public created stage",
"stage" : 1,
"top_md" : {
"val" : 400.0
},
"base_md" : {
"val" : 425.25
},
"length" : {
"val" : 25.25
},
"attribute_values" : [ {
"attribute_uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"value" : {
"val" : 12.25
}
} ]
}, {
"uuid" : "dbeab7e0-c581-4e5c-b918-71926606c93a",
"name" : "Second stage",
"stage" : 2,
"top_md" : {
"val" : 130.0
},
"base_md" : {
"val" : 155.25
},
"length" : {
"val" : 25.25
},
"attribute_values" : [ {
"attribute_uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"value" : {
"val" : 9.75
}
} ]
}, {
"uuid" : "83d7ae3b-c500-42a0-afe6-c29123a944d5",
"name" : "First stage",
"stage" : 3,
"top_md" : {
"val" : 100.0
},
"base_md" : {
"val" : 125.5
},
"length" : {
"val" : 25.5
},
"attribute_values" : [ {
"attribute_uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"value" : {
"val" : 8.5
}
} ]
} ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/completions
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Parameter | Description |
|---|---|
name |
Completion name to match exactly |
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Completion UUID |
content[].name |
String |
Completion name |
content[].attributes |
Array |
Completion stage attributes sorted by name in descending order, case-insensitive, only user-defined FLOAT attributes are listed |
content[].attributes[].uuid |
String |
Attribute UUID |
content[].attributes[].name |
String |
Attribute name |
content[].attributes[].type |
String |
Attribute type, always FLOAT |
content[].stages |
Array |
Completion stages that have both top and base MD, sorted by base MD descending |
content[].stages[].uuid |
String |
Stage UUID |
content[].stages[].name |
String |
Stage name |
content[].stages[].stage |
Number |
Stage number, from 1 for the stage with the largest base MD |
content[].stages[].top_md.val |
Number |
Stage top MD value in project units |
content[].stages[].base_md.val |
Number |
Stage base MD value in project units |
content[].stages[].length.val |
Number |
Stage length (base MD minus top MD) in project units; absent when top MD is not less than base MD |
content[].stages[].attribute_values |
Array |
Stage attribute values in the order of attributes, only attributes that have a value for the stage are listed |
content[].stages[].attribute_values[].attribute_uuid |
String |
Attribute UUID |
content[].stages[].attribute_values[].value.val |
Number |
Attribute value |
content[].parent_well |
Object |
Parent well metadata |
content[].parent_well.uuid |
String |
Parent well UUID |
content[].parent_well.name |
String |
Parent well name |
content[].parent_well.type |
String |
Parent well type: WELL for a lateral, TYPEWELL for a typewell |
Get completions by lateral
Get a list of completions by lateral UUID with pagination, in creation order. Only stages that have both top and base MD are returned, sorted by base MD descending. Only user-defined FLOAT stage attributes are returned, and a stage lists values only for the attributes that have one
Request
$ curl 'https://solo.cloud/public/api/v1/wells/31766c45-a82b-420c-8989-87ae427c554b/completions?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/31766c45-a82b-420c-8989-87ae427c554b/completions?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 715756803076aa37126e664b27802e23
Content-Type: application/json
{
"content" : [ {
"uuid" : "62326a56-c640-492c-8425-82d0681302d8",
"name" : "Lateral completion",
"attributes" : [ {
"uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"name" : "Proppant concentration",
"type" : "FLOAT"
} ],
"stages" : [ {
"uuid" : "dbeab7e0-c581-4e5c-b918-71926606c93a",
"name" : "Second stage",
"stage" : 1,
"top_md" : {
"val" : 130.0
},
"base_md" : {
"val" : 155.25
},
"length" : {
"val" : 25.25
},
"attribute_values" : [ {
"attribute_uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"value" : {
"val" : 9.75
}
} ]
}, {
"uuid" : "83d7ae3b-c500-42a0-afe6-c29123a944d5",
"name" : "First stage",
"stage" : 2,
"top_md" : {
"val" : 100.0
},
"base_md" : {
"val" : 125.5
},
"length" : {
"val" : 25.5
},
"attribute_values" : [ {
"attribute_uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"value" : {
"val" : 8.5
}
} ]
} ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/completions
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Completion UUID |
content[].name |
String |
Completion name |
content[].attributes |
Array |
Completion stage attributes sorted by name in descending order, case-insensitive, only user-defined FLOAT attributes are listed |
content[].attributes[].uuid |
String |
Attribute UUID |
content[].attributes[].name |
String |
Attribute name |
content[].attributes[].type |
String |
Attribute type, always FLOAT |
content[].stages |
Array |
Completion stages that have both top and base MD, sorted by base MD descending |
content[].stages[].uuid |
String |
Stage UUID |
content[].stages[].name |
String |
Stage name |
content[].stages[].stage |
Number |
Stage number, from 1 for the stage with the largest base MD |
content[].stages[].top_md.val |
Number |
Stage top MD value in project units |
content[].stages[].base_md.val |
Number |
Stage base MD value in project units |
content[].stages[].length.val |
Number |
Stage length (base MD minus top MD) in project units; absent when top MD is not less than base MD |
content[].stages[].attribute_values |
Array |
Stage attribute values in the order of attributes, only attributes that have a value for the stage are listed |
content[].stages[].attribute_values[].attribute_uuid |
String |
Attribute UUID |
content[].stages[].attribute_values[].value.val |
Number |
Attribute value |
Get completions by typewell
Get a list of completions by typewell UUID with pagination, in creation order. Only stages that have both top and base MD are returned, sorted by base MD descending. Only user-defined FLOAT stage attributes are returned, and a stage lists values only for the attributes that have one
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/08a56af6-344e-48ce-92aa-ef7596a1aead/completions?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/08a56af6-344e-48ce-92aa-ef7596a1aead/completions?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4e369a860467fcfb14baf70d92426b75
Content-Type: application/json
{
"content" : [ {
"uuid" : "f72f8980-3662-49ed-94ed-fd9eea22946b",
"name" : "Typewell completion",
"attributes" : [ {
"uuid" : "c9cb4f64-8f31-456a-849e-a24ac5056e60",
"name" : "Proppant concentration",
"type" : "FLOAT"
} ],
"stages" : [ {
"uuid" : "c27736b2-b071-4da6-8d92-e7601d8507c3",
"name" : "Second stage",
"stage" : 1,
"top_md" : {
"val" : 130.0
},
"base_md" : {
"val" : 155.25
},
"length" : {
"val" : 25.25
},
"attribute_values" : [ {
"attribute_uuid" : "c9cb4f64-8f31-456a-849e-a24ac5056e60",
"value" : {
"val" : 9.75
}
} ]
}, {
"uuid" : "d09ee208-cc7e-4e31-84b0-66e3aab1478a",
"name" : "First stage",
"stage" : 2,
"top_md" : {
"val" : 100.0
},
"base_md" : {
"val" : 125.5
},
"length" : {
"val" : 25.5
},
"attribute_values" : [ {
"attribute_uuid" : "c9cb4f64-8f31-456a-849e-a24ac5056e60",
"value" : {
"val" : 8.5
}
} ]
} ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/typewells/{uuid}/completions
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Completion UUID |
content[].name |
String |
Completion name |
content[].attributes |
Array |
Completion stage attributes sorted by name in descending order, case-insensitive, only user-defined FLOAT attributes are listed |
content[].attributes[].uuid |
String |
Attribute UUID |
content[].attributes[].name |
String |
Attribute name |
content[].attributes[].type |
String |
Attribute type, always FLOAT |
content[].stages |
Array |
Completion stages that have both top and base MD, sorted by base MD descending |
content[].stages[].uuid |
String |
Stage UUID |
content[].stages[].name |
String |
Stage name |
content[].stages[].stage |
Number |
Stage number, from 1 for the stage with the largest base MD |
content[].stages[].top_md.val |
Number |
Stage top MD value in project units |
content[].stages[].base_md.val |
Number |
Stage base MD value in project units |
content[].stages[].length.val |
Number |
Stage length (base MD minus top MD) in project units; absent when top MD is not less than base MD |
content[].stages[].attribute_values |
Array |
Stage attribute values in the order of attributes, only attributes that have a value for the stage are listed |
content[].stages[].attribute_values[].attribute_uuid |
String |
Attribute UUID |
content[].stages[].attribute_values[].value.val |
Number |
Attribute value |
Update completion
Update completion by UUID
Request
$ curl 'https://solo.cloud/public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Updated lateral completion"
}'
PATCH /public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 43
{
"name" : "Updated lateral completion"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 6edfe499d3e70d1049121e8b48367890
PATCH /public/api/v1/completions/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Completion UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
New completion name, up to 200 characters |
Response body
Empty body
Update completion attribute
Update completion attribute name by completion UUID and attribute UUID. Returns 400 if the attribute does not belong to the completion
Request
$ curl 'https://solo.cloud/public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8/attributes/e24bfc12-6278-4c42-9a3e-48005dda37eb' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Updated proppant concentration"
}'
PATCH /public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8/attributes/e24bfc12-6278-4c42-9a3e-48005dda37eb HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 47
{
"name" : "Updated proppant concentration"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 09231defe869f69126260f0e5eaec6d5
PATCH /public/api/v1/completions/{completionUuid}/attributes/{attributeUuid}
| Path parameter | Description |
|---|---|
completionUuid |
Completion UUID |
attributeUuid |
Attribute UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
New attribute name, up to 200 characters; length (case-insensitive) is reserved |
Response body
Empty body
Update completion stage
Update completion stage by stage UUID. An absent field keeps its current value. Only the listed attribute values are changed, an entry without a value clears the attribute value
Request
$ curl 'https://solo.cloud/public/api/v1/stages/83d7ae3b-c500-42a0-afe6-c29123a944d5' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Updated first stage",
"top_md" : {
"val" : 105.0
},
"base_md" : {
"val" : 129.5
},
"attribute_values" : [ {
"attribute_uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"value" : {
"val" : 10.5
}
} ]
}'
PATCH /public/api/v1/stages/83d7ae3b-c500-42a0-afe6-c29123a944d5 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 251
{
"name" : "Updated first stage",
"top_md" : {
"val" : 105.0
},
"base_md" : {
"val" : 129.5
},
"attribute_values" : [ {
"attribute_uuid" : "e24bfc12-6278-4c42-9a3e-48005dda37eb",
"value" : {
"val" : 10.5
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9704f1bdc2900b1a13213f7c41cb6d7c
PATCH /public/api/v1/stages/{stageUuid}
| Path parameter | Description |
|---|---|
stageUuid |
Stage UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
New stage name, up to 200 characters |
top_md.val |
Number |
New stage top MD value in project units, in range [0;100000] |
base_md.val |
Number |
New stage base MD value in project units, in range [0;100000] |
attribute_values |
Array |
Stage attribute values to change; each attribute must be a FLOAT attribute of the stage completion and may be listed once, attributes that are not listed keep their values |
attribute_values[].attribute_uuid |
String |
Attribute UUID |
attribute_values[].value.val |
Number |
New attribute value in range [-1000000000;1000000000]; an entry without a value clears the attribute value |
Response body
Empty body
Delete completion
Delete completion by UUID together with all its stages. Returns 403 if the completion or one of its stages is locked or is a private object of another user
Request
$ curl 'https://solo.cloud/public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7679afc0a23136a2270a8c9916ec9227
DELETE /public/api/v1/completions/{uuid}
| Path parameter | Description |
|---|---|
uuid |
Completion UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Delete completion attribute
Delete completion attribute by completion UUID and attribute UUID. The attribute values are deleted from all stages of the completion. Returns 400 if the attribute does not belong to the completion
Request
$ curl 'https://solo.cloud/public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8/attributes/e24bfc12-6278-4c42-9a3e-48005dda37eb' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/completions/62326a56-c640-492c-8425-82d0681302d8/attributes/e24bfc12-6278-4c42-9a3e-48005dda37eb HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d46be9bf2601b9dbd4aa6fc2cc5642ef
DELETE /public/api/v1/completions/{completionUuid}/attributes/{attributeUuid}
| Path parameter | Description |
|---|---|
completionUuid |
Completion UUID |
attributeUuid |
Attribute UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Delete completion stage
Delete completion stage by stage UUID. Returns 403 if the stage is locked or is a private stage of another user
Request
$ curl 'https://solo.cloud/public/api/v1/stages/83d7ae3b-c500-42a0-afe6-c29123a944d5' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/stages/83d7ae3b-c500-42a0-afe6-c29123a944d5 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a1291f5180e368672a8f3d19bec55097
DELETE /public/api/v1/stages/{stageUuid}
| Path parameter | Description |
|---|---|
stageUuid |
Stage UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
30. Production data
Create or update production curves
Bulk create or update production curves (monthly production data) for wells in the project.
A request may contain multiple wells (laterals or typewells) and multiple curves per well; each well_uuid + metric pair must be unique within the request, otherwise the request is rejected with 400. If any well is not found in the project, the whole request is rejected with 404 NOT_FOUND. If a curve for the same well and metric already exists, it is updated: its name, granularity and value type are taken from the request and its points are fully replaced, otherwise a new curve is created. The response lists one result per requested curve in request order. A curve already stored with the same name, granularity, value type and points is not written again and is answered as UNCHANGED, so a request repeated after the earlier one finished writes nothing again. A request that timed out may still be applied: wait a few minutes before repeating it.
One request carries at most 500 wells (a server setting), a larger request is rejected with 400 naming the limit. Nothing is written when a request is rejected.
Point values are production volumes in cubic meters (m3) submitted as plain finite numbers; they are stored as submitted, no unit conversion is performed.
Request
$ curl 'https://solo.cloud/public/api/v1/projects/f9b0e54a-d45d-4d93-a73e-92272b242670/production-curves/bulk' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"wells" : [ {
"well_uuid" : "9e9d30ca-fd46-4cc6-9a3a-f2703b74dd87",
"curves" : [ {
"name" : "Gas production curve",
"metric" : "GAS",
"granularity" : "MONTHLY",
"value_type" : "PERIOD",
"points" : [ {
"period_start" : "2024-01-01",
"value" : 250000.0
}, {
"period_start" : "2024-02-01",
"value" : 235500.5
} ]
} ]
} ]
}'
POST /public/api/v1/projects/f9b0e54a-d45d-4d93-a73e-92272b242670/production-curves/bulk HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 411
{
"wells" : [ {
"well_uuid" : "9e9d30ca-fd46-4cc6-9a3a-f2703b74dd87",
"curves" : [ {
"name" : "Gas production curve",
"metric" : "GAS",
"granularity" : "MONTHLY",
"value_type" : "PERIOD",
"points" : [ {
"period_start" : "2024-01-01",
"value" : 250000.0
}, {
"period_start" : "2024-02-01",
"value" : 235500.5
} ]
} ]
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: acd11816c4b07f0939badbceeda80028
Content-Type: application/json
[ {
"well_uuid" : "9e9d30ca-fd46-4cc6-9a3a-f2703b74dd87",
"curve_uuid" : "b93e55ce-4c54-4898-815b-d99237090dc9",
"name" : "Gas production curve",
"action" : "CREATED"
} ]
POST /public/api/v1/projects/{project_uuid}/production-curves/bulk
| Path parameter | Description |
|---|---|
project_uuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
wells |
Array |
Wells to create or update production curves for |
wells[].well_uuid |
String |
Well UUID (lateral or typewell in the project); a well UUID not found in the project rejects the whole request with 404 NOT_FOUND |
wells[].curves |
Array |
Production curves of the well; each well_uuid + metric pair must be unique within the request |
wells[].curves[].name |
String |
Production curve name (up to 200 characters); replaces the name of an existing curve |
wells[].curves[].metric |
String |
Production metric (OIL, GAS, WATER or CONDENSATE) |
wells[].curves[].granularity |
String |
Points granularity (MONTHLY) |
wells[].curves[].value_type |
String |
Points value type (PERIOD - each point holds the volume produced during its period, CUMULATIVE is reserved) |
wells[].curves[].points |
Array |
Production curve points; on update the existing points are fully replaced |
wells[].curves[].points[].period_start |
String |
Period start (ISO date, yyyy-MM-dd) |
wells[].curves[].points[].value |
Number |
Production volume for the period in cubic meters (m3), a finite number |
Response body
| Path | Type | Description |
|---|---|---|
[].well_uuid |
String |
Well UUID |
[].curve_uuid |
String |
Production curve UUID |
[].name |
String |
Production curve name |
[].action |
String |
CREATED if a new curve was created, UPDATED if the existing curve for the same well and metric was updated, UNCHANGED if it already had the same name, granularity, value type and points and was not written |
Get production curves by well
Get a list of production curves of the well with metadata (without points). Returns an empty array when the well has no production curves.
The caller must have read access to the project. A well that is not a lateral or typewell of the project is rejected with 404 NOT_FOUND.
Request
$ curl 'https://solo.cloud/public/api/v1/projects/f9b0e54a-d45d-4d93-a73e-92272b242670/wells/007371c8-5322-46d0-958b-f4f7554f6e42/production-curves' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/f9b0e54a-d45d-4d93-a73e-92272b242670/wells/007371c8-5322-46d0-958b-f4f7554f6e42/production-curves HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 56b2eefd69b11564c2b2e236dea676e5
Content-Type: application/json
[ {
"well_uuid" : "007371c8-5322-46d0-958b-f4f7554f6e42",
"curve_uuid" : "6a4f8f92-4947-4f54-8913-5a84ce87d381",
"name" : "Oil production curve",
"metric" : "OIL",
"granularity" : "MONTHLY",
"value_type" : "PERIOD",
"curve_data_version" : 1
} ]
GET /public/api/v1/projects/{project_uuid}/wells/{well_uuid}/production-curves
| Path parameter | Description |
|---|---|
project_uuid |
Project UUID |
well_uuid |
Well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
[].well_uuid |
String |
Well UUID |
[].curve_uuid |
String |
Production curve UUID |
[].name |
String |
Production curve name |
[].metric |
String |
Production metric (OIL, GAS, WATER or CONDENSATE) |
[].granularity |
String |
Points granularity (MONTHLY) |
[].value_type |
String |
Points value type (PERIOD - each point holds the volume produced during its period, CUMULATIVE is reserved) |
[].curve_data_version |
Number |
Version of the curve points data, changes when the points are updated |
Query production curves
Get production curves (monthly production data) with points for the requested wells in the project, sorted by well UUID, then by metric.
Each curve holds one production metric (OIL, GAS, WATER or CONDENSATE) with MONTHLY granularity; point values are volumes in cubic meters (m3), conversion to display units is the consumer's responsibility. Point value is a double value object.
The caller must have read access to the project. The endpoint is available when advanced data management is enabled for the company, otherwise the request is rejected with 403.
Request
$ curl 'https://solo.cloud/public/api/v1/projects/f9b0e54a-d45d-4d93-a73e-92272b242670/production-curves/query' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"well_uuids" : [ "007371c8-5322-46d0-958b-f4f7554f6e42" ],
"metrics" : [ "OIL" ]
}'
POST /public/api/v1/projects/f9b0e54a-d45d-4d93-a73e-92272b242670/production-curves/query HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 88
{
"well_uuids" : [ "007371c8-5322-46d0-958b-f4f7554f6e42" ],
"metrics" : [ "OIL" ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 77d278b09ca1038d86f8f61a467f04a8
Content-Type: application/json
[ {
"curve_uuid" : "6a4f8f92-4947-4f54-8913-5a84ce87d381",
"well_uuid" : "007371c8-5322-46d0-958b-f4f7554f6e42",
"name" : "Oil production curve",
"metric" : "OIL",
"granularity" : "MONTHLY",
"value_type" : "PERIOD",
"points" : [ {
"value" : {
"val" : 1500.0
},
"period_start" : "2024-01-01T00:00:00Z"
}, {
"value" : {
"val" : 1420.5
},
"period_start" : "2024-02-01T00:00:00Z"
} ]
} ]
POST /public/api/v1/projects/{project_uuid}/production-curves/query
| Path parameter | Description |
|---|---|
project_uuid |
Project UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
well_uuids |
Array |
Well UUIDs to return production curves for, 1 to 1000 wells, wells outside the project are ignored |
metrics |
Array |
Production metrics filter (OIL, GAS, WATER, CONDENSATE); empty or missing means all metrics |
Response body
| Path | Type | Description |
|---|---|---|
[].curve_uuid |
String |
Production curve UUID |
[].well_uuid |
String |
Well UUID |
[].name |
String |
Production curve name |
[].metric |
String |
Production metric (OIL, GAS, WATER or CONDENSATE) |
[].granularity |
String |
Points granularity (MONTHLY) |
[].value_type |
String |
Points value type (PERIOD - each point holds the volume produced during its period, CUMULATIVE is reserved) |
[].points |
Array |
Production curve points |
[].points[].period_start |
String |
Period start (ISO instant, UTC) |
[].points[].value.val |
Number |
Production volume for the period in cubic meters (m3) |
Delete production curve
Delete a production curve from the project by curve UUID. An unknown curve UUID is rejected with 404, a locked curve or a private curve of another user with 403
Request
$ curl 'https://solo.cloud/public/api/v1/projects/f9b0e54a-d45d-4d93-a73e-92272b242670/production-curves/93c18f33-1338-4092-90aa-2639dda22999' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/projects/f9b0e54a-d45d-4d93-a73e-92272b242670/production-curves/93c18f33-1338-4092-90aa-2639dda22999 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 40d921dd097b77d9a940de74ed1168ac
DELETE /public/api/v1/projects/{project_uuid}/production-curves/{curve_uuid}
| Path parameter | Description |
|---|---|
project_uuid |
Project UUID |
curve_uuid |
Production curve UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
31. Well construction
The construction of a well is kept per object type: hole sections, BHA runs and casings. A BHA run and a casing hold their components, which are read and written together with them: components have no endpoints of their own.
Solo validates the construction of a well as a whole: an object with missing or inconsistent values, or one that
does not fit the other objects of the well, is stored but does not pass validation. Every create, update and delete
validates all objects of the well again. The lists by well return a content array, empty when the well holds no
objects of that type, with the objects that pass validation only and without their components, so a count taken
from them can be lower than the number of objects stored for the well. A read by UUID returns the object whatever
its validity, with its components, valid and the validation_errors that tell what to correct.
An object is addressed through the well it belongs to, under another well of the project it is 404. Create returns the UUID
Solo assigns to the new object and its valid. Update changes only the fields that are sent: started_at or
finished_at sent as null clears the date, a number sent as {"undefined": true} clears the number, an empty
name removes the name, a null one keeps it. A type of a hole section or a casing that the project does not have yet is added to the
types of the project. A value Solo cannot store the object without is rejected with 400,
for example CASING_OUTER_DIAMETER_REQUIRED for a casing string without its outer diameter.
Every component needs its type and its own position, 1 or more: the components are read in the order of
position. components of an update is the new set of components: a component with the uuid of a current
component of the object keeps it and changes the other fields that are sent, a component without uuid is added, the current components
missing from the list are deleted. A uuid that is not a current component of the object is rejected with 400.
Without components the components stay as they are. Delete removes the object with its components.
Get hole sections by well
Get the hole sections of a well, ordered from the shallowest to the deepest. top_depth is computed on
read: it is the hole depth of the preceding section, which may itself be omitted, and 0 for the first
section.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/3f1fe75b-c8a9-4299-b79b-11640d5d48e1/hole-sections' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/3f1fe75b-c8a9-4299-b79b-11640d5d48e1/hole-sections HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 905631945a94b647ee3e7b731944fed1
Content-Type: application/json
{
"content" : [ {
"uuid" : "36d4f92f-39e1-42d0-acf8-2db7867e86e0",
"well_id" : "3f1fe75b-c8a9-4299-b79b-11640d5d48e1",
"name" : "",
"type" : "Surface",
"hole_size" : {
"val" : 0.4445
},
"hole_depth" : {
"val" : 600.0
},
"top_depth" : {
"val" : 0.0
},
"started_at" : "2026-03-01T00:00:00Z",
"finished_at" : "2026-03-06T00:00:00Z"
}, {
"uuid" : "c1c408df-aea3-45b3-ae63-cf8978dcbe29",
"well_id" : "3f1fe75b-c8a9-4299-b79b-11640d5d48e1",
"name" : "",
"type" : "Production",
"hole_size" : {
"val" : 0.3112
},
"hole_depth" : {
"val" : 5000.0
},
"top_depth" : {
"val" : 600.0
},
"started_at" : "2026-03-06T00:00:00Z",
"finished_at" : "2026-03-20T00:00:00Z"
} ]
}
GET /public/api/v1/wells/{well_uuid}/hole-sections
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Hole sections of the well |
content[].uuid |
String |
Hole section UUID |
content[].well_id |
String |
UUID of the well the hole section belongs to |
content[].name |
String |
Hole section name |
content[].type |
String |
Hole section type, for example Surface or Production |
content[].hole_size.val |
Number |
Hole diameter, m |
content[].hole_depth.val |
Number |
Depth of the hole section bottom, m |
content[].top_depth.val |
Number |
Depth of the hole section top, m. Computed as the previous section's hole depth |
content[].started_at |
String |
Start of drilling, ISO-8601 |
content[].finished_at |
String |
End of drilling, ISO-8601 |
Get hole section
Get a hole section of a well by UUID, whatever its validity. top_depth is computed as in the list.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/a377d35c-5e40-443b-9147-0d18b81f06da/hole-sections/72da7649-ccd8-4527-86fb-f5449ea793e3' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/a377d35c-5e40-443b-9147-0d18b81f06da/hole-sections/72da7649-ccd8-4527-86fb-f5449ea793e3 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 655323913c253c3008fed985e9485fd6
Content-Type: application/json
{
"uuid" : "72da7649-ccd8-4527-86fb-f5449ea793e3",
"well_id" : "a377d35c-5e40-443b-9147-0d18b81f06da",
"name" : "Surface section",
"type" : "Surface",
"hole_size" : {
"val" : 0.4445
},
"hole_depth" : {
"val" : 600.0
},
"top_depth" : {
"val" : 0.0
},
"started_at" : "2026-03-01T00:00:00Z",
"finished_at" : "2026-03-06T00:00:00Z",
"valid" : true,
"validation_errors" : [ ]
}
GET /public/api/v1/wells/{well_uuid}/hole-sections/{hole_section_uuid}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
hole_section_uuid |
Hole section UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Object UUID |
well_id |
String |
UUID of the well the object belongs to |
name |
String |
Hole section name, an empty string for none |
type |
String |
Hole section type, for example Surface or Production |
hole_size.val |
Number |
Hole diameter, m |
hole_depth.val |
Number |
Depth of the hole section bottom, m. A section without it passes validation only if its hole size is the smallest of the well |
started_at |
String |
Start of drilling, ISO-8601, null on update clears it |
finished_at |
String |
End of drilling, ISO-8601, null on update clears it |
top_depth.val |
Number |
Depth of the hole section top, m. Computed as the previous section's hole depth |
valid |
Boolean |
true if the object passes validation |
validation_errors |
Array |
Why the object does not pass validation, empty when it does |
validation_errors[].field |
String |
Field of the error as the request body names it, for example hole_size |
validation_errors[].code |
String |
Error code, for example REQUIRED or DEPTH_IN_LESS_THAN_DEPTH_OUT |
validation_errors[].related |
Array |
Objects the value conflicts with: uuid, object_type and their value |
Create hole section
Create a hole section in a well. type and hole_size are needed, a section without hole_depth passes validation
only if its hole_size is the smallest of the well.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/e3b6574a-2e7d-4d0e-aa09-bf3e5a0c7a81/hole-sections' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Surface section",
"type" : "Surface",
"hole_size" : {
"val" : 0.4445
},
"hole_depth" : {
"val" : 600.0
},
"started_at" : "2026-03-01T00:00:00Z",
"finished_at" : "2026-03-06T00:00:00Z"
}'
POST /public/api/v1/wells/e3b6574a-2e7d-4d0e-aa09-bf3e5a0c7a81/hole-sections HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 221
{
"name" : "Surface section",
"type" : "Surface",
"hole_size" : {
"val" : 0.4445
},
"hole_depth" : {
"val" : 600.0
},
"started_at" : "2026-03-01T00:00:00Z",
"finished_at" : "2026-03-06T00:00:00Z"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3c9313759ad5abc986365d599e15629c
Content-Type: application/json
{
"uuid" : "d7f52207-3c83-4439-a00d-2ba6a7cb19d3",
"valid" : true
}
POST /public/api/v1/wells/{well_uuid}/hole-sections
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Hole section name, an empty string for none |
type |
String |
Hole section type, for example Surface or Production |
hole_size.val |
Number |
Hole diameter, m |
hole_depth.val |
Number |
Depth of the hole section bottom, m. A section without it passes validation only if its hole size is the smallest of the well |
started_at |
String |
Start of drilling, ISO-8601, null on update clears it |
finished_at |
String |
End of drilling, ISO-8601, null on update clears it |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
UUID of the new object |
valid |
Boolean |
true if the object passes validation, only then the list of the well returns it |
Update hole section
Update a hole section of a well, the fields that are not sent keep their values.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/5eb97a33-0ec6-4922-a047-e0824a331c63/hole-sections/a7b1c9c8-cf3b-4239-8c2c-c4e31aa002fb' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Surface hole",
"hole_depth" : {
"val" : 650.0
},
"finished_at" : "2026-03-07T00:00:00Z"
}'
PATCH /public/api/v1/wells/5eb97a33-0ec6-4922-a047-e0824a331c63/hole-sections/a7b1c9c8-cf3b-4239-8c2c-c4e31aa002fb HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 113
{
"name" : "Surface hole",
"hole_depth" : {
"val" : 650.0
},
"finished_at" : "2026-03-07T00:00:00Z"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: dcf8834550463004ca5818c44784c17d
PATCH /public/api/v1/wells/{well_uuid}/hole-sections/{hole_section_uuid}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
hole_section_uuid |
Hole section UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Hole section name, an empty string for none |
type |
String |
Hole section type, for example Surface or Production |
hole_size.val |
Number |
Hole diameter, m |
hole_depth.val |
Number |
Depth of the hole section bottom, m. A section without it passes validation only if its hole size is the smallest of the well |
started_at |
String |
Start of drilling, ISO-8601, null on update clears it |
finished_at |
String |
End of drilling, ISO-8601, null on update clears it |
Response body
Empty body
Delete hole section
Delete a hole section of a well.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/ad897edf-c3ae-4c80-a4fa-2604078e545c/hole-sections/c161e1f3-c9fb-4101-bac3-38d1aa012072' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/wells/ad897edf-c3ae-4c80-a4fa-2604078e545c/hole-sections/c161e1f3-c9fb-4101-bac3-38d1aa012072 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 0c05e8cc690ac330e51007b7d949ab76
DELETE /public/api/v1/wells/{well_uuid}/hole-sections/{hole_section_uuid}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
hole_section_uuid |
Hole section UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Get BHA runs by well
Get the BHA runs of a well, ordered by run_number.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/3f1fe75b-c8a9-4299-b79b-11640d5d48e1/bha-runs' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/3f1fe75b-c8a9-4299-b79b-11640d5d48e1/bha-runs HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 1d102ccc4f6f2be17bde1a8c0b1a06ca
Content-Type: application/json
{
"content" : [ {
"uuid" : "fd0354d0-4a39-45aa-89d2-0d2e9c14f85c",
"well_id" : "3f1fe75b-c8a9-4299-b79b-11640d5d48e1",
"name" : "",
"run_number" : 1,
"type" : "DRILLING",
"bha_type" : "MUD_MOTOR",
"hole_size" : {
"val" : 0.4445
},
"depth_in" : {
"val" : 0.0
},
"depth_out" : {
"val" : 600.0
},
"max_outer_diameter" : {
"val" : 0.4445
},
"started_at" : "2026-03-01T06:00:00Z",
"finished_at" : "2026-03-04T00:00:00Z",
"reason_pulled" : "TD",
"description" : "Surface hole drilled to casing point",
"sliding_rpm" : {
"val" : 60.0
}
}, {
"uuid" : "cdf81e94-1fe4-459a-b4bc-a5206b60618f",
"well_id" : "3f1fe75b-c8a9-4299-b79b-11640d5d48e1",
"name" : "",
"run_number" : 2,
"type" : "DRILLING",
"bha_type" : "ROTOSTEER_PLUS_MUD_MOTOR",
"hole_size" : {
"val" : 0.3112
},
"depth_in" : {
"val" : 600.0
},
"depth_out" : {
"val" : 5000.0
},
"max_outer_diameter" : {
"val" : 0.3112
},
"started_at" : "2026-03-08T00:00:00Z",
"finished_at" : "2026-03-18T00:00:00Z",
"reason_pulled" : "TD",
"description" : "Production hole drilled to total depth",
"sliding_rpm" : {
"val" : 45.0
}
} ]
}
GET /public/api/v1/wells/{well_uuid}/bha-runs
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
BHA runs of the well |
content[].uuid |
String |
BHA run UUID |
content[].well_id |
String |
UUID of the well the BHA run belongs to |
content[].name |
String |
BHA run name |
content[].run_number |
Number |
Sequential number of the run within the well |
content[].type |
String |
Run type: DRILLING, HOLE_CONDITIONING, LOGGING or OTHER |
content[].bha_type |
String |
Assembly type: MUD_MOTOR, RSS, MUD_MOTOR_PLUS_RSS, ROTARY or ROTOSTEER_PLUS_MUD_MOTOR |
content[].hole_size.val |
Number |
Hole diameter the run was made in, m |
content[].depth_in.val |
Number |
Depth the run started at, m |
content[].depth_out.val |
Number |
Depth the run ended at, m |
content[].max_outer_diameter.val |
Number |
Largest of the max outer diameters of the run's components, m |
content[].started_at |
String |
Start of the run, ISO-8601 |
content[].finished_at |
String |
End of the run, ISO-8601 |
content[].reason_pulled |
String |
Why the assembly was pulled: TD, BHA_FAILURE, LOW_ROP or OTHER |
content[].description |
String |
Free-form comment |
content[].sliding_rpm.val |
Number |
Rotation speed while sliding, rpm |
Get BHA run
Get a BHA run of a well by UUID with its components, whatever its validity.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/943f2fcc-a7fb-408d-bf59-19e98329faf4/bha-runs/e216a532-aa86-45b9-9354-f1757bd17c4b' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/943f2fcc-a7fb-408d-bf59-19e98329faf4/bha-runs/e216a532-aa86-45b9-9354-f1757bd17c4b HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: f29eda3f8c313b71a9ee12e7c48749c2
Content-Type: application/json
{
"uuid" : "e216a532-aa86-45b9-9354-f1757bd17c4b",
"well_id" : "943f2fcc-a7fb-408d-bf59-19e98329faf4",
"name" : "Production run 1",
"run_number" : 1,
"type" : "DRILLING",
"bha_type" : "MUD_MOTOR",
"hole_size" : {
"val" : 0.3112
},
"depth_in" : {
"val" : 600.0
},
"depth_out" : {
"val" : 2500.0
},
"max_outer_diameter" : {
"val" : 0.3112
},
"started_at" : "2026-03-08T00:00:00Z",
"finished_at" : "2026-03-12T00:00:00Z",
"reason_pulled" : "TD",
"description" : "Drilled to the casing point",
"sliding_rpm" : {
"val" : 60.0
},
"valid" : true,
"validation_errors" : [ ],
"components" : [ {
"uuid" : "f32c993a-a242-4e0e-9724-6adf07fce445",
"position" : 1,
"type" : "BIT",
"material" : "Steel",
"description" : "BIT of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.3112
},
"inner_diameter" : {
"val" : 0.2612
},
"max_outer_diameter" : {
"val" : 0.3112
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
},
"valid" : true,
"validation_errors" : [ ]
}, {
"uuid" : "a0f23b3e-05aa-42c1-954e-2cfc05855edc",
"position" : 2,
"type" : "MUD_MOTOR",
"material" : "Steel",
"description" : "MUD_MOTOR of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2032
},
"inner_diameter" : {
"val" : 0.1532
},
"max_outer_diameter" : {
"val" : 0.2032
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
},
"valid" : true,
"validation_errors" : [ ]
} ]
}
GET /public/api/v1/wells/{well_uuid}/bha-runs/{bha_run_uuid}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
bha_run_uuid |
BHA run UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Object UUID |
well_id |
String |
UUID of the well the object belongs to |
name |
String |
BHA run name, an empty string for none |
type |
String |
Run type: DRILLING, HOLE_CONDITIONING, LOGGING or OTHER |
hole_size.val |
Number |
Hole diameter the run is made in, m |
bha_type |
String |
Assembly type: MUD_MOTOR, RSS, MUD_MOTOR_PLUS_RSS, ROTARY or ROTOSTEER_PLUS_MUD_MOTOR. A run without it does not pass validation |
depth_in.val |
Number |
Depth the run starts at, m. A run without it does not pass validation |
depth_out.val |
Number |
Depth the run ends at, m |
sliding_rpm.val |
Number |
Rotation speed while sliding, rpm |
started_at |
String |
Start of the run, ISO-8601, null on update clears it |
finished_at |
String |
End of the run, ISO-8601, null on update clears it |
reason_pulled |
String |
Why the assembly was pulled: TD, BHA_FAILURE, LOW_ROP or OTHER |
description |
String |
Free-form comment, up to 200 characters |
run_number |
Number |
Sequential number of the run within the well |
max_outer_diameter.val |
Number |
Largest of the max outer diameters of the run's components, m |
valid |
Boolean |
true if the object passes validation |
validation_errors |
Array |
Why the object does not pass validation, empty when it does |
validation_errors[].field |
String |
Field of the error as the request body names it, for example hole_size |
validation_errors[].code |
String |
Error code, for example REQUIRED or DEPTH_IN_LESS_THAN_DEPTH_OUT |
validation_errors[].related |
Array |
Objects the value conflicts with: uuid, object_type and their value |
components |
Array |
Components of the object, in the order of position |
components[].uuid |
String |
Component UUID |
components[].valid |
Boolean |
true if the component passes validation |
components[].validation_errors |
Array |
Why the component does not pass validation, empty when it does |
components[].type |
String |
Component type: ACCELERATOR, AGITATOR, BENT_SUB, BIT, CASING, CASING_SHOE, CROSSOVER, DRILL_COLLAR, DRILL_PIPE, FLEX_COLLAR, FLOAT_COLLAR, HOLE_OPENER, HWDP, JAR, LWD, MISC_SUB, MUD_MOTOR, MWD, REAMER, ROTARY_STEERABLE, STABILIZER or TURBINE |
components[].position |
Number |
Order in the object, from 1, unique |
components[].material |
String |
Material |
components[].description |
String |
Free-form comment |
components[].manufacturer |
String |
Manufacturer |
components[].outer_diameter.val |
Number |
Outer diameter, m |
components[].inner_diameter.val |
Number |
Inner diameter, m |
components[].max_outer_diameter.val |
Number |
Largest outer diameter, m |
components[].length.val |
Number |
Length, m |
components[].weight.val |
Number |
Weight, SI units |
components[].linear_weight.val |
Number |
Weight per length, SI units |
components[].density.val |
Number |
Material density, kg/m3 |
components[].non_magnetic |
Boolean |
true for a non-magnetic component |
components[].young_modulus.val |
Number |
Young's modulus of the material, SI units |
components[].poisson_ratio.val |
Number |
Poisson's ratio of the material |
components[].top_mut.val |
Number |
Make-up torque of the top connection, SI units |
components[].bot_mut.val |
Number |
Make-up torque of the bottom connection, SI units |
Create BHA run
Create a BHA run in a well, with its components. type and hole_size are needed. Solo gives the run the next
run_number of the well and computes max_outer_diameter from the components.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/d682af63-2e24-4712-a1e9-5f462a959ece/bha-runs' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Production run 1",
"type" : "DRILLING",
"bha_type" : "MUD_MOTOR",
"hole_size" : {
"val" : 0.3112
},
"depth_in" : {
"val" : 600.0
},
"depth_out" : {
"val" : 2500.0
},
"sliding_rpm" : {
"val" : 60.0
},
"started_at" : "2026-03-08T00:00:00Z",
"finished_at" : "2026-03-12T00:00:00Z",
"reason_pulled" : "TD",
"description" : "Drilled to the casing point",
"components" : [ {
"type" : "BIT",
"position" : 1,
"material" : "Steel",
"description" : "BIT of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.3112
},
"inner_diameter" : {
"val" : 0.2612
},
"max_outer_diameter" : {
"val" : 0.3112
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
}, {
"type" : "MUD_MOTOR",
"position" : 2,
"material" : "Steel",
"description" : "MUD_MOTOR of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2032
},
"inner_diameter" : {
"val" : 0.1532
},
"max_outer_diameter" : {
"val" : 0.2032
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
} ]
}'
POST /public/api/v1/wells/d682af63-2e24-4712-a1e9-5f462a959ece/bha-runs HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 1883
{
"name" : "Production run 1",
"type" : "DRILLING",
"bha_type" : "MUD_MOTOR",
"hole_size" : {
"val" : 0.3112
},
"depth_in" : {
"val" : 600.0
},
"depth_out" : {
"val" : 2500.0
},
"sliding_rpm" : {
"val" : 60.0
},
"started_at" : "2026-03-08T00:00:00Z",
"finished_at" : "2026-03-12T00:00:00Z",
"reason_pulled" : "TD",
"description" : "Drilled to the casing point",
"components" : [ {
"type" : "BIT",
"position" : 1,
"material" : "Steel",
"description" : "BIT of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.3112
},
"inner_diameter" : {
"val" : 0.2612
},
"max_outer_diameter" : {
"val" : 0.3112
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
}, {
"type" : "MUD_MOTOR",
"position" : 2,
"material" : "Steel",
"description" : "MUD_MOTOR of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2032
},
"inner_diameter" : {
"val" : 0.1532
},
"max_outer_diameter" : {
"val" : 0.2032
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: a7ada1cf9ed11265387ade22c205e2ca
Content-Type: application/json
{
"uuid" : "2dd75027-c6c6-4c1e-84b9-b18d684e55a7",
"valid" : true
}
POST /public/api/v1/wells/{well_uuid}/bha-runs
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
BHA run name, an empty string for none |
type |
String |
Run type: DRILLING, HOLE_CONDITIONING, LOGGING or OTHER |
hole_size.val |
Number |
Hole diameter the run is made in, m |
bha_type |
String |
Assembly type: MUD_MOTOR, RSS, MUD_MOTOR_PLUS_RSS, ROTARY or ROTOSTEER_PLUS_MUD_MOTOR. A run without it does not pass validation |
depth_in.val |
Number |
Depth the run starts at, m. A run without it does not pass validation |
depth_out.val |
Number |
Depth the run ends at, m |
sliding_rpm.val |
Number |
Rotation speed while sliding, rpm |
started_at |
String |
Start of the run, ISO-8601, null on update clears it |
finished_at |
String |
End of the run, ISO-8601, null on update clears it |
reason_pulled |
String |
Why the assembly was pulled: TD, BHA_FAILURE, LOW_ROP or OTHER |
description |
String |
Free-form comment, up to 200 characters |
components |
Array |
Components of the object, in the order of position |
components[].type |
String |
Component type: ACCELERATOR, AGITATOR, BENT_SUB, BIT, CASING, CASING_SHOE, CROSSOVER, DRILL_COLLAR, DRILL_PIPE, FLEX_COLLAR, FLOAT_COLLAR, HOLE_OPENER, HWDP, JAR, LWD, MISC_SUB, MUD_MOTOR, MWD, REAMER, ROTARY_STEERABLE, STABILIZER or TURBINE |
components[].position |
Number |
Order in the object, from 1, unique |
components[].material |
String |
Material |
components[].description |
String |
Free-form comment |
components[].manufacturer |
String |
Manufacturer |
components[].outer_diameter.val |
Number |
Outer diameter, m |
components[].inner_diameter.val |
Number |
Inner diameter, m |
components[].max_outer_diameter.val |
Number |
Largest outer diameter, m |
components[].length.val |
Number |
Length, m |
components[].weight.val |
Number |
Weight, SI units |
components[].linear_weight.val |
Number |
Weight per length, SI units |
components[].density.val |
Number |
Material density, kg/m3 |
components[].non_magnetic |
Boolean |
true for a non-magnetic component |
components[].young_modulus.val |
Number |
Young's modulus of the material, SI units |
components[].poisson_ratio.val |
Number |
Poisson's ratio of the material |
components[].top_mut.val |
Number |
Make-up torque of the top connection, SI units |
components[].bot_mut.val |
Number |
Make-up torque of the bottom connection, SI units |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
UUID of the new object |
valid |
Boolean |
true if the object passes validation, only then the list of the well returns it |
Update BHA run
Update a BHA run of a well, the fields that are not sent keep their values. run_number does not change.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/e7e4f7ba-dede-453e-a5cc-e372ccd5dba5/bha-runs/5349d456-8d02-4505-aff8-38a76d3966b1' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"depth_out" : {
"val" : 2600.0
},
"reason_pulled" : "BHA_FAILURE",
"components" : [ {
"uuid" : "44d26bb9-f7df-4685-898e-7ff02c0907ef",
"type" : "BIT",
"position" : 1,
"outer_diameter" : {
"val" : 0.3112
}
}, {
"type" : "ROTARY_STEERABLE",
"position" : 2,
"material" : "Steel",
"description" : "ROTARY_STEERABLE of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2032
},
"inner_diameter" : {
"val" : 0.1532
},
"max_outer_diameter" : {
"val" : 0.2032
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
} ]
}'
PATCH /public/api/v1/wells/e7e4f7ba-dede-453e-a5cc-e372ccd5dba5/bha-runs/5349d456-8d02-4505-aff8-38a76d3966b1 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 999
{
"depth_out" : {
"val" : 2600.0
},
"reason_pulled" : "BHA_FAILURE",
"components" : [ {
"uuid" : "44d26bb9-f7df-4685-898e-7ff02c0907ef",
"type" : "BIT",
"position" : 1,
"outer_diameter" : {
"val" : 0.3112
}
}, {
"type" : "ROTARY_STEERABLE",
"position" : 2,
"material" : "Steel",
"description" : "ROTARY_STEERABLE of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2032
},
"inner_diameter" : {
"val" : 0.1532
},
"max_outer_diameter" : {
"val" : 0.2032
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 98d287a287334bdba4bcf1e73f7b3baa
PATCH /public/api/v1/wells/{well_uuid}/bha-runs/{bha_run_uuid}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
bha_run_uuid |
BHA run UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
BHA run name, an empty string for none |
type |
String |
Run type: DRILLING, HOLE_CONDITIONING, LOGGING or OTHER |
hole_size.val |
Number |
Hole diameter the run is made in, m |
bha_type |
String |
Assembly type: MUD_MOTOR, RSS, MUD_MOTOR_PLUS_RSS, ROTARY or ROTOSTEER_PLUS_MUD_MOTOR. A run without it does not pass validation |
depth_in.val |
Number |
Depth the run starts at, m. A run without it does not pass validation |
depth_out.val |
Number |
Depth the run ends at, m |
sliding_rpm.val |
Number |
Rotation speed while sliding, rpm |
started_at |
String |
Start of the run, ISO-8601, null on update clears it |
finished_at |
String |
End of the run, ISO-8601, null on update clears it |
reason_pulled |
String |
Why the assembly was pulled: TD, BHA_FAILURE, LOW_ROP or OTHER |
description |
String |
Free-form comment, up to 200 characters |
components |
Array |
The new set of components: a current component missing from it is deleted, without this field the components stay as they are |
components[].uuid |
String |
UUID of a current component of the object to keep it, omit it for a new component |
components[].type |
String |
Component type: ACCELERATOR, AGITATOR, BENT_SUB, BIT, CASING, CASING_SHOE, CROSSOVER, DRILL_COLLAR, DRILL_PIPE, FLEX_COLLAR, FLOAT_COLLAR, HOLE_OPENER, HWDP, JAR, LWD, MISC_SUB, MUD_MOTOR, MWD, REAMER, ROTARY_STEERABLE, STABILIZER or TURBINE |
components[].position |
Number |
Order in the object, from 1, unique |
components[].material |
String |
Material |
components[].description |
String |
Free-form comment |
components[].manufacturer |
String |
Manufacturer |
components[].outer_diameter.val |
Number |
Outer diameter, m |
components[].inner_diameter.val |
Number |
Inner diameter, m |
components[].max_outer_diameter.val |
Number |
Largest outer diameter, m |
components[].length.val |
Number |
Length, m |
components[].weight.val |
Number |
Weight, SI units |
components[].linear_weight.val |
Number |
Weight per length, SI units |
components[].density.val |
Number |
Material density, kg/m3 |
components[].non_magnetic |
Boolean |
true for a non-magnetic component |
components[].young_modulus.val |
Number |
Young's modulus of the material, SI units |
components[].poisson_ratio.val |
Number |
Poisson's ratio of the material |
components[].top_mut.val |
Number |
Make-up torque of the top connection, SI units |
components[].bot_mut.val |
Number |
Make-up torque of the bottom connection, SI units |
Response body
Empty body
Delete BHA run
Delete a BHA run of a well with its components. The numbers of the other runs do not change.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/e4f1d6e4-d9eb-42e2-8b9a-b90324b9c9eb/bha-runs/5b92b81f-d85e-4d1a-837e-7a48145197da' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/wells/e4f1d6e4-d9eb-42e2-8b9a-b90324b9c9eb/bha-runs/5b92b81f-d85e-4d1a-837e-7a48145197da HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 8aa5ecb17fab0aded7d7a7cd96edcc27
DELETE /public/api/v1/wells/{well_uuid}/bha-runs/{bha_run_uuid}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
bha_run_uuid |
BHA run UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Get BHA run torque and drag models
Get the torque and drag models of a BHA run, the calculated model first.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/fd6b3270-58a9-4260-ad9f-4c625be2f7cb/bha-runs/d17a3fec-7518-4682-b362-c47bef50c2f4/torque-drag-models' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/fd6b3270-58a9-4260-ad9f-4c625be2f7cb/bha-runs/d17a3fec-7518-4682-b362-c47bef50c2f4/torque-drag-models HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: faf37bb90f2c465cf4e7ac7a03a8672b
Content-Type: application/json
{
"content" : [ {
"model_id" : "e2137538-aabc-44c8-b538-bd6ccfb1c05f",
"name" : "auto",
"data_type" : "CALCULATED_BROOMSTICK",
"created_at" : "2026-11-16T07:27:03.722583Z",
"updated_at" : "2026-11-16T07:27:03.722583Z"
}, {
"model_id" : "871a2927-bd83-49b8-a4f6-b90ff4100afe",
"name" : "report.csv",
"data_type" : "USER_BROOMSTICK",
"created_at" : "2026-11-16T07:27:04.179874Z",
"updated_at" : "2026-11-16T07:27:04.179874Z"
} ]
}
GET /public/api/v1/wells/{well_uuid}/bha-runs/{bha_run_uuid}/torque-drag-models
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
bha_run_uuid |
BHA run UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Torque and drag models: at most one calculated model, listed first, then imported ones from the newest |
content[].model_id |
String |
Model UUID |
content[].name |
String |
Display name, not unique: auto for the calculated model, the file name for an imported one |
content[].data_type |
String |
Model kind, use it to tell models apart: CALCULATED_BROOMSTICK for the calculated model, USER_BROOMSTICK for an imported one |
content[].created_at |
String |
Creation time, ISO-8601 |
content[].updated_at |
String |
Last update time, ISO-8601 |
Get BHA run torque and drag model
Get a torque and drag model of a BHA run with its curves.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/fd6b3270-58a9-4260-ad9f-4c625be2f7cb/bha-runs/d17a3fec-7518-4682-b362-c47bef50c2f4/torque-drag-models/e2137538-aabc-44c8-b538-bd6ccfb1c05f' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/fd6b3270-58a9-4260-ad9f-4c625be2f7cb/bha-runs/d17a3fec-7518-4682-b362-c47bef50c2f4/torque-drag-models/e2137538-aabc-44c8-b538-bd6ccfb1c05f HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 1db350c8e1b8c1a14a37a44c8f067f6f
Content-Type: application/json
{
"model_id" : "e2137538-aabc-44c8-b538-bd6ccfb1c05f",
"data_type" : "CALCULATED_BROOMSTICK",
"updated_at" : "2026-11-16T07:27:03.722583Z",
"start" : 0.0,
"end" : 27.229999896,
"block_weight" : null,
"hoist_limit" : null,
"torque_limit" : null,
"curves" : [ {
"mode" : "PU",
"friction_factor" : 0.1,
"points" : [ {
"index" : 0.0,
"hookload" : 38247.66,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29906.27,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.1,
"points" : [ {
"index" : 0.0,
"hookload" : 38213.98,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29890.75,
"torque" : null
} ]
}, {
"mode" : "PU",
"friction_factor" : 0.2,
"points" : [ {
"index" : 0.0,
"hookload" : 38264.51,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29914.03,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.2,
"points" : [ {
"index" : 0.0,
"hookload" : 38197.15,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29882.99,
"torque" : null
} ]
}, {
"mode" : "PU",
"friction_factor" : 0.3,
"points" : [ {
"index" : 0.0,
"hookload" : 38281.36,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29921.79,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.3,
"points" : [ {
"index" : 0.0,
"hookload" : 38180.33,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29875.24,
"torque" : null
} ]
}, {
"mode" : "PU",
"friction_factor" : 0.4,
"points" : [ {
"index" : 0.0,
"hookload" : 38298.22,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29929.55,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.4,
"points" : [ {
"index" : 0.0,
"hookload" : 38163.52,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29867.48,
"torque" : null
} ]
}, {
"mode" : "PU",
"friction_factor" : 0.5,
"points" : [ {
"index" : 0.0,
"hookload" : 38315.09,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29937.32,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.5,
"points" : [ {
"index" : 0.0,
"hookload" : 38146.71,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29859.72,
"torque" : null
} ]
}, {
"mode" : "ROB",
"friction_factor" : null,
"points" : [ {
"index" : 0.0,
"hookload" : 38230.82,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29898.51,
"torque" : null
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.1,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 1.58
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 0.75
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.2,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 3.16
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 1.5
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.3,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 4.74
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 2.24
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.4,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 6.32
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 2.99
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.5,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 7.89
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 3.74
} ]
} ]
}
GET /public/api/v1/wells/{well_uuid}/bha-runs/{bha_run_uuid}/torque-drag-models/{model_id}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
bha_run_uuid |
BHA run UUID |
model_id |
Model UUID from the model list |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
model_id |
String |
Model UUID |
data_type |
String |
Model kind, use it to tell models apart: CALCULATED_BROOMSTICK for the calculated model, USER_BROOMSTICK for an imported one |
updated_at |
String |
Last update time, ISO-8601 |
start |
Number |
Top of the measured-depth range the model covers, m |
end |
Number |
Deepest bit position the model was computed for, m. Can be shallower than the hole depth |
block_weight |
Number |
Block weight, N |
hoist_limit |
Number |
Hoisting limit, N |
torque_limit |
Number |
Torque limit, N*m |
curves |
Array |
Model curves, empty when nothing has been computed |
curves[].mode |
String |
PU (pick up), SO (slack off) or ROB (rotating off bottom) |
curves[].friction_factor |
Number |
Friction factor, null for the ROB hookload curve |
curves[].points |
Array |
Curve points, ordered by index |
curves[].points[].index |
Number |
Distance from the deepest bit position to the bit, m |
curves[].points[].hookload |
Number |
Hookload, N. Null where the curve carries torque |
curves[].points[].torque |
Number |
Torque, N*m. Null where the curve carries hookload |
Get casings by well
Get the casings of a well, ordered by casing_top, then by shoe_depth.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/3f1fe75b-c8a9-4299-b79b-11640d5d48e1/casings' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/3f1fe75b-c8a9-4299-b79b-11640d5d48e1/casings HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4ccc46a09ec48647098691da906d3cd7
Content-Type: application/json
{
"content" : [ {
"uuid" : "04629acc-d1eb-443c-affb-84d012cd6507",
"well_id" : "3f1fe75b-c8a9-4299-b79b-11640d5d48e1",
"name" : "",
"type" : "Conductor",
"outer_diameter" : {
"val" : 0.3397
},
"hole_size" : {
"val" : 0.4445
},
"inner_diameter" : {
"val" : 0.3151
},
"casing_top" : {
"val" : 0.0
},
"shoe_depth" : {
"val" : 600.0
},
"string_type" : "Casing",
"drift_diameter" : {
"val" : 0.3151
},
"started_at" : "2026-03-04T00:00:00Z",
"finished_at" : "2026-03-05T12:00:00Z",
"centralizers" : [ {
"type" : "RIGID",
"top_to_shoe" : 120.0,
"devices_per_joints" : "1/1"
} ],
"floatation_type" : "BOTTOM_UP",
"fluid_density" : {
"val" : 1200.0
},
"air_density" : {
"val" : 1.2
},
"floatation_sub_from_bottom" : {
"val" : 250.0
}
}, {
"uuid" : "1ab70e4f-e37c-4592-b50d-ba024bde154f",
"well_id" : "3f1fe75b-c8a9-4299-b79b-11640d5d48e1",
"name" : "",
"type" : "Production",
"outer_diameter" : {
"val" : 0.2445
},
"hole_size" : {
"val" : 0.3112
},
"inner_diameter" : {
"val" : 0.2205
},
"casing_top" : {
"val" : 0.0
},
"shoe_depth" : {
"val" : 5000.0
},
"string_type" : "Casing",
"drift_diameter" : {
"val" : 0.2205
},
"started_at" : "2026-03-18T00:00:00Z",
"finished_at" : "2026-03-19T12:00:00Z",
"centralizers" : [ {
"type" : "RIGID",
"top_to_shoe" : 120.0,
"devices_per_joints" : "1/1"
} ],
"floatation_type" : "BOTTOM_UP",
"fluid_density" : {
"val" : 1200.0
},
"air_density" : {
"val" : 1.2
},
"floatation_sub_from_bottom" : {
"val" : 250.0
}
} ]
}
GET /public/api/v1/wells/{well_uuid}/casings
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Casings of the well |
content[].uuid |
String |
Casing UUID |
content[].well_id |
String |
UUID of the well the casing belongs to |
content[].name |
String |
Casing name |
content[].type |
String |
Casing type, for example Conductor or Production |
content[].string_type |
String |
String type: Casing, Liner or Open Hole |
content[].outer_diameter.val |
Number |
Outer diameter, m |
content[].inner_diameter.val |
Number |
Inner diameter, m |
content[].drift_diameter.val |
Number |
Smallest inner diameter among the casing's components, m |
content[].hole_size.val |
Number |
Diameter of the hole the casing was run in, m |
content[].casing_top.val |
Number |
Depth of the casing top, m |
content[].shoe_depth.val |
Number |
Depth of the casing shoe, m |
content[].started_at |
String |
Start of running the casing, ISO-8601 |
content[].finished_at |
String |
End of running the casing, ISO-8601 |
content[].centralizers |
Array |
Centralizer intervals |
content[].floatation_type |
String |
Floatation type |
content[].fluid_density.val |
Number |
Floatation fluid density, kg/m3 |
content[].air_density.val |
Number |
Floatation air density, kg/m3 |
content[].floatation_sub_from_bottom.val |
Number |
Distance from the shoe to the floatation sub, m |
Get casing
Get a casing of a well by UUID with its components, whatever its validity. drift_diameter is computed from the
components.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/c2e349dc-d7a1-471f-8169-b854c88e484e/casings/d164ed02-63aa-452e-8b81-c1d33f13ee5f' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/c2e349dc-d7a1-471f-8169-b854c88e484e/casings/d164ed02-63aa-452e-8b81-c1d33f13ee5f HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 0270198c4f61a1f9fcf7997b001a62bf
Content-Type: application/json
{
"uuid" : "d164ed02-63aa-452e-8b81-c1d33f13ee5f",
"well_id" : "c2e349dc-d7a1-471f-8169-b854c88e484e",
"name" : "Intermediate casing",
"type" : "Intermediate",
"outer_diameter" : {
"val" : 0.2445
},
"hole_size" : {
"val" : 0.3112
},
"inner_diameter" : {
"val" : 0.2205
},
"casing_top" : {
"val" : 0.0
},
"shoe_depth" : {
"val" : 2400.0
},
"string_type" : "Casing",
"drift_diameter" : {
"val" : 0.1945
},
"started_at" : "2026-03-12T00:00:00Z",
"finished_at" : "2026-03-13T12:00:00Z",
"centralizers" : [ {
"type" : "RIGID",
"top_to_shoe" : 120.0,
"bottom_to_shoe" : 0.0,
"devices_per_joints" : "1/2"
} ],
"floatation_type" : "BOTTOM_UP",
"fluid_density" : {
"val" : 1200.0
},
"air_density" : {
"val" : 1.2
},
"floatation_sub_from_bottom" : {
"val" : 250.0
},
"valid" : true,
"validation_errors" : [ ],
"components" : [ {
"uuid" : "4d033a3e-4931-47a1-b5d1-95391fadaedd",
"position" : 1,
"type" : "CASING",
"material" : "Steel",
"description" : "CASING of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.1945
},
"max_outer_diameter" : {
"val" : 0.2445
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
},
"valid" : true,
"validation_errors" : [ ]
}, {
"uuid" : "6c2bf729-0fc2-4505-9084-c400a529cb34",
"position" : 2,
"type" : "CASING_SHOE",
"material" : "Steel",
"description" : "CASING_SHOE of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.1945
},
"max_outer_diameter" : {
"val" : 0.2445
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
},
"valid" : true,
"validation_errors" : [ ]
} ]
}
GET /public/api/v1/wells/{well_uuid}/casings/{casing_uuid}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
casing_uuid |
Casing UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Object UUID |
well_id |
String |
UUID of the well the object belongs to |
name |
String |
Casing name, an empty string for none |
type |
String |
Casing type, for example Conductor or Production |
string_type |
String |
String type: Casing, Liner or Open Hole. A Casing or Liner needs outer_diameter, an Open Hole needs hole_size |
outer_diameter.val |
Number |
Outer diameter, m |
inner_diameter.val |
Number |
Inner diameter, m. Needed to pass validation, except for an Open Hole |
hole_size.val |
Number |
Diameter of the hole the casing is run in, m |
casing_top.val |
Number |
Depth of the casing top, m. Needed to pass validation, except for an Open Hole |
shoe_depth.val |
Number |
Depth of the casing shoe, m. A casing without it does not pass validation |
started_at |
String |
Start of running the casing, ISO-8601, null on update clears it |
finished_at |
String |
End of running the casing, ISO-8601, null on update clears it |
centralizers |
Array |
Centralizer intervals, up to 10, stored and returned as sent |
floatation_type |
String |
Floatation type, up to 50 characters |
fluid_density.val |
Number |
Floatation fluid density, kg/m3 |
air_density.val |
Number |
Floatation air density, kg/m3 |
floatation_sub_from_bottom.val |
Number |
Distance from the shoe to the floatation sub, m |
drift_diameter.val |
Number |
Smallest inner diameter among the casing's components, m |
valid |
Boolean |
true if the object passes validation |
validation_errors |
Array |
Why the object does not pass validation, empty when it does |
validation_errors[].field |
String |
Field of the error as the request body names it, for example hole_size |
validation_errors[].code |
String |
Error code, for example REQUIRED or DEPTH_IN_LESS_THAN_DEPTH_OUT |
validation_errors[].related |
Array |
Objects the value conflicts with: uuid, object_type and their value |
components |
Array |
Components of the object, in the order of position |
components[].uuid |
String |
Component UUID |
components[].valid |
Boolean |
true if the component passes validation |
components[].validation_errors |
Array |
Why the component does not pass validation, empty when it does |
components[].type |
String |
Component type: ACCELERATOR, AGITATOR, BENT_SUB, BIT, CASING, CASING_SHOE, CROSSOVER, DRILL_COLLAR, DRILL_PIPE, FLEX_COLLAR, FLOAT_COLLAR, HOLE_OPENER, HWDP, JAR, LWD, MISC_SUB, MUD_MOTOR, MWD, REAMER, ROTARY_STEERABLE, STABILIZER or TURBINE |
components[].position |
Number |
Order in the object, from 1, unique |
components[].material |
String |
Material |
components[].description |
String |
Free-form comment |
components[].manufacturer |
String |
Manufacturer |
components[].outer_diameter.val |
Number |
Outer diameter, m |
components[].inner_diameter.val |
Number |
Inner diameter, m |
components[].max_outer_diameter.val |
Number |
Largest outer diameter, m |
components[].length.val |
Number |
Length, m |
components[].weight.val |
Number |
Weight, SI units |
components[].linear_weight.val |
Number |
Weight per length, SI units |
components[].density.val |
Number |
Material density, kg/m3 |
components[].non_magnetic |
Boolean |
true for a non-magnetic component |
components[].young_modulus.val |
Number |
Young's modulus of the material, SI units |
components[].poisson_ratio.val |
Number |
Poisson's ratio of the material |
components[].top_mut.val |
Number |
Make-up torque of the top connection, SI units |
components[].bot_mut.val |
Number |
Make-up torque of the bottom connection, SI units |
Create casing
Create a casing in a well, with its components. type is needed, and outer_diameter for a Casing or a Liner
string or hole_size for an Open Hole one. string_type may be omitted, then outer_diameter is needed.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/3227b6f8-8b56-4ec5-bd05-d22d7a8c9224/casings' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Intermediate casing",
"type" : "Intermediate",
"string_type" : "Casing",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.2205
},
"hole_size" : {
"val" : 0.3112
},
"casing_top" : {
"val" : 0.0
},
"shoe_depth" : {
"val" : 2400.0
},
"started_at" : "2026-03-12T00:00:00Z",
"finished_at" : "2026-03-13T12:00:00Z",
"centralizers" : [ {
"type" : "RIGID",
"top_to_shoe" : 120.0,
"bottom_to_shoe" : 0.0,
"devices_per_joints" : "1/2"
} ],
"floatation_type" : "BOTTOM_UP",
"fluid_density" : {
"val" : 1200.0
},
"air_density" : {
"val" : 1.2
},
"floatation_sub_from_bottom" : {
"val" : 250.0
},
"components" : [ {
"type" : "CASING",
"position" : 1,
"material" : "Steel",
"description" : "CASING of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.1945
},
"max_outer_diameter" : {
"val" : 0.2445
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
}, {
"type" : "CASING_SHOE",
"position" : 2,
"material" : "Steel",
"description" : "CASING_SHOE of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.1945
},
"max_outer_diameter" : {
"val" : 0.2445
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
} ]
}'
POST /public/api/v1/wells/3227b6f8-8b56-4ec5-bd05-d22d7a8c9224/casings HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 2198
{
"name" : "Intermediate casing",
"type" : "Intermediate",
"string_type" : "Casing",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.2205
},
"hole_size" : {
"val" : 0.3112
},
"casing_top" : {
"val" : 0.0
},
"shoe_depth" : {
"val" : 2400.0
},
"started_at" : "2026-03-12T00:00:00Z",
"finished_at" : "2026-03-13T12:00:00Z",
"centralizers" : [ {
"type" : "RIGID",
"top_to_shoe" : 120.0,
"bottom_to_shoe" : 0.0,
"devices_per_joints" : "1/2"
} ],
"floatation_type" : "BOTTOM_UP",
"fluid_density" : {
"val" : 1200.0
},
"air_density" : {
"val" : 1.2
},
"floatation_sub_from_bottom" : {
"val" : 250.0
},
"components" : [ {
"type" : "CASING",
"position" : 1,
"material" : "Steel",
"description" : "CASING of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.1945
},
"max_outer_diameter" : {
"val" : 0.2445
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
}, {
"type" : "CASING_SHOE",
"position" : 2,
"material" : "Steel",
"description" : "CASING_SHOE of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.1945
},
"max_outer_diameter" : {
"val" : 0.2445
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 23b14aa9dff3717e7de1dffbac85c008
Content-Type: application/json
{
"uuid" : "36d72321-e706-40ce-9607-0fb931204501",
"valid" : true
}
POST /public/api/v1/wells/{well_uuid}/casings
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Casing name, an empty string for none |
type |
String |
Casing type, for example Conductor or Production |
string_type |
String |
String type: Casing, Liner or Open Hole. A Casing or Liner needs outer_diameter, an Open Hole needs hole_size |
outer_diameter.val |
Number |
Outer diameter, m |
inner_diameter.val |
Number |
Inner diameter, m. Needed to pass validation, except for an Open Hole |
hole_size.val |
Number |
Diameter of the hole the casing is run in, m |
casing_top.val |
Number |
Depth of the casing top, m. Needed to pass validation, except for an Open Hole |
shoe_depth.val |
Number |
Depth of the casing shoe, m. A casing without it does not pass validation |
started_at |
String |
Start of running the casing, ISO-8601, null on update clears it |
finished_at |
String |
End of running the casing, ISO-8601, null on update clears it |
centralizers |
Array |
Centralizer intervals, up to 10, stored and returned as sent |
floatation_type |
String |
Floatation type, up to 50 characters |
fluid_density.val |
Number |
Floatation fluid density, kg/m3 |
air_density.val |
Number |
Floatation air density, kg/m3 |
floatation_sub_from_bottom.val |
Number |
Distance from the shoe to the floatation sub, m |
centralizers[].type |
String |
Centralizer type, RIGID or BOWSPRING |
centralizers[].top_to_shoe |
Number |
Distance from the shoe to the top of the interval, m |
centralizers[].bottom_to_shoe |
Number |
Distance from the shoe to the bottom of the interval, m |
centralizers[].devices_per_joints |
String |
Centralizers per joints, for example 1/2 |
components |
Array |
Components of the object, in the order of position |
components[].type |
String |
Component type: ACCELERATOR, AGITATOR, BENT_SUB, BIT, CASING, CASING_SHOE, CROSSOVER, DRILL_COLLAR, DRILL_PIPE, FLEX_COLLAR, FLOAT_COLLAR, HOLE_OPENER, HWDP, JAR, LWD, MISC_SUB, MUD_MOTOR, MWD, REAMER, ROTARY_STEERABLE, STABILIZER or TURBINE |
components[].position |
Number |
Order in the object, from 1, unique |
components[].material |
String |
Material |
components[].description |
String |
Free-form comment |
components[].manufacturer |
String |
Manufacturer |
components[].outer_diameter.val |
Number |
Outer diameter, m |
components[].inner_diameter.val |
Number |
Inner diameter, m |
components[].max_outer_diameter.val |
Number |
Largest outer diameter, m |
components[].length.val |
Number |
Length, m |
components[].weight.val |
Number |
Weight, SI units |
components[].linear_weight.val |
Number |
Weight per length, SI units |
components[].density.val |
Number |
Material density, kg/m3 |
components[].non_magnetic |
Boolean |
true for a non-magnetic component |
components[].young_modulus.val |
Number |
Young's modulus of the material, SI units |
components[].poisson_ratio.val |
Number |
Poisson's ratio of the material |
components[].top_mut.val |
Number |
Make-up torque of the top connection, SI units |
components[].bot_mut.val |
Number |
Make-up torque of the bottom connection, SI units |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
UUID of the new object |
valid |
Boolean |
true if the object passes validation, only then the list of the well returns it |
Update casing
Update a casing of a well, the fields that are not sent keep their values. centralizers replaces all intervals.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/2fe132ed-f39e-498a-9540-75f21bdd5c3c/casings/eb52b372-699e-450a-b9c3-729219d792ad' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "Production casing",
"shoe_depth" : {
"val" : 2450.0
},
"components" : [ {
"uuid" : "32fbf2f2-0b25-484f-9a56-327bd249a268",
"type" : "CASING",
"position" : 1,
"outer_diameter" : {
"val" : 0.2445
}
}, {
"type" : "FLOAT_COLLAR",
"position" : 2,
"material" : "Steel",
"description" : "FLOAT_COLLAR of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.1945
},
"max_outer_diameter" : {
"val" : 0.2445
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
} ]
}'
PATCH /public/api/v1/wells/2fe132ed-f39e-498a-9540-75f21bdd5c3c/casings/eb52b372-699e-450a-b9c3-729219d792ad HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 992
{
"name" : "Production casing",
"shoe_depth" : {
"val" : 2450.0
},
"components" : [ {
"uuid" : "32fbf2f2-0b25-484f-9a56-327bd249a268",
"type" : "CASING",
"position" : 1,
"outer_diameter" : {
"val" : 0.2445
}
}, {
"type" : "FLOAT_COLLAR",
"position" : 2,
"material" : "Steel",
"description" : "FLOAT_COLLAR of the example",
"manufacturer" : "Example Tools",
"outer_diameter" : {
"val" : 0.2445
},
"inner_diameter" : {
"val" : 0.1945
},
"max_outer_diameter" : {
"val" : 0.2445
},
"length" : {
"val" : 9.5
},
"weight" : {
"val" : 650.0
},
"linear_weight" : {
"val" : 68.4
},
"density" : {
"val" : 7850.0
},
"non_magnetic" : false,
"young_modulus" : {
"val" : 2.07E11
},
"poisson_ratio" : {
"val" : 0.3
},
"top_mut" : {
"val" : 25000.0
},
"bot_mut" : {
"val" : 25000.0
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 680db24cfa17051310b85c5a0df9e5d1
PATCH /public/api/v1/wells/{well_uuid}/casings/{casing_uuid}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
casing_uuid |
Casing UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Casing name, an empty string for none |
type |
String |
Casing type, for example Conductor or Production |
string_type |
String |
String type: Casing, Liner or Open Hole. A Casing or Liner needs outer_diameter, an Open Hole needs hole_size |
outer_diameter.val |
Number |
Outer diameter, m |
inner_diameter.val |
Number |
Inner diameter, m. Needed to pass validation, except for an Open Hole |
hole_size.val |
Number |
Diameter of the hole the casing is run in, m |
casing_top.val |
Number |
Depth of the casing top, m. Needed to pass validation, except for an Open Hole |
shoe_depth.val |
Number |
Depth of the casing shoe, m. A casing without it does not pass validation |
started_at |
String |
Start of running the casing, ISO-8601, null on update clears it |
finished_at |
String |
End of running the casing, ISO-8601, null on update clears it |
centralizers |
Array |
Centralizer intervals, up to 10, stored and returned as sent |
floatation_type |
String |
Floatation type, up to 50 characters |
fluid_density.val |
Number |
Floatation fluid density, kg/m3 |
air_density.val |
Number |
Floatation air density, kg/m3 |
floatation_sub_from_bottom.val |
Number |
Distance from the shoe to the floatation sub, m |
centralizers[].type |
String |
Centralizer type, RIGID or BOWSPRING |
centralizers[].top_to_shoe |
Number |
Distance from the shoe to the top of the interval, m |
centralizers[].bottom_to_shoe |
Number |
Distance from the shoe to the bottom of the interval, m |
centralizers[].devices_per_joints |
String |
Centralizers per joints, for example 1/2 |
components |
Array |
The new set of components: a current component missing from it is deleted, without this field the components stay as they are |
components[].uuid |
String |
UUID of a current component of the object to keep it, omit it for a new component |
components[].type |
String |
Component type: ACCELERATOR, AGITATOR, BENT_SUB, BIT, CASING, CASING_SHOE, CROSSOVER, DRILL_COLLAR, DRILL_PIPE, FLEX_COLLAR, FLOAT_COLLAR, HOLE_OPENER, HWDP, JAR, LWD, MISC_SUB, MUD_MOTOR, MWD, REAMER, ROTARY_STEERABLE, STABILIZER or TURBINE |
components[].position |
Number |
Order in the object, from 1, unique |
components[].material |
String |
Material |
components[].description |
String |
Free-form comment |
components[].manufacturer |
String |
Manufacturer |
components[].outer_diameter.val |
Number |
Outer diameter, m |
components[].inner_diameter.val |
Number |
Inner diameter, m |
components[].max_outer_diameter.val |
Number |
Largest outer diameter, m |
components[].length.val |
Number |
Length, m |
components[].weight.val |
Number |
Weight, SI units |
components[].linear_weight.val |
Number |
Weight per length, SI units |
components[].density.val |
Number |
Material density, kg/m3 |
components[].non_magnetic |
Boolean |
true for a non-magnetic component |
components[].young_modulus.val |
Number |
Young's modulus of the material, SI units |
components[].poisson_ratio.val |
Number |
Poisson's ratio of the material |
components[].top_mut.val |
Number |
Make-up torque of the top connection, SI units |
components[].bot_mut.val |
Number |
Make-up torque of the bottom connection, SI units |
Response body
Empty body
Delete casing
Delete a casing of a well with its components.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/a020d4de-39f3-43fb-b72c-15e5e2b8a129/casings/c534c45e-a88f-413c-a64b-94a286fc95cf' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/wells/a020d4de-39f3-43fb-b72c-15e5e2b8a129/casings/c534c45e-a88f-413c-a64b-94a286fc95cf HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 77fdf4d23d93185e716aaddeda39ecaf
DELETE /public/api/v1/wells/{well_uuid}/casings/{casing_uuid}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
casing_uuid |
Casing UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Get casing torque and drag models
Get the torque and drag models of a casing, the calculated model first.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/fd6b3270-58a9-4260-ad9f-4c625be2f7cb/casings/85933d5e-9df5-47af-878c-fbf5af0a575e/torque-drag-models' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/fd6b3270-58a9-4260-ad9f-4c625be2f7cb/casings/85933d5e-9df5-47af-878c-fbf5af0a575e/torque-drag-models HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 9283acd381cb9e41bb7dbc4017b51bd1
Content-Type: application/json
{
"content" : [ {
"model_id" : "bae5f717-18aa-47de-8587-a01409b393b3",
"name" : "auto",
"data_type" : "CALCULATED_BROOMSTICK",
"created_at" : "2026-11-16T07:27:04.251985Z",
"updated_at" : "2026-11-16T07:27:04.251985Z"
} ]
}
GET /public/api/v1/wells/{well_uuid}/casings/{casing_uuid}/torque-drag-models
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
casing_uuid |
Casing UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Torque and drag models: at most one calculated model, listed first, then imported ones from the newest |
content[].model_id |
String |
Model UUID |
content[].name |
String |
Display name, not unique: auto for the calculated model, the file name for an imported one |
content[].data_type |
String |
Model kind, use it to tell models apart: CALCULATED_BROOMSTICK for the calculated model, USER_BROOMSTICK for an imported one |
content[].created_at |
String |
Creation time, ISO-8601 |
content[].updated_at |
String |
Last update time, ISO-8601 |
Get casing torque and drag model
Get a torque and drag model of a casing with its curves.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/fd6b3270-58a9-4260-ad9f-4c625be2f7cb/casings/85933d5e-9df5-47af-878c-fbf5af0a575e/torque-drag-models/bae5f717-18aa-47de-8587-a01409b393b3' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/fd6b3270-58a9-4260-ad9f-4c625be2f7cb/casings/85933d5e-9df5-47af-878c-fbf5af0a575e/torque-drag-models/bae5f717-18aa-47de-8587-a01409b393b3 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 4134a980ec056f917516155a0ba19728
Content-Type: application/json
{
"model_id" : "bae5f717-18aa-47de-8587-a01409b393b3",
"data_type" : "CALCULATED_BROOMSTICK",
"updated_at" : "2026-11-16T07:27:04.251985Z",
"start" : 0.0,
"end" : 27.229999896,
"block_weight" : null,
"hoist_limit" : null,
"torque_limit" : null,
"curves" : [ {
"mode" : "PU",
"friction_factor" : 0.1,
"points" : [ {
"index" : 0.0,
"hookload" : 38247.66,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29906.27,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.1,
"points" : [ {
"index" : 0.0,
"hookload" : 38213.98,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29890.75,
"torque" : null
} ]
}, {
"mode" : "PU",
"friction_factor" : 0.2,
"points" : [ {
"index" : 0.0,
"hookload" : 38264.51,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29914.03,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.2,
"points" : [ {
"index" : 0.0,
"hookload" : 38197.15,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29882.99,
"torque" : null
} ]
}, {
"mode" : "PU",
"friction_factor" : 0.3,
"points" : [ {
"index" : 0.0,
"hookload" : 38281.36,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29921.79,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.3,
"points" : [ {
"index" : 0.0,
"hookload" : 38180.33,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29875.24,
"torque" : null
} ]
}, {
"mode" : "PU",
"friction_factor" : 0.4,
"points" : [ {
"index" : 0.0,
"hookload" : 38298.22,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29929.55,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.4,
"points" : [ {
"index" : 0.0,
"hookload" : 38163.52,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29867.48,
"torque" : null
} ]
}, {
"mode" : "PU",
"friction_factor" : 0.5,
"points" : [ {
"index" : 0.0,
"hookload" : 38315.09,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29937.32,
"torque" : null
} ]
}, {
"mode" : "SO",
"friction_factor" : 0.5,
"points" : [ {
"index" : 0.0,
"hookload" : 38146.71,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29859.72,
"torque" : null
} ]
}, {
"mode" : "ROB",
"friction_factor" : null,
"points" : [ {
"index" : 0.0,
"hookload" : 38230.82,
"torque" : null
}, {
"index" : 7.229999895999999,
"hookload" : 29898.51,
"torque" : null
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.1,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 1.58
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 0.75
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.2,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 3.16
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 1.5
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.3,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 4.74
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 2.24
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.4,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 6.32
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 2.99
} ]
}, {
"mode" : "ROB",
"friction_factor" : 0.5,
"points" : [ {
"index" : 0.0,
"hookload" : null,
"torque" : 7.89
}, {
"index" : 7.229999895999999,
"hookload" : null,
"torque" : 3.74
} ]
} ]
}
GET /public/api/v1/wells/{well_uuid}/casings/{casing_uuid}/torque-drag-models/{model_id}
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
casing_uuid |
Casing UUID |
model_id |
Model UUID from the model list |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
model_id |
String |
Model UUID |
data_type |
String |
Model kind, use it to tell models apart: CALCULATED_BROOMSTICK for the calculated model, USER_BROOMSTICK for an imported one |
updated_at |
String |
Last update time, ISO-8601 |
start |
Number |
Top of the measured-depth range the model covers, m |
end |
Number |
Deepest bit position the model was computed for, m. Can be shallower than the hole depth |
block_weight |
Number |
Block weight, N |
hoist_limit |
Number |
Hoisting limit, N |
torque_limit |
Number |
Torque limit, N*m |
curves |
Array |
Model curves, empty when nothing has been computed |
curves[].mode |
String |
PU (pick up), SO (slack off) or ROB (rotating off bottom) |
curves[].friction_factor |
Number |
Friction factor, null for the ROB hookload curve |
curves[].points |
Array |
Curve points, ordered by index |
curves[].points[].index |
Number |
Distance from the deepest bit position to the bit, m |
curves[].points[].hookload |
Number |
Hookload, N. Null where the curve carries torque |
curves[].points[].torque |
Number |
Torque, N*m. Null where the curve carries hookload |
32. Drive files
Files attached to a well in Solo Drive: scanned logs, reports, plans and other documents. A well keeps its
files in default folders addressed by a token: drilling_program, well_plans, bha, surveys,
well_logs, geosteering_reports, daily_drilling_reports, mud_reports, cementing_reports,
casing_pipe_tally, well_schematics, completions, core, mud_logs. Where folder is optional, omitting it
addresses the well root. An unknown token is rejected: with 406 in the folder query parameter of
listing, upload and download, with 400 inside the body of move and delete.
filenames takes explicit names or the single element "*" meaning every file of the folder; "*"
combined with other names is rejected with 400. Names are matched case-insensitively. A request that
names files which do not exist still succeeds with 200, the missing names come back in failed_filenames.
Access follows the role on the well's project and the Solo Drive role matrix: reading for listing and download (every role),
creating for upload and for the target well of a move (Geotech and higher), updating for the source well of a
move (Interpreter and higher), deleting for delete (Power Interpreter and Manager). An unknown well is 404. Files uploaded here appear in
Solo Drive for the same well, and files added in Solo Drive are listed here.
Get well files
Get the files of one folder of a well, or of the well root when folder is omitted. Folders themselves are
not listed. A well that holds no files yet answers 200 with an empty content.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files?folder=well_logs' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files?folder=well_logs HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3bc9c725a0803a9cd73c55d67d70aa50
Content-Type: application/json
{
"content" : [ {
"name" : "run1.las",
"folder" : "well_logs",
"size_bytes" : 31,
"created_at" : "2026-10-02T11:06:12.750327Z",
"updated_at" : "2026-10-02T11:06:12.750299Z"
}, {
"name" : "run2.las",
"folder" : "well_logs",
"size_bytes" : 31,
"created_at" : "2026-10-02T11:06:12.822538Z",
"updated_at" : "2026-10-02T11:06:12.822506Z"
} ]
}
GET /public/api/v1/wells/{uuid}/files
| Path parameter | Description |
|---|---|
uuid |
Well UUID |
| Parameter | Description |
|---|---|
folder |
Default folder token: drilling_program, well_plans, bha, surveys, well_logs, geosteering_reports, daily_drilling_reports, mud_reports, cementing_reports, casing_pipe_tally, well_schematics, completions, core, mud_logs. The well root when omitted |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Files of the folder, empty when it holds none |
content[].name |
String |
File name |
content[].folder |
String |
Folder token, absent for a file of the well root |
content[].size_bytes |
Number |
Size in bytes, null when it is unknown for a legacy file |
content[].created_at |
String |
Creation time, ISO 8601 UTC |
content[].updated_at |
String |
Last change time, ISO 8601 UTC |
Download well file
Download one file of a folder of a well, or of the well root when folder is omitted. filename is the name as
the listing returns it, matched case-insensitively. When several files share it, the one whose name matches
exactly wins, then the most recently changed. The answer is the file itself, Content-Disposition names it.
filename is required, a request without it is 400, a blank filename or * is 406. A folder the well does
not have or a name it does not hold is 404. HEAD is not supported and is answered 405 with Allow: GET.
503 means Solo Drive is unavailable or busy, the request can be repeated later.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files/download?folder=well_logs&filename=gamma-ray.csv' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files/download?folder=well_logs&filename=gamma-ray.csv HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7c41e9a2d05b4f8e93a6b1c2d4e5f607
Content-Type: text/csv
Content-Disposition: attachment; filename=gamma-ray.csv; filename*=UTF-8''gamma-ray.csv
depth,gamma
1000,42
1010,45
GET /public/api/v1/wells/{uuid}/files/download
| Path parameter | Description |
|---|---|
uuid |
Well UUID |
| Parameter | Description |
|---|---|
folder |
Default folder token: drilling_program, well_plans, bha, surveys, well_logs, geosteering_reports, daily_drilling_reports, mud_reports, cementing_reports, casing_pipe_tally, well_schematics, completions, core, mud_logs. The well root when omitted |
filename |
File name as the listing returns it, matched case-insensitively. Required, neither blank nor * |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
The file content with the content type of the file, Content-Disposition: attachment names the file
Upload well file
Upload one file into a default folder of a well, well_logs when folder is omitted. The folder is created
when the well does not have it yet. Any file format is accepted, up to 250 MB, a larger file is rejected with
413. A file whose name already exists in the folder is stored next to it as name (N).ext, the stored name
is returned in file_name. The file is sent in the file part of a multipart/form-data request.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files?folder=bha' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@plan.pdf;type=application/pdf' \
-F 'folder=bha'
POST /public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files?folder=bha HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: solo.cloud
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=folder
bha
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=plan.pdf
Content-Type: application/pdf
%PDF-1.4 sample Solo Drive file
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: af35d90824a57244ba92338ae2a6acf0
Content-Type: application/json
{
"folder" : "bha",
"file_name" : "plan.pdf",
"size_bytes" : 31
}
POST /public/api/v1/wells/{uuid}/files
| Path parameter | Description |
|---|---|
uuid |
Well UUID |
| Parameter | Description |
|---|---|
folder |
Default folder token: drilling_program, well_plans, bha, surveys, well_logs, geosteering_reports, daily_drilling_reports, mud_reports, cementing_reports, casing_pipe_tally, well_schematics, completions, core, mud_logs. well_logs when omitted |
| Part | Description |
|---|---|
file |
The file to store, any format, up to 250 MB |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
file_name |
String |
Stored file name: name (N).ext when the folder already held a file with the uploaded name |
folder |
String |
Folder token the file was stored in |
size_bytes |
Number |
Stored size in bytes |
Move well files
Move files from a folder of the well to a folder of the same or another well of the same company, a target
well the user cannot write to is rejected with 403, a well of another company with 400. The target well must already hold files, a well without any
is rejected with 404, while the target folder is created when missing. A name
that already exists in the target folder is stored as name (N).ext. Moving to the same folder is a no-op
answered with moved_count: 0.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files/move' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"folder" : "surveys",
"filenames" : [ "survey.las" ],
"target_well_uuid" : "6a910ddb-afb9-4842-b485-8c7d309e4915",
"target_folder" : "surveys"
}'
POST /public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files/move HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 159
{
"folder" : "surveys",
"filenames" : [ "survey.las" ],
"target_well_uuid" : "6a910ddb-afb9-4842-b485-8c7d309e4915",
"target_folder" : "surveys"
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 505aea4cc96a2fee5a714f3a126200cd
Content-Type: application/json
{
"source_well_uuid" : "ef4af66d-f8c1-419a-a8c4-1f913d093adc",
"target_well_uuid" : "6a910ddb-afb9-4842-b485-8c7d309e4915",
"moved_count" : 1,
"failed_filenames" : [ ]
}
POST /public/api/v1/wells/{uuid}/files/move
| Path parameter | Description |
|---|---|
uuid |
Source well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
folder |
String |
Source folder. Default folder token: drilling_program, well_plans, bha, surveys, well_logs, geosteering_reports, daily_drilling_reports, mud_reports, cementing_reports, casing_pipe_tally, well_schematics, completions, core, mud_logs. The well root when omitted |
filenames |
Array |
File names to process, or the single element * for every file of the folder. Names are matched case-insensitively, names that hold no file are returned in failed_filenames |
target_well_uuid |
String |
Target well UUID of the same company, the source well itself to move between its folders |
target_folder |
String |
Target folder token, created when missing. The well root when omitted |
Response body
| Path | Type | Description |
|---|---|---|
source_well_uuid |
String |
Source well UUID |
target_well_uuid |
String |
Target well UUID |
moved_count |
Number |
Number of moved files, 0 when source and target are the same folder |
failed_filenames |
Array |
Requested names that held no file in the source folder |
Delete well files
Delete the named files, or every file with "*", from a folder of the well. Deleted files disappear from the
listings immediately, the folder itself is kept. A well that holds no files is 404.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files/delete' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"folder" : "bha",
"filenames" : [ "old-plan.pdf" ]
}'
POST /public/api/v1/wells/ef4af66d-f8c1-419a-a8c4-1f913d093adc/files/delete HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 61
{
"folder" : "bha",
"filenames" : [ "old-plan.pdf" ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 3815a7aa5415b193e8bc7912237b0114
Content-Type: application/json
{
"folder" : "bha",
"well_uuid" : "ef4af66d-f8c1-419a-a8c4-1f913d093adc",
"deleted_count" : 1,
"failed_filenames" : [ ]
}
POST /public/api/v1/wells/{uuid}/files/delete
| Path parameter | Description |
|---|---|
uuid |
Well UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
folder |
String |
Default folder token: drilling_program, well_plans, bha, surveys, well_logs, geosteering_reports, daily_drilling_reports, mud_reports, cementing_reports, casing_pipe_tally, well_schematics, completions, core, mud_logs. The well root when omitted |
filenames |
Array |
File names to process, or the single element * for every file of the folder. Names are matched case-insensitively, names that hold no file are returned in failed_filenames |
Response body
| Path | Type | Description |
|---|---|---|
well_uuid |
String |
Well UUID |
folder |
String |
Folder token of the request, absent for the well root |
deleted_count |
Number |
Number of deleted files |
failed_filenames |
Array |
Requested names that held no file in the folder |
33. Driller's Roadmap
A Driller's Roadmap holds the planned drilling parameters of a well per depth interval. A well can hold several roadmaps. A roadmap is readable here once DrillSpot has saved data into it: a roadmap that was created but never saved is neither listed nor readable.
Get roadmaps by well
Get the roadmaps of a well as a content array of uuid and name, ordered by name. The array is empty
when the well holds no roadmaps.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/c9eea636-2058-4a4d-ae32-508888e0ddc5/roadmaps' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/c9eea636-2058-4a4d-ae32-508888e0ddc5/roadmaps HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d45d6621e29eb6db5fe07344871c2047
Content-Type: application/json
{
"content" : [ {
"name" : "Roadmap 1",
"uuid" : "b7f3a200-95b1-400f-9a1b-b19c7d4a3ced"
}, {
"name" : "Roadmap 2",
"uuid" : "38df0508-b592-4d96-bc07-f4922a8db073"
} ]
}
GET /public/api/v1/wells/{well_uuid}/roadmaps
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Roadmaps of the well that hold data, ordered by name |
content[].uuid |
String |
Roadmap UUID |
content[].name |
String |
Roadmap name |
Get roadmap by uuid
Get the latest saved version of a roadmap. The document is returned exactly as DrillSpot stores it: unlike the rest of this API its keys are in camelCase, and the format is defined by DrillSpot, so new fields may appear in it over time. Values are in SI units: metres for depths and diameters, radians for angles, m/s for ROP, N for WOB, Pa for MSE and differential pressure, rev/s for RPM and m3/s for flow rate.
data.entity holds the rows, one per depth station:
md,tvd,incl,azim,openHole- the station geometry, each wrapped in{val};formationTop- the formation top the station falls into,comments- free text;rowType- where the row came from:generated(computed by the roadmap generation),topset(added from a formation topset) oruser(added by the user);isTopsetrepeats the topset flag;parameters- the six standard drilling parametersrop,mse,wob,differentialPressure,surfaceRpmandflowRate, each asmedian/min/maxwrapped in{val}. A parameter that was not computed for the row is absent;customParameters- the user-added trace columns. Each key is the UUID of the trace the column was built from, each value has the samemedian/min/maxshape, and{}means the row has no value for that trace.
data.calculationSnapshots records the inputs the generated intervals were computed from: the topset
(topsetUuid), the well plan (wellPlanUuid), the offset wells (offsetUuids), the hole section
(holeSectionUuid), the depth range (minMd, maxMd), holeSize, offsetRadius, granularity, the
objective, the parameter constraints and the bha type. The numbers in a snapshot are plain values,
not wrapped in {val}. The references are stored as they were at generation time and may point to objects
deleted since.
Request
$ curl 'https://solo.cloud/public/api/v1/roadmaps/b7f3a200-95b1-400f-9a1b-b19c7d4a3ced' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/roadmaps/b7f3a200-95b1-400f-9a1b-b19c7d4a3ced HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 49bdb78cc7129186099921b70f15a51e
Content-Type: application/json
{
"data" : {
"entity" : [ {
"formationTop" : "Top Hole",
"md" : {
"val" : 0
},
"tvd" : {
"val" : 0
},
"incl" : {
"val" : 0
},
"azim" : {
"val" : 0
},
"openHole" : {
"val" : 0.250825
},
"comments" : "",
"rowType" : "generated",
"isTopset" : false,
"parameters" : {
"rop" : {
"median" : {
"val" : 0.03547644444444444
},
"min" : {
"val" : 0.022267144444444446
},
"max" : {
"val" : 0.3145747222222222
}
},
"mse" : {
"median" : {
"val" : 0
},
"min" : {
"val" : 0
},
"max" : {
"val" : 0
}
},
"wob" : {
"median" : {
"val" : 36401.82
},
"min" : {
"val" : -43750.62
},
"max" : {
"val" : 58987.26
}
},
"differentialPressure" : {
"median" : {
"val" : 1056987
},
"min" : {
"val" : -45587.7
},
"max" : {
"val" : 2046832
}
},
"surfaceRpm" : {
"median" : {
"val" : 0.4537001666666667
},
"min" : {
"val" : 0.014788998333333333
},
"max" : {
"val" : 0.6666648333333334
}
},
"flowRate" : {
"median" : {
"val" : 0.02841498333333333
},
"min" : {
"val" : 0
},
"max" : {
"val" : 0.04134635
}
}
},
"customParameters" : {
"5a89a54f-3c8e-40c9-8fae-fdb7437b8adb" : { }
}
}, {
"formationTop" : "Sand A",
"md" : {
"val" : 1524
},
"tvd" : {
"val" : 1500.2
},
"incl" : {
"val" : 0.0523
},
"azim" : {
"val" : 1.5708
},
"openHole" : {
"val" : 0.250825
},
"comments" : "top of Sand A",
"rowType" : "topset",
"isTopset" : true,
"parameters" : {
"rop" : {
"median" : {
"val" : 0.0312
},
"min" : {
"val" : 0.0201
},
"max" : {
"val" : 0.0455
}
},
"wob" : {
"median" : {
"val" : 40210.5
},
"min" : {
"val" : 35100.0
},
"max" : {
"val" : 44800.0
}
}
},
"customParameters" : { }
} ],
"calculationSnapshots" : [ {
"topsetUuid" : "adbdb0b8-6c94-42c1-a7c1-23e629448841",
"wellPlanUuid" : "a8a1dcad-a141-4e9a-8117-04bcf327f347",
"offsetUuids" : [ "2b6fb0f0-bb55-4874-86cd-dd8301ad32df", "971aee78-3580-44d6-9211-e797cc4fc829" ],
"minMd" : 0,
"maxMd" : 6096,
"holeSize" : 0.250825,
"holeSectionUuid" : "535f01eb-4350-55ea-84f5-d295a5e31884",
"offsetRadius" : 10,
"granularity" : 0,
"objective" : "max_rop",
"constraints" : {
"surfaceRpm" : {
"max" : 1.6666666666666667
}
},
"bha" : null
} ]
}
}
GET /public/api/v1/roadmaps/{roadmap_uuid}
| Path parameter | Description |
|---|---|
roadmap_uuid |
Roadmap UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
data.entity |
Array |
Rows of the roadmap, one per depth station |
data.entity[].md.val |
Number |
Measured depth, m |
data.entity[].tvd.val |
Number |
True vertical depth, m |
data.entity[].incl.val |
Number |
Inclination, rad |
data.entity[].azim.val |
Number |
Azimuth, rad |
data.entity[].openHole.val |
Number |
Open hole diameter, m |
data.entity[].formationTop |
String |
Formation top the row falls into |
data.entity[].comments |
String |
Free-text comment |
data.entity[].rowType |
String |
Where the row came from, see the chapter text |
data.entity[].isTopset |
Boolean |
Whether the row was added from a topset |
data.entity[].parameters |
Object |
Standard drilling parameters: rop (m/s), mse (Pa), wob (N), differentialPressure (Pa), surfaceRpm (rev/s), flowRate (m3/s), each as median, min and max, each wrapped in {val}. A parameter not computed for the row is absent |
data.entity[].customParameters |
Object |
User-added trace columns keyed by trace UUID, each as median, min and max, each wrapped in {val}. {} means no value |
data.calculationSnapshots |
Array |
Inputs the generated intervals were computed from: topsetUuid, wellPlanUuid, offsetUuids, holeSectionUuid, minMd, maxMd, holeSize, offsetRadius, granularity, objective, constraints, bha. Numbers here are plain, not wrapped in {val} |
34. Daily drilling reports
A daily drilling report (DDR) holds the rig activity of a well: operations, each covering a time interval with its activity code, depth reached and non-productive time, and summaries, each describing a period with its primary activities and critical points. A well holds at most one report. Operations and summaries are added in batches and never changed one by one: to replace them, delete all of them and add the new ones with new UUIDs, the UUIDs of deleted rows stay taken.
Times are ISO 8601 values. is_local_time of the report says how to read them: true means the rig local clock
written as UTC, false a true UTC instant. Depths are in the unit given by depth_reached_uom, as the source of the
report gave them, not converted to the project units.
Create daily drilling report
Create the report of a well. Repeating the request with the UUID of the existing report changes nothing, any other
UUID when the well already has a report is rejected with 409. Read the existing report with
Get daily drilling report by well.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/bd758368-969f-457c-bb7c-81edcf3b5b50/ddr' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"uuid" : "bd39b5ee-77ce-40fc-aac0-6fbdb629f3d3",
"name" : "DailyReport for Well 1",
"is_local_time" : false
}'
POST /public/api/v1/wells/bd758368-969f-457c-bb7c-81edcf3b5b50/ddr HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 117
{
"uuid" : "bd39b5ee-77ce-40fc-aac0-6fbdb629f3d3",
"name" : "DailyReport for Well 1",
"is_local_time" : false
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 14e29ba1b4b178c64fc05038421f6ce1
Content-Type: application/json
{
"uuid" : "bd39b5ee-77ce-40fc-aac0-6fbdb629f3d3"
}
POST /public/api/v1/wells/{well_uuid}/ddr
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
uuid |
String |
UUID of the new report, required |
name |
String |
Report name, required |
is_local_time |
Boolean |
true if the times of the rows are the rig local clock, false by default |
comment_uuid |
String |
UUID of the StarSteer comment the summaries go to, set on create only |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Daily drilling report UUID |
Get daily drilling report by well
Get the report of a well. Returns 404 if the well has no report.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 11cb4e8e623bef5e1b9f14a12f38ced8
Content-Type: application/json
{
"uuid" : "2d20a101-945a-42b8-bea3-99219dbda030",
"well_uuid" : "5cfb429f-bdab-4b43-afb1-00b92c63b738",
"name" : "DailyReport",
"is_local_time" : false,
"time_of_last_data_update" : "2026-11-16T07:25:57.910745Z"
}
GET /public/api/v1/wells/{well_uuid}/ddr
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Daily drilling report UUID |
well_uuid |
String |
Well (lateral) UUID |
name |
String |
Report name |
is_local_time |
Boolean |
true if the times of the rows are the rig local clock, false if they are UTC |
comment_uuid |
String |
UUID of the StarSteer comment the summaries go to |
time_of_last_data_update |
String |
When operations or summaries were last added, ISO 8601 UTC |
Update daily drilling report
Update the report by UUID. An absent field is left as it is. Rejected with 403 if the report is locked or is a
private report of another user.
Request
$ curl 'https://solo.cloud/public/api/v1/ddrs/1ef81401-7e82-4884-bf5d-6ae9cd405d26' -i -X PATCH \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name" : "DailyReport renamed",
"is_local_time" : true
}'
PATCH /public/api/v1/ddrs/1ef81401-7e82-4884-bf5d-6ae9cd405d26 HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 62
{
"name" : "DailyReport renamed",
"is_local_time" : true
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 46b4f39fbaa02132ff081fc8c913cb34
PATCH /public/api/v1/ddrs/{ddr_uuid}
| Path parameter | Description |
|---|---|
ddr_uuid |
Daily drilling report UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
name |
String |
Report name |
is_local_time |
Boolean |
true if the times of the rows are the rig local clock |
Response body
Empty body
Delete daily drilling report
Delete the report by UUID together with all its operations and summaries. Rejected with 403 if the report is
locked or is a private report of another user.
Request
$ curl 'https://solo.cloud/public/api/v1/ddrs/02b28c17-c13c-40be-a69b-1f26f58a02d0' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/ddrs/02b28c17-c13c-40be-a69b-1f26f58a02d0 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 000deac5b287e2b158d1aeeef2788add
DELETE /public/api/v1/ddrs/{ddr_uuid}
| Path parameter | Description |
|---|---|
ddr_uuid |
Daily drilling report UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
Get daily drilling report operations
Get a range of the operations of a well, ordered by start time. Deleted operations are not returned. The range is empty if the well has no report.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr/operations?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr/operations?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 6e004b921d628fd69ce40b7f716be5bf
Content-Type: application/json
{
"content" : [ {
"uuid" : "8df00c2a-0f45-4142-86d7-47ae9b1a520b",
"d_tim_start" : "2026-01-10T06:00:00Z",
"d_tim_end" : "2026-01-10T08:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"proprietary_code" : "DRL",
"proprietary_sub_code" : "ROT",
"proprietary_sub_sub_code" : "",
"comments" : "Drilled ahead from 3410 ft to 3520 ft",
"duration" : 2.0,
"non_productive_time" : {
"identified" : false,
"duration" : 0.0,
"comments" : ""
},
"is_local_time" : false
}, {
"uuid" : "29597507-1445-4b30-a59f-4ed5fa49e782",
"d_tim_start" : "2026-01-10T08:00:00Z",
"d_tim_end" : "2026-01-10T10:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"proprietary_code" : "DRL",
"proprietary_sub_code" : "ROT",
"proprietary_sub_sub_code" : "",
"comments" : "Drilled ahead from 3410 ft to 3520 ft",
"duration" : 2.0,
"non_productive_time" : {
"identified" : false,
"duration" : 0.0,
"comments" : ""
},
"is_local_time" : false
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{well_uuid}/ddr/operations
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Operation UUID |
content[].is_local_time |
Boolean |
The is_local_time of the report, repeated on every row |
content[].d_tim_start |
String |
Operation start, ISO 8601 |
content[].d_tim_end |
String |
Operation end, ISO 8601 |
content[].depth_reached |
Number |
Depth reached, in depth_reached_uom as the source gave it |
content[].depth_reached_uom |
String |
Unit of depth_reached, absent when unknown |
content[].proprietary_code |
String |
Activity code, may be empty |
content[].proprietary_sub_code |
String |
Activity sub code |
content[].proprietary_sub_sub_code |
String |
Activity sub-sub code |
content[].comments |
String |
Operation comments |
content[].duration |
Number |
Operation duration, hours |
content[].non_productive_time |
Object |
Non-productive time |
content[].non_productive_time.identified |
Boolean |
true if non-productive time was identified |
content[].non_productive_time.duration |
Number |
Non-productive time, hours |
content[].non_productive_time.comments |
String |
Non-productive time comments |
Get actual daily drilling report operations
Get the operations that start within 24 hours before the end of the latest operation, ordered by start time.
Returns 404 if the well has no operations.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr/operations/actual' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr/operations/actual HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d056e9479104256c434aef9567e07799
Content-Type: application/json
{
"content" : [ {
"uuid" : "8df00c2a-0f45-4142-86d7-47ae9b1a520b",
"d_tim_start" : "2026-01-10T06:00:00Z",
"d_tim_end" : "2026-01-10T08:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"proprietary_code" : "DRL",
"proprietary_sub_code" : "ROT",
"proprietary_sub_sub_code" : "",
"comments" : "Drilled ahead from 3410 ft to 3520 ft",
"duration" : 2.0,
"non_productive_time" : {
"identified" : false,
"duration" : 0.0,
"comments" : ""
},
"is_local_time" : false
}, {
"uuid" : "29597507-1445-4b30-a59f-4ed5fa49e782",
"d_tim_start" : "2026-01-10T08:00:00Z",
"d_tim_end" : "2026-01-10T10:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"proprietary_code" : "DRL",
"proprietary_sub_code" : "ROT",
"proprietary_sub_sub_code" : "",
"comments" : "Drilled ahead from 3410 ft to 3520 ft",
"duration" : 2.0,
"non_productive_time" : {
"identified" : false,
"duration" : 0.0,
"comments" : ""
},
"is_local_time" : false
} ]
}
GET /public/api/v1/wells/{well_uuid}/ddr/operations/actual
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Operations |
content[].uuid |
String |
Operation UUID |
content[].is_local_time |
Boolean |
The is_local_time of the report, repeated on every row |
content[].d_tim_start |
String |
Operation start, ISO 8601 |
content[].d_tim_end |
String |
Operation end, ISO 8601 |
content[].depth_reached |
Number |
Depth reached, in depth_reached_uom as the source gave it |
content[].depth_reached_uom |
String |
Unit of depth_reached, absent when unknown |
content[].proprietary_code |
String |
Activity code, may be empty |
content[].proprietary_sub_code |
String |
Activity sub code |
content[].proprietary_sub_sub_code |
String |
Activity sub-sub code |
content[].comments |
String |
Operation comments |
content[].duration |
Number |
Operation duration, hours |
content[].non_productive_time |
Object |
Non-productive time |
content[].non_productive_time.identified |
Boolean |
true if non-productive time was identified |
content[].non_productive_time.duration |
Number |
Non-productive time, hours |
content[].non_productive_time.comments |
String |
Non-productive time comments |
Get daily drilling report summaries
Get a range of the summaries of a well in the order they were added. Deleted summaries are not returned. The range is empty if the well has no report.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr/summaries?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr/summaries?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 376bb9a11acfd3372a5f20966b4b36b2
Content-Type: application/json
{
"content" : [ {
"uuid" : "40602568-32c8-4589-85f4-2e59b98e82e9",
"d_tim_start" : "2026-01-10T00:00:00Z",
"d_tim_end" : "2026-01-11T00:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"primary_activities" : "Drilled the lateral section",
"critical_points" : [ "Lost circulation at 3480 ft" ],
"non_productive_time" : {
"identified" : true,
"duration" : 1.5,
"comments" : "Waiting on weather"
},
"report_status" : "PARTIAL",
"is_local_time" : false
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{well_uuid}/ddr/summaries
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Summary UUID |
content[].is_local_time |
Boolean |
The is_local_time of the report, repeated on every row |
content[].d_tim_start |
String |
Summary period start, ISO 8601 |
content[].d_tim_end |
String |
Summary period end, ISO 8601 |
content[].depth_reached |
Number |
Depth reached, not negative, in depth_reached_uom |
content[].depth_reached_uom |
String |
Unit of depth_reached, absent when unknown |
content[].primary_activities |
String |
Primary activities of the period, not empty |
content[].critical_points |
Array |
Critical points of the period, an array of strings |
content[].report_status |
String |
PARTIAL or COMPLETE: whether the rig signed the report off, NOV reports only |
content[].non_productive_time |
Object |
Non-productive time |
content[].non_productive_time.identified |
Boolean |
true if non-productive time was identified |
content[].non_productive_time.duration |
Number |
Non-productive time, hours |
content[].non_productive_time.comments |
String |
Non-productive time comments |
Get actual daily drilling report summary
Get the summary with the latest end, the earliest added one among summaries with the same end. Returns 404 if the
well has no summaries.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr/summaries/actual' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/5cfb429f-bdab-4b43-afb1-00b92c63b738/ddr/summaries/actual HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: dc5d5bdc5dee1ebfb90a409465317a6f
Content-Type: application/json
{
"uuid" : "40602568-32c8-4589-85f4-2e59b98e82e9",
"d_tim_start" : "2026-01-10T00:00:00Z",
"d_tim_end" : "2026-01-11T00:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"primary_activities" : "Drilled the lateral section",
"critical_points" : [ "Lost circulation at 3480 ft" ],
"non_productive_time" : {
"identified" : true,
"duration" : 1.5,
"comments" : "Waiting on weather"
},
"report_status" : "PARTIAL",
"is_local_time" : false
}
GET /public/api/v1/wells/{well_uuid}/ddr/summaries/actual
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
uuid |
String |
Summary UUID |
is_local_time |
Boolean |
The is_local_time of the report, repeated on every row |
d_tim_start |
String |
Summary period start, ISO 8601 |
d_tim_end |
String |
Summary period end, ISO 8601 |
depth_reached |
Number |
Depth reached, not negative, in depth_reached_uom |
depth_reached_uom |
String |
Unit of depth_reached, absent when unknown |
primary_activities |
String |
Primary activities of the period, not empty |
critical_points |
Array |
Critical points of the period, an array of strings |
report_status |
String |
PARTIAL or COMPLETE: whether the rig signed the report off, NOV reports only |
non_productive_time |
Object |
Non-productive time |
non_productive_time.identified |
Boolean |
true if non-productive time was identified |
non_productive_time.duration |
Number |
Non-productive time, hours |
non_productive_time.comments |
String |
Non-productive time comments |
Add daily drilling report operations
Add from 1 to 1000 operations to the report by UUID. A request with an operation UUID that is taken, also by a
deleted operation, or is repeated in the request, or with a required field missing, is rejected with 400 and adds
nothing. An operation is skipped without an error when its d_tim_start, d_tim_end and depth_reached equal those
of an operation the report already has (a deleted one does not count) or of an earlier operation of the same request,
whatever its UUID: the stored operation is not changed. Times are compared to the microsecond, depth exactly.
Rejected with 403 if the report is locked or is a private report of another user.
Request
$ curl 'https://solo.cloud/public/api/v1/ddrs/55529a27-f196-4bfe-b202-e7a2e00e6d80/operations' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"items" : [ {
"uuid" : "8c3a7c2c-cc45-4022-a0b8-4701e8e9111c",
"d_tim_start" : "2026-01-10T10:00:00Z",
"d_tim_end" : "2026-01-10T12:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"proprietary_code" : "DRL",
"proprietary_sub_code" : "ROT",
"proprietary_sub_sub_code" : "",
"comments" : "Drilled ahead from 3410 ft to 3520 ft",
"duration" : 2.0,
"non_productive_time" : {
"identified" : false,
"duration" : 0.0,
"comments" : ""
}
} ]
}'
POST /public/api/v1/ddrs/55529a27-f196-4bfe-b202-e7a2e00e6d80/operations HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 521
{
"items" : [ {
"uuid" : "8c3a7c2c-cc45-4022-a0b8-4701e8e9111c",
"d_tim_start" : "2026-01-10T10:00:00Z",
"d_tim_end" : "2026-01-10T12:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"proprietary_code" : "DRL",
"proprietary_sub_code" : "ROT",
"proprietary_sub_sub_code" : "",
"comments" : "Drilled ahead from 3410 ft to 3520 ft",
"duration" : 2.0,
"non_productive_time" : {
"identified" : false,
"duration" : 0.0,
"comments" : ""
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 8b6c11b6264a16bb1a1c4a4fcf91b55e
POST /public/api/v1/ddrs/{ddr_uuid}/operations
| Path parameter | Description |
|---|---|
ddr_uuid |
Daily drilling report UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
items |
Array |
Operations to add, from 1 to 1000 |
items[].uuid |
String |
Operation UUID, generated when absent |
items[].d_tim_start |
String |
Operation start, ISO 8601 |
items[].d_tim_end |
String |
Operation end, ISO 8601 |
items[].depth_reached |
Number |
Depth reached, in depth_reached_uom as the source gave it |
items[].depth_reached_uom |
String |
Unit of depth_reached, absent when unknown |
items[].proprietary_code |
String |
Activity code, may be empty |
items[].proprietary_sub_code |
String |
Activity sub code |
items[].proprietary_sub_sub_code |
String |
Activity sub-sub code |
items[].comments |
String |
Operation comments |
items[].duration |
Number |
Operation duration, hours |
items[].non_productive_time |
Object |
Non-productive time |
items[].non_productive_time.identified |
Boolean |
true if non-productive time was identified |
items[].non_productive_time.duration |
Number |
Non-productive time, hours |
items[].non_productive_time.comments |
String |
Non-productive time comments |
Response body
Empty body
Add daily drilling report summaries
Add from 1 to 1000 summaries to the report by UUID, all of them or none, rejected with 400 on the same terms as
operations. A summary is never skipped as a repeat. depth_reached must not be negative and primary_activities must
not be empty. Rejected with 403 if the report is locked or is a private
report of another user.
Request
$ curl 'https://solo.cloud/public/api/v1/ddrs/5db9c3da-7ab6-4309-82d0-8f09c0dc436a/summaries' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"items" : [ {
"uuid" : "88e4c28a-5f9d-4d81-8718-7d107bd8ca97",
"d_tim_start" : "2026-01-11T00:00:00Z",
"d_tim_end" : "2026-01-12T00:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"primary_activities" : "Drilled the lateral section",
"critical_points" : [ "Lost circulation at 3480 ft" ],
"non_productive_time" : {
"identified" : true,
"duration" : 1.5,
"comments" : "Waiting on weather"
},
"report_status" : "PARTIAL"
} ]
}'
POST /public/api/v1/ddrs/5db9c3da-7ab6-4309-82d0-8f09c0dc436a/summaries HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 503
{
"items" : [ {
"uuid" : "88e4c28a-5f9d-4d81-8718-7d107bd8ca97",
"d_tim_start" : "2026-01-11T00:00:00Z",
"d_tim_end" : "2026-01-12T00:00:00Z",
"depth_reached" : 3520.0,
"depth_reached_uom" : "ft",
"primary_activities" : "Drilled the lateral section",
"critical_points" : [ "Lost circulation at 3480 ft" ],
"non_productive_time" : {
"identified" : true,
"duration" : 1.5,
"comments" : "Waiting on weather"
},
"report_status" : "PARTIAL"
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 717410ddf3c997e40281586db734d7d6
POST /public/api/v1/ddrs/{ddr_uuid}/summaries
| Path parameter | Description |
|---|---|
ddr_uuid |
Daily drilling report UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
items |
Array |
Summaries to add, from 1 to 1000 |
items[].uuid |
String |
Summary UUID, generated when absent |
items[].d_tim_start |
String |
Summary period start, ISO 8601 |
items[].d_tim_end |
String |
Summary period end, ISO 8601 |
items[].depth_reached |
Number |
Depth reached, not negative, in depth_reached_uom |
items[].depth_reached_uom |
String |
Unit of depth_reached, absent when unknown |
items[].primary_activities |
String |
Primary activities of the period, not empty |
items[].critical_points |
Array |
Critical points of the period, an array of strings |
items[].report_status |
String |
PARTIAL or COMPLETE: whether the rig signed the report off, NOV reports only |
items[].non_productive_time |
Object |
Non-productive time |
items[].non_productive_time.identified |
Boolean |
true if non-productive time was identified |
items[].non_productive_time.duration |
Number |
Non-productive time, hours |
items[].non_productive_time.comments |
String |
Non-productive time comments |
Response body
Empty body
Delete daily drilling report operations and summaries
Delete all operations and summaries of the report by UUID and keep the report. time_of_last_data_update of the
report does not change, and the UUIDs of the deleted rows cannot be used again. Rejected with 403 if the report is
locked or is a private report of another user.
Request
$ curl 'https://solo.cloud/public/api/v1/ddrs/df4947ec-aa96-4dc7-ad09-9ab88f627d80/operations-and-summaries' -i -X DELETE \
-H 'Authorization: Bearer <your_access_token>'
DELETE /public/api/v1/ddrs/df4947ec-aa96-4dc7-ad09-9ab88f627d80/operations-and-summaries HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 215cee910e6439a4068744bc94683cd4
DELETE /public/api/v1/ddrs/{ddr_uuid}/operations-and-summaries
| Path parameter | Description |
|---|---|
ddr_uuid |
Daily drilling report UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
Empty body
35. Mud checks
Mud checks hold the drilling fluid properties measured on a lateral: the time and depth of the check, the mud
type and class, the rheometer readings and a set of measures. A measure is an object of value, uom and
datum and keeps the unit it was stored with: nothing is converted to the project units, and uom is absent
when the source gave none. ph and cuttings_sg are plain numbers. Every measure sits at the root of the check.
Every mud check of the lateral is listed and can be replaced or deleted here, the ones loaded by data sources
included, unless a user keeps it private or locked in Solo: a mud check private to another user is not listed,
and a mud check that is locked or private to another user is not replaced or deleted (403). A request takes
from 1 to 1000 checks or uuids. A uuid of a mud check of another lateral answers
409 MUD_CHECK_ALREADY_EXISTS on create and replace and 404 MUD_CHECK_NOT_FOUND on delete.
Get mud checks by well
Get every mud check of a lateral as a content array ordered by dtim, the checks without dtim last.
A mud check private to another user is not listed. The array is empty when the lateral holds no mud checks.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/9667b555-29ba-46ca-b34f-f94d7690538b/mud-checks' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/9667b555-29ba-46ca-b34f-f94d7690538b/mud-checks HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 860d1af1fc8d561e90825074b71a733e
Content-Type: application/json
{
"content" : [ {
"uuid" : "34cd06d3-ac12-45c9-9197-9083863c4d4f",
"uid" : "MC-0001",
"dtim" : "2026-10-21T06:00:00Z",
"type" : "WBM",
"mud_class" : "WATERBASED",
"rheology_input" : "FANN_READINGS",
"source_type" : "EMAIL",
"description" : "Morning check",
"engineer" : "J. Smith",
"company_name" : "Mud Co",
"location_sample" : "Pit 2",
"asg" : "2.6",
"poly_type" : "PAC",
"md" : {
"value" : 3118.0,
"uom" : "m",
"datum" : "KB"
},
"pv" : {
"value" : 18.0,
"uom" : "cP"
},
"mud_weight" : {
"value" : 9.8,
"uom" : "ppg"
},
"ph" : 9.5,
"rheometer" : {
"uid" : "rh-1",
"temp_rheom" : {
"value" : 49.0,
"uom" : "degC"
},
"vis3_rpm" : 4.0,
"vis6_rpm" : 6.0,
"vis100_rpm" : 22.0,
"vis200_rpm" : 33.0,
"vis300_rpm" : 40.0,
"vis600_rpm" : 58.0
},
"extension_name_value" : [ {
"uid" : "env-1",
"name" : "Flowline temperature",
"value" : {
"value" : 48.0,
"uom" : "degC"
},
"data_type" : "double"
} ]
}, {
"uuid" : "b5b97026-66ba-421b-ac9e-4a8bf997a339",
"dtim" : "2026-10-21T12:00:00Z",
"mud_weight" : {
"value" : 9.9
}
}, {
"uuid" : "b0b32a6b-36c0-49f6-9304-06384940611f",
"pv" : {
"value" : 21.0,
"uom" : "cP"
}
} ]
}
GET /public/api/v1/wells/{well_uuid}/mud-checks
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Mud checks of the well, ordered by dtim, checks without dtim last. The measures are fields of the check, there is no measures key: md, tvd, pres_bop_rating, temp_vis, temp_hthp, pres_hthp, filtrate_hthp, filter_cake_hthp, solids_calc_pc, barite_pc, temp_ph, alkalinity_p1, alkalinity_p2, magnesium, potassium, brine_pc, elect_stab, calcium_chloride, solids_hi_grav_pc, polymer, sol_cor_pc, oil_ctg, hardness_ca, sulfide, pv, yp, filter_cake_ltlp, calcium, chloride, filtrate_ltlp, temperature, gel10_sec, gel10_min, gel30_min, lcm, solids_low_grav_pc, lime, mbt, mf, mud_weight, oil_pc, pm_filtrate, pm, sand_pc, solids_pc, vis_funnel, water_pc, water_phase_salinity and cuttings_size are measures {value, uom, datum} in the unit the source gave, ph and cuttings_sg are plain numbers |
content[].uuid |
String |
Check UUID |
content[].source_type |
String |
Source of the check: SOLOBOX, EMAIL, PASON, NABORS, INNOVA, NOV, DRIVE or WELLVIEW. Absent for a check entered by hand |
content[].uid |
String |
Identifier of the check in its source system, up to 200 characters |
content[].dtim |
String |
Time of the check, ISO 8601 |
content[].type |
String |
Mud type: WBM, OBM or SBM |
content[].mud_class |
String |
Mud class: WATERBASED, OILBASED, OTHER, PNEUMATIC or UNKNOWN |
content[].rheology_input |
String |
How the rheology was given: FANN_READINGS or PV_YP |
content[].description |
String |
Free text, up to 8000 characters |
content[].engineer |
String |
Mud engineer, up to 200 characters |
content[].company_name |
String |
Mud company, up to 200 characters |
content[].location_sample |
String |
Where the sample was taken, up to 200 characters |
content[].asg |
String |
Average specific gravity of the solids as the source gave it, up to 200 characters |
content[].poly_type |
String |
Polymer type, up to 200 characters |
content[].md |
Object |
Measured depth of the check, a measure {value, uom, datum} |
content[].mud_weight |
Object |
Mud weight (density), a measure {value, uom, datum} |
content[].pv |
Object |
Plastic viscosity, a measure {value, uom, datum} |
content[].ph |
Number |
pH, a plain number |
content[].rheometer |
Object |
Rheometer readings: uid, the measures temp_rheom and pres_rheom, the dial readings vis3_rpm, vis6_rpm, vis100_rpm, vis200_rpm, vis300_rpm, vis600_rpm and extension_name_value as in the check |
content[].extension_name_value |
Array |
Name-value pairs the source attached to the check: uid, name, value (a measure), data_type, dtim, md (a measure), index (an integer), measure_class, description |
Create mud checks
Add mud checks to a lateral. uuid is optional, a missing one is generated: the response lists the uuids
of the checks in the request order. A uuid repeated in the request answers 400 DUPLICATE_MUD_CHECK_UUID,
a uuid of any existing mud check answers 409 MUD_CHECK_ALREADY_EXISTS: use replace to change a check.
source_type is set on creation only.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/9667b555-29ba-46ca-b34f-f94d7690538b/mud-checks' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"checks" : [ {
"uuid" : "53b9a6e6-c32f-44f5-8c89-8853f2c312b8",
"uid" : "MC-0003",
"dtim" : "2026-10-21T18:00:00Z",
"type" : "WBM",
"mud_class" : "WATERBASED",
"rheology_input" : "FANN_READINGS",
"source_type" : "EMAIL",
"description" : "Morning check",
"engineer" : "J. Smith",
"company_name" : "Mud Co",
"location_sample" : "Pit 2",
"asg" : "2.6",
"poly_type" : "PAC",
"md" : {
"value" : 3118.0,
"uom" : "m",
"datum" : "KB"
},
"mud_weight" : {
"value" : 9.8,
"uom" : "ppg"
},
"pv" : {
"value" : 18.0,
"uom" : "cP"
},
"ph" : 9.5,
"rheometer" : {
"uid" : "rh-1",
"temp_rheom" : {
"value" : 49.0,
"uom" : "degC"
},
"vis3_rpm" : 4.0,
"vis6_rpm" : 6.0,
"vis100_rpm" : 22.0,
"vis200_rpm" : 33.0,
"vis300_rpm" : 40.0,
"vis600_rpm" : 58.0
},
"extension_name_value" : [ {
"uid" : "env-1",
"name" : "Flowline temperature",
"value" : {
"value" : 48.0,
"uom" : "degC"
},
"data_type" : "double"
} ]
}, {
"dtim" : "2026-10-22T00:00:00Z",
"mud_weight" : {
"value" : 10.0,
"uom" : "ppg"
}
} ]
}'
POST /public/api/v1/wells/9667b555-29ba-46ca-b34f-f94d7690538b/mud-checks HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 1266
{
"checks" : [ {
"uuid" : "53b9a6e6-c32f-44f5-8c89-8853f2c312b8",
"uid" : "MC-0003",
"dtim" : "2026-10-21T18:00:00Z",
"type" : "WBM",
"mud_class" : "WATERBASED",
"rheology_input" : "FANN_READINGS",
"source_type" : "EMAIL",
"description" : "Morning check",
"engineer" : "J. Smith",
"company_name" : "Mud Co",
"location_sample" : "Pit 2",
"asg" : "2.6",
"poly_type" : "PAC",
"md" : {
"value" : 3118.0,
"uom" : "m",
"datum" : "KB"
},
"mud_weight" : {
"value" : 9.8,
"uom" : "ppg"
},
"pv" : {
"value" : 18.0,
"uom" : "cP"
},
"ph" : 9.5,
"rheometer" : {
"uid" : "rh-1",
"temp_rheom" : {
"value" : 49.0,
"uom" : "degC"
},
"vis3_rpm" : 4.0,
"vis6_rpm" : 6.0,
"vis100_rpm" : 22.0,
"vis200_rpm" : 33.0,
"vis300_rpm" : 40.0,
"vis600_rpm" : 58.0
},
"extension_name_value" : [ {
"uid" : "env-1",
"name" : "Flowline temperature",
"value" : {
"value" : 48.0,
"uom" : "degC"
},
"data_type" : "double"
} ]
}, {
"dtim" : "2026-10-22T00:00:00Z",
"mud_weight" : {
"value" : 10.0,
"uom" : "ppg"
}
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 648c48844e765d3a3914a57058bbe195
Content-Type: application/json
{
"uuids" : [ "53b9a6e6-c32f-44f5-8c89-8853f2c312b8", "98afa0ac-77b2-4a8c-95df-c3e645b142fc" ]
}
POST /public/api/v1/wells/{well_uuid}/mud-checks
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
checks |
Array |
Checks to add, 1 to 1000. The measures are fields of the check, there is no measures key: md, tvd, pres_bop_rating, temp_vis, temp_hthp, pres_hthp, filtrate_hthp, filter_cake_hthp, solids_calc_pc, barite_pc, temp_ph, alkalinity_p1, alkalinity_p2, magnesium, potassium, brine_pc, elect_stab, calcium_chloride, solids_hi_grav_pc, polymer, sol_cor_pc, oil_ctg, hardness_ca, sulfide, pv, yp, filter_cake_ltlp, calcium, chloride, filtrate_ltlp, temperature, gel10_sec, gel10_min, gel30_min, lcm, solids_low_grav_pc, lime, mbt, mf, mud_weight, oil_pc, pm_filtrate, pm, sand_pc, solids_pc, vis_funnel, water_pc, water_phase_salinity and cuttings_size are measures {value, uom, datum} in the unit the source gave, ph and cuttings_sg are plain numbers |
checks[].uuid |
String |
Check UUID, generated when omitted |
checks[].source_type |
String |
Source of the check: SOLOBOX, EMAIL, PASON, NABORS, INNOVA, NOV, DRIVE or WELLVIEW. Omit it for a check entered by hand. Set on creation only |
checks[].uid |
String |
Identifier of the check in its source system, up to 200 characters |
checks[].dtim |
String |
Time of the check, ISO 8601 |
checks[].type |
String |
Mud type: WBM, OBM or SBM |
checks[].mud_class |
String |
Mud class: WATERBASED, OILBASED, OTHER, PNEUMATIC or UNKNOWN |
checks[].rheology_input |
String |
How the rheology was given: FANN_READINGS or PV_YP |
checks[].description |
String |
Free text, up to 8000 characters |
checks[].engineer |
String |
Mud engineer, up to 200 characters |
checks[].company_name |
String |
Mud company, up to 200 characters |
checks[].location_sample |
String |
Where the sample was taken, up to 200 characters |
checks[].asg |
String |
Average specific gravity of the solids as the source gave it, up to 200 characters |
checks[].poly_type |
String |
Polymer type, up to 200 characters |
checks[].md |
Object |
Measured depth of the check, a measure {value, uom, datum} |
checks[].mud_weight |
Object |
Mud weight (density), a measure {value, uom, datum} |
checks[].pv |
Object |
Plastic viscosity, a measure {value, uom, datum} |
checks[].ph |
Number |
pH, a plain number |
checks[].rheometer |
Object |
Rheometer readings: uid, the measures temp_rheom and pres_rheom, the dial readings vis3_rpm, vis6_rpm, vis100_rpm, vis200_rpm, vis300_rpm, vis600_rpm and extension_name_value as in the check |
checks[].extension_name_value |
Array |
Name-value pairs the source attached to the check: uid, name, value (a measure), data_type, dtim, md (a measure), index (an integer), measure_class, description |
Response body
| Path | Type | Description |
|---|---|---|
uuids |
Array |
UUIDs of the added checks in request order |
Replace mud checks
Replace the listed mud checks of a lateral as a whole: a field that is not sent is cleared, only
source_type keeps its stored value. uuid is required for every check, a check without it answers 400,
and a uuid that is not taken adds a new check. Checks that are not listed are kept. A uuid repeated in the
request answers 400 DUPLICATE_MUD_CHECK_UUID. A mud check that is locked or private to another user answers
403 and nothing is replaced.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/9667b555-29ba-46ca-b34f-f94d7690538b/mud-checks' -i -X PUT \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"checks" : [ {
"uuid" : "34cd06d3-ac12-45c9-9197-9083863c4d4f",
"dtim" : "2026-10-21T06:00:00Z",
"type" : "WBM",
"mud_class" : "WATERBASED",
"rheology_input" : "PV_YP",
"description" : "Morning check, corrected",
"engineer" : "J. Smith",
"md" : {
"value" : 3118.0,
"uom" : "m",
"datum" : "KB"
},
"mud_weight" : {
"value" : 9.7,
"uom" : "ppg"
},
"pv" : {
"value" : 17.0,
"uom" : "cP"
},
"ph" : 9.6
} ]
}'
PUT /public/api/v1/wells/9667b555-29ba-46ca-b34f-f94d7690538b/mud-checks HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 506
{
"checks" : [ {
"uuid" : "34cd06d3-ac12-45c9-9197-9083863c4d4f",
"dtim" : "2026-10-21T06:00:00Z",
"type" : "WBM",
"mud_class" : "WATERBASED",
"rheology_input" : "PV_YP",
"description" : "Morning check, corrected",
"engineer" : "J. Smith",
"md" : {
"value" : 3118.0,
"uom" : "m",
"datum" : "KB"
},
"mud_weight" : {
"value" : 9.7,
"uom" : "ppg"
},
"pv" : {
"value" : 17.0,
"uom" : "cP"
},
"ph" : 9.6
} ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 7cf34017c3d82a18744ec4b934dba607
PUT /public/api/v1/wells/{well_uuid}/mud-checks
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
checks |
Array |
Checks to replace or to add, 1 to 1000, each with its uuid. A field that is not sent is cleared. The measures are fields of the check, there is no measures key: md, tvd, pres_bop_rating, temp_vis, temp_hthp, pres_hthp, filtrate_hthp, filter_cake_hthp, solids_calc_pc, barite_pc, temp_ph, alkalinity_p1, alkalinity_p2, magnesium, potassium, brine_pc, elect_stab, calcium_chloride, solids_hi_grav_pc, polymer, sol_cor_pc, oil_ctg, hardness_ca, sulfide, pv, yp, filter_cake_ltlp, calcium, chloride, filtrate_ltlp, temperature, gel10_sec, gel10_min, gel30_min, lcm, solids_low_grav_pc, lime, mbt, mf, mud_weight, oil_pc, pm_filtrate, pm, sand_pc, solids_pc, vis_funnel, water_pc, water_phase_salinity and cuttings_size are measures {value, uom, datum} in the unit the source gave, ph and cuttings_sg are plain numbers |
checks[].uuid |
String |
UUID of the check to replace, or of a new check |
checks[].source_type |
String |
Source of a new check: SOLOBOX, EMAIL, PASON, NABORS, INNOVA, NOV, DRIVE or WELLVIEW. A stored check keeps its stored source |
checks[].uid |
String |
Identifier of the check in its source system, up to 200 characters |
checks[].dtim |
String |
Time of the check, ISO 8601 |
checks[].type |
String |
Mud type: WBM, OBM or SBM |
checks[].mud_class |
String |
Mud class: WATERBASED, OILBASED, OTHER, PNEUMATIC or UNKNOWN |
checks[].rheology_input |
String |
How the rheology was given: FANN_READINGS or PV_YP |
checks[].description |
String |
Free text, up to 8000 characters |
checks[].engineer |
String |
Mud engineer, up to 200 characters |
checks[].company_name |
String |
Mud company, up to 200 characters |
checks[].location_sample |
String |
Where the sample was taken, up to 200 characters |
checks[].asg |
String |
Average specific gravity of the solids as the source gave it, up to 200 characters |
checks[].poly_type |
String |
Polymer type, up to 200 characters |
checks[].md |
Object |
Measured depth of the check, a measure {value, uom, datum} |
checks[].mud_weight |
Object |
Mud weight (density), a measure {value, uom, datum} |
checks[].pv |
Object |
Plastic viscosity, a measure {value, uom, datum} |
checks[].ph |
Number |
pH, a plain number |
checks[].rheometer |
Object |
Rheometer readings: uid, the measures temp_rheom and pres_rheom, the dial readings vis3_rpm, vis6_rpm, vis100_rpm, vis200_rpm, vis300_rpm, vis600_rpm and extension_name_value as in the check |
checks[].extension_name_value |
Array |
Name-value pairs the source attached to the check: uid, name, value (a measure), data_type, dtim, md (a measure), index (an integer), measure_class, description |
Response body
Empty body
Delete mud checks
Delete the listed mud checks of a lateral. A uuid of no mud check is skipped. A mud check that is locked or
private to another user answers 403 and nothing is deleted. The deletion cannot be undone through the API.
Request
$ curl 'https://solo.cloud/public/api/v1/wells/9667b555-29ba-46ca-b34f-f94d7690538b/mud-checks/delete' -i -X POST \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"uuids" : [ "b0b32a6b-36c0-49f6-9304-06384940611f" ]
}'
POST /public/api/v1/wells/9667b555-29ba-46ca-b34f-f94d7690538b/mud-checks/delete HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 58
{
"uuids" : [ "b0b32a6b-36c0-49f6-9304-06384940611f" ]
}
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: d7cd36e0e13ff162b0f3d12af55b4241
POST /public/api/v1/wells/{well_uuid}/mud-checks/delete
| Path parameter | Description |
|---|---|
well_uuid |
Well (lateral) UUID |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
| Body field | Type | Description |
|---|---|---|
uuids |
Array |
UUIDs of the checks to delete, 1 to 1000 |
Response body
Empty body
36. Drilling events
Drilling events record what happened on a well, at which MD and time. Events sit in event groups on a lateral, a typewell or a nested well, a group sets the custom attributes of its events. Categories belong to the project. A private event group or attribute of another user is not listed.
Get event groups by lateral
Get the drilling event groups of a lateral in creation order, with their attributes sorted by name and the number of events. A private group or attribute of another user is left out. Read the events by Get events by event group
Request
$ curl 'https://solo.cloud/public/api/v1/wells/88936c24-62e9-4566-84f7-4bd557cb8421/eventgroups?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/wells/88936c24-62e9-4566-84f7-4bd557cb8421/eventgroups?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 909acf992fa02071946b403a1c58a1f1
Content-Type: application/json
{
"content" : [ {
"uuid" : "db0a1e34-4cc0-4359-a06e-69e21d7072bc",
"name" : "Events",
"attributes" : [ {
"uuid" : "62e6c1c9-78a2-4f78-808a-e6452a137524",
"name" : "Cost",
"type" : "NUMBER"
}, {
"uuid" : "31807474-ffa5-47b4-b6fc-15b220e23bc7",
"name" : "Due",
"type" : "DATE"
}, {
"uuid" : "bd78dc42-fd30-4aad-9937-bfaa5d614678",
"name" : "Note",
"type" : "TEXT"
} ],
"events_count" : 2
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/wells/{uuid}/eventgroups
| Path parameter | Description |
|---|---|
uuid |
Lateral UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Event group UUID |
content[].name |
String |
Event group name, not unique |
content[].attributes |
Array |
Custom attributes of the events of the group, sorted by name |
content[].attributes[].uuid |
String |
Attribute UUID |
content[].attributes[].name |
String |
Attribute name |
content[].attributes[].type |
String |
Attribute type: NUMBER, TEXT or DATE |
content[].events_count |
Number |
Number of events in the group |
Get event groups by typewell
Get the drilling event groups of a typewell in creation order, with their attributes sorted by name and the number of events. A private group or attribute of another user is left out. Read the events by Get events by event group
Request
$ curl 'https://solo.cloud/public/api/v1/typewells/5dee69ff-1383-4dd9-981d-0d746e46e0c6/eventgroups?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/typewells/5dee69ff-1383-4dd9-981d-0d746e46e0c6/eventgroups?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: df3735d60e9709a84cc3ffce16b17562
Content-Type: application/json
{
"content" : [ {
"uuid" : "e4a19cf9-af36-4a12-8314-577fd94b1f6e",
"name" : "Events",
"attributes" : [ ],
"events_count" : 0
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/typewells/{uuid}/eventgroups
| Path parameter | Description |
|---|---|
uuid |
Typewell UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Event group UUID |
content[].name |
String |
Event group name, not unique |
content[].attributes |
Array |
Custom attributes of the events of the group, sorted by name |
content[].attributes[].uuid |
String |
Attribute UUID |
content[].attributes[].name |
String |
Attribute name |
content[].attributes[].type |
String |
Attribute type: NUMBER, TEXT or DATE |
content[].events_count |
Number |
Number of events in the group |
Get event groups by nested well
Get the drilling event groups of a nested well in creation order, with their attributes sorted by name and the number of events. A private group or attribute of another user is left out. Read the events by Get events by event group
Request
$ curl 'https://solo.cloud/public/api/v1/nestedwells/d9bc0bc6-a3e9-4548-9416-9519c12dcd49/eventgroups?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/nestedwells/d9bc0bc6-a3e9-4548-9416-9519c12dcd49/eventgroups?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 5746584cb3db0dd12fb55b55ad8bf711
Content-Type: application/json
{
"content" : [ {
"uuid" : "bb3c3ee5-686a-46ce-9f6b-4866df1d3e72",
"name" : "Events",
"attributes" : [ ],
"events_count" : 0
} ],
"offset" : 0,
"limit" : 10,
"total" : 1,
"first" : true,
"last" : true
}
GET /public/api/v1/nestedwells/{uuid}/eventgroups
| Path parameter | Description |
|---|---|
uuid |
Nested well UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Event group UUID |
content[].name |
String |
Event group name, not unique |
content[].attributes |
Array |
Custom attributes of the events of the group, sorted by name |
content[].attributes[].uuid |
String |
Attribute UUID |
content[].attributes[].name |
String |
Attribute name |
content[].attributes[].type |
String |
Attribute type: NUMBER, TEXT or DATE |
content[].events_count |
Number |
Number of events in the group |
Get event groups by project and name
Get the drilling event groups named name on all wells of a project in creation order, each with its parent well,
its attributes sorted by name and the number of events. The name matches trimmed and case-insensitive. For a virtual
project, only the groups of its wells and of their nested wells are returned. A private group or attribute of another
user is left out. Read the events by Get events by event group
Request
$ curl 'https://solo.cloud/public/api/v1/projects/d25f2882-4aec-49b6-be58-1f537414cb82/eventgroups?name=Events&offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/d25f2882-4aec-49b6-be58-1f537414cb82/eventgroups?name=Events&offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: 0878e7b1c754fc84b57ec6f97132c72f
Content-Type: application/json
{
"content" : [ {
"uuid" : "db0a1e34-4cc0-4359-a06e-69e21d7072bc",
"name" : "Events",
"parent_well" : {
"uuid" : "88936c24-62e9-4566-84f7-4bd557cb8421",
"name" : "Events lateral",
"type" : "WELL"
},
"attributes" : [ {
"uuid" : "62e6c1c9-78a2-4f78-808a-e6452a137524",
"name" : "Cost",
"type" : "NUMBER"
}, {
"uuid" : "31807474-ffa5-47b4-b6fc-15b220e23bc7",
"name" : "Due",
"type" : "DATE"
}, {
"uuid" : "bd78dc42-fd30-4aad-9937-bfaa5d614678",
"name" : "Note",
"type" : "TEXT"
} ],
"events_count" : 2
}, {
"uuid" : "bb3c3ee5-686a-46ce-9f6b-4866df1d3e72",
"name" : "Events",
"parent_well" : {
"uuid" : "d9bc0bc6-a3e9-4548-9416-9519c12dcd49",
"name" : "Events plan",
"type" : "NESTEDWELL"
},
"attributes" : [ ],
"events_count" : 0
}, {
"uuid" : "e4a19cf9-af36-4a12-8314-577fd94b1f6e",
"name" : "Events",
"parent_well" : {
"uuid" : "5dee69ff-1383-4dd9-981d-0d746e46e0c6",
"name" : "Events typewell",
"type" : "TYPEWELL"
},
"attributes" : [ ],
"events_count" : 0
} ],
"offset" : 0,
"limit" : 10,
"total" : 3,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/eventgroups
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Parameter | Description |
|---|---|
name |
Event group name, trimmed and case-insensitive |
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Event group UUID |
content[].name |
String |
Event group name, not unique |
content[].attributes |
Array |
Custom attributes of the events of the group, sorted by name |
content[].attributes[].uuid |
String |
Attribute UUID |
content[].attributes[].name |
String |
Attribute name |
content[].attributes[].type |
String |
Attribute type: NUMBER, TEXT or DATE |
content[].events_count |
Number |
Number of events in the group |
content[].parent_well |
Object |
The well the group belongs to |
content[].parent_well.uuid |
String |
Parent well UUID |
content[].parent_well.name |
String |
Parent well name |
content[].parent_well.type |
String |
Parent well type: WELL for a lateral, TYPEWELL or NESTEDWELL |
Get events by event group
Get the drilling events of a group sorted by MD start, with their attribute values. MDs are in project units, times
are UTC, a DATE value is a UTC time. category_uuid refers to
Get event categories by project. Returns 403 for a private group of
another user
Request
$ curl 'https://solo.cloud/public/api/v1/eventgroups/db0a1e34-4cc0-4359-a06e-69e21d7072bc/events?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/eventgroups/db0a1e34-4cc0-4359-a06e-69e21d7072bc/events?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: ddc321751376d37b523bbd7923face25
Content-Type: application/json
{
"content" : [ {
"uuid" : "35625a78-a60e-40f8-83c7-c5a337874800",
"category_uuid" : "ea3956c4-13b9-46a9-8c3c-9de968c3a247",
"md_start" : {
"val" : 10250.0
},
"md_end" : {
"val" : 10310.5
},
"start_time" : "2026-08-21T10:15:00Z",
"end_time" : "2026-08-21T12:00:00Z",
"severity" : "HIGH",
"description" : "Stuck at the shoe",
"attribute_values" : [ {
"attribute_uuid" : "62e6c1c9-78a2-4f78-808a-e6452a137524",
"value" : {
"val" : 1200.0
}
}, {
"attribute_uuid" : "31807474-ffa5-47b4-b6fc-15b220e23bc7",
"value" : "2026-08-22T00:00:00Z"
}, {
"attribute_uuid" : "bd78dc42-fd30-4aad-9937-bfaa5d614678",
"value" : "Rig down"
} ]
}, {
"uuid" : "58738924-8d4b-4b04-9095-014568463a67",
"category_uuid" : "ea3956c4-13b9-46a9-8c3c-9de968c3a247",
"md_start" : {
"val" : 10400.0
},
"attribute_values" : [ ]
} ],
"offset" : 0,
"limit" : 10,
"total" : 2,
"first" : true,
"last" : true
}
GET /public/api/v1/eventgroups/{uuid}/events
| Path parameter | Description |
|---|---|
uuid |
Event group UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Event UUID |
content[].category_uuid |
String |
Event category UUID, see Get event categories by project |
content[].md_start.val |
Number |
MD start in project units |
content[].md_end.val |
Number |
MD end in project units, absent when not set |
content[].start_time |
String |
Start time, ISO-8601 UTC, absent when not set |
content[].end_time |
String |
End time, ISO-8601 UTC, absent when not set |
content[].severity |
String |
INSIGNIFICANT, LOW, MEDIUM, HIGH or EXTREME, absent when not set |
content[].description |
String |
Event description, absent when not set |
content[].attribute_values |
Array |
Values of the attributes of the group the event has, in the order of the attributes |
content[].attribute_values[].attribute_uuid |
String |
Attribute UUID |
content[].attribute_values[].value |
Varies |
{"val": number} for NUMBER, a string for TEXT, an ISO-8601 UTC time for DATE |
content[].attribute_values[].value.val |
Number |
NUMBER value |
Get event categories by project
Get the drilling event categories of a project: the predefined categories first, then those of the project in creation order. A virtual project lists the categories of its global project
Request
$ curl 'https://solo.cloud/public/api/v1/projects/d25f2882-4aec-49b6-be58-1f537414cb82/eventcategories?offset=0&limit=10' -i -X GET \
-H 'Authorization: Bearer <your_access_token>'
GET /public/api/v1/projects/d25f2882-4aec-49b6-be58-1f537414cb82/eventcategories?offset=0&limit=10 HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud
Response
HTTP/1.1 200 OK
X-Solo-Trace-Id: e531031365dc580f7971f1da21265987
Content-Type: application/json
{
"content" : [ {
"uuid" : "82bd44d8-73f1-4752-a72e-7d71eb1b5a5c",
"name" : "Lost Circulation",
"predefined" : true
}, {
"uuid" : "cd2d79e8-a5fb-4e0b-ac43-7b7215173c3a",
"name" : "Tight Hole",
"predefined" : true
}, {
"uuid" : "1b5ec728-fee1-4aeb-abfa-ccfc5b62fbfd",
"name" : "Downhole failure",
"predefined" : true
}, {
"uuid" : "8ea37293-cf14-4aad-a785-a757c008f20d",
"name" : "Well Control",
"predefined" : true
}, {
"uuid" : "7369e6d4-f141-4ddc-8e06-c1f40968859a",
"name" : "Overpressure",
"predefined" : true
}, {
"uuid" : "14710d73-deb0-43be-8487-484ecde84000",
"name" : "Depletion",
"predefined" : true
}, {
"uuid" : "123797a9-29e0-4db6-bec7-55c473ad65d0",
"name" : "Stuck Pipe",
"predefined" : true
}, {
"uuid" : "ea3956c4-13b9-46a9-8c3c-9de968c3a247",
"name" : "Low ROP",
"predefined" : false
} ],
"offset" : 0,
"limit" : 10,
"total" : 8,
"first" : true,
"last" : true
}
GET /public/api/v1/projects/{uuid}/eventcategories
| Path parameter | Description |
|---|---|
uuid |
Project UUID |
| Parameter | Description |
|---|---|
offset |
Index of the first record to return by a request from the list of all records |
limit |
Maximum number of records to return by a request from the list of all records, starting with 'offset' |
| Header | Description |
|---|---|
Authorization |
OAuth2 authorization header |
Response body
| Path | Type | Description |
|---|---|---|
content |
Array |
Content array |
offset |
Number |
Index of the first record returned by a request from the list of all records |
limit |
Number |
Maximum number of records returned by a request from the list of all records, starting with 'offset' |
total |
Number |
Total number of records |
first |
Boolean |
true if the current records range is the first, otherwise - false |
last |
Boolean |
true if the current records range is the last, otherwise - false |
content[].uuid |
String |
Event category UUID |
content[].name |
String |
Event category name |
content[].predefined |
Boolean |
true for a predefined category shared by every project |
Errors
Error response body
All the errors have the following structure:
| Path | Type | Description |
|---|---|---|
message |
String |
The error details |
type |
String |
Type of the error |
trace_id |
String |
Trace ID of the request |
solo_object_uuid |
String |
Optional. UUID of the object the error relates to, present only for some errors |
solo_object_name |
String |
Optional. Name of the object the error relates to, present only for some errors |
folder_uuid |
String |
Optional. UUID of the folder the error relates to, present only for some errors |
400 Bad Request
The request cannot be fulfilled due to bad syntax, validation errors, missing data, etc. The type field tells the reason, for example INVALID_PARAMETER (a required query parameter is missing), INVALID_PARAMETER_TYPE (a parameter value, such as a UUID, is malformed) or INVALID_REQUEST_BODY (the request body is invalid or cannot be read). Data refused by the calculation engine, such as the layers of an earth model, is rejected with INVALID_REQUEST_BODY too, the message names the reason.
Response
HTTP/1.1 400 Bad Request
{
"message": "Missing required request parameters: offset",
"trace_id": "d369294dba75b176",
"type": "INVALID_PARAMETER"
}
401 Unauthorized
The request cannot be fulfilled due to incorrect access credentials, missing or invalid authentication token.
Response
HTTP/1.1 401 Unauthorized
{
"message": "Unauthorized access",
"trace_id": "d369294dba75b177",
"type": "UNAUTHORIZED"
}
403 Forbidden
The request cannot be fulfilled due to lack of access to perform an operation. Endpoints that take a project UUID usually return 403 also when the project does not exist.
Response
HTTP/1.1 403 Forbidden
{
"message": "Access is denied",
"trace_id": "d369294dba75b178",
"type": "FORBIDDEN"
}
404 Not Found
The requested object not found.
Response
HTTP/1.1 404 Not Found
{
"message": "Object with uuid 1b9f6a0e-3c7d-4a52-9e1f-2d8c5b7a6e40 not found",
"trace_id": "d369294dba75b180",
"type": "NOT_FOUND"
}
406 Not Acceptable
Some endpoints reject an invalid parameter value (INVALID_PARAMETER) or a request body in a wrong format (INVALID_REQUEST_BODY_FORMAT, for example grid, polygon, stick and image log uploads) with 406. 406 is also returned when the Accept header does not match what the endpoint produces.
Response
HTTP/1.1 406 Not Acceptable
{
"message": "Only one of the parameters 'epsg_mnemonic' or 'epsg_crs_code' may be specified at a time",
"trace_id": "d4e9313ff6267dd5",
"type": "INVALID_PARAMETER"
}
409 Conflict
Request could not be processed because of conflict in the current state of the resource (such as an edit conflict between multiple simultaneous updates). PROJECT_BUSY means the project was busy with other changes and nothing of the request was applied: repeat the same request.
Response
HTTP/1.1 409 Conflict
{
"message": "Requested change cannot be applied",
"trace_id": "4844645175526a44",
"type": "NOT_ACCEPTED"
}
415 Unsupported Media Type
The request Content-Type is not supported by the endpoint, for example a body other than JSON is sent to an endpoint that expects application/json.
Response
HTTP/1.1 415 Unsupported Media Type
{
"message": "Content-Type 'text/plain;charset=ISO-8859-1' is not supported",
"trace_id": "d369294dba75b179",
"type": "INVALID_REQUEST_BODY"
}
500 Internal Server Error
The request cannot be fulfilled due to internal server error.
Response
HTTP/1.1 500 Internal server error
{
"message": "Internal server error",
"trace_id": "d369294dba75b181",
"type": "INTERNAL_ERROR"
}
503 Service Unavailable
The request cannot be fulfilled due to temporary server unavailability. Please retry the request later. You can find the detailed information in the error response body.
Response
HTTP/1.1 503 Service Unavailable
{
"message": "Service is unavailable, please try again later",
"trace_id": "d369294dba75b182",
"type": "SERVICE_UNAVAILABLE"
}
License agreement
Copyright 2022 Rogii Inc. These API Terms form a binding "Agreement" between You and Rogii Inc. (“Rogii”) "You," and "your," refers to the individual, company or legal entity that you represent. The Agreement does not grant You any right to access or use: (a) Solo Cloud platform and associated tools and applications (the "Services"); (b) any of Rogii’s non-public application programming interfaces; or (c) the confidential geoscience and drilling data owned by third parties stored in Solo Cloud. If You wish to access the Services, You will be required to enter into separate license agreements with Rogii for the Services.
DEFINITIONS
“Software Application” means software authored by You that accesses or otherwise interoperates with Solo Cloud via the Solo Cloud Public API.
“Solo Cloud” means Rogii’s proprietary multi-tenant cloud system and database which contains confidential geoscience and drilling data owned by third parties.
“Solo Cloud Public API” means a collection of routines, classes, function parameters, protocols, related libraries, tools and other instructions provided in source code or object code form that allow access to or interoperability with Solo Cloud by a Software Application.
“Python SDK” means the software development kit of tools developed by Rogii that enables access to the capabilities and features of Solo Cloud through the utilization of Solo Cloud Public API.
Rogii grants You a world-wide, non-exclusive, revocable limited license, under applicable copyrights, to Use the Solo Cloud Public API or Python SDK, as applicable, only as necessary to develop, test, enable and support interoperability between the Software Application and Solo Cloud.
You will not: (A) access Solo Cloud Public API or Python SDK or their documentation in violation of any law or regulation; (B) access Solo Cloud Public API or Python SDK in any manner that (i) compromises, breaks or circumvents any of Rogii’s technical processes or security measures associated with Solo Cloud, (ii) poses a security vulnerability to customers or users of Solo Cloud, or (iii) tests the vulnerability of Rogii’s systems or networks; (C) access Solo Cloud Public API or Python SDK or their documentation in order to replicate or compete with Solo Cloud; (D) attempt to reverse engineer or otherwise derive source code, trade secrets, or know-how of Solos Cloud API, Python SDK or Solo Cloud; or (E) attempt to use Solo Cloud Public API or Python SDK in a manner that exceeds rate limits, or constitutes excessive or abusive usage.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOLO CLOUD PUBLIC API, PYTHON SDK AND THEIR DOCUMENTATION AND ALL RELATED COMPONENTS AND INFORMATION ARE PROVIDED BY US ON AN "AS IS" AND "AS AVAILABLE" BASIS WITHOUT ANY WARRANTIES OF ANY KIND, AND WE EXPRESSLY DISCLAIM ANY AND ALL WARRANTIES, WHETHER EXPRESS OR IMPLIED, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, TITLE, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. YOU ACKNOWLEDGE THAT ROGII DOES NOT WARRANT THAT THE SOLO CLOUD PUBLIC API OR PYTHON SDK WILL BE UNINTERRUPTED, TIMELY, SECURE, ERROR-FREE, OR BACKWARDS COMPATIBLE.
You shall defend, indemnify and hold harmless Rogii, its affiliates and their respective officers, directors, employees, agents and representatives from any and all claims, damages, liabilities, costs and fees (including reasonable attorneys’ fees) arising from the Software Application. The Parties agree to comply with the following process when Rogii seeks indemnification under this section and specifically that Rogii is to: (i) promptly give You written notice of the claim; (ii) give You sole control of the defense and settlement of the claim (provided that You may not settle any claim unless it unconditionally releases Rogii of all liability); and (iii) provide You, at Your cost, all reasonable assistance.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL ROGII BE RESPONSIBLE OR LIABLE WITH RESPECT TO ANY SUBJECT MATTER OF THIS AGREEMENT UNDER ANY CONTRACT, NEGLIGENCE, STRICT LIABILITY OR OTHER THEORY FOR: (I) LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES, OR TECHNOLOGY; OR (II) ANY INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO LOSS OF REVENUES OR PROFITS; (III) ANY MATTER BEYOND ITS REASONABLE CONTROL; OR (IV) ANY AMOUNT IN THE AGGREGATE OVER $100
Rogii may terminate this Agreement immediately upon written notice if You breach this Agreement. Rogii may, at its sole discretion, reinstate Your ability to use the Solo Cloud Public API if You demonstrate that You have remedied any such breach.
Notwithstanding the foregoing, Sections 4-6 of this Agreement will survive any termination of this Agreement.