API Reference

Create a questionnaire screening

post
https://api.platform.briink.com/workspaces//screenings

Creates a new screening and execution. If no question ids are sent in the request body, all questions of the questionnaire related to the given screening will get processed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
runnable_config
object
file_ids
array of uuids
File Ids
array | null
ScreeningLanguageCodeEnum | null

BCP-47 code of the language the screening runs in. Null means the screening is not language-specific and its executions inherit the questionnaire's language. Supported codes: en (English), zh-Hans (Simplified Chinese), ja (Japanese), es-419 (Latin American Spanish), pt-BR (Brazilian Portuguese).

boolean
Defaults to false
ScreeningEntityInput | null

Optional entity to associate with this screening

uuid
required
Headers
Responses

Updated 3 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?