Skip to content

Commit

Permalink
Part of docs: new dataset endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
ktuite committed Mar 15, 2024
1 parent 044773b commit 96cb040
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions docs/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ info:
- Bulk Entity Creation!
* The existing [Entity Create](/central-api-entity-management/#creating-entities) endpoint now also accepts a list of Entities to append to a Dataset.
* The `uuid` property is no longer required and Central will generate a UUID for each new Entity if needed.
- Create Datasets (Entity Lists) and add Properties via the API!
- OData Data Document for requests of Submissions and Entities now allow use of `$orderby`.
- ETag headers on all Blobs.

Expand Down Expand Up @@ -9752,6 +9753,73 @@ paths:
code: "403.1"
message: The authenticated actor does not have rights to perform that
action.
post:
tags:
- Dataset Management
summary: Creating Datasets
description: Creates a new Dataset with a specified name within a project. (add more)
operationId: Creating Datasets
parameters:
- name: projectId
in: path
description: The numeric ID of the Project
required: true
schema:
type: number
example: "16"
requestBody:
content:
'*/*':
schema:
required:
- name
type: object
properties:
name:
type: string
description: The desired name of the Dataset.
approvalRequired:
type: boolean
description: Control whether a Submission should be approved before an Entity is created from it.
required: false
example:
name: Trees
approvalRequired: false
required: false
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DatasetMetadata'
example:
name: people
createdAt: '2018-01-19T23:58:03.395Z'
projectId: 1
approvalRequired: false
sourceForms: []
linkedForms: []
properties: []
403:
description: Forbidden
content:
application/json:
schema:
required:
- code
type: object
properties:
code:
type: string
message:
type: string
example:
code: "403.1"
message: The authenticated actor does not have rights to perform that
action.
/projects/{projectId}/datasets/{name}:
get:
tags:
Expand Down

0 comments on commit 96cb040

Please sign in to comment.