CursorQueryRequest

Cloud APIs

CursorQueryRequest

kindstring or Array of stringsrequired

Example:"slb-osdu-prod-des-prod-testing:welldb:wellbore:1.0.0"

One of:

Specify a single kind, e.g., "slb-osdu-prod-des-prod-testing:welldb:wellbore:1.0.0"

string

limitinteger, (int32), [ 0 .. 1000 ]

The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 1000.

Example:30

querystring

The query string in Lucene query string syntax.

Example:"data.Basin:\"Ft. Worth\""

returnedFieldsArray of strings

The fields on which to project the results.

Example:

[
  "data.kind"
]

sortobject(SortQuery)

Example:

{
  "field": [
    "createTime"
  ],
  "order": [
    "DESC"
  ]
}

queryAsOwnerboolean

The queryAsOwner switches between viewer and owner to return results that you are entitled to view or results you are the owner of.

Example:false

spatialFilterobject(SpatialFilter)

Example:

{
  "field": "data.SpatialLocation.Wgs84Coordinates",
  "byBoundingBox": {
    "topLeft": { … },
    "bottomRight": { … }
  }
}

cursorstring

Search context to retrieve next batch of results.

Example:"<put a valid cursor or leave it blank for the first request>"

{
  "kind": "slb-osdu-prod-des-prod-testing:welldb:wellbore:1.0.0",
  "limit": 30,
  "query": "data.Basin:\"Ft. Worth\"",
  "returnedFields": [
    "data.kind"
  ],
  "queryAsOwner": false,
  "cursor": "<put a valid cursor or leave it blank for the first request>"
}