API docs by Redocly

Dataset-JSON (0.0.1)

Download OpenAPI specification:

License: MIT

CDISC Dataset-JSON Standard API

Get About the API

Responses

Response samples

Content type
application/json
{}

Get the list of studies

header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new study

header Parameters
api-key
required
string (Api-Key)
Request Body schema: application/json
required
studyOID
required
string (Studyoid)
name
required
string (Name)
label
required
string (Label)
Array of Standards (strings) or Standards (null) (Standards)

Responses

Request samples

Content type
application/json
{
  • "studyOID": "string",
  • "name": "string",
  • "label": "string",
  • "standards": [
    ]
}

Response samples

Content type
application/json
{
  • "studyOID": "string",
  • "name": "string",
  • "label": "string",
  • "standards": [
    ],
  • "href": "string",
  • "metaDataRef": [
    ],
  • "snapshots": [
    ],
  • "studyCreationDateTime": "2025-11-17T20:09:33.995555Z",
  • "datasets": [
    ]
}

Get a study

path Parameters
studyOID
required
string (Studyoid)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
{
  • "studyOID": "string",
  • "name": "string",
  • "label": "string",
  • "standards": [
    ],
  • "href": "string",
  • "metaDataRef": [
    ],
  • "snapshots": [
    ],
  • "studyCreationDateTime": "2025-11-17T20:09:33.995555Z",
  • "datasets": [
    ]
}

Update a study

path Parameters
studyOID
required
string (Studyoid)
header Parameters
api-key
required
string (Api-Key)
Request Body schema: application/json
required
studyOID
required
string (Studyoid)
name
required
string (Name)
label
required
string (Label)
Array of Standards (strings) or Standards (null) (Standards)

Responses

Request samples

Content type
application/json
{
  • "studyOID": "string",
  • "name": "string",
  • "label": "string",
  • "standards": [
    ]
}

Response samples

Content type
application/json
{
  • "studyOID": "string",
  • "name": "string",
  • "label": "string",
  • "standards": [
    ],
  • "href": "string",
  • "metaDataRef": [
    ],
  • "snapshots": [
    ],
  • "studyCreationDateTime": "2025-11-17T20:09:33.995555Z",
  • "datasets": [
    ]
}

Delete a study

path Parameters
studyOID
required
string (Studyoid)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Create a new study snapshot

path Parameters
studyOID
required
string (Studyoid)
query Parameters
label
string (Label)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
{
  • "studyOID": "string",
  • "name": "string",
  • "label": "string",
  • "standards": [
    ],
  • "href": "string",
  • "metaDataRef": [
    ],
  • "snapshots": [
    ],
  • "studyCreationDateTime": "2025-11-17T20:09:33.995555Z",
  • "datasets": [
    ]
}

Get the list of snapshots for a study

path Parameters
studyOID
required
string (Studyoid)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a snapshot

path Parameters
studyOID
required
string (Studyoid)
snapshotID
required
string (Snapshotid)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
{
  • "studyOID": "string",
  • "name": "string",
  • "label": "string",
  • "standards": [
    ],
  • "href": "string",
  • "metaDataRef": [
    ],
  • "snapshots": [
    ],
  • "studyCreationDateTime": "2025-11-17T20:09:33.995555Z",
  • "datasets": [
    ]
}

Delete a snapshot

path Parameters
studyOID
required
string (Studyoid)
snapshotID
required
string (Snapshotid)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get a snapshot dataset

path Parameters
studyOID
required
string (Studyoid)
snapshotID
required
string (Snapshotid)
datasetOID
required
string (Datasetoid)
query Parameters
Metadataonly (boolean) or Metadataonly (null) (Metadataonly)
Default: false
Dataonly (boolean) or Dataonly (null) (Dataonly)
Default: false
Offset (integer) or Offset (null) (Offset)
Default: 0
Limit (integer) or Limit (null) (Limit)
Default: 0
header Parameters
api-key
required
string (Api-Key)
Accept-Encoding (string) or Accept-Encoding (null) (Accept-Encoding)
Default:
If-Modified-Since (string) or If-Modified-Since (null) (If-Modified-Since)
Default:

Responses

Response samples

Content type
application/json
{
  • "datasetJSONCreationDateTime": "2025-11-17T20:09:33.999933Z",
  • "datasetJSONVersion": "1.1",
  • "fileOID": "string",
  • "dbLastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "originator": "string",
  • "sourceSystem": {
    },
  • "studyOID": "string",
  • "metaDataVersionOID": "string",
  • "metaDataRef": "string",
  • "itemGroupOID": "string",
  • "records": 0,
  • "name": "string",
  • "label": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

Get the list of datasets for a study

path Parameters
studyOID
required
string (Studyoid)
query Parameters
Standard (string) or Standard (null) (Standard)
header Parameters
api-key
required
string (Api-Key)
If-Modified-Since (string) or If-Modified-Since (null) (If-Modified-Since)
Default:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new dataset

query Parameters
Standard (string) or Standard (null) (Standard)
Default: ""
header Parameters
api-key
required
string (Api-Key)
Request Body schema: application/json
required
Datasetjsoncreationdatetime (string) or Datasetjsoncreationdatetime (null) (Datasetjsoncreationdatetime)
Default: "2025-11-17T20:09:33.999933Z"
datasetJSONVersion
required
string (Datasetjsonversion)
Enum: "1.1" "1.1.0" "1.1.1" "1.1.2" "1.1.3" "1.1.4" "1.1.5"
Fileoid (string) or Fileoid (null) (Fileoid)
Dblastmodifieddatetime (string) or Dblastmodifieddatetime (null) (Dblastmodifieddatetime)
Originator (string) or Originator (null) (Originator)
SourceSystem (object) or null
studyOID
required
string (Studyoid)
Metadataversionoid (string) or Metadataversionoid (null) (Metadataversionoid)
Metadataref (string) or Metadataref (null) (Metadataref)
itemGroupOID
required
string (Itemgroupoid)
Records (integer) or Records (null) (Records)
Default: 0
name
required
string (Name)
label
required
string (Label)
required
Array of objects (Columns)
rows
Array of any (Rows) [ items ]

Responses

Request samples

Content type
application/json
{
  • "datasetJSONCreationDateTime": "2025-11-17T20:09:33.999933Z",
  • "datasetJSONVersion": "1.1",
  • "fileOID": "string",
  • "dbLastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "originator": "string",
  • "sourceSystem": {
    },
  • "studyOID": "string",
  • "metaDataVersionOID": "string",
  • "metaDataRef": "string",
  • "itemGroupOID": "string",
  • "records": 0,
  • "name": "string",
  • "label": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

Response samples

Content type
application/json
{
  • "itemGroupOID": "string",
  • "name": "string",
  • "label": "string",
  • "standard": "sdtmig",
  • "records": 0,
  • "href": "string",
  • "datasetJSONCreationDateTime": "2025-11-17T20:09:33.993457Z"
}

Get a dataset

path Parameters
studyOID
required
string (Studyoid)
datasetOID
required
string (Datasetoid)
query Parameters
Metadataonly (boolean) or Metadataonly (null) (Metadataonly)
Default: false
Dataonly (boolean) or Dataonly (null) (Dataonly)
Default: false
Offset (integer) or Offset (null) (Offset)
Default: 0
Limit (integer) or Limit (null) (Limit)
Default: 0
header Parameters
api-key
required
string (Api-Key)
Accept-Encoding (string) or Accept-Encoding (null) (Accept-Encoding)
Default:
If-Modified-Since (string) or If-Modified-Since (null) (If-Modified-Since)
Default:

Responses

Response samples

Content type
application/json
{
  • "datasetJSONCreationDateTime": "2025-11-17T20:09:33.999933Z",
  • "datasetJSONVersion": "1.1",
  • "fileOID": "string",
  • "dbLastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "originator": "string",
  • "sourceSystem": {
    },
  • "studyOID": "string",
  • "metaDataVersionOID": "string",
  • "metaDataRef": "string",
  • "itemGroupOID": "string",
  • "records": 0,
  • "name": "string",
  • "label": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

Update a dataset

path Parameters
studyOID
required
string (Studyoid)
datasetOID
required
string (Datasetoid)
query Parameters
Standard (string) or Standard (null) (Standard)
Default: ""
header Parameters
api-key
required
string (Api-Key)
Request Body schema: application/json
required
Datasetjsoncreationdatetime (string) or Datasetjsoncreationdatetime (null) (Datasetjsoncreationdatetime)
Default: "2025-11-17T20:09:33.999933Z"
datasetJSONVersion
required
string (Datasetjsonversion)
Enum: "1.1" "1.1.0" "1.1.1" "1.1.2" "1.1.3" "1.1.4" "1.1.5"
Fileoid (string) or Fileoid (null) (Fileoid)
Dblastmodifieddatetime (string) or Dblastmodifieddatetime (null) (Dblastmodifieddatetime)
Originator (string) or Originator (null) (Originator)
SourceSystem (object) or null
studyOID
required
string (Studyoid)
Metadataversionoid (string) or Metadataversionoid (null) (Metadataversionoid)
Metadataref (string) or Metadataref (null) (Metadataref)
itemGroupOID
required
string (Itemgroupoid)
Records (integer) or Records (null) (Records)
Default: 0
name
required
string (Name)
label
required
string (Label)
required
Array of objects (Columns)
rows
Array of any (Rows) [ items ]

Responses

Request samples

Content type
application/json
{
  • "datasetJSONCreationDateTime": "2025-11-17T20:09:33.999933Z",
  • "datasetJSONVersion": "1.1",
  • "fileOID": "string",
  • "dbLastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "originator": "string",
  • "sourceSystem": {
    },
  • "studyOID": "string",
  • "metaDataVersionOID": "string",
  • "metaDataRef": "string",
  • "itemGroupOID": "string",
  • "records": 0,
  • "name": "string",
  • "label": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

Response samples

Content type
application/json
{
  • "itemGroupOID": "string",
  • "name": "string",
  • "label": "string",
  • "standard": "sdtmig",
  • "records": 0,
  • "href": "string",
  • "datasetJSONCreationDateTime": "2025-11-17T20:09:33.993457Z"
}

Append records to a dataset

path Parameters
studyOID
required
string (Studyoid)
datasetOID
required
string (Datasetoid)
header Parameters
api-key
required
string (Api-Key)
Request Body schema: application/json
required
rows
Array of any (Rows) [ items ]

Responses

Request samples

Content type
application/json
{
  • "rows": [
    ]
}

Response samples

Content type
application/json
{
  • "itemGroupOID": "string",
  • "name": "string",
  • "label": "string",
  • "standard": "sdtmig",
  • "records": 0,
  • "href": "string",
  • "datasetJSONCreationDateTime": "2025-11-17T20:09:33.993457Z"
}

Delete a dataset

path Parameters
studyOID
required
string (Studyoid)
datasetOID
required
string (Datasetoid)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Export a dataset to NDJSON (async)

path Parameters
studyOID
required
string (Studyoid)
datasetOID
required
string (Datasetoid)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "href": "string"
}

Download NDJSON dataset as a stream

path Parameters
studyOID
required
string (Studyoid)
datasetOID
required
string (Datasetoid)
header Parameters
api-key
required
string (Api-Key)
Accept-Encoding (string) or Accept-Encoding (null) (Accept-Encoding)
Default:

Responses

Response samples

Content type
application/x-ndjson
Example
{
  • "datasetJSONCreationDateTime": "2025-11-17T20:09:33.999933Z",
  • "datasetJSONVersion": "1.1",
  • "fileOID": "string",
  • "dbLastModifiedDateTime": "2019-08-24T14:15:22Z",
  • "originator": "string",
  • "sourceSystem": {
    },
  • "studyOID": "string",
  • "metaDataVersionOID": "string",
  • "metaDataRef": "string",
  • "itemGroupOID": "string",
  • "records": 0,
  • "name": "string",
  • "label": "string",
  • "columns": [
    ]
}

Create a new Define-XML file

path Parameters
studyOID
required
string (Studyoid)
header Parameters
api-key
required
string (Api-Key)
Request Body schema: application/json
required
label
required
string (Label)
defineXML
required
string (Definexml)

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "defineXML": "string"
}

Response samples

Content type
application/json
{
  • "label": "string",
  • "href": "string"
}

Get the list of Define-XML files for a study

path Parameters
studyOID
required
string (Studyoid)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Define-XML

path Parameters
studyOID
required
string (Studyoid)
label
required
string (Label)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
{
  • "label": "string",
  • "defineXML": "string"
}

Update a Define-XML

path Parameters
studyOID
required
string (Studyoid)
label
required
string (Label)
header Parameters
api-key
required
string (Api-Key)
Request Body schema: application/json
required
label
required
string (Label)
defineXML
required
string (Definexml)

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "defineXML": "string"
}

Response samples

Content type
application/json
{
  • "label": "string",
  • "href": "string"
}

Delete a Define-XML

path Parameters
studyOID
required
string (Studyoid)
label
required
string (Label)
header Parameters
api-key
required
string (Api-Key)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}