diff --git a/submissionsections.md b/submissionsections.md index 6c5d9bfd..f52ba8d0 100644 --- a/submissionsections.md +++ b/submissionsections.md @@ -14,29 +14,32 @@ Example: to be provided ## Single Submission-Definition **/api/config/submissionsections/<:section-name>** -Provide detailed information about a specific submission-section. The JSON response document is as follow +Provide detailed information about a specific submission-section. The JSON response document is as follows + ```json { - id: "id-of-the-submission-form-page", - header: "First page", - mandatory: true, - sectionType: "submission-form", - scope: null, - type: "submissionsection", - _links: { - "config" : "/config/submissionforms/<:id-of-the-submission-form-page>" - } + "id": "id-of-the-submission-form-page", + "header": "First page", + "mandatory": true, + "sectionType": "submission-form", + "extendsType": null, + "scope": null, + "type": "submissionsection", + "_links": { + "config": "/config/submissionforms/<:id-of-the-submission-form-page>" + } } ``` * the *header* attribute is the label or the i18n key to use to present the section to the user * the *mandatory* attribute defines if the section MUST be used by each submission. Otherwise, the user is allowed to enable/disable the section interacting with the workspaceitem * the *scope* attribute can be null or one of the values: workflow or submission. A value other than *null* mean that the section will be only available during the specified phase -* the *sectionType* attribute defines the kind of section that the UI will need to use to interact with the data. See the [documentation about the available values for sectionType provided here](submissionsection-types.md) +* the *sectionType* attribute defines the _specific_ kind of section that the UI will need to use to interact with the data. See the [documentation about the available values for sectionType provided here](submissionsection-types.md) +* the optional *extendsType* attribute defines the _generic_ kind of this section. For example, it is possible to implement an `custom-upload` section type that still inherits the behaviour of standard upload by specifying `"extendsType": "upload"`. ## Linked Entities ### config It returns the endpoint to use to access a detailed, sectionType dependent, configuration to be used in the panel. Such as the list of fields to include in a form based panel, the upload and access condition options for an upload panel, etc. -See the [documentation about the available values for sectionType provided here](submissionsection-types.md) \ No newline at end of file +See the [documentation about the available values for sectionType provided here](submissionsection-types.md)