REST/SOAP Endpoints

Learn how to create REST and SOAP endpoints.

A project requires an endpoint which is the access point for your project's pipeline. You can create either a REST or a SOAP endpoint.

  • REST endpoints use HTTP 1.1 verbs (GET, POST, PUT, PATCH and DELETE) and a path to a resource to create the endpoint. The path can include path parameters which are defined using curly braces, such as {parameter}. Normally, the response is returned as JSON.

  • SOAP endpoints use .wsdl files, which are XML files, to create the endpoint.

A project can contain as many endpoints as required.

Any created endpoint is reachable with or without a trailing slash. For example, if your published endpoint is .../foo, then it is also reachable by .../foo/.

Endpoint paths

The following shows a typical path of an endpoint.


Path element



Organization in which you created the project that contains the endpoint.


Project containing the endpoint.


Top level exposed resource.


Subsequent level exposed resource.


Path parameter within curly braces { }.

Here is an example endpoint from the Quickstart tutorial


Path parameters are variable parts of a URL path. They are used to point to a specific resource. A URL can have several path parameters, each denoted with curly braces { }. The order of the path parameters are important. See Here for more details.

.json or .xml in endpoint extensions

Using an extension ensures the response to a request made to the API is in the format indicated by the extension. This can be used in place of Accept headers which may be required when making a response from a browser, for instance. A browser may only accept JSON or XML so using an endpoint extension makes the format of the response explicit to the browser.

In the first example shown below, the endpoint extension is shown as .json. This causes a response from the API to be in JSON. Similarly, the second example shows an endpoint has an .xml extension. In this case the response is formatted in XML.

# JSON response
# XML response

The following shows a JSON response to an endpoint extension having .json.

"manufacturer":"Remedy Engines",