Carbon

Implementation Hub

The implementation hub resource.

Basehttps://rest.carbon.ms/implementationHub
GET/implementationHub

List implementation hubs

Retrieve a paginated list of implementation hubs. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/implementationHub
curl --request GET \
  --url 'https://rest.carbon.ms/implementationHub?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "templateKey": "string",
    "templateVersion": 0,
    "tier": "string",
    "status": "string",
    "exclusions": "string",
    "contacts": "string",
    "createdBy": "string"
  }
]
GET/implementationHub

Retrieve a implementation hub

Fetch a single implementation hub by filtering on `id`.

Query parameters

idstring

Match on the implementation hub's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/implementationHub
curl --request GET \
  --url 'https://rest.carbon.ms/implementationHub?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "templateKey": "string",
  "templateVersion": 0,
  "tier": "string",
  "status": "string",
  "exclusions": "string",
  "contacts": "string",
  "createdBy": "string"
}
POST/implementationHub

Create a implementation hub

Create a new implementation hub.

Body parameters

templateKeystringrequired
templateVersionnumberrequired
tierimplementationTierrequired
statusimplementationStatusrequired
exclusionsobjectrequired
contactsobjectrequired
signedAttimestamp
signedBystring

References user.id

POSThttps://rest.carbon.ms/implementationHub
curl --request POST \
  --url https://rest.carbon.ms/implementationHub \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"templateKey":"string","templateVersion":0,"tier":"string","status":"string","exclusions":"string","contacts":"string"}'
Response
{
  "id": "abc123def456",
  "templateKey": "string",
  "templateVersion": 0,
  "tier": "string",
  "status": "string",
  "exclusions": "string",
  "contacts": "string",
  "createdBy": "string"
}
PATCH/implementationHub

Update a implementation hub

Update an existing implementation hub, matched on `id`.

Body parameters

templateKeystringrequired
templateVersionnumberrequired
tierimplementationTierrequired
statusimplementationStatusrequired
exclusionsobjectrequired
contactsobjectrequired
signedAttimestamp
signedBystring

References user.id

PATCHhttps://rest.carbon.ms/implementationHub
curl --request PATCH \
  --url 'https://rest.carbon.ms/implementationHub?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"templateKey":"string"}'
Response
{
  "id": "abc123def456",
  "templateKey": "string",
  "templateVersion": 0,
  "tier": "string",
  "status": "string",
  "exclusions": "string",
  "contacts": "string",
  "createdBy": "string"
}
DELETE/implementationHub

Delete a implementation hub

Delete a implementation hub, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the implementation hub to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/implementationHub
curl --request DELETE \
  --url 'https://rest.carbon.ms/implementationHub?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content