1. References
  2. Management API
  3. Applications
Rate this page:

Applications

Methods

AddApplication

Copy URL

Adds a new account's application.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
AddApplication example
Copy

AddApplication example

Add a new application.

Parameters

  • application_name:

    string

    The short application name in format [a-z][a-z0-9-]{1,64}

  • secure_record_storage:

    boolean

    Optional

    Whether to enable secure storage for all logs and records of the application

Returns

  • result:

    number

    1

  • application_id:

    number

    The application ID

  • application_name:

    string

    The full application name

  • secure_record_storage:

    boolean

    Whether a secure storage for logs and records is enabled or not

DelApplication

Copy URL

Deletes the account's application.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
DelApplication example
Copy

DelApplication example

Delete the application 1 and 3.

Parameters

  • application_id:

    intlist

    The application ID list separated by semicolons (;). Use the 'all' value to select all applications

  • application_name:

    stringlist

    The application name list separated by semicolons (;). Can be used instead of application_id

Returns

  • result:

    number

    1

SetApplicationInfo

Copy URL

Edits the account's application.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
SetApplicationInfo example
Copy

SetApplicationInfo example

Change the application name.

Parameters

  • application_id:

    number

    The application ID

  • required_application_name:

    string

    The application name that can be used instead of application_id

  • application_name:

    string

    Optional

    The new short application name in format [a-z][a-z0-9-]{1,79}

  • secure_record_storage:

    boolean

    Optional

    Whether to enable secure storage for all logs and records of the application

Returns

  • result:

    number

    1

  • application_name:

    string

    The new full application name

  • secure_record_storage:

    boolean

    Whether a secure storage for logs and records is enabled or not

GetApplications

Copy URL

Gets the account's applications.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Supervisor
Call list manager
User manager
Accountant
Support
GetApplications example
Copy

GetApplications example

Get two applications, but skip the first one.

Parameters

  • application_id:

    number

    Optional

    The application ID to filter

  • application_name:

    string

    Optional

    The application name part to filter

  • with_rules:

    boolean

    Optional
    Defaults on:  false

    Whether to get bound rules info

  • with_scenarios:

    boolean

    Optional
    Defaults on:  false

    Whether to get bound rules and scenarios info

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records are skipped in the output

Returns

  • result:

    [ApplicationInfoType]

  • total_count:

    number

    The total found application count

  • count:

    number

    The returned application count