Apps - Get

Service:

Azure AI Services

API Version:

2.0

Gets the application info.

GET {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

Responses

Name	Type	Description
200 OK	ApplicationInfoResponse	The application info.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Application Info request

Sample request

HTTP

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

Sample response

Status code:

200

{
  "id": "363187f1-c573-46b3-bc4c-ae01d686e68e",
  "name": "MyFirstDummyAp",
  "description": "This is my first dummy application",
  "culture": "en-us",
  "usageScenario": "IoT",
  "domain": "Comics",
  "versionsCount": 3,
  "createdDateTime": "2017-01-31T16:15:54Z",
  "endpoints": {
    "PRODUCTION": {
      "versionId": "0.1",
      "isStaging": false,
      "endpointUrl": "DummyUrl",
      "endpointRegion": "westus",
      "assignedEndpointKey": "",
      "publishedDateTime": "2017-02-19T17:09:14Z"
    }
  },
  "endpointHitsCount": 0
}

Definitions

Name	Description
ApplicationInfoResponse	Response containing the Application Info.
ErrorResponse	Error response when invoking an operation on the API.

ApplicationInfoResponse

Object

Response containing the Application Info.

Name	Type	Description
activeVersion	string	The version ID currently marked as active.
createdDateTime	string	The version's creation timestamp.
culture	string	The culture of the application. For example, "en-us".
description	string	The description of the application.
domain	string	The domain for the new application. Optional. For example, Comics.
endpointHitsCount	integer	Number of calls made to this endpoint.
endpoints	object	The Runtime endpoint URL for this model version.
id	string	The ID (GUID) of the application.
name	string	The name of the application.
usageScenario	string	Defines the scenario for the new application. Optional. For example, IoT.
versionsCount	integer	Amount of model versions within the application.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string