The Open API specification for Synapse is now available for download!

Download Open API Spec

POST /accessRequirement/formTemplate

Create a form template, which describes how a JSON Schema is presented to a user as a multi-step data access request form. The template is bound to one exact version of a registered JSON Schema, and every property that schema requires must be presented by exactly one field of the template.

Every templateFileHandleId of a field must be listed in the template's attachments, and the caller must have created every attached file. Any authenticated user can download a file listed by any version of the template using POST /fileHandle/batch or GET /file/{id} with FileHandleAssociateType.FormTemplateAttachment and the template ID as the associateObjectId.

This service may only be used by the Synapse Access and Compliance Team.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/accessRequirement/formTemplate

Resource Information
Authentication Required
Required OAuth Scopes view , modify
HTTP Method POST
Request Object FormTemplate
(application/json)
Response Object FormTemplate
(application/json)