84 lines
2.3 KiB
Markdown
84 lines
2.3 KiB
Markdown
---
|
|
name: entitlements-routes
|
|
description: Handle 6 OpenAPI operation(s) under /v1/entitlements for the entitlements route group.
|
|
---
|
|
|
|
# entitlements API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /v1/entitlements for the entitlements route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_entitlements_active_entitlements
|
|
|
|
- Operation ID: `get_entitlements_active_entitlements`
|
|
- Route: `GET /v1/entitlements/active_entitlements`
|
|
- Mode: READ
|
|
- Summary: List all active entitlements
|
|
- Parameters:
|
|
- `customer` in `query` required
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_entitlements_active_entitlements_id
|
|
|
|
- Operation ID: `get_entitlements_active_entitlements_id`
|
|
- Route: `GET /v1/entitlements/active_entitlements/{id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an active entitlement
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_entitlements_features
|
|
|
|
- Operation ID: `get_entitlements_features`
|
|
- Route: `GET /v1/entitlements/features`
|
|
- Mode: READ
|
|
- Summary: List all features
|
|
- Parameters:
|
|
- `archived` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `lookup_key` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_entitlements_features
|
|
|
|
- Operation ID: `post_entitlements_features`
|
|
- Route: `POST /v1/entitlements/features`
|
|
- Mode: WRITE
|
|
- Summary: Create a feature
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_entitlements_features_id
|
|
|
|
- Operation ID: `get_entitlements_features_id`
|
|
- Route: `GET /v1/entitlements/features/{id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a feature
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_entitlements_features_id
|
|
|
|
- Operation ID: `post_entitlements_features_id`
|
|
- Route: `POST /v1/entitlements/features/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Updates a feature
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|