Apps - Update

Reference

Service:: Azure AI Services

API Version:: 2.0

Updates the name or description of the application.

PUT {Endpoint}/luis/api/v2.0/apps/{appId}

URI Parameters

Name	In	Required	Type	Description
appId	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).

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

Request Body

Name	Type	Description
description	string	The application's new description.
name	string	The application's new name.

Responses

Name	Type	Description
200 OK	OperationStatus	Successfully updated application name and description.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Rename Application request

Sample request

HTTP

PUT {Endpoint}/luis/api/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e


{
  "name": "LUIS App name updated",
  "description": "LUIS App description updated"
}

Sample response

Status code:: 200

{
  "code": "Success",
  "message": "Operation Successful"
}

Definitions

Name	Description
ApplicationUpdateObject	Object model for updating the name or description of an application.
ErrorResponse	Error response when invoking an operation on the API.
OperationStatus	Response of an Operation status.
OperationStatusType	Status Code.

ApplicationUpdateObject

Object model for updating the name or description of an application.

Name	Type	Description
description	string	The application's new description.
name	string	The application's new 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	OperationStatusType	Status Code.
message	string	Status details.

OperationStatusType

Status Code.

Name	Type	Description
FAILED	string
Failed	string
Success	string

Share via