Rate this page:

Applications

Methods

AddApplication

Copy URL

Adds a new account's application.

AddApplication example

AddApplication example

Add a new application.

Parameters

  • application_name:

    string

    Optional

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

  • secure_record_storage:

    boolean

    Optional

    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

    This flag indicates whether a secure storage for logs and records is enabled or not.

DelApplication

Copy URL

Deletes the account's application.

DelApplication example

DelApplication example

Delete the application 1 and 3.

Parameters

  • application_id:

    intlist

    The application ID list separated by the ';' symbol or the 'all' value.

  • application_name:

    stringlist

    The application name list separated by the ';' symbol. Can be used instead of appliction_id.

Returns

  • result:

    number

    1

SetApplicationInfo

Copy URL

Edits the account's application.

SetApplicationInfo example

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

    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

    This flag indicates whether a secure storage for logs and records is enabled or not.

GetApplications

Copy URL

Gets the account's applications.

GetApplications example

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.

  • user_id:

    number

    Optional

    The user ID to filter.

  • excluded_user_id:

    number

    Optional

    The excluded user ID to filter.

  • showing_user_id:

    number

    Optional

    Specify the user ID value to show it in the 'users' array output.

  • with_rules:

    boolean

    Optional
    Defaults on:  false

    Set true to get bound rules info.

  • with_scenarios:

    boolean

    Optional
    Defaults on:  false

    Set true 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 will be skipped in the output.

Returns

  • total_count:

    number

    The total found application count.

  • count:

    number

    The returned application count.