Jump to

• Request
• Response

[Deprecated]: V1.0

post

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

Deprecated: Use latest version instead.

Retrieves the study-permissioned Blinded Kits dataset for a single study and mode.

The dataset exposes blinded kit inventory and dispensation history, including study, site, subject, randomization, shipment, lot, kit status, verification/confirmation metadata, and audit columns, without exposing unblinded treatment-arm details.

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

The dataset returns rows at inventory level for blinded kits associated with the study and mode.

Required permission: BlindedKitsDatasetPost.

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 and INVENTORY_ID 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.
• 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.

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 BlindedKitsDataSetQuery

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 | Randomization context | Lot context | Shipment context | Kit 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(32 CHAR)	Indicates the study version associated with the dataset row.
STUDY_MODE	VARCHAR2(64 CHAR)	Indicates the study mode used in the referencing data in a custom report, such as Test, Training, or Active. Possible values include test, active, or training.
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_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)	Indicates the principal investigator's prefix. 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)	Indicates the Drug Enforcement Administration number associated with the site.
EXPIRATION	VARCHAR2(2048 CHAR)	Indicates the expiration date of the Drug Enforcement Administration number.
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.
SDV_GROUP_NAME	VARCHAR2(255)	Indicates the site's source data verification strategy.
INITIAL_SUBJECTS_COUNT	VARCHAR2(2048)	Indicates the number of initial subjects to be eligible for source data verification, as specified by a study manager.
INITIAL_SUBJECTS_SDV_TYPE	VARCHAR2(2048)	Indicates if all questions or only critical questions are eligible for source data verification for the initial subjects, as specified by a study manager. Possible values include All Questions or Critical Questions Only.
REMAINING_SUBJECTS_PERCENTAGE	VARCHAR2(2048)	Indicates the percentage of remaining subjects to be eligible for source data verification, as specified by a study manager.
REMAINING_SUBJECTS_SDV_TYPE	VARCHAR2(2048)	Indicates if all questions or only critical questions are eligible for source data verification for the remaining subjects, as specified by a study manager. 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 or 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. This value reflects the country's ISO code.
PHONE	VARCHAR2(500 CHAR)	The site's phone number, as entered by the site administrator when they created or last modified the site.
FAX	VARCHAR2(500 CHAR)	The site's fax number, as entered by the site administrator when they created or last modified the site.
EMAIL	VARCHAR2(500 CHAR)	The site's email address, 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)	A site's country, as entered by the site administrator when they created or last modified the site. This value reflects the country's ISO code.
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 code attributes associated with the site geography for the dataset row.

Column Name	Data Type	Description
COUNTRY_NAME	VARCHAR2(4000 CHAR)	Indicates a country's two-digit ISO code.

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.
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, scheduling rules, 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. Oracle Clinical One Analytics 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)	Indicates the event type as specified by the study designer when they created the event. Possible values include ScreeningVisit, ScheduleAbleVisit, SubjectWithdrawalVisit, SubjectCompletionVisit, UnScheduleAbleVisit, Event, AdverseEvent, ScreenFailureVisit, or ReScreeningEvent.
VISIT_STATUS	VARCHAR2(32 CHAR)	Indicates a visit's status in the system. Can have one of the following values: 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. 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. INPROGRESS: the visit was never completed and has one or more required items with no saved data. NEW: the visit was either dynamically triggered or added as part of Advanced Study Versioning (ASV) and has no data. NOT_STARTED: the visit has not been started. 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.
VISIT_ORDER	NUMBER	The order in which subject visits occur, as configured in the study design.
VISIT_IS_REQUIRED	CHAR(1)	Indicates if a visit is required. Possible values include Y or N.
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, as it is the first visit in the schedule.
SCHEDULED_FROM_EVENT_REFNAME	VARCHAR2(64 CHAR)	Indicates the system reference name of the parent visit from which the associated visit was scheduled.
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

Randomization context

Randomization design settings and subject randomization outcome fields associated with the record.

Column Name	Data Type	Description
RAND_NUMBER	NUMBER	Indicates the randomization number assigned to each randomized subject in a study. Note: If the Blind Randomization Number option in your study's settings is set to Yes, data for this field displays as Blinded.
RND_STATUS	VARCHAR2(64 CHAR)	Indicates the randomization status for the subject's randomization number. Can have one of the following values: Assigned: the subject has a randomization number assigned. Randomized in error: the subject was randomized in error.
RANDOMIZATION_DATE	TIMESTAMP(6)	Indicates the date on which a subject has been randomized in the study.
RERANDOMIZATION	NUMBER	Indicates whether the study designer chose to use the current randomization design for a second or later randomization event in the study. Values can be 1 or 0.

Parent topic: Section index

Lot context

Lot identifiers, expiration controls, and supply-state attributes associated with the row.

Column Name	Data Type	Description
BLINDED_LOT_TITLE	VARCHAR2(64 CHAR)	Indicates the unique name of a blinded lot, as specified by a clinical supply manager when they created the blinded lot.
BLINDED_LOT_SHORT_NAME	VARCHAR2(64 CHAR)	Indicates an alternative blinded lot label, as specified by the clinical supply manager when they created the blinded lot. A blinded lot short name can be used when multiple depots use the same lot and have different naming conventions. One depot can use the title of a blinded lot, whereas another depot can use the short name.
BLINDED_LOT_EXPIRATION_DATE	DATE	Indicates the expiration date for the entire blinded lot, as specified by the clinical supply manager when they created the blinded lot.
BLINDED_LOT_DO_NOT_COUNT_DAYS	NUMBER	Indicates the number of days before the expiration date when the kit is no longer counted in a site's inventory, as specified by the clinical supply manager when they created the blinded lot.
BLINDED_LOT_DO_NOT_SHIP_DAYS	NUMBER	Indicates the number of days before the expiration date when a kit can no longer be shipped from a depot to a site, as specified by the clinical supply manager when they created the blinded lot.

Parent topic: Section index

Shipment context

Shipment lifecycle, receipt, and tracking details associated with kit distribution.

Column Name	Data Type	Description
SHIPMENT_NAME	VARCHAR2(64 CHAR)	Indicates a shipment's full name.
SHIPMENT_STATUS	VARCHAR2(64 CHAR)	Indicates the status of a shipment, as updated by the system or by a user in the study. Can have one of the following values: PENDING IN TRANSIT RECEIVED CANCELLED LOST CONFIRMED INVALID PENDING DESTRUCTION RECEIVED FOR DESTRUCTION DESTROYED QUARANTINED
TRACKING_NUMBER	VARCHAR2(64 CHAR)	Indicates a shipment's tracking number, as specified by the depot user.
SHIPMENT_CREATED_DATE	TIMESTAMP(6)	Indicates the date a shipment was created, whether it is a manual shipment or an automatic shipment.
SHIPMENT_DATE	TIMESTAMP(6)	Indicates a shipment's ship date, either automatically specified by an integration with the clinical depot facility or manually specified by someone from either the sponsor or depot.
SHIPMENT_RECEIPT_DATE	TIMESTAMP(6)	Indicates the date on which the shipment was received.
SHIPMENT_RECEIVED_BY	VARCHAR2(255 CHAR)	Indicates the user who received the given shipment.

Parent topic: Section index

Kit context

Required kit inventory, dispensing, dosing, and verification fields associated with the record.

Column Name	Data Type	Description
KIT_NUMBER	VARCHAR2(1024 CHAR)	Indicates a kit's number, as assigned in the system.
BAR_CODE	VARCHAR2(1000 CHAR)	If included in a study, this indicates a kit's bar code as generated by the system.
KIT_TYPE	VARCHAR2(255 CHAR)	A kit's type, as specified by the study designer when they created the kit. The following values can be displayed: Investigation Product Device Kit Type Titration
KIT_STATUS	VARCHAR2(64 CHAR)	Indicates a kit's status in the study's inventory.
INSTANCE_NUMBER	NUMBER	Indicates the repeat instance number of the visit.
DOSAGE	NUMBER	Indicates the dosage for the dispensed kit, when the kit contains calculated doses.
FREQUENCY	VARCHAR2(64 CHAR)	Indicates the dosing frequency as defined by a study designer.
MEASUREMENT	VARCHAR2(1000 CHAR)	Indicates the total numeric value for the product in a kit with calculated doses, as defined by a study designer.
TRIAL_SUPPLY_TYPE	VARCHAR2(16 CHAR)	Indicates the supply type of the kit, as specified by the study designer. Possible values include BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX, or OTHER.
MINIMUM_KITS_TO_SHIP	NUMBER	Indicates the minimum number of kits to include in each shipment to meet packaging requirements, as specified by the study designer when they created the kit type.
QUANTITY	NUMBER	Indicates a kit's quantity, as specified by the study designer.
UNITS_PER_KIT	NUMBER	Indicates the number of units in the kit, such as the number of pills in a bottle, as specified by the study designer.
BALANCE_UNITS	NUMBER	Indicates the total units of a kit minus the missing and returned units.
RETURNED_UNITS	NUMBER	Number of units remaining in the kit as indicated by the site user or Clinical Research Associate (CRA).
MISSING_UNITS	NUMBER	Number of lost or damaged units in the kit as indicated by the site user.
CONSERVED	VARCHAR2(16 CHAR)	Indicates whether a kit was conserved by a site user. Possible values include Y or N.
DEVICE_TYPE	VARCHAR2(255)	Indicates the type of device, as specified by the study designer when they created the device kit type. Possible values include ActivityWatch, BloodPressureMonitor, GlucoseMonitor, WeightScale, ECGReader, Spirometer, MobileApp, SmartPillBottle, PulseOximeter, WearablePatch, or Other.
DEVICE_CONNECTION	VARCHAR2(255)	Indicates the type of device connection, as specified by the study designer when they created the device kit type. The following values can be displayed: No Connection Device to Cloud Cloud to Cloud
CRA_VERIFIED	NUMBER	Indicates whether the inventory record was verified by a Clinical Research Associate (CRA). Possible values include 0 or 1.
DISPENSATION_DATE	TIMESTAMP(6)	Indicates a kit's dispensation date, as entered by a site user when they dispensed the kit to a subject.
DISPENSATION_CONFIRMED	NUMBER	Indicates whether a kit's dispensation was confirmed by a site user. Possible values include 0 or 1.
CONFIRMED_DATE	TIMESTAMP(6)	Indicates the date at which a specified kit's dispensation was confirmed.
CONFIRMED_BY	VARCHAR2(255 CHAR)	Indicates the user who confirmed the dispensation of the specified kit.
VERIFIED_DATE	TIMESTAMP(6)	Indicates the date when inventory was verified. Date is displayed in UTC.
VERIFIED_BY	VARCHAR2(255 CHAR)	Indicates the user who verified inventory data.

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.
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)	Required comment in a reason for change if 'Other' is selected.
IS_CURRENT	CHAR(1)	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(10)	A number that represents the unique identifier of the study.
EVENT_ID	RAW(16 BYTE)	Indicates the unique identifier of the event.
EVENT_WID	NUMBER(10)	A number that represents the unique identifier of the event.
SHIPMENT_RECEIVED_BY_ID	RAW(16 BYTE)	Indicates the user identifier of the user who confirmed receipt of the shipment order.
SHIPMENT_RECEIVED_BY_WID	NUMBER(10)	Indicates the numeric identifier of a user who confirmed receipt of the shipment order.
INVENTORY_ID	RAW(16 BYTE)	Indicates the unique identifier of the study's inventory.
INVENTORY_WID	NUMBER(10)	Indicates the numeric identifier of the study's inventory.
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.
SITE_WID	NUMBER(10)	A number that represents the unique identifier of a site.
SUBJECT_WID	NUMBER(10)	A number that represents the unique identifier of the subject.
SHIPMENT_WID	NUMBER(10)	A number that represents the unique identifier of a shipment.
USER_WID	NUMBER(10)	Indicates a user's numeric identifier.
VERIFIED_BY_WID	NUMBER(10)	Indicates the numeric identifier of the user who verified inventory data.
CONFIRMED_BY_WID	NUMBER(10)	Indicates the numeric identifier of a user who confirmed the dispensation of a kit during a visit.
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 BlindedKitsDataSetReport BlindedKitsDataSetEmptyReport

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