d7efbd8cd4
This commit adds a new endpoint `/v1/events` which provides a list of all timeline events. It is able to be filtered by story_id, worklist_id, and board_id. The existing `/v1/stories/:id/events` endpoint is preserved, but similar endpoints for worklists and boards don't exist in favour of using something like `/v1/events?worklist_id=360`. Change-Id: Ie13f9d71d9a0b736e4184dd36cc1a6ac26a5f109
4.8 KiB
V1 Web API
API
MY_ACCESS_TOKEN is to be replaced by a token for a given user obtained from https://my.example.org/#!/profile/tokens initially. The User Tokens section of the api documentation gives instructions for obtaining subsequent tokens.
Projects
storyboard.api.v1.projects:ProjectsController
Project Groups
storyboard.api.v1.project_groups:ProjectGroupsController
storyboard.api.v1.project_groups:ProjectsSubcontroller
Stories
storyboard.api.v1.stories:StoriesController
storyboard.api.v1.stories:TasksNestedController
Comments and Timeline events
storyboard.api.v1.timeline:CommentsController
storyboard.api.v1.timeline:TimeLineEventsController
storyboard.api.v1.timeline:NestedTimeLineEventsController
Tasks
storyboard.api.v1.tasks:TasksPrimaryController
Branches
storyboard.api.v1.branches:BranchesController
Milestones
storyboard.api.v1.milestones:MilestonesController
Tags
storyboard.api.v1.tags:TagsController
Subscriptions
storyboard.api.v1.subscriptions:SubscriptionsController
Users
storyboard.api.v1.users:UsersController
Teams
storyboard.api.v1.teams:TeamsController
storyboard.api.v1.teams:UsersSubcontroller
User Preferences
storyboard.api.v1.user_preferences:UserPreferencesController
System Info
storyboard.api.v1.system_info:SystemInfoController
User Tokens
storyboard.api.v1.user_tokens:UserTokensController
Worklists
storyboard.api.v1.worklists:WorklistsController
Filters
storyboard.api.v1.worklists:FilterSubcontroller
Items
storyboard.api.v1.worklists:ItemsSubcontroller
Permissions
storyboard.api.v1.worklists:PermissionsController
Boards
storyboard.api.v1.boards:BoardsController
Permissions
storyboard.api.v1.boards:PermissionsController
Due Dates
storyboard.api.v1.due_dates:DueDatesController
Permissions
storyboard.api.v1.due_dates:PermissionsController
Object model
Story
storyboard.api.v1.wmodels.Story
Task
storyboard.api.v1.wmodels.Task
Project
storyboard.api.v1.wmodels.Project
ProjectGroup
storyboard.api.v1.wmodels.ProjectGroup
Comment
storyboard.api.v1.wmodels.Comment
Timeline event
storyboard.api.v1.wmodels.TimeLineEvent
Due Date
storyboard.api.v1.wmodels.DueDate
Board
storyboard.api.v1.wmodels.Board
Worklist
storyboard.api.v1.wmodels.Worklist
WorklistItem
storyboard.api.v1.wmodels.WorklistItem
WorklistFilter
storyboard.api.v1.wmodels.WorklistFilter
FilterCriterion
storyboard.api.v1.wmodels.FilterCriterion
User
storyboard.api.v1.wmodels.User
SystemInfo
storyboard.api.v1.wmodels.SystemInfo