IntegrationsREST API Static Endpoints

The topics in this section describe the endpoints available in Spectrum.

Note: The representational state transfer (REST) API for Web Services integration provides basic functionality. It cannot be used for more complex tasks such as submitting stacked jobs. See SOAP API for Web Services for information on creating more complex front-end applications.

Endpoint Definitions

Each endpoint definition topic contains some or all the following:

  • The method name and a description of its purpose

  • The URL for accessing the endpoint

  • The version of Loftware Spectrum that the endpoint was made available

  • The required and optional parameters and their formats

  • The variables available

  • What the request returns (the response)

  • The method signature

  • Example requests and responses

About Endpoint Method Signatures

Each endpoint definition contains a method signature that defines the properties of the REST request. The following describes the components of a signature.

{GET [/methodName]}
The resource method (GET and/or POST) and the name of the REST endpoint.
public String restmethodName
The format of the return message (String in this case).
@RequestParam(value = "objectId", required = true) Long objectId,
Any required parameters that must be added to the rest call and the format of the parameter (long in this case).
@RequestParam(value = "reason", required = false) String reason
Any optional parameters that can be included in the rest call and the format of the parameter.

Example Request

http://<server:port>/spectrum-server/rest/methodName?objectID=123456&reason=because

The Loftware Spectrum REST Integration API is organized in the following sections.