Managing value sets¶
Value sets are named lists of strings stored per organization. They are referenced in pipeline event filters as $name and resolved at query time — the current list is always used, so updating a value set immediately affects future pipeline counts without any change to the pipeline definition.
Name rules: alphanumeric characters, hyphens, and underscores only. Names must be unique per organization. If you submit a name with a leading $, it is stored without it.
List all value sets¶
Endpoint
| GET | https://api.giosg.com/api/objectives/v1/orgs/<organization_id>/pipeline/value-sets/ |
|---|---|
Returns a paginated list. Each item has the structure described in Retrieve a value set.
Create a value set¶
Endpoint
| POST | https://api.giosg.com/api/objectives/v1/orgs/<organization_id>/pipeline/value-sets/ |
|---|---|
Payload
| Attribute | Type | Description |
|---|---|---|
name |
string | Value set name (used as $name in event filters). Required. |
values |
array | Non-empty list of strings. Required. |
Example:
1 2 3 4 | |
Response: same structure as Retrieve a value set.
Retrieve a value set¶
Endpoint
| GET | https://api.giosg.com/api/objectives/v1/orgs/<organization_id>/pipeline/value-sets/<value_set_id>/ |
|---|---|
Response
| Attribute | Type | Description |
|---|---|---|
id |
uuid | Unique identifier. |
organization_id |
uuid | Organization that owns the value set. |
name |
string | Value set name (without $). |
values |
array | List of strings. |
created_at |
string | Creation time (ISO-8601). |
modified_at |
string | Last modification time (ISO-8601). |
Update a value set¶
Endpoint
| PATCH / PUT | https://api.giosg.com/api/objectives/v1/orgs/<organization_id>/pipeline/value-sets/<value_set_id>/ |
|---|---|
Same fields as create (name, values). For PATCH, include only the fields to change. name must remain unique per organization.
Remove a value set¶
Endpoint
| DELETE | https://api.giosg.com/api/objectives/v1/orgs/<organization_id>/pipeline/value-sets/<value_set_id>/ |
|---|---|
No response body. Returns 204 on success.