1 Overview

The OHMPI RM REST APIs are uniform interfaces for identifying and managing generic resources of metadata, entities, and relationships. The OHMPI RM REST APIs are used for accessing the functionality of the relationship management service and integrating with the OHMPI applications and any other integral enterprise applications by combining with SOA. The OHMPI RM REST APIs are JAX-RS 2.0 standard RESTful web services. This guide provides the information of the RESTful web services that are available with the current release.

The managed resources of the OHMPI RM application are categorized into the following:

Metadata Resources: Manages relationship types and entity types
Relationship Resources: Manages relationships
Entity Resources: Manages entities
MPI Integration Resources: Manages MPI integration functionality between the RM and the MPI applications
Application Management Resources: Manages domains, rulesets, and tasks
Application Statistics Resources: Manages the application statistical information

The relationship management REST API context root is:

http(s)://<server>:<port>/ohmpi-rm/1.0.0

1.0.0 is the current version of the relationship management APIs.

1.1 HTTP Verbs' Usage

GET is used for retrieving and searching resources
PUT is used for updating the existing resources
POST is used for creating new resources. It is also used for querying resources by complicated search criteria with sensitive information.

1.2 Generic RM Resource Naming Conventions

Non-case sensitive
Start with alphabets
Mix with any letters, digits, or underscores
Avoid one-character names
No two resources have the same resource name
Each unique resource has only one root resource URI
Any names of parameters and variables are non-case sensitive
Any values of parameters and variables are non-case sensitive