...
Below are the attributes which need to be sent in the request body:
Parameter | Details |
|---|---|
| title | Collection Collection protocol title.Unique in the application |
| shortTitle | Collection protocol short title. Unique in the application |
| startDate | Collection protocol starting date |
| endDate[optional] | Collection protocol end dateprincipalInvestigatorId. If given then, the endDate should not be later than startDate. |
| investigator | Principal investigator on CP Mainly contains following parameters : loginName : User login name. Specified For this specified user must be present in application. domainName: Name of domain to which user belongs to. By default it will be catissue. |
| activityStatus | Activity status of a collection protocol |
| cpType[optional] | Collection protocol type |
| labelFormat[optional] | CP label format |
| derivedLabelFormat[optional] | Derived label format |
| aliquotLabelFormat[optional] | Aliquot label format |
| ppIdFormat[optional] | PPId format |
| cpSiteRoles[optional] | It is collection of Sites and Roles with respect to CP. By default it will be none. i.e. Blank collection. Mainly contains following parameters : roleName : Role of user like Scientist, Admin etc. Role For this attribute role must be present in application. siteName: Site name. For this attribute Site must be present in application.
|
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols
...
| URL | http://<host>:<port>/openspecimen/rest/ng/collection-protocols |
| Method | POST |
| Request | application/json |
| json | { "title":"My Cp", "shortTitle": "CpM", "startDate" : "2014-07-23", "endDate" : "2018-07-23", "activityStatus": "Active", "principalInvestigatorinvestigator" : {"loginName" : "admin@admin.com", "domainName" :"catissue"}, "cpSiteRoles" : { "siteName" : "My Site", "roleName" : "Scientist" } } |
Response | { "id" : 1, "title":"My Cp", "shortTitle": "CpM", "startDate" : "2014-07-23", "endDate" : "2018-07-23", "principalInvestigatorinvestigator" : {"loginName" : "admin@admin.com", "domainName" :"catissue"}, "labelFormat": null, "derivedLabelFormat": null, "aliquotLabelFormat": null, "ppIdFormat": "", "cpSiteRoles" : { "id" : 1, "siteName" : "My Site", "roleName" : "Scientist" } } |
...