Model - Update Hierarchical Entity Role
Update a role for a given hierarchical entity in a version of the application.
PUT {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles/{roleId}URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
app
|
path | True |
string uuid |
The application ID. |
|
Endpoint
|
path | True |
string |
Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
|
h
|
path | True |
string uuid |
The hierarchical entity extractor ID. |
|
role
|
path | True |
string uuid |
The entity role ID. |
|
version
|
path | True |
string |
The version ID. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | True |
string |
Request Body
| Name | Type | Description |
|---|---|---|
| name |
string |
The entity role name. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Successfully updated the entity role. |
|
| Other Status Codes |
Error Response. |
Security
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Examples
Successful Update Hierarchical Entity Extractor Role request
Sample request
PUT {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/hierarchicalentities/3d73462d-98f0-4dcd-8d30-fab9e65f2e73/roles/6dbed7e2-7df6-4cd6-a225-97e6fbe4493d
{
"name": "New Name"
}
Sample response
{
"code": "Success",
"message": "Operation Successful"
}Definitions
| Name | Description |
|---|---|
|
Entity |
Object model for updating an entity role. |
|
Error |
Error response when invoking an operation on the API. |
|
Operation |
Response of an Operation status. |
|
Operation |
Status Code. |
EntityRoleUpdateObject
Object model for updating an entity role.
| Name | Type | Description |
|---|---|---|
| name |
string |
The entity role name. |
ErrorResponse
Error response when invoking an operation on the API.
| Name | Type | Description |
|---|---|---|
| errorType |
string |
OperationStatus
Response of an Operation status.
| Name | Type | Description |
|---|---|---|
| code |
Status Code. |
|
| message |
string |
Status details. |
OperationStatusType
Status Code.
| Name | Type | Description |
|---|---|---|
| FAILED |
string |
|
| Failed |
string |
|
| Success |
string |