IBM API Hub
IBM OpenPages REST API V2

By IBM OpenPages

The IBM® OpenPages® GRC REST API provides access to IBM OpenPages® data and metadata. This data-centric API is specified in terms of resources, their URIs, and actions that can be performed on these URIs.


Updates for each version of the IBM OpenPages REST API V2 are described in the following sections.

Version 9.0.0.5

Deprecated and new endpoints

OpenPages REST API V2 Version 9.0.0.4 included the Log Collector endpoints for Start Logging Process (POST /v2/logs/collector) and Get Process Details for Logs (GET /v2/logs/collector/{process_id}).

Because the definitions of these endpoints don't meet the OpenAPI standard, some applications that use the openapi.json file cannot process it. To improve the compliance of the OpenPages REST API V2, the endpoints were deprecated and removed from the openapi.json file and the documentation for version 9.0.0.5.

You can still use the deprecated endpoints, but consider using the new alternative endpoints in 9.0.0.5:

  • Use the GET /v2/logs/collect/{process_id} endpoint instead of the deprecated GET /v2/logs/collector/{process_id} endpoint to retrieve the details for the subprocesses that track the application servers in the cluster.
  • Use the POST /v2/logs/collect endpoint instead of the deprecated POST /v2/logs/collector endpoint to start the log collector process.

If you're already using the deprecated endpoints, refer to Deprecation of Log collector endpoints in the OpenPages REST API V2.

Version 9.0.0.4

New query parameter

Set a new query parameter, append_enum_vals, to true to create an enumerated string value if it doesn't exist. You can use append_enum_vals on the following endpoints:

    POST /v2/contents
    PUT /v2/contents/{id}

Version 9.0.0.3

New endpoints

  • Use POST /v2/fastmap/validate to validate the contents of an XLSX FastMap template.
  • Use POST /v2/fastmap/import to load the contents of an XLSX FastMap template.
  • Use POST /v2/logs/collector to start the log collection process.
  • Use GET /v2/logs/collector/{process_id} to return the process details of logs.
  • Use GET /v2/logs/collector/download/{zip_object_id} to return logs as a .zip file.
  • Use GET /v2/configuration/locales to return a list of supported locales.
  • Use PUT /v2/configuration/settings to update the value of the configuration setting specified by the path.

Version 9.0.0.2

New endpoint

Use POST /v2/scim/Bulk to process a bulk request.

Version 9.0.0.1

New query parameter

On the GET /v2/contents/{id} endpoint, set the query parameter include_workflow to true to return associated workflow information.

New endpoints

  • Use GET /v2/workflows/instances/{id} to return workflow instance data for the specified workflow instance ID.
  • Use GET /v2/workflows/definitions/{id} to return a workflow process definition with the specified ID.
  • Use GET /v2/workflows/definitions/version/{id} to return a workflow process definition with the specified version ID.
  • Use GET /v2/workflows/definitions to return all workflow process definitions.
  • Use POST /v2/workflows/instances/{id}/transition/{transition} to transition an object to a new workflow state based on the specified instance ID and transition name.
  • Use GET /v2/workflows/instances/search to return workflow instances by using search parameters.
  • Use POST /v2/workflows/definitions/{id}/start/{grc_object_id} to start the workflow. The ID parameter specifies the workflow and the object ID specifies the object that passes through the workflow process.

Open API Specification

About specification
API Version

9.0.0.5

Legend
Technologies
Products & Services
Architectures & Deployment models
Company information
Company logoIBM OpenPages