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.

https://Solo.cloud/

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
    • Nested well
      • Topset
        • Top
    • Log
    • Mudlog
    • Topset
      • Top
    • Image
    • Target line
  • Typewell
    • Log
    • Mudlog
    • Topset
      • Top

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:

1. val - field holds a value
2. undefined - field which is true if a value is not a number value

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

0. Authentication

Issue token

Authentication using OAuth 2.0

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: a2950b96056639a9
Authorization: dcecf4ec-b001-47db-89ec-9571d27ff532
Set-Cookie: SESSION=ZGNlY2Y0ZWMtYjAwMS00N2RiLTg5ZWMtOTU3MWQyN2ZmNTMy; Path=/; HttpOnly; SameSite=Lax
Content-Type: application/json;charset=UTF-8

{
  "access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsic29sby1wdWJsaWMtYXBpIl0sImNvbXBhbnlfaWQiOjIwMDAzLCJ1c2VyX2lkIjoxNDg2LCJjbGllbnRfYXBwX2lkIjoicGFwaSIsInVzZXJfbmFtZSI6InRlc3QrYXBpQHRlc3QuY29tIiwic2NvcGUiOlsicmVhZCJdLCJleHAiOjE2Nzg4ODMwODYsInVzZXJfZGlnZXN0IjoiOGI5ZWVhMzc3NyIsImlhdCI6MTY3ODg3MzA4NiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9TVEFGRiJdLCJqdGkiOiI4NVc1VnB6emxiVDFtdWpMb3FzZ1BJTUNXV00iLCJjbGllbnRfaWQiOiJzb2xvLWFwaS1jbGllbnQtaWQifQ.wxMsuWn1g9881kHFDB1BSL2Iikbfw4fHohlvYimcgte45cjjmOb9g8pv85ELy-m2IhNfKoNEQEfqT9Hax2LRjP2_UE3ArsmehYD2mEyAn5pCY_KIpKsKyqw3-PY24b2NZGzVMMT2hKFaWIK5ACBOUtIch_3-Li_H3VSkzDntdxw",
  "token_type" : "bearer",
  "refresh_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wYW55X2lkIjoyMDAwMywiY2xpZW50X2FwcF9pZCI6InBhcGkiLCJ1c2VyX25hbWUiOiJ0ZXN0K2FwaUB0ZXN0LmNvbSIsInVzZXJfZGlnZXN0IjoiOGI5ZWVhMzc3NyIsImF1dGhvcml0aWVzIjpbIlJPTEVfU1RBRkYiXSwiY2xpZW50X2lkIjoic29sby1hcGktY2xpZW50LWlkIiwiYXVkIjpbInNvbG8tcHVibGljLWFwaSJdLCJ1c2VyX2lkIjoxNDg2LCJzY29wZSI6WyJyZWFkIl0sImF0aSI6Ijg1VzVWcHp6bGJUMW11akxvcXNnUElNQ1dXTSIsImV4cCI6MTY3ODkwMzA4NiwiaWF0IjoxNjc4ODczMDg2LCJqdGkiOiJMVUl0MDlQWFAxdldWOEM3bGJwQ2MzZVNLQmcifQ.r1j6kjtdOUb-7c27x3sRsWLEl9eWl4p7lRQWAEdcDAJ7wFOIpWGiRVcAR9VOV2ccoaBcV37d2N3UXkYE8WHqyAqsWih649dapu6BsuidV5dY65rwrko7LZEMcDHQ7CXVqTcrknPAXz-jcqTowV5MVzK59ZHtwCXgBbXIq_bs5PI",
  "expires_in" : 9999,
  "scope" : "read",
  "iat" : 1678873086,
  "jti" : "85W5VpzzlbT1mujLoqsgPIMCWWM"
}

POST /oauth/token

Parameter	Description
grant_type	The type of grant being presented in exchange for an access and refresh token. Can be password or refresh_token
username	User name in Solo to access a project
password	User password in Solo to access a project

Header	Description
Authorization	Authorization header in the following format Basic credentials credentials 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
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	Scope of the token
iat	Number	Time at which the token was issued
jti	String	Unique token identifier

1. Projects

Get projects

Get a list of company projects with pagination

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: 65f667e6aa5ccdd6
Content-Type: application/json

{
  "content" : [ {
    "uuid" : "4ff6bba3-53ae-4681-907c-78f8042ba993",
    "name" : "Papi test project 1",
    "measure_unit" : "FOOT",
    "role" : "MANAGER",
    "accessed_on" : "2023-03-15T09:37:52Z",
    "modified_on" : "2023-03-15T09:37:52Z"
  }, {
    "uuid" : "65447662-6e3f-4be4-bdb3-152da29bef13",
    "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" : "2023-03-15T09:37:53Z",
    "modified_on" : "2023-03-15T09:37:53Z"
  }, {
    "uuid" : "97cd8bbe-e74b-4bf2-8bef-e0559194a789",
    "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" : "2023-03-15T09:37:53Z",
    "modified_on" : "2023-03-15T09:37:53Z"
  } ],
  "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	Filter projects by the 'name' field. 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	Measurement units (possible values: METER, FOOT, METER_FOOT)
content[].role	String	Role
content[].accessed_on	String	Date/time project last accessed at
content[].modified_on	String	Date/time project last modified at
content[].geo_crs	Object	Coordinate reference system (CRS) information
content[].geo_crs.code	Varies	CRS code
content[].geo_crs.authority	Varies	Authority
content[].geo_crs.name	Varies	CRS name
content[].geo_crs.measure_unit	Varies	CRS measure unit

Get virtual projects

Get a list of company virtual projects with pagination

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: d8182f7b92e50098
Content-Type: application/json

{
  "content" : [ {
    "uuid" : "4289af99-7c73-4f63-b328-df9be2cee9af",
    "name" : "Virtual Papi test project 1",
    "measure_unit" : "FOOT",
    "role" : "MANAGER",
    "parent_uuid" : "4ff6bba3-53ae-4681-907c-78f8042ba993",
    "parent_name" : "Papi test project 1",
    "virtual" : true,
    "modified_on" : "2023-03-15T09:37:52Z"
  }, {
    "uuid" : "f4c2b74a-5a8f-458e-ab7b-c0eac8388f30",
    "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" : "65447662-6e3f-4be4-bdb3-152da29bef13",
    "parent_name" : "Papi test project 2",
    "virtual" : true,
    "modified_on" : "2023-03-15T09:37:53Z"
  }, {
    "uuid" : "b7737b9d-4850-40ae-87d4-e73d669f607f",
    "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" : "97cd8bbe-e74b-4bf2-8bef-e0559194a789",
    "parent_name" : "Papi test project 3",
    "virtual" : true,
    "modified_on" : "2023-03-15T09:37:53Z"
  } ],
  "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	Filter virtual projects by the 'name' field. 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	Measurement units (possible values: METER, FOOT, METER_FOOT)
content[].role	String	Role
content[].accessed_on	String	Date/time project last accessed at
content[].modified_on	String	Date/time project last modified at
content[].geo_crs	Object	Coordinate reference system (CRS) information
content[].parent_uuid	String	Parent project UUID
content[].parent_name	String	Parent project name
content[].virtual	Boolean	Whether the project is virtual
content[].geo_crs.code	Varies	CRS code
content[].geo_crs.authority	Varies	Authority
content[].geo_crs.name	Varies	CRS name
content[].geo_crs.measure_unit	Varies	CRS measure unit

Get project

Get a single project info

Request

$ curl 'https://solo.cloud/public/api/v1/projects/97cd8bbe-e74b-4bf2-8bef-e0559194a789' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/projects/97cd8bbe-e74b-4bf2-8bef-e0559194a789 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: 836eedc79d945789
Content-Type: application/json

{
  "uuid" : "97cd8bbe-e74b-4bf2-8bef-e0559194a789",
  "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" : "2023-03-15T09:37:53Z",
  "modified_on" : "2023-03-15T09:37:53Z"
}

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	Measurement units (possible values: METER, FOOT, METER_FOOT)
role	String	Role
accessed_on	String	Date/time project last accessed at
modified_on	String	Date/time project last modified at
geo_crs	Object	Coordinate reference system (CRS) information
geo_crs.code	Number	CRS code
geo_crs.authority	String	Authority
geo_crs.name	String	CRS name
geo_crs.measure_unit	String	CRS measure unit

Get recently updated objects

Get recently updated project objects

Request

$ curl 'https://solo.cloud/public/api/v1/projects/97cd8bbe-e74b-4bf2-8bef-e0559194a789/changes' -i -X POST \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "modified_since" : "2023-03-15T09:36:53.088Z"
}'

POST /public/api/v1/projects/97cd8bbe-e74b-4bf2-8bef-e0559194a789/changes HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 51

{
  "modified_since" : "2023-03-15T09:36:53.088Z"
}

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 7362901302ee1897
Content-Type: application/json

{
  "content" : [ {
    "uuid" : "d9494a05-95e4-4c6b-93af-edeb80e8d769",
    "type" : "WELL",
    "operation" : "CREATE"
  }, {
    "uuid" : "c2601bf3-926f-4ff8-91f0-156c4921d43d",
    "type" : "TYPEWELL",
    "operation" : "CREATE"
  } ],
  "modified_on" : "2023-03-15T09:37:53.538Z",
  "modified_at" : "2023-03-15T09:37:53.538+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	Date/time project modifications request since (pay attention to format)

Response body

Path	Type	Description
content	Array	Content array
modified_at	String	Date/time project last modified at
content[].uuid	String	Project object UUID
content[].type	String	Project object type
content[].operation	String	Operation performed on the object

2. Laterals

Create lateral

Create lateral by project UUID

Request

$ curl 'https://solo.cloud/public/api/v1/projects/60d218a0-8f8b-4673-ab66-7c6ca2bfc8f2/laterals' -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/60d218a0-8f8b-4673-ab66-7c6ca2bfc8f2/laterals 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: 3a6b99bbb0fe493e
Content-Type: application/json

{
  "uuid" : "1ebeee91-ddad-450d-9de7-5fb7d314c6eb"
}

POST /public/api/v1/projects/{uuid}/laterals

Path parameter	Description
uuid	Project UUID

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	Convergence
azimuth.val	Number	AzimuthVS
kb.val	Number	Kelly Bushing (KB) is the height of the Derek (drill rig) measured from the MSL
tieintvd.val	Number	TieInTvd
tieinns.val	Number	TieInNs
tieinew.val	Number	TieInEw
xsrfreal.val	Number	X surface wellbore coordinate
ysrfreal.val	Number	Y surface wellbore coordinate

Response body

Path	Type	Description
uuid	String	Created lateral UUID

Get laterals by project

Get a list of laterals by project UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/projects/60d218a0-8f8b-4673-ab66-7c6ca2bfc8f2/wells?offset=0&limit=10&filter=oNe' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/projects/60d218a0-8f8b-4673-ab66-7c6ca2bfc8f2/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: 9cb60aa4c7626bbc
Content-Type: application/json

{
  "content" : [ {
    "uuid" : "54d6b12f-ea3f-4897-89bc-820ed4f68067",
    "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/{projectUuid}/wells

Path parameter	Description
projectUuid	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	Filter laterals by the 'name' or 'api' fields. 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	Flag indicating the presence of logs
content[].flags.has_topsets	Boolean	Flag indicating the presence of topsets
content[].flags.has_interpretations	Boolean	Flag indicating the presence of interpretations
content[].flags.has_nested_wells	Boolean	Flag indicating the presence of nested wells
content[].flags.has_mudlogs	Boolean	Flag indicating the presence of mudlogs
content[].flags.has_target_lines	Boolean	Flag indicating the presence of target lines

Get lateral meta

Get lateral metadata

Request

$ curl 'https://solo.cloud/public/api/v1/wells/fb679bec-3ace-4559-b9ee-9f5b2be9ec0d' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/fb679bec-3ace-4559-b9ee-9f5b2be9ec0d HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 5b1c37de7c4eab28
Content-Type: application/json

{
  "uuid" : "fb679bec-3ace-4559-b9ee-9f5b2be9ec0d",
  "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/{lateralUuid}

Path parameter	Description
lateralUuid	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
ysrf.val	Number	Y surface coordinate
kb.val	Number	Kelly Bushing (KB) is the height of the Derek (drill rig) measured from the MSL
azimuth.val	Number	AzimuthVS
convergence.val	Number	Convergence
tie_in_tvd.val	Number	Tie in tvd coordinates
tie_in_ns.val	Number	Tie in NS
tie_in_ew.val	Number	Tie in EW

Get lateral trajectory

Get lateral trajectory data by lateral UUID

Request

$ curl 'https://solo.cloud/public/api/v1/wells/cd80a765-a58f-4497-828c-57fa9e214ea1/trajectory' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/cd80a765-a58f-4497-828c-57fa9e214ea1/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: dde1fc8b9ce6295b
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/{wellUuid}/trajectory

Path parameter	Description
wellUuid	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)

Get starred objects

Get starred objects by lateral UUID

Request

$ curl 'https://solo.cloud/public/api/v1/laterals/bde2713d-e7de-46be-b504-e084d36b9055/starred' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/laterals/bde2713d-e7de-46be-b504-e084d36b9055/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: 21c1d6573563fc83
Content-Type: application/json

{
  "target_line" : "0c12fe66-9a11-486f-a57f-2e0a63c13e5c",
  "nested_well" : "2d9ca722-366f-487f-b66c-bc1de4a37de3",
  "interpretation" : "c4e0c4bd-861a-45a2-b92f-6ae0966a688f",
  "topset" : "89d1ed28-a176-40af-9ca0-a0d44b9b655d"
}

GET /public/api/v1/laterals/{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
nested_well	String	Starred nested well UUID
interpretation	String	Starred interpretation UUID
topset	String	Starred topset UUID

Get linked typewells

Get linked typewells by lateral UUID

Request

$ curl 'https://solo.cloud/public/api/v1/laterals/08a6518b-ac34-4923-aff9-58af40b50d01/linked?offset=0&limit=10' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/laterals/08a6518b-ac34-4923-aff9-58af40b50d01/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: e53faa83f3e86cbf
Content-Type: application/json

{
  "content" : [ {
    "shift" : {
      "val" : 1640.4199475065616
    },
    "typewell_id" : "24a9a8d3-c18f-4b93-bd59-feb85bb49816"
  } ],
  "offset" : 0,
  "limit" : 10,
  "total" : 1,
  "first" : true,
  "last" : true
}

GET /public/api/v1/laterals/{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
content[].typewell_id	String	Typewell UUID

Get comments

Get comments by lateral UUID

Request

$ curl 'https://solo.cloud/public/api/v1/laterals/7376bc15-a367-4889-a50c-ef81dcbd2b38/comments?offset=0&limit=10' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/laterals/7376bc15-a367-4889-a50c-ef81dcbd2b38/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: f991d1a1b2483113
Content-Type: application/json

{
  "content" : [ {
    "comment_id" : "c09fe80a-8052-4138-a719-4f7fc67ec52a",
    "name" : "Comment",
    "comment_boxes" : [ {
      "commentbox_id" : "657a8c69-eef5-40cd-aacc-3a3fa83f31c6",
      "text" : "New Comment Text",
      "anchor_md" : {
        "val" : 2375.2755905511813
      }
    } ]
  }, {
    "comment_id" : "c4bf395f-61cf-4b2c-bd5b-ae4a21e53aef",
    "name" : "Comment",
    "comment_boxes" : [ {
      "commentbox_id" : "42ad7476-ba71-4de7-a879-c1ece5f51d0b",
      "text" : "New Comment Text",
      "anchor_md" : {
        "val" : 2375.2755905511813
      }
    }, {
      "commentbox_id" : "8fb16123-f5ef-40d6-bddf-f92e14fbda0b",
      "text" : "New Comment Text",
      "anchor_md" : {
        "val" : 2375.2755905511813
      }
    } ]
  } ],
  "offset" : 0,
  "limit" : 10,
  "total" : 2,
  "first" : true,
  "last" : true
}

GET /public/api/v1/laterals/{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 measured depth

Update lateral meta

Update lateral metadata

Request

$ curl 'https://solo.cloud/public/api/v1/wells/54d6b12f-ea3f-4897-89bc-820ed4f68067' -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/54d6b12f-ea3f-4897-89bc-820ed4f68067 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: 1e6ae7c48507e35d

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
operator	String	Operator name
api	String	API lateral number
xsrf.val	Number	X surface coordinate
ysrf.val	Number	Y surface coordinate
kb.val	Number	Kelly Bushing (KB) is the height of the Derek (drill rig) measured from the MSL
azimuth.val	Number	Well azimuth (degrees)
convergence.val	Number	Convergence
tie_in_tvd.val	Number	Tie in tvd coordinates
tie_in_ns.val	Number	Tie in NS
tie_in_ew.val	Number	Tie in EW

Response body

Empty body

Extend lateral trajectory

Extend lateral trajectory (note that 'azim' can be used for a trajectory station azimuth as well as 'azi')

Request

$ curl 'https://solo.cloud/public/api/v1/wells/54d6b12f-ea3f-4897-89bc-820ed4f68067/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/54d6b12f-ea3f-4897-89bc-820ed4f68067/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: a8afc685dbcd3280

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	Depth measure unit of a trajectory stations related to the lateral. Accepted values: m, ft
incl_uom	String	Inclination measure unit of a trajectory stations related to the lateral. Accepted values: dega, rad
azi_uom	String	Azimuth measure unit of a trajectory stations related to the lateral. Accepted values: dega, rad
trajectory_stations	Array	Lateral trajectory data array
trajectory_stations[].md.val	Number	Depth data value
trajectory_stations[].incl.val	Number	Inclination data value
trajectory_stations[].azi.val	Number	Azimuth data value

Response body

Empty body

Replace lateral trajectory

Replace lateral trajectory (note that 'azim' can be used for a trajectory station azimuth as well as 'azi')

Request

$ curl 'https://solo.cloud/public/api/v1/wells/54d6b12f-ea3f-4897-89bc-820ed4f68067/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/54d6b12f-ea3f-4897-89bc-820ed4f68067/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: 95a92e8d6c3a5a2d

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	Depth measure unit of a trajectory stations related to the lateral. Accepted values: m, ft
incl_uom	String	Inclination measure unit of a trajectory stations related to the lateral. Accepted values: dega, rad
azi_uom	String	Azimuth measure unit of a trajectory stations related to the lateral. Accepted values: dega, rad
trajectory_stations	Array	Lateral trajectory data array
trajectory_stations[].md.val	Number	Depth data value
trajectory_stations[].incl.val	Number	Inclination data value
trajectory_stations[].azi.val	Number	Azimuth data value

Response body

Empty body

Set starred objects

Set starred objects by lateral UUID

Request

$ curl 'https://solo.cloud/public/api/v1/laterals/uuid/bde2713d-e7de-46be-b504-e084d36b9055/starred' -i -X PUT \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "targetline" : "0c12fe66-9a11-486f-a57f-2e0a63c13e5c",
  "nestedwell" : "2d9ca722-366f-487f-b66c-bc1de4a37de3",
  "interpretation" : "c4e0c4bd-861a-45a2-b92f-6ae0966a688f",
  "topset" : "89d1ed28-a176-40af-9ca0-a0d44b9b655d"
}'

PUT /public/api/v1/laterals/uuid/bde2713d-e7de-46be-b504-e084d36b9055/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 230

{
  "targetline" : "0c12fe66-9a11-486f-a57f-2e0a63c13e5c",
  "nestedwell" : "2d9ca722-366f-487f-b66c-bc1de4a37de3",
  "interpretation" : "c4e0c4bd-861a-45a2-b92f-6ae0966a688f",
  "topset" : "89d1ed28-a176-40af-9ca0-a0d44b9b655d"
}

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 6310decd81e1c94f

PUT /public/api/v1/laterals/uuid/{uuid}/starred

Path parameter	Description
uuid	Lateral UUID

Header	Description
Authorization	OAuth2 authorization header

Body field	Type	Description
targetline	String	Target line UUID to set starred (use "00000000-0000-0000-0000-000000000000" to reset)
nestedwell	String	Nested well UUID to set starred (use "00000000-0000-0000-0000-000000000000" to reset)
interpretation	String	Interpretation UUID to set starred (use "00000000-0000-0000-0000-000000000000" to reset)
topset	String	Topset UUID to set starred (use "00000000-0000-0000-0000-000000000000" to reset)

Response body

Empty body

3. Interpretations

Get interpretations by lateral

Get a list of interpretations by lateral UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/wells/5debff60-a0d8-4d9d-b494-33fec8388fdf/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/5debff60-a0d8-4d9d-b494-33fec8388fdf/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: 356faba69356cdf3
Content-Type: application/json

{
  "content" : [ {
    "name" : "test interpretation 1",
    "uuid" : "54832d2f-cc44-4669-a710-16f0792e182f"
  }, {
    "name" : "test interpretation 2",
    "uuid" : "098098ad-58f9-4d52-ad5b-7f6f0fd2bfb5"
  } ],
  "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	Filter interpretations by the 'name' field. 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

Get starred objects

Get starred objects by interpretation UUID

Request

$ curl 'https://solo.cloud/public/api/v1/interpretations/83131fcd-c38e-4309-93d7-b2728fbf5e80/starred' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/interpretations/83131fcd-c38e-4309-93d7-b2728fbf5e80/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: 1062f9232c5237fc
Content-Type: application/json

{
  "top" : "a05fe9d5-f12f-407f-8f28-e4c7fe5b43f7",
  "center" : "01ba0133-8b52-4de8-9606-c883bd713fa0",
  "bottom" : "c7bd120f-46b5-43d3-96b8-aa86c76de617"
}

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
center	String	Starred center horizon UUID
bottom	String	Starred bottom horizon UUID

Set starred objects

Set starred objects by interpretation UUID

Request

$ curl 'https://solo.cloud/public/api/v1/interpretations/uuid/83131fcd-c38e-4309-93d7-b2728fbf5e80/starred' -i -X PUT \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "top" : "a05fe9d5-f12f-407f-8f28-e4c7fe5b43f7",
  "center" : "01ba0133-8b52-4de8-9606-c883bd713fa0",
  "bottom" : "c7bd120f-46b5-43d3-96b8-aa86c76de617"
}'

PUT /public/api/v1/interpretations/uuid/83131fcd-c38e-4309-93d7-b2728fbf5e80/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 158

{
  "top" : "a05fe9d5-f12f-407f-8f28-e4c7fe5b43f7",
  "center" : "01ba0133-8b52-4de8-9606-c883bd713fa0",
  "bottom" : "c7bd120f-46b5-43d3-96b8-aa86c76de617"
}

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 3d01887cdd91d3d7

PUT /public/api/v1/interpretations/uuid/{uuid}/starred

Path parameter	Description
uuid	Interpretation UUID

Header	Description
Authorization	OAuth2 authorization header

Body field	Type	Description
top	String	Horizon UUID to be set as starred top (use "00000000-0000-0000-0000-000000000000" to reset)
center	String	Horizon UUID to be set as starred center (use "00000000-0000-0000-0000-000000000000" to reset)
bottom	String	Horizon UUID to be set as starred bottom (use "00000000-0000-0000-0000-000000000000" to reset)

Response body

Empty body

Get auto-typewells by interpretation

Get a list of auto-typewells by interpretation UUID

Request

$ curl 'https://solo.cloud/public/api/v1/interpretations/9623171b-e6b6-41ec-ab2e-44b24aa88b0d/autotypewells' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/interpretations/9623171b-e6b6-41ec-ab2e-44b24aa88b0d/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: 4b65b789e98ad9c9
Content-Type: application/json

{
  "content" : [ {
    "auto_typewell_uuid" : "9be7e5b7-3445-408d-82f6-a5cf95c2edc2"
  } ]
}

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

4. Horizons

Get horizons meta

Get a list of horizons by interpretation UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/interpretations/05ec8337-498f-4cff-ac75-cd1ae1d4e33b/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/05ec8337-498f-4cff-ac75-cd1ae1d4e33b/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: a922531326408439
Content-Type: application/json

{
  "content" : [ {
    "name" : "Test horizon 1",
    "uuid" : "e6056c74-ce82-4c34-b4ca-faa694ae2798"
  }, {
    "name" : "Test horizon 2",
    "uuid" : "8db42b2b-5837-436c-9f76-d96f644db5cd"
  }, {
    "name" : "Test horizon 3",
    "uuid" : "f5f60b40-02e1-43e4-acba-17d92edac796"
  } ],
  "offset" : 0,
  "limit" : 20,
  "total" : 3,
  "first" : true,
  "last" : true
}

GET /public/api/v1/interpretations/{interpretationUuid}/horizons

Path parameter	Description
interpretationUuid	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	Filter horizons by the 'name' field. 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

Request

$ curl 'https://solo.cloud/public/api/v1/interpretations/0b009a93-0195-4abf-b90e-3aece49e2ebd/horizons/data/spacing/5000' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/interpretations/0b009a93-0195-4abf-b90e-3aece49e2ebd/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: 9314ea96f7fd2e33
Content-Type: application/json

{
  "content" : [ {
    "azimuth" : {
      "val" : 71.543
    },
    "horizons" : [ {
      "name" : "!new Hor",
      "tvdss" : {
        "val" : 22.965879265091868
      },
      "uuid" : "e00ad90a-ab9f-44a4-8697-ba4f2fc5e7b6"
    }, {
      "name" : "Horizon1",
      "tvdss" : {
        "val" : -3257.8740157480324
      },
      "uuid" : "92ef4922-abc3-46f5-b080-526562f313d1"
    } ],
    "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" : "e00ad90a-ab9f-44a4-8697-ba4f2fc5e7b6"
    }, {
      "name" : "Horizon1",
      "tvdss" : {
        "val" : -3257.8740157480324
      },
      "uuid" : "92ef4922-abc3-46f5-b080-526562f313d1"
    } ],
    "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	Spacing value

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	Well azimuth VS (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 with pagination (one element per page)

Request

$ curl 'https://solo.cloud/public/api/v1/wells/22b97b55-98fd-4c42-9d6d-5eb8fd22a216/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/22b97b55-98fd-4c42-9d6d-5eb8fd22a216/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: f265861ba8c4e93d
Content-Type: application/json

{
  "content" : [ {
    "azimuth" : {
      "val" : 71.543
    },
    "horizons" : [ {
      "name" : "!new Hor",
      "tvdss" : {
        "val" : 22.965879265091868
      },
      "uuid" : "e00ad90a-ab9f-44a4-8697-ba4f2fc5e7b6"
    }, {
      "name" : "Horizon1",
      "tvdss" : {
        "val" : -3257.8740157480324
      },
      "uuid" : "92ef4922-abc3-46f5-b080-526562f313d1"
    } ],
    "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" : "e00ad90a-ab9f-44a4-8697-ba4f2fc5e7b6"
    }, {
      "name" : "Horizon1",
      "tvdss" : {
        "val" : -3257.8740157480324
      },
      "uuid" : "92ef4922-abc3-46f5-b080-526562f313d1"
    } ],
    "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" : "0b009a93-0195-4abf-b90e-3aece49e2ebd"
  },
  "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	Spacing value

Parameter	Description
offset	Each value corresponds to an ordinal index (0 .. N, where N - the total number of interpretations in specified well) of a separate interpretation with its calculated horizons range

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[].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	Well azimuth VS (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

Request

$ curl 'https://solo.cloud/public/api/v1/wells/8db70c5a-f73f-4e76-8de9-43720e59e4e6/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/8db70c5a-f73f-4e76-8de9-43720e59e4e6/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: fedf2bed095ef87b
Content-Type: application/json

{
  "uuid" : "475ab691-bd6d-448c-8e0e-31f8f954845e"
}

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	Wellbore identifier
xsrf.val	Number	X surface wellbore coordinate
ysrf.val	Number	Y surface wellbore coordinate
kb.val	Number	Kelly Bushing (KB) is the height of the Derek (drill rig) measured from the MSL
tie_in_ew.val	Number	TieInEw
tie_in_ns.val	Number	TieInNs
tie_in_tvd.val	Number	TieInTvd

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

Request

$ curl 'https://solo.cloud/public/api/v1/wells/932ab010-b547-49e3-a992-5619befafbf5/nestedwells?offset=0&limit=10&filter=oNe' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/932ab010-b547-49e3-a992-5619befafbf5/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: 9b523dff7a151f80
Content-Type: application/json

{
  "content" : [ {
    "uuid" : "e3f0c1d5-02e8-47b3-8948-d6df7411c678",
    "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/{lateralUuid}/nestedwells

Path parameter	Description
lateralUuid	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	Filter nested wells by the 'name' or 'api' fields. 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 meta

Get nested well metadata data by UUID

Request

$ curl 'https://solo.cloud/public/api/v1/nestedwells/85a628e8-4c99-489d-a630-2c4ca58f4265' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/nestedwells/85a628e8-4c99-489d-a630-2c4ca58f4265 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: df86cfc80113749d
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	Lateral name
operator	String	Operator name
api	String	API lateral number
xsrf.val	Number	X surface coordinate
ysrf.val	Number	Y surface coordinate
kb.val	Number	Kelly Bushing (KB) is the height of the Derek (drill rig) measured from the MSL
tie_in_tvd.val	Number	Tie in tvd coordinates
tie_in_ns.val	Number	Tie in NS
tie_in_ew.val	Number	Tie in EW

Get nested well trajectory

Get nested well trajectory data by nested well UUID

Request

$ curl 'https://solo.cloud/public/api/v1/nestedwells/812d5e68-e0d9-4531-bcdf-594d0f24dfa9/trajectory' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/nestedwells/812d5e68-e0d9-4531-bcdf-594d0f24dfa9/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 2431a0afbaec1387
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/{nestedWellUuid}/trajectory

Path parameter	Description
nestedWellUuid	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)

Update nested well meta

Update nested well metadata

Request

$ curl 'https://solo.cloud/public/api/v1/nestedwells/d45f1262-f5b5-4dc5-8ce6-a5552070c73c' -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/d45f1262-f5b5-4dc5-8ce6-a5552070c73c 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: f71c9525800d6f6d

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
operator	String	Operator name
api	String	API nested well number
xsrf.val	Number	X surface coordinate
xsrf.undefined	Boolean	If true then X surface coordinate will be set as parent
ysrf.val	Number	Y surface coordinate
ysrf.undefined	Boolean	If true then Y surface coordinate will be set as parent
kb.val	Number	Kelly Bushing (KB) is the height of the Derek (drill rig) measured from the MSL
kb.undefined	Boolean	If true then KB will be set as parent
tie_in_tvd.val	Number	Tie in TVD
tie_in_tvd.undefined	Boolean	If true then tie in TVD will be set undefined
tie_in_ns.val	Number	Tie in NS
tie_in_ns.undefined	Boolean	If true then tie in NS will be set undefined
tie_in_ew.val	Number	Tie in EW
tie_in_ew.undefined	Boolean	If true then tie in EW will be set undefined

Response body

Empty body

Extend nested well trajectory

Extend nested well trajectory (note that 'azim' can be used for a trajectory station azimuth as well as 'azi')

Request

$ curl 'https://solo.cloud/public/api/v1/nestedwells/0fde9135-9a7e-4331-8f2d-2bdac7b67cbe/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/0fde9135-9a7e-4331-8f2d-2bdac7b67cbe/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: d65d7b5976ac53c0

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	Depth measure unit of a trajectory stations related to the nested well. Accepted values: m, ft
incl_uom	String	Inclination measure unit of a trajectory stations related to the nested well. Accepted values: dega, rad
azi_uom	String	Azimuth measure unit of a trajectory stations related to the nested well. Accepted values: dega, rad
trajectory_stations	Array	Nested well trajectory data array
trajectory_stations[].md.val	Number	Depth data value
trajectory_stations[].incl.val	Number	Inclination data value
trajectory_stations[].azi.val	Number	Azimuth data value

Response body

Empty body

Replace nested well trajectory

Replace nested well trajectory (note that 'azim' can be used for a trajectory station azimuth as well as 'azi')

Request

$ curl 'https://solo.cloud/public/api/v1/nestedwells/465ad7cb-cf33-4015-ac03-9692f5c33f17/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/465ad7cb-cf33-4015-ac03-9692f5c33f17/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: 9f894d83cd64d38c

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	Depth measure unit of a trajectory stations related to the nested well. Accepted values: m, ft
incl_uom	String	Inclination measure unit of a trajectory stations related to the nested well. Accepted values: dega, rad
azi_uom	String	Azimuth measure unit of a trajectory stations related to the nested well. Accepted values: dega, rad
trajectory_stations	Array	Nested well trajectory data array
trajectory_stations[].md.val	Number	Depth data value
trajectory_stations[].incl.val	Number	Inclination data value
trajectory_stations[].azi.val	Number	Azimuth data value

Response body

Empty body

Set starred topset

Set starred topset by nested well UUID

Request

$ curl 'https://solo.cloud/public/api/v1/nestedwells/uuid/fb1cde84-f4d4-4104-880f-3b0c7ffc40f6/starred' -i -X PUT \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "topset" : "3fa7ad45-f4e6-4782-999c-60a52a695c57"
}'

PUT /public/api/v1/nestedwells/uuid/fb1cde84-f4d4-4104-880f-3b0c7ffc40f6/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 55

{
  "topset" : "3fa7ad45-f4e6-4782-999c-60a52a695c57"
}

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: c155d7eb857be460

PUT /public/api/v1/nestedwells/uuid/{uuid}/starred

Path parameter	Description
uuid	Nested well UUID

Header	Description
Authorization	OAuth2 authorization header

Body field	Type	Description
topset	String	Topset UUID to set starred (use "00000000-0000-0000-0000-000000000000" to reset)

Response body

Empty body

6. Typewells

Create typewell

Create typewell by project UUID

Request

$ curl 'https://solo.cloud/public/api/v1/projects/b104742b-73b7-4668-bccd-996ce552f9da/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/b104742b-73b7-4668-bccd-996ce552f9da/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: 64e38ca67126ae07
Content-Type: application/json

{
  "uuid" : "20ffe70b-44c6-4319-918a-637e8d0fd6bd"
}

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	Convergence
azimuth.val	Number	AzimuthVS
kb.val	Number	Kelly Bushing (KB) is the height of the Derek (drill rig) measured from the MSL
tieintvd.val	Number	TieInTvd
tieinns.val	Number	TieInNs
tieinew.val	Number	TieInEw
xsrfreal.val	Number	X surface wellbore coordinate
ysrfreal.val	Number	Y surface wellbore coordinate

Response body

Path	Type	Description
uuid	String	Created typewell UUID

Get typewells by project

Get a list of typewells by project UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/projects/b104742b-73b7-4668-bccd-996ce552f9da/typewells?offset=0&limit=10&filter=oNe' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/projects/b104742b-73b7-4668-bccd-996ce552f9da/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: a992ca6cd9f6cd53
Content-Type: application/json

{
  "content" : [ {
    "uuid" : "7c13f3cb-a400-40bf-beae-468f4f95e042",
    "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/{projectUuid}/typewells

Path parameter	Description
projectUuid	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	Filter typewells by the 'name' or 'api' fields. 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
content[].flags.has_topsets	Boolean	Flag indicating the presence of topsets
content[].flags.has_mudlogs	Boolean	Flag indicating the presence of mudlogs

Get typewell meta

Get typewell metadata

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/d17a8a6e-742b-487b-a531-7949f48155db' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/typewells/d17a8a6e-742b-487b-a531-7949f48155db 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: 656392bd0c81274f
Content-Type: application/json

{
  "uuid" : "d17a8a6e-742b-487b-a531-7949f48155db",
  "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
ysrf.val	Number	Y surface coordinate
kb.val	Number	Kelly Bushing (KB) is the height of the Derek (drill rig) measured from the MSL
convergence.val	Number	Convergence
tie_in_tvd.val	Number	Tie in tvd coordinates
tie_in_ns.val	Number	Tie in NS
tie_in_ew.val	Number	Tie in EW

Get typewell trajectory

Get typewell trajectory data by typewell UUID

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/171885ee-d1fa-4d87-ad8a-712a32c055a9/trajectory' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/typewells/171885ee-d1fa-4d87-ad8a-712a32c055a9/trajectory HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 0376fbd523043e62
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/{typeWellUuid}/trajectory

Path parameter	Description
typeWellUuid	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)

Get starred topset

Get starred topset by typewell UUID

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/d17a8a6e-742b-487b-a531-7949f48155db/starred' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/typewells/d17a8a6e-742b-487b-a531-7949f48155db/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: 160deb75afa145f9
Content-Type: application/json

{
  "topset" : "e04ee3ab-aba2-405a-a6e0-371478d9b234"
}

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

Get linked laterals

Get linked laterals by typewell UUID

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/24763cc7-6c3a-4c82-a844-1118b8aeb77f/linked?offset=0&limit=10' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/typewells/24763cc7-6c3a-4c82-a844-1118b8aeb77f/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: b61022f5f592b354
Content-Type: application/json

{
  "content" : [ {
    "shift" : {
      "val" : 1640.4199475065616
    },
    "lateral_id" : "86d2c3e4-ccd9-472a-9ac8-8242696f8467"
  } ],
  "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
content[].lateral_id	String	Lateral UUID

Update typewell meta

Update typewell metadata

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/7c13f3cb-a400-40bf-beae-468f4f95e042' -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/7c13f3cb-a400-40bf-beae-468f4f95e042 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: 103352eede6d3ed6

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
operator	String	Operator name
api	String	API typewell number
xsrf.val	Number	X surface coordinate
ysrf.val	Number	Y surface coordinate
kb.val	Number	Kelly Bushing (KB) is the height of the Derek (drill rig) measured from the MSL
convergence.val	Number	Convergence
tie_in_tvd.val	Number	Tie in tvd coordinates
tie_in_ns.val	Number	Tie in NS
tie_in_ew.val	Number	Tie in EW

Response body

Empty body

Extend typewell trajectory

Extend typewell trajectory (note that 'azim' can be used for a trajectory station azimuth as well as 'azi')

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/7c13f3cb-a400-40bf-beae-468f4f95e042/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/7c13f3cb-a400-40bf-beae-468f4f95e042/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: 9877bf2504c37939

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	Depth measure unit of a trajectory stations related to the typewell. Accepted values: m, ft
incl_uom	String	Inclination measure unit of a trajectory stations related to the typewell. Accepted values: dega, rad
azi_uom	String	Azimuth measure unit of a trajectory stations related to the typewell. Accepted values: dega, rad
trajectory_stations	Array	Typewell trajectory data array
trajectory_stations[].md.val	Number	Depth data value
trajectory_stations[].incl.val	Number	Inclination data value
trajectory_stations[].azi.val	Number	Azimuth data value

Response body

Empty body

Replace typewell trajectory

Replace typewell trajectory (note that 'azim' can be used for a trajectory station azimuth as well as 'azi')

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/7c13f3cb-a400-40bf-beae-468f4f95e042/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/7c13f3cb-a400-40bf-beae-468f4f95e042/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: 6d0305e7478ca005

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	Depth measure unit of a trajectory stations related to the typewell. Accepted values: m, ft
incl_uom	String	Inclination measure unit of a trajectory stations related to the typewell. Accepted values: dega, rad
azi_uom	String	Azimuth measure unit of a trajectory stations related to the typewell. Accepted values: dega, rad
trajectory_stations	Array	Typewell trajectory data array
trajectory_stations[].md.val	Number	Depth data value
trajectory_stations[].incl.val	Number	Inclination data value
trajectory_stations[].azi.val	Number	Azimuth data value

Response body

Empty body

Set starred topset

Set starred topset by typewell UUID

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/uuid/d17a8a6e-742b-487b-a531-7949f48155db/starred' -i -X PUT \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "topset" : "e04ee3ab-aba2-405a-a6e0-371478d9b234"
}'

PUT /public/api/v1/typewells/uuid/d17a8a6e-742b-487b-a531-7949f48155db/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 55

{
  "topset" : "e04ee3ab-aba2-405a-a6e0-371478d9b234"
}

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 373930e9107dccab

PUT /public/api/v1/typewells/uuid/{uuid}/starred

Path parameter	Description
uuid	Typewell UUID

Header	Description
Authorization	OAuth2 authorization header

Body field	Type	Description
topset	String	Topset UUID to set starred (use "00000000-0000-0000-0000-000000000000" to reset)

Response body

Empty body

7. Topsets

Create lateral topset

Create topset by lateral UUID

Request

$ curl 'https://solo.cloud/public/api/v1/wells/7d895091-cafe-4707-be5f-9592890d738b/topsets' -i -X POST \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Topset name"
}'

POST /public/api/v1/wells/7d895091-cafe-4707-be5f-9592890d738b/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: 62bdaab832ff4f34
Content-Type: application/json

{
  "uuid" : "cbb80051-07ff-4c93-95e7-65692af266a1"
}

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

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/4660e35c-a7df-46b8-9a00-f04e35310641/topsets' -i -X POST \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Topset name"
}'

POST /public/api/v1/typewells/4660e35c-a7df-46b8-9a00-f04e35310641/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: 1c8e2e77e9aeb92e
Content-Type: application/json

{
  "uuid" : "c63f6785-246f-4fa0-95fe-a9f7c2563466"
}

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

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/7b8c7912-dab8-45d7-baea-0cf8452572d8/topsets' -i -X POST \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Topset name"
}'

POST /public/api/v1/nestedwells/7b8c7912-dab8-45d7-baea-0cf8452572d8/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: 697b2766ab9a8735
Content-Type: application/json

{
  "uuid" : "95e9d896-5aaf-4032-8628-4d52d04fd664"
}

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

Response body

Path	Type	Description
uuid	String	Created topset UUID

Get topsets by lateral

Get a list of topsets by lateral UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/wells/7d895091-cafe-4707-be5f-9592890d738b/topsets?offset=0&limit=10' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/7d895091-cafe-4707-be5f-9592890d738b/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: 09304fdb84eb625b
Content-Type: application/json

{
  "content" : [ {
    "name" : "C Log TopSet mDMrQYgLqi",
    "uuid" : "5e38aff0-dbd2-4b58-9cde-d388f2cd8480"
  }, {
    "name" : "D Well AmNomPaVuX",
    "uuid" : "2c6482fa-dd40-4aa9-b536-88bc47889170"
  }, {
    "name" : "Top Set",
    "uuid" : "a5123673-79f3-4b5f-80c5-bf3dbe6f904c"
  }, {
    "name" : "TopSet Log HsdyYbIxiV",
    "uuid" : "8a1996db-c940-49c5-bb3a-9dbea6ead267"
  }, {
    "name" : "TopSetUiZUhtMBCA",
    "uuid" : "65cc522f-5bf1-491a-b708-48a0bd880205"
  } ],
  "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

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/4660e35c-a7df-46b8-9a00-f04e35310641/topsets?offset=0&limit=10' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/typewells/4660e35c-a7df-46b8-9a00-f04e35310641/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: be44630fe343d4e4
Content-Type: application/json

{
  "content" : [ {
    "name" : "C Log TopSet dIRzshlSMa",
    "uuid" : "0a4df0e0-8e5a-42cd-9630-ad5f9cbd184c"
  }, {
    "name" : "D Well dydaoZoQkT",
    "uuid" : "efb248bc-2f09-430c-9c23-1d28300669d7"
  }, {
    "name" : "TopSetAoDeQGkGku",
    "uuid" : "dccbcae8-f78d-40ec-8361-be049a834288"
  }, {
    "name" : "TopSet Log ivcIciaeFH",
    "uuid" : "ef1c4a61-d317-42aa-9b80-0f94492c1c4a"
  } ],
  "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

Request

$ curl 'https://solo.cloud/public/api/v1/nestedwells/7b8c7912-dab8-45d7-baea-0cf8452572d8/topsets?offset=0&limit=10' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/nestedwells/7b8c7912-dab8-45d7-baea-0cf8452572d8/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: 7a27086eaaf14a09
Content-Type: application/json

{
  "content" : [ {
    "name" : "C Log TopSet CrdcmwcPJi",
    "uuid" : "0a8e3c05-09c1-4aa1-b78b-00a72df7f3a3"
  }, {
    "name" : "D Well CAgDmrtKWu",
    "uuid" : "b15fd16e-af6e-44b0-a57a-25fd4102eff1"
  }, {
    "name" : "TopSet Log jHQOSrBirg",
    "uuid" : "4dc54128-ad81-4654-8fa4-0ee1c1b5d63c"
  }, {
    "name" : "Topset name",
    "uuid" : "95e9d896-5aaf-4032-8628-4d52d04fd664"
  }, {
    "name" : "TopSetznLULzNzmy",
    "uuid" : "1ace1914-9d4b-45d7-b429-cbcbffd82505"
  } ],
  "offset" : 0,
  "limit" : 10,
  "total" : 5,
  "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 starred objects

Get starred objects by topset UUID

Request

$ curl 'https://solo.cloud/public/api/v1/topsets/a5123673-79f3-4b5f-80c5-bf3dbe6f904c/starred' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

GET /public/api/v1/topsets/a5123673-79f3-4b5f-80c5-bf3dbe6f904c/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: f090d65ee3c6f183
Content-Type: application/json

{
  "top" : "85f2d729-51bb-4730-a9df-03bf21b9dc2f",
  "center" : "b2a901a1-6be0-410f-99a1-4534285c962b",
  "bottom" : "1df8a3ea-f40c-4bad-a134-a6025e71580c"
}

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	Starred top top UUID
center	String	Starred center top UUID
bottom	String	Starred bottom top UUID

Set starred objects

Set starred objects by topset UUID

Request

$ curl 'https://solo.cloud/public/api/v1/topsets/uuid/a5123673-79f3-4b5f-80c5-bf3dbe6f904c/starred' -i -X PUT \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "top" : "85f2d729-51bb-4730-a9df-03bf21b9dc2f",
  "center" : "b2a901a1-6be0-410f-99a1-4534285c962b",
  "bottom" : "1df8a3ea-f40c-4bad-a134-a6025e71580c"
}'

PUT /public/api/v1/topsets/uuid/a5123673-79f3-4b5f-80c5-bf3dbe6f904c/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 158

{
  "top" : "85f2d729-51bb-4730-a9df-03bf21b9dc2f",
  "center" : "b2a901a1-6be0-410f-99a1-4534285c962b",
  "bottom" : "1df8a3ea-f40c-4bad-a134-a6025e71580c"
}

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 2ee5db25b31cf70a

PUT /public/api/v1/topsets/uuid/{uuid}/starred

Path parameter	Description
uuid	Topset UUID

Header	Description
Authorization	OAuth2 authorization header

Body field	Type	Description
top	String	Top UUID to be set as starred top (use "00000000-0000-0000-0000-000000000000" to reset)
center	String	Top UUID to be set as starred center (use "00000000-0000-0000-0000-000000000000" to reset)
bottom	String	Top UUID to be set as starred bottom (use "00000000-0000-0000-0000-000000000000" to reset)

Response body

Empty body

8. Tops

Create top

Create top by topset UUID

Request

$ curl 'https://solo.cloud/public/api/v1/topsets/1b46ae9f-7866-4430-a57a-5ec812f19d38/tops' -i -X POST \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Top name",
  "md" : {
    "val" : 100.5
  }
}'

POST /public/api/v1/topsets/1b46ae9f-7866-4430-a57a-5ec812f19d38/tops HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: application/json
Host: solo.cloud
Content-Length: 59

{
  "name" : "Top name",
  "md" : {
    "val" : 100.5
  }
}

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 2d036f1797f27599
Content-Type: application/json

{
  "uuid" : "a3f1b31e-8911-40d5-8cab-cf3021e2916a"
}

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
md	Object	Measured depth. If present val is set, otherwise undefined is true
md.val	Number	Measured depth value in project units (must be in [0;100000] range)
md.undefined	Boolean	Set to true if MD is undefined

Response body

Path	Type	Description
uuid	String	Created top UUID

Get tops by topset

Get a list of tops by topset UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/topsets/c00e0cb2-ecec-4b7d-a93e-a2e3ab9196f2/tops?offset=0&limit=20' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/topsets/c00e0cb2-ecec-4b7d-a93e-a2e3ab9196f2/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: ebeb5ee09ace75b1
Content-Type: application/json

{
  "content" : [ {
    "md" : {
      "val" : 9.842519685039372
    },
    "name" : "Top",
    "topset_name" : "Top Set",
    "uuid" : "506ffcce-6ef3-41f5-9a40-92ba3dca3beb"
  }, {
    "md" : {
      "val" : 13.123359580052496
    },
    "name" : "Update Top",
    "topset_name" : "Top Set",
    "uuid" : "7646ca1b-0196-43d8-848f-afa037dc41a2"
  } ],
  "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	Top name
content[].md.val	Number	Measured depth value in project units

Get tops by lateral

Get a list of tops by lateral UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/wells/4ce71fec-5bac-426f-82fd-56a3cb4e5535/tops?offset=0&limit=20' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/4ce71fec-5bac-426f-82fd-56a3cb4e5535/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: c88573b7c4d47a04
Content-Type: application/json

{
  "content" : [ {
    "md" : {
      "val" : 9.842519685039372
    },
    "name" : "Top",
    "topset_name" : "Top Set",
    "uuid" : "adcb24cf-daeb-4fd7-93a4-8ae7ce7e86d9"
  }, {
    "md" : {
      "val" : 13.123359580052496
    },
    "name" : "Update Top",
    "topset_name" : "Top Set",
    "uuid" : "b29e79b9-0a34-4b08-a675-f5944a79512f"
  } ],
  "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	Top name
content[].md.val	Number	Measured depth value in project units

Get tops by typewell

Get a list of tops by typewell UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/cb8da2aa-38d1-495d-be30-26de169949cc/tops?offset=0&limit=20' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/typewells/cb8da2aa-38d1-495d-be30-26de169949cc/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: d0f7769f0943703a
Content-Type: application/json

{
  "content" : [ {
    "md" : {
      "val" : 9.842519685039372
    },
    "name" : "Top",
    "topset_name" : "Top Set",
    "uuid" : "b2079a6c-6f5f-4b87-8ccf-5df57261d04c"
  }, {
    "md" : {
      "val" : 13.123359580052496
    },
    "name" : "Update Top",
    "topset_name" : "Top Set",
    "uuid" : "2d4ed772-ad32-4063-9345-b665551caf70"
  } ],
  "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	Top name
content[].md.val	Number	Measured depth value in project units

Get tops by nested well

Get a list of tops by nested well UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/nestedwells/a25902af-a439-4fb1-bffb-e2cf71b83d21/tops?offset=0&limit=20' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/nestedwells/a25902af-a439-4fb1-bffb-e2cf71b83d21/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: a92a1a46310df843
Content-Type: application/json

{
  "content" : [ {
    "md" : {
      "val" : 9.842519685039372
    },
    "name" : "Top",
    "topset_name" : "Top Set",
    "uuid" : "5aae8c09-80a0-4f75-8f2d-3124962cd3f3"
  }, {
    "md" : {
      "val" : 13.123359580052496
    },
    "name" : "Update Top",
    "topset_name" : "Top Set",
    "uuid" : "bd19bb00-b685-4616-9892-d14edfcb59ca"
  } ],
  "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	Top name
content[].md.val	Number	Measured depth value in project units

9. Target lines

Create target line

Create target line by lateral UUID

Request

$ curl 'https://solo.cloud/public/api/v1/wells/e3ce714f-ad3c-4799-a453-a32f32a8e6ab/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/e3ce714f-ad3c-4799-a453-a32f32a8e6ab/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: 2aaf51d571ba6b6a
Content-Type: application/json

{
  "uuid" : "9d95d93b-4dee-4480-819a-bb47e27cf148"
}

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
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

Get target lines by lateral

Get a list of target lines by lateral UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/wells/d0525adc-c986-4cdf-89c4-ad98c0b29258/targetlines?offset=0&limit=20' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/d0525adc-c986-4cdf-89c4-ad98c0b29258/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: be32b8e9b02291a3
Content-Type: application/json

{
  "content" : [ {
    "name" : "Target Line",
    "uuid" : "633db506-143e-4465-a9d5-d0f3be0d8a62"
  }, {
    "name" : "Update Target Line",
    "uuid" : "e7543fe5-130d-42f3-a00d-f51b894adeb0"
  } ],
  "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

Get target line data

Get a list of target line data by target line UUID

Request

$ curl 'https://solo.cloud/public/api/v1/targetlines/05905ab4-ac79-490f-bd8d-9732c6c1fecc/data' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/targetlines/05905ab4-ac79-490f-bd8d-9732c6c1fecc/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 8dac4afa711c5966
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" : {
      "undefined" : true
    },
    "origin_md" : {
      "val" : 1601.392124079087
    },
    "origin_top_corridor_tvd" : {
      "undefined" : true
    },
    "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" : {
      "undefined" : true
    },
    "target_md" : {
      "val" : 1112.7999494309042
    },
    "target_top_corridor_tvd" : {
      "undefined" : true
    },
    "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" : "05905ab4-ac79-490f-bd8d-9732c6c1fecc"
  } ]
}

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	Difference between target and base TVD (project units)
content[].delta_vs.val	Number	Difference between target and base VS (project units)
content[].tvd_vs.val	Number	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 a list of target lines data by lateral UUID

Request

$ curl 'https://solo.cloud/public/api/v1/wells/70d36182-29ef-4171-8eaa-9b2307203d4b/targetlines/data?offset=0&limit=20' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/70d36182-29ef-4171-8eaa-9b2307203d4b/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: 497b4b3aaa7f2837
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" : {
      "undefined" : true
    },
    "origin_md" : {
      "val" : 1601.392124079087
    },
    "origin_top_corridor_tvd" : {
      "undefined" : true
    },
    "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" : {
      "undefined" : true
    },
    "target_md" : {
      "val" : 1112.7999494309042
    },
    "target_top_corridor_tvd" : {
      "undefined" : true
    },
    "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" : "a10935b2-801a-4e6c-9f85-5d95cd724f5f"
  } ],
  "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	Difference between target and base TVD (project units)
content[].delta_vs.val	Number	Difference between target and base VS (project units)
content[].tvd_vs.val	Number	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

Request

$ curl 'https://solo.cloud/public/api/v1/wells/5c69bd31-4cf1-4bf4-a383-149b5b12e8df/targetlines/starred' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/5c69bd31-4cf1-4bf4-a383-149b5b12e8df/targetlines/starred HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: d85d5708a7852874
Content-Type: application/json

{
  "name" : "Target Line",
  "uuid" : "fad7d434-f5dc-48d2-83f1-157d4b92c1f0"
}

GET /public/api/v1/wells/{lateralUuid}/targetlines/starred

Path parameter	Description
lateralUuid	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 by UUID

Request

$ curl 'https://solo.cloud/public/api/v1/targetlines/58fe27d2-1389-425f-816f-379588da1e06' -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/58fe27d2-1389-425f-816f-379588da1e06 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: 1f78d07517f0f595

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
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

Delete target line

Delete target line by UUID

Request

$ curl 'https://solo.cloud/public/api/v1/targetlines/4dd3a51c-beeb-4de5-866a-bc6c5ecaa49a' -i -X DELETE \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json'

DELETE /public/api/v1/targetlines/4dd3a51c-beeb-4de5-866a-bc6c5ecaa49a 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: 7095914f4db1517b

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

Request

$ curl 'https://solo.cloud/public/api/v1/wells/64030200-2238-41f9-a80c-bad979495bc2/logs' -i -X POST \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Log name"
}'

POST /public/api/v1/wells/64030200-2238-41f9-a80c-bad979495bc2/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: 50a02761e9c1b5c7
Content-Type: application/json

{
  "uuid" : "d3a45ca1-5f5d-47e1-9136-dd44a5aaeede"
}

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

Response body

Path	Type	Description
uuid	String	Created log UUID

Create typewell log

Create log by typewell UUID

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/e3102691-324c-4ef5-a063-d85f1602120a/logs' -i -X POST \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Log name"
}'

POST /public/api/v1/typewells/e3102691-324c-4ef5-a063-d85f1602120a/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: c3a6c20c43af741c
Content-Type: application/json

{
  "uuid" : "fa98279b-77df-4a39-b83e-4bd0b43e6849"
}

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

Response body

Path	Type	Description
uuid	String	Created log UUID

Get logs by lateral

Get a list of logs by lateral UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/wells/585d99d6-3be7-414e-b783-46a7c6be1471/logs?offset=0&limit=10&filter=mMa' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/585d99d6-3be7-414e-b783-46a7c6be1471/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: a80dbe0b536e2c23
Content-Type: application/json

{
  "content" : [ {
    "name" : "Gamma Ray",
    "uuid" : "643e2053-db72-4d6e-b172-fe9b130a52c3"
  } ],
  "offset" : 0,
  "limit" : 10,
  "total" : 1,
  "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	Filter logs by the 'name' field. 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[].uuid	String	Log UUID

Get logs by typewell

Get a list of logs by typewell UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/22af40cb-123a-49fd-804f-73264fef8d34/logs?offset=0&limit=10&filter=mMa' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/typewells/22af40cb-123a-49fd-804f-73264fef8d34/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: 66cf97155954baa3
Content-Type: application/json

{
  "content" : [ {
    "name" : "Gamma Ray",
    "uuid" : "d48e75fc-c3de-4b4f-b7e9-f6e89f2dde8a"
  } ],
  "offset" : 0,
  "limit" : 10,
  "total" : 1,
  "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	Filter logs by the 'name' field. 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[].uuid	String	Log UUID

Get log data

Get log data by log UUID

Request

$ curl 'https://solo.cloud/public/api/v1/logs/b497ae63-8f9d-4238-8957-3e603b30d2c9/data' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/logs/b497ae63-8f9d-4238-8957-3e603b30d2c9/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: d4c6849212771170
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
log_points[].data.val	Number	Point data value
log_points[].md	Object	Point MD
log_points[].md.val	Number	Point MD value

Update log meta

Update log metadata

Request

$ curl 'https://solo.cloud/public/api/v1/logs/b497ae63-8f9d-4238-8957-3e603b30d2c9' -i -X PATCH \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Log name"
}'

PATCH /public/api/v1/logs/b497ae63-8f9d-4238-8957-3e603b30d2c9 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: dc6ab4773832411c

PATCH /public/api/v1/logs/{uuid}

Path parameter	Description
uuid	Log UUID

Header	Description
Authorization	OAuth2 authorization header

Body field	Type	Description
name	String	Log name
unit	String	Measure unit of point data values related to the log

Response body

Empty body

Extend log data

Extend log data

Request

$ curl 'https://solo.cloud/public/api/v1/logs/342851b3-8b1e-403f-a88b-a01149600722/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/342851b3-8b1e-403f-a88b-a01149600722/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: 1ea67c6c0047d8c7

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 point MD values related to the log. Accepted values: m, ft
value_unit	String	Measure unit of point data values related to the log
log_points	Array	Log points array
log_points[].value.val	Number	Point data value
log_points[].index.val	Number	Point MD value

Response body

Empty body

Replace log data

Replace log data

Request

$ curl 'https://solo.cloud/public/api/v1/logs/b497ae63-8f9d-4238-8957-3e603b30d2c9/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/b497ae63-8f9d-4238-8957-3e603b30d2c9/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: 462ea2cff72b3305

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 point MD values related to the log. Accepted values: m, ft
value_unit	String	Measure unit of point data values related to the log
log_points	Array	Log points array
log_points[].value.val	Number	Point data value
log_points[].index.val	Number	Point MD value

Response body

Empty body

11. Images

Create image

Request

$ curl 'https://solo.cloud/public/api/v1/laterals/03bb320c-153d-469a-9b2e-debed367d905/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/laterals/03bb320c-153d-469a-9b2e-debed367d905/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: 1d899368ed6b5180
Content-Type: application/json

{
  "uuid" : "1d197db6-a40a-46f6-8a1e-63bdb53df2e8"
}

POST /public/api/v1/laterals/{lateralUuid}/images

Path parameter	Description
lateralUuid	Lateral UUID

Header	Description
Authorization	OAuth2 authorization header

Body field	Type	Description
name	String	Image name
azimuth.val	Number	Azimuth in degrees image is applicable to. If missed azimuth from lateral will be applied
bottom_left	Object	Bottom left image anchor point
top_right	Object	Top right image anchor point
bottom_left.vs.val	Number	VS point coordinate value in project units
bottom_left.tvdss.val	Number	TVDSS point coordinate value in project units
top_right.vs.val	Number	VS point coordinate value in project units
top_right.tvdss.val	Number	TVDSS point coordinate value in project units

Response body

Path	Type	Description
uuid	String	Created image UUID

Update image

Request

$ curl 'https://solo.cloud/public/api/v1/images/39e23645-4345-4487-8fa4-66d55d81cb3d' -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/39e23645-4345-4487-8fa4-66d55d81cb3d 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: 6fc79b675ed516c9

PUT /public/api/v1/images/{imageUuid}

Path parameter	Description
imageUuid	Updated image UUID

Header	Description
Authorization	OAuth2 authorization header

Body field	Type	Description
name	String	Image name
azimuth.val	Number	Azimuth in degrees image is applicable to. If missed azimuth from lateral will be applied
bottom_left	Object	Bottom left image anchor point
top_right	Object	Top right image anchor point
bottom_left.vs.val	Number	VS point coordinate value in project units
bottom_left.tvdss.val	Number	TVDSS point coordinate value in project units
top_right.vs.val	Number	VS point coordinate value in project units
top_right.tvdss.val	Number	TVDSS point coordinate value in project units

Response body

Empty body

Upload image

Request

$ curl 'https://solo.cloud/public/api/v1/images/b896520d-a467-47dd-8d99-a4d778124813/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/b896520d-a467-47dd-8d99-a4d778124813/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: 19a51eddc6117121

PUT /public/api/v1/images/{imageUuid}/data

Path parameter	Description
imageUuid	Image UUID

Header	Description
Authorization	OAuth2 authorization header
Content-Type	Image type. Only 'image/png' is supported at the moment

Response body

Empty body

Upload image (multipart)

Request

$ curl 'https://solo.cloud/public/api/v1/images/d776fbc7-ee3a-447d-9fbd-3be880f89aa8/data' -i -X PUT \
    -H 'Authorization: Bearer <your_access_token>' \
    -H 'Content-Type: multipart/form-data; boundary="8i8VeTtuvRf2Z6z0GAF-gigLZGNiTRvmdEj"' \
    -F 'image=<binary image data>;type=image/png'

PUT /public/api/v1/images/d776fbc7-ee3a-447d-9fbd-3be880f89aa8/data HTTP/1.1
Authorization: Bearer <your_access_token>
Content-Type: multipart/form-data; boundary="8i8VeTtuvRf2Z6z0GAF-gigLZGNiTRvmdEj"; 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: e50e231d31eb7d0d

PUT /public/api/v1/images/{imageUuid}/data

Path parameter	Description
imageUuid	Image UUID

Part	Description
image	Request part containing PNG image

Header	Description
Authorization	OAuth2 authorization header

Response body

Empty body

12. Mudlogs

Get mudlogs by lateral

Get a list of mudlogs by lateral UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/wells/232b5d13-4749-442f-948a-3a90e634bcd8/mudlogs?offset=0&limit=10&filter=mMa' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/wells/232b5d13-4749-442f-948a-3a90e634bcd8/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: 5cbab78dd4ed7b3f
Content-Type: application/json

{
  "content" : [ {
    "name" : "Gamma Ray",
    "uuid" : "38d57b32-038c-4bd3-9524-a0df1b00d906"
  } ],
  "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	Filter mudlogs by the 'name' field. 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

Request

$ curl 'https://solo.cloud/public/api/v1/typewells/569f839b-5864-4100-b4df-5404f753ca26/mudlogs?offset=0&limit=10&filter=mMa' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/typewells/569f839b-5864-4100-b4df-5404f753ca26/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: 0c84b07ce7f61c60
Content-Type: application/json

{
  "content" : [ {
    "name" : "Gamma Ray",
    "uuid" : "aaa62fb2-2268-452f-b04e-ed2100b4c621"
  } ],
  "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	Filter mudlogs by the 'name' field. 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 a list of mudlogs by typewell UUID with pagination

Request

$ curl 'https://solo.cloud/public/api/v1/mudlogs/5c4d7f19-b691-447b-8efa-b02c46b3ad87/data' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/mudlogs/5c4d7f19-b691-447b-8efa-b02c46b3ad87/data HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: de97e2b3c754f086
Content-Type: application/json

{
  "logs" : [ {
    "name" : "Gzipped Mudlog",
    "uuid" : "d4f2af81-db9b-4a0f-aebd-ae959e74020c",
    "log_points" : [ {
      "data" : {
        "val" : -3688.6927
      },
      "md" : {
        "val" : 2443.0
      }
    }, {
      "data" : {
        "val" : 16.581
      },
      "md" : {
        "val" : 2443.5
      }
    }, {
      "data" : {
        "val" : -11.85
      },
      "md" : {
        "val" : 2444.0
      }
    }, {
      "data" : {
        "val" : 15.187
      },
      "md" : {
        "val" : 2444.5
      }
    }, {
      "data" : {
        "val" : -4.363
      },
      "md" : {
        "val" : 2445.0
      }
    }, {
      "data" : {
        "val" : -40.475
      },
      "md" : {
        "val" : 2445.5
      }
    }, {
      "data" : {
        "val" : 61.463
      },
      "md" : {
        "val" : 2446.0
      }
    }, {
      "data" : {
        "val" : 82.305
      },
      "md" : {
        "val" : 2446.5
      }
    }, {
      "data" : {
        "val" : 114.139
      },
      "md" : {
        "val" : 2447.0
      }
    }, {
      "data" : {
        "val" : 144.503
      },
      "md" : {
        "val" : 2447.5
      }
    } ]
  } ]
}

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	Log UUID
logs[].name	String	Log name
logs[].log_points[].md.val	Number	MD (project units)
logs[].log_points[].data.val	Number	Data value

13. Traces

Get traces collection

Get the list of predefined traces

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: 2a24ad02f395d733
Content-Type: application/json

{
  "content" : [ {
    "uuid" : "f93bf5a7-9755-4163-9c44-6d107967db4b",
    "name" : "Bit depth"
  }, {
    "uuid" : "d635c218-3d17-4f5d-98b4-026085c4f584",
    "name" : "Hole Depth"
  }, {
    "uuid" : "cbfc47a9-4bb0-4a69-9747-136b5b5fa453",
    "name" : "Block position"
  }, {
    "uuid" : "dfdf09da-5be0-495f-b802-15840ce93066",
    "name" : "Hookload"
  }, {
    "uuid" : "30652f8a-15d2-4a10-9e86-2943a7bd5687",
    "name" : "Surface RPM"
  }, {
    "uuid" : "de8ce461-cf26-4e38-ac68-e2e228c331ab",
    "name" : "Surface Torque"
  }, {
    "uuid" : "f764306b-302e-4500-8518-4f149f839a85",
    "name" : "Standpipe Pressure"
  }, {
    "uuid" : "4457de71-ae74-4fd6-ad87-c0f19275806e",
    "name" : "Mud Weight IN"
  }, {
    "uuid" : "627bb479-067b-4e60-b4de-7679c48c6d0f",
    "name" : "Downhole WOB"
  }, {
    "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" : "8b6023ce-d4d7-46be-b9e1-d9ebc92b2711",
    "name" : "Surface Torque Max"
  }, {
    "uuid" : "1690e9e7-3c19-4053-8788-6935a0b2d034",
    "name" : "Block Velocity"
  }, {
    "uuid" : "cf0042b1-9c10-4eca-8aa6-3954147f4fad",
    "name" : "Gas"
  }, {
    "uuid" : "6565f21c-0d1e-4ce6-bbcf-da4b7900f2f4",
    "name" : "Total Tank Volume"
  }, {
    "uuid" : "107b71c0-ebe1-484f-91c3-c5f57a5ee2ba",
    "name" : "Trip Tank Volume"
  }, {
    "uuid" : "999d98fd-b761-488f-9af8-dca909ec7bd8",
    "name" : "Mud Weight Out"
  }, {
    "uuid" : "354dbda4-8dc0-40e8-9723-8b63b794a003",
    "name" : "Survey MD"
  }, {
    "uuid" : "624e443b-6a3b-4247-a648-53db39d19f1b",
    "name" : "Inclination"
  }, {
    "uuid" : "a3fcfa5d-8881-499d-91e8-48a7b3dc2215",
    "name" : "Cont Inclination"
  }, {
    "uuid" : "a415fee9-3992-4915-9ba2-262b084500f9",
    "name" : "Azimuth"
  }, {
    "uuid" : "512cf80d-8872-435f-8e88-bed593b12670",
    "name" : "Cont Azimuth"
  }, {
    "uuid" : "bda8a0dd-ced2-46bd-a82a-1db75b62653c",
    "name" : "Gamma Ray"
  }, {
    "uuid" : "c4d4b89e-5e6c-404f-9d8d-5ca8b2c26885",
    "name" : "Resistivity"
  }, {
    "uuid" : "fd5fdd95-2cd8-4879-8403-2509ee3f66ee",
    "name" : "Density"
  }, {
    "uuid" : "19d0f8f5-fd1c-41f8-86c4-939a5dada63e",
    "name" : "Caliper"
  }, {
    "uuid" : "78b342b0-ec47-4d9b-ae3a-0df49448c1ec",
    "name" : "ECD"
  }, {
    "uuid" : "3d1105fa-a8de-4e54-981f-105b75142937",
    "name" : "StickSlip"
  }, {
    "uuid" : "f49024eb-cdf9-42a4-beca-974dc8348281",
    "name" : "Shock Levels"
  }, {
    "uuid" : "92e27c5f-3277-4a5c-a478-b9a989944671",
    "name" : "On bottom hours"
  }, {
    "uuid" : "274c2682-91d7-4a31-b0e3-8928ef561f0a",
    "name" : "Circulation hours"
  }, {
    "uuid" : "e2fb4974-ec46-4ea9-8709-c88bc36a2b6d",
    "name" : "User Defined 1"
  }, {
    "uuid" : "e59daa2c-64db-4a2e-bb7c-09acef11dc2e",
    "name" : "User Defined 2"
  }, {
    "uuid" : "7f7be1d3-ec46-4082-a954-dbe1e7ea9f8b",
    "name" : "User Defined 3"
  }, {
    "uuid" : "03e25dfc-8f2f-4264-a26d-8b2901124345",
    "name" : "User Defined 4"
  }, {
    "uuid" : "b011d505-d3ba-4401-a833-a6b9c7d50cdd",
    "name" : "User Defined 5"
  }, {
    "uuid" : "cf3b4243-195d-4363-b4dd-58a3c25100fe",
    "name" : "User Defined 6"
  }, {
    "uuid" : "1538bd80-2e41-48d3-8df2-e588fc02d403",
    "name" : "User Defined 7"
  }, {
    "uuid" : "ea5eab65-2d61-4893-8598-15e754c9bf97",
    "name" : "User Defined 8"
  }, {
    "uuid" : "e99c00e0-9ca4-4d90-9f00-213eb17a2dcf",
    "name" : "User Defined 9"
  }, {
    "uuid" : "d1117878-8b29-431e-8a30-1dab930623e9",
    "name" : "User Defined 10"
  }, {
    "uuid" : "702c9494-7666-435f-ad46-9c6a3f24faa3",
    "name" : "Mud Flow In"
  }, {
    "uuid" : "44596b6b-f833-4299-aaf7-519c7b27e8e1",
    "name" : "WOB"
  }, {
    "uuid" : "3a655e25-ff42-4c56-b083-9d6cc77a7a8c",
    "name" : "In Slips"
  }, {
    "uuid" : "f86e140e-b5d0-4b5f-98de-951200fd8038",
    "name" : "GTF"
  }, {
    "uuid" : "805070d4-e80a-4d0d-83d6-430ba7ab00bf",
    "name" : "MTF"
  }, {
    "uuid" : "b68b2510-7858-4dcb-b242-57fcd584e0aa",
    "name" : "ROP"
  }, {
    "uuid" : "1e96aa39-75b9-4990-8042-a02a61a08646",
    "name" : "Downhole TQ"
  }, {
    "uuid" : "508ac83a-8d7e-45e6-b8c7-be7aa5dccbec",
    "name" : "Bit Depth Vertical"
  }, {
    "uuid" : "2d9cbed5-4d21-4243-89e6-586f1bb961ff",
    "name" : "Hole Depth Vertical"
  }, {
    "uuid" : "8595db67-37e0-4389-8f29-6753c9a9e2f7",
    "name" : "WOB Max"
  }, {
    "uuid" : "5a89a54f-3c8e-40c9-8fae-fdb7437b8adb",
    "name" : "Total RPM"
  }, {
    "uuid" : "65c71407-9a65-484d-aeed-b4ef14b91582",
    "name" : "Mud Flow Out"
  }, {
    "uuid" : "992a7d4e-f854-424d-911a-c674ef8e87f4",
    "name" : "Flow"
  }, {
    "uuid" : "e5145f9f-e946-432c-ab0b-6bf0fbe9188c",
    "name" : "Casing Pressure"
  }, {
    "uuid" : "30ad129a-4854-4bb5-8e1d-3c9065605fe2",
    "name" : "Pump Stroke Count"
  }, {
    "uuid" : "9d444b75-4c6b-496c-a945-f75f003e7a0a",
    "name" : "Temperature Out"
  }, {
    "uuid" : "7a76ccd8-e64f-4155-9184-d5f66ac3a58a",
    "name" : "Temperature In"
  }, {
    "uuid" : "ab7e5866-a3da-4e6c-b584-523799719b34",
    "name" : "KPI: Slip to slip"
  }, {
    "uuid" : "e3c996b6-9cdb-4876-ac99-0aab694b801a",
    "name" : "Rig Activity"
  }, {
    "uuid" : "eb85cf68-047e-43b0-bbbb-75548c8e700e",
    "name" : "KPI: Trip In: Connection"
  }, {
    "uuid" : "f65f24d3-a306-4a1c-9765-5b8359aed7c3",
    "name" : "KPI: Trip Out: Running"
  }, {
    "uuid" : "fed6681e-1f21-466c-bf91-55fed528a07d",
    "name" : "KPI: Trip In: Running"
  }, {
    "uuid" : "0f936580-1edd-449c-b760-9142097dfec6",
    "name" : "SPM Total"
  }, {
    "uuid" : "43b1d9c6-4420-4866-9c1f-c3f9d1d5f543",
    "name" : "KPI: Weight to Weight"
  }, {
    "uuid" : "5fe2a454-86ad-4fdc-abbf-686e4f67a4fa",
    "name" : "KPI: Trip Out: Connection"
  } ]
}

GET /public/api/v1/traces

Header	Description
Authorization	OAuth2 authorization header

Response body

Path	Type	Description
content	Array	Traces collection
content[].uuid	String	Trace UUID
content[].name	String	Trace name

Get mapped traces by lateral

Get the list of mapped traces by lateral

Request

$ curl 'https://solo.cloud/public/api/v1/laterals/fdae734d-20c9-47bf-a5cf-3023af4e6ae4/traces/mapped?type=TIME' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/laterals/fdae734d-20c9-47bf-a5cf-3023af4e6ae4/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: 706b268a1aa071b1
Content-Type: application/json

{
  "content" : [ {
    "uuid" : "d635c218-3d17-4f5d-98b4-026085c4f584",
    "name" : "Hole Depth",
    "hash" : "c22cb85014148e31f20c7859176825c5",
    "unit" : "m",
    "start_date_time_index" : "2019-11-01T00:00:00Z",
    "last_date_time_index" : "2020-11-01T00:02:00Z"
  } ]
}

GET /public/api/v1/laterals/{lateralUuid}/traces/mapped

Path parameter	Description
lateralUuid	Lateral UUID

Parameter	Description
type	Trace type (DEPTH/TIME)

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	Trace hash
content[].unit	String	Trace unit
content[].start_date_time_index	String	Start date time index
content[].last_date_time_index	String	Last date time index

Get log data by lateral and trace

Get log data by lateral and trace linked to WITSML

Request

$ curl 'https://solo.cloud/public/api/v1/laterals/fdae734d-20c9-47bf-a5cf-3023af4e6ae4/traces/d635c218-3d17-4f5d-98b4-026085c4f584/data/time?from=2019-11-01T00%3A00%3A00Z&to=2020-11-01T00%3A02%3A00Z' -i -X GET \
    -H 'Authorization: Bearer <your_access_token>'

GET /public/api/v1/laterals/fdae734d-20c9-47bf-a5cf-3023af4e6ae4/traces/d635c218-3d17-4f5d-98b4-026085c4f584/data/time?from=2019-11-01T00%3A00%3A00Z&to=2020-11-01T00%3A02%3A00Z HTTP/1.1
Authorization: Bearer <your_access_token>
Host: solo.cloud

Response

HTTP/1.1 200 OK
X-Solo-Trace-Id: 013c109b8fda9d6b
Content-Type: application/json

{
  "content" : [ {
    "index" : "2019-11-01T00:00:00.000Z",
    "value" : "1.0"
  }, {
    "index" : "2019-11-03T00:01:00.000Z",
    "value" : "4.0"
  }, {
    "index" : "2020-11-01T00:00:00.000Z",
    "value" : "1.0"
  }, {
    "index" : "2020-11-01T00:01:00.000Z",
    "value" : "2.0"
  }, {
    "index" : "2020-11-01T00:02:00.000Z",
    "value" : "3.0"
  } ]
}

GET /public/api/v1/laterals/{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
to	(Optional) End date, for example: 2020-11-01T00:02:00.000Z
hash	(Optional) Trace hash
limit	(Optional) Limit of returning rows. Default 1000, max 1_000_000

Header	Description
Authorization	OAuth2 authorization header

Response body

Path	Type	Description
content	Array	Log data array
content[].index	String	an index value
content[].value	String	a value of the requested trace

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

400 Bad Request

The request cannot be fulfilled due to bad syntax, validation errors, missing data, etc.

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.

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": "No well found with uuid=df34fj4398f34098fj344",
  "trace_id": "d369294dba75b180",
  "type": "NOT_FOUND"
}

406 Not Acceptable

The parameters provided are incorrect.

Response

HTTP/1.1 406 Not Acceptable
{
    "message": "This interpretation's type is not supported",
    "trace_id": "d4e9313ff6267dd5",
    "type": "INVALID_PARAMETER"
}

500 Internal Server Error

The request cannot be fulfilled due to internal server error.

Response

HTTP/1.1 500 Internal server error
{
  "message": "Internal 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 temporarily unavailable",
  "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.

1. 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.

2. 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.

3. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

4. 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.

5. 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.

6. 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

7. 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.

8. Notwithstanding the foregoing, Sections 4-6 of this Agreement will survive any termination of this Agreement.