Default language.

Developing an API program

This section explains when to use an application programming interface (API) and provides an overview of the BMC Remedy Action Request System (AR System) APIs. It includes information that a developer needs to write applications that integrate with BMC Remedy AR System.

This section also includes a complete reference to the functions of the BMC Remedy AR System C API and covers information about the Java API and the REST API.

Note

The compatibility information listed in the product documentation is subject to change. See BMC Remedy ITSM Suite compatibility matrix in the BMC Remedy ITSM Deployment online documentation for the latest, most complete information about what is officially supported. Carefully read the system requirements for your operating system, especially the necessary patch requirements.

You must know how to write API programs and be familiar with BMC Remedy AR System, including the overall architecture. In addition, you should be knowledgeable about the operating system for your environment and have some experience with client/server applications and plug-ins. The information here assumes that you are proficient in C programming and are familiar with arrays, pointers, structure types, and allocated memory. To use the XML import and export functions, you should be knowledgeable about XML.

Use the following information to understand how to use C and other compatible languages to write programs that integrate with BMC Remedy AR System. The following information includes a complete reference to the functions of the BMC Remedy AR System C API and also provides an overview of the Java API.

Goal

Instructions

Understand the client-server application model, the BMC Remedy AR System C API program structure, and the library functions.

Write an API program.

Learn how to use the BMC Remedy AR System REST API to transmit data between a server and a web application , and know the issues and considerations when using the BMC Remedy AR System REST API.

Learn how to use the BMC Remedy AR System C API for linking with third-party applications, and know the issues and considerations when using the BMC Remedy AR System C API.

Understand the contents of the BMC Remedy AR System C API package, know the C API changes, and the requirements for compiling and linking C API programs.

Learn about the common elements and functions of the BMC Remedy AR System C API data structures and the relationships among objects.

Learn about the supported formats for transforming XML documents to BMC Remedy AR System structures.

Understand the various types of BMC Remedy AR System C API functions and their components.

Learn the tips for designing a program, developing a plug-in to send notifications, and enabling a client to perform multiple API calls within a transaction.

Debug your application programs by analyzing the logs and using the driver program.

Understand the BMC Remedy AR System plug-in API functions.

Transform BMC Remedy AR System objects into XML format and know the types of functions for object manipulation and transformation.

Use dynamic joins, create vendor forms, and retrieve information from forms that store hierarchical data.

Learn about the BMC Remedy AR System Java API programming model, understand the run-time configuration to run Java API programs, and develop your BMC Remedy AR System Java client.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*