Vikunja.API.Project

Operations

Project

backgroundsUnsplashImageImageGet

backgroundsUnsplashImageImageGet

Arguments

:: Image

"image" - Unsplash Image ID

-> VikunjaRequest BackgroundsUnsplashImageImageGet MimeNoContent FilePath MimeOctetStream

GET /backgrounds/unsplash/image/{image}

Get an unsplash image

Get an unsplash image. **Returns json on error.**

AuthMethod: AuthApiKeyJWTKeyAuth

data BackgroundsUnsplashImageImageGet

Instances

Produces BackgroundsUnsplashImageImageGet MimeOctetStream

application/octet-stream

Defined in Vikunja.API.Project

backgroundsUnsplashImageImageThumbGet

backgroundsUnsplashImageImageThumbGet

Arguments

:: Image

"image" - Unsplash Image ID

-> VikunjaRequest BackgroundsUnsplashImageImageThumbGet MimeNoContent FilePath MimeOctetStream

GET /backgrounds/unsplash/image/{image}/thumb

Get an unsplash thumbnail image

Get an unsplash thumbnail image. The thumbnail is cropped to a max width of 200px. **Returns json on error.**

AuthMethod: AuthApiKeyJWTKeyAuth

data BackgroundsUnsplashImageImageThumbGet

Instances

Produces BackgroundsUnsplashImageImageThumbGet MimeOctetStream

application/octet-stream

Defined in Vikunja.API.Project

backgroundsUnsplashSearchGet

backgroundsUnsplashSearchGet :: VikunjaRequest BackgroundsUnsplashSearchGet MimeNoContent [BackgroundImage] MimeJSON

GET /backgrounds/unsplash/search

Search for a background from unsplash

Search for a project background from unsplash

AuthMethod: AuthApiKeyJWTKeyAuth

data BackgroundsUnsplashSearchGet

Instances

Produces BackgroundsUnsplashSearchGet MimeJSON

application/json

Defined in Vikunja.API.Project

HasOptionalParam BackgroundsUnsplashSearchGet S

Optional Param "s" - Search backgrounds from unsplash with this search term.

Defined in Vikunja.API.Project

Methods

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

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

HasOptionalParam BackgroundsUnsplashSearchGet P

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

Defined in Vikunja.API.Project

Methods

applyOptionalParam :: VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept -> P -> VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept

(-&-) :: VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept -> P -> VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept

projectsGet

projectsGet :: VikunjaRequest ProjectsGet MimeNoContent [ModelsProject] MimeJSON

GET /projects

Get all projects a user has access to

Returns all projects a user has access to.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsGet

Instances

Produces ProjectsGet MimeJSON

application/json

Defined in Vikunja.API.Project

HasOptionalParam ProjectsGet S

Optional Param "s" - Search projects by title.

Defined in Vikunja.API.Project

Methods

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

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

HasOptionalParam ProjectsGet 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.Project

Methods

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

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

HasOptionalParam ProjectsGet Page

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

Defined in Vikunja.API.Project

Methods

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

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

HasOptionalParam ProjectsGet IsArchived

Optional Param "is_archived" - If true, also returns all archived projects.

Defined in Vikunja.API.Project

Methods

applyOptionalParam :: VikunjaRequest ProjectsGet contentType res accept -> IsArchived -> VikunjaRequest ProjectsGet contentType res accept

(-&-) :: VikunjaRequest ProjectsGet contentType res accept -> IsArchived -> VikunjaRequest ProjectsGet contentType res accept

projectsIdBackgroundDelete

projectsIdBackgroundDelete

Arguments

:: Id

"id" - Project ID

-> VikunjaRequest ProjectsIdBackgroundDelete MimeNoContent ModelsProject MimeJSON

DELETE /projects/{id}/background

Remove a project background

Removes a previously set project background, regardless of the project provider used to set the background. It does not throw an error if the project does not have a background.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdBackgroundDelete

Instances

Produces ProjectsIdBackgroundDelete MimeJSON

application/json

Defined in Vikunja.API.Project

projectsIdBackgroundGet

projectsIdBackgroundGet

Arguments

:: Id

"id" - Project ID

-> VikunjaRequest ProjectsIdBackgroundGet MimeNoContent FilePath MimeOctetStream

GET /projects/{id}/background

Get the project background

Get the project background of a specific project. **Returns json on error.**

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdBackgroundGet

Instances

Produces ProjectsIdBackgroundGet MimeOctetStream

application/octet-stream

Defined in Vikunja.API.Project

projectsIdBackgroundsUnsplashPost

projectsIdBackgroundsUnsplashPost

Arguments

:: (Consumes ProjectsIdBackgroundsUnsplashPost MimeJSON, MimeRender MimeJSON BackgroundImage)

=> BackgroundImage

"project" - The image you want to set as background

-> Id

"id" - Project ID

-> VikunjaRequest ProjectsIdBackgroundsUnsplashPost MimeJSON ModelsProject MimeJSON

POST /projects/{id}/backgrounds/unsplash

Set an unsplash photo as project background

Sets a photo from unsplash as project background.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdBackgroundsUnsplashPost

Instances

Produces ProjectsIdBackgroundsUnsplashPost MimeJSON

application/json

Defined in Vikunja.API.Project

Consumes ProjectsIdBackgroundsUnsplashPost MimeJSON

application/json

Defined in Vikunja.API.Project

HasBodyParam ProjectsIdBackgroundsUnsplashPost BackgroundImage

Body Param "project" - The image you want to set as background

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsIdBackgroundsUnsplashPost contentType, MimeRender contentType BackgroundImage) => VikunjaRequest ProjectsIdBackgroundsUnsplashPost contentType res accept -> BackgroundImage -> VikunjaRequest ProjectsIdBackgroundsUnsplashPost contentType res accept

projectsIdBackgroundsUploadPut

projectsIdBackgroundsUploadPut

Arguments

:: Consumes ProjectsIdBackgroundsUploadPut MimeMultipartFormData

=> Background

"background" - The file as single file.

-> Id

"id" - Project ID

-> VikunjaRequest ProjectsIdBackgroundsUploadPut MimeMultipartFormData ModelsMessage MimeJSON

PUT /projects/{id}/backgrounds/upload

Upload a project background

Upload a project background.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdBackgroundsUploadPut

Instances

Produces ProjectsIdBackgroundsUploadPut MimeJSON

application/json

Defined in Vikunja.API.Project

Consumes ProjectsIdBackgroundsUploadPut MimeMultipartFormData

multipart/form-data

Defined in Vikunja.API.Project

projectsIdDelete

projectsIdDelete

Arguments

:: Id

"id" - Project ID

-> VikunjaRequest ProjectsIdDelete MimeNoContent ModelsMessage MimeJSON

DELETE /projects/{id}

Deletes a project

Delets a project

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdDelete

Instances

Produces ProjectsIdDelete MimeJSON

application/json

Defined in Vikunja.API.Project

projectsIdGet

projectsIdGet

Arguments

:: Id

"id" - Project ID

-> VikunjaRequest ProjectsIdGet MimeNoContent ModelsProject MimeJSON

GET /projects/{id}

Gets one project

Returns a project by its ID.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdGet

Instances

Produces ProjectsIdGet MimeJSON

application/json

Defined in Vikunja.API.Project

projectsIdPost

projectsIdPost

Arguments

:: (Consumes ProjectsIdPost MimeJSON, MimeRender MimeJSON ModelsProject)

=> ModelsProject

"project" - The project with updated values you want to update.

-> Id

"id" - Project ID

-> VikunjaRequest ProjectsIdPost MimeJSON ModelsProject MimeJSON

POST /projects/{id}

Updates a project

Updates a project. This does not include adding a task (see below).

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdPost

Instances

Produces ProjectsIdPost MimeJSON

application/json

Defined in Vikunja.API.Project

Consumes ProjectsIdPost MimeJSON

application/json

Defined in Vikunja.API.Project

HasBodyParam ProjectsIdPost ModelsProject

Body Param "project" - The project with updated values you want to update.

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsIdPost contentType, MimeRender contentType ModelsProject) => VikunjaRequest ProjectsIdPost contentType res accept -> ModelsProject -> VikunjaRequest ProjectsIdPost contentType res accept

projectsIdProjectusersGet

projectsIdProjectusersGet

Arguments

:: Id

"id" - Project ID

-> VikunjaRequest ProjectsIdProjectusersGet MimeNoContent [UserUser] MimeJSON

GET /projects/{id}/projectusers

Get users

Lists all users (without emailadresses). Also possible to search for a specific user.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdProjectusersGet

Instances

Produces ProjectsIdProjectusersGet MimeJSON

application/json

Defined in Vikunja.API.Project

HasOptionalParam ProjectsIdProjectusersGet S

Optional Param "s" - Search for a user by its name.

Defined in Vikunja.API.Project

Methods

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

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

projectsIdViewsViewBucketsGet

projectsIdViewsViewBucketsGet

Arguments

:: Id

"id" - Project ID

-> View

"view" - Project view ID

-> VikunjaRequest ProjectsIdViewsViewBucketsGet MimeNoContent [ModelsBucket] MimeJSON

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

Get all kanban buckets of a project

Returns all kanban buckets which belong to that project. Buckets are always sorted by their position in ascending order. To get all buckets with their tasks, use the tasks endpoint with a kanban view.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdViewsViewBucketsGet

Instances

Produces ProjectsIdViewsViewBucketsGet MimeJSON

application/json

Defined in Vikunja.API.Project

projectsIdViewsViewBucketsPut

projectsIdViewsViewBucketsPut

Arguments

:: (Consumes ProjectsIdViewsViewBucketsPut MimeJSON, MimeRender MimeJSON ModelsBucket)

=> ModelsBucket

"bucket" - The bucket object

-> Id

"id" - Project Id

-> View

"view" - Project view ID

-> VikunjaRequest ProjectsIdViewsViewBucketsPut MimeJSON ModelsBucket MimeJSON

PUT /projects/{id}/views/{view}/buckets

Create a new bucket

Creates a new kanban bucket on a project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdViewsViewBucketsPut

Instances

Produces ProjectsIdViewsViewBucketsPut MimeJSON

application/json

Defined in Vikunja.API.Project

Consumes ProjectsIdViewsViewBucketsPut MimeJSON

application/json

Defined in Vikunja.API.Project

HasBodyParam ProjectsIdViewsViewBucketsPut ModelsBucket

Body Param "bucket" - The bucket object

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsIdViewsViewBucketsPut contentType, MimeRender contentType ModelsBucket) => VikunjaRequest ProjectsIdViewsViewBucketsPut contentType res accept -> ModelsBucket -> VikunjaRequest ProjectsIdViewsViewBucketsPut contentType res accept

projectsProjectIDDuplicatePut

projectsProjectIDDuplicatePut

Arguments

:: (Consumes ProjectsProjectIDDuplicatePut MimeJSON, MimeRender MimeJSON ModelsProjectDuplicate)

=> ModelsProjectDuplicate

"project" - The target parent project which should hold the copied project.

-> ProjectId

"projectId" - The project ID to duplicate

-> VikunjaRequest ProjectsProjectIDDuplicatePut MimeJSON ModelsProjectDuplicate MimeJSON

PUT /projects/{projectID}/duplicate

Duplicate an existing project

Copies the project, tasks, files, kanban data, assignees, comments, attachments, lables, relations, backgrounds, user/team rights and link shares from one project to a new one. The user needs read access in the project and write access in the parent of the new project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectIDDuplicatePut

Instances

Produces ProjectsProjectIDDuplicatePut MimeJSON

application/json

Defined in Vikunja.API.Project

Consumes ProjectsProjectIDDuplicatePut MimeJSON

application/json

Defined in Vikunja.API.Project

HasBodyParam ProjectsProjectIDDuplicatePut ModelsProjectDuplicate

Body Param "project" - The target parent project which should hold the copied project.

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsProjectIDDuplicatePut contentType, MimeRender contentType ModelsProjectDuplicate) => VikunjaRequest ProjectsProjectIDDuplicatePut contentType res accept -> ModelsProjectDuplicate -> VikunjaRequest ProjectsProjectIDDuplicatePut contentType res accept

projectsProjectIDViewsViewBucketsBucketIDDelete

projectsProjectIDViewsViewBucketsBucketIDDelete

Arguments

:: ProjectId

"projectId" - Project Id

-> BucketId

"bucketId" - Bucket Id

-> View

"view" - Project view ID

-> VikunjaRequest ProjectsProjectIDViewsViewBucketsBucketIDDelete MimeNoContent ModelsMessage MimeJSON

DELETE /projects/{projectID}/views/{view}/buckets/{bucketID}

Deletes an existing bucket

Deletes an existing kanban bucket and dissociates all of its task. It does not delete any tasks. You cannot delete the last bucket on a project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectIDViewsViewBucketsBucketIDDelete

Instances

Produces ProjectsProjectIDViewsViewBucketsBucketIDDelete MimeJSON

application/json

Defined in Vikunja.API.Project

projectsProjectIDViewsViewBucketsBucketIDPost

projectsProjectIDViewsViewBucketsBucketIDPost

Arguments

:: (Consumes ProjectsProjectIDViewsViewBucketsBucketIDPost MimeJSON, MimeRender MimeJSON ModelsBucket)

=> ModelsBucket

"bucket" - The bucket object

-> ProjectId

"projectId" - Project Id

-> BucketId

"bucketId" - Bucket Id

-> View

"view" - Project view ID

-> VikunjaRequest ProjectsProjectIDViewsViewBucketsBucketIDPost MimeJSON ModelsBucket MimeJSON

POST /projects/{projectID}/views/{view}/buckets/{bucketID}

Update an existing bucket

Updates an existing kanban bucket.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectIDViewsViewBucketsBucketIDPost

Instances

Produces ProjectsProjectIDViewsViewBucketsBucketIDPost MimeJSON

application/json

Defined in Vikunja.API.Project

Consumes ProjectsProjectIDViewsViewBucketsBucketIDPost MimeJSON

application/json

Defined in Vikunja.API.Project

HasBodyParam ProjectsProjectIDViewsViewBucketsBucketIDPost ModelsBucket

Body Param "bucket" - The bucket object

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsProjectIDViewsViewBucketsBucketIDPost contentType, MimeRender contentType ModelsBucket) => VikunjaRequest ProjectsProjectIDViewsViewBucketsBucketIDPost contentType res accept -> ModelsBucket -> VikunjaRequest ProjectsProjectIDViewsViewBucketsBucketIDPost contentType res accept

projectsProjectViewsGet

projectsProjectViewsGet

Arguments

:: Project

"project" - Project ID

-> VikunjaRequest ProjectsProjectViewsGet MimeNoContent [ModelsProjectView] MimeJSON

GET /projects/{project}/views

Get all project views for a project

Returns all project views for a sepcific project

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectViewsGet

Instances

Produces ProjectsProjectViewsGet MimeJSON

application/json

Defined in Vikunja.API.Project

projectsProjectViewsIdDelete

projectsProjectViewsIdDelete

Arguments

:: Project

"project" - Project ID

-> Id

"id" - Project View ID

-> VikunjaRequest ProjectsProjectViewsIdDelete MimeNoContent ModelsMessage MimeJSON

DELETE /projects/{project}/views/{id}

Delete a project view

Deletes a project view.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectViewsIdDelete

Instances

Produces ProjectsProjectViewsIdDelete MimeJSON

application/json

Defined in Vikunja.API.Project

projectsProjectViewsIdGet

projectsProjectViewsIdGet

Arguments

:: Project

"project" - Project ID

-> Id

"id" - Project View ID

-> VikunjaRequest ProjectsProjectViewsIdGet MimeNoContent ModelsProjectView MimeJSON

GET /projects/{project}/views/{id}

Get one project view

Returns a project view by its ID.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectViewsIdGet

Instances

Produces ProjectsProjectViewsIdGet MimeJSON

application/json

Defined in Vikunja.API.Project

projectsProjectViewsIdPost

projectsProjectViewsIdPost

Arguments

:: (Consumes ProjectsProjectViewsIdPost MimeJSON, MimeRender MimeJSON ModelsProjectView)

=> ModelsProjectView

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

-> Project

"project" - Project ID

-> Id

"id" - Project View ID

-> VikunjaRequest ProjectsProjectViewsIdPost MimeJSON ModelsProjectView MimeJSON

POST /projects/{project}/views/{id}

Updates a project view

Updates a project view.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectViewsIdPost

Instances

Produces ProjectsProjectViewsIdPost MimeJSON

application/json

Defined in Vikunja.API.Project

Consumes ProjectsProjectViewsIdPost MimeJSON

application/json

Defined in Vikunja.API.Project

HasBodyParam ProjectsProjectViewsIdPost ModelsProjectView

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

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsProjectViewsIdPost contentType, MimeRender contentType ModelsProjectView) => VikunjaRequest ProjectsProjectViewsIdPost contentType res accept -> ModelsProjectView -> VikunjaRequest ProjectsProjectViewsIdPost contentType res accept

projectsProjectViewsPut

projectsProjectViewsPut

Arguments

:: (Consumes ProjectsProjectViewsPut MimeJSON, MimeRender MimeJSON ModelsProjectView)

=> ModelsProjectView

"view" - The project view you want to create.

-> Project

"project" - Project ID

-> VikunjaRequest ProjectsProjectViewsPut MimeJSON ModelsProjectView MimeJSON

PUT /projects/{project}/views

Create a project view

Create a project view in a specific project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectViewsPut

Instances

Produces ProjectsProjectViewsPut MimeJSON

application/json

Defined in Vikunja.API.Project

Consumes ProjectsProjectViewsPut MimeJSON

application/json

Defined in Vikunja.API.Project

HasBodyParam ProjectsProjectViewsPut ModelsProjectView

Body Param "view" - The project view you want to create.

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsProjectViewsPut contentType, MimeRender contentType ModelsProjectView) => VikunjaRequest ProjectsProjectViewsPut contentType res accept -> ModelsProjectView -> VikunjaRequest ProjectsProjectViewsPut contentType res accept

projectsPut

projectsPut

Arguments

:: (Consumes ProjectsPut MimeJSON, MimeRender MimeJSON ModelsProject)

=> ModelsProject

"project" - The project you want to create.

-> VikunjaRequest ProjectsPut MimeJSON ModelsProject MimeJSON

PUT /projects

Creates a new project

Creates a new project. If a parent project is provided the user needs to have write access to that project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsPut

Instances

Produces ProjectsPut MimeJSON

application/json

Defined in Vikunja.API.Project

Consumes ProjectsPut MimeJSON

application/json

Defined in Vikunja.API.Project

HasBodyParam ProjectsPut ModelsProject

Body Param "project" - The project you want to create.

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsPut contentType, MimeRender contentType ModelsProject) => VikunjaRequest ProjectsPut contentType res accept -> ModelsProject -> VikunjaRequest ProjectsPut contentType res accept