datawarehouse

List Data Warehouse instances

Lists all non-deleted Data Warehouse instances. Use the status parameter to filter for particular Data Warehouse statuses.<br/> NOTE: In the response body, the next link returns null when there is no more pages.

get/gdc/datawarehouse/instances

Request

Base URL
https://secure.gooddata.com
Auth
none declared

Query parameters

statusstring[]

Filter Data Warehouse instances by status. Use multiple parameters to list Data Warehouse instances in multiple statuses (for example, ?status=enabled&status=error). Possible values: enabled, deleted, initializing, error, all.

offsetstring

The offset of the first record on a page. You can reuse the value of the offset parameter, which is an element of the link in the next parameter from the previous response from this resource.

limitinteger

The maximum number of records per page.

Response

Get instances the user can see (can be filtered by status parameter)

Example response

{
  "instances": {
    "items": [
      {
        "instance": {
          "title": "Storage",
          "description": "Testing Storage",
          "authorizationToken": "token",
          "status": "ENABLED",
          "created": "2014-03-17T13:02:39Z",
          "updated": "2014-03-17T13:02:41Z",
          "createdBy": "/gdc/account/profile/{profile_id}",
          "updatedBy": "/gdc/account/profile/{profile_id}",
          "connectionUrl": "jdbc:gdc:datawarehouse://{server}:{port}}/gdc/datawarehouse/instances/{instance_id}",
          "links": {
            "self": "/gdc/datawarehouse/instances/{instance_id}",
            "parent": "/gdc/datawarehouse/instances",
            "users": "/gdc/datawarehouse/instances/{instance_id}/users",
            "schemas": "/gdc/datawarehouse/instances/{instance_id}/schemas",
            "jdbc": "jdbc:gdc:datawarehouse://{server}:{port}}/gdc/datawarehouse/instances/{instance_id}",
            "endpoints": "/gdc/datawarehouse/instances/{instance_id}/endpoints"
          },
          "license": "standard"
        }
      }
    ],
    "links": {
      "self": "/gdc/uri/self",
      "parent": "/gdc/uri/parent"
    },
    "paging": {
      "next": "/gdc/uri?offset=100"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.