Jump to

• Request
• Response

V1.0

post

/ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/items/actions

Retrieves the study-permissioned Subject Item SVFL dataset for a single study and mode.

The dataset exposes item-level action history, including action type, action status, action object, sign metadata, action user/date, together with related study, site, subject, visit, form, and item context.

Supports select, filter, sort, limit, and offset query patterns.

The dataset returns action-history rows captured for subject item data points in the selected study and mode.

Required permission: DMActionsPost.

Recommended order columns: The backend query always orders results by DH_TIMESTAMP and VERSION_START in ascending order first. If orderColumns is empty, only these two columns are used. If orderColumns is provided, the specified columns are appended after DH_TIMESTAMP and VERSION_START. For stable, deterministic pagination, use STUDY_ID, SUBJECT_ID, EVENT_ID, EVENT_INSTANCE_NUM, FORM_ID, INNER_REPEAT, OUTER_REPEAT, ITEM_ID, ACTION_TYPE, ACTION_OBJECT, ACTION_STATUS, SIGN_LEVEL, and SIGN_NAME in the orderColumns field of the request payload.

Request

Path Parameters

• mode(required): string

  Execution mode for the study.

  Allowed values: test, active, training.

  Example: test.

• studyId(required): string(uuid)

  Unique study identifier supplied in the studyId path parameter.

  Use the uppercase hexadecimal UUID value for the study.

  Example: 0C7CBA3F70034C47947E2FAB086BFBF5.

• tenantId(required): string(uuid)

  Unique tenant identifier supplied in the tenantId path parameter.

  Use the uppercase hexadecimal UUID value for the tenant.

  Example: EC942244BB30163BE053BEC44C64CF34.

Query Parameters

• limit: integer(int32)
  Minimum Value: 0

  Page size for the result set.

  • 0 disables pagination and returns the maximum result set allowed by the dataset endpoint.
  • Positive values enable pagination.
  • Negative values return HTTP 400.

  Example:

  100

• offset: integer(int32)
  Minimum Value: 0

  Zero-based row offset.

  • Counts rows, not pages.
  • To fetch the next page, repeat the same request body and set offset = previous offset + previous count.
  • When limit = 0, this value is ignored and the response echoes offset = 0.
  • When limit > 0, an offset beyond the available rows returns HTTP 200 with an empty page.
  • Negative values return HTTP 400.

  Example:

  0

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Submit a structured query for a Data Hub dataset.

• selectColumns is required and must contain one or more valid column names exposed by the target dataset version.
• whereColumns is optional and provides structured filter predicates. Supported operators are =, !=, <>, >, >=, <, <=, LIKE, NOT LIKE, IN, NOT IN, BETWEEN, NOT BETWEEN, IS, and IS NOT.

  Default behavior: Data is filtered based on the STUDY_WID column.

• orderColumns is optional and controls sort order. For stable multi-page retrieval, keep the same orderColumns across page requests.

Show Source

• orderColumns: array orderColumns

  Optional sort instructions to apply to the result set.

  Duplicate order-by columns are rejected.

• selectColumns: array selectColumns

  Required non-empty list of dataset column names to return.

  Column validation is case-insensitive, and the response echoes canonical uppercase dataset column names in the same order.

• whereColumns: array whereColumns

  Optional structured filter predicates.

  This is the request-body equivalent of a WHERE clause.

  All predicate values are supplied as strings and are parsed according to the underlying dataset column type.

{
    "type":"object",
    "properties":{
        "selectColumns":{
            "type":"array",
            "description":"<p>Required non-empty list of dataset column names to return.</p><p>Column validation is case-insensitive, and the response echoes canonical uppercase dataset column names in the same order.</p>",
            "example":[
                "STUDY_VERSION",
                "STUDY_ID"
            ],
            "items":{
                "type":"string",
                "description":"<p>Required non-empty list of dataset column names to return.</p><p>Column validation is case-insensitive, and the response echoes canonical uppercase dataset column names in the same order.</p>",
                "example":"[\"STUDY_VERSION\",\"STUDY_ID\"]"
            }
        },
        "whereColumns":{
            "type":"array",
            "description":"<p>Optional structured filter predicates.</p><p>This is the request-body equivalent of a <code>WHERE</code> clause.</p><p>All predicate values are supplied as strings and are parsed according to the underlying dataset column type.</p>",
            "example":[
                {
                    "columnName":"STUDY_ID",
                    "operator":"=",
                    "value":[
                        "A86F2D0BB610404DB62D37AFA9C20B50"
                    ]
                }
            ],
            "items":{
                "$ref":"#/components/schemas/QueryPredicate"
            }
        },
        "orderColumns":{
            "type":"array",
            "description":"<p>Optional sort instructions to apply to the result set.</p><p>Duplicate order-by columns are rejected.</p>",
            "example":[
                {
                    "columnName":"VERSION_START",
                    "sortOrder":"ASC"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/QueryOrder"
            }
        }
    },
    "description":"<p>Submit a structured query for a Data Hub dataset.</p>\n<ul>\n  <li><code>selectColumns</code> is required and must contain one or more valid column names exposed by the target dataset version.</li>\n  <li><code>whereColumns</code> is optional and provides structured filter predicates. Supported operators are <code>=</code>, <code>!=</code>, <code>&lt;&gt;</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>LIKE</code>, <code>NOT LIKE</code>, <code>IN</code>, <code>NOT IN</code>, <code>BETWEEN</code>, <code>NOT BETWEEN</code>, <code>IS</code>, and <code>IS NOT</code>.\n    <p><strong>Default behavior</strong>: Data is filtered based on the <code>STUDY_WID</code> column.</p>\n  </li>\n  <li><code>orderColumns</code> is optional and controls sort order. For stable multi-page retrieval, keep the same <code>orderColumns</code> across page requests.</li>\n</ul>\n"
}

Nested Schema : orderColumns

Type: array

Optional sort instructions to apply to the result set.

Duplicate order-by columns are rejected.

Show Source

• Array of: object QueryOrder

  Sort instruction specifying a dataset column and optional order direction.

{
    "type":"array",
    "description":"<p>Optional sort instructions to apply to the result set.</p><p>Duplicate order-by columns are rejected.</p>",
    "example":[
        {
            "columnName":"VERSION_START",
            "sortOrder":"ASC"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/QueryOrder"
    }
}

Example:

[
    {
        "columnName":"VERSION_START",
        "sortOrder":"ASC"
    }
]

Nested Schema : selectColumns

Type: array

Required non-empty list of dataset column names to return.

Column validation is case-insensitive, and the response echoes canonical uppercase dataset column names in the same order.

Show Source

• Array of: string

  Required non-empty list of dataset column names to return.

  Column validation is case-insensitive, and the response echoes canonical uppercase dataset column names in the same order.

  Example: ["STUDY_VERSION","STUDY_ID"]

{
    "type":"array",
    "description":"<p>Required non-empty list of dataset column names to return.</p><p>Column validation is case-insensitive, and the response echoes canonical uppercase dataset column names in the same order.</p>",
    "example":[
        "STUDY_VERSION",
        "STUDY_ID"
    ],
    "items":{
        "type":"string",
        "description":"<p>Required non-empty list of dataset column names to return.</p><p>Column validation is case-insensitive, and the response echoes canonical uppercase dataset column names in the same order.</p>",
        "example":"[\"STUDY_VERSION\",\"STUDY_ID\"]"
    }
}

Example:

[
    "STUDY_VERSION",
    "STUDY_ID"
]

Nested Schema : whereColumns

Type: array

Optional structured filter predicates.

This is the request-body equivalent of a WHERE clause.

All predicate values are supplied as strings and are parsed according to the underlying dataset column type.

Show Source

• Array of: object QueryPredicate
  Structured filter predicate used to constrain dataset results by column, operator, and value

{
    "type":"array",
    "description":"<p>Optional structured filter predicates.</p><p>This is the request-body equivalent of a <code>WHERE</code> clause.</p><p>All predicate values are supplied as strings and are parsed according to the underlying dataset column type.</p>",
    "example":[
        {
            "columnName":"STUDY_ID",
            "operator":"=",
            "value":[
                "A86F2D0BB610404DB62D37AFA9C20B50"
            ]
        }
    ],
    "items":{
        "$ref":"#/components/schemas/QueryPredicate"
    }
}

Example:

[
    {
        "columnName":"STUDY_ID",
        "operator":"=",
        "value":[
            "A86F2D0BB610404DB62D37AFA9C20B50"
        ]
    }
]

Nested Schema : QueryOrder

Type: object

Sort instruction specifying a dataset column and optional order direction.

Show Source

• columnName: string

  Required dataset column name to sort by.

  Column-name validation is case-insensitive.

  Example: VERSION_START
• sortOrder: string
  Allowed Values: [ "ASC", "DESC" ]

  Optional sort direction.

  If omitted, SQL default ascending order is used for that column. Allowed values are ASC and DESC.

  Example: ASC

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "description":"<p>Required dataset column name to sort by.</p><p>Column-name validation is case-insensitive.</p>",
            "example":"VERSION_START"
        },
        "sortOrder":{
            "type":"string",
            "description":"<p>Optional sort direction.</p><p>If omitted, SQL default ascending order is used for that column. Allowed values are ASC and DESC.</p>",
            "example":"ASC",
            "enum":[
                "ASC",
                "DESC"
            ]
        }
    },
    "description":"<p>Sort instruction specifying a dataset column and optional order direction.</p>",
    "example":[
        {
            "columnName":"VERSION_START",
            "sortOrder":"ASC"
        }
    ]
}

Example:

[
    {
        "columnName":"VERSION_START",
        "sortOrder":"ASC"
    }
]

Nested Schema : QueryPredicate

Type: object

Structured filter predicate used to constrain dataset results by column, operator, and value

Show Source

• columnName: string
  Required dataset column name to filter on. Column-name validation is case-insensitive.

  Example: STUDY_ID
• operator: string
  Allowed Values: [ ">", "<", "=", ">=", "<=", "<>", "!=", "IN", "NOT IN", "BETWEEN", "NOT BETWEEN", "LIKE", "NOT LIKE", "IS", "IS NOT" ]

  Required comparison operator. Use one value for =, !=, <>, >, >=, <, <="," like, and not like; one or more values for in in; exactly two between between; value equal to null is not.< div>

  Example: =
• value: array value
  Filter values as strings. Value cardinality depends on the operator: one for most operators, one or more for IN/NOT IN, exactly two for BETWEEN/NOT BETWEEN, and exactly one value equal to NULL for IS/IS NOT.

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "description":"Required dataset column name to filter on. Column-name validation is case-insensitive.",
            "example":"STUDY_ID"
        },
        "operator":{
            "type":"string",
            "description":"Required comparison operator. Use one value for =, !=, <>, >, >=, <, <=, LIKE, and NOT LIKE; one or more values for IN and NOT IN; exactly two values for BETWEEN and NOT BETWEEN; and exactly one value equal to NULL for IS and IS NOT.",
            "example":"=",
            "enum":[
                ">",
                "<",
                "=",
                ">=",
                "<=",
                "<>",
                "!=",
                "IN",
                "NOT IN",
                "BETWEEN",
                "NOT BETWEEN",
                "LIKE",
                "NOT LIKE",
                "IS",
                "IS NOT"
            ]
        },
        "value":{
            "type":"array",
            "description":"Filter values as strings. Value cardinality depends on the operator: one for most operators, one or more for IN/NOT IN, exactly two for BETWEEN/NOT BETWEEN, and exactly one value equal to NULL for IS/IS NOT.",
            "example":[
                "A86F2D0BB610404DB62D37AFA9C20B50"
            ],
            "items":{
                "type":"string",
                "description":"Filter values as strings. Value cardinality depends on the operator: one for most operators, one or more for IN/NOT IN, exactly two for BETWEEN/NOT BETWEEN, and exactly one value equal to NULL for IS/IS NOT.",
                "example":"[\"A86F2D0BB610404DB62D37AFA9C20B50\"]"
            }
        }
    },
    "description":"Structured filter predicate used to constrain dataset results by column, operator, and value",
    "example":[
        {
            "columnName":"STUDY_ID",
            "operator":"=",
            "value":[
                "A86F2D0BB610404DB62D37AFA9C20B50"
            ]
        }
    ]
}

Example:

[
    {
        "columnName":"STUDY_ID",
        "operator":"=",
        "value":[
            "A86F2D0BB610404DB62D37AFA9C20B50"
        ]
    }
]

Nested Schema : value

Type: array

Filter values as strings. Value cardinality depends on the operator: one for most operators, one or more for IN/NOT IN, exactly two for BETWEEN/NOT BETWEEN, and exactly one value equal to NULL for IS/IS NOT.

Show Source

• Array of: string
  Filter values as strings. Value cardinality depends on the operator: one for most operators, one or more for IN/NOT IN, exactly two for BETWEEN/NOT BETWEEN, and exactly one value equal to NULL for IS/IS NOT.

  Example: ["A86F2D0BB610404DB62D37AFA9C20B50"]

{
    "type":"array",
    "description":"Filter values as strings. Value cardinality depends on the operator: one for most operators, one or more for IN/NOT IN, exactly two for BETWEEN/NOT BETWEEN, and exactly one value equal to NULL for IS/IS NOT.",
    "example":[
        "A86F2D0BB610404DB62D37AFA9C20B50"
    ],
    "items":{
        "type":"string",
        "description":"Filter values as strings. Value cardinality depends on the operator: one for most operators, one or more for IN/NOT IN, exactly two for BETWEEN/NOT BETWEEN, and exactly one value equal to NULL for IS/IS NOT.",
        "example":"[\"A86F2D0BB610404DB62D37AFA9C20B50\"]"
    }
}

Example:

[
    "A86F2D0BB610404DB62D37AFA9C20B50"
]

Examples

Select an example SubjectItemSvflDataSetQuery

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

Response behavior

• The response is tabular. columns defines the selected output order, and each row in data follows that same order.
• Every value in data is returned as a JSON string or null, including logical numbers and date/time values.
• hasMore = "true" means more matching rows exist after the current page.
• If filters match no rows, or offset is beyond the last row, the API returns HTTP 200 with data = [], count = 0, and hasMore = "false".

Section index

Study context | Site context | Country context | Subject context | Event context | Form context | Item context | Action context | Audit context | Reference and system identifiers

Study context

Study-level identifiers, version metadata, and protocol attributes associated with the dataset row.

Column Name	Data Type	Description
STUDY_TITLE	VARCHAR2(4000 CHAR)	The STUDY_TITLE data element reflects the title of a protocol as defined by the study manager each time a new study version is created and renamed in the Study Mode section. For example, if the original study version is named P01_A23 in Active mode, that name appears as the STUDY_TITLE. If the study manager later creates a new version of the study and renames it to P01_A23_Production2, this new name will be displayed as the STUDY_TITLE for that version when used in Active mode. When you include multiple study versions in your dataset, and each has a different title, the STUDY_TITLE element will reflect the specific title assigned to each version. For example, your dataset might include study versions 1.0.2, 1.0.3, and 1.0.4. If the study manager renamed each version, you would see those unique titles in the dataset: P_01_A23 (for study version 1.0.2) P01_A23_Production2 (for study version 1.0.3) P01_A23_Production3 (for study version 1.0.4)
STUDY_ID_NAME	VARCHAR2(64 CHAR)	A study ID as specified by the study manager when they created the study, such as a protocol acronym and protocol number.
STUDY_REFNAME	VARCHAR2(64 CHAR)	Indicates the study's reference name used by the system. This value is composed by STUDY_ID_NAME converted to uppercase with blank spaces removed. Once created, this value never changes, even if STUDY_ID_NAME is changed.
STUDY_VERSION	VARCHAR2(100 CHAR)	Indicates the study version number of the referencing data in the dataset.
STUDY_PHASE	VARCHAR2(64 CHAR)	A study's phase as indicated by the study manager when they created the study. Possible values include I, I/II, II, II/III, III, IV, or Other.
BLINDING_TYPE	VARCHAR2(64 CHAR)	Indicates whether the study is an open-label type of study or a blinded study, as specified by the study manager when they created the study. Possible values include OpenLabel, Blinded, OpenLabelBlinded, or Observational.
THERAPEUTIC_AREA	VARCHAR2(64 CHAR)	Indicates the therapeutic area as specified by the study manager when they created the study. Possible values include CardiologyVascularDiseases, DentalOralHealth, Dermatology, Endocrinology, FamilyMedicine, Gastroenterology, GeneticDisease, HealthyVolunteers, Hematology, Hepatology, Immunology, InfectionsInfectiousDisease, Musculoskeletal, Nephrology, Neurology, NutritionWeightLoss, ObstetricsGynecology, Oncology, Ophthalmology, Otolaryngology, PediatricsNeonatology, PlasticSurgery, PharmacologyToxicology, Podiatry, PsychiatryPsychology, PulmonaryRespiratoryDiseases, Rheumatology, Sleep, Trauma, Urology, or Vaccines.

Parent topic: Section index

Site context

Site profile, operational settings, and site-maintained contact details associated with the dataset row.

Column Name	Data Type	Description
SITE_NAME	VARCHAR2(500 CHAR)	Indicates the site's name as entered by a site manager when they created or last modified a site.
SITE_ID_NAME	VARCHAR2(50 CHAR)	Indicates the site ID as entered by a site manager when they created or last modified a site.
SITE_STATUS	VARCHAR2(50 CHAR)	Indicates the status of a site whether it is New, Active, or Retired.
SITE_TYPE	VARCHAR2(50 CHAR)	Indicates the type of organization. Possible values include Hospital, Teaching Hospital, Medical Clinic, or Other.
SITE_STUDY_VERSION	VARCHAR2(2048 CHAR)	The study version assigned to the site, as configured by a site manager.
INVESTIGATOR	VARCHAR2(2048 CHAR)	A Principal Investigator's Full Name as listed when the site manager created the site.
PI_PREFIX	VARCHAR2(2048 CHAR)	The principal investigator's prefix at the site. Possible values include 1st Lt, Adm, Atty, Brother, Capt, Chief, Cmdr, Col, Dean, Dr, Elder, Father, Gen, Gov, Hon, Lt Col, Maj, MSgt, Mr, Mrs, Ms, Prince, Prof, Rabbi, Rev, or Sister.
DEA_NUMBER	VARCHAR2(2048 CHAR)	The DEA registration number.
EXPIRATION	VARCHAR2(2048 CHAR)	Indicates the expiration date of the DEA Registration Number as defined by a site manager.
ADD_SUBJECTS	VARCHAR2(2048 CHAR)	Flag that enables or prevents site users from adding subjects at one or multiple sites. Possible values include true or false.
SCREEN_SUBJECTS	VARCHAR2(2048 CHAR)	Flag that enables or prevents site users from screening subjects at one or multiple sites. Possible values include true or false.
RANDOMIZE_SUBJECTS	VARCHAR2(2048 CHAR)	Flag that enables or prevents site users from randomizing subjects at one or multiple sites. Possible values include true or false.
DISPENSE_TO_SUBJECTS	VARCHAR2(2048 CHAR)	Flag that enables or prevents site users from dispensing kits, devices or performing dose changes for subjects at one or multiple sites. Possible values include true or false.
DRUG_DESTRUCTION_CAPABLE	VARCHAR2(2048 CHAR)	Flag that defines if the kit type is destructible at the site. Possible values include true or false.
EHR_ENABLED	CHAR(3)	Indicates if a site is currently enabled for Electronic Health Record (EHR) data import. Possible values include Y or N.
SDV_GROUP_NAME	VARCHAR2(255)	Name of the SDV Strategy, as entered by the study manager.
INITIAL_SUBJECTS_COUNT	VARCHAR2(2048)	Number of initial subjects included in the SDV strategy.
INITIAL_SUBJECTS_SDV_TYPE	VARCHAR2(2048)	Type of Source Data Verification: All Questions or Critical Questions. Possible values include All Questions or Critical Questions Only.
REMAINING_SUBJECTS_PERCENTAGE	VARCHAR2(2048)	Number of remaining subjects included in the SDV strategy.
REMAINING_SUBJECTS_SDV_TYPE	VARCHAR2(2048)	Type of Source Data Verification: All Questions or Critical Questions. Possible values include All Questions or Critical Questions Only.
ADDRESS_STREET_1	VARCHAR2(150 CHAR)	A site's first address as entered by the site manager when they created or last modified the site.
ADDRESS_STREET_2	VARCHAR2(150 CHAR)	A site's second address as entered by the site manager when they created or last modified the site.
ADDRESS_CITY	VARCHAR2(100 CHAR)	A site's city as entered by the site manager when they created or last modified the site.
ADDRESS_STATE_OR_PROV_OR_CNTY	VARCHAR2(100 CHAR)	A site's state, province, or county as entered by the site manager when they created or last modified the site.
ADDRESS_POSTALCODE	VARCHAR2(20 CHAR)	The Zip Postal Code associated with a site's address.
ADDRESS_COUNTRY	VARCHAR2(4000 CHAR)	A site's country as entered by the site manager when they created or last modified the site. The field displays the country ISO code.
PHONE	VARCHAR2(500 CHAR)	The contact phone number as entered by the site manager when they created or last modified the site.
FAX	VARCHAR2(500 CHAR)	The contact fax number as entered by the site administrator when they created or last modified the site.
EMAIL	VARCHAR2(500 CHAR)	Email address of the site as entered by the site administrator when they created or last modified the site.
TIMEZONE	VARCHAR2(2048 CHAR)	Indicates the time zone the site is currently placed on as specified by a site manager.
SHIPPING_ATTENTION	VARCHAR2(2048 CHAR)	Indicates the name of the person who will receive shipments at the site, as specified by a site manager.
SHIPPING_ADDRESS_1	VARCHAR2(150 CHAR)	The first line of a site's shipping address as entered by the site manager when they created or last modified the site.
SHIPPING_ADDRESS_2	VARCHAR2(150 CHAR)	The second line of a site's second shipping address as entered by the site manager when they created or last modified the site.
SHIPPING_CITY	VARCHAR2(100 CHAR)	City associated with the shipping address, as entered by the site manager when they created or last modified the site.
SHIPPING_STATE_OR_PROV_OR_CNTY	VARCHAR2(100 CHAR)	State, province, or county associated with the shipping address, as entered by the site manager when they created or last modified the site.
SHIPPING_ZIP	VARCHAR2(20 CHAR)	Zip Postal Code associated with the shipping address.
SHIPPING_COUNTRY	VARCHAR2(4000 CHAR)	Country associated with the shipping address, as entered by the site manager when they created or last modified the site.
SHIPPING_PHONE	VARCHAR2(500 CHAR)	Phone number associated with the shipping address.
SHIPPING_FAX	VARCHAR2(500 CHAR)	Fax number associated with the shipping address.
SHIPPING_EMAIL	VARCHAR2(500 CHAR)	Email address associated with the shipping address.

Parent topic: Section index

Country context

Country-level fields exposed separately in Oracle Analytics for geographic reporting.

Column Name	Data Type	Description
COUNTRY_NAME	VARCHAR2(4000 CHAR)	Full name of the country associated with the subject, such as United States.

Parent topic: Section index

Subject context

Subject identity, status, enrollment, and transfer attributes associated with the record.

Column Name	Data Type	Description
SUBJECT_NUMBER	VARCHAR2(500 CHAR)	The number currently assigned to the subject in the system as identifier. Note: NULL is displayed if a subject was removed using the Undo Add Subject feature.
SCREENING_NUMBER	VARCHAR2(500 CHAR)	Always displays the original screening number, assigned to the subject at screening.
PREVIOUS_SUBJECT_NUMBER	VARCHAR2(500 CHAR)	When a subject number change is applied, this field holds the number that was assigned to the subject before the change.
SUBJECT_STATE	VARCHAR2(100 CHAR)	A subject's state in Clinical One Cloud Service. Note: When a subject is Screened, the dataset returns Screening_Initiated until the next visit is complete and the subject becomes Active. When a subject is Screen Failed, the dataset returns Auto_Screen_Failed. Possible values include New, Screening_Initiated, Screen_Failed, Auto_Screen_Failed, Enrolled, Active, Subject Visit, Subject_Transferred, Withdrawn, or Complete.

Parent topic: Section index

Event context

Event metadata, visit scheduling, and visit-status attributes associated with the dataset row.

Column Name	Data Type	Description
EVENT_TITLE	VARCHAR2(64 CHAR)	The event's title, defined by the user when an event is created.
EVENT_ID_NAME	VARCHAR2(16 CHAR)	The event's id as in Clinical One Cloud Service.
EVENT_REFNAME	VARCHAR2(64 CHAR)	The event's reference name. Displays a capitalized version of the user-entered EVENT_TITLE with blank spaces removed. The system generates this value, which is not displayed in the Clinical One Cloud Service user interface. Note: This value does not change if the associated EVENT_TITLE is updated in a subsequent Study Version.
EVENT_TYPE	VARCHAR2(100)	Displays the type of event that impacts a visit's status. Upon selecting this data element, only events that occurred in your study are displayed. For example, you may see some of the following events: Visit_Complete Visit_Date_Changed VisitDateCleared VisitDateEntered Visit_Not_Started Visit_Skip_Undone Visit_Skipped Visit_Started Visit_Inserted: this option refers to new visits inserted into the study's schedule as an Advanced Study Versioning change.
VISIT_TYPE	VARCHAR2(100 CHAR)	Displays the type of visit: ADVERSE_EVENT: adverse event visit. DISPENSATION: dispensation visit. NON_DISPENSATION: non-dispensation visit. OPTIONAL: optional visit. OPTIONAL_DISPENSATION: optional dispensation visit. RANDOMIZATION: randomization visit. RESCREENING: rescreening visit. SCREENFAILURE: screen failure visit. SCREENING: screening visit. SUBJECT_COMPLETE: study completion visit. UNSCHEDULED: unscheduled visit. UNSCHEDULED_DISPENSATION: unscheduled dispensation visit. WITHDRAW: withdrawal visit.
VISIT_STATUS	VARCHAR2(32 CHAR)	Indicates a visit's status in the system. Can have one of the following values: NEW: the visit was dynamically triggered and has no data. NOT_STARTED: the visit has not been started. INPROGRESS: the visit was never completed and has one or more required items with no saved data. INCOMPLETE: the visit was completed at some point but now has one or more required items that are not completed. INCOMPLETE_ERR: the visit was completed at some point but now has one or more required items that are not completed and open queries. COMPLETE: all required items within the visit are completed and there are no open queries. COMPLETE_ERR: all required items within the visit are completed but there are open queries. SKIPPED: the visit was part of the visit schedule for the subject but was skipped by a site user. UNDO_SKIP: the visit was skipped at some point but the skip action was undone.
EVENT_INSTANCE_NUM	NUMBER	Indicates the unscheduled visit instance number as designed by the study designer.
VISIT_ORDER	NUMBER	The order in which subject visits occur, as configured in the study design.
IS_REQUIRED	NUMBER	Indicates if the visit is required. Possible values include 0 or 1.
VISIT_IS_REQUIRED	CHAR(1)	Indicates if a visit is required. Possible values include 0 or 1.
IS_SCHEDULED_VISIT	CHAR(1)	Indicates if the visit is scheduled. Possible values include Y or N.
SCHEDULED_FROM_EVENT_NAME	VARCHAR2(64 CHAR)	Displays the EVENT_TITLE (visit title) of the Scheduled From visit as defined in the Visit Schedule. Note: If a visit is not scheduled or it is the first visit in the schedule, then this element is populated with the visit's own title. For example, Screening Visit is displayed for the Screening Visit, if it is the first visit in the schedule.
SCHEDULED_FROM_EVENT_REFNAME	VARCHAR2(64 CHAR)	Displays the EVENT_REFNAME of the Scheduled From Visit as defined in the Visit Schedule. Note: If a visit is not scheduled or it is the first visit in the schedule, then this element is populated with that visit's own refname.
VISIT_START_DATE	DATE	Date stamp of a visit's start date.
PROJECTED_VISIT_START_DATE	TIMESTAMP(6)	Date when the next scheduled visit should start in the study, based on the configured visit schedule.
PROJECTED_VISIT_END_DATE	TIMESTAMP(6)	Date when the next scheduled visit should end in the study, based on the configured visit schedule.
PROJECTED_VISIT_DATE	TIMESTAMP(6)	Date when the next scheduled visit should take place in the study, based on the configured visit schedule.
DELAY_DAYS	NUMBER	The number of days between the prior scheduled visit.
DELAY_HOURS	NUMBER	The number of hours between the prior scheduled visit (in addition to the DELAY_DAYS field).
VISIT_WINDOW_BEFORE_DAYS	NUMBER	Indicates how many days before the scheduled date and time the visit can occur, as entered by a study designer.
VISIT_WINDOW_BEFORE_HOURS	NUMBER	Indicates how many hours before the scheduled date and time the visit can occur, as entered by a study designer.
VISIT_WINDOW_AFTER_DAYS	NUMBER	Indicates how many days after the scheduled date and time the visit can occur.
VISIT_WINDOW_AFTER_HOURS	NUMBER	Indicates how many hours after the scheduled date and time the visit can occur.

Parent topic: Section index

Form context

Form-level design or collected-form attributes associated with the dataset row.

Column Name	Data Type	Description
FORM_NAME	VARCHAR2(64 CHAR)	The name of the form, as specified by the study designer.
FORM_REFNAME	VARCHAR2(64 CHAR)	A form's reference name.
FORM_STATUS	VARCHAR2(25 CHAR)	The status of the given form. Can have one of the following values: COMPLETED: all required items are completed with no open queries. COMPLETED_WITH_ERROR: all required items are complete but the form has validation errors. Validation errors can happen when a Designer rule condition is not met. IN_PROGRESS: the form was never completed and has one or more required items not completed. IN_PROGRESS_WITH_ERROR: the form was never completed and has one or more required items not completed and the form has validation errors. Validation errors can happen when a Designer rule condition is not met. INCOMPLETE: the form was completed at some point but now it has one or more required items not completed. INCOMPLETE_WITH_ERROR: the form was completed at some point but now it has one or more required items not completed and the form has validation errors. Validation errors can happen when a Designer rule condition is not met. SCHEDULED: the form is new and has no data entered for it. DELETED: All questions in a form have been cleared and the form is considered deleted. BLANK: indicates null or not applicable. OPTIONAL: the form does not have any required or completed items. NEW: none of the items of the form have been completed yet. A form can only received this status if it is triggered by a question with a show form rule or if it is added as part of Advanced Study Versioning (ASV).
REPEAT_FORM_NUMBER	NUMBER	Refers to the form instance number of all applicable form types with repeating data: Two section forms, Lab forms, Repeating forms.
REPEAT_SEQUENCE_NUMBER	NUMBER	Refers to the row instance number of all applicable form types with repeating data: Two section forms, Lab forms, Repeating forms.
INNER_REPEAT	NUMBER	Refers to the Section Repeat values of all applicable form types with repeating data: Two section forms, Lab forms, Repeating forms.
OUTER_REPEAT	NUMBER	Refers to the Form Repeat values of all applicable form types with repeating data: Two section forms, Lab forms, Repeating forms.
IS_REPEATING	CHAR(1)	Indicates if it is a repeating form. Possible values include Y or N.
IS_ROLLOVER	CHAR(1)	Indicates whether the form contains a rollover type of question. Possible values include Y or N.

Parent topic: Section index

Item context

Question-level configuration and collected item attributes associated with the dataset row.

Column Name	Data Type	Description
ITEM_NAME	VARCHAR2(4000 CHAR)	Indicates the title of the question, as entered by a study designer.
ITEM_REFNAME	VARCHAR2(64 CHAR)	Indicates the item's reference name defined in Clinical One Cloud Service.
QUESTION_TYPE	VARCHAR2(32 CHAR)	Indicates the type of question as defined by a study designer. For example: Text Number Age Date/time Drop-down Radio buttons Checkboxes Possible values include Text, DateTime, Number, Measurement, Calculation, Choice, label, or FileUpload.
MEASURE_UNIT	VARCHAR2(64 CHAR)	Indicates the measure of unit specified by a study designer for a Number type of question.
SAS_VARIABLE	VARCHAR2(32 CHAR)	Indicates the SAS Variable of a form defined by a study designer.
SAS_LABEL	VARCHAR2(4000 CHAR)	Indicates the SAS Label of a form defined by a study designer.
REFERENCE_CODE	VARCHAR2(64 CHAR)	Indicates a question's reference code.
LAB_NAME	VARCHAR2(500 CHAR)	Indicates the associated lab name when the item is part of a lab form.
LAB_ID	VARCHAR2(50 CHAR)	Indicates the associated lab ID, when the item is part of a lab form.
REQUIRED	NUMBER	Indicates if the question is required. Required questions must be answered in order to save the form that contains it. Possible values include 0 or 1.
READONLY	NUMBER(1)	Indicates that the question is marked as read-only by a study designer. Possible values include 0 or 1.
HIDDEN	NUMBER(1)	Indicates if a question is hidden, as marked by a study designer. Possible values include 0 or 1.
SDV_SELECTION_STATUS	VARCHAR2(32 CHAR)	Indicates if, after all applicable Source Data Verification (SDV) settings combined, the question requires verification or not for the subject. This is determined based on the study SDV settings, the SDV strategy assigned to the site, whether the subject is part of the pool of selected subjects for SDV, and SDV settings defined at the item level in form design. For more information, see Understand Source Data Verification. This data element is populated with four possible values: OBLIGATORY: the question requires verification. This means that either the study has a 100% SDV configuration or it has a Targeted SDV configuration and the question is selected for SDV for that given subject. OPTIONAL: the question may be verified but it is not required for that given subject. This is only applicable for Targeted SDV studies that allow SDV overrides. OPTIONAL_CRITICAL: the question is set as a critical variable but the subject is not part of the SDV subject pool, hence the question may be verified but it is not required for that given subject. This is only applicable for Targeted SDV studies that allow SDV overrides. IRRELEVANT: the question is not configured for SDV for this subject and it is not expected to be verified. This would be the case of: Read-only questions. Studies set up for no SDV. Studies with Targeted SDV configuration that don't allow SDV overrides. Screen failed subjects when excluded from SDV.
HAS_QUERY	CHAR(1)	Indicates if there is a query raised against a question, irrespective of the status. Possible values include Y or N.
VALUE	VARCHAR2(4000 CHAR)	The raw value of the form question value (can be an array in questions with decodes). For more details see Form item output mapping in data extracts.
ITEM_F	VARCHAR2(4000 CHAR)	The formatted value: value as entered in Clinical One Cloud Service converted to the question data type as per form design. Values from text questions are formatted to remove all non-printable characters (such as tabs, carriage returns, newline characters, and leading or trailing white spaces). For more details see Form item output mapping in data extracts.

Parent topic: Section index

Action context

SVFL action transitions and sign-specific attributes associated with the dataset row.

Column Name	Data Type	Description
ACTION_TYPE	VARCHAR2(32 CHAR)	Indicates the action that was updated for the given object. Possible values are SIGN, VERIFY, FREEZE, or LOCK.
ACTION_OBJECT	VARCHAR2(64 CHAR)	Indicates the refname of the Clinical One object where the action was applied.
ACTION_STATUS	VARCHAR2(16 CHAR)	The resulting status after the action update. Possible values depend on the action type and can be: SIGNED UNSIGNED FROZEN UNFROZEN VERIFIED UNVERIFIED LOCKED UNLOCKED Note: There will be no record for the initial state where no action was applied. This is when the status for a given SVFL action to the object is null. For example, when the object is not currently signed and it has never been, so it cannot be unsigned either.
ACTION_DATE	TIMESTAMP(6)	The version start of the audit where the action was applied.
ACTION_USER	VARCHAR2(255 CHAR)	Indicates the user that performed the update to the action. This field displays SYSTEM if it is not a direct action update and is instead the result of an automatic recalculation performed by the system or any other user action that indirectly impacts SVFL status.
SIGN_LEVEL	VARCHAR2(16 CHAR)	Only applicable for sign actions. Indicates the level at which the signature was applied. Possible values include CASEBOOK, FORM, or VISIT.
SIGN_NAME	VARCHAR2(1000)	Only applicable for sign actions. The configured name of the signature.
SIGN_AFFIDAVIT_NAME	VARCHAR2(4000 CHAR)	Only applicable for sign actions. Indicates the name of the affidavit that the signature displays to users for their endorsement.

Parent topic: Section index

Audit context

Audit-trail metadata describing row versioning, acting users, and reason-for-change details.

Column Name	Data Type	Description
VERSION_START	TIMESTAMP(6)	Audit trail timestamp when this version of the dataset row became effective. Together with VERSION_END, it defines the validity window for the row version.
VERSION_END	TIMESTAMP(6)	Indicates the date and time of when data was changed, if the data is not current.
OPERATION_TYPE	VARCHAR2(16 CHAR)	Audit trail field that indicates how the dataset row version was produced. CREATED: the row was initially created. MODIFIED: an existing row was updated. REMOVED: the row was removed from the active record set.
CURRENT_STUDY_ROLE_NAME	VARCHAR2(100 CHAR)	Current study role name of the user who updated the dataset row. If the user's study role changes later, this field shows the user's current study role.
USER_NAME	VARCHAR2(255 CHAR)	Audit trail field that represents the user who performed the action. The value for this column may represent a user's actual username or a user's email address, depending on how the user login was defined in Oracle Life Sciences IAMS.
EHR_IMPORTED	CHAR(1)	Indicates if a question was populated via an Electronic Health Record (EHR) data import. If EHR data import is disabled after the data is imported, EHR_IMPORTED continues to show Yes. Possible values include Y or N.
OBJECT_VERSION_NUMBER	NUMBER	Audit trail field that represents the version number of the data.
REASON	VARCHAR2(255 CHAR)	Audit trail reason recorded for the dataset row change. Populated when a reason for change is provided for the row update.
COMMENT	VARCHAR2(2048 CHAR)	When present, provides the comment entered for the change reason or generated by rule execution.
IS_CURRENT	CHAR(1 CHAR)	Audit trail flag that indicates whether the dataset row version is the current version (Y) or a historical version (N).

Parent topic: Section index

Reference and system identifiers

System identifiers, numeric reference keys, and technical linkage fields carried with the dataset row.

Column Name	Data Type	Description
STUDY_ID	RAW(16 BYTE)	GUID of the study.
STUDY_WID	NUMBER	A number that represents the unique identifier of the study.
EVENT_ID	RAW(16 BYTE)	GUID of the event.
EVENT_WID	NUMBER	A number that represents the unique identifier of the event.
FORM_ID	RAW(16 BYTE)	GUID of the form.
FORM_WID	NUMBER	A number that represents the unique identifier of the form.
ITEM_ID	RAW(16 BYTE)	GUID of the item.
ITEM_WID	NUMBER	A number that represents the unique identifier of the item.
SCHEDULED_FROM_EVENT_ID	RAW(16 BYTE)	GUID of the event from which this visit was scheduled.
SCHEDULED_FROM_EVENT_WID	NUMBER(10)	A number that represents the unique identifier of the parent visit from which the associated visit was scheduled.
SITE_ID	RAW(16 BYTE)	GUID of the site.
SITE_WID	NUMBER	A number that represents the unique identifier of a site.
SUBJECT_EVENT_INST_ID	RAW(16 BYTE)	GUID of the subject event instance described by SUBJECT_EVENT_INST_WID.
SUBJECT_EVENT_INST_WID	NUMBER(10)	A number that represents the unique identifier of the subject event instance.
SUBJECT_EVENTINST_FORM_ID	RAW(16 BYTE)	GUID of the subject form record tied to this event instance.
SUBJECT_EVENTINST_FORM_WID	NUMBER(10)	A number that represents the unique identifier of the subject form record.
SUBJECT_EVENTINST_FORMITEM_ID	RAW(16 BYTE)	GUID of the subject form item record tied to this event instance and form.
SUBJECT_EVENTINST_FORMITEM_WID	NUMBER(10)	A number that represents the unique identifier of the subject form item record.
SUBJECT_ID	RAW(16 BYTE)	GUID of the subject.
SUBJECT_WID	NUMBER	A number that represents the unique identifier of the subject.
USER_ID	RAW(16 BYTE)	GUID of the user.
USER_WID	NUMBER	Indicates a user's numeric identifier.
CURRENT_STUDY_ROLE_ID	RAW(16 BYTE)	The ID associated with the study role assigned to the user who updated the given record. If the user study role changes, this field will show the current study role ID of the given user.
CURRENT_STUDY_ROLE_WID	NUMBER(10)	Numeric identifier of the role of the user who updated the given record. If the user study role changes, this field will show the current study role of the given user.
ID	RAW(16 BYTE)	GUID of the subject form item record that anchors each SVFL row.
INTEGRATION_ID	VARCHAR2(1000 CHAR)	Identifier of the integration that produced the dataset row, when applicable.
DH_TIMESTAMP	TIMESTAMP(6)	A timestamp that indicates when the data became available in the dataset.
SOFTWARE_VERSION_NUMBER	NUMBER	A number that increases incrementally every time a data point is modified.

Parent topic: Section index

Body ()

Root Schema : DataHubReportDto

Type: object

Tabular dataset response for a dynamic Data Hub query.

columns defines the selected output order, and each row in data aligns positionally to that list.

Show Source

• columns: array columns

  Ordered dataset column names selected by the client.

  Each row in data uses this exact order.

• count: integer (int32)

  Number of rows returned in the current page.

  Example: 2
• data: array data

  Row data aligned positionally with columns.

  Each cell is serialized as a JSON string or null, even for logical numbers and timestamps.

• hasMore: string

  String pagination flag ("true" or "false") indicating whether more matching rows exist after the current page.

  Returned as a string for backward compatibility.

  Example: false
• limit: integer (int32)

  Requested page size.

  Dataset endpoints commonly use 0 to mean unpaginated or all rows.

  Example: 100
• offset: integer (int32)

  Zero-based row offset applied to the result set.

  Dataset endpoints that disable pagination with limit = 0 typically echo offset = 0 in the response.

  Example: 0
• totalResults: integer (int32)

  Total number of matching rows across all pages after filters are applied.

  This can be non-zero even when the current page is empty because the requested offset is beyond the last row.

  Example: 2

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"string",
            "description":"<p>String pagination flag (<code>\"true\"</code> or <code>\"false\"</code>) indicating whether more matching rows exist after the current page.</p><p>Returned as a string for backward compatibility.</p>",
            "example":"false"
        },
        "totalResults":{
            "type":"integer",
            "description":"<p>Total number of matching rows across all pages after filters are applied.</p><p>This can be non-zero even when the current page is empty because the requested offset is beyond the last row.</p>",
            "format":"int32",
            "example":2
        },
        "count":{
            "type":"integer",
            "description":"<p>Number of rows returned in the current page.</p>",
            "format":"int32",
            "example":2
        },
        "limit":{
            "type":"integer",
            "description":"<p>Requested page size.</p><p>Dataset endpoints commonly use <code>0</code> to mean unpaginated or all rows.</p>",
            "format":"int32",
            "example":100
        },
        "offset":{
            "type":"integer",
            "description":"<p>Zero-based row offset applied to the result set.</p><p>Dataset endpoints that disable pagination with <code>limit = 0</code> typically echo <code>offset = 0</code> in the response.</p>",
            "format":"int32",
            "example":0
        },
        "columns":{
            "type":"array",
            "description":"<p>Ordered dataset column names selected by the client.</p><p>Each row in <code>data</code> uses this exact order.</p>",
            "example":[
                "STUDY_ID",
                "RECORD_ID",
                "STATUS"
            ],
            "items":{
                "type":"string",
                "description":"<p>Ordered dataset column names selected by the client.</p><p>Each row in <code>data</code> uses this exact order.</p>",
                "example":"[\"STUDY_ID\",\"RECORD_ID\",\"STATUS\"]"
            }
        },
        "data":{
            "type":"array",
            "description":"<p>Row data aligned positionally with <code>columns</code>.</p><p>Each cell is serialized as a JSON string or <code>null</code>, even for logical numbers and timestamps.</p>",
            "example":[
                [
                    "A86F2D0BB610404DB62D37AFA9C20B50",
                    "REC001",
                    "Active"
                ],
                [
                    "A86F2D0BB610404DB62D37AFA9C20B50",
                    "REC002",
                    "Inactive"
                ]
            ],
            "items":{
                "type":"array",
                "description":"<p>Row data aligned positionally with <code>columns</code>.</p><p>Each cell is serialized as a JSON string or <code>null</code>, even for logical numbers and timestamps.</p>",
                "example":[
                    [
                        "A86F2D0BB610404DB62D37AFA9C20B50",
                        "REC001",
                        "Active"
                    ],
                    [
                        "A86F2D0BB610404DB62D37AFA9C20B50",
                        "REC002",
                        "Inactive"
                    ]
                ],
                "items":{
                    "type":"string",
                    "description":"<p>Row data aligned positionally with <code>columns</code>.</p><p>Each cell is serialized as a JSON string or <code>null</code>, even for logical numbers and timestamps.</p>",
                    "example":"[[\"A86F2D0BB610404DB62D37AFA9C20B50\",\"REC001\",\"Active\"],[\"A86F2D0BB610404DB62D37AFA9C20B50\",\"REC002\",\"Inactive\"]]"
                }
            }
        }
    },
    "description":"<p>Tabular dataset response for a dynamic Data Hub query.</p><p><code>columns</code> defines the selected output order, and each row in <code>data</code> aligns positionally to that list.</p>"
}

Nested Schema : columns

Type: array

Ordered dataset column names selected by the client.

Each row in data uses this exact order.

Show Source

• Array of: string

  Ordered dataset column names selected by the client.

  Each row in data uses this exact order.

  Example: ["STUDY_ID","RECORD_ID","STATUS"]

{
    "type":"array",
    "description":"<p>Ordered dataset column names selected by the client.</p><p>Each row in <code>data</code> uses this exact order.</p>",
    "example":[
        "STUDY_ID",
        "RECORD_ID",
        "STATUS"
    ],
    "items":{
        "type":"string",
        "description":"<p>Ordered dataset column names selected by the client.</p><p>Each row in <code>data</code> uses this exact order.</p>",
        "example":"[\"STUDY_ID\",\"RECORD_ID\",\"STATUS\"]"
    }
}

Example:

[
    "STUDY_ID",
    "RECORD_ID",
    "STATUS"
]

Nested Schema : data

Type: array

Row data aligned positionally with columns.

Each cell is serialized as a JSON string or null, even for logical numbers and timestamps.

Show Source

• Array of: array items

  Row data aligned positionally with columns.

  Each cell is serialized as a JSON string or null, even for logical numbers and timestamps.

{
    "type":"array",
    "description":"<p>Row data aligned positionally with <code>columns</code>.</p><p>Each cell is serialized as a JSON string or <code>null</code>, even for logical numbers and timestamps.</p>",
    "example":[
        [
            "A86F2D0BB610404DB62D37AFA9C20B50",
            "REC001",
            "Active"
        ],
        [
            "A86F2D0BB610404DB62D37AFA9C20B50",
            "REC002",
            "Inactive"
        ]
    ],
    "items":{
        "type":"array",
        "description":"<p>Row data aligned positionally with <code>columns</code>.</p><p>Each cell is serialized as a JSON string or <code>null</code>, even for logical numbers and timestamps.</p>",
        "example":[
            [
                "A86F2D0BB610404DB62D37AFA9C20B50",
                "REC001",
                "Active"
            ],
            [
                "A86F2D0BB610404DB62D37AFA9C20B50",
                "REC002",
                "Inactive"
            ]
        ],
        "items":{
            "type":"string",
            "description":"<p>Row data aligned positionally with <code>columns</code>.</p><p>Each cell is serialized as a JSON string or <code>null</code>, even for logical numbers and timestamps.</p>",
            "example":"[[\"A86F2D0BB610404DB62D37AFA9C20B50\",\"REC001\",\"Active\"],[\"A86F2D0BB610404DB62D37AFA9C20B50\",\"REC002\",\"Inactive\"]]"
        }
    }
}

Example:

[
    [
        "A86F2D0BB610404DB62D37AFA9C20B50",
        "REC001",
        "Active"
    ],
    [
        "A86F2D0BB610404DB62D37AFA9C20B50",
        "REC002",
        "Inactive"
    ]
]

Nested Schema : items

Type: array

Row data aligned positionally with columns.

Each cell is serialized as a JSON string or null, even for logical numbers and timestamps.

Show Source

• Array of: string

  Row data aligned positionally with columns.

  Each cell is serialized as a JSON string or null, even for logical numbers and timestamps.

  Example: [["A86F2D0BB610404DB62D37AFA9C20B50","REC001","Active"],["A86F2D0BB610404DB62D37AFA9C20B50","REC002","Inactive"]]

{
    "type":"array",
    "description":"<p>Row data aligned positionally with <code>columns</code>.</p><p>Each cell is serialized as a JSON string or <code>null</code>, even for logical numbers and timestamps.</p>",
    "example":[
        [
            "A86F2D0BB610404DB62D37AFA9C20B50",
            "REC001",
            "Active"
        ],
        [
            "A86F2D0BB610404DB62D37AFA9C20B50",
            "REC002",
            "Inactive"
        ]
    ],
    "items":{
        "type":"string",
        "description":"<p>Row data aligned positionally with <code>columns</code>.</p><p>Each cell is serialized as a JSON string or <code>null</code>, even for logical numbers and timestamps.</p>",
        "example":"[[\"A86F2D0BB610404DB62D37AFA9C20B50\",\"REC001\",\"Active\"],[\"A86F2D0BB610404DB62D37AFA9C20B50\",\"REC002\",\"Inactive\"]]"
    }
}

Example:

[
    [
        "A86F2D0BB610404DB62D37AFA9C20B50",
        "REC001",
        "Active"
    ],
    [
        "A86F2D0BB610404DB62D37AFA9C20B50",
        "REC002",
        "Inactive"
    ]
]

Examples

Select an example SubjectItemSvflDataSetReport SubjectItemSvflDataSetEmptyReport

400 Response

Returned when the request is invalid.

• Causes include invalid tenantId or studyId, negative limit or offset, empty selectColumns, invalid dataset columns, invalid whereColumns operator/value combinations, duplicate orderColumns, invalid sortOrder, and malformed typed filter values.
• Error payload format: {"status":"failed","result":null,"errorData":{"errorCode":"...","errorMessage":"...","details":{...}},"version":1}.

Body ()

Root Schema : DataHubResponse

Type: object

Standard Data Hub response envelope.

Successful responses return status as "success" and populate result. Failed responses return status as "failed" and populate errorData.

Show Source

• errorData: object errorData

  Machine-readable error payload when status is "failed".

  This field is null when status is "success".

• result: object result

  Payload returned by the API when status is "success".

  This field is null when status is "failed".

• status: string

  Overall request processing status.

  Allowed values are "success" and "failed".

  Example: success
• version: integer (int32)
  Envelope version number.

  Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"<p>Overall request processing status.</p><p>Allowed values are \"success\" and \"failed\".</p>",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"<p>Payload returned by the API when <code>status</code> is \"success\".</p><p>This field is null when <code>status</code> is \"failed\".</p>",
            "example":{
                "message":"Operation succeeded"
            }
        },
        "errorData":{
            "type":"object",
            "description":"<p>Machine-readable error payload when <code>status</code> is \"failed\".</p><p>This field is null when <code>status</code> is \"success\".</p>",
            "example":{
                "errorCode":"VALIDATION_ERROR",
                "errorMessage":"Invalid column name specified in the select columns: SITE_ID1",
                "details":{
                    "field":"selectColumns"
                }
            }
        },
        "version":{
            "type":"integer",
            "description":"Envelope version number.",
            "format":"int32",
            "example":1
        }
    },
    "description":"<p>Standard Data Hub response envelope.</p><p>Successful responses return <code>status</code> as \"success\" and populate <code>result</code>. Failed responses return <code>status</code> as \"failed\" and populate <code>errorData</code>.</p>"
}

Nested Schema : errorData

Type: object

Machine-readable error payload when status is "failed".

This field is null when status is "success".

Example:

{
    "errorCode":"VALIDATION_ERROR",
    "errorMessage":"Invalid column name specified in the select columns: SITE_ID1",
    "details":{
        "field":"selectColumns"
    }
}

Nested Schema : result

Type: object

Payload returned by the API when status is "success".

This field is null when status is "failed".

Example:

{
    "message":"Operation succeeded"
}

Examples

Select an example InvalidSelectColumn NegativePagination InvalidWhereOperator InvalidIsOperatorValue

401 Response

Returned when the request cannot be authenticated.

The response body is empty.

403 Response

Returned when the request is authenticated but the caller is not authorized to access the requested resource.

The response body contains a plain-text authorization message.

Possible response bodies:

• Either the resource does not exist, or the user cannot access the resource.
• The entity is in maintenance mode, or the user cannot access the resource.

Body ()

Root Schema : schema

Type: string

500 Response

Returned when an unexpected server-side error occurs while processing the request.

The response body contains the platform error payload with the error code and description.

Body ()

Root Schema : Status

Type: object

Show Source

• code: string
• description: string

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Examples

Select an example InternalServerError

Back to Top