Model - Patch Closed List

Adds a batch of sublists to an existing list entity in a version of the application.

PATCH {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 entity 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
subLists

WordListObject[]

Sublists to add.

Responses

Name Type Description
200 OK

OperationStatus

Successfully added sublists to the list entity.

Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Add SubLists to Closed List Entity request

Sample request

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


{
  "subLists": [
    {
      "canonicalForm": "Texas",
      "list": [
        "tx",
        "texas"
      ]
    }
  ]
}

Sample response

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

Definitions

Name Description
ClosedListModelPatchObject

Object model for adding a batch of sublists to an existing 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.

ClosedListModelPatchObject

Object model for adding a batch of sublists to an existing list entity.

Name Type Description
subLists

WordListObject[]

Sublists to add.

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

WordListObject

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.