REST API for Clinical One Platform

Generate a report based on search specifications and query parameters

post

/ec-reporting-svc/rest/v1.0/reports

This API submits a request for generating a report and returns Job ID in response. Right: ReportingPost.

Request

Query Parameters

format: string

Format of the report
mode: string

Mode of the study. Accepts test, active, or training.
reportid: string

Report ID
studyId: string(uuid)

ID of the study for which you want to generate report. Tenant reports such as HSL report etc can be generated by making study id as null.

Supported Media Types

Root Schema : schema

Type: object

Show Source

extFieldSpecsList: array extFieldSpecsList
fieldSpecsList: array fieldSpecsList

{
    "type":"object",
    "properties":{
        "fieldSpecsList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReportField"
            }
        },
        "extFieldSpecsList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReportField"
            }
        }
    }
}

Nested Schema : extFieldSpecsList

Type: array

Show Source

Array of: object ReportField

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReportField"
    }
}

Nested Schema : fieldSpecsList

Type: array

Show Source

Array of: object ReportField

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReportField"
    }
}

Nested Schema : ReportField

Type: object

Show Source

fieldId(required): string

Minimum Length: 0

Maximum Length: 32

Field ID

Example: Location GUID
fieldName(required): string

Minimum Length: 0

Maximum Length: 255

Field name

Example: siteIds
fieldSequence: integer (int32)

Minimum Value: 0

Field sequence

Example: 1
fieldType(required): string

Minimum Length: 0

Maximum Length: 50

Field type

Example: list
fieldValueList(required): array fieldValueList

{
    "required":[
        "fieldId",
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldId":{
            "maxLength":32,
            "minLength":0,
            "type":"string",
            "description":"Field ID",
            "example":"Location GUID"
        },
        "fieldName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Field name",
            "example":"siteIds"
        },
        "fieldType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Field type",
            "example":"list"
        },
        "fieldSequence":{
            "minimum":0,
            "type":"integer",
            "description":"Field sequence",
            "format":"int32",
            "example":1
        },
        "fieldValueList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : fieldValueList

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

text/html
application/json

202 Response

Success

Root Schema : ExecutionLog

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 4000
currSearchSpec: string

Minimum Length: 0

Maximum Length: 32000
currSortSpec: string

Minimum Length: 0

Maximum Length: 512
fileStorageId: string (uuid)
id: string (uuid)
objectVersionNumber: number
operationType: string

Minimum Length: 0

Maximum Length: 1024
reason: string

Minimum Length: 0

Maximum Length: 4000
recCount: integer (int32)
rptFormat(required): string

Minimum Length: 0

Maximum Length: 255
rptId: string (uuid)
rptKickoffDatetime(required): string (date-time)
rptName(required): string

Minimum Length: 0

Maximum Length: 255
rptStatCd: string

Minimum Length: 0

Maximum Length: 255
runDuration: integer
softwareVersionNumber: number
userId(required): string (uuid)
versionEnd(required): string (date-time)
versionStart(required): string (date-time)

{
    "required":[
        "rptFormat",
        "rptKickoffDatetime",
        "rptName",
        "userId",
        "versionEnd",
        "versionStart"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "rptId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "runDuration":{
            "type":"integer"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":1024,
            "minLength":0,
            "type":"string"
        },
        "reason":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "rptKickoffDatetime":{
            "type":"string",
            "format":"date-time"
        },
        "rptName":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "rptStatCd":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "rptFormat":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "recCount":{
            "type":"integer",
            "format":"int32"
        },
        "currSearchSpec":{
            "maxLength":32000,
            "minLength":0,
            "type":"string"
        },
        "currSortSpec":{
            "maxLength":512,
            "minLength":0,
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "fileStorageId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

401 Response

Unauthorized user

Root Schema : BaseResponse

Type: object

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result
status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.