LUlucid
Data Item

Get Data Items By Key

Returns all data items in the specified collection whose field values match the values specified in a Data Item By Key Find JSON Object. If necessary, you can paginate this endpoint's results using query parameters. Note: For more complex data item search queries, consider using the filter parameter with Get All Data Items.

post/collections/{collectionId}/items/{dataItemId}

Request

  • Base URL
    https://data.lucid.app
  • URL
    https://data.lucid.app/collections/{collectionId}/items/{dataItemId}
  • Auth
    OAuth 2
    Authorization code: https://lucid.app/oauth2/authorize
    Token URL: https://api.lucid.co/oauth2/token scopes: data-service.admin

Path parameters

collectionIdinteger required

ID of collection to get data items from

dataItemIdinteger required

ID of data item to get

Query parameters

startinteger
Example:1

Starting 1-based index of the data items to return. Defaults to 1.

endinteger
Example:100

Ending 1-based index of the data items to return. Defaults to 10000.

Request body

keySchemaFieldsstring[]

Fields used to search for items in the collection. If it is not provided, primary keys from the schema are used.

Example request

{
  "targetValues": [
    {
      "fieldValues": [
        "Ontario"
      ]
    }
  ],
  "keySchemaFields": [
    "Province"
  ]
}

Response

OK with paginated list of Data Items

totalinteger

Total number of data items in the collection

prevstring

Link to get the previous set of data items

nextstring

Link to get the next set of data items

Example response

{
  "items": [
    {
      "uri": "https://data.lucid.app/collections/2/items/4",
      "collection": "https://data.lucid.app/collections/2",
      "fields": {
        "Co1B": "value1",
        "Co2B": "value2"
      }
    }
  ],
  "total": 175,
  "prev": "https://data.lucid.app/collections/2/items?start=1&end=100",
  "next": "https://data.lucid.app/collections/2/items?start=201&end=300"
}

Changes

No recorded changes to this operation across all 1 revision of this API.