Fetch Saved Cohort Details
get
/ohfapi/cg/v3.3/cohort
This endpoint supports the retrieval of Cohort(Public/Private) information saved for the Logged in User along with Public cohorts saved for the other users.Cohort information inclues Cohort Name,Identifier,Description,Privacy,Created On,Created By,Updated On,Updated By,Cohort Count,Criteria,Context.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
cohortAccess(optional): string
Cohort Access to be filtered with
-
cohortName(optional): string
Cohort Name to be searched
-
limit(optional): integer(int32)
Number of rows to return
-
offset(optional): integer(int32)
Row number to start from
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : PageableCollection
Type:
object
Model for paginated collections of data.
Show Source
-
count(optional):
integer(int64)
Number of objects in the 'items' collection.
-
hasMore(optional):
boolean
A boolean indicating if more pages are available.
-
items(optional):
array items
A collection of paged items.
-
links(optional):
array links
A collection of links containing hrefs to the current, next, and previous pages as applicable.
-
resourceType(optional):
string
Identify the resource type
Nested Schema : links
Type:
array
A collection of links containing hrefs to the current, next, and previous pages as applicable.
Show Source
Example:
{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}
Nested Schema : Serializable
Type:
object
400 Response
Invalid parameters supplied
404 Response
Cohort List(s) not found