ovidens
API-Referenz

The app's dataset nodes and their declared column schemas

GET/v1/apps/{app}/datasets

The app's dataset nodes with the column schema each one declares: every column's technical id, its type, whether a value is required, its permitted values where it is an enumeration, and which CSV value options apply to it. Requires the workspace:read scope, and the app must be an analytic one. The declared schema is the integration contract: a CSV whose header does not match it is rejected in full, so read it before building the file rather than after a failed import. A cell of an enumerated column carries the option's LABEL, and enumValues is exactly that list of labels; options reports the same options in the same order with the stable id the platform stores and the description the author wrote, so a renamed option is recognisable as the same option rather than as a new one.

Authorization

bearerAuth
AuthorizationBearer <token>

Obtain a token from https://id.ovidens.com/oauth/token using the client_credentials grant.

In: header

Path Parameters

app*string

The app's stable technicalId, as reported by listApps. It is a snake_case identifier, never a numeric id, and it survives a rename of the app.

Length1 <= length <= 64
curl -X GET "https://example.com/v1/apps/string/datasets"
{  "datasets": [    {      "technicalId": "string",      "name": "string",      "schemaSource": "current",      "columns": [        {          "technicalId": "string",          "name": "string",          "type": "string",          "required": true,          "enumValues": [            "string"          ],          "options": [            {              "id": "string",              "label": "string",              "description": "string"            }          ],          "valueOptions": {            "decimalSeparator": true,            "thousandsSeparator": true,            "dateFormat": true,            "timestampFormat": true          }        }      ]    }  ]}

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

War diese Seite hilfreich?