R API client for openapi

The Mednet EDC (Electronic Data Capture) REST API provides a single-point of access for reading data stored across iMednet data services. This specification documents all available endpoints in the latest version of the API.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

• API version: 1.3.6
• Package version: 1.0.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.RClientCodegen

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")

Build the package

git clone https://github.com/GIT_USER_ID/GIT_REPO_ID
cd GIT_REPO_ID
R CMD build .
R CMD check openapi_1.0.0.tar.gz --no-manual
R CMD INSTALL --preclean openapi_1.0.0.tar.gz

Install the package

install.packages("openapi")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("GIT_USER_ID/GIT_REPO_ID")

To install the package from a local file:

install.packages("openapi_1.0.0.tar.gz", repos = NULL, type = "source")

Usage

library(openapi)

Reformat code

To reformat code using styler, please run the following in the R console:

install.packages("remotes")
remotes::install_github("r-lib/styler@v1.7.0.9003")
library("styler")
style_dir()

Documentation for API Endpoints

All URIs are relative to https://edc.prod.imednetapi.com/api/v1/edc

Class	Method	HTTP request	Description
AdministrationApi	ListUsers	GET /studies/{studyKey}/users	List users and their roles in a study
CodingsApi	ListCodings	GET /studies/{studyKey}/codings	List coding activities in a study
FormsApi	ListForms	GET /studies/{studyKey}/forms	List forms in a study
IntervalsApi	ListIntervals	GET /studies/{studyKey}/intervals	List intervals (visit definitions) in a study
JobsApi	GetJobStatus	GET /studies/{studyKey}/jobs/{batchId}	Retrieve job status by batch ID
QueriesApi	ListQueries	GET /studies/{studyKey}/queries	List data queries in a study
RecordRevisionsApi	ListRecordRevisions	GET /studies/{studyKey}/recordRevisions	List record revisions (audit trail entries) in a study
RecordsApi	CreateRecords	POST /studies/{studyKey}/records	Add new record or update subject/record data
RecordsApi	ListRecords	GET /studies/{studyKey}/records	List records (eCRF instances) in a study
SitesApi	ListSites	GET /studies/{studyKey}/sites	List sites for a study
StudiesApi	ListStudies	GET /studies	List studies accessible by API key
SubjectsApi	ListSubjects	GET /studies/{studyKey}/subjects	List subjects in a study
VariablesApi	ListVariables	GET /studies/{studyKey}/variables	List variables (fields) in a study
VisitsApi	ListVisits	GET /studies/{studyKey}/visits	List visits (subject visit instances) in a study

Documentation for Models

• Coding
• CodingList
• ComponentsSchemasIntervalFormsItem
• ComponentsSchemasMetadataError
• ComponentsSchemasRecordCreateRequestItem
• Form
• FormList
• InlineObject
• InlineObject1
• InlineObject2
• InlineObject3
• InlineObject4
• InlineObject5
• Interval
• IntervalList
• Job
• Keyword
• Metadata
• Pagination
• Query
• QueryComment
• QueryList
• Record
• RecordJobStatus
• RecordList
• RecordRevision
• RecordRevisionList
• Role
• Site
• SiteList
• Sort
• Study
• StudyList
• Subject
• SubjectList
• User
• UserList
• Variable
• VariableList
• Visit
• VisitList

Documentation for Authorization

Authentication schemes defined for the API:

apiKeyAuth

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

securityKeyAuth

• Type: API key
• API key parameter name: x-imn-security-key
• Location: HTTP header