# DataExchange-DatasetJson-API

**Repository Path**: ahwork/DataExchange-DatasetJson-API

## Basic Information

- **Project Name**: DataExchange-DatasetJson-API
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-28
- **Last Updated**: 2025-08-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DataExchange-DatasetJson-API

| Date         | Version | Summary of Changes |
|--------------|---------|--------------------|
| 2025-08-07	| 1.0	  | Draft              |   

This repository contains the Dataset-JSON API Specification v1.0 and associated User Guide. This API standard complements
the [Dataset-JSON CDISC Data Exchange standard](https://github.com/cdisc-org/DataExchange-DatasetJson).

To review the Dataset-JSON API Specification, use the HTML version [dataset-json-api-1-0.html](https://html-preview.github.io/?url=https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/docs/dataset-json-api-1-0.html). 

To review the Dataset-JSON API User Guide, see the Markdown version [dataset-json-api-1-0-ug](https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/docs/dataset-json-api-1-0-ug.md).

To review the Dataset-JSON API Specification as OAS, see the JSON version [dataset-json-api-1-0.json](https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/openapi/dataset-json-api-1-0.json). 

## Description
The main purpose of *DataExchange-DatasetJson-API* is to create a standard API specification for exchanging 
Dataset-JSON datasets.

The API endpoints, payloads, and other details are available in the JSON and HTML versions of the specification. 
The User Guide provides additional information useful to client and server API implementers.

Please add any comments or issues into the GitHub repository under Discussions or Issues, respectively.

The API specification has been developed using the machine-readable
[Open API Specification (OAS) 3.1 standard](https://github.com/OAI/OpenAPI-Specification). API specifications in OAS format can be used to generate 
documentation as well as to generate code for API clients. Check out this [list of OAS tools](https://openapi.tools/). 

For those interested in generating content using the API specification, see the JSON version in the 
openapi folder. The [dataset-json-api-1-0.json](https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/openapi/dataset-json-api-1-0.json) 
file contains the machine-readable specification used to generate the HTML documentation file 
[dataset-json-api-1-0.html](https://html-preview.github.io/?url=https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/docs/dataset-json-api-1-0.html).

## Contribution

Contributions are welcome. When you contribute to this repository you are doing so under the licenses below. 
Please check out [Contribution](CONTRIBUTING.md) for additional information. All contributions must adhere to the 
following [Code of Conduct](CODE_OF_CONDUCT.md).

## License

![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg) ![License: CC BY 4.0](https://img.shields.io/badge/License-CC_BY_4.0-blue.svg)

### Code & Scripts

This project uses the [MIT](http://www.opensource.org/licenses/MIT "The MIT License | Open Source Initiative") license 
(see [`LICENSE`](LICENSE.md)) for code, schemas, models, JSON-based specifications, and scripts.

### Content
Documentation content files are released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). This does not include trademark permissions.

## Re-use
When you want to re-use and refer to the content, please do so like the following:

> Content based on [Dataset-JSON API (GitHub)](https://github.com/cdisc-org/DataExchange-DatasetJson-API) used under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) license.