Relationship.update¶
Update relationship fields.
Server: PATCH /api/foundry/relationships/{id}/ (409 when sealed).
Signature¶
update(**kwargs: Any) -> None
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
**kwargs |
Any |
no | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
relationship_id |
path |
string |
yes | - |
Fields¶
Schema: RelationshipUpdateSchema
| Field | Type | Required |
|---|---|---|
basis |
string |
no |
confidence |
string |
no |
object_id |
string |
no |
object_kind |
string |
no |
params |
object |
no |
relationship_type_id |
string |
no |
scope |
string |
no |
subject_id |
string |
no |
subject_kind |
string |
no |
Return shape¶
HTTP 200 — OK
Schema: RelationshipSchema
| Field | Type | Required |
|---|---|---|
basis |
string |
yes |
confidence |
string |
no |
id |
string |
yes |
object_id |
string |
yes |
object_kind |
string |
yes |
params |
object |
yes |
relationship_type_id |
string |
yes |
scope |
string |
yes |
sealed |
boolean |
yes |
subject_id |
string |
yes |
subject_kind |
string |
yes |
team_id |
string |
yes |
Permission¶
Required permission: admin
HTTP¶
PATCH /api/foundry/relationships/{id}/ (updateRelationship)
Usage¶
relationship.update()