Changes to the APIs

Contents:

Expand all Collapse all

Contents:

Changes for Release 5.0

Introducing v4 APIs

NOTE: This feature is in Beta release.

Release 5.0 signals the introduction of version 4 of the REST APIs.

NOTE: At this time, a very limited number of v4 REST APIs are publicly available. Where possible, you should continue to use the v3 endpoints. For more information, see v4 Endpoints.

NOTE: v3 of the APIs are still supported as of the generally available date for Release 5.0. For more information, see v3 Endpoints.

v4 conventions

The following conventions apply to v4 and later versions of the APIs:

Parameter lists are consistently enveloped in the following manner:
```
{ "data": [
    {
      ...
    }
  ]
}
```
Field names are in camelCase and are consistent with the resource name in the URL or with the embed URL parameter.
From early API versions, foreign keys have been replaced with identifiers like the following:
v3 and earlier v4 and later
"createdBy": 1,

"creator": { "id": 1 },
"updatedBy": 2,

"updater": { "id": 2 },
Publication endpoint references database differently. This change is to make the publishing endpoint for relational targets more flexible in the future.
v3 and earlier v4 and later
"database": "dbName",

"path": ["dbName"],

Changes for Release 4.2

Create Hive and Redshift connections via API

You can create connections of these types via API:

Only one global Hive connection is still supported.
You can create multiple Redshift connections.

See API Connections Create v3.

WrangledDataset endpoints are still valid

In Release 4.1.1 and earlier, the WrangledDataset endpoints enabled creation, modification, and deletion of a wrangled dataset object, which also created the associated recipe object.

In Release 4.2, wrangled datasets have been removed from the application interface. However, the WrangledDataset API endpoints remain, although they now apply to the recipe directly.

The following endpoints and methods are still available:

NOTE: In a future release, these endpoints may be migrated to recipe-based endpoints. API users should review this page for each release.

For more information, see Changes to the Object Model.

Send Feedback

v3 and earlier	v4 and later
"createdBy": 1,	"creator": { "id": 1 },
"updatedBy": 2,	"updater": { "id": 2 },

Page tree