Skip to main content

ApplicationsApi

MethodHTTP requestDescription
CreateAdminApiApplicationUsingPOSTPOST /api/web/v1/applications/adminapiCreate Admin API application
GetAdminApiApplicationUsingGETGET /api/web/v1/applications/adminapi/{id}Get Admin API application
ListAdminApiApplicationsUsingGETGET /api/web/v1/applications/adminapiList Admin API application
ListApplicationInfoUsingGETGET /api/web/v1/applicationinfoList application information
ListApplicationTemplatesUsingGETGET /api/web/v1/applications/templatesList application templates
RemoveAdminApiApplicationUsingDELETEDELETE /api/web/v1/applications/adminapi/{id}Remove Admin API application
UpdateAdminApiApplicationUsingPUTPUT /api/web/v1/applications/adminapi/{id}Update Admin API application
UpdateAdminApiSharedSecretUsingPUTPUT /api/web/v1/applications/adminapi/regenerate/{id}Regenerate Admin API application shared secret

CreateAdminApiApplicationUsingPOST​

AdminApiApplication CreateAdminApiApplicationUsingPOST (AdminApiApplicationParms adminApiApplicationParms)

Create Admin API application

Create an Admin API application. Caller requires the APPLICATIONS:ADD permission.

Using the CreateAdminApiApplicationUsingPOSTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
adminApiApplicationParmsAdminApiApplicationParms

Return type​

AdminApiApplication

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

GetAdminApiApplicationUsingGET​

AdminApiApplication GetAdminApiApplicationUsingGET (string id)

Get Admin API application

Get an Admin API application. Caller requires the APPLICATIONS:VIEW permission.

Example​

Using the GetAdminApiApplicationUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
idstringThe UUID of the application to be fetched.

Return type​

AdminApiApplication

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

ListAdminApiApplicationsUsingGET​

List<AdminApiApplication> ListAdminApiApplicationsUsingGET ()

List Admin API application

List Admin API application. Caller requires the APPLICATIONS:VIEW permission.

Example​

Using the ListAdminApiApplicationsUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

This endpoint does not need any parameter.

Return type​

List<AdminApiApplication>

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

ListApplicationInfoUsingGET​

List<ApplicationInfo> ListApplicationInfoUsingGET ()

List application information

List application information. Caller requires the APPLICATIONS:VIEW permission.

Example​

Using the ListApplicationInfoUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

This endpoint does not need any parameter.

Return type​

List<ApplicationInfo>

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

ListApplicationTemplatesUsingGET​

List<ApplicationTemplate> ListApplicationTemplatesUsingGET ()

List application templates

List application templates. Caller requires the TEMPLATES:VIEW permission.

Example​

Using the ListApplicationTemplatesUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

This endpoint does not need any parameter.

Return type​

List<ApplicationTemplate>

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

RemoveAdminApiApplicationUsingDELETE​

void RemoveAdminApiApplicationUsingDELETE (string id)

Remove Admin API application

Remove an Admin API application. Caller requires the APPLICATIONS:REMOVE permission.

Example​

Using the RemoveAdminApiApplicationUsingDELETEWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
idstringThe UUID of the application to be removed.

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

UpdateAdminApiApplicationUsingPUT​

AdminApiApplication UpdateAdminApiApplicationUsingPUT (string id, AdminApiApplicationParms adminApiApplicationParms)

Update Admin API application

Update an Admin API application. Caller requires the APPLICATIONS:EDIT permission.

Example​

Using the UpdateAdminApiApplicationUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
idstringThe UUID of the application to be updated.
adminApiApplicationParmsAdminApiApplicationParms

Return type​

AdminApiApplication

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

UpdateAdminApiSharedSecretUsingPUT​

string UpdateAdminApiSharedSecretUsingPUT (string id)

Regenerate Admin API application shared secret

Regenerate the shared secret for an Admin API application. Caller requires the APPLICATIONS:EDIT permission.

Example​

Using the UpdateAdminApiSharedSecretUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
idstringThe UUID of the application to be updated.

Return type​

string

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-