Dataset-JSON (0.0.1)

Download OpenAPI specification:

License: MIT

CDISC Dataset-JSON Standard API

Get About the API

Responses

Response samples

200

Content type

application/json

{"lastUpdated": "2019-08-24T14:15:22Z",
"author": "http://example.com",
"repo": "http://example.com",
"links": [{"name": "string",
"href": "string"
}
]
}

Get the list of studies

header Parameters

api-key

required

string (Api-Key)

Responses

Response samples

200
422

Content type

application/json

[{"studyOID": "string",
"name": "string",
"label": "string",
"standards": ["sdtmig"
],
"href": "string",
"metaDataRef": [{"label": "string",
"href": "http://example.com"
}
],
"snapshots": [{"label": "string",
"href": "http://example.com"
}
],
"studyCreationDateTime": "2025-08-15T13:27:34.602019Z",
"datasets": [{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}
]
}
]

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)
href required	string (Href)

Responses

Request samples

Payload

Content type

application/json

{"studyOID": "string",
"name": "string",
"label": "string",
"standards": ["sdtmig"
],
"href": "string"
}

Response samples

201
422

Content type

application/json

{"studyOID": "string",
"name": "string",
"label": "string",
"standards": ["sdtmig"
],
"href": "string",
"metaDataRef": [{"label": "string",
"href": "http://example.com"
}
],
"snapshots": [{"label": "string",
"href": "http://example.com"
}
],
"studyCreationDateTime": "2025-08-15T13:27:34.602019Z",
"datasets": [{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}
]
}

Get a study

path Parameters

studyOID

required

string (Studyoid)

header Parameters

api-key

required

string (Api-Key)

Responses

Response samples

200
422

Content type

application/json

{"studyOID": "string",
"name": "string",
"label": "string",
"standards": ["sdtmig"
],
"href": "string",
"metaDataRef": [{"label": "string",
"href": "http://example.com"
}
],
"snapshots": [{"label": "string",
"href": "http://example.com"
}
],
"studyCreationDateTime": "2025-08-15T13:27:34.602019Z",
"datasets": [{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}
]
}

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)
href required	string (Href)

Responses

Request samples

Payload

Content type

application/json

{"studyOID": "string",
"name": "string",
"label": "string",
"standards": ["sdtmig"
],
"href": "string"
}

Response samples

200
422

Content type

application/json

{"studyOID": "string",
"name": "string",
"label": "string",
"standards": ["sdtmig"
],
"href": "string",
"metaDataRef": [{"label": "string",
"href": "http://example.com"
}
],
"snapshots": [{"label": "string",
"href": "http://example.com"
}
],
"studyCreationDateTime": "2025-08-15T13:27:34.602019Z",
"datasets": [{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}
]
}

Delete a study

path Parameters

studyOID

required

string (Studyoid)

header Parameters

api-key

required

string (Api-Key)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Create a new study snapshot

path Parameters

studyOID

required

string (Studyoid)

query Parameters

label

required

string (Label)

header Parameters

api-key

required

string (Api-Key)

Responses

Response samples

201
422

Content type

application/json

{"studyOID": "string",
"name": "string",
"label": "string",
"standards": ["sdtmig"
],
"href": "string",
"metaDataRef": [{"label": "string",
"href": "http://example.com"
}
],
"snapshots": [{"label": "string",
"href": "http://example.com"
}
],
"studyCreationDateTime": "2025-08-15T13:27:34.602019Z",
"datasets": [{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}
]
}

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

200
422

Content type

application/json

[{"label": "string",
"href": "http://example.com"
}
]

Get a snapshot

path Parameters

studyOID required	string (Studyoid)
label required	string (Label)

header Parameters

api-key

required

string (Api-Key)

Responses

Response samples

200
422

Content type

application/json

{"studyOID": "string",
"name": "string",
"label": "string",
"standards": ["sdtmig"
],
"href": "string",
"metaDataRef": [{"label": "string",
"href": "http://example.com"
}
],
"snapshots": [{"label": "string",
"href": "http://example.com"
}
],
"studyCreationDateTime": "2025-08-15T13:27:34.602019Z",
"datasets": [{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}
]
}

Delete a snapshot

path Parameters

studyOID required	string (Studyoid)
label required	string (Label)

header Parameters

api-key

required

string (Api-Key)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Get a snapshot dataset

path Parameters

studyOID required	string (Studyoid)
label required	string (Label)
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

200
422

Content type

application/json

{"datasetJSONCreationDateTime": "2025-08-15T13:27:34.605686Z",
"datasetJSONVersion": "1.1",
"fileOID": "string",
"dbLastModifiedDateTime": "2019-08-24T14:15:22Z",
"originator": "string",
"sourceSystem": {"name": "string",
"version": "string"
},
"studyOID": "string",
"metaDataVersionOID": "string",
"metaDataRef": "string",
"itemGroupOID": "string",
"records": 0,
"name": "string",
"label": "string",
"columns": [{"itemOID": "string",
"name": "string",
"label": "string",
"dataType": "string",
"targetDataType": "integer",
"length": 0,
"displayFormat": "string",
"keySequence": 0
}
],
"rows": [null
]
}

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

200
422

Content type

application/json

[{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}
]

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-08-15T13:27:34.605686Z"
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)

Responses

Request samples

Payload

Content type

application/json

{"datasetJSONCreationDateTime": "2025-08-15T13:27:34.605686Z",
"datasetJSONVersion": "1.1",
"fileOID": "string",
"dbLastModifiedDateTime": "2019-08-24T14:15:22Z",
"originator": "string",
"sourceSystem": {"name": "string",
"version": "string"
},
"studyOID": "string",
"metaDataVersionOID": "string",
"metaDataRef": "string",
"itemGroupOID": "string",
"records": 0,
"name": "string",
"label": "string",
"columns": [{"itemOID": "string",
"name": "string",
"label": "string",
"dataType": "string",
"targetDataType": "integer",
"length": 0,
"displayFormat": "string",
"keySequence": 0
}
],
"rows": [null
]
}

Response samples

201
422

Content type

application/json

{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}

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

200
422

Content type

application/json

{"datasetJSONCreationDateTime": "2025-08-15T13:27:34.605686Z",
"datasetJSONVersion": "1.1",
"fileOID": "string",
"dbLastModifiedDateTime": "2019-08-24T14:15:22Z",
"originator": "string",
"sourceSystem": {"name": "string",
"version": "string"
},
"studyOID": "string",
"metaDataVersionOID": "string",
"metaDataRef": "string",
"itemGroupOID": "string",
"records": 0,
"name": "string",
"label": "string",
"columns": [{"itemOID": "string",
"name": "string",
"label": "string",
"dataType": "string",
"targetDataType": "integer",
"length": 0,
"displayFormat": "string",
"keySequence": 0
}
],
"rows": [null
]
}

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-08-15T13:27:34.605686Z"
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)

Responses

Request samples

Payload

Content type

application/json

{"datasetJSONCreationDateTime": "2025-08-15T13:27:34.605686Z",
"datasetJSONVersion": "1.1",
"fileOID": "string",
"dbLastModifiedDateTime": "2019-08-24T14:15:22Z",
"originator": "string",
"sourceSystem": {"name": "string",
"version": "string"
},
"studyOID": "string",
"metaDataVersionOID": "string",
"metaDataRef": "string",
"itemGroupOID": "string",
"records": 0,
"name": "string",
"label": "string",
"columns": [{"itemOID": "string",
"name": "string",
"label": "string",
"dataType": "string",
"targetDataType": "integer",
"length": 0,
"displayFormat": "string",
"keySequence": 0
}
],
"rows": [null
]
}

Response samples

200
422

Content type

application/json

{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}

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)

Responses

Request samples

Payload

Content type

application/json

{"rows": [null
]
}

Response samples

200
422

Content type

application/json

{"itemGroupOID": "string",
"name": "string",
"label": "string",
"standard": "sdtmig",
"records": 0,
"href": "http://example.com",
"datasetJSONCreationDateTime": "2025-08-15T13:27:34.598550Z"
}

Delete a dataset

path Parameters

studyOID required	string (Studyoid)
datasetOID required	string (Datasetoid)

header Parameters

api-key

required

string (Api-Key)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

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

Payload

Content type

application/json

{"label": "string",
"defineXML": "string"
}

Response samples

201
422

Content type

application/json

{"label": "string",
"href": "http://example.com"
}

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

200
422

Content type

application/json

[{"label": "string",
"href": "http://example.com"
}
]

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

200
422

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

Payload

Content type

application/json

{"label": "string",
"defineXML": "string"
}

Response samples

200
422

Content type

application/json

{"label": "string",
"href": "http://example.com"
}

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

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Dataset-JSON (0.0.1)

Get About the API

Responses

Response samples

Get the list of studies

header Parameters

Responses

Response samples

Create a new study

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a study

path Parameters

header Parameters

Responses

Response samples

Update a study

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a study

path Parameters

header Parameters

Responses

Response samples

Create a new study snapshot

path Parameters

query Parameters

header Parameters

Responses

Response samples

Get the list of snapshots for a study

path Parameters

header Parameters

Responses

Response samples

Get a snapshot

path Parameters

header Parameters

Responses

Response samples

Delete a snapshot

path Parameters

header Parameters

Responses

Response samples

Get a snapshot dataset

path Parameters

query Parameters

header Parameters

Responses

Response samples

Get the list of datasets for a study

path Parameters

query Parameters

header Parameters

Responses

Response samples

Create a new dataset

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a dataset

path Parameters

query Parameters

header Parameters

Responses

Response samples

Update a dataset

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required