Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Apps

Applications store the REST URL of the web server they interact. Also, apps store other settings and data.

Apps

Field

Description

name

Application name

appKey

Unique identifier that is used on the client side to connect to this app

url

REST URL for web server integration via WCS RESTful API.

owner

User who owns the application

mainClass

Main class for direct calls. For deep integration and server-side developers.

callbackClass

Main class for callbacks. For deep integration and server-side developers.

restUsername

User name for HTTP authentication of REST.

restPassword

User password for HTTP authentication of REST.

Application descriptions are stored in database.yml file.

You can manage apps using the following commands:

...

Code Block
languagebash
themeRDark
remove app MyApp

Application REST methods

You can manage application REST methods with the following commands:

  • add app-rest-method
  • show app-rest-methods
  • remove app-rest-method

show app-rest-methods

The command is used to show all the REST methods of the application.

Parameters:
<app key> the unique key of the app, required

Example:

Code Block
languagebash
themeRDark
show app-rest-methods defaultApp

add app-rest-method

The command is used to add REST method to the application.

Parameters:
<app key> the unique key of the app, required
<rest method> REST method to be added, required
[-a | --all] add all the REST methods, optional, in this case <rest method> is not required

Example:

Code Block
languagebash
themeRDark
add app-rest-method MyAppKey connect
add app-rest-method -a MyAppKey

remove app-rest-method

The command is used to remove REST method from the application.

Parameters:
<app key> the unique key of the app, required
<rest method> REST method to be removed, required
[-a | --all] remove all the REST methods, optional, in this case <rest method> is not required

Example:

Code Block
languagebash
themeRDark
remove app-rest-method MyAppKey connect
remove app-rest-method -a MyAppKey

Examples

Adding the app for the existing user bob

...