Skip to main content

Pools

Pools define collaborative data collections that group entities across different projects. The primary goal of pools is to make it easy to share entities with multiple collaborators or systems by assigning them to one or more shared pools. Pools act as logical containers that enable flexible access and reuse of data — independent of the original project or context in which the entity was created. This mechanism supports scenarios such as:

  • Cross-project collaboration
  • Centralized data aggregation
  • Thematic or functional grouping of entities

Each entity can be assigned to one or more pools via a list of Pool IDs.

info

Like Channels, Pools are internally managed. Please contact the project lead to clarify which pools are available and suitable for your use case.

Structure​

Each entity can be linked to multiple pools. A pool is referenced by its unique identifier.

{
  "pools": [
    "605c5f2f4f4a28671cb3c125",
    "605c5f2f1f4a24671cb3c531"
  ]
}

Using pools​

Pools can be assigned directly when creating a new entity or can be added, updated, removed later via the described Endpoint below.

Request​

PATCH 
/:id/pools
{
  "pools": [
    {
      "_id": "605c5f2f1f4a24671cb3c531"
    },
    {
      "_id": "605c5f2f4f4a28671cb3c125",
      "remove": true
    }
  ]
}

Response​

  • If the entity does not exist, the Gateway returns a 404 Not Found.
  • If one or more pools do not exist, the Gateway returns a 404 Not Found.
    "The following pool(s) do not exist [<pool>]"