Create capacity

Create a new capacity

POST /revenueOrganization/capacities

Create capacity

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/revenueOrganization/capacities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idColumnSlug": "<string>",
  "timeColumnSlug": "<string>",
  "memberCapacity": 123,
  "allocationExpirationPolicy": {
    "interval": "<string>",
    "minute": 123
  }
}
'

200

{
  "capacity": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "name": "<string>",
    "description": "<string>",
    "memberCapacity": 123,
    "allocationExpirationPolicy": {
      "interval": "<string>",
      "minute": 123
    },
    "modelUuid": "<string>",
    "idColumnSlug": "<string>",
    "timeColumnSlug": "<string>",
    "filter": {
      "groups": [
        {
          "conditions": [
            {
              "kind": "<string>",
              "name": "<string>",
              "clause": "<string>"
            }
          ]
        }
      ]
    },
    "syncedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

name · string · required

Capacity name.

color · enum<string> · required

Capacity color.

Available options: orange, red, purple, green, yellow, grey

description · string

Capacity description.

modelUuid · string<uuid>

Model identifier for capacity mapping.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

idColumnSlug · string

Identifier column slug.

timeColumnSlug · string

Time column slug.

memberCapacity · number

Capacity per member.

allocationExpirationPolicy · Allocation expiration policy · object

Allocation expiration schedule.

Allocation expiration policy

Allocation expiration policy

Allocation expiration policy

Allocation expiration policy

Allocation expiration policy

Allocation expiration policy

Show child attributes

filter · Filter · object

Filter criteria for capacity.

Show child attributes

Response

200

application/json

Successful response

capacity · Capacity · object · required

Created capacity details.

Show child attributes