REST API for Clinical One Platform

v1.0 REST Endpoints

Sites and Depots/Site/v1.0

The operations from the Sites and Depots/Site/v1.0 category.

Clear site's SDFs cached data by study ID and mode: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/clearsitecache
~~Create a site~~: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
~~Create a site and send notification~~: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf
~~Delete a site by ID~~: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
~~Delete depot email~~: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/deleteDepotEmail
Generate report for sites: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}
Generate specific report for sites: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/report/{reportName}
Get a site by ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
Get a site by SDF ID for tenant: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/tenant/{sdfId}
Get all site study version: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/allstudyversions/{sdfType}
Get all sites by type: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/all
Get all sites by type and study version: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/allstudyversions
Get countries for a site: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/countries
Get countries for a site by SDF type: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/countries
Get SDF information with creation date by SDF type: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/creationDate
Get site by filter parameters: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/siteFilterPaginated
Get site by site name and address: Method: get
Path: /ec-site-svc/rest/v1/tenant/sdfs/autoSuggest
Get site by site name or address and type of SDF: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/search
~~Get site by site name or address and type of SDF (UI search autocomplete)~~: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/autoSuggest
Get site details for IDs sent in payload: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/sdfDetails
Get sites by type or list of countries: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
Get sites on search key: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/searchSite
Get the principal investigator's last name and address of the site: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/pinaddr
~~Update a site~~: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
~~Update a site and send notification~~: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf/{sdfId}
~~Update all sites with a new study version~~: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/versionupdate
Update site properties for managing sites: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/multiple