Get a dataset

Get a dataset of the current workspace, or one shared with every workspace

GET /api/v1/datasets/{id}

Get a dataset

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/datasets/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "name": "<string>",
  "scenarioCount": 1,
  "updatedAt": "2023-11-07T05:31:56Z",
  "shared": true,
  "readOnly": true,
  "owner": "workspace",
  "filling": {
    "total": 1
  },
  "scenarioIds": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Path Parameters

id · string · required

Response

200

application/json

Dataset.

id · string · required

Minimum string length: 1

name · string · required

scenarioCount · integer · required

Required range: x >= 0

updatedAt · string<date-time> · required

shared · boolean · required

readOnly · boolean · required

owner · enum<string> · required

Available options: workspace, simforge

filling · object | null · required

Show child attributes

scenarioIds · string[] · required