Entities API

Golden 3.0.0 public API reference. Parameters, responses, and schemas for supported customer operations.

14 operations.

GET /api/entities

Retrieves all available entities.

Operation ID: getAllEntities

Locates all entities and returns. Requires the ADMIN, STEWARD or VIEWER role.

Security: bearerAuth

Responses

POST /api/entities

Creates a new entity or updates existing one.

Operation ID: saveEntity

Creates a new entity or updates existing one using provided information. Functional validations are applied. Requires the ADMIN role.

Security: bearerAuth

Request body

Responses

POST /api/entities/export

Runs a entities export.

Operation ID: exportEntity

Exports selected entities and returns the configuration package in exchange. The response contains the export; no background task is created. Requires the ADMIN role.

Security: bearerAuth

Request body

Responses

GET /api/entities/export/all

Exports all entities.

Operation ID: exportAllEntities

Exports all entities and returns the configuration package in exchange. The response contains the export; no background task is created. Requires the ADMIN role.

Security: bearerAuth

Responses

POST /api/entities/import

Import entities.

Operation ID: importEntities

Receives a list of entities as JSON and tries to import one by one. Requires the ADMIN role.

Security: bearerAuth

Request body

Entity resource dto

Responses

PUT /api/entities/synchronize

Manual entity synchronization.

Operation ID: synchronizeEntity

Locates a existing entity and executes a manual synchronization using provided parameters. The entity must be enabled, unlocked and set to manual mode. Requires the ADMIN role.

Security: bearerAuth

Request body

Responses

GET /api/entities/table/{table}

Retrieves the entity associated to a table.

Operation ID: getEntityForTable

Locates that is associated to indicated table, or none if table is not associated to an entity. Requires the ADMIN, STEWARD or VIEWER role.

Security: bearerAuth

Parameters

Responses

GET /api/entities/{entity}

Retrieves a entity by identifier.

Operation ID: getEntity

Locates a entity by identifier and returns it. Requires the ADMIN, STEWARD or VIEWER role.

Security: bearerAuth

Parameters

Responses

DELETE /api/entities/{entity}

Deletes a entity.

Operation ID: deleteEntity

Locates a entity and deletes it. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

PUT /api/entities/{entity}/automatic/{automatic}

Set automatic/manual synchronization mode for an entity.

Operation ID: setEntityAutomatic

Locates a existing entity and sets automatic synchronization behaviour. An entity in automatic synchronization mode does automatic synchronization and does not allow any changes, so the entity becomes locked; if not automatic, synchronization needs to be manually called. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

PUT /api/entities/{entity}/clear

Clears an entity.

Operation ID: clearEntity

Locates a existing entity and clears all buckets if not locked. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

GET /api/entities/{entity}/dependencies

Retrieves what an entity uses and what uses it.

Operation ID: getEntityDependencies

Builds the dependency graph and returns this entity’s place in it. ⚠️ The cost is the whole installation, not this one entity: every resource, every table and every entity is loaded to build the graph. That is why it is a call of its own and why neither the listing nor the entity read carries it. Requires the ADMIN, STEWARD or VIEWER role, and the entity has to be one the caller may see.

Security: bearerAuth

Parameters

Responses

PUT /api/entities/{entity}/enabled/{enabled}

Enable/disable an entity.

Operation ID: setEntityEnabled

Locates a existing entity and sets/unsets enabled flag. A disabled entity does not allow any data operation, but allows changes to configuration. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

PUT /api/entities/{entity}/locked/{locked}

Locks/unlocks an entity.

Operation ID: setEntityLocking

Locates a existing entity and locks/unlocks. A locked entity prevents any change to be made to the entity and underlying table and resources. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses