openapi-directory/api/azure.com/cognitiveservices-LUIS-Authoring.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"LUIS Authoring Client","version":"3.0-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"cognitiveservices-LUIS-Authoring","x-tags":["Azure","Microsoft"]},"security":[{"apiKeyHeader":[]}],"paths":{"/apps/":{"get":{"description":"Lists all of the user's applications.","operationId":"Apps_List","parameters":[{"$ref":"#/components/parameters/SkipInPath"},{"$ref":"#/components/parameters/TakeInPath"}],"responses":{"200":{"description":"A list of the user applications.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsInfoList"},"examples":{"Successful Get Applications List request":{"$ref":"#/components/examples/Successful_Get_Applications_List_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"description":"Creates a new LUIS app.","operationId":"Apps_Add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreateObject"}}},"description":"An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is \"0.1\". Note: the culture cannot be changed after the app is created.","required":true},"responses":{"201":{"description":"The ID of the created application.","x-nullable":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuidResponse"},"examples":{"Successful Application Creation":{"$ref":"#/components/examples/Successful_Application_Creation"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/assistants":{"get":{"description":"Gets the endpoint URLs for the prebuilt Cortana applications.","operationId":"Apps_ListCortanaEndpoints","responses":{"200":{"description":"A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalAssistantsResponse"},"examples":{"Successful Get Personal Assistant Applications":{"$ref":"#/components/examples/Successful_Get_Personal_Assistant_Applications"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/cultures":{"get":{"description":"Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,\"en-us\" represents the U.S. variation of English.","operationId":"Apps_ListSupportedCultures","responses":{"200":{"description":"A list object containing the supported application cultures.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableCultures"},"examples":{"Successful Get Application Cultures request":{"$ref":"#/components/examples/Successful_Get_Application_Cultures_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/customprebuiltdomains":{"get":{"description":"Gets all the available custom prebuilt domains for all cultures.","operationId":"Apps_ListAvailableCustomPrebuiltDomains","responses":{"200":{"description":"Returns a list of all custom prebuilt domains and their intents/entities representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrebuiltDomainsList"},"examples":{"Successful Get Available Custom Prebuilt Domains request":{"$ref":"#/components/examples/Successful_Get_Available_Custom_Prebuilt_Domains_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"description":"Adds a prebuilt domain along with its intent and entity models as a new application.","operationId":"Apps_AddCustomPrebuiltDomain","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrebuiltDomainCreateObject"}}},"description":"A prebuilt domain create object containing the name and culture of the domain.","required":true},"responses":{"201":{"description":"The ID of the created application.","x-nullable":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuidResponse"},"examples":{"Successful Add Custom Prebuilt Application request":{"$ref":"#/components/examples/Successful_Add_Custom_Prebuilt_Application_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/customprebuiltdomains/{culture}":{"get":{"description":"Gets all the available prebuilt domains for a specific culture.","operationId":"Apps_ListAvailableCustomPrebuiltDomainsForCulture","parameters":[{"description":"Culture.","in":"path","name":"culture","required":true,"schema":{"type":"string"},"examples":{"Successful Get AvailableCustomPrebuiltDomainsForCulture request":{"value":"{culture}"}}}],"responses":{"200":{"description":"Returns a list of all domains and their intents and entities for a specific culture.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrebuiltDomainsList"},"examples":{"Successful Get AvailableCustomPrebuiltDomainsForCulture request":{"$ref":"#/components/examples/Successful_Get_AvailableCustomPrebuiltDomainsForCulture_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/domains":{"get":{"description":"Gets the available application domains.","operationId":"Apps_ListDomains","responses":{"200":{"description":"A list object containing the available application domains.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableDomains"},"examples":{"Successful Get Application Domains request":{"$ref":"#/components/examples/Successful_Get_Application_Domains_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/import":{"post":{"description":"Imports an application to LUIS, the application's structure is included in the request body.","operationId":"Apps_Import","parameters":[{"description":"The application name to create. If not specified, the application name will be read from the imported object. If the application name already exists, an error is returned.","in":"query","name":"appName","schema":{"type":"string"},"examples":{"Successful Import Application":{"value":"Test LUIS App"}}}],"requestBody":{"$ref":"#/components/requestBodies/LuisApp"},"responses":{"201":{"description":"The ID of the imported application.","x-nullable":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuidResponse"},"examples":{"Successful Import Application":{"$ref":"#/components/examples/Successful_Import_Application"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/usagescenarios":{"get":{"description":"Gets the application available usage scenarios.","operationId":"Apps_ListUsageScenarios","responses":{"200":{"description":"A list object containing the available application usage scenarios.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUsageScenarios"},"examples":{"Successful Get Application Usage Scenarios request":{"$ref":"#/components/examples/Successful_Get_Application_Usage_Scenarios_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}":{"delete":{"description":"Deletes an application.","operationId":"Apps_Delete","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/ForcePath"}],"responses":{"200":{"description":"Successfully deleted application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Rename Application request":{"$ref":"#/components/examples/Successful_Rename_Application_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Gets the application info.","operationId":"Apps_Get","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"responses":{"200":{"description":"The application info.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInfoResponse"},"examples":{"Successful Get Application Info request":{"$ref":"#/components/examples/Successful_Get_Application_Info_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Updates the name or description of the application.","operationId":"Apps_Update","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateObject"}}},"description":"A model containing Name and Description of the application.","required":true},"responses":{"200":{"description":"Successfully updated application name and description.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Rename Application request":{"$ref":"#/components/examples/Successful_Rename_Application_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/azureaccounts":{"delete":{"description":"Removes assigned Azure account from the application.","operationId":"AzureAccounts_RemoveFromApp","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/BearerAuthPath"}],"requestBody":{"$ref":"#/components/requestBodies/AzureAccountInfoObject"},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful delete assigned azure account request":{"$ref":"#/components/examples/Successful_delete_assigned_azure_account_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"apps - Removes an assigned LUIS Azure account from an application"},"get":{"description":"Gets the LUIS Azure accounts assigned to the application for the user using his ARM token.","operationId":"AzureAccounts_GetAssigned","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/BearerAuthPath"}],"responses":{"200":{"description":"A list of azure account information objects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureAccountInfoList"},"examples":{"Successful Get assigned azure accounts request":{"$ref":"#/components/examples/Successful_Get_assigned_azure_accounts_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"apps - Get LUIS Azure accounts assigned to the application"},"post":{"description":"Assigns an Azure account to the application.","operationId":"AzureAccounts_AssignToApp","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/BearerAuthPath"}],"requestBody":{"$ref":"#/components/requestBodies/AzureAccountInfoObject"},"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Assign azure account request":{"$ref":"#/components/examples/Successful_Assign_azure_account_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"apps - Assign a LUIS Azure account to an application"}},"/apps/{appId}/endpoints":{"get":{"description":"Returns the available endpoint deployment regions and URLs.","operationId":"Apps_ListEndpoints","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"responses":{"200":{"description":"Returns a list of endpoints regions and their corresponding endpoint URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableEndpoints"},"examples":{"Successful Get Endpoints request":{"$ref":"#/components/examples/Successful_Get_Endpoints_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/permissions":{"delete":{"description":"Removes a user from the allowed list of users to access this LUIS application. Users are removed using their email address.","operationId":"Permissions_Delete","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"requestBody":{"$ref":"#/components/requestBodies/UserCollaborator"},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Remove User From Access List":{"$ref":"#/components/examples/Successful_Remove_User_From_Access_List"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Gets the list of user emails that have permissions to access your application.","operationId":"Permissions_List","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"responses":{"200":{"description":"The list includes a single owner. All collaborators are listed in the emails array.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccessList"},"examples":{"Successful Get Application User Access List":{"$ref":"#/components/examples/Successful_Get_Application_User_Access_List"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"description":"Adds a user to the allowed list of users to access this LUIS application. Users are added using their email address.","operationId":"Permissions_Add","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"requestBody":{"$ref":"#/components/requestBodies/UserCollaborator"},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Add User To Access List":{"$ref":"#/components/examples/Successful_Add_User_To_Access_List"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Replaces the current user access list with the new list sent in the body. If an empty list is sent, all access to other users will be removed.","operationId":"Permissions_Update","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaboratorsArray"}}},"description":"A model containing a list of user email addresses.","required":true},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Replaces Users From Access List":{"$ref":"#/components/examples/Successful_Replaces_Users_From_Access_List"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/publish":{"post":{"description":"Publishes a specific version of the application.","operationId":"Apps_Publish","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationPublishObject"}}},"description":"The application publish object. The region is the target region that the application is published to.","required":true},"responses":{"201":{"description":"An object containing the application endpoint URL, its assigned endpoint key and publishing status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductionOrStagingEndpointInfo"},"examples":{"Successful Publish Application request":{"$ref":"#/components/examples/Successful_Publish_Application_request"}}}}},"207":{"description":"An object containing the application endpoint URL, its assigned endpoint key and publishing status in case that publishing one or more regions failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductionOrStagingEndpointInfo"},"examples":{"Successful Publish Application request":{"$ref":"#/components/examples/Successful_Publish_Application_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/publishsettings":{"get":{"description":"Get the application publish settings including 'UseAllTrainingData'.","operationId":"Apps_GetPublishSettings","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"responses":{"200":{"description":"The application publish settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishSettings"},"examples":{"Successful Get Publish Settings request":{"$ref":"#/components/examples/Successful_Get_Publish_Settings_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Updates the application publish settings including 'UseAllTrainingData'.","operationId":"Apps_UpdatePublishSettings","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishSettingUpdateObject"}}},"description":"An object containing the new publish application settings.","required":true},"responses":{"200":{"description":"Successfully updated application settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Update Publish Settings request":{"$ref":"#/components/examples/Successful_Update_Publish_Settings_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/querylogs":{"get":{"description":"Gets the logs of the past month's endpoint queries for the application.","operationId":"Apps_DownloadQueryLogs","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"responses":{"200":{"description":"A CSV file containing the query logs for the past month.","content":{"application/octet-stream":{"schema":{"description":"The query logs of an application for the past month in CSV format.","format":"file","type":"object"},"examples":{"Successful Download Application Query logs request":{"$ref":"#/components/examples/Successful_Download_Application_Query_logs_request"}}}}},"default":{"description":"Error Response.","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/settings":{"get":{"description":"Get the application settings including 'UseAllTrainingData'.","operationId":"Apps_GetSettings","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"responses":{"200":{"description":"The application settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationSettings"},"examples":{"Successful Get Application Settings request":{"$ref":"#/components/examples/Successful_Get_Application_Settings_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Updates the application settings including 'UseAllTrainingData'.","operationId":"Apps_UpdateSettings","parameters":[{"$ref":"#/components/parameters/AppIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationSettingUpdateObject"}}},"description":"An object containing the new application settings.","required":true},"responses":{"200":{"description":"Successfully updated application settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Update Application Settings request":{"$ref":"#/components/examples/Successful_Update_Application_Settings_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions":{"get":{"description":"Gets a list of versions for this application ID.","operationId":"Versions_List","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/SkipInPath"},{"$ref":"#/components/parameters/TakeInPath"}],"responses":{"200":{"description":"A list of all versions of the application.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VersionInfo"},"type":"array"},"examples":{"Successful Get Application Versions info request":{"$ref":"#/components/examples/Successful_Get_Application_Versions_info_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/import":{"post":{"description":"Imports a new version into a LUIS application.","operationId":"Versions_Import","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"description":"The new versionId to import. If not specified, the versionId will be read from the imported object.","in":"query","name":"versionId","schema":{"type":"string"},"examples":{"Successful Import Application":{"value":"0.2"}}}],"requestBody":{"$ref":"#/components/requestBodies/LuisApp"},"responses":{"201":{"description":"The created application version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"},"examples":{"Successful Import Application":{"$ref":"#/components/examples/Successful_Import_Application"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/":{"delete":{"description":"Deletes an application version.","operationId":"Versions_Delete","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Delete Application Version request":{"$ref":"#/components/examples/Successful_Delete_Application_Version_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.","operationId":"Versions_Get","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"}],"responses":{"200":{"description":"A model containing the version info.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionInfo"},"examples":{"Successful Get Application Version info request":{"$ref":"#/components/examples/Successful_Get_Application_Version_info_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Updates the name or description of the application version.","operationId":"Versions_Update","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdateObject"}}},"description":"A model containing Name and Description of the application.","required":true},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Rename Application Version request":{"$ref":"#/components/examples/Successful_Rename_Application_Version_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/clone":{"post":{"description":"Creates a new version from the selected version.","operationId":"Versions_Clone","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdateObject"}}},"description":"A model containing the new version ID.","required":true},"responses":{"201":{"description":"The new version ID.","content":{"application/json":{"schema":{"type":"string"},"examples":{"Successful Clone Application Version request":{"$ref":"#/components/examples/Successful_Clone_Application_Version_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/closedlists":{"get":{"description":"Gets information about all the list entity models in a version of the application.","operationId":"Model_ListClosedLists","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/SkipInPath"},{"$ref":"#/components/parameters/TakeInPath"}],"responses":{"200":{"description":"A list of list entity model infos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedListEntityExtractorsList"},"examples":{"Successful Get Application Version Closed List Infos request":{"$ref":"#/components/examples/Successful_Get_Application_Version_Closed_List_Infos_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"description":"Adds a list entity model to a version of the application.","operationId":"Model_AddClosedList","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedListModelCreateObject"}}},"description":"A model containing the name and words for the new list entity extractor.","required":true},"responses":{"201":{"description":"The ID of the created model.","x-nullable":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuidResponse"},"examples":{"Successful Create Closed List Entity Model request":{"$ref":"#/components/examples/Successful_Create_Closed_List_Entity_Model_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}":{"delete":{"description":"Deletes a list entity model from a version of the application.","operationId":"Model_DeleteClosedList","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The list entity model ID.","in":"path","name":"clEntityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Delete Closed List Entity Info request":{"value":"d1f95436-57ac-4524-ae81-5bdd32668ccf"}}}],"responses":{"200":{"description":"Successfully delete list entity from a version of application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Delete Closed List Entity Info request":{"$ref":"#/components/examples/Successful_Delete_Closed_List_Entity_Info_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Gets information about a list entity in a version of the application.","operationId":"Model_GetClosedList","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The list model ID.","in":"path","name":"clEntityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Get Closed List Entity Info request":{"value":"8713b104-78ec-4c4f-9f96-f2e53562cc16"}}}],"responses":{"200":{"description":"The list model info.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedListEntityExtractor"},"examples":{"Successful Get Closed List Entity Info request":{"$ref":"#/components/examples/Successful_Get_Closed_List_Entity_Info_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"description":"Adds a batch of sublists to an existing list entity in a version of the application.","operationId":"Model_PatchClosedList","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The list entity model ID.","in":"path","name":"clEntityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Add SubLists to Closed List Entity request":{"value":"d1f95436-57ac-4524-ae81-5bdd32668ccf"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedListModelPatchObject"}}},"description":"A words list batch.","required":true},"responses":{"200":{"description":"Successfully added sublists to the list entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Add SubLists to Closed List Entity request":{"$ref":"#/components/examples/Successful_Add_SubLists_to_Closed_List_Entity_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Updates the list entity in a version of the application.","operationId":"Model_UpdateClosedList","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The list model ID.","in":"path","name":"clEntityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Update Closed List Entity Info request":{"value":"d1f95436-57ac-4524-ae81-5bdd32668ccf"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosedListModelUpdateObject"}}},"description":"The new list entity name and words list.","required":true},"responses":{"200":{"description":"Successfully updated list entity name and words list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Update Closed List Entity Info request":{"$ref":"#/components/examples/Successful_Update_Closed_List_Entity_Info_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists":{"post":{"description":"Adds a sublist to an existing list entity in a version of the application.","operationId":"Model_AddSubList","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The list entity extractor ID.","in":"path","name":"clEntityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Add Sublist request":{"value":"d1f95436-57ac-4524-ae81-5bdd32668ccf"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WordListObject"}}},"description":"Words list.","required":true},"responses":{"201":{"description":"The ID of the newly created sublist.","content":{"application/json":{"schema":{"format":"int64","type":"integer"},"examples":{"Successful Add Sublist request":{"$ref":"#/components/examples/Successful_Add_Sublist_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}":{"delete":{"description":"Deletes a sublist of a specific list entity model from a version of the application.","operationId":"Model_DeleteSubList","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The list entity extractor ID.","in":"path","name":"clEntityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Delete Sublist request":{"value":"d1f95436-57ac-4524-ae81-5bdd32668ccf"}}},{"description":"The sublist ID.","in":"path","name":"subListId","required":true,"schema":{"type":"integer","format":"int64"},"examples":{"Successful Delete Sublist request":{"value":123}}}],"responses":{"200":{"description":"Successfully deleted sublist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Delete Sublist request":{"$ref":"#/components/examples/Successful_Delete_Sublist_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Updates one of the list entity's sublists in a version of the application.","operationId":"Model_UpdateSubList","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The list entity extractor ID.","in":"path","name":"clEntityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Update Sublist request":{"value":"d1f95436-57ac-4524-ae81-5bdd32668ccf"}}},{"description":"The sublist ID.","in":"path","name":"subListId","required":true,"schema":{"type":"integer","format":"int64"},"examples":{"Successful Update Sublist request":{"value":123}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WordListBaseUpdateObject"}}},"description":"A sublist update object containing the new canonical form and the list of words.","required":true},"responses":{"200":{"description":"Successfully updated sublist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Update Sublist request":{"$ref":"#/components/examples/Successful_Update_Sublist_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles":{"get":{"operationId":"Model_ListClosedListEntityRoles","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"entity Id","in":"path","name":"entityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Get Closed List Entity Roles request":{"value":"2d3173b0-983c-43ae-92f8-6f5b5d09a11a"}}}],"responses":{"200":{"description":"A list of the entity roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityRoleList"},"examples":{"Successful Get Closed List Entity Roles request":{"$ref":"#/components/examples/Successful_Get_Closed_List_Entity_Roles_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Get all roles for a list entity in a version of the application."},"post":{"operationId":"Model_CreateClosedListEntityRole","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The entity model ID.","in":"path","name":"entityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Create Closed List Entity Role request":{"value":"fc821c4e-a2f8-4074-9410-7271b38a692d"}}}],"requestBody":{"$ref":"#/components/requestBodies/EntityRoleCreateObject"},"responses":{"201":{"description":"The ID of the created entity role","x-nullable":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuidResponse"},"examples":{"Successful Create Closed List Entity Role request":{"$ref":"#/components/examples/Successful_Create_Closed_List_Entity_Role_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Create a role for a list entity in a version of the application."}},"/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles/{roleId}":{"delete":{"operationId":"Model_DeleteClosedListEntityRole","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The entity ID.","in":"path","name":"entityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Delete Prebuilt Entity Role request":{"value":"3d73462d-98f0-4dcd-8d30-fab9e65f2e73"}}},{"description":"The entity role Id.","in":"path","name":"roleId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Delete Prebuilt Entity Role request":{"value":"a682a962-1f92-4ae7-b8b8-398414e30c12"}}}],"responses":{"200":{"description":"Successfully operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Delete Prebuilt Entity Role request":{"$ref":"#/components/examples/Successful_Delete_Prebuilt_Entity_Role_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Delete a role for a given list entity in a version of the application."},"get":{"operationId":"Model_GetClosedListEntityRole","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"entity ID.","in":"path","name":"entityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Get Closed List Entity Role request":{"value":"3d73462d-98f0-4dcd-8d30-fab9e65f2e73"}}},{"description":"entity role ID.","in":"path","name":"roleId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Get Closed List Entity Role request":{"value":"a682a962-1f92-4ae7-b8b8-398414e30c12"}}}],"responses":{"200":{"description":"An entity role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityRole"},"examples":{"Successful Get Closed List Entity Role request":{"$ref":"#/components/examples/Successful_Get_Closed_List_Entity_Role_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Get one role for a given list entity in a version of the application."},"put":{"operationId":"Model_UpdateClosedListEntityRole","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"description":"The entity ID.","in":"path","name":"entityId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Update Closed List Entity Extractor Role request":{"value":"3d73462d-98f0-4dcd-8d30-fab9e65f2e73"}}},{"description":"The entity role ID.","in":"path","name":"roleId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Update Closed List Entity Extractor Role request":{"value":"6dbed7e2-7df6-4cd6-a225-97e6fbe4493d"}}}],"requestBody":{"$ref":"#/components/requestBodies/EntityRoleUpdateObject"},"responses":{"200":{"description":"Successfully updated the entity role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Update Closed List Entity Extractor Role request":{"$ref":"#/components/examples/Successful_Update_Closed_List_Entity_Extractor_Role_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Update a role for a given list entity in a version of the application."}},"/apps/{appId}/versions/{versionId}/compositeentities":{"get":{"description":"Gets information about all the composite entity models in a version of the application.","operationId":"Model_ListCompositeEntities","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/SkipInPath"},{"$ref":"#/components/parameters/TakeInPath"}],"responses":{"200":{"description":"A list of composite entity model infos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompositeEntityExtractorsList"},"examples":{"Successful Get Application Version Composite Entity Infos request":{"$ref":"#/components/examples/Successful_Get_Application_Version_Composite_Entity_Infos_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}":{"delete":{"description":"Deletes a composite entity from a version of the application.","operationId":"Model_DeleteCompositeEntity","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/CEntityIdInPath"}],"responses":{"200":{"description":"Successfully deleted composite entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Delete Entity Info request":{"$ref":"#/components/examples/Successful_Delete_Entity_Info_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Gets information about a composite entity in a version of the application.","operationId":"Model_GetCompositeEntity","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/CEntityIdInPath"}],"responses":{"200":{"description":"The composite entity model info.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompositeEntityExtractor"},"examples":{"Successful Get Composite Entity Info request":{"$ref":"#/components/examples/Successful_Get_Composite_Entity_Info_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Updates a composite entity in a version of the application.","operationId":"Model_UpdateCompositeEntity","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/CEntityIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompositeEntityModel"}}},"description":"A model object containing the new entity extractor name and children.","required":true},"responses":{"200":{"description":"Successfully updated composite entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Update Composite Entity Extractor request":{"$ref":"#/components/examples/Successful_Update_Composite_Entity_Extractor_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children":{"post":{"description":"Creates a single child in an existing composite entity model in a version of the application.","operationId":"Model_AddCompositeEntityChild","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/CEntityIdInPath"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string"}},"type":"object"}}},"description":"A model object containing the name of the new composite child model.","required":true},"responses":{"201":{"description":"The ID of the created model.","x-nullable":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuidResponse"},"examples":{"Successful Create Composite Entity Child Model request":{"$ref":"#/components/examples/Successful_Create_Composite_Entity_Child_Model_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}":{"delete":{"description":"Deletes a composite entity extractor child from a version of the application.","operationId":"Model_DeleteCompositeEntityChild","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/CEntityIdInPath"},{"description":"The hierarchical entity extractor child ID.","in":"path","name":"cChildId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Delete Composite Entity Child Model request":{"value":"891c235f-4f42-4320-bc36-b6256b6c3f2b"}}}],"responses":{"200":{"description":"Successfully deleted entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Delete Composite Entity Child Model request":{"$ref":"#/components/examples/Successful_Delete_Composite_Entity_Child_Model_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles":{"get":{"operationId":"Model_ListCompositeEntityRoles","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/CEntityIdInPath"}],"responses":{"200":{"description":"A list of the entity roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityRoleList"},"examples":{"Successful Get Composite Entity Roles request":{"$ref":"#/components/examples/Successful_Get_Composite_Entity_Roles_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Get all roles for a composite entity in a version of the application"},"post":{"operationId":"Model_CreateCompositeEntityRole","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/CEntityIdInPath"}],"requestBody":{"$ref":"#/components/requestBodies/EntityRoleCreateObject"},"responses":{"201":{"description":"The ID of the created entity role","x-nullable":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuidResponse"},"examples":{"Successful Create Composite Entity Role request":{"$ref":"#/components/examples/Successful_Create_Composite_Entity_Role_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Create a role for a composite entity in a version of the application."}},"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles/{roleId}":{"delete":{"operationId":"Model_DeleteCompositeEntityRole","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/CEntityIdInPath"},{"description":"The entity role Id.","in":"path","name":"roleId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Successful Delete Composite Entity Role request":{"value":"a682a962-1f92-4ae7-b8b8-398414e30c12"}}}],"responses":{"200":{"description":"Successfully operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"},"examples":{"Successful Delete Composite Entity Role request":{"$ref":"#/components/examples/Successful_Delete_Composite_Entity_Role_request"}}}}},"default":{"description":"Error Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Delete a role for a given composite entity in a version of the application."},"get":{"operationId":"Model_GetCompositeEntityRole","parameters":[{"$ref":"#/components/parameters/AppIdInPath"},{"$ref":"#/components/parameters/VersionIdInPath"},{"$ref":"#/components/parameters/CEntityIdInPath"},{"description":"entity role ID.","in":"path","name":"roleId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"