Tracked Activity Input

The tracked activity input resource.

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

List tracked activity inputs

Retrieve a paginated list of tracked activity inputs. 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/trackedActivityInput
curl --request GET \
  --url 'https://rest.carbon.ms/trackedActivityInput?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "trackedActivityId": "xyz789",
    "trackedEntityId": "xyz789",
    "quantity": 10,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]
GET/trackedActivityInput

Retrieve a tracked activity input

Fetch a single tracked activity input by filtering on `trackedActivityId`.

Query parameters

trackedActivityIdstring

Match on the tracked activity input's `trackedActivityId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/trackedActivityInput
curl --request GET \
  --url 'https://rest.carbon.ms/trackedActivityInput?trackedActivityId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "trackedActivityId": "xyz789",
  "trackedEntityId": "xyz789",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
POST/trackedActivityInput

Create a tracked activity input

Create a new tracked activity input.

Body parameters

quantitynumberrequired
companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/trackedActivityInput
curl --request POST \
  --url https://rest.carbon.ms/trackedActivityInput \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quantity":10,"companyId":"xyz789"}'
Response
{
  "trackedActivityId": "xyz789",
  "trackedEntityId": "xyz789",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
PATCH/trackedActivityInput

Update a tracked activity input

Update an existing tracked activity input, matched on `trackedActivityId`.

Body parameters

quantitynumberrequired
companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/trackedActivityInput
curl --request PATCH \
  --url 'https://rest.carbon.ms/trackedActivityInput?trackedActivityId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quantity":10}'
Response
{
  "trackedActivityId": "xyz789",
  "trackedEntityId": "xyz789",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
DELETE/trackedActivityInput

Delete a tracked activity input

Delete a tracked activity input, matched on `trackedActivityId`. Returns 204 No Content.

Query parameters

trackedActivityIdstring

The `trackedActivityId` of the tracked activity input to delete, e.g. `eq.{id}`.

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