Vikunja.API.Labels

Operations

Labels

labelsGet

labelsGet :: VikunjaRequest LabelsGet MimeNoContent [ModelsLabel] MimeJSON

GET /labels

Get all labels a user has access to

Returns all labels which are either created by the user or associated with a task the user has at least read-access to.

AuthMethod: AuthApiKeyJWTKeyAuth

data LabelsGet

Instances

Produces LabelsGet MimeJSON

application/json

Defined in Vikunja.API.Labels

HasOptionalParam LabelsGet S

Optional Param "s" - Search labels by label text.

Defined in Vikunja.API.Labels

Methods

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

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

HasOptionalParam LabelsGet 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.Labels

Methods

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

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

HasOptionalParam LabelsGet Page

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

Defined in Vikunja.API.Labels

Methods

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

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

labelsIdDelete

labelsIdDelete

Arguments

:: Id

"id" - Label ID

-> VikunjaRequest LabelsIdDelete MimeNoContent ModelsLabel MimeJSON

DELETE /labels/{id}

Delete a label

Delete an existing label. The user needs to be the creator of the label to be able to do this.

AuthMethod: AuthApiKeyJWTKeyAuth

data LabelsIdDelete

Instances

Produces LabelsIdDelete MimeJSON

application/json

Defined in Vikunja.API.Labels

labelsIdGet

labelsIdGet

Arguments

:: Id

"id" - Label ID

-> VikunjaRequest LabelsIdGet MimeNoContent ModelsLabel MimeJSON

GET /labels/{id}

Gets one label

Returns one label by its ID.

AuthMethod: AuthApiKeyJWTKeyAuth

data LabelsIdGet

Instances

Produces LabelsIdGet MimeJSON

application/json

Defined in Vikunja.API.Labels

labelsIdPut

labelsIdPut

Arguments

:: (Consumes LabelsIdPut MimeJSON, MimeRender MimeJSON ModelsLabel)

=> ModelsLabel

"label" - The label object

-> Id

"id" - Label ID

-> VikunjaRequest LabelsIdPut MimeJSON ModelsLabel MimeJSON

PUT /labels/{id}

Update a label

Update an existing label. The user needs to be the creator of the label to be able to do this.

AuthMethod: AuthApiKeyJWTKeyAuth

data LabelsIdPut

Instances

Produces LabelsIdPut MimeJSON

application/json

Defined in Vikunja.API.Labels

Consumes LabelsIdPut MimeJSON

application/json

Defined in Vikunja.API.Labels

HasBodyParam LabelsIdPut ModelsLabel

Body Param "label" - The label object

Defined in Vikunja.API.Labels

Methods

setBodyParam :: (Consumes LabelsIdPut contentType, MimeRender contentType ModelsLabel) => VikunjaRequest LabelsIdPut contentType res accept -> ModelsLabel -> VikunjaRequest LabelsIdPut contentType res accept

labelsPut

labelsPut

Arguments

:: (Consumes LabelsPut MimeJSON, MimeRender MimeJSON ModelsLabel)

=> ModelsLabel

"label" - The label object

-> VikunjaRequest LabelsPut MimeJSON ModelsLabel MimeJSON

PUT /labels

Create a label

Creates a new label.

AuthMethod: AuthApiKeyJWTKeyAuth

data LabelsPut

Instances

Produces LabelsPut MimeJSON

application/json

Defined in Vikunja.API.Labels

Consumes LabelsPut MimeJSON

application/json

Defined in Vikunja.API.Labels

HasBodyParam LabelsPut ModelsLabel

Body Param "label" - The label object

Defined in Vikunja.API.Labels

Methods

setBodyParam :: (Consumes LabelsPut contentType, MimeRender contentType ModelsLabel) => VikunjaRequest LabelsPut contentType res accept -> ModelsLabel -> VikunjaRequest LabelsPut contentType res accept

tasksTaskIDLabelsBulkPost

tasksTaskIDLabelsBulkPost

Arguments

:: (Consumes TasksTaskIDLabelsBulkPost MimeJSON, MimeRender MimeJSON ModelsLabelTaskBulk)

=> ModelsLabelTaskBulk

"label" - The array of labels

-> TaskId

"taskId" - Task ID

-> VikunjaRequest TasksTaskIDLabelsBulkPost MimeJSON ModelsLabelTaskBulk MimeJSON

POST /tasks/{taskID}/labels/bulk

Update all labels on a task.

Updates all labels on a task. Every label which is not passed but exists on the task will be deleted. Every label which does not exist on the task will be added. All labels which are passed and already exist on the task won't be touched.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskIDLabelsBulkPost

Instances

Produces TasksTaskIDLabelsBulkPost MimeJSON

application/json

Defined in Vikunja.API.Labels

Consumes TasksTaskIDLabelsBulkPost MimeJSON

application/json

Defined in Vikunja.API.Labels

HasBodyParam TasksTaskIDLabelsBulkPost ModelsLabelTaskBulk

Body Param "label" - The array of labels

Defined in Vikunja.API.Labels

Methods

setBodyParam :: (Consumes TasksTaskIDLabelsBulkPost contentType, MimeRender contentType ModelsLabelTaskBulk) => VikunjaRequest TasksTaskIDLabelsBulkPost contentType res accept -> ModelsLabelTaskBulk -> VikunjaRequest TasksTaskIDLabelsBulkPost contentType res accept

tasksTaskLabelsGet

tasksTaskLabelsGet

Arguments

:: Task

"task" - Task ID

-> VikunjaRequest TasksTaskLabelsGet MimeNoContent [ModelsLabel] MimeJSON

GET /tasks/{task}/labels

Get all labels on a task

Returns all labels which are assicociated with a given task.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskLabelsGet

Instances

Produces TasksTaskLabelsGet MimeJSON

application/json

Defined in Vikunja.API.Labels

HasOptionalParam TasksTaskLabelsGet S

Optional Param "s" - Search labels by label text.

Defined in Vikunja.API.Labels

Methods

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

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

HasOptionalParam TasksTaskLabelsGet 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.Labels

Methods

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

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

HasOptionalParam TasksTaskLabelsGet Page

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

Defined in Vikunja.API.Labels

Methods

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

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

tasksTaskLabelsLabelDelete

tasksTaskLabelsLabelDelete

Arguments

:: Task

"task" - Task ID

-> Label

"label" - Label ID

-> VikunjaRequest TasksTaskLabelsLabelDelete MimeNoContent ModelsMessage MimeJSON

DELETE /tasks/{task}/labels/{label}

Remove a label from a task

Remove a label from a task. The user needs to have write-access to the project to be able do this.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskLabelsLabelDelete

Instances

Produces TasksTaskLabelsLabelDelete MimeJSON

application/json

Defined in Vikunja.API.Labels

tasksTaskLabelsPut

tasksTaskLabelsPut

Arguments

:: (Consumes TasksTaskLabelsPut MimeJSON, MimeRender MimeJSON ModelsLabelTask)

=> ModelsLabelTask

"label" - The label object

-> Task

"task" - Task ID

-> VikunjaRequest TasksTaskLabelsPut MimeJSON ModelsLabelTask MimeJSON

PUT /tasks/{task}/labels

Add a label to a task

Add a label to a task. The user needs to have write-access to the project to be able do this.

AuthMethod: AuthApiKeyJWTKeyAuth

data TasksTaskLabelsPut

Instances

Produces TasksTaskLabelsPut MimeJSON

application/json

Defined in Vikunja.API.Labels

Consumes TasksTaskLabelsPut MimeJSON

application/json

Defined in Vikunja.API.Labels

HasBodyParam TasksTaskLabelsPut ModelsLabelTask

Body Param "label" - The label object

Defined in Vikunja.API.Labels

Methods

setBodyParam :: (Consumes TasksTaskLabelsPut contentType, MimeRender contentType ModelsLabelTask) => VikunjaRequest TasksTaskLabelsPut contentType res accept -> ModelsLabelTask -> VikunjaRequest TasksTaskLabelsPut contentType res accept