Show TOC

Start a ProjectLocate this document in the navigation structure

Use this REST request to start the ESP project. A project must already exist in the workspace specified in the request. This REST request is a POST type request.

Header
http://serverDetails/espws/restservice/project/<projectName>?action=start&workspace=<workspaceName>
Body
Table 1: Connection Details
Element Description
defaultCluster

(Optional) Specify a default cluster for the REST server to which you are connecting. This element contains the credentialselement below. If you specify this element, the workspace name specified in the URI is ignored.

Specify either this element or the connectionDetails element. If you specify both elements, you will receive an error.

credentials (Optional) Specify a value based on the type of authentication the ESP Server is using.
  • for username and password authentication, specify username:password values.
  • for RSA authentication, specify keystore:user:password values. For the keystore value, only specify the keystore file name. Do not specify a file path. If you are using Windows, surround the file name in single quotation marks.
  • for Kerberos authentication, specify user:service:cache values. For the cache value, only specify the Kerberos cache file name. Do not specify a file path. If you are using Windows, surround the file name in single quotation marks.
connectionDetails

(Required only if defaultCluster is not specified) Element containing clusterName, port, and authentication details below.

Specify either this element or the defaultCluster element. If you specify both elements, you will receive an error.

clusterName

Type: string

(Required if no default is specified) The name of the cluster on which the project that you wish to update is running.

port

Type: integer

(Required) Specify the port on which the cluster is running.

authentication

(Required) Element containing authentication details (type, data, and sslEnabled).

type

Type: string

(Required) Specify the type of authentication the ESP Server is using. Valid values are user, RSA, and Kerberos.

data

Type: string

(Required) Specify a value based on the type of authentication you specified in the type element. For example,
  • for user, specify username:password values
  • for rsa, specify keystore:user:password values. For the keystore value, enter the keystore file name. Do not specify a file path. If you are using Windows, surround the file name in single quotation marks.
  • for kerberos, specify user:service:cache values. For the cache value, enter the Kerberos cache file name. Do not specify a file path. If you are using Windows, surround the file name in single quotation marks.
sslEnabled

Type: boolean

(Required) Specify whether SSL is enabled on the cluster on which the project is running. The default value is false.

Example
Header
http://localhost:9091/espws/restservice/project/myproject?action=start&workspace=default 
Body
{ 
 "defaultCluster" : { "credentials" : "<username>:<password>" }
}
or
{
   "connectionDetails": {
        " clusterName ": "iltlvl231",
        "port": "19011",
        "authentication": {
            "type": "user",
            "data": "lroot:<password>",
            "sslEnabled": "true"
        }
    }
}