metabase.api.segment
/api/segment endpoints.
/api/segment endpoints.
DELETE_:idclj
DELETE /api/segment/:id
Archive a Segment. (DEPRECATED -- Just pass updated value of :archived to the PUT endpoint instead.)
PARAMS:
-
id -
revision_messagevalue must be a non-blank string.
## `DELETE /api/segment/:id` Archive a Segment. (DEPRECATED -- Just pass updated value of `:archived` to the `PUT` endpoint instead.) ##### PARAMS: * **`id`** * **`revision_message`** value must be a non-blank string.
GET_clj
GET /api/segment/
Fetch all Segments.
## `GET /api/segment/` Fetch *all* `Segments`.
GET_:idclj
## `GET /api/segment/:id` Fetch `Segment` with ID. ##### PARAMS: * **`id`**
GET_:id_relatedclj
## `GET /api/segment/:id/related` Return related entities. ##### PARAMS: * **`id`**
GET_:id_revisionsclj
## `GET /api/segment/:id/revisions` Fetch `Revisions` for `Segment` with ID. ##### PARAMS: * **`id`**
POST_clj
POST /api/segment/
Create a new Segment.
PARAMS:
-
namevalue must be a non-blank string. -
descriptionvalue may be nil, or if non-nil, value must be a string. -
table_idvalue must be an integer greater than zero. -
definitionvalue must be a map.
## `POST /api/segment/` Create a new `Segment`. ##### PARAMS: * **`name`** value must be a non-blank string. * **`description`** value may be nil, or if non-nil, value must be a string. * **`table_id`** value must be an integer greater than zero. * **`definition`** value must be a map.
POST_:id_revertclj
POST /api/segment/:id/revert
Revert a Segement to a prior Revision.
PARAMS:
-
id -
revision_idvalue must be an integer greater than zero.
## `POST /api/segment/:id/revert` Revert a `Segement` to a prior `Revision`. ##### PARAMS: * **`id`** * **`revision_id`** value must be an integer greater than zero.
PUT_:idclj
PUT /api/segment/:id
Update a Segment with ID.
PARAMS:
-
points_of_interestvalue may be nil, or if non-nil, value must be a string. -
descriptionvalue may be nil, or if non-nil, value must be a string. -
archivedvalue may be nil, or if non-nil, value must be a boolean. -
definitionvalue may be nil, or if non-nil, value must be a map. -
revision_messagevalue must be a non-blank string. -
show_in_getting_startedvalue may be nil, or if non-nil, value must be a boolean. -
namevalue may be nil, or if non-nil, value must be a non-blank string. -
caveatsvalue may be nil, or if non-nil, value must be a string. -
id
## `PUT /api/segment/:id` Update a `Segment` with ID. ##### PARAMS: * **`points_of_interest`** value may be nil, or if non-nil, value must be a string. * **`description`** value may be nil, or if non-nil, value must be a string. * **`archived`** value may be nil, or if non-nil, value must be a boolean. * **`definition`** value may be nil, or if non-nil, value must be a map. * **`revision_message`** value must be a non-blank string. * **`show_in_getting_started`** value may be nil, or if non-nil, value must be a boolean. * **`name`** value may be nil, or if non-nil, value must be a non-blank string. * **`caveats`** value may be nil, or if non-nil, value must be a string. * **`id`**
routesclj
Ring routes for api/segment: (POST_ PUT_:id GET_:id_revisions POST_:id_revert GET_ GET_:id_related DELETE_:id GET_:id)
Ring routes for api/segment: (POST_ PUT_:id GET_:id_revisions POST_:id_revert GET_ GET_:id_related DELETE_:id GET_:id)
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close