×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')

This documentation supports the 20.02 version of Remedy Action Request (AR) System.

To view an earlier version, select the version from the Product version menu.


Remedy Action Request System 20.02 Developing an API program

Integrating AR System forms with a third-party application by using the REST API

The REST API is a simple stateless architecture that runs over the HTTP. The AR System server uses JavaScript Object Notation (JSON) format to transmit data between a server and a web application. The advantage of REST is having a limited number of operations for the interactions between clients and services.

The API is a web service that conforms to the architectural principles of Representational State Transfer (REST). Each API is called by issuing a standard HTTP request method: POST, GET, PUT, or DELETE (more commonly known as the CRUD operations: Create, Read, Update, and Delete).

The client creates new entries by issuing POST requests. The details of an individual entry or list of entries is retrieved using a GET request. The client issues PUT requests to modify an entry object. When an entry object is no longer needed, the client issues a DELETE request to remove the entry. 

The AR System server uses Jetty as a web server to service the REST API requests. You should use Secure Sockets Layer (SSL) certificates with the Jetty server to service the REST API requests. For more information, see Configuring the REST API by using SSL certificates.

Clients such as curl, Postman, or BMC TestHttpClient tool can make calls to REST APIs. For information about the BMC TestHTTPClient tool, see the knowledge article on BMC Communities  TestHttpClient - Command line tool to test HTTP(S) services Open link .

Learning about the REST API
Using the REST API

Was this page helpful? Yes No Submitting... Thank you
Last modified by Maithili Deshpande on Apr 12, 2024
rest_api crud_operations

Comments

  1. David Fiel

    The "Configuring the REST API" link doesn't go anywhere.

    May 22, 2020 03:51
    1. Onkar Telkikar

      Hello David,

      Thank you for pointing out this issue with the content. We have updated the link in this topic.

      Regards,
      Onkar

      May 23, 2020 04:33
  2. David k Hill

    It would be really nice if there is a section from this page that would cover troubleshooting the Rest API Server. Separately to show the various configuration settings, logging settings and common errors for Jetty server etc.

    May 20, 2022 02:18
    1. Anagha Deshpande

      Hello David,

      Thanks for brining this to our notice. 

      We have updated the topic with a link to troubleshooting AR System server REST APIs.

      Regards,

      Anagha

      May 24, 2022 10:48

Log in or register to comment.

When to use API programming
Learning about the REST API
© Copyright 1991-2021 BMC Software, Inc. © Copyright 1991-2021 BladeLogic, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.