REST API for Clinical One Platform

Generate a global report

post

/ec-auth-svc/rest/v1.0/report/{reportName}

Generates global reports for the specified report type. Clients must provide the report name as a path parameter and can supply filter/query criteria in the request payload. The response is a paginated list of results based on the applied filter.

Request

Path Parameters

reportName(required): string
The name of the report to generate.
Example:
```
USER_ASSIGNMENT
```

Supported Media Types

application/json

Root Schema : SearchSpecs

Type: object

Title: SearchSpecs

Request body passing search specs like limit, offset and list of fields

Show Source

fieldSpecsList: array fieldSpecsList
limit: integer (int32)

Minimum Value: 1

Maximum Value: 5000

Maximum number of records to display per page.

Example: 50
offset: integer (int32)

Minimum Value: 0

Maximum Value: 2147483647

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: 5

{
    "title":"SearchSpecs",
    "type":"object",
    "properties":{
        "limit":{
            "maximum":5000,
            "minimum":1,
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32",
            "example":50
        },
        "offset":{
            "maximum":2147483647,
            "minimum":0,
            "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":5
        },
        "fieldSpecsList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Field"
            }
        }
    },
    "description":"Request body passing search specs like limit, offset and list of fields"
}

Nested Schema : fieldSpecsList

Type: array

Show Source

Array of: object Field

Contains field details.

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

Nested Schema : Field

Type: object

Contains field details.

Show Source

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): string

List of values for the Field

Example: ["D5E16DD550CB4AD1B330E0D09B4B8F3F","A5E16DD550CB4AD1B330E0D09B4B8F3F"]

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "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":"string",
            "description":"List of values for the Field",
            "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
        }
    },
    "description":"Contains field details."
}

Examples

Response

Supported Media Types

application/json

200 Response

Successful report generated. The response is wrapped in AuthResponse with result as PaginatedResponseDto.

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result data of the API response; actual type depends on the API
status: string (none)

Indicates request success ("success") or failure ("failure").

Example: success
version: integer (int32)

Version of the response schema.

Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@3565a0f5

Examples

400 Response

Bad request. Failed to generate the report due to validation or business errors.

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result data of the API response; actual type depends on the API
status: string (none)

Indicates request success ("success") or failure ("failure").

Example: success
version: integer (int32)

Version of the response schema.

Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@3565a0f5

Examples