Purpose

Retrieves a list of the schemas for a particular data source.

Important: The schemas returned will be restricted to a single schema when a schema has been specified for the Metadata Exposed Schemas option in the Web UI (or the HDPMetadataExposedSchemas property via the DataSource API).
Note: An administrator can execute this operation on behalf of a user by appending the user query parameter to the request and specifying a user name. See also Managing resources on behalf of users.

URL

https://<myserver>:<port>/api/mgmt/datasources/<datasourceid>/schemas

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Parameter Description Usage Valid Values
"datasourceId" The ID of the data source Required The ID is auto-generated when the data source is created and cannot be changed.

Response definition

The response takes the following format. The properties of the response are described in the table that follows.


{
  "schemas": [
    {
      "name": "schema_name"
    },
    ...
  ]
}
Property Description Usage Valid Values
"name" For data stores that support schemas, the name of a schema associated with the data source.

For data stores that do not support schemas, a dash (-) is returned.

 Required For data stores that support schemas, a valid schema name.

For data stores that do not support schemas, a dash (-) is returned.

Sample server success response

Data stores that support schemas, return a payload similar to the following.


{
  "schemas": [
    {
      "name": "INFORMATION_SCHEMA"
    },
    {
      "name": "SFORCE"
    }     
  ]
}

Data stores that do not support schemas, return a payload similar to the following.


{
  "schemas": [
    {
      "name": "-"
    }
  ]
}

Sample server failure response 


{
  "error": {
    "code": "222207011",
    "message": {
      "lang": "en-US",
      "value": "Invalid DataSource ID {0}"
    }
  }
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the MgmtAPI (11) and ViewDataSource (2) permissions.