Jump to

• Request
• Response

Generate a report based on the path parameter

post

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}

Generates the following reports: DC_SUBJECT_VISIT, DC_SUBJECT_DATA, DC_SUBJECT_EVENTS, DC_SUBJECT_SETTINGS, DC_VISIT_SETTINGS, DC_GENERAL_SETTINGS, DC_SITE_SETTINGS, DC_COUNTRY_SETTINGS, DC_GENERAL_SETTINGS_AUDIT, DC_COUNTRY_SETTINGS_AUDIT, SUBJECT_DATA_CTMS, DC_SUBJECT_DATA_EXTRACT and DC_SIGNATURE_CONFIGS. Rights: DataCaptureSubjectGet or SubjectDataCTMSReportPost or SubjectDataClassificationGet.

Request

Path Parameters

• reportName(required): string
  Name of the report to generate. Reports include: DC_SUBJECT_EVENTS, DC_SUBJECT_DATA, DC_SUBJECT_DATA_OPTION3, DC_SUBJECT_SETTINGS, DC_VISIT_SETTINGS and DC_SIGNATURE_CONFIGS.

Query Parameters

• fileType: string
  File type for data extract
• sessionToken: string(uuid)
  Token to identify the session.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• fieldSpecsList: array fieldSpecsList
• limit: integer (int32)
  Minimum Value: 1

  Maximum Value: 10000
• offset: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

{
    "type":"object",
    "properties":{
        "limit":{
            "maximum":"10000",
            "minimum":"1",
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "maximum":"2147483647",
            "minimum":"0",
            "type":"integer",
            "format":"int32"
        },
        "fieldSpecsList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FieldSet"
            }
        }
    }
}

Nested Schema : fieldSpecsList

Type: array

Show Source

• Array of: object FieldSet

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

Nested Schema : FieldSet

Type: object

Show Source

• fieldName: string
  Minimum Length: 0

  Maximum Length: 255
• fieldNameList: array fieldNameList
• fieldSequence: integer (int32)
  Minimum Value: 0
• fieldType(required): string
  Minimum Length: 0

  Maximum Length: 50
• fieldValueList: array fieldValueList
• fieldValueSets: array fieldValueSets

{
    "required":[
        "fieldType"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "fieldType":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "fieldSequence":{
            "minimum":"0",
            "type":"integer",
            "format":"int32"
        },
        "fieldValueList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "fieldNameList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "fieldValueSets":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : fieldNameList

Type: array

Show Source

• Array of: string

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

Nested Schema : fieldValueList

Type: array

Show Source

• Array of: string

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

Nested Schema : fieldValueSets

Type: array

Show Source

• Array of: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PaginatedResponseDto
  Paginated Response Object for report APIs.

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

Nested Schema : PaginatedResponseDto

Type: object

Paginated Response Object for report APIs.

Show Source

• columns: array columns
• count: integer (int32)
  Total count of result
• data: array data
• hasMore: string
  Attribute describes if result set has more records

  Example: true
• limit: integer (int32)
  Maximum number of records to display per page.
• offset: integer (int32)
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter

  Example: 400
• totalResults: integer (int32)
  Total number of entities in response

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"string",
            "description":"Attribute describes if result set has more records",
            "example":"true"
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter",
            "format":"int32",
            "example":"400"
        },
        "columns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "data":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    },
    "description":"Paginated Response Object for report APIs."
}

Nested Schema : columns

Type: array

Show Source

• Array of: string

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

Nested Schema : data

Type: array

Show Source

• Array of: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: string

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

400 Response

Bad request.

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top