Generating entity relationship documents (ERDs)

Use the maxinst pod or an API tool like Swagger to generate and download entity relationship documents (ERDs). An ERD describes Maximo® business objects and the relationships between them. Use it to review relationships that are defined in the Maximo Manage database to identify if you can reuse any existing relationship.

Procedure

Make an API request or use any API tool to generate an ERD.
Option Description
Make an API request 
POST https://maxinst.<domain path>/toolsapi/toolservice/generd
Use the Swagger API tool.
  1. In a browser, specify the URL for Manage tools API as shown in the following example.
    https://maxinst.<domain path>/toolsapi/oas3/api.html
  2. In the Managetools api window, click Authorize.
  3. In the Available authorizations dialog, enter the API key value that you generated in the API Keys application in Maximo Manage.
  4. Click Authorize.
  5. Click Done.
  6. Select Generate ERD route handler to expand it.
  7. Click Try it out.
  8. Click Execute.
Note: Depending on available resources and the speed of your environment, it might take some time to generate a response. You can ignore any warnings in the response after it is generated. The success response code that is generated is 200.

What to do next

You can download the ERD file to your local system or view the ERD document in your browser.