Get DataStoreMetadata by ID

Retrieves a single DataStoreMetadata by its unique identifier. Data stores provide structured data storage.

GET /api/data-stores/{id}

Get DataStoreMetadata by ID

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/data-stores/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "eventAware": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "deleteProtection": true,
    "metadata": {
      "indexed": true,
      "type": "<string>"
    },
    "storePurpose": "<string>",
    "storeType": "<string>"
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "supportsScheduling": true,
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id · string<uuid> · required

Unique identifier (UUID) of the resource.

Response

200

application/json

The DataStoreMetadata

Data store metadata describes a data store for structured data storage.

changeSequence · integer<int32>

createdOn · string<date-time>

deleteUserEmail · string | null

deleteUserId · string | null

deleted · boolean

deletedDate · string<date-time> | null

deprecated · boolean

eventAware · boolean | null

extensionPackRef · string

id · string

metadata · object

Show child attributes

name · string

organizationId · string

publicAccess · boolean

slug · string

supportsScheduling · boolean | null

template · boolean

type · string

updatedOn · string<date-time>

uuid · string

yamlSource · string | null