Skip to content

Extend 'metadatablocks/{block_id}' endpoint JSON output to include 'isRequired', 'typeClass' and 'displayOrder' fields #10216

@GPortas

Description

@GPortas

Overview of the Feature Request

The goal is to extend the API endpoint /api/metadatablocks/{block_id} to include the following fields in its response:

  • isRequired: To know if the field is required to create a dataset
  • displayOrder: The display order in the creation / edit forms
  • typeClass: The type class of this field ("controlledVocabulary", "compound", or "primitive")

The second param is necessary for the SPA, and the first one not only for the SPA but also for any other frontend application that aims to create a dataset.

The third one is necessary for dataset creation, since it is a property included for each metadata field value in the json sent to the backend via POST.

What kind of user is the feature intended for?
API User

What inspired the request?

What existing behavior do you want changed?
None

Any brand new behavior do you want to add to Dataverse?
New fields in 'metadatablocks/{block_id}' response

Any open or closed issues related to this feature request?

Metadata

Metadata

Assignees

Labels

SPAThese changes are required for the Dataverse SPASize: 3A percentage of a sprint. 2.1 hours.User Role: API UserMakes use of APIspm.GREI-d-2.7.1NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflowspm.GREI-d-2.7.2NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions