Studies endpoint

Given an API Key, fetch the set of studies. Only studies that the API key is authorized to view will be included in the response.

Accessing the index

A GET request is used to access the index

Request structure

GET /api/v1/edc/studies?page=0&size=25&sort=studyKey%2CASC&filter=studyKey%3D%3DPHARMADEMO HTTP/1.1
x-imn-security-key: my-security-key
x-api-key: my-api-token
Content-Type: application/json
Host: localhost:8080

Request parameters

Request parameters are optional. Default values are used unless specified.

Parameter Description

page

Which index page to be returned. Default value is 0.

size

Items per page to be returned. Default value is 25. Maximum items allowed per page is 500

sort

Name of the property by which to sort the result set. To sort in a particular direction add a comma to the property name and either asc or desc. To sort by multiple properties add additional sort parameters. Default value is studyKey,asc.

filter

Optional filter search criteria. Must follow correct syntax. Refer to filter section for details.

Response body

Below is an example response payload.

{
  "metadata" : {
    "status" : "OK",
    "method" : "GET",
    "path" : "/api/v1/edc/studies",
    "timestamp" : "2023-12-27 22:15:15",
    "error" : { }
  },
  "pagination" : {
    "currentPage" : 0,
    "size" : 25,
    "totalPages" : 1,
    "totalElements" : 1,
    "sort" : [ {
      "property" : "studyKey",
      "direction" : "ASC"
    } ]
  },
  "data" : [ {
    "sponsorKey" : "100",
    "studyKey" : "PHARMADEMO",
    "studyId" : 100,
    "studyName" : "iMednet Pharma Demonstration Study",
    "studyDescription" : "iMednet Demonstration Study v2 Created 05April2018 After A5 Release",
    "studyType" : "STUDY",
    "dateCreated" : "2023-12-27 22:15:15",
    "dateModified" : "2023-12-27 22:15:16"
  } ]
}

Response fields

Path Type Description

metadata.status

String

Http status

metadata.method

String

Http method

metadata.path

String

Requested URI path

metadata.timestamp

String

Timestamp when response was generated

metadata.error

Object

Detail error message from request if error occur

pagination.currentPage

Number

Current error page

pagination.size

Number

Size per page

pagination.totalPages

Number

Total pages return from search

pagination.totalElements

Number

Total elements return from search

pagination.sort[].property

String

Sort property

pagination.sort[].direction

String

Sort direction

data[].sponsorKey

String

Sponsor key that this study is belong to

data[].studyKey

String

Unique study key

data[].studyId

Number

Mednet study ID

data[].studyName

String

Study name

data[].studyDescription

String

Study description detail

data[].studyType

String

The type of study

data[].dateCreated

String

Date when this record was created

data[].dateModified

String

Last date modified of this record