1. REST API for Clinical One Platform
  2. Tasks
  3. Reporting
  4. v1.0

Aggregate data for Oracle CRF Submit

post

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

Provides the aggregated/collated data based on the given query parameters. Submit required field specifications in the request body.
Right: ReportingPost.

Request

Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Specifies fields for report generation
Show Source
Nested Schema : extFieldSpecsList
Type: object
Contains field details.
Show Source
Nested Schema : fieldSpecsList
Type: object
Contains field details.
Show Source
Nested Schema : fieldValueList
Type: array
List of values for the Field
Show Source
  • List of values for the Field
    Example: ["D5E16DD550CB4AD1B330E0D09B4B8F3F","A5E16DD550CB4AD1B330E0D09B4B8F3F"]
Example:
[
    "D5E16DD550CB4AD1B330E0D09B4B8F3F",
    "A5E16DD550CB4AD1B330E0D09B4B8F3F"
]
Nested Schema : fieldValueList
Type: array
List of values for the Field
Show Source
  • List of values for the Field
    Example: ["D5E16DD550CB4AD1B330E0D09B4B8F3F","A5E16DD550CB4AD1B330E0D09B4B8F3F"]
Example:
[
    "D5E16DD550CB4AD1B330E0D09B4B8F3F",
    "A5E16DD550CB4AD1B330E0D09B4B8F3F"
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Success Returns a BaseResponse containing an ODM object.
Body ()
Root Schema : ODM1
Type: object
Oracle Clinical Data Management model object for CRF report result data, including study, admin, reference, clinical, and associated metadata.
Show Source
Nested Schema : AdminData
Type: object
ODM AdminData section: definition of users, locations, digital signatures, and study OID metadata.
Show Source
Nested Schema : Association
Type: object
Association between study and metadata version with embedded content
Show Source
  • content
    List of associated elements
  • String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 2.0.0.38
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example: 2.0.0.39.222eabde-1b96-48f6-9d3b-6250880a2b09
Nested Schema : ClinicalData
Type: object
ODM ClinicalData section containing study OID, metadata version OID, and lists of subject data, audit records, signatures, and annotations.
Show Source
Nested Schema : ReferenceData
Type: object
ReferenceData DTO.
Show Source
Nested Schema : Signature
Type: object
XML Digital Signature container including SignedInfo, SignatureValue, KeyInfo and optional Object elements.
Show Source
Nested Schema : Study
Type: object
ODM Study object
Show Source
Nested Schema : Location
Type: object
Represents a site or location entity within the ODM context.
Show Source
Nested Schema : SignatureDef
Type: object
Definition of a signature including meaning, legal reason, and identifiers.
Show Source
Nested Schema : User
Type: object
Represents a user in the ODM AdminData structure (site personnel, investigator, etc).
Show Source
Nested Schema : metaDataVersionRef
Type: object
Reference to a specific study metadata version with effective date information.
Show Source
  • Effective date for this metadata version in YYYY-MM-DD format.
    Example: 2025-01-31
  • Effective date and time for this metadata version in ISO-8601 format.
    Example: 2025-01-31T10:15:30Z
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the metadata version.
    Example: A1B2C3D4E5F6478899AABBCCDDEEFF11
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example: 0C7CBA3F70034C47947E2FAB086BFBF5
Nested Schema : LegalReason1
Type: object
Represents the legal reason metadata for an ODM element.
Show Source
Nested Schema : Meaning1
Type: object
Represents the meaning metadata for an ODM element.
Show Source
Nested Schema : address
Type: object
Postal or location address for an ODM user or site, with support for street, city, state, country, and postal code.
Show Source
Nested Schema : certificate
Type: object
Digital certificate or identity for an ODM User.
Show Source
Nested Schema : DisplayName1
Type: object
Human-readable display name for the ODM User.
Show Source
  • Value for the display name of the user.
    Example: Dr. J. Smith
Nested Schema : email
Type: object
Email address record for an ODM user.
Show Source
Nested Schema : fax
Type: object
Fax number/contact for an ODM User.
Show Source
Nested Schema : FirstName10
Type: object
User's first name.
Show Source
Nested Schema : FullName10
Type: object
User's full name as a single value.
Show Source
Nested Schema : LastName10
Type: object
User's last/family/surname.
Show Source
Nested Schema : locationRef
Type: object
Reference to a study/site location for an ODM User.
Show Source
Nested Schema : LoginName1
Type: object
Login name or identifier for the ODM User.
Show Source
Nested Schema : Organization10
Type: object
Organization name associated with the User.
Show Source
  • Name of the user's organization.
    Example: Site 101 Hospital
Nested Schema : Pager1
Type: object
Pager number or contact info for an ODM User.
Show Source
Nested Schema : phone
Type: object
Phone number/contact entry for ODM User.
Show Source
Nested Schema : Picture1
Type: object
Profile or avatar image info for ODM User.
Show Source
Nested Schema : City1
Type: object
City component of a postal address.
Show Source
Nested Schema : Country1
Type: object
Country component of a postal address.
Show Source
Nested Schema : OtherText1
Type: object
Additional address information or notes.
Show Source
Nested Schema : PostalCode1
Type: object
Postal or ZIP code component of a postal address.
Show Source
Nested Schema : StateProv1
Type: object
State or province component of a postal address.
Show Source
Nested Schema : streetName
Type: object
Street name component of a postal address.
Show Source
Nested Schema : content
Type: array
List of associated elements
Show Source
Nested Schema : items
Type: object
List of associated elements
Nested Schema : Annotations
Type: array
List of annotations attached to the clinical data
Show Source
Nested Schema : auditRecords
Type: array
List of audit records associated with clinical data
Show Source
Nested Schema : Signatures
Type: array
List of digital signatures applied to the clinical data
Show Source
Nested Schema : subjectData
Type: array
List of subject-level clinical data records
Show Source
Nested Schema : Annotations1
Type: object
Container for a list of ODM Annotation entries.
Show Source
Nested Schema : annotation
Type: array
List of Annotation entries associated to the ODM structure.
Show Source
Nested Schema : Annotation2
Type: object
Note, query, or other annotation associated with a data point, including flags and a comment.
Show Source
Nested Schema : Comment2
Type: object
Comment DTO
Show Source
Nested Schema : flag
Type: object
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
Nested Schema : FlagType1
Type: object
Flag type
Show Source
Example:
{
    "flagOID":"QUERY"
}
Nested Schema : FlagValue1
Type: object
Flag value
Show Source
Example:
{
    "value":"Review"
}
Nested Schema : AuditRecords1
Type: object
Container for a list of ODM audit record entries.
Show Source
Nested Schema : auditRecord
Type: array
List of audit records associated with the subject or form.
Show Source
Nested Schema : AuditRecord100
Type: object
Audit trail entry describing who performed a change, where it occurred, when it happened, and the justification.
Show Source
Nested Schema : DateTimeStamp1
Type: object
Date/time stamp value with formatted representation.
Show Source
Nested Schema : LocationRef1
Type: object
Reference to a study/site location for an ODM User.
Show Source
Nested Schema : ReasonForChange1
Type: object
Explanation provided to justify why a data value was created or modified.
Show Source
  • Free-text reason describing the change.
    Example: Correction of data entry error
Nested Schema : SourceID1
Type: object
Identifier of the originating system or source that provided the data.
Show Source
Nested Schema : UserRef10
Type: object
Reference to a user within the study.
Show Source
Nested Schema : Signatures1
Type: object
Container for a list of ODM Signature entries.
Show Source
Nested Schema : signature
Type: array
List of signature entries associated with the ODM structure.
Show Source
Nested Schema : Signature1
Type: object
Digital signature record including signer, location, timestamp, and cryptographic binding manifest.
Show Source
Nested Schema : CryptoBindingManifest10
Type: object
Cryptographic binding manifest that ties the signature to the signed payload.
Show Source
  • Base64-encoded manifest payload.
    Example: VGhpcyBpcyBhIG1hbmlmZXN0IHBheWxvYWQ=
Nested Schema : SignatureRef1
Type: object
Reference to a signature object used to approve or verify data.
Show Source
Nested Schema : SubjectData1
Type: object
ODM SubjectData structure including audit, signature, references and event data for a subject.
Show Source
Nested Schema : annotation
Type: array
List of annotations (queries, notes, flags) linked to the subject data.
Show Source
Nested Schema : InvestigatorRef1
Type: object
Reference to an investigator user participating in the study.
Show Source
  • Identifier (OID) of the investigator user within the study.
    Example: c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29
Nested Schema : SiteRef10
Type: object
Reference to a study site/location.
Show Source
Nested Schema : studyEventData
Type: array
All scheduled or unscheduled visit/event data for the subject.
Show Source
Nested Schema : subjectHistory
Type: array
Chronological history of key actions for this subject.
Show Source
  • History1
    Historical record describing an action performed on an ODM entity, with optional details and timestamp.
Nested Schema : transferData
Type: array
Data transfer records for this subject (e.g., imports or system migrations).
Show Source
Nested Schema : StudyEventData1
Type: object
Subject visit or study event data block including forms, annotations and references.
Show Source
Nested Schema : annotation
Type: array
Annotations (queries, comments, flags) on this study event.
Show Source
Nested Schema : EventHistory
Type: array
History of actions performed on this study event.
Show Source
  • History1
    Historical record describing an action performed on an ODM entity, with optional details and timestamp.
Example:
[
    {
        "action":"Locked",
        "actionDate":"2025-11-01T14:00:00Z"
    }
]
Nested Schema : formData
Type: array
Forms captured within this study event.
Show Source
Nested Schema : RepeatingFormSummary1
Type: object
Summary container for sets of repeating forms within a study event.
Show Source
Nested Schema : History1
Type: object
Historical record describing an action performed on an ODM entity, with optional details and timestamp.
Show Source
Nested Schema : details
Type: array
Additional details about the action.
Show Source
  • Additional details about the action.
    Example: ["Verified by Data Manager","No discrepancies found"]
Example:
[
    "Verified by Data Manager",
    "No discrepancies found"
]
Nested Schema : FormData10
Type: object
Data captured for a single form within a study event, including items, annotations, signatures, and status.
Show Source
Nested Schema : Annotation
Type: array
Annotations (queries, notes, flags) for this form.
Show Source
Nested Schema : ArchiveLayoutRef1
Type: object
Archive layout reference
Show Source
Nested Schema : ItemGroupData
Type: array
Groups of item data contained in this form.
Show Source
Nested Schema : ItemGroupData1
Type: object
Data captured for a Item Group
Show Source
Nested Schema : annotation
Type: object
Note, query, or other annotation associated with a data point, including flags and a comment.
Show Source
Nested Schema : items
Type: object
Data captured for a Item
Show Source
Nested Schema : flag
Type: object
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
Nested Schema : Annotation
Type: object
Note, query, or other annotation associated with a data point, including flags and a comment.
Show Source
Nested Schema : MeasurementUnitRef1
Type: object
Data captured for a Measurement Unit
Show Source
Nested Schema : flag
Type: object
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
Nested Schema : repeatingFormData
Type: array
Collection of repeating form data entries.
Show Source
Nested Schema : RepeatingFormData1
Type: object
A single repeating form instance including headers and rows of item data.
Show Source
Nested Schema : formHeader
Type: array
Header section for the repeating form instance (metadata about the form).
Show Source
Nested Schema : Row
Type: array
Rows comprising items captured in this form instance.
Show Source
  • Row2
    A single row within a repeating form instance containing associated forms and item data.
Nested Schema : FormHeader1
Type: object
Header metadata for a form instance, including basic identity and display information.
Show Source
Nested Schema : Row2
Type: object
A single row within a repeating form instance containing associated forms and item data.
Show Source
Nested Schema : associatedFormList
Type: array
List of forms associated with this row, if any.
Show Source
Nested Schema : item
Type: array
Items captured within this row.
Show Source
Nested Schema : AssociatedFormList1
Type: object
Associated form details including visit and audit metadata
Show Source
Nested Schema : auditTrail
Type: array
List of audit trail entries
Show Source
Nested Schema : AuditTrail1
Type: object
Audit trail entry with timestamp, user, deletion status and note
Show Source
Nested Schema : Item1
Type: object
ODM Item instance with value and identifiers
Show Source
  • Indicates whether this item represents an itemset (grid or repeating values).
    Example: false
  • Row identifiers or count for the itemset when itemset is true.
    Example: 1
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: 3F2504E04F8911D39A0C0305E82C3301
  • The decoded value of the raw value, which provides a more meaningful representation of the data. For dates, it follows the ISO 8601 standard. For questions with multiple choice options, it uses the corresponding code from the codelist. Additionally, ItemD decodes special flags like NA, ND, and UNK to their corresponding meanings, making it easier to understand the data.
    Example: SAMPLE_VALUE
Nested Schema : TransferData1
Type: object
Subject transfer details between sites
Show Source
Nested Schema : Annotations
Type: object
Container for a list of ODM Annotation entries.
Show Source
Nested Schema : AuditRecords
Type: object
Container for a list of ODM audit record entries.
Show Source
Nested Schema : ItemGroupData
Type: object
Data captured for a Item Group
Show Source
Nested Schema : Signatures
Type: object
Container for a list of ODM Signature entries.
Show Source
Nested Schema : annotation
Type: array
List of Annotation entries associated to the ODM structure.
Show Source
Nested Schema : auditRecord
Type: array
List of audit records associated with the subject or form.
Show Source
Nested Schema : annotation
Type: object
Note, query, or other annotation associated with a data point, including flags and a comment.
Show Source
Nested Schema : items
Type: object
Data captured for a Item
Show Source
Nested Schema : flag
Type: object
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
Nested Schema : Annotation
Type: object
Note, query, or other annotation associated with a data point, including flags and a comment.
Show Source
Nested Schema : flag
Type: object
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
Nested Schema : signature
Type: array
List of signature entries associated with the ODM structure.
Show Source
Nested Schema : KeyInfoType1
Type: object
Key information content (e.g., X509Data, KeyName) and optional identifier.
Show Source
  • content
    Key information content (e.g., X509Data, KeyName).
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: ABCDEF1234567890ABCDEF1234567890
Nested Schema : object
Type: object
Generic container for embedded object content and metadata
Show Source
Nested Schema : SignatureValueType1
Type: object
The actual value of the digital signature and optional identifier.
Show Source
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: ABCDEF1234567890ABCDEF1234567890
  • Base64-encoded signature value.
Nested Schema : SignedInfoType1
Type: object
Contains canonicalization and signature methods, and references used in the XML Digital Signature.
Show Source
Nested Schema : content
Type: object
Key information content (e.g., X509Data, KeyName).
Nested Schema : content
Type: array
List of embedded content
Show Source
Nested Schema : items
Type: object
List of embedded content
Nested Schema : CanonicalizationMethodType1
Type: object
Canonicalization method definition per XML Digital Signature specification.
Show Source
Nested Schema : reference
Type: object
Reference to signed data including transforms, digest method, and digest value.
Show Source
Nested Schema : SignatureMethodType1
Type: object
Signature algorithm definition and associated parameters for XML Digital Signatures.
Show Source
Nested Schema : content
Type: object
Arbitrary content for CanonicalizationMethod child nodes.
Nested Schema : DigestMethodType1
Type: object
Digest method definition and optional parameters for computing the message digest in XML Digital Signatures.
Show Source
Nested Schema : TransformsType1
Type: object
Collection of Transform elements applied to the referenced data.
Show Source
Nested Schema : content
Type: object
Optional content/parameters for the DigestMethod.
Nested Schema : transform
Type: object
Transform algorithm definition and optional parameters applied to referenced data.
Show Source
Nested Schema : content
Type: object
Optional content/parameters for the Transform.
Nested Schema : content
Type: object
Optional content/parameters for the SignatureMethod.
Nested Schema : BasicDefinitions10
Type: object
Root-level definitions for basic units and reference types in the ODM Study.
Show Source
Nested Schema : GlobalVariables10
Type: object
ODM GlobalVariables for a Study, providing human-readable study description and identifiers.
Show Source
Nested Schema : MetaDataVersion
Type: object
Represents the metadata about the study
Show Source
Nested Schema : MeasurementUnit
Type: object
A measurement unit reference used in study forms, such as mg/dL.
Show Source
Nested Schema : Alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : Symbol10
Type: object
Symbol element for a MeasurementUnit.
Show Source
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : ProtocolName10
Type: object
Protocol identifier/name for the ODM Study.
Show Source
Nested Schema : StudyDescription10
Type: object
Free-text description of the ODM Study.
Show Source
  • Free-text description of the Study.
    Example: Phase 3, double blind, randomized clinical study in Diabetes.
Nested Schema : StudyName10
Type: object
Human-readable display name for the ODM Study.
Show Source
Nested Schema : codeList
Type: object
Code list definition including items or external mappings.
Show Source
Nested Schema : conditionDef
Type: object
Condition definition containing formal expressions and metadata.
Show Source
Nested Schema : formDef
Type: object
Form definition containing item group references, archive layouts and metadata.
Show Source
Nested Schema : imputationMethod
Type: object
Imputation method definition with value and identifier.
Show Source
  • Imputation method object identifier
    Example: a4a7124a-0056-4fb5-9a7e-4a1b0068a966.1_8_0_29
  • Imputation method value
    Example: MeanImputation
Nested Schema : Include10
Type: object
Includes the metadata about the study version
Show Source
Nested Schema : itemDef
Type: object
Item definition including question, code list, range checks and metadata.
Show Source
Nested Schema : itemGroupDef
Type: object
ItemGroup definition containing item references and metadata.
Show Source
Nested Schema : methodDef
Type: object
Method definition containing formal expressions and metadata.
Show Source
Nested Schema : presentation
Type: object
Presentation metadata including value, identifier and language.
Show Source
Nested Schema : Protocol10
Type: object
Protocol metadata
Show Source
Nested Schema : studyEventDef
Type: object
Study Event Def data
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : codeListItem
Type: object
Represents a single code list item with decode and metadata.
Show Source
Nested Schema : Description10
Type: object
Description DTO having information on the translated text
Show Source
Nested Schema : enumeratedItem
Type: object
Enumerated item value with optional ordering and aliases.
Show Source
Nested Schema : ExternalCodeList1
Type: object
Reference to an external dictionary-based code list.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : Decode1
Type: object
Decoded text for a code list item with translations.
Show Source
Nested Schema : translatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : translatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : formalExpression
Type: object
Formal expression used for validation.
Show Source
Nested Schema : alias
Type: array
Aliases for the form
Show Source
Nested Schema : archiveLayout
Type: array
Archive layouts defined for this form
Show Source
Nested Schema : itemGroupRef
Type: array
Item group references for this form
Show Source
Nested Schema : Alias1
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : ArchiveLayout1
Type: object
Archive layout metadata for a form.
Show Source
Nested Schema : ItemGroupRef1
Type: object
Reference to an ItemGroup within a form.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : CodeListRef1
Type: object
Reference to a CodeList by its OID.
Show Source
  • OID of the referenced code list
    Example: c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29
Nested Schema : ExternalQuestion1
Type: object
External question reference details.
Show Source
Nested Schema : itemRef
Type: object
Reference to an Item within an ItemGroup.
Show Source
Nested Schema : measurementUnitRef
Type: object
Data captured for a Measurement Unit
Show Source
Nested Schema : Question1
Type: object
Question containing translated display text.
Show Source
Nested Schema : rangeCheck
Type: object
Range check configuration for item validation.
Show Source
Nested Schema : role
Type: object
Represents the role associated with an item or definition.
Show Source
Nested Schema : translatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : checkValue
Type: object
A value used within a range validation.
Show Source
Nested Schema : ErrorMessage1
Type: object
Error message details for validation failures.
Show Source
Nested Schema : formalExpression
Type: object
Formal expression used for validation.
Show Source
Nested Schema : translatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Nested Schema : alias
Type: array
Aliases for the ItemGroup
Show Source
Nested Schema : itemRef
Type: array
References to Items within this ItemGroup
Show Source
Nested Schema : ItemRef1
Type: object
Reference to an Item within an ItemGroup.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : formalExpression
Type: object
Formal expression used for validation.
Show Source
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Example:
[
    {
        "context":"CDASH",
        "name":"PROTID"
    }
]
Nested Schema : studyEventRef
Type: object
Study Event Ref data
Show Source
Example:
[
    {
        "eventOID":"SE1"
    }
]
Nested Schema : alias
Type: object
A synonym, translation, or locale-specific label for a MeasurementUnit.
Show Source
  • Locale, region, or terminology context.
    Example: US
  • Alternative or alias name for the unit in this context.
    Example: mg per deciliter
Nested Schema : formRef
Type: object
FormRef metadata
Show Source
Examples

400 Response

Bad Request : Required fields missing or invalid.
Body ()
Root Schema : BaseResponse
Type: object
Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.
Show Source
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
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
Nested Schema : details
Type: object
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
Examples

401 Response

Unauthorized : User lacks access.
Body ()
Root Schema : BaseResponse
Type: object
Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.
Show Source
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
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
Nested Schema : details
Type: object
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
Examples

500 Response

Internal Server Error : Unexpected server failure.
Body ()
Root Schema : BaseResponse
Type: object
Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.
Show Source
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
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
Nested Schema : details
Type: object
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
Examples

Back to Top