Custom API Action

Make a custom HTTP request to the Jama API.

Jama API docs: Jama uses Swagger as their API explorer. In order to view the API, you will need to be logged in to your Jama instance. Then, navigate to https://{your_subdomain}.jamacloud.com/api-docs/ - where {your-subdomain} is the subdomain of your Jama instance. This is the same subdomain value that you used when authenticating your connection.

For example, if your Jama instance URL is https://example-subdomain.jamacloud.com/, then you will navigate to https://example-subdomain.jamacloud.com/api-docs to view the API documentation.

Options

• Request Type (dropdown) - Available HTTP Request Methods. Choose from GET, POST, PUT, PATCH, and DELETE. Refer to API docs in order to determine which request type to use.

  • GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.

  • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. Additional documentation here.

  • PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. Additional documentation here.

  • PATCH: applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that the result of multiple PATCH’s could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Additional documentation here.

  • DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). Additional documentation here.

Input Fields

• Request

  • Relative URL (string) - Relative request URL. The relative URL structure for this action follows the /rest/latest route. E.g. - If the full API URL is https://example-subdomain.jamacloud.com/rest/latest/projects, then the Relative URL would be /projects.

    Example: /projects

  • Query (object) - Query parmaeters for the request.

    Example: {"name":"Jama Software"}

  • Headers (object) - Headers for the request.

    Example: {"Accept":"application/json"}

  • Body (object) (only for POST, PUT, PATCH, and DELETE) - Body of the request.

    Example: {"foo": "automation, "bar": "integration"}

Output Fields

• Response
  • Status Code (number) - The status code of the HTTP response. Here is a list of all status codes.
  • Headers (object) - The response headers. A more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you.
  • Body (object) - The response body. Depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.