PUT api/v2/items/{itemEntityId}/custodian
Sets custodian to item. Requires "Asset Administration -> Transfer Owner" privilege. Custodian can be provided by username (entity-id) or email or employee ID. Item should be active. Custodian account should not be locked.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| itemEntityId |
Item unique identifier |
string |
Required |
Body Parameters
Used to identify custodian. At least one property value which uniquely identify user should be provided: entity-id, email, employee-id. If multiple properties provided, they are tested in the order: entity-id, email, employee-id
CustodianData| Name | Description | Type | Additional information |
|---|---|---|---|
| custodian |
Object which identifies custodian |
UserSimple |
Required |
Request Formats
application/json, text/json
{
"custodian": {
"entity-id": "sample string 1",
"name": "sample string 2",
"email": "sample string 3",
"employee-id": "sample string 4",
"phone": "sample string 5"
}
}
Response Information
Resource Description
Returns HttpStatus 200, if succeded. Returns HttpStatus 404, if item or custodian not found. Returns HttpStatus 400, if failed. Check "X-Status-Description" header for error message.
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |