Vikunja.API.Task

Operations

Task

kindIdReactionsDeletePost

kindIdReactionsDeletePost

Arguments

:: (Consumes KindIdReactionsDeletePost MimeJSON, MimeRender MimeJSON ModelsReaction)

=> ModelsReaction

"project" - The reaction you want to add to the entity.

-> Id

"id" - Entity ID

-> Kind

"kind" - The kind of the entity. Can be either tasks or comments for task comments

-> VikunjaRequest KindIdReactionsDeletePost MimeJSON ModelsMessage MimeJSON

POST /{kind}/{id}/reactions/delete

Removes the user's reaction

Removes the reaction of that user on that entity.

AuthMethod: AuthApiKeyJWTKeyAuth

data KindIdReactionsDeletePost

Instances

Produces KindIdReactionsDeletePost MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes KindIdReactionsDeletePost MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam KindIdReactionsDeletePost ModelsReaction

Body Param "project" - The reaction you want to add to the entity.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes KindIdReactionsDeletePost contentType, MimeRender contentType ModelsReaction) => VikunjaRequest KindIdReactionsDeletePost contentType res accept -> ModelsReaction -> VikunjaRequest KindIdReactionsDeletePost contentType res accept

kindIdReactionsGet

kindIdReactionsGet

Arguments

:: Id

"id" - Entity ID

-> Kind

"kind" - The kind of the entity. Can be either tasks or comments for task comments

-> VikunjaRequest KindIdReactionsGet MimeNoContent [Map String [UserUser]] MimeJSON

GET /{kind}/{id}/reactions

Get all reactions for an entity

Returns all reactions for an entity

AuthMethod: AuthApiKeyJWTKeyAuth

data KindIdReactionsGet

Instances

Produces KindIdReactionsGet MimeJSON

application/json

Defined in Vikunja.API.Task

kindIdReactionsPut

kindIdReactionsPut

Arguments

:: (Consumes KindIdReactionsPut MimeJSON, MimeRender MimeJSON ModelsReaction)

=> ModelsReaction

"project" - The reaction you want to add to the entity.

-> Id

"id" - Entity ID

-> Kind

"kind" - The kind of the entity. Can be either tasks or comments for task comments

-> VikunjaRequest KindIdReactionsPut MimeJSON ModelsReaction MimeJSON

PUT /{kind}/{id}/reactions

Add a reaction to an entity

Add a reaction to an entity. Will do nothing if the reaction already exists.

AuthMethod: AuthApiKeyJWTKeyAuth

data KindIdReactionsPut

Instances

Produces KindIdReactionsPut MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes KindIdReactionsPut MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam KindIdReactionsPut ModelsReaction

Body Param "project" - The reaction you want to add to the entity.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes KindIdReactionsPut contentType, MimeRender contentType ModelsReaction) => VikunjaRequest KindIdReactionsPut contentType res accept -> ModelsReaction -> VikunjaRequest KindIdReactionsPut contentType res accept

projectsIdTasksPut

projectsIdTasksPut

Arguments

:: (Consumes ProjectsIdTasksPut MimeJSON, MimeRender MimeJSON ModelsTask)

=> ModelsTask

"task" - The task object

-> Id

"id" - Project ID

-> VikunjaRequest ProjectsIdTasksPut MimeJSON ModelsTask MimeJSON

PUT /projects/{id}/tasks

Create a task

Inserts a task into a project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdTasksPut

Instances

Produces ProjectsIdTasksPut MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes ProjectsIdTasksPut MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam ProjectsIdTasksPut ModelsTask

Body Param "task" - The task object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes ProjectsIdTasksPut contentType, MimeRender contentType ModelsTask) => VikunjaRequest ProjectsIdTasksPut contentType res accept -> ModelsTask -> VikunjaRequest ProjectsIdTasksPut contentType res accept

projectsIdViewsViewTasksGet

projectsIdViewsViewTasksGet

Arguments

:: Id

"id" - The project ID.

-> View

"view" - The project view ID.

-> VikunjaRequest ProjectsIdViewsViewTasksGet MimeNoContent [ModelsTask] MimeJSON

GET /projects/{id}/views/{view}/tasks

Get tasks in a project

Returns all tasks for the current project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdViewsViewTasksGet

Instances

Produces ProjectsIdViewsViewTasksGet MimeJSON

application/json

Defined in Vikunja.API.Task

HasOptionalParam ProjectsIdViewsViewTasksGet SortBy

Optional Param "sort_by" - The sorting parameter. You can pass this multiple times to get the tasks ordered by multiple different parametes, along with order_by. Possible values to sort by are id, title, description, done, done_at, due_date, created_by_id, project_id, repeat_after, priority, start_date, end_date, hex_color, percent_done, uid, created, updated. Default is id.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> SortBy -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> SortBy -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet S

Optional Param "s" - Search tasks by task text.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> S -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> S -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Page -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Page -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet OrderBy

Optional Param "order_by" - The ordering parameter. Possible values to order by are asc or desc. Default is asc.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> OrderBy -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> OrderBy -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet FilterTimezone

Optional Param "filter_timezone" - The time zone which should be used for date match (statements like

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> FilterTimezone -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> FilterTimezone -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet FilterIncludeNulls

Optional Param "filter_include_nulls" - If set to true the result will include filtered fields whose value is set to null. Available values are true or false. Defaults to false.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> FilterIncludeNulls -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> FilterIncludeNulls -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet Filter

Optional Param "filter" - The filter query to match tasks by. Check out https://vikunja.io/docs/filters for a full explanation of the feature.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Filter -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Filter -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet Expand

Optional Param "expand" - If set to subtasks, Vikunja will fetch only tasks which do not have subtasks and then in a second step, will fetch all of these subtasks. This may result in more tasks than the pagination limit being returned, but all subtasks will be present in the response. You can only set this to subtasks.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Expand -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Expand -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

projectsProjectViewsViewBucketsBucketTasksPost

projectsProjectViewsViewBucketsBucketTasksPost

Arguments

:: (Consumes ProjectsProjectViewsViewBucketsBucketTasksPost MimeJSON, MimeRender MimeJSON ModelsTaskBucket)

=> ModelsTaskBucket

"taskBucket" - The id of the task you want to move into the bucket.

-> Project

"project" - Project ID

-> View

"view" - Project View ID

-> Bucket

"bucket" - Bucket ID

-> VikunjaRequest ProjectsProjectViewsViewBucketsBucketTasksPost MimeJSON ModelsTaskBucket MimeJSON

POST /projects/{project}/views/{view}/buckets/{bucket}/tasks

Update a task bucket

Updates a task in a bucket

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectViewsViewBucketsBucketTasksPost

Instances

Produces ProjectsProjectViewsViewBucketsBucketTasksPost MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes ProjectsProjectViewsViewBucketsBucketTasksPost MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam ProjectsProjectViewsViewBucketsBucketTasksPost ModelsTaskBucket

Body Param "taskBucket" - The id of the task you want to move into the bucket.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes ProjectsProjectViewsViewBucketsBucketTasksPost contentType, MimeRender contentType ModelsTaskBucket) => VikunjaRequest ProjectsProjectViewsViewBucketsBucketTasksPost contentType res accept -> ModelsTaskBucket -> VikunjaRequest ProjectsProjectViewsViewBucketsBucketTasksPost contentType res accept

tasksAllGet

tasksAllGet :: VikunjaRequest TasksAllGet MimeNoContent [ModelsTask] MimeJSON

GET /tasks/all

Get tasks

Returns all tasks on any project the user has access to.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksAllGet

Instances

Produces TasksAllGet MimeJSON

application/json

Defined in Vikunja.API.Task

HasOptionalParam TasksAllGet SortBy

Optional Param "sort_by" - The sorting parameter. You can pass this multiple times to get the tasks ordered by multiple different parametes, along with order_by. Possible values to sort by are id, title, description, done, done_at, due_date, created_by_id, project_id, repeat_after, priority, start_date, end_date, hex_color, percent_done, uid, created, updated. Default is id.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> SortBy -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> SortBy -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet S

Optional Param "s" - Search tasks by task text.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> S -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> S -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> PerPage -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> PerPage -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> Page -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> Page -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet OrderBy

Optional Param "order_by" - The ordering parameter. Possible values to order by are asc or desc. Default is asc.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> OrderBy -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> OrderBy -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet FilterTimezone

Optional Param "filter_timezone" - The time zone which should be used for date match (statements like

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> FilterTimezone -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> FilterTimezone -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet FilterIncludeNulls

Optional Param "filter_include_nulls" - If set to true the result will include filtered fields whose value is set to null. Available values are true or false. Defaults to false.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> FilterIncludeNulls -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> FilterIncludeNulls -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet Filter

Optional Param "filter" - The filter query to match tasks by. Check out https://vikunja.io/docs/filters for a full explanation of the feature.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> Filter -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> Filter -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet Expand

Optional Param "expand" - If set to subtasks, Vikunja will fetch only tasks which do not have subtasks and then in a second step, will fetch all of these subtasks. This may result in more tasks than the pagination limit being returned, but all subtasks will be present in the response. You can only set this to subtasks.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> Expand -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> Expand -> VikunjaRequest TasksAllGet contentType res accept

tasksBulkPost

tasksBulkPost

Arguments

:: (Consumes TasksBulkPost MimeJSON, MimeRender MimeJSON ModelsBulkTask)

=> ModelsBulkTask

"task" - The task object. Looks like a normal task, the only difference is it uses an array of project_ids to update.

-> VikunjaRequest TasksBulkPost MimeJSON ModelsTask MimeJSON

POST /tasks/bulk

Update a bunch of tasks at once

Updates a bunch of tasks at once. This includes marking them as done. Note: although you could supply another ID, it will be ignored. Use task_ids instead.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksBulkPost

Instances

Produces TasksBulkPost MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes TasksBulkPost MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam TasksBulkPost ModelsBulkTask

Body Param "task" - The task object. Looks like a normal task, the only difference is it uses an array of project_ids to update.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksBulkPost contentType, MimeRender contentType ModelsBulkTask) => VikunjaRequest TasksBulkPost contentType res accept -> ModelsBulkTask -> VikunjaRequest TasksBulkPost contentType res accept

tasksIdAttachmentsAttachmentIDDelete

tasksIdAttachmentsAttachmentIDDelete

Arguments

:: Id

"id" - Task ID

-> AttachmentId

"attachmentId" - Attachment ID

-> VikunjaRequest TasksIdAttachmentsAttachmentIDDelete MimeNoContent ModelsMessage MimeJSON

DELETE /tasks/{id}/attachments/{attachmentID}

Delete an attachment

Delete an attachment.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksIdAttachmentsAttachmentIDDelete

Instances

Produces TasksIdAttachmentsAttachmentIDDelete MimeJSON

application/json

Defined in Vikunja.API.Task

tasksIdAttachmentsAttachmentIDGet

tasksIdAttachmentsAttachmentIDGet

Arguments

:: Id

"id" - Task ID

-> AttachmentId

"attachmentId" - Attachment ID

-> VikunjaRequest TasksIdAttachmentsAttachmentIDGet MimeNoContent FilePath MimeOctetStream

GET /tasks/{id}/attachments/{attachmentID}

Get one attachment.

Get one attachment for download. **Returns json on error.**

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksIdAttachmentsAttachmentIDGet

Instances

Produces TasksIdAttachmentsAttachmentIDGet MimeOctetStream

application/octet-stream

Defined in Vikunja.API.Task

HasOptionalParam TasksIdAttachmentsAttachmentIDGet PreviewSize

Optional Param "preview_size" - The size of the preview image. Can be sm = 100px, md = 200px, lg = 400px or xl = 800px. If provided, a preview image will be returned if the attachment is an image.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksIdAttachmentsAttachmentIDGet contentType res accept -> PreviewSize -> VikunjaRequest TasksIdAttachmentsAttachmentIDGet contentType res accept

(-&-) :: VikunjaRequest TasksIdAttachmentsAttachmentIDGet contentType res accept -> PreviewSize -> VikunjaRequest TasksIdAttachmentsAttachmentIDGet contentType res accept

tasksIdAttachmentsGet

tasksIdAttachmentsGet

Arguments

:: Id

"id" - Task ID

-> VikunjaRequest TasksIdAttachmentsGet MimeNoContent [ModelsTaskAttachment] MimeJSON

GET /tasks/{id}/attachments

Get all attachments for one task.

Get all task attachments for one task.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksIdAttachmentsGet

Instances

Produces TasksIdAttachmentsGet MimeJSON

application/json

Defined in Vikunja.API.Task

HasOptionalParam TasksIdAttachmentsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksIdAttachmentsGet contentType res accept -> PerPage -> VikunjaRequest TasksIdAttachmentsGet contentType res accept

(-&-) :: VikunjaRequest TasksIdAttachmentsGet contentType res accept -> PerPage -> VikunjaRequest TasksIdAttachmentsGet contentType res accept

HasOptionalParam TasksIdAttachmentsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksIdAttachmentsGet contentType res accept -> Page -> VikunjaRequest TasksIdAttachmentsGet contentType res accept

(-&-) :: VikunjaRequest TasksIdAttachmentsGet contentType res accept -> Page -> VikunjaRequest TasksIdAttachmentsGet contentType res accept

tasksIdAttachmentsPut

tasksIdAttachmentsPut

Arguments

:: Consumes TasksIdAttachmentsPut MimeMultipartFormData

=> Files

"files" - The file, as multipart form file. You can pass multiple.

-> Id

"id" - Task ID

-> VikunjaRequest TasksIdAttachmentsPut MimeMultipartFormData ModelsMessage MimeJSON

PUT /tasks/{id}/attachments

Upload a task attachment

Upload a task attachment. You can pass multiple files with the files form param.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksIdAttachmentsPut

Instances

Produces TasksIdAttachmentsPut MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes TasksIdAttachmentsPut MimeMultipartFormData

multipart/form-data

Defined in Vikunja.API.Task

tasksIdDelete

tasksIdDelete

Arguments

:: Id

"id" - Task ID

-> VikunjaRequest TasksIdDelete MimeNoContent ModelsMessage MimeJSON

DELETE /tasks/{id}

Delete a task

Deletes a task from a project. This does not mean "mark it done".

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksIdDelete

Instances

Produces TasksIdDelete MimeJSON

application/json

Defined in Vikunja.API.Task

tasksIdGet

tasksIdGet

Arguments

:: Id

"id" - The task ID

-> VikunjaRequest TasksIdGet MimeNoContent ModelsTask MimeJSON

GET /tasks/{id}

Get one task

Returns one task by its ID

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksIdGet

Instances

Produces TasksIdGet MimeJSON

application/json

Defined in Vikunja.API.Task

tasksIdPositionPost

tasksIdPositionPost

Arguments

:: (Consumes TasksIdPositionPost MimeJSON, MimeRender MimeJSON ModelsTaskPosition)

=> ModelsTaskPosition

"view" - The task position with updated values you want to change.

-> Id

"id" - Task ID

-> VikunjaRequest TasksIdPositionPost MimeJSON ModelsTaskPosition MimeJSON

POST /tasks/{id}/position

Updates a task position

Updates a task position.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksIdPositionPost

Instances

Produces TasksIdPositionPost MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes TasksIdPositionPost MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam TasksIdPositionPost ModelsTaskPosition

Body Param "view" - The task position with updated values you want to change.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksIdPositionPost contentType, MimeRender contentType ModelsTaskPosition) => VikunjaRequest TasksIdPositionPost contentType res accept -> ModelsTaskPosition -> VikunjaRequest TasksIdPositionPost contentType res accept

tasksIdPost

tasksIdPost

Arguments

:: (Consumes TasksIdPost MimeJSON, MimeRender MimeJSON ModelsTask)

=> ModelsTask

"task" - The task object

-> Id

"id" - The Task ID

-> VikunjaRequest TasksIdPost MimeJSON ModelsTask MimeJSON

POST /tasks/{id}

Update a task

Updates a task. This includes marking it as done. Assignees you pass will be updated, see their individual endpoints for more details on how this is done. To update labels, see the description of the endpoint.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksIdPost

Instances

Produces TasksIdPost MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes TasksIdPost MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam TasksIdPost ModelsTask

Body Param "task" - The task object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksIdPost contentType, MimeRender contentType ModelsTask) => VikunjaRequest TasksIdPost contentType res accept -> ModelsTask -> VikunjaRequest TasksIdPost contentType res accept

tasksTaskIDCommentsCommentIDDelete

tasksTaskIDCommentsCommentIDDelete

Arguments

:: TaskId

"taskId" - Task ID

-> CommentId

"commentId" - Comment ID

-> VikunjaRequest TasksTaskIDCommentsCommentIDDelete MimeNoContent ModelsMessage MimeJSON

DELETE /tasks/{taskID}/comments/{commentID}

Remove a task comment

Remove a task comment. The user doing this need to have at least write access to the task this comment belongs to.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskIDCommentsCommentIDDelete

Instances

Produces TasksTaskIDCommentsCommentIDDelete MimeJSON

application/json

Defined in Vikunja.API.Task

tasksTaskIDCommentsCommentIDGet

tasksTaskIDCommentsCommentIDGet

Arguments

:: TaskId

"taskId" - Task ID

-> CommentId

"commentId" - Comment ID

-> VikunjaRequest TasksTaskIDCommentsCommentIDGet MimeNoContent ModelsTaskComment MimeJSON

GET /tasks/{taskID}/comments/{commentID}

Remove a task comment

Remove a task comment. The user doing this need to have at least read access to the task this comment belongs to.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskIDCommentsCommentIDGet

Instances

Produces TasksTaskIDCommentsCommentIDGet MimeJSON

application/json

Defined in Vikunja.API.Task

tasksTaskIDCommentsCommentIDPost

tasksTaskIDCommentsCommentIDPost

Arguments

:: TaskId

"taskId" - Task ID

-> CommentId

"commentId" - Comment ID

-> VikunjaRequest TasksTaskIDCommentsCommentIDPost MimeNoContent ModelsTaskComment MimeJSON

POST /tasks/{taskID}/comments/{commentID}

Update an existing task comment

Update an existing task comment. The user doing this need to have at least write access to the task this comment belongs to.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskIDCommentsCommentIDPost

Instances

Produces TasksTaskIDCommentsCommentIDPost MimeJSON

application/json

Defined in Vikunja.API.Task

tasksTaskIDCommentsGet

tasksTaskIDCommentsGet

Arguments

:: TaskId

"taskId" - Task ID

-> VikunjaRequest TasksTaskIDCommentsGet MimeNoContent [ModelsTaskComment] MimeJSON

GET /tasks/{taskID}/comments

Get all task comments

Get all task comments. The user doing this need to have at least read access to the task.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskIDCommentsGet

Instances

Produces TasksTaskIDCommentsGet MimeJSON

application/json

Defined in Vikunja.API.Task

tasksTaskIDCommentsPut

tasksTaskIDCommentsPut

Arguments

:: (Consumes TasksTaskIDCommentsPut MimeJSON, MimeRender MimeJSON ModelsTaskComment)

=> ModelsTaskComment

"relation" - The task comment object

-> TaskId

"taskId" - Task ID

-> VikunjaRequest TasksTaskIDCommentsPut MimeJSON ModelsTaskComment MimeJSON

PUT /tasks/{taskID}/comments

Create a new task comment

Create a new task comment. The user doing this need to have at least write access to the task this comment should belong to.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskIDCommentsPut

Instances

Produces TasksTaskIDCommentsPut MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes TasksTaskIDCommentsPut MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam TasksTaskIDCommentsPut ModelsTaskComment

Body Param "relation" - The task comment object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksTaskIDCommentsPut contentType, MimeRender contentType ModelsTaskComment) => VikunjaRequest TasksTaskIDCommentsPut contentType res accept -> ModelsTaskComment -> VikunjaRequest TasksTaskIDCommentsPut contentType res accept

tasksTaskIDRelationsPut

tasksTaskIDRelationsPut

Arguments

:: (Consumes TasksTaskIDRelationsPut MimeJSON, MimeRender MimeJSON ModelsTaskRelation)

=> ModelsTaskRelation

"relation" - The relation object

-> TaskId

"taskId" - Task ID

-> VikunjaRequest TasksTaskIDRelationsPut MimeJSON ModelsTaskRelation MimeJSON

PUT /tasks/{taskID}/relations

Create a new relation between two tasks

Creates a new relation between two tasks. The user needs to have update rights on the base task and at least read rights on the other task. Both tasks do not need to be on the same project. Take a look at the docs for available task relation kinds.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskIDRelationsPut

Instances

Produces TasksTaskIDRelationsPut MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes TasksTaskIDRelationsPut MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam TasksTaskIDRelationsPut ModelsTaskRelation

Body Param "relation" - The relation object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksTaskIDRelationsPut contentType, MimeRender contentType ModelsTaskRelation) => VikunjaRequest TasksTaskIDRelationsPut contentType res accept -> ModelsTaskRelation -> VikunjaRequest TasksTaskIDRelationsPut contentType res accept

tasksTaskIDRelationsRelationKindOtherTaskIDDelete

tasksTaskIDRelationsRelationKindOtherTaskIDDelete

Arguments

:: (Consumes TasksTaskIDRelationsRelationKindOtherTaskIDDelete MimeJSON, MimeRender MimeJSON ModelsTaskRelation)

=> ModelsTaskRelation

"relation" - The relation object

-> TaskId

"taskId" - Task ID

-> RelationKind

"relationKind" - The kind of the relation. See the TaskRelation type for more info.

-> OtherTaskId

"otherTaskId" - The id of the other task.

-> VikunjaRequest TasksTaskIDRelationsRelationKindOtherTaskIDDelete MimeJSON ModelsMessage MimeJSON

DELETE /tasks/{taskID}/relations/{relationKind}/{otherTaskID}

Remove a task relation

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskIDRelationsRelationKindOtherTaskIDDelete

Instances

Produces TasksTaskIDRelationsRelationKindOtherTaskIDDelete MimeJSON

application/json

Defined in Vikunja.API.Task

Consumes TasksTaskIDRelationsRelationKindOtherTaskIDDelete MimeJSON

application/json

Defined in Vikunja.API.Task

HasBodyParam TasksTaskIDRelationsRelationKindOtherTaskIDDelete ModelsTaskRelation

Body Param "relation" - The relation object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksTaskIDRelationsRelationKindOtherTaskIDDelete contentType, MimeRender contentType ModelsTaskRelation) => VikunjaRequest TasksTaskIDRelationsRelationKindOtherTaskIDDelete contentType res accept -> ModelsTaskRelation -> VikunjaRequest TasksTaskIDRelationsRelationKindOtherTaskIDDelete contentType res accept