Integrations and API

Integrate your systems with DataGalaxy Portfolio through its API: objects, typed read API, attachments and events.

18 articles

API fundamentals

Integrate DataGalaxy Portfolio with your systems using connectors, the API, and SSE, and configure API authentication and IP whitelisting.

Create an integration, manage its API tokens and JSON configuration, and give it permissions on concepts.

Listen to platform events in real time by connecting to the Server-Sent Events (SSE) channel with an integration token.

Create an object through the API with a POST request using field IDs as keys.

Retrieve an object and all its field values through the API with a GET request.

Update an object's field values through the API with a PATCH request using its ID.

Delete an object through the API with a DELETE request that uses its ID.

Retrieve all objects that share a field value, such as all instances of a concept, with a GET request.

Link two instances through an existing n-n association by sending a POST request to the events endpoint.

Read instances by concept with readable API aliases: create an integration, set permissions, and try the API in its documentation.

Control Typed Read API results by retrieving one instance by ID, choosing returned fields, and paginating with limit and startAfter.

Retrieve all instances of a concept with their field values through the Typed Read API.

Retrieve one instance of a concept with its field values through the Typed Read API.

Retrieve the history of a field of an instance over a time range, with the date, origin and value of each change.

List the files attached to an attachment field of an instance, with their revision IDs and upload details.

Download the content of a file attached to an instance, using its revision ID.

Upload a file to an attachment field or replace an existing file with the forceUpdate option.

Delete a file attached to an instance, using its revision ID.