api-study-create.study-create

Service to create study data.

This class provides a method to create the ressource Study from the system

Channel /study/{version}.

This class check if the study exists and if yes, do not Create it

Input:

  • Study.

Returns:
HTTP status code:

  • 201: study created.

  • 403: already_exist.

  • 500: Error while creating the ressources.

JSON: payload with the Study objet.

  • study (Study)

Input

Name

Datatype

Required

Description

extension

string

Yes

—

created

string

—

—

date

string

—

—

description

string

—

—

description_summary

string

—

—

identifier

string

—

—

keyword

string

—

—

name

string

—

—

note

string

—

—

part_of

string

—

study primary_id value

period

Period

—

—

phase

string

—

—

primary_purpose_type

string

—

—

progress_status

ProgressStatus

—

—

recruitment

Recruitment

—

—

region

string

—

—

site

string

—

Organization primary_id value

status

string

—

—

title

string

—

—

version

string

—

primary_id generated by the system

Output

Name

Datatype

Required

Description

extension

string

Yes

—

created

string

—

—

date

string

—

—

description

string

—

—

description_summary

string

—

—

identifier

string

—

—

keyword

string

—

—

name

string

—

—

note

string

—

—

part_of

string

—

study primary_id value

period

Period

—

—

phase

string

—

—

primary_purpose_type

string

—

—

progress_status

ProgressStatus

—

—

recruitment

Recruitment

—

—

region

string

—

—

site

string

—

Organization primary_id value

status

string

—

—

title

string

—

—

version

string

—

primary_id generated by the system