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/project_available_assignees...

115 lines
3.9 KiB

# /api/v3/projects/{id}/available_assignees
---
get:
parameters:
- description: Project id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_embedded:
elements:
- _links:
delete:
href: "/api/v3/users/1"
method: DELETE
title: Delete j.sheppard
lock:
href: "/api/v3/users/1/lock"
method: POST
title: Set lock on j.sheppard
self:
href: "/api/v3/users/1"
title: John Sheppard - j.sheppard
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20Z'
email: shep@mail.com
firstName: John
id: 1
lastName: Sheppard
login: j.sheppard
status: active
updatedAt: '2014-05-21T08:51:20Z'
- _links:
delete:
href: "/api/v3/users/2"
method: DELETE
title: Delete j.sheppard2
lock:
href: "/api/v3/users/2/lock"
method: POST
title: Set lock on j.sheppard2
self:
href: "/api/v3/users/2"
title: Jim Sheppard - j.sheppard2
_type: User
avatar: https://example.org/users/1/avatar
createdAt: '2014-05-21T08:51:20Z'
email: shep@mail.net
firstName: Jim
id: 2
lastName: Sheppard
login: j.sheppard2
status: active
updatedAt: '2014-05-21T08:51:20Z'
_links:
self:
href: "/api/v3/projects/42/available_assignees"
_type: Collection
count: 2
total: 2
schema:
"$ref": "../components/schemas/available_assignees_model.yml"
description: OK
headers: {}
'403':
content:
application/hal+json:
schema:
$ref: "../components/schemas/error_response.yml"
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to see the assignable users for this
project.
description: |-
Returned if the client does not have sufficient permissions.
**Required permission:** view work packages
*Note that you will only receive this error, if you are at least allowed to see the corresponding project.*
headers: {}
'404':
content:
application/hal+json:
schema:
$ref: "../components/schemas/error_response.yml"
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified project does not exist.
description: |-
Returned if the project does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view project
headers: {}
tags:
- Work Packages
description: Gets a list of users that can be assigned to work packages in the given
project.
operationId: Available_assignees
summary: Available assignees