miniApps

Get list of miniApps

GET	{{baseUrl}}/orchestrator/api/miniapps/?name__iexact=<miniapp name>&group__iexact=<group name>	Gets the list of miniApps that the user has access to.

Click to see the details

Query Parameters

Request a miniApp which applies to these filters.

Name	Type	Description
`name__iexact`	string	The miniApp's name.
`group__iexact`	string	The miniApp's group.

Response (Success)

JSON

HTTP/1.1 200 OK

Returns list of miniApps.

Example

JSON

[
  {
    "id": "025c9ddd-2357-4415-8c55-466cbe44a548.corpus2.CorpusCollection.MiniApps.71a09bff46324414bdcd0377a0428ac4",
    "name": "corpus2",
    "type": "CorpusCollection",
    "diamantAppName": "MiniApps",
    "group": "ocp",
    "numbers": []
  },
  {
    "id": "025c9ddd-2357-4415-8c55-466cbe44a548.corpus3.CorpusCollection.MiniApps.e92b6e81c15c448e9972b0e4669e18bb",
    "name": "corpus3",
    "type": "CorpusCollection",
    "diamantAppName": "MiniApps",
    "group": "ocp",
    "numbers": [
      {
        "number": "+12244781692",
        "country": "US",
        "groupId": "ocp",
        "miniAppId": "025c9ddd-2357-4415-8c55-466cbe44a548.corpus3.CorpusCollection.MiniApps.e92b6e81c15c448e9972b0e4669e18bb",
        "locale": "en-US"
      }
    ]
  }
]

Get list of miniApps' custom properties

GET	{{baseUrl}}/orchestrator/api/miniapps/custom_properties/	Gets the list of miniApps' custom properties. The properties are grouped up accordingly.

Click to see the details

Query Parameters

A dictionary, which has the property that the UI sends back to the API as a key and the property attributes as a value.

Name	Type	Description
`full_name`	string	The property full name.
`custom_properties`	array[string]	The DiaManT related properties, which the given key refers to.

Response (Success)

JSON

HTTP/1.1 200 OK

Example

JSON

{
    "continuous_agent_requests": {
        "full_name": "Continuous agent requests",
        "custom_properties": [
            "continuousAgentRequestsMax"
        ]
    },
    "continuous_no_responses_allowed": {
        "full_name": "Continuous no responses allowed",
        "custom_properties": [
            "continuousNoInputsMax"
        ]
    },
    "continuous_no_interpretation_errors": {
        "full_name": "Continuous no interpretation errors",
        "custom_properties": [
            "continuousNoMatchesMax",
            "continuousSameStateEventsMax",
            "continuousLowConfRejectionsMax"
        ]
    },
    "continuous_mixed_errors": {
        "full_name": "Continuous mixed errors",
        "custom_properties": [
            "continuousErrorsMax"
        ]
    }
}