Viewing and using REST API methods

Content Intelligence Content Monitor Help
Version
2.2.x
2.1.x
2.0.x
Audience
anonymous
Part Number
MK-HCI006-00

HCM hosts a web-based documentation page where you can view all supported REST API methods, including the request bodies, request URLs, response bodies, and return codes for each. You can also use this page to run each REST API method.

To view the REST API documentation, in the HCM web app, click the user icon (). Then click Rest API.

You can use the REST API documentation pages to experiment with the REST API.

To use the REST API page to run a method:

  1. Click the row for the method you want.
  2. If the method needs you to specify a UUID:
    1. Click the row for the GET method for the resource type that you want. For example, to edit a dashboard, to learn the UUIDs of all dashboards in the system, go to the GET /dashboards method.
    2. Click Try it Out!.
    3. In the JSON response body, copy the value for the uuid field for the resource that you want.
      Note: Do not specify UUIDs when creating resources.
  3. If the method you want needs you to specify a request body:
    1. In the Parameters section, under Model Schema, click inside the JSON text box.

      The JSON text is added to the Value field.

    2. Edit the JSON in the Value field
      Note: Some methods might need other information in addition to or instead of UUIDs or JSON-formatted text. Some need particular string values or require that you browse for and select a file to upload.
  4. Click Try it out!.