Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r085

...

Review the changes to the publicly available REST APIs for

D s product
rtrue
for  for the current release and past releases. 

...

Cancel
D s dataflow
jobs via API

D s ed
editionsgdpent,gdppro,gdppr,gdpst


Endpointhttp://www.example.com:3005/v4/jobGroups/:id/cancel
AuthenticationRequired
MethodPOST
Request Body

None.

Response Status Code200 - Ok
Response Body
Code Block
{
  "jobIds": [
    1
  ],
  "jobgroupId": 1
}

...

For the :connectorId value below, use the vendor value that you acquired above. For example, to acquire connector type definitions for MySQL connection type, use the value mysql.

Endpoint/v4/connectorMetadata/:connectorId/defaults
MethodGET
DescriptionGet the default metadata for a connector without applying custom overrides. This metadata is used to defined connectivity, ingestion, and publishing for the connector.
Documentation
D s api refdoclink
operation/getConnectorDefaults

Get connector metadata information - current values

The following endpoint acquires the current metadata for a specified connector type, which include the default values with any applicable overrides applied to them.

Endpoint/v4/connectorMetadata/:connectorId/
MethodGET
DescriptionGet the consolidated metadata for a connector in a given workspace. This metadata is used to defined connectivity, ingestion, and publishing for the connector.
Documentation
D s api refdoclink
operation/getConnectorConfig

Get connector metadata information - get overrides values

The following endpoint retrieves the overrides that have been applied to a specific connector.

Endpoint/v4/connectorMetadata/:connectorId/overrides
MethodGET
DescriptionGet the metadata overrides for a connector in a given workspace. These overrides are applied to the base configuration for connectivity operations.
Documentation
D s api refdoclink
operation/getConnectorOverrides

Create overrides for a connector

The following endpoint applies the specified value or values as overrides to the connector.

Endpoint/v4/connectorMetadata/:connectorId/overrides
MethodPOST
Description

The specified overrides are merged into the current set of overrides for the connector. A new entry is created if no overrides currently exist.

Documentation
Tip

Tip: Overrides are specified in the request body. See the link below for more.

D s api refdoclink
operation/updateConnectorOverrides

Delete overrides for a connector

The following endpoint deletes all override values for a specified connector.

Endpoint/v4/connectorMetadata/:connectorId/overrides
MethodDELETE
Description

All overrides are deleted. The connector reverts to the base configuration.

Documentation
D s api refdoclink
operation/deleteConnectorOverrides



Asset transfer API using email addresses

...

Info

NOTE: This feature is available to project owners only.

Info

NOTE: Do not transfer assets from an admin user to a non-admin user. Some options on the shared objects may be lost due to the loss of permissions.

Notes:

  • When a user transfer assets, the level of privilege (viewer, editor, or owner) is transferred with each asset. It is technically possible for a user to own an asset and to have sub-maximal privileges on the asset.
    • For shareable assets such as flows and connections, the original owner is downgraded to editor of those assets and any assets scoped within them, such as datasets.
    • Schedules are transferred. Time and time zone information in the schedules are not modified during the transfer.
    • For non-shareable assets, such as folders and macros, the original owner no longer has access to them at all.
  • Participants in the transfer can be identified by email address or internal identifier of the platform.
  • Transferring of assets does not check for access to the objects. It's possible that the receiving user may not be able to access connections or datasets that were created by the original user. Examples:
    • Original user accessed data through a connection that was shared to the user. Receiving user does not have access to or credentials for the connection.
    • Original user had permissions to directories on the backend datastore that the receiving user does not have.
  • This endpoint does not delete the user who transferred the assets.

Here is the mapping of example user identifiers:

roleemail addressinternal identifier
from-userjoe@example.com4
to-userjim@example.com7

Transfer of assets using email:

Endpoint http://www.example.com:3005/v4/workspaces/current/transfer
AuthenticationRequired
MethodPATCH
Request Body
Code Block
{
 "fromUserEmail": "joe@example.com",
 "toUserEmail": "jim@example.com"
}
Response Status Code200 - Ok
Response Body

Empty.

Transfer of assets using internal identifier:

The following endpoint call transfers assets from userId 4 to userId 7.

Endpoint http://www.example.com:3005/v4/workspaces/current/transfer
AuthenticationRequired
MethodPATCH
Request Body
Code Block
{
 "fromUserId": "4",
 "toUserId": "7"
}
Response Status Code200 - Ok
Response Body

Empty.

For more information, see

...

Flow sharing API now accepts user email addresses

D s ed
editionsgdppr

Beginning in Release 7.5, the API has been enhanced to allow insertion of a user's email address as part of the request body. Below is an example request:

Endpoint/v4/flows/402/permissions/
MethodPOST
Request Body
Code Block
    "data": [
        {
            "email": "user@example.com",
            "role": "collaborator",
            "policy": "flow_editor"
        }
    ]
}

If the above returns a 201 - Success status message, then user@example.com has been given the role of collaborator, which uses the flow_editor policy, for flowId 402.

...