Jump to

• Request
• Response

v1.0

post

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

Asynchronous call to generates a report for the subject's data and events and to calculate projected dispensation date: DC_SUBJECT_EVENTS, DC_SUBJECT_DATA, DC_SUBJECT_DATA_OPTION3,DC_STUDY_SETTINGS,DC_SUBJECT_SETTINGS,DC_SDV_SETTINGS,DC_SDV_STRATEGIES,DC_ENROLLMENT_SETTINGS,DC_SCREEN_RAND_LIMIT_COUNTRY,DC_VISIT_SETTINGS_REPORT,DC_CUSTOM_ENROLLMENT_SETTINGS,DC_VISIT_SETTINGS,DC_PROJECTEDVISITDATE..

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  active

• reportName(required): string
  Name of the report to generate: DC_SUBJECT_EVENTS, DC_SUBJECT_DATA, DC_SUBJECT_DATA_OPTION3,DC_STUDY_SETTINGS,DC_SUBJECT_SETTINGS,DC_SDV_SETTINGS,DC_SDV_STRATEGIES,DC_ENROLLMENT_SETTINGS,DC_SCREEN_RAND_LIMIT_COUNTRY,DC_VISIT_SETTINGS_REPORT,DC_CUSTOM_ENROLLMENT_SETTINGS,DC_VISIT_SETTINGS,DC_PROJECTEDVISITDATE.

  Example:

  DC_SUBJECT_DATA

• studyId(required): string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  A1B2C3D4E5F647839ABCDEF012345678

Query Parameters

• format: string
  File type for data extract.File Type supported are CSV, HTML and PDF

  Example:

  CSV

• reportid: string(uuid)
  Unique report identifier

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Specifies fields for report generation

Show Source

• extFieldSpecsList: object extFieldSpecsList
  Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.
• fieldSpecsList: object fieldSpecsList
  Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.

{
    "type":"object",
    "properties":{
        "fieldSpecsList":{
            "required":[
                "fieldName",
                "fieldType",
                "fieldValueList"
            ],
            "type":"object",
            "properties":{
                "fieldName":{
                    "maxLength":255,
                    "minLength":1,
                    "type":"string",
                    "description":"Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.",
                    "example":"ruleState"
                },
                "fieldType":{
                    "maxLength":16,
                    "minLength":4,
                    "type":"string",
                    "description":"Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.",
                    "example":"list",
                    "enum":[
                        "list",
                        "date",
                        "date-time",
                        "number",
                        "string",
                        "boolean"
                    ]
                },
                "fieldSequence":{
                    "maximum":2147483647,
                    "minimum":0,
                    "type":"integer",
                    "description":"Sequence/order of the field. Provide a non-negative integer.",
                    "format":"int32",
                    "example":1
                },
                "fieldValueList":{
                    "type":"array",
                    "description":"List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.",
                    "example":[
                        {
                            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                        }
                    ],
                    "items":{
                        "maxLength":256,
                        "minLength":1,
                        "type":"string",
                        "example":"publish"
                    }
                }
            },
            "description":"Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.",
            "example":{
                "fieldName":"ruleState",
                "fieldType":"list",
                "fieldSequence":1,
                "fieldValueList":[
                    "approved"
                ]
            }
        },
        "extFieldSpecsList":{
            "required":[
                "fieldName",
                "fieldType",
                "fieldValueList"
            ],
            "type":"object",
            "properties":{
                "fieldName":{
                    "maxLength":255,
                    "minLength":1,
                    "type":"string",
                    "description":"Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.",
                    "example":"ruleState"
                },
                "fieldType":{
                    "maxLength":16,
                    "minLength":4,
                    "type":"string",
                    "description":"Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.",
                    "example":"list",
                    "enum":[
                        "list",
                        "date",
                        "date-time",
                        "number",
                        "string",
                        "boolean"
                    ]
                },
                "fieldSequence":{
                    "maximum":2147483647,
                    "minimum":0,
                    "type":"integer",
                    "description":"Sequence/order of the field. Provide a non-negative integer.",
                    "format":"int32",
                    "example":1
                },
                "fieldValueList":{
                    "type":"array",
                    "description":"List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.",
                    "example":[
                        {
                            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                        }
                    ],
                    "items":{
                        "maxLength":256,
                        "minLength":1,
                        "type":"string",
                        "example":"publish"
                    }
                }
            },
            "description":"Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.",
            "example":{
                "fieldName":"ruleState",
                "fieldType":"list",
                "fieldSequence":1,
                "fieldValueList":[
                    "approved"
                ]
            }
        }
    },
    "description":"Specifies fields for report generation"
}

Nested Schema : extFieldSpecsList

Type: object

Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.

Show Source

• fieldName(required): string
  Minimum Length: 1

  Maximum Length: 255

  Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.

  Example: ruleState
• fieldSequence: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Sequence/order of the field. Provide a non-negative integer.

  Example: 1
• fieldType(required): string
  Minimum Length: 4

  Maximum Length: 16

  Allowed Values: [ "list", "date", "date-time", "number", "string", "boolean" ]

  Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.

  Example: list
• fieldValueList(required): array fieldValueList
  List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.",
            "example":"ruleState"
        },
        "fieldType":{
            "maxLength":16,
            "minLength":4,
            "type":"string",
            "description":"Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.",
            "example":"list",
            "enum":[
                "list",
                "date",
                "date-time",
                "number",
                "string",
                "boolean"
            ]
        },
        "fieldSequence":{
            "maximum":2147483647,
            "minimum":0,
            "type":"integer",
            "description":"Sequence/order of the field. Provide a non-negative integer.",
            "format":"int32",
            "example":1
        },
        "fieldValueList":{
            "type":"array",
            "description":"List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "maxLength":256,
                "minLength":1,
                "type":"string",
                "example":"publish"
            }
        }
    },
    "description":"Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.",
    "example":{
        "fieldName":"ruleState",
        "fieldType":"list",
        "fieldSequence":1,
        "fieldValueList":[
            "approved"
        ]
    }
}

Example:

{
    "fieldName":"ruleState",
    "fieldType":"list",
    "fieldSequence":1,
    "fieldValueList":[
        "approved"
    ]
}

Nested Schema : fieldSpecsList

Type: object

Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.

Show Source

• fieldName(required): string
  Minimum Length: 1

  Maximum Length: 255

  Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.

  Example: ruleState
• fieldSequence: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Sequence/order of the field. Provide a non-negative integer.

  Example: 1
• fieldType(required): string
  Minimum Length: 4

  Maximum Length: 16

  Allowed Values: [ "list", "date", "date-time", "number", "string", "boolean" ]

  Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.

  Example: list
• fieldValueList(required): array fieldValueList
  List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.",
            "example":"ruleState"
        },
        "fieldType":{
            "maxLength":16,
            "minLength":4,
            "type":"string",
            "description":"Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.",
            "example":"list",
            "enum":[
                "list",
                "date",
                "date-time",
                "number",
                "string",
                "boolean"
            ]
        },
        "fieldSequence":{
            "maximum":2147483647,
            "minimum":0,
            "type":"integer",
            "description":"Sequence/order of the field. Provide a non-negative integer.",
            "format":"int32",
            "example":1
        },
        "fieldValueList":{
            "type":"array",
            "description":"List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "maxLength":256,
                "minLength":1,
                "type":"string",
                "example":"publish"
            }
        }
    },
    "description":"Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.",
    "example":{
        "fieldName":"ruleState",
        "fieldType":"list",
        "fieldSequence":1,
        "fieldValueList":[
            "approved"
        ]
    }
}

Example:

{
    "fieldName":"ruleState",
    "fieldType":"list",
    "fieldSequence":1,
    "fieldValueList":[
        "approved"
    ]
}

Nested Schema : fieldValueList

Type: array

List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 256

  Example: publish

{
    "type":"array",
    "description":"List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "maxLength":256,
        "minLength":1,
        "type":"string",
        "example":"publish"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : fieldValueList

Type: array

List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 256

  Example: publish

{
    "type":"array",
    "description":"List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "maxLength":256,
        "minLength":1,
        "type":"string",
        "example":"publish"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Examples

Select an example ExtFieldSpecs

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

202 Response

Successful operation.

400 Response

Invalid 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

401 Response

User not authorized to generate the report.

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

500 Response

Internal server error.

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