Segment

/api/segment endpoints.

Archive a Segment. (DEPRECATED – Just pass updated value of :archived to the PUT endpoint instead.).

• id

• revision_message value must be a non-blank string.

Fetch all Segments.

Fetch Segment with ID.

• id value must be an integer greater than zero.

Return related entities.

• id

Fetch Revisions for Segment with ID.

• id

Create a new Segment.

• 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.

Revert a Segement to a prior Revision.

• id

• revision_id value must be an integer greater than zero.

Update a Segment with ID.

• 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

---

« Back to API index