Document Favorite

The document favorite resource.

Basehttps://rest.carbon.ms/documentFavorite

GET/documentFavorite

List document favorites

Retrieve a paginated list of document favorites. 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/documentFavorite

curl --request GET \
  --url 'https://rest.carbon.ms/documentFavorite?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "documentId": "xyz789",
    "userId": "xyz789"
  }
]

GET/documentFavorite

Retrieve a document favorite

Fetch a single document favorite by filtering on `documentId`.

Query parameters

documentIdstring

Match on the document favorite's `documentId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/documentFavorite

curl --request GET \
  --url 'https://rest.carbon.ms/documentFavorite?documentId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "documentId": "xyz789",
  "userId": "xyz789"
}

POST/documentFavorite

Create a document favorite

Create a new document favorite.

POSThttps://rest.carbon.ms/documentFavorite

curl --request POST \
  --url https://rest.carbon.ms/documentFavorite \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"documentId":"xyz789"}'

Response

{
  "documentId": "xyz789",
  "userId": "xyz789"
}

PATCH/documentFavorite

Update a document favorite

Update an existing document favorite, matched on `documentId`.

PATCHhttps://rest.carbon.ms/documentFavorite

curl --request PATCH \
  --url 'https://rest.carbon.ms/documentFavorite?documentId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'

Response

{
  "documentId": "xyz789",
  "userId": "xyz789"
}

DELETE/documentFavorite

Delete a document favorite

Delete a document favorite, matched on `documentId`. Returns 204 No Content.

Query parameters

documentIdstring

The `documentId` of the document favorite to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/documentFavorite

curl --request DELETE \
  --url 'https://rest.carbon.ms/documentFavorite?documentId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content