openapi: 3.0.0
info:
description: |
Example ClinSpark Report Invocation API Doc (Transfer Report). Note that only the a basic representation of a standard Transfer Data reportReport and its options are presented in this document. HoweverAdapting adaptingthe theuse parameters appropriately will allow invocation of other reports supported by an instance. Use of Bearer Token Authentication is only supported in ClinSpark version 23.3 and greater.
version: "1.0.0"
title: ClinSpark Report Invocation API
servers:
- url: 'https://{customerId}.clinspark.com/api/v1'
variables:
customerId:
default: community-dev
description: Customer ID assigned by the service provider
- url: 'https://{ngrokPrefix}.ngrok.io/clinspark/api/v1'
variables:
ngrokPrefix:
default: 04f5b951df6d
description: first part of ngrok-assigned id
paths:
/invokeReport:
get:
summary: Invoke a the Transfer Data Report
operationId: get-transferReport
parameters:
- name: studyId
in: query
description: Status values that need to be considered for filter.
required: false
schema:
type: integer
- name: studyName
in: query
description: Name of the Study. Capitalization and spelling must match exactly. Only include EITHER studyId OR studyName, not both.
required: false
example: ABC-PK-12
schema:
type: string
- name: reportName
in: query
description: Name of the report
required: false
example: Transfer Data
schema:
type: string
- name: transferReportType
in: query
description: Type of transfer report
required: false
example: clinicalCSV
schema:
type: string
enum:
- clinicalXpt
- clinicalCSV
- clinicalExcel
- odmXml
- name: itemDataTyped
in: query
description: Used for the ODM XML report.
required: false
schema:
type: string
enum:
- 'true'
- 'false'
- name: includeMetaData
in: query
description: Used for the ODM XML report.
required: false
schema:
type: string
enum:
- 'true'
- 'false'
- name: includeNonCrfMetaData
in: query
description: Include Non-CRF?
required: false
schema:
type: string
enum:
- 'false'
- 'true'
- name: xptVersion
in: query
description: XPT Version
example: 'v5'
schema:
type: string
enum:
- 'v5'
- 'v8'
- name: onlyRandomized
in: query
description: has no effect when choosing specific subjects
required: false
schema:
type: string
enum:
- 'true'
- 'false'
- name: subjectsIds
in: query
description: id of specific subjects to include
required: false
schema:
type: array
items:
type: integer
style: form
explode: false
examples:
oneId:
summary: Example of a single ID
value: [5] # ?subjectsIds=5
multipleIds:
summary: Example of multiple IDs
value: [1, 5, 7] # ?subjectsIds=1,5,7
security:
- basicAuth: []
responses:
'200':
description: successfulSuccessful operation.
content: # Response body
application/zip:
schema:
type: string
format: binary
'400':
description: Invalid status value.
'401':
description: Unauthorized. You must add Basic Authentication headers.
'422':
description: Invalid request. There are input validation errors. Look at the response for details.
components:
securitySchemes:
basicAuth: # <-- arbitrary name for the security scheme
type: http
scheme: basic
bearerAuth:
type: http
scheme: bearer |