Overview
IBM OpenPages is a GRC platform built on a typed content model. The Automize connector works against its REST API: content objects and their associations, types and templates, folders, queries and search, workflows, questionnaires, reporting periods, and FastMap import for bulk loads.
Setting up the connection
Auth type: HTTP Basic.
- Get the server hostname, without a scheme — e.g. openpages.acme.com, or host:port for an on-premise deployment on a non-standard port.
- Use an OpenPages account for HTTP Basic, or a bearer token where the deployment issues them. Supply one or the other, not both.
- Give the account only the object types and folders the process touches — OpenPages authorises per type.
- In Automize, open Settings → Connectors → IBM OpenPages → Add connection and fill in the server plus either the username and password or the token.
Available operations
32 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Add Child Associations | General | Associate child objects with a parent object |
| Create Content | General | Create a GRC object. The body carries the object's type, name, parent and field values |
| Create Contents (bulk) | General | Create several GRC objects in one call |
| Delete Content | General | Delete a GRC object (recoverable until purged) |
| FastMap Import | General | Import a validated FastMap file. Bulk-writes GRC objects — validate first |
| FastMap Validate | General | Validate a FastMap import file WITHOUT importing it — always run this first |
| Get Associations | General | Get an object's associated objects |
| Get Content | General | Get one GRC object by its ID |
| Get Content Audit Log | General | Get the field-level audit log for an object |
| Get Content Template | General | Get a blank object template for a type — the shape a create should follow |
| Get Current Reporting Period | General | Get the instance's current reporting period |
| Get Folder Resources | General | List the objects held in a folder |
| Get Questionnaire Assessment | General | Get a questionnaire's assessment results |
| Get Questionnaire Template | General | Get a questionnaire's template |
| Get Type | General | Get one object type's schema, including its fields |
| Get Type Associations | General | Get the association types available on an object type |
| List Currencies | General | List configured currencies |
| List Folders | General | List folders |
| List Profiles | General | List the security/UI profiles configured on the instance |
| List Reporting Periods | General | List all reporting periods |
| List Types | General | List the object types this instance defines — call this first to learn what it holds |
| List Workflow Definitions | General | List workflow definitions |
| Lock Content | General | Lock an object against concurrent edits |
| Query | General | Run a SQL-like query over GRC content. This is how you read a SET of objects — there is no per-type list endpoint. |
| Remove Child Associations | General | Remove child associations from a parent object |
| Run Rules | General | Run configured rules against GRC content |
| Search | General | Search GRC content through the search engine |
| Search Workflow Instances | General | Search running workflow instances |
| Start Workflow | General | Start a workflow definition on a GRC object |
| Transition Workflow | General | Move a workflow instance through a named transition |
| Unlock Content | General | Release a lock held on an object |
| Update Content | General | Update a GRC object's fields |
Operations
Add Child Associations
Associate child objects with a parent object
| Parameter | Required | Type | Description |
|---|---|---|---|
Parent object ID id | Yes | string |
Create Content
Create a GRC object. The body carries the object's type, name, parent and field values
No input parameters.
Create Contents (bulk)
Create several GRC objects in one call
No input parameters.
Delete Content
Delete a GRC object (recoverable until purged)
| Parameter | Required | Type | Description |
|---|---|---|---|
Object ID id | Yes | string |
FastMap Import
Import a validated FastMap file. Bulk-writes GRC objects — validate first
No input parameters.
FastMap Validate
Validate a FastMap import file WITHOUT importing it — always run this first
No input parameters.
Get Associations
Get an object's associated objects
| Parameter | Required | Type | Description |
|---|---|---|---|
Object ID id | Yes | string |
Get Content
Get one GRC object by its ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Object ID id | Yes | string |
Get Content Audit Log
Get the field-level audit log for an object
| Parameter | Required | Type | Description |
|---|---|---|---|
Object ID id | Yes | string |
Get Content Template
Get a blank object template for a type — the shape a create should follow
No input parameters.
Get Current Reporting Period
Get the instance's current reporting period
No input parameters.
Get Folder Resources
List the objects held in a folder
| Parameter | Required | Type | Description |
|---|---|---|---|
Folder ID folder_id | Yes | string |
Get Questionnaire Assessment
Get a questionnaire's assessment results
| Parameter | Required | Type | Description |
|---|---|---|---|
Questionnaire ID id | Yes | string |
Get Questionnaire Template
Get a questionnaire's template
| Parameter | Required | Type | Description |
|---|---|---|---|
Questionnaire ID id | Yes | string |
Get Type
Get one object type's schema, including its fields
| Parameter | Required | Type | Description |
|---|---|---|---|
Type ID type_id | Yes | string |
Get Type Associations
Get the association types available on an object type
| Parameter | Required | Type | Description |
|---|---|---|---|
Type ID type_id | Yes | string |
List Currencies
List configured currencies
No input parameters.
List Folders
List folders
No input parameters.
List Profiles
List the security/UI profiles configured on the instance
No input parameters.
List Reporting Periods
List all reporting periods
No input parameters.
List Types
List the object types this instance defines — call this first to learn what it holds
No input parameters.
List Workflow Definitions
List workflow definitions
No input parameters.
Lock Content
Lock an object against concurrent edits
| Parameter | Required | Type | Description |
|---|---|---|---|
Object ID id | Yes | string |
Query
Run a SQL-like query over GRC content. This is how you read a SET of objects — there is no per-type list endpoint.
No input parameters.
Remove Child Associations
Remove child associations from a parent object
| Parameter | Required | Type | Description |
|---|---|---|---|
Parent object ID id | Yes | string |
Run Rules
Run configured rules against GRC content
No input parameters.
Search
Search GRC content through the search engine
No input parameters.
Search Workflow Instances
Search running workflow instances
No input parameters.
Start Workflow
Start a workflow definition on a GRC object
| Parameter | Required | Type | Description |
|---|---|---|---|
Workflow definition ID id | Yes | string | |
GRC object ID grc_object_id | Yes | string |
Transition Workflow
Move a workflow instance through a named transition
| Parameter | Required | Type | Description |
|---|---|---|---|
Workflow instance ID id | Yes | string | |
Transition name transition | Yes | string |
Unlock Content
Release a lock held on an object
| Parameter | Required | Type | Description |
|---|---|---|---|
Object ID id | Yes | string |
Update Content
Update a GRC object's fields
| Parameter | Required | Type | Description |
|---|---|---|---|
Object ID id | Yes | string |
FAQ
- When should I use FastMap instead of Create Contents?
- Create Contents (bulk) posts objects through the ordinary API. FastMap Import runs OpenPages' own import, which is what you want for a large load or one that spans related object types. Run FastMap Validate first — it reports what the import would reject without writing anything.
- Why does a create fail on a field that exists in the UI?
- Fields belong to a type, and the type governs what a create will accept. Get Type and Get Content Template return the writable field set for the object you are creating.