Skip to content

Commit

Permalink
Add note about dataset name conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
ktuite committed May 3, 2024
1 parent b280607 commit 3436ca1
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8645,7 +8645,9 @@ paths:
- Dataset Management
summary: Creating Datasets
description: |-
You can create a Dataset with a specific `name` within a Project. This Dataset can then be populated via the API or via Forms and Submissions, and then used by other Forms. This endpoint allows a Dataset to be created programatically without an input form.
You can create a Dataset with a specific `name` within a Project. This Dataset can then be populated with Entities via the API or via Forms and Submissions, and then used by other Forms. This endpoint allows a Dataset to be created programatically without an input form.

The name of a Dataset is case-sensitive in that it will keep the capitalization provided (e.g. "Trees"). But Central will not allow a second Dataset with the same name but different capitalization to be created (e.g. "trees" when "Trees" already exists).

By default, the Dataset will have no properties, but each Entity will have a `label` and a unique ID (`uuid`). You can add additional properties with this [related endpoint](/central-api-dataset-management/#adding-properties).

Expand Down Expand Up @@ -8701,6 +8703,22 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error403'
409:
description: Conflict
content:
application/json:
schema:
required:
- code
type: object
properties:
code:
type: string
message:
type: string
example:
code: 409.3
message: A resource already exists with name,projectId value(s) of trees,1.
/projects/{projectId}/datasets/{name}:
get:
tags:
Expand Down

0 comments on commit 3436ca1

Please sign in to comment.