Jump to

• Request
• Response

v1.0

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

Request Body - 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
  Field Specification List. Each element describes a single filter applied to the report.
• limit: integer (int32)
  Minimum Value: 1

  Maximum Value: 5000

  Maximum number of records to display per page. Provide a value between 1 and 5000 inclusive. Negative numbers are not accepted.

  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. Provide a zero or positive value.

  Example: 5

{
    "title":"SearchSpecs",
    "type":"object",
    "properties":{
        "limit":{
            "maximum":5000,
            "minimum":1,
            "type":"integer",
            "description":"Maximum number of records to display per page. Provide a value between 1 and 5000 inclusive. Negative numbers are not accepted.",
            "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. Provide a zero or positive value.",
            "format":"int32",
            "example":5
        },
        "fieldSpecsList":{
            "type":"array",
            "description":"Field Specification List. Each element describes a single filter applied to the report.",
            "example":[
                {
                    "fieldName":"ruleState",
                    "fieldType":"list",
                    "fieldSequence":1,
                    "fieldValueList":[
                        "approved"
                    ]
                }
            ],
            "items":{
                "$ref":"#/components/schemas/Field"
            }
        }
    },
    "description":"Request body passing search specs like limit, offset and list of fields"
}

Nested Schema : fieldSpecsList

Type: array

Field Specification List. Each element describes a single filter applied to the report.

Show Source

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

{
    "type":"array",
    "description":"Field Specification List. Each element describes a single filter applied to the report.",
    "example":[
        {
            "fieldName":"ruleState",
            "fieldType":"list",
            "fieldSequence":1,
            "fieldValueList":[
                "approved"
            ]
        }
    ],
    "items":{
        "$ref":"#/components/schemas/Field"
    }
}

Example:

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

Nested Schema : Field

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"
    }
]

Examples

Select an example Example request body for generating a report

Back to Top

Response

Supported Media Types

• application/json

200 Response

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

Body ()

Root Schema : AuthResponse

Type: object

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

Show Source

• errorData: object ErrorResponseData
• 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

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

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

Example:

oracle.doceng.json.BetterJsonNull@e668392

Nested Schema : details

Type: object

Examples

Select an example Successful response example

400 Response

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

Body ()

Root Schema : AuthResponse

Type: object

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

Show Source

• errorData: object ErrorResponseData
• 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

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

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

Example:

oracle.doceng.json.BetterJsonNull@e668392

Nested Schema : details

Type: object

Examples

Select an example Example error response

Back to Top