OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/docs/api/apiv3/paths/work_package_available_proj...

119 lines
4.5 KiB

# /api/v3/work_packages/{id}/available_projects
---
get:
parameters:
- description: work package id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
categories:
href: "/api/v3/projects/6/categories"
createWorkPackage:
href: "/api/v3/projects/6/work_packages/form"
method: post
createWorkPackageImmediate:
href: "/api/v3/projects/6/work_packages"
method: post
editWorkPackage:
href: "/api/v3//work_packages/{id}/form"
method: post
templated: true
self:
href: "/api/v3/projects/6"
title: A project
versions:
href: "/api/v3/projects/6/versions"
_type: Project
createdAt: '2015-07-06T13:28:14+00:00'
description: Eveniet molestias omnis quis aut qui eum adipisci.
Atque aut aut in exercitationem adipisci amet. Nisi asperiores
quia ratione veritatis enim exercitationem magnam. Aut fuga
architecto adipisci nihil. Et repellat pariatur. Aliquam et
sed perferendis nostrum quaerat. Fugit doloremque voluptatem.
id: 6
identifier: a_project
name: A project
type: Customer Project
updatedAt: '2015-10-01T09:55:02+00:00'
- _links:
categories:
href: "/api/v3/projects/14/categories"
createWorkPackage:
href: "/api/v3/projects/14/work_packages/form"
method: post
createWorkPackageImmediate:
href: "/api/v3/projects/14/work_packages"
method: post
self:
href: "/api/v3/projects/14"
title: Another project
versions:
href: "/api/v3/projects/14/versions"
_type: Project
createdAt: '2016-02-29T12:50:20+00:00'
description: ''
id: 14
identifier: another_project
name: Another project
type:
updatedAt: '2016-02-29T12:50:20+00:00'
_links:
self:
href: "/api/v3/work_packages/5/available_projects"
_type: Collection
count: 2
total: 2
schema:
"$ref": "../components/schemas/available_projects_for_work_package_model.yml"
description: OK
headers: {}
'403':
content:
application/hal+json:
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: |-
Returned if the client does not have sufficient permissions.
**Required permission:** edit work package
*Note that you will only receive this error, if you are at least allowed to see the corresponding work package.*
headers: {}
'404':
content:
application/hal+json:
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified work package does not exist.
description: |-
Returned if the work package does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work package
headers: {}
tags:
- Work Packages
description: Gets a list of projects that are available as projects to which the
work package can be moved.
operationId: Available_projects_for_work_package
summary: Available projects for work package