Introduction IBM® OpenPages® is an AI-driven, highly scalable governance, risk and compliance GRC solution. 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. Endpoint URIs In the IBM OpenPages model, the metadata it defines, and their corresponding data can be accessed, updated, and created using the REST API. The REST API takes the form of URIs for these resources. The complete set of supported actions, their paths, parameters, and corresponding returned codes are defined. Data sent and returned during these HTTP interactions can either be in the HTTP body or as attachments. The base URL for IBM OpenPages API endpoints come from your individual service instance. To find the URL, click the service instance in your Resource listhttps://cloud.ibm.com/resources and click Environment. Use the value that's listed in the Fixed URL field. For example: text https://21181e99-2f47-4ca8-8594-4b329353810c.us-east-1.aws.openpages.ibm.com AWS https://145493cd-c0d6-4ce5-a2b3-86e0410ea88c.us-east.openpages.cloud.ibm.com IBM Cloud In IBM OpenPages as a Service, the specification of the URI address and the naming of path segments is not arbitrary. Every URI begins with https://Method Path Summary GET /v2/questionnaire/{id}/assessment Get an Questionnaire Type by ID GET /v2/questionnaire/{id}/template Get an Questionnaire Type by ID GET /v2/configuration/tags Get Tags POST /v2/configuration/tags Add Tags PUT /v2/configuration/decrypt_with_external_key Decrypt using External Key PUT /v2/configuration/encrypt_with_external_key Encrypt using External Key GET /v2/configuration/currencies/base Get Base Currency GET /v2/configuration/settings/all/{setting_path} Get Child Settings GET /v2/configuration/currencies Get Currencies GET /v2/configuration/currencies/{code} Get Currency by ISO code PUT /v2/configuration/currencies/{code} Set Currency status GET /v2/configuration/reporting_periods/current Get Current Reporting Period GET /v2/configuration/currencies/{code}/exchange_rates Get exchange rates for a Currency POST /v2/configuration/currencies/{code}/exchange_rates Sets exchange rate for Currency GET /v2/configuration/locales Get Locales GET /v2/configuration/text/{text_key} Get Localized Application Text GET /v2/configuration/text Get All Application Text GET /v2/configuration/profiles/{profile} Get Profile by ID GET /v2/configuration/profiles/{profile}/definition Get Profile Definition GET /v2/configuration/profiles/fields Get Profile Fields GET /v2/configuration/profiles Get Profiles GET /v2/configuration/reporting_periods/{reporting_period} Get Reporting Period by Name GET /v2/configuration/reporting_periods Get All Reporting Periods GET /v2/configuration/settings/{setting_path} Get Setting GET /v2/configuration/admin_mode Get System Admin Mode PUT /v2/configuration/admin_mode Set System Admin Mode GET /v2/configuration/tags/{tagid} Get Tag PUT /v2/configuration/tags/{tagid} Update Tag PUT /v2/configuration/integrate_cognos_service Integrate Cognos Service POST /v2/configuration/currencies/exchange_rates Set Multiple Exchange Rates PUT /v2/configuration/settings Update Setting Value PUT /v2/configuration/traces Enable or Disable Trace Log Options POST /v2/contents/{id}/associations/children Add Child Associations DELETE /v2/contents/{id}/associations/children Remove Children Associations POST /v2/contents/{id}/associations/parents Add Parent Associations DELETE /v2/contents/{id}/associations/parents Remove Parent Associations GET /v2/contents/{id}/tags Get GRC Object Tags POST /v2/contents/{id}/tags Associate Tags DELETE /v2/contents/{id}/tags Disassociate Tags GET /v2/contents/permissions/allowedtocreatetypes Get Object Types a User Can Create GET /v2/contents/{id}/permissions/allowedtocreatetypes Get Child Object Types that the User can Create for a Specified Parent GET /v2/contents/{id}/associations Get GRC Object Associations POST /v2/contents/{id}/associations Add Associations DELETE /v2/contents/{id}/associations Remove Associations PUT /v2/contents/{id}/action/copy Copy GRC Objects POST /v2/contents/bulk Create Bulk GRC Objects POST /v2/contents Create GRC Object GET /v2/contents/{id} Get GRC Object by ID PUT /v2/contents/{id} Update GRC Object DELETE /v2/contents/{id} Delete Resource GET /v2/contents/deletedresources Find Deleted Resources GET /v2/contents/{id}/permissions/cancreate/{type} GRC Object Can Create Child of Type GET /v2/contents/{id}/associations/children/{child_id} Get GRC Object Child Association by ID GET /v2/contents/{id}/document Get Document Content as Stream PUT /v2/contents/{id}/document Update Document with Stream GET /v2/contents/{id}/permissions/effective GRC Object Effective Permissions GET /v2/contents/template Get New GRC Object Template GET /v2/contents/{id}/associations/parents/{parent_id} Get GRC Object Parent Association by ID GET /v2/contents/{id}/report/{field_name} Get Report Fragment GET /v2/contents/{id}/associations/auditlogs Get Association Audit Logs GET /v2/contents/{id}/fields/auditlogs Get fields Audit Log PUT /v2/contents/{id}/action/lock Lock GRC Object PUT /v2/contents/{id}/action/move Move GRC Objects PUT /v2/contents/{id}/action/overwriteproperties Overwrite Field Values DELETE /v2/contents/{id}/action/purge Purge Resource DELETE /v2/contents/{id}/action/remove_all_locks Remove All Locks PUT /v2/contents/{id}/action/unlock Unlock GRC Object POST /v2/fastmap/import FastMap import POST /v2/fastmap/validate FastMap validate GET /v2/folders Get Root Folder POST /v2/folders Create New Folder GET /v2/folders/{folder_id} Get Folder by ID PUT /v2/folders/{folder_id} Update Folder DELETE /v2/folders/{folder_id} Delete Folder GET /v2/folders/{folder_id}/permissions/effective Get Effective Permissions GET /v2/folders/template Get New Folder Template GET /v2/folders/{folder_id}/resources Get Folder Resources GET /v2/logs/collector/download/{zip_object_id} Get Contents of Log Zip File GET /v2/logs/collect/{process_id} Get subprocess Details for a process. POST /v2/logs/collect Start Logging Process GET /v2/processes/latest/{process_type_id} Get Latest Process for Type GET /v2/processes/{process_id} Get a Process PUT /v2/processes/{process_id} Terminate a Process GET /v2/processes/{process_id}/logs Get Process Logs GET /v2/processes/processtypes Get all Process Types GET /v2/processes Get a list of Processes GET /v2/query Query Service - Get POST /v2/query Query Service - Post GET /v2/search Get Results from Global Search POST /v2/search Global Search - Post POST /v2/rules/run Run routing rules for given object IDs GET /v2/types/{type_id}/associations/{association_id} Get Association Definition by ID GET /v2/types/usages/unclaimed Get all Non provisioned Solutions Usage GET /v2/types/{type_id} Get an Object Type by ID GET /v2/types/{type_id}/associations Get Object Type Associations GET /v2/types Get all Object Types POST /v2/scim/Bulk Process bulk request GET /v2/scim/Groups Get top level groups POST /v2/scim/Groups Create group GET /v2/scim/Groups/{id} Get Group PUT /v2/scim/Groups/{id} Update Group PATCH /v2/scim/Groups/{id} Patch Group GET /v2/scim/ResourceTypes Get resource types GET /v2/scim/ResourceTypes/{resource_name} Get resource type by name GET /v2/scim/Schemas/{schema_id} Get schema by id GET /v2/scim/Schemas List all schemas GET /v2/scim/ServiceProviderConfig Get service provider configuration GET /v2/scim/Users List users POST /v2/scim/Users Create user GET /v2/scim/Users/{id} Get user PUT /v2/scim/Users/{id} Update user PATCH /v2/scim/Users/{id} Patch User GET /v2/workflows/instances/{id} Retrieve workflow instance data for the given workflow instance id GET /v2/workflows/definitions/{id} Get Workflow Process Definition by Id GET /v2/workflows/definitions/version/{id} Get Workflow Process Definition by Version Id GET /v2/workflows/definitions Get Workflow Process Definitions POST /v2/workflows/instances/{id}/transition/{transition} Transition GRC Object to New Workflow State GET /v2/workflows/instances/search Retrieve workflow instances using search parameters POST /v2/workflows/definitions/{id}/start/{grc_object_id} Start the workflow process for the given workflow id and grc object id