Share via

Model - Update Closed List

Service:
Azure AI Services
API Version:
2.0

Updates the list entity in a version of the application.

PUT {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}

URI Parameters

Name In Required Type Description
appId
 path True

string (uuid)

The application ID.
clEntityId
 path True

string (uuid)

The list model ID.
Endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
versionId
 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 new name of the list entity.
subLists

WordListObject[]

The new sublists for the feature.

Responses

Name Type Description
200 OK

OperationStatus

Successfully updated list entity name and words list.
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Update Closed List Entity Info request

Sample request

PUT {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/d1f95436-57ac-4524-ae81-5bdd32668ccf


{
  "name": "States",
  "subLists": [
    {
      "canonicalForm": "Texas",
      "list": [
        "TX",
        "Texas"
      ]
    }
  ]
}

Sample response

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

Definitions

Name Description
ClosedListModelUpdateObject

Object model for updating a list entity.
ErrorResponse

Error response when invoking an operation on the API.
OperationStatus

Response of an Operation status.
OperationStatusType

Status Code.
WordListObject

Sublist of items for a list entity.

ClosedListModelUpdateObject

Object

Object model for updating a list entity.

Name Type Description
name

string

The new name of the list entity.
subLists

WordListObject[]

The new sublists for the feature.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name Type Description
errorType

string

OperationStatus

Object

Response of an Operation status.

Name Type Description
code

OperationStatusType

Status Code.
message

string

Status details.

OperationStatusType

Enumeration

Status Code.

Value Description
Failed
FAILED
Success

WordListObject

Object

Sublist of items for a list entity.

Name Type Description
canonicalForm

string

The standard form that the list represents.
list

string[]

List of synonym words.