Endpoint Configuration

CloverDX Designer > Data Services > Development > Data Service Job Editor > Endpoint Configuration

Contains configuration of the REST endpoint: job name, URL, HTTP methods that this endpoint will respond to, and a category.

When connected to a Server sandbox, the Endpoint Configuration shows the current status of service deployment. The service will respond to incoming requests only when it is in the published state.

Data Service jobs can be published directly from Designer if connected to a Server sandbox.

Designer will attempt to redeploy the service whenever the job or the endpoint configuration is changed. The redeployment happens when you save changes in the job; however, the deployment may fail if the configuration is invalid.

Due to potential failures, the automatic redeployment of the service is useful mostly during development, when changes to the jobs are frequent and you want to quickly test the service behavior. In production environment, it is recommended to upload the service .rjob files to the Server sandbox and deploy the service using CloverDX Server management console instead. This way, you can make sure it has been deployed correctly.

Figure 307. Main .rjob editor

Endpoint configuration
Endpoint name	Title of a job. It should be a human-readable title. Displayed in a documentation and user interface.
Endpoint URL	A URL of a REST job endpoint where it listens for connections. The grayed part cannot be changed and is automatically derived from a CloverDX Server URL. The URL may contain a specification of path parameters using a `{param_name}` syntax. Since version 5.1 you can use regular expressions for matching path parameters in URLs, for example: use `{param_name:.+}` (e.g. `{filename:.+}`) for the parameter to accept any character. Note: unless you use the regular expression above, parameters are not matched if the value contains `/` (slash).
Request method	The list of HTTP methods this endpoint will respond to. If client uses an HTTP method unsupported by the endpoint, they receive a response code: 404 - Not found.
Category	The category is used in the Data Apps catalog to group related services. Only published services with the Data App feature enabled are visible in the catalog.
Icon	The image referenced by this optional parameter is used in Data Apps catalog for better orientation in the list of all available Data Apps.

Endpoint configuration

Endpoint name

Title of a job. It should be a human-readable title. Displayed in a documentation and user interface.

Endpoint URL

A URL of a REST job endpoint where it listens for connections. The grayed part cannot be changed and is automatically derived from a CloverDX Server URL.

The URL may contain a specification of path parameters using a {param_name} syntax.

Since version 5.1 you can use regular expressions for matching path parameters in URLs, for example: use {param_name:.+} (e.g. {filename:.+}) for the parameter to accept any character.

Note: unless you use the regular expression above, parameters are not matched if the value contains / (slash).

Request method

The list of HTTP methods this endpoint will respond to.

If client uses an HTTP method unsupported by the endpoint, they receive a response code: 404 - Not found.