Skip to content

New Collections findBySubmissionDefinitionName endpoint #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

New Collections findBySubmissionDefinitionName endpoint #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbb91ff
new findBySubmissionDefinitionName endpoint
paulo-graca Jul 30, 2025
92bd0bb
remove collections references
paulo-graca Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions collections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,23 @@ Return codes:
* 200 OK - if the operation succeeds
* 401 Unauthorized - if you are not authenticated

#### findBySubmissionDefinitionName
**/api/core/collections/search/findBySubmissionDefinitionName**

Get the list of all collections associated with a particular submission name.

The supported parameters are:
* `name`: the name for a specific submission-definition.
* `page`, `size` [see pagination](README.md#Pagination)

eg:
/api/core/collections/search/findBySubmissionDefinitionName?name=<:definition-name>

Return codes:
* 200 OK - if the operation succeeds
* 400 Bad Request - if the name is missing or invalid
* 401 Unauthorized - if you are not authenticated

## Patch operations

Collection metadata can be modified as described in [Modifying metadata via Patch](metadata-patch.md).
Expand Down
6 changes: 0 additions & 6 deletions submissiondefinitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Provide detailed information about a specific submission-definition. The JSON re
```

Exposed links:
* collections: list of collections that explicitly use such submission-definition
* sections: list of submission-section included in this definition

### Search methods
Expand All @@ -34,11 +33,6 @@ Exposed links:
It returns the submission definition that apply to a specific collection eventually fallback to the default configuration

### Linked entities
#### collections
**/api/config/submissiondefinitions/<:definition-name>/collections**

It returns the list of collection that make an explicit use of the submission-definition. If a collection doesn't specify the submission-definition to be used the default mapping apply but this collection is not included in the list returned by this method

#### sections
**/api/config/submissiondefinitions/<:definition-name>/sections**

Expand Down