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)

Create Admin API application

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

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(id)

Get Admin API application

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

Example​

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​

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​

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​

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​

removeAdminApiApplicationUsingDELETE(id)

Remove Admin API application

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

Example​

Parameters​

NameTypeDescriptionNotes
idStringThe UUID of the application to be removed.

Return type​

null (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(id, adminApiApplicationParms)

Update Admin API application

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

Example​

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(id)

Regenerate Admin API application shared secret

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

Example​

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-