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
Examples

Back to Top

Response

Supported Media Types

200 Response

Success Returns a BaseResponse containing an ODM object.
Body ()
Root Schema : ODM
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
Example:
{
    "user":[
        {
            "userId":"A8C41D8062A14FCC89EDA475C3E3AF12",
            "userName":"adminuser"
        }
    ],
    "location":[
        {
            "locationId":"LOC101",
            "locationName":"Site 101"
        }
    ],
    "signatureDef":[
        {
            "sigType":"Data Entry"
        }
    ],
    "studyOID":"D5E16DD550CB4AD1B330E0D09B4B8F3F"
}
Nested Schema : Association
Type: object
Study-level associations (e.g. investigator, site, etc.).
Show Source
Example:
[
    {
        "role":"INVESTIGATOR"
    }
]
Nested Schema : ClinicalData
Type: object
List of clinical data subjects/visits/logs.
Show Source
Example:
[
    {
        "subjectOID":"SUBJ1"
    }
]
Nested Schema : ReferenceData
Type: object
Reference data map.
Show Source
Example:
[
    {
        "refType":"CDISC"
    }
]
Nested Schema : Signature
Type: object
Array of digital signatures appended to this CRF data.
Show Source
Example:
[
    {
        "signedBy":"Dr. J. Smith"
    }
]
Nested Schema : Study
Type: object
ODM Study object
Show Source
Example:
[
    {
        "studyOID":"S123"
    }
]
Nested Schema : Location
Type: object
Physical or logical locations for the study.
Show Source
Nested Schema : SignatureDef
Type: object
Study-level signature definitions.
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: array
Show Source
Nested Schema : MetaDataVersionRef
Type: object
Show Source
Nested Schema : LegalReason
Type: object
Show Source
Nested Schema : Meaning
Type: object
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 : DisplayName
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 : FirstName
Type: object
User's first name.
Show Source
Example:
{
    "value":"John"
}
Nested Schema : FullName
Type: object
User's full name as a single value.
Show Source
Example:
{
    "value":"John Smith"
}
Nested Schema : LastName
Type: object
User's last/family/surname.
Show Source
Example:
{
    "value":"Smith"
}
Nested Schema : LocationRef
Type: object
Reference to a study/site location for an ODM User.
Show Source
Nested Schema : LoginName
Type: object
Login name or identifier for the ODM User.
Show Source
Nested Schema : Organization
Type: object
Organization name associated with the User.
Show Source
  • Name of the user's organization.
    Example: Site 101 Hospital
Example:
{
    "value":"Site 101 Hospital"
}
Nested Schema : Pager
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
Example:
{
    "value":"555-9876"
}
Nested Schema : Picture
Type: object
Profile or avatar image info for ODM User.
Show Source
Nested Schema : City
Type: object
City for this address.
Show Source
Nested Schema : Country
Type: object
Country.
Show Source
Nested Schema : OtherText
Type: object
Additional address information.
Show Source
Nested Schema : PostalCode
Type: object
Postal or ZIP code.
Show Source
Nested Schema : StateProv
Type: object
State or province.
Show Source
Nested Schema : StreetName
Type: object
List of street name lines.
Show Source
Nested Schema : Content
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : Annotations
Type: array
Show Source
Nested Schema : AuditRecords
Type: array
Show Source
Nested Schema : Signatures
Type: array
Show Source
Nested Schema : SubjectData
Type: array
Show Source
Nested Schema : Annotations
Type: object
Show Source
Nested Schema : Annotation
Type: array
Show Source
Nested Schema : Annotation
Type: object
Show Source
Nested Schema : Comment
Type: object
Annotation comment object
Show Source
Example:
{
    "value":"Requires follow-up"
}
Nested Schema : Flag
Type: object
Flags associated with this annotation
Show Source
Example:
[
    {
        "flagOID":"FLAG1"
    }
]
Nested Schema : FlagType
Type: object
Show Source
Nested Schema : FlagValue
Type: object
Show Source
Nested Schema : AuditRecords
Type: object
Show Source
Nested Schema : AuditRecord
Type: array
Show Source
Nested Schema : AuditRecord
Type: object
Show Source
Nested Schema : DateTimeStamp
Type: object
Timestamp of signing
Show Source
Example:
{
    "value":"2025-10-27T10:00:00Z"
}
Nested Schema : LocationRef
Type: object
Reference to a study/site location for an ODM User.
Show Source
Example:
{
    "locationOID":"LOC101"
}
Nested Schema : ReasonForChange
Type: object
Reason for data change
Show Source
Example:
{
    "value":"Correction"
}
Nested Schema : SourceID
Type: object
Source identifier
Show Source
Example:
{
    "value":"SYS"
}
Nested Schema : UserRef
Type: object
Reference to user
Show Source
Example:
{
    "userOID":"USER123"
}
Nested Schema : Signatures
Type: object
Show Source
Nested Schema : Signature
Type: array
Show Source
Nested Schema : Signature
Type: object
Show Source
Nested Schema : CryptoBindingManifest
Type: object
Crypto binding manifest details
Show Source
Example:
{
    "manifestID":"CBM1"
}
Nested Schema : SignatureRef
Type: object
Reference to signature
Show Source
Example:
{
    "refID":"SIGREF1"
}
Nested Schema : SubjectData
Type: object
Show Source
Nested Schema : Annotation
Type: array
Show Source
Nested Schema : InvestigatorRef
Type: object
Show Source
Nested Schema : SiteRef
Type: object
Show Source
Nested Schema : StudyEventData
Type: array
Show Source
Nested Schema : SubjectHistory
Type: array
Show Source
Nested Schema : TransferData
Type: array
Show Source
Nested Schema : StudyEventData
Type: object
Show Source
Nested Schema : Annotation
Type: array
Show Source
Nested Schema : EventHistory
Type: array
Show Source
Nested Schema : FormData
Type: array
Show Source
Nested Schema : RepeatingFormSummary
Type: object
Show Source
Nested Schema : History
Type: object
Show Source
Nested Schema : details
Type: array
Show Source
Nested Schema : FormData
Type: object
Show Source
Nested Schema : Annotation
Type: array
Show Source
Nested Schema : ArchiveLayoutRef
Type: object
Show Source
Nested Schema : ItemGroupData
Type: array
Show Source
Nested Schema : ItemGroupData
Type: object
Show Source
Nested Schema : Annotation
Type: object
Annotations for the item group
Show Source
Example:
[
    {
        "annotationOID":"AN1"
    }
]
Nested Schema : Items
Type: object
Contained item data list
Show Source
Example:
[
    {
        "itemOID":"ITM1"
    }
]
Nested Schema : Flag
Type: object
Flags associated with this annotation
Show Source
Example:
[
    {
        "flagOID":"FLAG1"
    }
]
Nested Schema : Annotation
Type: object
Annotations for this item
Show Source
Example:
[
    {
        "id":"AN1"
    }
]
Nested Schema : MeasurementUnitRef
Type: object
Measurement unit reference
Show Source
Example:
{
    "measurementUnitOID":"U1"
}
Nested Schema : Flag
Type: object
Flags associated with this annotation
Show Source
Example:
[
    {
        "flagOID":"FLAG1"
    }
]
Nested Schema : RepeatingFormData
Type: array
Show Source
Nested Schema : RepeatingFormData
Type: object
Show Source
Nested Schema : FormHeader
Type: array
Show Source
Nested Schema : Row
Type: array
Show Source
Nested Schema : FormHeader
Type: object
Show Source
Nested Schema : Row
Type: object
Show Source
Nested Schema : AssociatedFormList
Type: array
Show Source
Nested Schema : Item
Type: array
Show Source
Nested Schema : AssociatedFormList
Type: object
Show Source
Nested Schema : AuditTrail
Type: array
Show Source
Nested Schema : AuditTrail
Type: object
Show Source
Nested Schema : Item
Type: object
Show Source
Nested Schema : TransferData
Type: object
Show Source
Nested Schema : Annotations
Type: object
List of annotations
Show Source
Example:
[
    {
        "annotationOID":"AN1"
    }
]
Nested Schema : AuditRecords
Type: object
List of audit records
Show Source
Example:
[
    {
        "auditOID":"AUD1"
    }
]
Nested Schema : ItemGroupData
Type: object
List of item group data
Show Source
Example:
[
    {
        "groupOID":"IG1"
    }
]
Nested Schema : Signatures
Type: object
List of signatures
Show Source
Example:
[
    {
        "signatureOID":"SIG1"
    }
]
Nested Schema : Annotation
Type: array
Show Source
Nested Schema : AuditRecord
Type: array
Show Source
Nested Schema : Annotation
Type: object
Annotations for the item group
Show Source
Example:
[
    {
        "annotationOID":"AN1"
    }
]
Nested Schema : Items
Type: object
Contained item data list
Show Source
Example:
[
    {
        "itemOID":"ITM1"
    }
]
Nested Schema : Flag
Type: object
Flags associated with this annotation
Show Source
Example:
[
    {
        "flagOID":"FLAG1"
    }
]
Nested Schema : Annotation
Type: object
Annotations for this item
Show Source
Example:
[
    {
        "id":"AN1"
    }
]
Nested Schema : Flag
Type: object
Flags associated with this annotation
Show Source
Example:
[
    {
        "flagOID":"FLAG1"
    }
]
Nested Schema : Signature
Type: array
Show Source
Nested Schema : KeyInfoType
Type: object
Show Source
Nested Schema : Object
Type: array
Show Source
Nested Schema : SignatureValueType
Type: object
Show Source
Nested Schema : SignedInfoType
Type: object
Show Source
Nested Schema : Content
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : ObjectType
Type: object
Show Source
Nested Schema : Content
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : CanonicalizationMethodType
Type: object
Show Source
Nested Schema : Reference
Type: array
Show Source
Nested Schema : SignatureMethodType
Type: object
Show Source
Nested Schema : Content
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : ReferenceType
Type: object
Show Source
Nested Schema : DigestMethodType
Type: object
Show Source
Nested Schema : TransformsType
Type: object
Show Source
Nested Schema : Content
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : Transform
Type: array
Show Source
Nested Schema : TransformType
Type: object
Show Source
Nested Schema : Content
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : Content
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : BasicDefinitions
Type: object
Root-level definitions for basic units and reference types in the ODM Study.
Show Source
Example:
{
    "unitDef":[
        {
            "unitOID":"U1"
        }
    ]
}
Nested Schema : GlobalVariables
Type: object
ODM GlobalVariables for a Study, providing human-readable study description and identifiers.
Show Source
Example:
{
    "studyName":{
        "value":"TESTSTUDY"
    }
}
Nested Schema : MetaDataVersion
Type: object
List of metadata versions for the study.
Show Source
Example:
[
    {
        "versionOID":"MDV1"
    }
]
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 : Symbol
Type: object
Symbol element for a MeasurementUnit.
Show Source
Example:
{
    "translatedText":[
        {
            "lang":"en",
            "value":"mg/dL"
        }
    ]
}
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : ProtocolName
Type: object
Protocol identifier/name for the ODM Study.
Show Source
Nested Schema : StudyDescription
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 : StudyName
Type: object
Human-readable display name for the ODM Study.
Show Source
Example:
{
    "value":"Sample Study"
}
Nested Schema : CodeList
Type: object
Code lists for data values
Show Source
Example:
[
    {
        "codeListOID":"CL1"
    }
]
Nested Schema : ConditionDef
Type: object
Condition definitions for logic
Show Source
Example:
[
    {
        "conditionOID":"C1"
    }
]
Nested Schema : FormDef
Type: object
Form definitions
Show Source
Example:
[
    {
        "formOID":"F1"
    }
]
Nested Schema : ImputationMethod
Type: object
Imputation methods
Show Source
Example:
[
    {
        "methodOID":"IM1"
    }
]
Nested Schema : Include
Type: object
Reference to parent include structure
Show Source
Example:
{
    "href":"/includes/INC123"
}
Nested Schema : ItemDef
Type: object
Item definitions
Show Source
Example:
[
    {
        "itemOID":"I1"
    }
]
Nested Schema : ItemGroupDef
Type: object
Item group definitions
Show Source
Example:
[
    {
        "groupOID":"IG1"
    }
]
Nested Schema : MethodDef
Type: object
Custom method definitions
Show Source
Example:
[
    {
        "methodOID":"M1"
    }
]
Nested Schema : Presentation
Type: object
Presentations used in eCRFs
Show Source
Example:
[
    {
        "presentationOID":"P1"
    }
]
Nested Schema : Protocol
Type: object
Protocol metadata for this study version
Show Source
Example:
{
    "protocolName":"PROT1"
}
Nested Schema : StudyEventDef
Type: object
Study event definitions
Show Source
Example:
[
    {
        "eventOID":"SE1"
    }
]
Nested Schema : Alias
Type: array
Show Source
Nested Schema : Description
Type: object
Item description details
Show Source
Example:
{
    "value":"desc"
}
Nested Schema : EnumeratedItem
Type: array
Show Source
Nested Schema : ExternalCodeList
Type: object
Show Source
Nested Schema : Items
Type: array
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":"SUBJID"
    }
]
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : EnumeratedItem
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : CodeListItem
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : Decode
Type: object
Show Source
Nested Schema : TranslatedText
Type: array
Show Source
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : Alias
Type: array
Show Source
Nested Schema : FormalExpression
Type: array
Show Source
Nested Schema : FormalExpression
Type: object
Show Source
Nested Schema : Alias
Type: array
Show Source
Nested Schema : ArchiveLayout
Type: array
Show Source
Nested Schema : ItemGroupRef
Type: array
Show Source
Nested Schema : ArchiveLayout
Type: object
Show Source
Nested Schema : ItemGroupRef
Type: object
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":"SUBJID"
    }
]
Nested Schema : CodeListRef
Type: object
Reference to code list
Show Source
Example:
{
    "codeListOID":"CL1"
}
Nested Schema : ExternalQuestion
Type: object
Additional question taken from external systems
Show Source
Example:
{
    "externalId":"Q1"
}
Nested Schema : ItemRef
Type: object
Item reference list
Show Source
Example:
[
    {
        "itemOID":"ITM2"
    }
]
Nested Schema : MeasurementUnitRef
Type: object
Measurement units for this item
Show Source
Example:
[
    {
        "unitOID":"U1"
    }
]
Nested Schema : Question
Type: object
The main study question
Show Source
Example:
{
    "text":"What is your height?"
}
Nested Schema : RangeCheck
Type: object
Validation range checks
Show Source
Example:
[
    {
        "checkOID":"RC1"
    }
]
Nested Schema : Role
Type: object
Item roles (reviewer, data entry, etc)
Show Source
Example:
[
    {
        "roleName":"DataEntry"
    }
]
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : CheckValue
Type: object
Check values for enforcing data validation range
Show Source
Example:
[
    {
        "value":"10"
    }
]
Nested Schema : ErrorMessage
Type: object
Error message details for validation error
Show Source
Example:
{
    "lang":"en",
    "value":"Error: out of range!"
}
Nested Schema : FormalExpression
Type: object
Formal expressions for advanced data validation
Show Source
Example:
[
    {
        "language":"XPath",
        "value":"@AGE > 18"
    }
]
Nested Schema : TranslatedText
Type: object
A localizable or translated representation of a symbol, label, or similar text element.
Show Source
Example:
{
    "lang":"en",
    "value":"mg/dL"
}
Nested Schema : Alias
Type: array
Show Source
Nested Schema : ItemRef
Type: array
Show Source
Nested Schema : ItemRef
Type: object
Item reference list
Show Source
Example:
[
    {
        "itemOID":"ITM2"
    }
]
Nested Schema : Alias
Type: array
Show Source
Nested Schema : FormalExpression
Type: array
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
Referenced study events
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
Example:
[
    {
        "context":"CDASH",
        "name":"SCREEN"
    }
]
Nested Schema : FormRef
Type: object
Associated form references
Show Source
Example:
[
    {
        "formOID":"F1"
    }
]
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
  • ErrorResponseData
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
  • Response status for the request; typically 'success' or 'error'.
    Example: success
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
  • 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
  • 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.
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
  • ErrorResponseData
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
  • Response status for the request; typically 'success' or 'error'.
    Example: success
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
  • 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
  • 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.
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
  • ErrorResponseData
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
  • Response status for the request; typically 'success' or 'error'.
    Example: success
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
  • 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
  • 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.
Examples

Back to Top