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.
130 lines
4.3 KiB
130 lines
4.3 KiB
# /api/v3/relations/{id}/form
|
|
---
|
|
post:
|
|
parameters:
|
|
- description: ID of the relation being modified
|
|
example: '1'
|
|
in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/hal+json:
|
|
examples:
|
|
response:
|
|
value:
|
|
_embedded:
|
|
payload:
|
|
_links:
|
|
from:
|
|
href: "/api/v3/work_packages/4534"
|
|
to:
|
|
href: "/api/v3/work_packages/3857"
|
|
_type: WorkPackage
|
|
delay: 3
|
|
description: let it rest for 3 days
|
|
type: follows
|
|
schema:
|
|
_links:
|
|
self:
|
|
href: "/api/v3/relations/schema"
|
|
_type: Schema
|
|
delay:
|
|
name: Delay
|
|
type: Integer
|
|
writable: true
|
|
description:
|
|
name: Description
|
|
type: String
|
|
writable: true
|
|
from:
|
|
name: From work package
|
|
type: WorkPackage
|
|
writeable: false
|
|
id:
|
|
name: ID
|
|
type: Integer
|
|
writable: false
|
|
reverseType:
|
|
name: Reverse Type
|
|
type: String
|
|
writable: false
|
|
to:
|
|
name: To work package
|
|
type: WorkPackage
|
|
writable: false
|
|
type:
|
|
allowedValues:
|
|
- relates
|
|
- duplicates
|
|
- duplicated
|
|
- blocks
|
|
- blocked
|
|
- precedes
|
|
- follows
|
|
- includes
|
|
- partof
|
|
- requires
|
|
- required
|
|
name: Type
|
|
type: String
|
|
writable: true
|
|
validationErrors:
|
|
from:
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:BadExampleError
|
|
message: For the purpose of this example we need a validation
|
|
error. The remainder of the response pretends there were no
|
|
errors.
|
|
_links:
|
|
commit:
|
|
href: "/api/v3/relations"
|
|
method: PATCH
|
|
self:
|
|
href: "/api/v3/relations/form"
|
|
validate:
|
|
href: "/api/v3/relations/form"
|
|
method: POST
|
|
_type: Form
|
|
schema:
|
|
"$ref": "../components/schemas/relation_edit_form_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 allowed to edit the specified relation.
|
|
description: |-
|
|
Returned if the client does not have sufficient permissions.
|
|
|
|
**Required permission:** manage work package relations
|
|
|
|
*Note that you will only receive this error, if you are at least allowed to see the involved work packages.*
|
|
headers: {}
|
|
'404':
|
|
content:
|
|
application/hal+json:
|
|
examples:
|
|
response:
|
|
value:
|
|
_type: Error
|
|
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
|
|
message: The specified relation does not exist.
|
|
description: |-
|
|
Returned if the relation does not exist or the client does not have sufficient permissions to see it.
|
|
|
|
**Required permission:** view (involved) work package(s), manage work package relations
|
|
headers: {}
|
|
tags:
|
|
- Relations
|
|
description: ''
|
|
operationId: Relation_edit_form
|
|
summary: Relation edit form
|
|
|