1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Data Hub
  4. Datasets
  5. Get study site dataset

V1.0

post

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

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

The dataset exposes audited study-site property history through PROPERTY_NAME and PROPERTY_VALUE, together with the latest available study, organization, address, country, investigator, SDV, supply, audit and reference attributes for the site. Supported audited properties are StudyVersion, DrugDestruction, AddSubjectToSiteToggle, ScreenSubjectsAtSiteToggle, RandomizeSubjectsAtSiteToggle, DispensetoSubjectsAtSiteToggle, SiteScreeningLimit, SiteRandomizationLimit, and SiteStatus.

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

The dataset returns rows only for sites associated to the study and having an assigned Study Version at least once.

Required permission: SiteDatasetPost.

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, SITE_ID, PROPERTY_NAME, and VERSION_START in the orderColumns field of the request payload.

Request

Path Parameters

  • Execution mode for the study.

    Allowed values: test, active, training.

    Example: test.

  • Unique study identifier supplied in the studyId path parameter.

    Use the uppercase hexadecimal UUID value for the study.

    Example: 0C7CBA3F70034C47947E2FAB086BFBF5.

  • Unique tenant identifier supplied in the tenantId path parameter.

    Use the uppercase hexadecimal UUID value for the tenant.

    Example: EC942244BB30163BE053BEC44C64CF34.

Query Parameters
  • 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
  • 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
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

    Optional sort instructions to apply to the result set.

    Duplicate order-by columns are rejected.

  • 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

    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.

Nested Schema : orderColumns
Type: array

Optional sort instructions to apply to the result set.

Duplicate order-by columns are rejected.

Show Source
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

  • 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"]
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
Example:
[
    {
        "columnName":"STUDY_ID",
        "operator":"=",
        "value":[
            "A86F2D0BB610404DB62D37AFA9C20B50"
        ]
    }
]
Nested Schema : QueryOrder
Type: object

Sort instruction specifying a dataset column and optional order direction.

Show Source

  • Required dataset column name to sort by.

    Column-name validation is case-insensitive.

    Example: VERSION_START
  • 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
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
  • Required dataset column name to filter on. Column-name validation is case-insensitive.
    Example: STUDY_ID
  • 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
    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:
[
    {
        "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
  • 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

Back to Top

Response

Supported Media Types

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.
  • No single response column uniquely identifies a history row. Use (STUDY_ID, SITE_ID, PROPERTY_NAME, VERSION_START) as the stable row-version key.
  • 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 operations context | Organization context | Primary address and contact context | Investigator context | Audit context | Reference and system identifiers

Study context

Latest study-level identifiers and descriptive protocol attributes applied to every returned audit row.

Column Name Data Type Description
STUDY_TITLEVARCHAR2(64 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_NAMEVARCHAR2(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_REFNAMEVARCHAR2(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_PHASEVARCHAR2(64 CHAR)Indicates the study phase. Possible values include I, I/II, II, II/III, III, IV, or Other.
BLINDING_TYPEVARCHAR2(64 CHAR)Indicates the study blinding type. Possible values include OpenLabel, Blinded, OpenLabelBlinded, or Observational.
STUDY_THERAPEUTIC_AREAVARCHAR2(64 CHAR)Indicates the study therapeutic area. 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 operations context

Audited study-site property history, current site activity markers, SDV settings, and supply controls associated with the site.

Column Name Data Type Description
SITE_ID_NAMEVARCHAR2(50 CHAR)Indicates the site ID as entered by a site manager when they created or last modified a site.
PROPERTY_NAMEVARCHAR2(100 CHAR)Canonical identifier of the audited study-site property. Possible values are StudyVersion, DrugDestruction, AddSubjectToSiteToggle, ScreenSubjectsAtSiteToggle, RandomizeSubjectsAtSiteToggle, DispensetoSubjectsAtSiteToggle, SiteScreeningLimit, SiteRandomizationLimit, or SiteStatus.
PROPERTY_VALUEVARCHAR2(2048 CHAR)Value captured for the audited property in the current audit row. Possible values include 10.0.0.14, Active, or true....
SITE_IS_ACTIVECHAR(1)Current active indicator derived from the latest site status. Y means the latest site status is Active. Possible values include Y or N.
SITE_ACTIVE_MIN_DATETIMESTAMP(6)Earliest date on which the site became active.
SITE_ACTIVE_MAX_DATETIMESTAMP(6)Latest date on which the site became active.
SITE_INACTIVE_MIN_DATETIMESTAMP(6)Earliest date on which the site became inactive.
SITE_INACTIVE_MAX_DATETIMESTAMP(6)Latest date on which the site became inactive.
SDV_STRATEGY_NAMEVARCHAR2(255)Name of the SDV Strategy, as entered by the study manager.
INIT_SUBJ_COUNTVARCHAR2(2048)Number of initial subjects included in the SDV strategy.
INIT_SDV_TYPEVARCHAR2(2048)Type of Source Data Verification: All Questions or Critical Questions. Possible values include All Questions or Critical Questions Only.
REMAIN_SUBJ_PERCVARCHAR2(2048)Percentage of remaining subjects included in the SDV strategy.
REMAIN_SDV_TYPEVARCHAR2(2048)Type of Source Data Verification: All Questions or Critical Questions. Possible values include All Questions or Critical Questions Only.
SUPPLY_STRATEGY_NAMEVARCHAR2(64 CHAR)Name of the strategy that was applied to the site.
RESUPPLY_TYPEVARCHAR2(64 CHAR)Indicates the type of resupply strategy. Possible values include MinMax or Predictive.

Parent topic: Section index


Organization context

Organization profile, lifecycle, and legal attributes associated with the site.

Column Name Data Type Description
ORG_NAMEVARCHAR2(500 CHAR)Organization name associated with the site profile.
ORG_ID_NAMEVARCHAR2(50 CHAR)Identifier name of the organization associated with the site.
ORG_STATUSVARCHAR2(32767 CHAR)Indicates the status of the organization associated with the site. Possible values include New, Active, or Retired.
ORG_CATEGORYVARCHAR2(32767 CHAR)Indicates the type of organization. Possible values include Hospital, Teaching Hospital, Medical Clinic, or Other.
ORG_TIMEZONEVARCHAR2(2048 CHAR)Indicates the time zone the site is currently placed on as specified by a site manager.
WEBSITEVARCHAR2(255 CHAR)Web URL associated with the institution.
ORG_INT_IDENTIFIERVARCHAR2(500 CHAR)Integration ID associated with the institution, when available.
ORG_TAX_IDENTIFIERVARCHAR2(50 CHAR)Tax Identification Number (TIN) associated with the institution.
VAT_NUMBERVARCHAR2(50 CHAR)Value Added Tax (VAT) identification number associated with the institution.
HAS_MSAVARCHAR2(5 CHAR)Indicates whether the institution has a Master Service Agreement with established terms and conditions. Possible values include Y or N.
MSA_START_DATETIMESTAMP(6)Start date on which the Master Service Agreement becomes effective.
MSA_END_DATETIMESTAMP(6)End date through which the Master Service Agreement remains effective.

Parent topic: Section index


Primary address and contact context

Primary address, contact, and location fields associated with the site or organization.

Column Name Data Type Description
IS_MAIN_PRIMARYCHAR(1)Indicates whether the address is configured as the site's main primary address.
ADDRESS_TYPECHAR(7)Indicates the address purpose configured for the site. In Data Hub, this dataset currently exposes only the Primary address.
ADDRESS_1VARCHAR2(150 CHAR)A site's first address as entered by the site manager when they created or last modified the site.
ADDRESS_2VARCHAR2(150 CHAR)A site's second address as entered by the site manager when they created or last modified the site.
CITYVARCHAR2(100 CHAR)A site's city as entered by the site manager when they created or last modified the site.
STATE_PROVINCEVARCHAR2(100 CHAR)A site's state, province, or county as entered by the site manager when they created or last modified the site.
ZIP_POSTAL_CODEVARCHAR2(20 CHAR)The Zip Postal Code associated with a site's address.
COUNTRYVARCHAR2(4000 CHAR)Country in the site's primary address.
SITE_COUNTRYVARCHAR2(4000 CHAR)Country associated with the site profile.
PHONEVARCHAR2(500 CHAR)The contact phone number as entered by the site manager when they created or last modified the site.
ALT_PHONEVARCHAR2(500 CHAR)Alternate phone number associated with the contact.
FAXVARCHAR2(500 CHAR)The contact fax number as entered by the site administrator when they created or last modified the site.

Parent topic: Section index


Investigator context

Principal-investigator identity, credential, licensing, and specialty attributes associated with the site.

Column Name Data Type Description
PREFIXVARCHAR2(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.
FIRST_NAMEVARCHAR2(2048 CHAR)First name of the associated contact.
MIDDLE_NAMEVARCHAR2(100 CHAR)Middle name of the associated contact.
LAST_NAMEVARCHAR2(2048 CHAR)Last name of the associated contact.
SUFFIXVARCHAR2(32767 CHAR)Indicates the principal investigator's suffix. Possible values include II, III, IV, CPA, DDS, Esq, JD, Jr, LLD, MD, PhD, Ret, RN, Sr, or DO.
DEGREEVARCHAR2(200 CHAR)Degree or credential associated with the investigator.
INV_STATUSVARCHAR2(32767 CHAR)Indicates the investigator status. Possible values include New, Active, Disbarred, Deceased, Retired, Restricted, or Active Not In Use By Study.
INV_SPECIALTYVARCHAR2(32767 CHAR)Indicates the investigator's primary specialty. Possible values include Allergy and immunology, Anesthesiology, Dermatology, Diagnostic radiology, Emergency medicine, Family medicine, Internal medicine, Medical genetics, Neurology, Nuclear medicine, Obstetrics and gynecology, Ophthalmology, Pathology, Pediatrics, Physical medicine and rehabilitation, Preventive medicine, Psychiatry, Radiation oncology, Surgery, or Urology.
INV_SUB_SPECIALTYVARCHAR2(500 CHAR)Indicates the investigator sub-specialty. Valid values depend on INV_SPECIALTY. Possible values include Critical care medicine, Hospice and palliative care, Pain medicine, Pediatric anesthesiology, or Sleep medicine.
INV_TIMEZONEVARCHAR2(50 CHAR)Indicates the investigator time zone. Sample values shown are representative, not exhaustive. Possible values include America/New_York, Europe/Madrid, Asia/Calcutta, or Asia/Kolkata.
INV_IDENTIFIERVARCHAR2(50 CHAR)Associated ID of the contact. This identifier is unique across contacts at your organizations.
INV_INT_IDENTIFIERVARCHAR2(500 CHAR)Integration ID associated with the contact, when available.
INV_TAX_IDENTIFIERVARCHAR2(50 CHAR)Tax Identification Number (TIN) associated with the contact.
INV_LISC_NUMVARCHAR2(500 CHAR)Licensed research number associated with the contact.
INV_MED_IDENTIFIERVARCHAR2(500 CHAR)Medical identifier associated with the contact.
INV_NPIVARCHAR2(500 CHAR)National Provider Identifier (NPI) associated with the contact. This is a unique identification number for covered health care providers.
INV_DEA_NUMVARCHAR2(2048 CHAR)The DEA registration number.
INV_DEA_EXPVARCHAR2(2048 CHAR)Indicates the expiration date of the DEA Registration Number as defined by a site manager.
INV_EXEMPTION_NUMVARCHAR2(500 CHAR)Exemption number associated with the contact.

Parent topic: Section index


Audit context

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

Column Name Data Type Description
VERSION_STARTTIMESTAMP(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_ENDTIMESTAMP(6)Indicates the date and time of when data was changed, if the data is not current.
OPERATION_TYPEVARCHAR2(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_NAMEVARCHAR2(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_NAMEVARCHAR2(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_NUMBERNUMBERAudit trail field that represents the version number of the data.
REASONVARCHAR2(255 CHAR)Audit trail reason recorded for the dataset row change. Populated when a reason for change is provided for the row update.
COMMENTSVARCHAR2(2048 CHAR)Comment recorded for the dataset row change, when provided.
IS_CURRENTCHAR(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_IDRAW(16 BYTE)GUID of the study.
STUDY_WIDNUMBER(10)A number that represents the unique identifier of the study.
SITE_IDRAW(16 BYTE)GUID of the site.
SITE_WIDNUMBER(10)A number that represents the unique identifier of a site.
USER_IDRAW(16 BYTE)GUID of the user.
USER_WIDNUMBER(10)Indicates a user's numeric identifier.
CURRENT_STUDY_ROLE_IDRAW(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_WIDNUMBER(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.
DH_TIMESTAMPTIMESTAMP(6)A timestamp that indicates when the data became available in the dataset.
SOFTWARE_VERSION_NUMBERNUMBERSoftware version number stored on the underlying source row that produced the Site dataset record.

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

    Ordered dataset column names selected by the client.

    Each row in data uses this exact order.

  • Number of rows returned in the current page.

    Example: 2
  • data

    Row data aligned positionally with columns.

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

  • 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

  • Requested page size.

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

    Example: 100

  • 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

  • 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
Nested Schema : columns
Type: array

Ordered dataset column names selected by the client.

Each row in data uses this exact order.

Show Source

  • Ordered dataset column names selected by the client.

    Each row in data uses this exact order.

    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
  • items

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

  • 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"]]
Example:
[
    [
        "A86F2D0BB610404DB62D37AFA9C20B50",
        "REC001",
        "Active"
    ],
    [
        "A86F2D0BB610404DB62D37AFA9C20B50",
        "REC002",
        "Inactive"
    ]
]
Examples

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
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

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
Examples

Back to Top