kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
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.
73 lines
2.2 KiB
73 lines
2.2 KiB
3 years ago
|
# /api/v3/work_packages/schemas/
|
||
|
|
---
|
||
|
|
get:
|
||
|
|
parameters:
|
||
|
|
- description: |-
|
||
|
|
JSON specifying filter conditions.
|
||
|
|
Accepts the same format as returned by the [queries](#queries) endpoint. Currently supported filters are:
|
||
|
|
|
||
|
|
+ id: The schema's id
|
||
|
|
example: '[{ "id": { "operator": "=", "values": ["12-1", "14-2"] } }]'
|
||
|
|
in: query
|
||
|
|
name: filters
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
responses:
|
||
|
|
'200':
|
||
|
|
content:
|
||
|
|
application/hal+json:
|
||
|
|
examples:
|
||
|
|
response:
|
||
|
|
value:
|
||
|
|
_embedded:
|
||
|
|
elements:
|
||
|
|
- _links:
|
||
|
|
self:
|
||
|
|
href: "/api/v3/work_packages/schemas/13-1"
|
||
|
|
_type: Schema...
|
||
|
|
- _links:
|
||
|
|
self:
|
||
|
|
href: "/api/v3/work_packages/schemas/7-6"
|
||
|
|
_type: Schema...
|
||
|
|
_links:
|
||
|
|
self:
|
||
|
|
href: "/api/v3/work_packages/schemas"
|
||
|
|
_type: Collection
|
||
|
|
count: 2
|
||
|
|
total: 5
|
||
|
|
schema:
|
||
|
|
"$ref": "../components/schemas/work_package_schemas_model.yml"
|
||
|
|
description: OK
|
||
|
|
headers: {}
|
||
|
|
'400':
|
||
|
|
content:
|
||
|
|
application/hal+json:
|
||
|
|
examples:
|
||
|
|
response:
|
||
|
|
value:
|
||
|
|
_type: Error
|
||
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery
|
||
|
|
message: Unknown filter.
|
||
|
|
description: Returned if the client sends invalid request.
|
||
|
|
headers: {}
|
||
|
|
'403':
|
||
|
|
content:
|
||
|
|
application/hal+json:
|
||
|
|
examples:
|
||
|
|
response:
|
||
|
|
value:
|
||
|
|
_type: Error
|
||
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
|
||
|
|
message: You are not allowed to list schemas.
|
||
|
|
description: |-
|
||
|
|
Returned if the client does not have sufficient permissions.
|
||
|
|
|
||
|
|
**Required permission:** View work packages in any project.
|
||
|
|
headers: {}
|
||
|
|
tags:
|
||
|
|
- Work Packages
|
||
|
|
description: List work package schemas.
|
||
|
|
operationId: List_Work_Package_Schemas
|
||
|
|
summary: List Work Package Schemas
|