IBM OpenPages with Watson REST API Reference API Reference
Public Reference documentation for the IBM OpenPages with Watson REST API.
This document applies to IBM OpenPages with Watson Version 8.1 and may also apply to subsequent releases.
Licensed Materials - Property of IBM Corporation.
© Copyright IBM Corporation, 2003, 2022.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: http, https
Version: 8.1
configuration
Get All Application Text
Get all the Localized Application Text labels for the current user's locale. Optionally use parameter categoryFilters to filter application texts by category names. Also use optional parameter includeLocalizedLabels to include localized labels for all the locales.
includeLocalizedLabels:
boolean
false
in query
Include localized labels for all the locales.
categoryFilters:
string
in query
Filter application texts by category names.
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"name": "string",
"category": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
}
}
]
Get Profile Fields for View
Get field definitions with profile context for a particular view on an object type e.g.Fields from Detail view for SOXBusEntity.
profile:
string
in query
Profile name
type:
string
in query
Object Type system name
view:
string
in query
View name
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "string",
"description": "string",
"isDefault": "boolean",
"isFallback": "boolean",
"isEnabled": "boolean",
"isDeleted": "boolean"
}
Get Base Currency
Get Base Currency information for this system. Base currency is typically set at install time.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"isoCode": "string",
"name": "string",
"symbol": "string",
"precision": "integer (int32)",
"isBaseCurrency": "boolean",
"isEnabled": "boolean",
"id": "string"
}
Get Currency by ISO code
Get single Currency details by ISO code.
code:
string
in path
ISO currency code.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"isoCode": "string",
"name": "string",
"symbol": "string",
"precision": "integer (int32)",
"isBaseCurrency": "boolean",
"isEnabled": "boolean",
"id": "string"
}
Set Currency status
Set single Currency status to be enabled or disabled.
code:
string
in path
ISO currency code.
enable:
boolean
in query
Status to set on the currency.
default
successful operation
Response Content-Types: application/json
Decrypt using External Key
Decrypt all data (OpenPages storage, sensitive infomation in OpenPages database) using external key
200 OK
successful operation
type
string
Response Content-Types: application/json
Response Example (200 OK)
"string"
Get Current Reporting Period
Get the Current Reporting Period information
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"label": "string",
"description": "string",
"finalizedDate": "string (date-time)",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)"
}
Enable/Disable Trace options
Enable/Disable Trace options from UI
Logger List
Request Example
{
"traceList": [
{
"value": "string",
"name": "string",
"path": "string"
}
]
}
default
successful operation
Response Content-Types: application/json
PUT /configuration/integrateCognosService
default
successful operation
Response Content-Types: application/json
Get Localized Application Text
Get the Localized Application Text label for the current user's locale.
textKey:
string
in path
The application text key for example: "com.label.activityview.detailview"
200 OK
successful operation
type
string
Response Content-Types: application/json
Response Example (200 OK)
"string"
Get Reporting Period by Name
Get specific Reporting Period by name.
reportingPeriod:
string
in path
The name of the Reporting Period.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"label": "string",
"description": "string",
"finalizedDate": "string (date-time)",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)"
}
Get System Admin Mode
Get status of System Admin Mode either true or false.
200 OK
successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
"boolean"
Set System Admin Mode
Set status of System Admin Mode either enabled true or false. Requires System Administration Mode permission.
enable:
boolean
in query
Set true to enable admin mode, false to disable.
default
successful operation
Response Content-Types: application/json
Get Exchange Rates for Currency
Get Exchange rates for a currency for a specified ISO currency code. The default response returns current exchange rate. To get the exchange rate as of a particular date, use the date parameter.
code:
string
in path
ISO currency code.
date:
string
in query
The date to retrieve the currency. Expected Date Format is ISO 8601 'yyyyMMdd'T'HHmmss'Z''
history:
boolean
in query
Return all the historical currencies if the date is not specified.
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "string",
"currencyCode": "string",
"rate": "number (double)",
"startDate": "string (date-time)",
"endDate": "string (date-time)"
}
]
Set Exchange Rate for Currency
Sets a Currency exchange rate.
Exchange rate to set on Currency. Each exchange rate must contain both the currencyCode and rate and if startDate is not provided, the default value will be the current date.
code:
string
in path
ISO currency code.
Request Content-Types: application/json
Request Example
{
"id": "string",
"currencyCode": "string",
"rate": "number (double)",
"startDate": "string (date-time)",
"endDate": "string (date-time)"
}
default
successful operation
Encrypt using External Key
Encrypt all data (OpenPages storage, sensitive infomation in OpenPages database) using external key
200 OK
successful operation
type
string
Response Content-Types: application/json
Response Example (200 OK)
"string"
Get Profile Definition
Get a full profile definition including object types, fields and views.
profile:
string
in path
Profile name or Id.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "string",
"description": "string",
"isDefault": "boolean",
"isFallback": "boolean",
"isEnabled": "boolean",
"isDeleted": "boolean"
}
Get Profile by Id
Get a single Profile summary.
profile:
string
in path
Profile name or Id.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"id": "string",
"description": "string",
"isDefault": "boolean",
"isFallback": "boolean",
"isEnabled": "boolean",
"isDeleted": "boolean"
}
Get All Reporting Periods
Get list of all Reporting Periods.
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "string",
"label": "string",
"description": "string",
"finalizedDate": "string (date-time)",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)"
}
]
Get Currencies
Get a list of all currencies. Use onlyEnabled query parameter to request either all currencies (false) or only the enabled currencies (true).
onlyEnabled:
boolean
in query
(no description)
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"isoCode": "string",
"name": "string",
"symbol": "string",
"precision": "integer (int32)",
"isBaseCurrency": "boolean",
"isEnabled": "boolean",
"id": "string"
}
]
Get Setting
Get configuration setting value by path.
settingPath:
string
in path
The setting path for example /OpenPages/Applications/GRCM/Audit Trail/Show Audit Trail For Custom Forms. Notice as the path contains '/' it must be URL encoded.
200 OK
successful operation
404 Not Found
Requested Setting was not found.
Response Content-Types: application/json
Response Example (200 OK)
{
"key": "string",
"value": "string"
}
Get Profiles
Get list of all Profiles summary information.
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"name": "string",
"id": "string",
"description": "string",
"isDefault": "boolean",
"isFallback": "boolean",
"isEnabled": "boolean",
"isDeleted": "boolean"
}
]
Set Multiple Exchange Rates
Sets Currency exchange rates with a list of exchange rates for multiple currencies.
List of exchange rates to set. Each exchange rate must contain both the currencyCode and rate and if startDate is not provided, the default value will be the current date.
Request Content-Types: application/json
Request Example
[
{
"id": "string",
"currencyCode": "string",
"rate": "number (double)",
"startDate": "string (date-time)",
"endDate": "string (date-time)"
}
]
default
successful operation
Get Child Setting
Get value for all child configuration under given path.
settingPath:
string
in path
Get the child settings for given path for example /OpenPages/Platform/CP4D/Sync/Profiles. Notice as the path contains '/' it must be URL encoded.
200 OK
successful operation
404 Not Found
Requested Setting was not found.
Response Content-Types: application/json
Response Example (200 OK)
{
"key": "string",
"value": "string"
}
contents
Get Report Fragment
For a GRC Object, invoke Cognos report fragment by field name of the fragment.
id:
string
in path
GRC Object Id or Path.
fieldName:
string
in path
System name of the report fragment field.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean",
"value": "string"
}
Get GRC Object Associations
Get a list of all GRC Object Associations to other GRC Objects.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path. Examples:
- Id: 3456
- Relative: Issue/Test 01/Issue 1
- Full Path: /_op_sox/Project/Default/Issue/Test 01/Issue 1.txt
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"typeDefinitionId": "string",
"path": "string",
"associationDefinitionId": "string",
"type": "string"
}
]
Add Associations
Add associations from one GRC Object to one or more other GRC Objects as either parents or children. In each AssociationNodeType in the request, you must set the Id attribute to be the target of the association.
Request body list of assocations to create.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path.
Request Content-Types: application/json
Request Example
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"typeDefinitionId": "string",
"path": "string",
"associationDefinitionId": "string",
"type": "string"
}
]
400 Bad Request
association id cannot be null.
Remove Associations
Remove associations from one GRC Object to one or more other GRC Objects.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path.
parents:
string
in query
Comma-delimited list of parent Ids
children:
string
in query
Comma-delimited list of child Ids
default
successful operation
Move GRC Objects
Moves a list of GRC Objects to this parent GRC object specified by the Id. Example of a move action request:
{
id:["12345"],
options:{
includeChildren: true,
conflictBehavior: "OVERWRITE",
typeDefinitions:["SOXIssue"],
}
}
Request body containing the list of Ids of objects to be moved and options for the move action.
id:
string
in path
Parent GRC Object Id or Path to move the other objects to.
Request Content-Types: application/json
Request Example
{
"id": [
"string"
],
"options": {
"includeChildren": "boolean",
"conflictBehavior": "string",
"typeDefinitions": [
"string"
],
"typeAssociations": [
{
"parentObjectType": "string",
"childObjectType": "string"
}
],
"autoNameChildren": "boolean"
}
}
default
successful operation
Response Content-Types: application/json
Unlock GRC Object
Unlock a single GRC Object if it was locked.
id:
string
in path
GRC Object Id or Path to unlock.
default
successful operation
Response Content-Types: application/json
Permission to Create Objects - Globally
Get for a given list of Object Types which types is a user potentially allowed to create given the current security assigned to the user and any security rules which may apply globally. Users may test their own permissions, a Super Administrator or a Security Administrator may test the permissions for other users using the userId parameter.
user:
string
in query
User name or id to check permissions for, if null use current user from session. Only allowed for Super Administrator or Security Administrator user otherwise responds with Not Authorized.
types:
string
in query
List of Object Types to check. Comma-separated list of type names or ids, if null the default is a list of all types in the system.
200 OK
successful operation
type
string[]
Response Content-Types: application/json
Response Example (200 OK)
[
"string"
]
Permission to Create Objects for Parent
Get for a given list of Object Types which types is a user potentially allowed to create given the current security assigned to the user and any security rules which may apply globally. Users may test their own permissions, a Super Administrator or a Security Administrator may test the permissions for other users using the userId parameter.
id:
string
in path
GRC Object Id or Path.
types:
string
in query
List of Object Types to check. Comma-separated list of type names or ids, if null the default is a list of all types in the system.
200 OK
successful operation
type
string[]
Response Content-Types: application/json
Response Example (200 OK)
[
"string"
]
Get GRC Object Child Associations
Get a list of all GRC Object child associations to children GRC Objects.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path. Examples:
- Id: 3456
- Relative: Issue/Test 01/Issue 1
- Full Path: /_op_sox/Project/Default/Issue/Test 01/Issue 1.txt
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"typeDefinitionId": "string",
"path": "string",
"associationDefinitionId": "string",
"type": "string"
}
]
Add Child Associations
Add child associations from one GRC Object to one or more children GRC Objects.
Request body list of child assocations to create.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path.
Request Content-Types: application/json
Request Example
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"typeDefinitionId": "string",
"path": "string",
"associationDefinitionId": "string",
"type": "string"
}
]
400 Bad Request
association id cannot be null.
Remove Children Associations
Remove children associations from one GRC Object to one or more child GRC Objects.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path.
children:
string
in query
Comma-delimited list of child Ids
default
successful operation
GRC Object Effective Permissions
Get the effective permissions for a user on a GRC Object resource. Users may test their own permissions, a Super Administrator or a Security Administrator may test the permissions for other users using the userId parameter.
id:
string
in path
GRC Object Id or Path.
user:
string
in query
User name or id to check permissions for, if null use current user from session. Only allowed for Super Administrator or Security Administrator user otherwise responds with Not Authorized.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"folderId": "string",
"securityPrincipal": "string",
"canRead": "boolean",
"canWrite": "boolean",
"canDelete": "boolean",
"canAssociate": "boolean"
}
Get GRC Object Parent Associations
Get a list of all GRC Object Parent Associations to parent GRC Objects.
id:
string
in path
(no description)
parentId:
string
in path
(no description)
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"typeDefinitionId": "string",
"path": "string",
"associationDefinitionId": "string",
"type": "string"
}
]
Get Document Content as Stream
Retrieve the file contents of a Document as a binary sequence of bytes. The response content type will always be a binary stream of content but the request may specify which MIME type.
id:
string
in path
The Document Id or path. Non-document GRC Objects are not supported.
mimeType:
string
in query
MIME Type of the content in the response.
default
successful operation
Response Content-Types: application/octet-stream
Update Document with Stream
Update an existing Document attachment instance by sending the content as raw binary stream which is more efficient than the JSON/Base64 methods.
New document content as a sequence of bytes.
id:
string
in path
The Document Id or path.
Request Example
"object"
default
successful operation
Get GRC Object Parent Associations
Get a list of all GRC Object parent associations to parent GRC Objects.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path. Examples:
- Id: 3456
- Relative: Issue/Test 01/Issue 1
- Full Path: /_op_sox/Project/Default/Issue/Test 01/Issue 1.txt
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"typeDefinitionId": "string",
"path": "string",
"associationDefinitionId": "string",
"type": "string"
}
]
Add Parent Associations
Add parent associations from one GRC Object to one or more parent GRC Objects.
Request body list of parent assocations to create.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path.
Request Content-Types: application/json
Request Example
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"typeDefinitionId": "string",
"path": "string",
"associationDefinitionId": "string",
"type": "string"
}
]
400 Bad Request
association id cannot be null.
Remove Parent Associations
Remove parent associations from one GRC Object to one or more parent GRC Objects.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path.
parents:
string
in query
Comma-delimited list of parent Ids
default
successful operation
Get Document Content
Deprecated Retrieve the file contents of a Document as a binary sequence of bytes. This method is deprecated and instead should use Get Document Content as Stream.
id:
string
in path
The Document Id or path. Non-document GRC Objects are not supported.
filename:
string
in path
The file name of the Document to retrieve.
200 OK
successful operation
type
string[]
Response Example (200 OK)
[
"string (byte)"
]
Update Document Content
Deprecated Update an existing Document attachment instance. This method is Deprecated and for larger document attachments use Update Document with Stream method.
undefined
id:
string
in path
(no description)
filename:
string
in path
(no description)
Request Content-Types: application/json
Request Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string",
"fileTypeDefinition": {
"fileExtension": "string",
"mimeType": "string",
"id": "string"
},
"contentDefinition": {
"attribute": {
"type": "string",
"src": "string"
},
"children": "string"
}
}
default
successful operation
Get Field Audit Logs
Get a list of FieldAuditLogs for the GRC Object specified by the id. If no filter is specified, then all field logs are retrieved. To specify the filters, a query parameter is used.
id:
string
in path
GRC Object Id or Path
fieldFilters:
string
in query
Filter which fields' audit logs to retrieve. Comma-delimited list of field system names.
startDate:
string
in query
Start of date range in audit logs. Accepts ISO8601 date format. "yyyMMdd'T'HHmmssZ"
endDate:
string
in query
End of date range in audit logs. Accepts ISO8601 date format. "yyyMMdd'T'HHmmssZ"
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "string",
"name": "string",
"modifiedBy": "string",
"modifiedDate": "string (date-time)",
"oldValue": "string",
"newValue": "string"
}
]
Purge Resource
Purge a resource to fully remove all references to the object from the system, including past versions, audit trail, openpages storage and records from reporting periods. This operation can only be performed by a Super Administrator user and can not be undone.
id:
string
in path
GRC Object Id, the Id can be an object id or a soft deleted object id.
default
successful operation
Get GRC Object by Id
Get a GRC Object instance by Id or a relative path. Use optional parameters to control data returned.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path. Examples:
- Id: 3456
- Relative: Issue/Test 01/Issue 1
- Full Path: /_op_sox/Project/Default/Issue/Test 01/Issue 1.txt
fieldFilters:
string
in query
List of fields to include in response. Comma-delimited list of system names of fields for the Object Type. Default response includes all fields.
includeAssociations:
string
NONE,
BOTH,
PARENT,
CHILD
NONE
in query
Assocations to other GRC Objects. Defaults to NONE for optimal performance.
associationTypeFilters:
string
in query
If including Associations, list of Object Types to include.
reportingPeriodLabel:
string
Current Reporting Period
in query
Reporting Period name to retrieve the GRC Object from a particular period. Default will be from the Current Period if not specified.
evaluateComputedFields:
string
false
in query
Computed fields are not evaluated by default. To include evaluated calculations in response set to true.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string"
}
Update GRC Object
Update an existing GRC Object instance or document. For larger document attachments use Update Document - Binary method.Sample updating a GRC Object:
{
"fields":{
"field":[
{
"name":"objFieldString",
"dataType":"STRING_TYPE",
"value":"{STRING_VALUE}"
},
{
"name":"objFieldInteger",
"dataType":"INTEGER_TYPE",
"value":"{INTEGER_VALUE}"
},
{
"name":"objFieldDecimal",
"dataType":"FLOAT_TYPE",
"value":"{FLOAT_VALUE}"
},
{
"name":"objFieldBoolean",
"dataType":"BOOLEAN_TYPE",
"value":"{TRUE_OR_FALSE}"
},
{
"name":"objFieldDate",
"dataType":"DATE_TYPE",
"value":"{DATE_VALUE}"
},
{
"name":"objFieldCurrency",
"dataType":"CURRENCY_TYPE",
"baseAmount": {NUMERIC_BASE_AMOUNT},
"localAmount": {NUMERIC_LOCAL_AMOUNT},
"exchangeRate": {NUMERIC_EXCHANGE_RATE},
"baseCurrency":{
"isoCode":"{BASE_ISO}"
},
"localCurrency":{
"isoCode":"{LOCAL_ISO}"
}
},
{
"name":"objFieldEnum",
"dataType":"ENUM_TYPE",
"enumValue":{
"name":"{ENUM_VALUE}",
"localizedLabel":"{ENUM_LABEL}",
"index": {ENUM_INDEX}
}
},
{
"name":"objFieldMulValEnum",
"dataType":"MULTI_VALUE_ENUM",
"multiEnumValue":{
"enumValue":[
{
"name":"{ENUM_VALUE_1}"
},
{
"name":"{ENUM_VALUE_2}"
}
]
}
}
]
},
"typeDefinitionId":"5",
"primaryParentId":"20",
"name":"testObj5",
"description":"test object description"
}
Sample updating a GRC Object and set empty fields' values.
{
"fields":{
"field":[
{
"name":"objFieldString",
"dataType":"STRING_TYPE",
"value":null
},
{
"name":"objFieldInteger",
"dataType":"INTEGER_TYPE",
"value":null
},
{
"name":"objFieldDecimal",
"dataType":"FLOAT_TYPE",
"value":null
},
{
"name":"objFieldBoolean",
"dataType":"BOOLEAN_TYPE",
"value":null
},
{
"name":"objFieldDate",
"dataType":"DATE_TYPE",
"value":null
},
{
"name":"objFieldCurrency",
"dataType":"CURRENCY_TYPE",
"isAmountNull":true
},
{
"name":"objFieldEnum",
"dataType":"ENUM_TYPE",
"enumValue":{
}
},
{
"name":"objFieldMulValEnum",
"dataType":"MULTI_VALUE_ENUM",
"multiEnumValue":{
"enumValue":[
]
}
}
]
},
"typeDefinitionId":"5",
"primaryParentId":"20",
"name":"testObj5",
"description":"test object description"
}
typeDefinitionIdcould be either an Object Type's Id:123or it's system nameSOXIssue. Note that Object Type labels are not supported.primaryParentIdcould be either another GRC Object Type's Id:10101or it's full path:/_op_sox/Project/Default/Issue/Parent-Issue.txt- For every field in the
fieldsthe field must be identified uniquely by either the field's id attribute or"id": "456"or name attribute"name": "OPSS-Iss:Status" - When updating a GRC Object and setting field types "MEDIUM_STRING_TYPE" and "LARGE_STRING_TYPE" values to null, the values for those fields will be an empty String "" instead of NULL
Request body containing GRC Object Type or Document details.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path. Examples:
- Id: 3456
- Relative: Issue/Test 01/Issue 1
- Full Path: /_op_sox/Project/Default/Issue/Test 01/Issue 1.txt
Request Content-Types: application/json
Request Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string",
"fileTypeDefinition": {
"fileExtension": "string",
"mimeType": "string",
"id": "string"
},
"contentDefinition": {
"attribute": {
"type": "string",
"src": "string"
},
"children": "string"
}
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string"
}
Delete GRC Object
Delete a GRC Object instance by Id. This performs a "soft delete" and some information may be retrieved using the Find Deleted Resources method.
id:
string
in path
The GRC Object Id or path.
default
successful operation
Get New GRC Object Template
Gets an empty GRC Object template that can be used to create a new object instance. The response body may be used to construct the request body for a new object to the /contents POST method.
typeId:
string
in query
Object Type system name or Id for the new template.
fileTypeId:
string
in query
For document attachment File Types in addition to the typeId for the SOXDocument or other type, you must specify a fileTypeId for desired File content type. These file type ids are available in /grc/api/types/{TypeID} for document object types.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string"
}
Remove All Locks
Remove all locks from the GRC Object specified and also any locks present in the hierarchy below the specificed object.
id:
string
in path
GRC Object Id or Path to remove locks from.
default
successful operation
Response Content-Types: application/json
Create GRC Object
Create new GRC Object instance. Can also create Document types with attachment content. Sample creating a GRC Object:
{
"fields":{},
"typeDefinitionId": "5",
"primaryParentId": "20",
"name": "testObj5",
"description": "test object description"
}
Sample creating a Document with attachment contents in the 'contentDefinition.children' attribute of the JSON, in this example it is plain text. For binary file formats you must Base64 encode the file contents:
{
"contentDefinition":
{
"attribute":
{
"type": "text/plain"
},
"children": "Created this document using API"
},
"fileTypeDefinition":
{
"id": "9",
"mimeType": "text/plain",
"fileExtension": "txt"
},
"fields":{},
"typeDefinitionId": "4",
"name": "MytestDoc1",
"description": "TestDocument created using json"
}
The Ids used for type definitions and file types are available in the /types API.
typeDefinitionIdcould be either an Object Type's Id:123or it's system nameSOXIssue. Note that Object Type labels are not supported.primaryParentIdcould be either another GRC Object Type's Id:10101or it's full path:/_op_sox/Project/Default/Issue/Parent-Issue.txt- For every field in the
fieldsthe field must be identified uniquely by either the field's id attribute or"id": "456"or name attribute"name": "OPSS-Iss:Status"
Request body containing GRC Object Type or Document details.
Request Content-Types: application/json
Request Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string",
"fileTypeDefinition": {
"fileExtension": "string",
"mimeType": "string",
"id": "string"
},
"contentDefinition": {
"attribute": {
"type": "string",
"src": "string"
},
"children": "string"
}
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string",
"fileTypeDefinition": {
"fileExtension": "string",
"mimeType": "string",
"id": "string"
},
"contentDefinition": {
"attribute": {
"type": "string",
"src": "string"
},
"children": "string"
}
}
Get Association Audit Logs
Get a list of AssociationAuditLogs for the GRC Object specified by the id. If no filter is specified, then all association logs are retrieved. To specify the filters, a query parameter is used.
id:
string
in path
GRC Object Id or Path
associationFilters:
string
in query
Filter which object types of associations to retrieve. Comma-delimited list of type names.
startDate:
string
in query
Start of date range in audit logs. Accepts ISO8601 date format. "yyyMMdd'T'HHmmssZ"
endDate:
string
in query
End of date range in audit logs. Accepts ISO8601 date format. "yyyMMdd'T'HHmmssZ"
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "string",
"name": "string",
"associatedObjectType": "string",
"modifiedBy": "string",
"modifiedDate": "string (date-time)",
"status": "string"
}
]
Get GRC Object Child Association by Id
Get a single GRC Object Child Association details.
id:
string
in path
The GRC Object Id or path. Path may be relative or a full path. Examples:
- Id: 3456
- Relative: Issue/Test 01/Issue 1
- Full Path: /_op_sox/Project/Default/Issue/Test 01/Issue 1.txt
childId:
string
in path
The Id of the child object that is associated to this GRC Object.
200 OK
successful operation
404 Not Found
childId : {childId} not found.
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"typeDefinitionId": "string",
"path": "string",
"associationDefinitionId": "string",
"type": "string"
}
GRC Object Can Create Child of Type
Check whether or not a user can create a new GRC Object of a specific child type in the context of an intended parent GRC Object and folder based on the current user's permissions and security rules.
id:
string
in path
GRC Object Id or Path.
type:
string
in path
The child Object Type.
folder:
string
in query
The folder id for the context to check whether the user can create a child object, if null then determine the default folder.
200 OK
successful operation
type
boolean
Response Content-Types: application/json
Response Example (200 OK)
"boolean"
Overwrite Field Values
Overwrite text fields of a object with a specific value. This operation can only be performed by a Super Administrator user and can not be undone. Limitations:
- The data type of specific fields must be string or long string.
- The display type of specific fields in any profile must be one of text, text area, rich text, on demand, on demand rich text and automatic.
- For system fields, only the description field and the comment field are allowed.
- Encrypted fields are not allowed.
- The new value cannot be null or empty.
id:
string
in path
GRC Object Id
fields:
string
in query
Comma-delimited list of field definition Ids to which the new value is overwritten
value:
string
in query
New value to overwrite. Must not be empty.
default
successful operation
Copy GRC Objects
Copies a list of GRC Objects to this GRC object specified by the Id. Example of a copy action request:
{
id:["12345"],
options:{
includeChildren: true,
conflictBehavior: "CREATECOPYOF",
typeDefinitions:["SOXIssue"],
typeAssociations:[
{
parentObjectType: "SOXProcess",
childObjectType: "SOXIssue"
}
],
autoNameChildren:false
}
}
The respone contains a list of the copies that were made.
Request body containing the list of Ids of objects to be copied and options for the copy action.
id:
string
in path
Parent GRC Object Id or Path to copy the other objects to.
Request Content-Types: application/json
Request Example
{
"id": [
"string"
],
"options": {
"includeChildren": "boolean",
"conflictBehavior": "string",
"typeDefinitions": [
"string"
],
"typeAssociations": [
{
"parentObjectType": "string",
"childObjectType": "string"
}
],
"autoNameChildren": "boolean"
}
}
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string"
}
]
Find Deleted Resources
Query for deleted resources using filters. Can use paging for results. This operation can only be performed by a Super Administrator user. The results from this method can be used in the Purge Resource method.
filter:
string
in query
A filter to narrow deleted resource results. For example: filter=Description like 'name'.
startRow:
integer
(int32)
0
in query
Paging start row index
endRow:
integer
(int32)
0
in query
Paging end row index
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"creator": "string",
"lastModifiedBy": "string",
"typeDefinitionId": "string"
}
]
Lock GRC Object
Lock a single GRC Object.
id:
string
in path
GRC Object Id or Path to lock.
default
successful operation
Response Content-Types: application/json
folders
Get Folder by Id
Gets specific Folder resource information by Id.
folderId:
string
in path
Folder Id
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string"
}
Update Folder
Update an existing Folder.
Request body updated folder object.
folderId:
string
in path
Id of Folder to be updated
Request Content-Types: application/json
Request Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string"
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string"
}
Delete Folder
Delete a Folder by Id. All containees are deleted as well. Cannot be undone.
folderId:
string
in path
Folder Id to delete
default
successful operation
Get Folder Containees
Gets all resources contained in a folder. Results may be either GRC Object content or other Folders.
folderId:
string
in path
Folder Id to get containees of.
includeContainees:
string
FOLDER,
GRCOBJECT,
BOTH
BOTH
in query
Which types of containees to return.
200 OK
List of containees which may be GRCObjectType or FolderType
Response Content-Types: application/json
Get Effective Permissions
Find the effective permissions (ACL) for a user on a GRC Object resource. Example path for GET request: /folders/1234/effectivePermissions?user=bill
folderId:
string
in path
Folder Id to get permissions on.
user:
string
in query
User name or Id. If not provided will get effective permissions for current user.
200 OK
successful operation
403 Forbidden
If user parameter is specified the current user must have administrative access to see that user's permissions.
Response Content-Types: application/json
Response Example (200 OK)
{
"folderId": "string",
"securityPrincipal": "string",
"canRead": "boolean",
"canWrite": "boolean",
"canDelete": "boolean",
"canAssociate": "boolean"
}
Get Root Folder
Get the root Folder resource for the OpenPages with Watson with full path of "/"
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string"
}
]
Create New Folder
Create a new Folder. See /folders/template GET method to get a template folder that may be used to construct the request body to this method.
Request body new folder object.
Request Content-Types: application/json
Request Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string"
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string"
}
Get New Folder Template
Gets an empty Folder template that can be used to create a new folder. The response body may be used to construct the request body for a new folder to the /folders POST method.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string"
}
processes
Get a Process
Get a specific Process instance information by Id
processId:
string
in path
Process instance Id
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
Terminate a Process
Terminates a Process instance. Will stop the process instance execution and can not be undone.
processId:
string
in path
Process instance Id
action:
string
terminate
in query
What terminate action to perform
200 OK
successful operation
type
400 Bad Request
provide a valid action name
Response Content-Types: application/json
Response Example (200 OK)
[
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
Get all Process Types
Get all Process Types in the Long Running Process Framework (LRPF).
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"processTypeId": "string",
"name": "string",
"description": "string",
"defaultTimeSeconds": "integer (int32)",
"isMultipleInstance": "boolean",
"isTerminateUponStart": "boolean"
}
]
Get Process Logs
Get Process for a Process instance. The maximum logs that may be returned in one response 10000 for performance. Use paging parameters to retrieve more logs.
processId:
string
in path
Process instance Id
includeLocalizedStatus:
boolean
false
in query
Whether includes localized status labels
startRow:
integer
(int32)
0
in query
Paging start row index (1-based)
endRow:
integer
(int32)
0
in query
Paging end row index (1-based)
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
Get Latest Process for type
Get the latest specific Process instance information by Process Type Id.
processTypeId:
string
in path
Process Type Id
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
Get a list of Processes
Get a list Process instance information by Id
processId:
string
in query
Process instance Id
parentProcessId:
string
in query
The parent Process Id of queried processes
processTypeId:
string
in query
The Process type id of queried processes
status:
string
in query
The Process status of queried processes
createdOnBegin:
string
in query
The starting range of the created time of queried processes in XMLGregorianCalendar pattern "yyyy-MM-dd'T'HH:mm:ss'Z'"
createdOnEnd:
string
in query
The ending range of the created time of queried processes in XMLGregorianCalendar pattern "yyyy-MM-dd'T'HH:mm:ss'Z'"
createdBy:
string
in query
The Process creator (user) name of queried processes
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
query
Query Service - Get
Service to query content based on SQL-like syntax with parameters passed by query. Supports paging of results and default page size is 50. Refer to the OpenPages GRC API Javadocs for more detail on Query Service syntax. Results honor the current user's security permissions including role-based and security rules. Important: Using the select * is not supported in combination with reporting schema excluded fields on the object type. Instead, define the select statements using column names explicitly that return the subset of fields that are available and necessary to satisfy your requirements.
q:
string
in query
Query statement.Is required and must follow Query-Service syntax.
skipCount:
integer
(int32)
0
in query
Number of results to be skipped. Used for paging.
caseInsensitive:
boolean
false
in query
Specify if string comparisons should be case-insensitive. Applies to all comparisons in WHERE clause.
pageSize:
integer
(int32)
50
in query
Number of results to return, starting from skipCount.
maxRows:
integer
(int32)
0
in query
Maximum number of results the query service retrieves from the database. Use 0 for all rows.
honorPrimary:
boolean
false
in query
If JOIN syntax is used between Object Types, specifies whether to restrict to only include primary associations.
includeLinks:
boolean
true
in query
If results should have HATEOS style links for pagination in the response.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"rows": [
{
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
}
}
]
}
Query Service - Post
Service to query content based on SQL-like syntax using POST method. Can use when query statement is lengthy or cannot be encoded. Supports paging of results and default page size is 50. Refer to the OpenPages GRC API Javadocs for more detail on QueryService syntax. Results honor the current user's security permissions including role-based and security rules. Important: Using the select * is not supported in combination with reporting schema excluded fields on the object type. Instead, define the select statements using column names explicitly that return the subset of fields that are available and necessary to satisfy your requirements.
Request body query parameters. Statement attribute is required and must follow Query-Service syntax
Request Content-Types: application/json
Request Example
{
"statement": "string",
"skipCount": "integer (int32)",
"caseInsensitive": "boolean",
"pageSize": "integer (int32)",
"maxRows": "integer (int32)",
"honorPrimary": "boolean",
"includeLinks": "string"
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"rows": [
{
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
}
}
]
}
search
Global Search - Get
Global Search of all GRC content. The search is performed by matching search terms across any field in the current user’s profile and returns a list of results based on a search ranking (most relevant first). A specific range may be requested and separate requests are used to retrieve subsequent ranges. The results are limited to the setting 'Platform / Search / Request / Result Cache Size'; ranges beyond this size are not allowed. The search may be scoped by a list of Types, or all Types if not specified. Results honor the current user's security permissions including role-based and security rules.
Provides a REST end-point that can be comaptible with a Dojo JsonRestStore client. The JsonRestStore follows RFC 2616 whenever possible to define interaction with server.
q:
string
in query
Search terms
range:
string
0-9
in query
Range of search results to return. Optional, will defer to HTTP Range header if present. Format of range is start#-end#
types:
string
in query
Object Types to include in search. All possible types included if not specified. Format of types is comma delimited list of Object Type names or Ids. Deprecated in 7.3, Instead Use 'fot' parameter.
mode:
string
normal
normal
in query
Global Search mode. Reserved for future use.
fot:
string
in query
Faceted Search by Object Types. All possible types included if not specified. Format of types is comma delimited list of Object Type names or Ids. If both 'fot' and 'types' are present, then types is ignored.
fur:
string
in query
Faceted Search by Users. Search syntax representing one or more Users facets to search on, use semicolon to represent more than one user facet. Syntax: {!T A}[DATA];{!T A}[DATA]
- !T = Type of user facet
- !c = creator
- !l = last modified by
- !o = user selected in fields
- A = Action on user facet
- m = me
- o = others, specify in DATA
- DATA = Data of user facet (comma delimited list of user names or Ids)
fdt:
string
in query
Faceted Search by Date. Search syntax representing one or more Date facets to search on, use semicolon to represent more than one date facet. Syntax: {!T A}[DATA];{!T A}[DATA]
- !T = Type of date facet
- !c = creation date
- !l = last modified date
- !o = date in fields
- A = Action on date facet
- o = on date
- r = date range
- p = previous days
- n = next days
- DATA = Data of date facet
- YYYY-MM-DD = a specific date
- YYYY-MM-DD TO YYYY-MM-DD = a date range
ffp:
string
in query
Facted Search by Folder Path. Use relative paths starting from below the Object type root folder.
fmt:
string
in query
Facted Search by MIME type. Applies to file attachment search. Comma delimited list of MIME Media types.
Range:
string
in header
For paging a client may include a HTTP Range header with an items range unit specifying the range. Example: items=0-24
200 OK
Search results
Response Content-Types: application/json
Response Example (200 OK)
{
"searchId": "string",
"estimatedResults": "integer (int32)",
"resultList": [
{
"id": "string",
"name": "string",
"description": "string",
"path": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"objectTypeLabel": "string",
"parentFolderId": "string",
"customDisplayFields": [
{
"fieldLabel": "string",
"displayTypeId": "integer (int64)",
"value": "string"
}
]
}
]
}
Response Headers (200 OK)
| Content-Range |
This service will respond with a Content-Range header to indicate how many items are being returned and an estimate of how many total items exist. Example header value: |
string |
Global Search - Post
Global Search of all GRC data. The search is performed by matching search terms across any field in the current user’s profile and returns a list of results based on a search ranking (most relevant first). A specific range may be requested and separate requests are used to retrieve subsequent ranges. The results are limited to the setting 'Platform / Search / Request / Result Cache Size'; ranges beyond this size are not allowed. The search may be scoped by a list of Types, or all Types if not specified. Results honor the current user's security permissions including role-based and security rules.
Request body search parameters
Request Content-Types: application/json
Request Example
{
"q": "string",
"searchId": "string",
"types": "string",
"mode": "string",
"page": "integer (int32)",
"pageSize": "integer (int32)",
"fot": "string",
"fur": "string",
"fdt": "string",
"ffp": "string",
"fmt": "string"
}
200 OK
successful operation
400 Bad Request
Search parameters not provided in request body
Response Content-Types: application/json
Response Example (200 OK)
{
"searchId": "string",
"estimatedResults": "integer (int32)",
"resultList": [
{
"id": "string",
"name": "string",
"description": "string",
"path": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"objectTypeLabel": "string",
"parentFolderId": "string",
"customDisplayFields": [
{
"fieldLabel": "string",
"displayTypeId": "integer (int64)",
"value": "string"
}
]
}
]
}
wadl
Get WADL Document
Builds and returns WADL application model for all services. The Web Application Description Language (WADL) is a machine-readable XML description of HTTP-based web services.
200 OK
successful operation
Response Content-Types: application/vnd.sun.wadl+xml, application/json
Response Example (200 OK)
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"grammars": {
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"include": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"href": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
]
},
"resources": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"resource": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"param": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"option": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
],
"value": "string",
"mediaType": "string",
"otherAttributes": "object"
}
],
"link": {
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
},
"any": [
"object"
],
"href": "string",
"name": "string",
"style": "string",
"id": "string",
"type": {
"namespaceURI": "string"
}
}
]
}
]
}
]
}
Get WADL Document - Options
Builds and returns WADL application model for all services. The Web Application Description Language (WADL) is a machine-readable XML description of HTTP-based web services.
200 OK
successful operation
Response Content-Types: application/vnd.sun.wadl+xml, application/json
Response Example (200 OK)
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"grammars": {
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"include": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"href": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
]
},
"resources": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"resource": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"param": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"option": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
],
"value": "string",
"mediaType": "string",
"otherAttributes": "object"
}
],
"link": {
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
},
"any": [
"object"
],
"href": "string",
"name": "string",
"style": "string",
"id": "string",
"type": {
"namespaceURI": "string"
}
}
]
}
]
}
]
}
types
Get an Object Type by Id
Get a single Object Type. Use optional parameters to control data returned
typeId:
string
in path
Object Type Id or Object Type system name
includeFieldDefinitions:
boolean
true
in query
(no description)
includeLocalizedLabels:
boolean
false
in query
Include Labels for all Locales or only the labels for current user's locale
200 OK
successful operation
404 Not Found
Object Type not found
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedPluralLabel": "string",
"localizedPluralLabels": {
"localizedPluralLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"description": "string",
"jspPath": "string",
"id": "string",
"rootFolderPath": "string",
"rootFolderId": "string",
"fieldDefinitions": {
"fieldDefinition": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedGuidance": "string",
"localizedGuidances": {
"localizedGuidance": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"dataType": "string",
"required": "boolean",
"description": "string",
"computed": "boolean",
"readOnly": "boolean",
"dependencies": {
"dependency": [
{
"dependencyType": "string",
"logicalOperator": "string",
"controllerFieldMapType": [
{
"typeDefinitionId": "string",
"controllerFieldDefinitionId": "string",
"controllerValueType": [
{
"controllerValueName": "string",
"dependentValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
]
}
]
}
]
},
"enumValues": {
"enumValue": [
{}
]
}
}
]
}
}
Get Child Object Type Associations
Get Child Object Type Association Definitions for a single Object Type in the schema.
typeId:
string
in path
Object Type Id or Object Type system name
includeLocalizedLabels:
boolean
false
in query
(no description)
200 OK
successful operation
404 Not Found
Object Type not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedPluralLabel": "string",
"localizedPluralLabels": {
"localizedPluralLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"associationDefinitionId": "string",
"max": "integer (int32)",
"min": "integer (int32)",
"enabled": "boolean",
"relationship": "string"
}
]
Get all Object Types
Get a list of all Object Types. Use optional parameters to control data returned
includeFieldDefinitions:
boolean
false
in query
(no description)
includeLocalizedLabels:
boolean
false
in query
Include Labels for all Locales or only the labels for current user's locale
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedPluralLabel": "string",
"localizedPluralLabels": {
"localizedPluralLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"description": "string",
"jspPath": "string",
"id": "string",
"rootFolderPath": "string",
"rootFolderId": "string",
"fieldDefinitions": {
"fieldDefinition": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedGuidance": "string",
"localizedGuidances": {
"localizedGuidance": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"dataType": "string",
"required": "boolean",
"description": "string",
"computed": "boolean",
"readOnly": "boolean",
"dependencies": {
"dependency": [
{
"dependencyType": "string",
"logicalOperator": "string",
"controllerFieldMapType": [
{
"typeDefinitionId": "string",
"controllerFieldDefinitionId": "string",
"controllerValueType": [
{
"controllerValueName": "string",
"dependentValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
]
}
]
}
]
},
"enumValues": {
"enumValue": [
null
]
}
}
]
}
}
]
Get Object Type Associations
Get Parent and Child Object Type Association Definitions for a single Object Type in the schema.
typeId:
string
in path
Object Type Id or Object Type system name
includeLocalizedLabels:
boolean
false
in query
(no description)
200 OK
successful operation
404 Not Found
Object Type not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedPluralLabel": "string",
"localizedPluralLabels": {
"localizedPluralLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"associationDefinitionId": "string",
"max": "integer (int32)",
"min": "integer (int32)",
"enabled": "boolean",
"relationship": "string"
}
]
Get Association Definition by Id
Get a single Association Definitions for a single Object Type by the Association's Id.
typeId:
string
in path
Object Type Id or Object Type system name
associationId:
string
in path
Association definition Id
includeLocalizedLabels:
boolean
false
in query
(no description)
200 OK
successful operation
404 Not Found
Object Type not found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedPluralLabel": "string",
"localizedPluralLabels": {
"localizedPluralLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"associationDefinitionId": "string",
"max": "integer (int32)",
"min": "integer (int32)",
"enabled": "boolean",
"relationship": "string"
}
Get Parent Object Type Associations
Get Parent Object Type Association Definitions for a single Object Type in the schema.
typeId:
string
in path
Object Type Id or Object Type system name
includeLocalizedLabels:
boolean
false
in query
(no description)
200 OK
successful operation
404 Not Found
Object Type not found
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedPluralLabel": "string",
"localizedPluralLabels": {
"localizedPluralLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"associationDefinitionId": "string",
"max": "integer (int32)",
"min": "integer (int32)",
"enabled": "boolean",
"relationship": "string"
}
]
security/groups
Get Top Level Groups
Get the top level groups in the system. Only Security Administrators can view groups.
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
]
Create Group
Create a new group. Example of a group:
{
"description": "Rest API test group",
"groupName": "RestTestGroup",
"isEnabled": true,
"adminLevel": 2,
"emailAddress": "others@openpages.local",
"parentId":"11"
}
Request body containing group attributes to create. The main attributes used are:
- groupName
- description
- isEnabled
- parentId
All others are ignored and do not need to be provided.
Request Content-Types: application/json
Request Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
Get Role Assignments for Group
Get the list of role assignments given to this group. Only Security Administrators can view groups.
id:
string
in path
Group name or Id.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
Assign Role to Group
Assign a role at a security context to this group.
id:
string
in path
Group name or Id.
role:
string
in query
Role Template Id for the role to assign.
context:
string
in query
The Security Context to assign the role at. The context is identified by a GRC Object Id e.g. the Id of a SOXBusEntity.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
default
successful operation
Revoke Role from Group
Revoke a role at a security context from this group.
id:
string
in path
Group name or Id.
role:
string
in query
Role Template Id for the role to revoke.
context:
string
in query
The Security Context to revoke the role at. The context is identified by a GRC Object Id e.g. the Id of a SOXBusEntity.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
default
successful operation
Get Permissions for Group
Get the list of application permissions given to this group. Only Security Administrators can view groups.
id:
string
in path
Group name or Id.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
[
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
Get Users for Group
Get the list of users which are members of this group. Only Security Administrators can view groups.
id:
string
in path
Group name or Id.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
includeAllGroups:
string
false
in query
If details of all Groups to which user belong is required then includeAllGroups should be true.
Response Content-Types: application/json
Response Example (200 OK)
[
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
]
Add Users to Group
Add existing users as members to this group.
Request body list of users to add. Users must exist first, this will not create users.
id:
string
in path
Group name or Id.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
Request Content-Types: application/json
Request Example
[
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
]
default
successful operation
Remove Users from Group
Remove existing users as members from this group. You may use either request body or query parameters to pass list of user ids to remove. You can not remove users from the special system group: 'OpenPages'.
Users to remove in a comma-delimited list of User Ids. This is optional if values provided in query path. E.g. {"value":"1021,2202,2030,1041"}
id:
string
in path
Group name or Id.
users:
string
in query
Users to remove in a comma-delimited list of User Ids. This is optional if values provided in request body.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
Request Content-Types: application/json
Request Example
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean",
"value": "string"
}
default
successful operation
Get Sub-Groups for Group
Get the list of groups which are members of this group. Only Security Administrators can view groups.
id:
string
in path
Group name or Id.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
]
Add Sub-Groups to Group
Add existing groups as members to this group.
Request body list of groups to add. Groups must exist first, this will not create groups.
id:
string
in path
Group name or Id.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
Request Content-Types: application/json
Request Example
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
]
default
successful operation
Remove Sub-Groups from Group
Remove existing groups as members to this group.
Sub-groups to remove in a comma-delimited list of Group Ids. This is optional if values is provided in query path. E.g. {"value":"1021,2202,2030,1041"}
id:
string
in path
Group name or Id.
subgroups:
string
in query
Sub-groups to remove in a comma-delimited list of Group Ids.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
Request Content-Types: application/json
Request Example
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean",
"value": "string"
}
default
successful operation
Create groups for IBM Cloud Pak for Data synch operation
Create groups with minimal attributes as received from IBM Cloud Pak for Data platform. Example of a group request body:
{
"description": "Rest API test group",
"groupName": "RestTestGroup",
"isEnabled": true,
"adminLevel": 2,
"emailAddress": "others@openpages.local",
"parentId":"11"
}
If group already exists in OpenPages then it is associated back with the parent group as provided in body.
Request body containing group attributes to create. The main attributes used are:
- groupName
- description
- isEnabled
- parentId
All others are ignored and do not need to be provided.
Request Content-Types: application/json
Request Example
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
]
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
Update groups for IBM Cloud Pak for Data synch operation
Updates an existing groups with the given modified attributes as received from IBM Cloud Pak for Data platform. Only the attributes present will be changed. Example of a group request body:
[
{
"id": "3021",
"groupName": "RestTestGroup",
"description":"New Description!"
}
]
id and groupName are not modifiable for group.
Request body containing groups to update.
Request Example
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
]
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
Get Group by Id
Get single Group by Id. Only Security Administrators can view groups.
id:
string
in path
Group name or Id.
isName:
string
false
in query
If Group name is a numeric value then isName should be true.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
security/permissions
Get Permission by Id
Get a single Application Permission information by its name or Id.
id:
string
in path
(no description)
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
Get All Permissions
Get list of all the Application Permissions in the system.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
[
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
security/roles
Get Object Permissions for Role Template
Get list of all Object Permissions for a Role Template.
id:
string
in path
Role Template name or Id
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"canRead": "object",
"canWrite": "object",
"canDelete": "object",
"canAssociate": "object",
"rootFolderId": "string",
"rootFolderPath": "string"
}
]
Get Permissions for Role Template
Get list of all Application Permissions for a Role Template.
id:
string
in path
Role Template name or Id
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
[
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
Get All Role Templates
Get list of all Role Templates in the system.
Response Content-Types: application/json
Response Example (200 OK)
[
{
"roleName": "string",
"id": "string",
"description": "string",
"isEnabled": "boolean",
"isLocked": "boolean",
"grcObjectType": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"objectPermissions": {
"objectPermission": [
{
"id": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"canRead": "object",
"canWrite": "object",
"canDelete": "object",
"canAssociate": "object",
"rootFolderId": "string",
"rootFolderPath": "string"
}
]
}
}
]
Get Role Template by Id
Get single Role Template by Id.
id:
string
in path
Role Template name or Id
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"roleName": "string",
"id": "string",
"description": "string",
"isEnabled": "boolean",
"isLocked": "boolean",
"grcObjectType": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"objectPermissions": {
"objectPermission": [
{
"id": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"canRead": "object",
"canWrite": "object",
"canDelete": "object",
"canAssociate": "object",
"rootFolderId": "string",
"rootFolderPath": "string"
}
]
}
}
security/users
Get Permissions for User
Get a list of all application permissions assigned to the user. Only Security Administrators can view this data for other users.
id:
string
in path
User name or Id.
isName:
string
false
in query
If User name is a numeric value then isName should be true.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
[
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
Reset Password for User
Reset the user's password to a new password that is provided. Example of a password request body:
{
"userName":"jdoe123",
"password": "changeme"
}
Note that all user passwords are stored encrypted in the OpenPages with Watson. See the Administrators Guide for details on encryption.
Request body containing changed password attribute. Other attributes are ignored.
id:
string
in path
User name or Id.
isName:
string
false
in query
If User name is a numeric value then isName should be true.
Request Example
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
default
successful operation
Get User by Id
Get single User by Id. Only Security Administrators can view this data for other users.
id:
string
in path
User name or Id.
isName:
string
false
in query
If User name is a numeric value then isName should be true.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
Update User
Updates an existing user with the given modified attributes. Only the attributes present will be changed. Example of a user request body:
{
"id": "1021",
"userName": "jdoe123",
"description":"New Description! And Locking this user.",
"isLocked":true}
id and userName are not modifiable for users. Note that groups, roleAssignments and adminPermissions cannot be updated through this method.
undefined
id:
string
in path
User name or Id.
isName:
string
false
in query
If User name is a numeric value then isName should be true.
Request Example
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
Get Role Assignments for User
Get the list of role assignments given to this user. Only Security Administrators can view this data for other users.
id:
string
in path
User name or Id.
isName:
string
false
in query
If User name is a numeric value then isName should be true.
200 OK
successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
[
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
Assign Role to User
Assign a role at a security context to this user.
id:
string
in path
User name or Id.
role:
string
in query
Role Template Id for the role to assign.
context:
string
in query
The Security Context to assign the role at. The context is identified by a GRC Object Id e.g. the Id of a SOXBusEntity.
default
successful operation
Revoke Role from User
Revoke a role at a security context from this user. If the role assignment was granted at the root level then for context parameter use the Object Type name e.g. 'SOXBusEntity'
id:
string
in path
User name or Id.
role:
string
in query
Role Template Id for the role to assign.
context:
string
in query
The Security Context to assign the role at. The context is identified by a GRC Object Id e.g. the Id of a SOXBusEntity. If the role assignment was granted at the root level then for context parameter use the Object Type name e.g. 'SOXBusEntity'
isName:
string
false
in query
If User name is a numeric value then isName should be true.
default
successful operation
Get active users for IBM Cloud Pak for Data synch operation
Note that very minimal attributes of active users as required for synchronising them between OpenPages and IBM Cloud Pak for Data platform will be sent through this method.
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
Create users for IBM Cloud Pak for Data synch operation
Create users with minimal attributes as received from IBM Cloud Pak for Data platform. Example of a user request body:
[
{
"userName":"jdoe123",
"firstName":"John",
"emailAddress": "john.doe@company.com"
"isEnabled": true
}
]
Note that very minimal user attributes as required for hosting OpenPages on IBM Cloud Pak for Data will be set through this method.
Request body containing user attributes.
Request Content-Types: application/json
Request Example
[
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
]
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
Update users for IBM Cloud Pak for Data synch operation
Updates an existing users with the given modified attributes as received from IBM Cloud Pak for Data platform. Only the attributes present will be changed. Example of a user request body:
[
{
"id": "1021",
"userName": "jdoe123",
"description":"New Description! And Locking this user.",
"isLocked":true
}
]
id and userName are not modifiable for users. Service will append provided list of available profiles to existing set. If user already exists in OpenPages then it is updated with values as provided in body.
Request body containing user to update.
Request Example
[
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
]
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
Get Group Memberships for User
Get a list of all groups the user is a member of. Only Security Administrators can view this data for other users.
id:
string
in path
User name or Id.
isName:
string
false
in query
If User name is a numeric value then isName should be true.
Response Content-Types: application/json
Response Example (200 OK)
[
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
]
Get Actors User Impersonates
Gets all Ids of actors this user impersonates. This method is useful for determining what security access a user may inherit. Only Security Administrators can view this data for other users.
id:
string
in path
User name or Id.
isName:
string
false
in query
If User name is a numeric value then isName should be true.
200 OK
successful operation
type
string[]
Response Content-Types: application/json
Response Example (200 OK)
[
"string"
]
Create User
Create a new user with the given attributes. Example of a user request body:
{
"userName":"jdoe123",
"firstName":"John",
"lastName":"Doe",
"localeISOCode": "en_us",
"emailAddress": "john.doe@company.com",
"availableProfileNames": [ "ORM Profile", "ITG Profile"],
"preferredProfileName": "ORM Profile",
"password": "changeme",
"groups": {
"group": [
{
"id" :"2003"
"groupName":"Group1"
},
{
"id" :"2004" ,
"groupName":"Group2"
}
]
}
}
Note that roleAssignments and adminPermissions cannot be set through this method.
Request body containing user attributes to create.
Request Content-Types: application/json
Request Example
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
200 OK
successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
null
]
}
}
]
}
}
Anonymize User Attributes
The anonymized text is "Anonymous", if it is not specified. The first name, last name and description of the user will be the anonymized text. The middle name of the user will be empty. The email address of the user will be "{anonymizedText}@{anonymizedText:lowercase}.com", e.g. " Anonymous@anonymous.com"
id:
string
in path
User Id.
text:
string
in query
The anonymized text, default "Anonymous", the maximum length of the value is 64.
default
successful operation
Response Content-Types: application/json
Schema Definitions
ApplicationTextType: object
- name: string
- category: string
- localizedLabel: string
- localizedLabels: LocalizedLabels
Example
{
"name": "string",
"category": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
}
}
LocalizedLabelType: object
- localeISOCode: string
- localizedLabel: string
Example
{
"localeISOCode": "string",
"localizedLabel": "string"
}
LocalizedLabels: object
- localizedLabel: LocalizedLabelType
-
LocalizedLabelType
Example
{
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
}
ProfileType: object
- name: string
- id: string
- description: string
- isDefault: boolean
- isFallback: boolean
- isEnabled: boolean
- isDeleted: boolean
Example
{
"name": "string",
"id": "string",
"description": "string",
"isDefault": "boolean",
"isFallback": "boolean",
"isEnabled": "boolean",
"isDeleted": "boolean"
}
CurrencyType: object
- isoCode: string
- name: string
- symbol: string
- precision: integer (int32)
- isBaseCurrency: boolean
- isEnabled: boolean
- id: string
Example
{
"isoCode": "string",
"name": "string",
"symbol": "string",
"precision": "integer (int32)",
"isBaseCurrency": "boolean",
"isEnabled": "boolean",
"id": "string"
}
ReportingPeriodType: object
- id: string
- label: string
- description: string
- finalizedDate: string (date-time)
- creationDate: string (date-time)
- modifiedDate: string (date-time)
Example
{
"id": "string",
"label": "string",
"description": "string",
"finalizedDate": "string (date-time)",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)"
}
TraceLogListType: object
- traceList: TraceLogType
-
TraceLogType
Example
{
"traceList": [
{
"value": "string",
"name": "string",
"path": "string"
}
]
}
TraceLogType: object
- value: string
- name: string
- path: string
Example
{
"value": "string",
"name": "string",
"path": "string"
}
ExchangeRateType: object
- id: string
- currencyCode: string
- rate: number (double)
- startDate: string (date-time)
- endDate: string (date-time)
Example
{
"id": "string",
"currencyCode": "string",
"rate": "number (double)",
"startDate": "string (date-time)",
"endDate": "string (date-time)"
}
Attributes: object
- attribute: ViewAttributeType
-
ViewAttributeType
Example
{
"attribute": [
{
"name": "string",
"value": "string"
}
]
}
Fields: object
Example
{
"field": [
{
"fieldSystemName": "string",
"id": "string",
"displayType": {
"name": "string",
"id": "string",
"spanColumns": "boolean"
},
"isRequired": "boolean",
"isReadOnly": "boolean"
}
]
}
ObjectTypes: object
- objectType: ProfileTypeDefinition
-
ProfileTypeDefinition
Example
{
"objectType": [
{
"name": "string",
"id": "string",
"typeDefinition": "string",
"order": "integer (int32)",
"fields": {
"field": [
{
"fieldSystemName": "string",
"id": "string",
"displayType": {
"name": "string",
"id": "string",
"spanColumns": "boolean"
},
"isRequired": "boolean",
"isReadOnly": "boolean"
}
]
},
"views": {
"view": [
{
"id": "string",
"viewTypeName": "string",
"name": "string",
"description": "string",
"showDescription": "boolean",
"isDefault": "boolean",
"isDisabled": "boolean",
"attributes": {
"attribute": [
{
"name": "string",
"value": "string"
}
]
}
}
]
}
}
]
}
ProfileDisplayType: object
- name: string
- id: string
- spanColumns: boolean
Example
{
"name": "string",
"id": "string",
"spanColumns": "boolean"
}
ProfileFieldDefinition: object
- fieldSystemName: string
- id: string
- displayType: ProfileDisplayType
- isRequired: boolean
- isReadOnly: boolean
Example
{
"fieldSystemName": "string",
"id": "string",
"displayType": {
"name": "string",
"id": "string",
"spanColumns": "boolean"
},
"isRequired": "boolean",
"isReadOnly": "boolean"
}
ProfileTypeDefinition: object
Example
{
"name": "string",
"id": "string",
"typeDefinition": "string",
"order": "integer (int32)",
"fields": {
"field": [
{
"fieldSystemName": "string",
"id": "string",
"displayType": {
"name": "string",
"id": "string",
"spanColumns": "boolean"
},
"isRequired": "boolean",
"isReadOnly": "boolean"
}
]
},
"views": {
"view": [
{
"id": "string",
"viewTypeName": "string",
"name": "string",
"description": "string",
"showDescription": "boolean",
"isDefault": "boolean",
"isDisabled": "boolean",
"attributes": {
"attribute": [
{
"name": "string",
"value": "string"
}
]
}
}
]
}
}
ResourceAssociation: object
- id: string
- resourceId: string
- resourceType: string REPORT, INLINE_REPORT, HOME_PAGE_TAB_REPORT, DEFAULT_HOME_PAGE_TAB, BPM_PROCESS_PORTAL_TAB, TILES_HOME_PAGE_TAB
- tabEnabled: boolean
- tabOrder: integer (int32)
- homePagePanelsConfiguration: string
Example
{
"id": "string",
"resourceId": "string",
"resourceType": "string",
"tabEnabled": "boolean",
"tabOrder": "integer (int32)",
"homePagePanelsConfiguration": "string"
}
ResourceAssociations: object
- resourceAssociation: ResourceAssociation
-
ResourceAssociation
Example
{
"resourceAssociation": [
{
"id": "string",
"resourceId": "string",
"resourceType": "string",
"tabEnabled": "boolean",
"tabOrder": "integer (int32)",
"homePagePanelsConfiguration": "string"
}
]
}
ViewAttributeType: object
- name: string HIERARCHY_PATH_LIST_4, HIERARCHY_PATH_LIST_3, HIERARCHY_PATH_LIST_2, HIERARCHY_PATH_LIST, SORT_ORDER, IS_VIEW_SELECTOR, IS_SEPARATE_PAGE
- value: string
Example
{
"name": "string",
"value": "string"
}
ViewType: object
- id: string
- viewTypeName: string
- name: string
- description: string
- showDescription: boolean
- isDefault: boolean
- isDisabled: boolean
- attributes: Attributes
Example
{
"id": "string",
"viewTypeName": "string",
"name": "string",
"description": "string",
"showDescription": "boolean",
"isDefault": "boolean",
"isDisabled": "boolean",
"attributes": {
"attribute": [
{
"name": "string",
"value": "string"
}
]
}
}
ReportFieldType: object
- id: string
- dataType: string
- name: string
- hasChanged: boolean
- value: string
Example
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean",
"value": "string"
}
AtomCategory: object
- base: string
- lang: string
- otherAttributes: object
- term: string
- scheme: string
- label: string
Example
{
"base": "string",
"lang": "string",
"otherAttributes": "object",
"term": "string",
"scheme": "string",
"label": "string"
}
AtomContent: object
- base: string
- lang: string
- type: string
- src: string
Example
{
"base": "string",
"lang": "string",
"type": "string",
"src": "string"
}
AtomEntry: object
- base: string
- lang: string
- otherAttributes: object
- id: string
- updated: string (date-time)
- title: AtomText
- summary: AtomText
- published: string (date-time)
- any: Element
-
Element - content: AtomContent
- authors: AtomPerson
-
AtomPerson - categories: AtomCategory
-
AtomCategory - links: AtomLink
-
AtomLink - updatedAsTime: integer (int64)
- publishedAsTime: integer (int64)
- contributors: AtomPerson
-
AtomPerson
Example
{
"base": "string",
"lang": "string",
"otherAttributes": "object",
"id": "string",
"updated": "string (date-time)",
"title": {
"base": "string",
"lang": "string",
"otherAttributes": "object",
"type": "string",
"value": "string"
},
"summary": {
"base": "string",
"lang": "string",
"otherAttributes": "object",
"type": "string",
"value": "string"
},
"published": "string (date-time)",
"any": [
{
"tagName": "string",
"schemaTypeInfo": {
"typeName": "string",
"typeNamespace": "string"
},
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
]
}
AtomLink: object
- base: string
- lang: string
- otherAttributes: object
- length: string
- title: string
- hreflang: string
- rel: string
- type: string
- href: string
Example
{
"base": "string",
"lang": "string",
"otherAttributes": "object",
"length": "string",
"title": "string",
"hreflang": "string",
"rel": "string",
"type": "string",
"href": "string"
}
AtomPerson: object
Example
{
"email": "string",
"any": [
{
"tagName": "string",
"schemaTypeInfo": {
"typeName": "string",
"typeNamespace": "string"
},
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
]
}
AtomText: object
- base: string
- lang: string
- otherAttributes: object
- type: string text, html, xhtml
- value: string
Example
{
"base": "string",
"lang": "string",
"otherAttributes": "object",
"type": "string",
"value": "string"
}
DOMConfiguration: object
- parameterNames: DOMStringList
Example
{
"parameterNames": {
"length": "integer (int32)"
}
}
Document: object
- doctype: DocumentType
- implementation: DOMImplementation
- documentElement: Element
- inputEncoding: string
- xmlEncoding: string
- xmlStandalone: boolean
- xmlVersion: string
- strictErrorChecking: boolean
- documentURI: string
- domConfig: DOMConfiguration
- nodeName: string
- nodeValue: string
- nodeType: integer (int32)
- parentNode: Node
- childNodes: NodeList
- firstChild: Node
- lastChild: Node
- previousSibling: Node
- nextSibling: Node
- attributes: NamedNodeMap
- ownerDocument: Document
- namespaceURI: string
- prefix: string
- localName: string
- baseURI: string
- textContent: string
Example
{
"doctype": {
"name": "string",
"entities": {
"length": "integer (int32)"
},
"notations": {
"length": "integer (int32)"
},
"publicId": "string",
"systemId": "string",
"internalSubset": "string",
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
DocumentType: object
- name: string
- entities: NamedNodeMap
- notations: NamedNodeMap
- publicId: string
- systemId: string
- internalSubset: string
- nodeName: string
- nodeValue: string
- nodeType: integer (int32)
- parentNode: Node
- childNodes: NodeList
- firstChild: Node
- lastChild: Node
- previousSibling: Node
- nextSibling: Node
- attributes: NamedNodeMap
- ownerDocument: Document
- namespaceURI: string
- prefix: string
- localName: string
- baseURI: string
- textContent: string
Example
{
"name": "string",
"entities": {
"length": "integer (int32)"
},
"notations": {
"length": "integer (int32)"
},
"publicId": "string",
"systemId": "string",
"internalSubset": "string",
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
Element: object
- tagName: string
- schemaTypeInfo: TypeInfo
- nodeName: string
- nodeValue: string
- nodeType: integer (int32)
- parentNode: Node
- childNodes: NodeList
- firstChild: Node
- lastChild: Node
- previousSibling: Node
- nextSibling: Node
- attributes: NamedNodeMap
- ownerDocument: Document
- namespaceURI: string
- prefix: string
- localName: string
- baseURI: string
- textContent: string
Example
{
"tagName": "string",
"schemaTypeInfo": {
"typeName": "string",
"typeNamespace": "string"
},
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
Node: object
- nodeName: string
- nodeValue: string
- nodeType: integer (int32)
- parentNode: Node
- childNodes: NodeList
- firstChild: Node
- lastChild: Node
- previousSibling: Node
- nextSibling: Node
- attributes: NamedNodeMap
- ownerDocument: Document
- namespaceURI: string
- prefix: string
- localName: string
- baseURI: string
- textContent: string
Example
{
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
TypeInfo: object
- typeName: string
- typeNamespace: string
Example
{
"typeName": "string",
"typeNamespace": "string"
}
AtomFeed: object
- base: string
- lang: string
- otherAttributes: object
- id: string
- updated: string (date-time)
- title: AtomText
- subtitle: AtomText
- generator: AtomGenerator
- icon: string
- logo: string
- rights: AtomText
- any: object[]
-
object - totalResults: integer (int64)
- itemsPerPage: integer (int64)
- startIndex: integer (int64)
- authors: AtomPerson
-
AtomPerson - categories: AtomCategory
-
AtomCategory - links: AtomLink
-
AtomLink - entries: AtomEntry
-
AtomEntry - updatedAsTime: integer (int64)
- contributors: AtomPerson
-
AtomPerson - openSearchQueries: OpenSearchQuery
-
OpenSearchQuery
Example
{
"base": "string",
"lang": "string",
"otherAttributes": "object",
"id": "string",
"updated": "string (date-time)",
"title": {
"base": "string",
"lang": "string",
"otherAttributes": "object",
"type": "string",
"value": "string"
},
"subtitle": {
"base": "string",
"lang": "string",
"otherAttributes": "object",
"type": "string",
"value": "string"
},
"generator": {
"value": "string",
"base": "string",
"lang": "string",
"otherAttributes": "object",
"uri": "string",
"version": "string"
},
"icon": "string",
"logo": "string",
"rights": {
"base": "string",
"lang": "string",
"otherAttributes": "object",
"type": "string",
"value": "string"
},
"any": [
"object"
],
"totalResults": "integer (int64)",
"itemsPerPage": "integer (int64)",
"startIndex": "integer (int64)",
"authors": [
{
"email": "string",
"any": [
{
"tagName": "string",
"schemaTypeInfo": {
"typeName": "string",
"typeNamespace": "string"
},
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string",
"nodeValue": "string",
"nodeType": "integer (int32)",
"parentNode": {
"nodeName": "string"
}
}
}
}
}
}
}
}
}
}
]
}
]
}
AtomGenerator: object
- value: string
- base: string
- lang: string
- otherAttributes: object
- uri: string
- version: string
Example
{
"value": "string",
"base": "string",
"lang": "string",
"otherAttributes": "object",
"uri": "string",
"version": "string"
}
OpenSearchQuery: object
- role: string
- searchTerms: string
- title: string
- totalResults: integer
- count: integer
- startPage: integer
- startIndex: integer
- language: string
- inputEncoding: string
- outputEncoding: string
- otherAttributes: object
Example
{
"role": "string",
"searchTerms": "string",
"title": "string",
"totalResults": "integer",
"count": "integer",
"startPage": "integer",
"startIndex": "integer",
"language": "string",
"inputEncoding": "string",
"outputEncoding": "string",
"otherAttributes": "object"
}
AssociationNodeType: object
Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"typeDefinitionId": "string",
"path": "string",
"associationDefinitionId": "string",
"type": "string"
}
Link: object
- rel: string self
- href: string
- type: string
- hreflang: string
- length: string
Example
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
ActionType: object
- id: string[]
-
string - options: OptionType
Example
{
"id": [
"string"
],
"options": {
"includeChildren": "boolean",
"conflictBehavior": "string",
"typeDefinitions": [
"string"
],
"typeAssociations": [
{
"parentObjectType": "string",
"childObjectType": "string"
}
],
"autoNameChildren": "boolean"
}
}
OptionType: object
- includeChildren: boolean
- conflictBehavior: string
- typeDefinitions: string[]
-
string - typeAssociations: TypeAssociation
-
TypeAssociation - autoNameChildren: boolean
Example
{
"includeChildren": "boolean",
"conflictBehavior": "string",
"typeDefinitions": [
"string"
],
"typeAssociations": [
{
"parentObjectType": "string",
"childObjectType": "string"
}
],
"autoNameChildren": "boolean"
}
TypeAssociation: object
- parentObjectType: string
- childObjectType: string
Example
{
"parentObjectType": "string",
"childObjectType": "string"
}
ResourcePermissionType: object
- folderId: string
- securityPrincipal: string
- canRead: boolean
- canWrite: boolean
- canDelete: boolean
- canAssociate: boolean
Example
{
"folderId": "string",
"securityPrincipal": "string",
"canRead": "boolean",
"canWrite": "boolean",
"canDelete": "boolean",
"canAssociate": "boolean"
}
FieldAuditLogType: object
- id: string
- name: string
- modifiedBy: string
- modifiedDate: string (date-time)
- oldValue: string
- newValue: string
Example
{
"id": "string",
"name": "string",
"modifiedBy": "string",
"modifiedDate": "string (date-time)",
"oldValue": "string",
"newValue": "string"
}
ContentDefinitionType: object
- attribute: AttributeType
- children: string
Example
{
"attribute": {
"type": "string",
"src": "string"
},
"children": "string"
}
FieldType: object
- id: string
- dataType: string
- name: string
- hasChanged: boolean
Example
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
FileTypeDefinitionType: object
- fileExtension: string
- mimeType: string
- id: string
Example
{
"fileExtension": "string",
"mimeType": "string",
"id": "string"
}
JsonDocumentType: object
- links: Link
-
Link - name: string
- id: string
- path: string
- isFolder: boolean
- creationDate: string (date-time)
- modifiedDate: string (date-time)
- description: string
- parentFolderId: string
- creator: string
- lastModifiedBy: string
- fields: FieldsType
- typeDefinitionId: string
- isCheckOut: boolean
- isLocked: boolean
- primaryParentId: string
- fileTypeDefinition: FileTypeDefinitionType
- contentDefinition: ContentDefinitionType
Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string",
"fileTypeDefinition": {
"fileExtension": "string",
"mimeType": "string",
"id": "string"
},
"contentDefinition": {
"attribute": {
"type": "string",
"src": "string"
},
"children": "string"
}
}
GrcObjectType: object
- links: Link
-
Link - name: string
- id: string
- path: string
- isFolder: boolean
- creationDate: string (date-time)
- modifiedDate: string (date-time)
- description: string
- parentFolderId: string
- creator: string
- lastModifiedBy: string
- fields: FieldsType
- typeDefinitionId: string
- isCheckOut: boolean
- isLocked: boolean
- primaryParentId: string
Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string",
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
},
"typeDefinitionId": "string",
"isCheckOut": "boolean",
"isLocked": "boolean",
"primaryParentId": "string"
}
AssociationAuditLogType: object
- id: string
- name: string
- associatedObjectType: string
- modifiedBy: string
- modifiedDate: string (date-time)
- status: string
Example
{
"id": "string",
"name": "string",
"associatedObjectType": "string",
"modifiedBy": "string",
"modifiedDate": "string (date-time)",
"status": "string"
}
DeletedResourceType: object
Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"creator": "string",
"lastModifiedBy": "string",
"typeDefinitionId": "string"
}
FolderType: object
Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"name": "string",
"id": "string",
"path": "string",
"isFolder": "boolean",
"creationDate": "string (date-time)",
"modifiedDate": "string (date-time)",
"description": "string",
"parentFolderId": "string",
"creator": "string",
"lastModifiedBy": "string"
}
ProcessInfoType: object
- processId: string
- name: string
- description: string
- processTypeId: string
- finished: boolean
- createdOn: string (date-time)
- createdBy: string
- status: string STATUS_UPDATE_ERROR, STATUS_PENDING, STATUS_QUEUED, STATUS_STARTED, STATUS_RUNNING, STATUS_WARNING, STATUS_FINISHED_ERROR, STATUS_TERMINATED_SYSTEM, STATUS_TERMINATED_USER, STATUS_FINISHED_SUCCESS, STATUS_FINISHED_WARNING, STATUS_FINISHED_PARTIAL_SUCCESS
- parentProcessId: string
- percentComplete: integer (int32)
- childProcesses: ProcessInfoType
-
ProcessInfoType
Example
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string",
"parentProcessId": "string",
"percentComplete": "integer (int32)",
"childProcesses": [
{
"processId": "string",
"name": "string",
"description": "string",
"processTypeId": "string",
"finished": "boolean",
"createdOn": "string (date-time)",
"createdBy": "string",
"status": "string"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
ProcessTypeType: object
- processTypeId: string
- name: string
- description: string
- defaultTimeSeconds: integer (int32)
- isMultipleInstance: boolean
- isTerminateUponStart: boolean
Example
{
"processTypeId": "string",
"name": "string",
"description": "string",
"defaultTimeSeconds": "integer (int32)",
"isMultipleInstance": "boolean",
"isTerminateUponStart": "boolean"
}
RowType: object
- fields: FieldsType
Example
{
"fields": {
"field": [
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean"
}
]
}
}
QueryType: object
- statement: string
- skipCount: integer (int32)
- caseInsensitive: boolean
- pageSize: integer (int32)
- maxRows: integer (int32)
- honorPrimary: boolean
- includeLinks: string true
Example
{
"statement": "string",
"skipCount": "integer (int32)",
"caseInsensitive": "boolean",
"pageSize": "integer (int32)",
"maxRows": "integer (int32)",
"honorPrimary": "boolean",
"includeLinks": "string"
}
CustomDisplayFields: object
- fieldLabel: string
- displayTypeId: integer (int64)
- value: string
Example
{
"fieldLabel": "string",
"displayTypeId": "integer (int64)",
"value": "string"
}
SearchResponseType: object
- searchId: string
- estimatedResults: integer (int32)
- resultList: SearchResultType
-
SearchResultType
Example
{
"searchId": "string",
"estimatedResults": "integer (int32)",
"resultList": [
{
"id": "string",
"name": "string",
"description": "string",
"path": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"objectTypeLabel": "string",
"parentFolderId": "string",
"customDisplayFields": [
{
"fieldLabel": "string",
"displayTypeId": "integer (int64)",
"value": "string"
}
]
}
]
}
SearchResultType: object
- id: string
- name: string
- description: string
- path: string
- objectTypeId: string
- objectTypeName: string
- objectTypeLabel: string
- parentFolderId: string
- customDisplayFields: CustomDisplayFields
-
CustomDisplayFields
Example
{
"id": "string",
"name": "string",
"description": "string",
"path": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"objectTypeLabel": "string",
"parentFolderId": "string",
"customDisplayFields": [
{
"fieldLabel": "string",
"displayTypeId": "integer (int64)",
"value": "string"
}
]
}
SearchType: object
- q: string
- searchId: string
- types: string
- mode: string
- page: integer (int32)
- pageSize: integer (int32)
- fot: string
- fur: string
- fdt: string
- ffp: string
- fmt: string
Example
{
"q": "string",
"searchId": "string",
"types": "string",
"mode": "string",
"page": "integer (int32)",
"pageSize": "integer (int32)",
"fot": "string",
"fur": "string",
"fdt": "string",
"ffp": "string",
"fmt": "string"
}
Application: object
Example
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"grammars": {
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"include": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"href": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
]
},
"resources": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"resource": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"param": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"option": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
],
"value": "string",
"mediaType": "string",
"otherAttributes": "object"
}
],
"link": {
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
},
"any": [
"object"
],
"href": "string",
"name": "string",
"style": "string",
"id": "string",
"type": {
"namespaceURI": "string",
"localPart": "string"
}
}
]
}
]
}
]
}
Doc: object
- content: object[]
-
object - title: string
- lang: string
- otherAttributes: object
Example
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
Grammars: object
Example
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"include": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"href": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
]
}
Param: object
Example
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"option": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
],
"value": "string",
"mediaType": "string",
"otherAttributes": "object"
}
],
"link": {
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
},
"any": [
"object"
],
"href": "string",
"name": "string",
"style": "string",
"id": "string",
"type": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"required": "boolean",
"repeating": "boolean",
"fixed": "string",
"path": "string",
"otherAttributes": "object",
"default": "string"
}
QName: object
- namespaceURI: string
- localPart: string
- prefix: string
Example
{
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
}
Resource: object
Example
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"param": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"option": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
],
"value": "string",
"mediaType": "string",
"otherAttributes": "object"
}
],
"link": {
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
},
"any": [
"object"
],
"href": "string",
"name": "string",
"style": "string",
"id": "string",
"type": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"required": "boolean",
"repeating": "boolean",
"fixed": "string",
"path": "string",
"otherAttributes": "object",
"default": "string"
}
],
"methodOrResource": [
"object"
],
"any": [
"object"
],
"id": "string",
"type": [
"string"
],
"queryType": "string",
"path": "string",
"otherAttributes": "object"
}
Resources: object
Example
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"resource": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"param": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"option": [
{
"doc": [
{
"content": [
"object"
],
"title": "string",
"lang": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
],
"value": "string",
"mediaType": "string",
"otherAttributes": "object"
}
],
"link": {
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
},
"any": [
"object"
],
"href": "string",
"name": "string",
"style": "string",
"id": "string",
"type": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"required": "boolean",
"repeating": "boolean",
"fixed": "string",
"path": "string",
"otherAttributes": "object",
"default": "string"
}
],
"methodOrResource": [
"object"
],
"any": [
"object"
],
"id": "string",
"type": [
"string"
],
"queryType": "string",
"path": "string",
"otherAttributes": "object"
}
],
"any": [
"object"
],
"base": "string",
"otherAttributes": "object"
}
ControllerFieldMapType: object
- typeDefinitionId: string
- controllerFieldDefinitionId: string
- controllerValueType: ControllerValueType
-
ControllerValueType
Example
{
"typeDefinitionId": "string",
"controllerFieldDefinitionId": "string",
"controllerValueType": [
{
"controllerValueName": "string",
"dependentValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
]
}
ControllerValueType: object
- controllerValueName: string
- dependentValue: EnumValueType
-
EnumValueType
Example
{
"controllerValueName": "string",
"dependentValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
Dependencies: object
- dependency: FieldDependencyType
-
FieldDependencyType
Example
{
"dependency": [
{
"dependencyType": "string",
"logicalOperator": "string",
"controllerFieldMapType": [
{
"typeDefinitionId": "string",
"controllerFieldDefinitionId": "string",
"controllerValueType": [
{
"controllerValueName": "string",
"dependentValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
]
}
]
}
]
}
EnumValueType: object
- id: string
- name: string
- localizedLabel: string
- localizedLabels: LocalizedLabels
- index: integer (int32)
- hidden: boolean
- parentId: JAXBElementString
- parentName: string
Example
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
EnumValues: object
- enumValue: EnumValueType
-
EnumValueType
Example
{
"enumValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
FieldDefinitionType: object
- id: string
- name: string
- localizedLabel: string
- localizedLabels: LocalizedLabels
- localizedGuidance: string
- localizedGuidances: LocalizedGuidances
- dataType: string
- required: boolean
- description: string
- computed: boolean
- readOnly: boolean
- dependencies: Dependencies
- enumValues: EnumValues
- isHierarchical: boolean
Example
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedGuidance": "string",
"localizedGuidances": {
"localizedGuidance": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"dataType": "string",
"required": "boolean",
"description": "string",
"computed": "boolean",
"readOnly": "boolean",
"dependencies": {
"dependency": [
{
"dependencyType": "string",
"logicalOperator": "string",
"controllerFieldMapType": [
{
"typeDefinitionId": "string",
"controllerFieldDefinitionId": "string",
"controllerValueType": [
{
"controllerValueName": "string",
"dependentValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
]
}
]
}
]
},
"enumValues": {
"enumValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
},
"isHierarchical": "boolean"
}
FieldDefinitions: object
- fieldDefinition: FieldDefinitionType
-
FieldDefinitionType
Example
{
"fieldDefinition": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedGuidance": "string",
"localizedGuidances": {
"localizedGuidance": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"dataType": "string",
"required": "boolean",
"description": "string",
"computed": "boolean",
"readOnly": "boolean",
"dependencies": {
"dependency": [
{
"dependencyType": "string",
"logicalOperator": "string",
"controllerFieldMapType": [
{
"typeDefinitionId": "string",
"controllerFieldDefinitionId": "string",
"controllerValueType": [
{
"controllerValueName": "string",
"dependentValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
]
}
]
}
]
},
"enumValues": {
"enumValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
},
"isHierarchical": "boolean"
}
]
}
FieldDependencyType: object
- dependencyType: string
- logicalOperator: string
- controllerFieldMapType: ControllerFieldMapType
-
ControllerFieldMapType
Example
{
"dependencyType": "string",
"logicalOperator": "string",
"controllerFieldMapType": [
{
"typeDefinitionId": "string",
"controllerFieldDefinitionId": "string",
"controllerValueType": [
{
"controllerValueName": "string",
"dependentValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
]
}
]
}
FileTypes: object
- fileType: FileTypeDefinitionType
-
FileTypeDefinitionType
Example
{
"fileType": [
{
"fileExtension": "string",
"mimeType": "string",
"id": "string"
}
]
}
JAXBElement: object
- name: QName
- value: object
- nil: boolean
- globalScope: boolean
- typeSubstituted: boolean
Example
{
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "object",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
}
JAXBElementString: object
- name: QName
- value: string
- nil: boolean
- globalScope: boolean
- typeSubstituted: boolean
Example
{
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
}
LocalizedGuidances: object
- localizedGuidance: LocalizedLabelType
-
LocalizedLabelType
Example
{
"localizedGuidance": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
}
LocalizedPluralLabels: object
- localizedPluralLabel: LocalizedLabelType
-
LocalizedLabelType
Example
{
"localizedPluralLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
}
TypeDefinitionType: object
- name: string
- localizedLabel: string
- localizedLabels: LocalizedLabels
- localizedPluralLabel: string
- localizedPluralLabels: LocalizedPluralLabels
- description: string
- jspPath: string
- id: string
- rootFolderPath: string
- rootFolderId: string
- fieldDefinitions: FieldDefinitions
- fileTypes: FileTypes
Example
{
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedPluralLabel": "string",
"localizedPluralLabels": {
"localizedPluralLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"description": "string",
"jspPath": "string",
"id": "string",
"rootFolderPath": "string",
"rootFolderId": "string",
"fieldDefinitions": {
"fieldDefinition": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedGuidance": "string",
"localizedGuidances": {
"localizedGuidance": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"dataType": "string",
"required": "boolean",
"description": "string",
"computed": "boolean",
"readOnly": "boolean",
"dependencies": {
"dependency": [
{
"dependencyType": "string",
"logicalOperator": "string",
"controllerFieldMapType": [
{
"typeDefinitionId": "string",
"controllerFieldDefinitionId": "string",
"controllerValueType": [
{
"controllerValueName": "string",
"dependentValue": [
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"index": "integer (int32)",
"hidden": "boolean",
"parentId": {
"name": {
"namespaceURI": "string",
"localPart": "string",
"prefix": "string"
},
"value": "string",
"nil": "boolean",
"globalScope": "boolean",
"typeSubstituted": "boolean"
},
"parentName": "string"
}
]
}
]
}
]
}
]
},
"enumValues": {
"enumValue": [
{
"id": "string"
}
]
}
}
]
}
}
AssociationDefinitionType: object
- id: string
- name: string
- localizedLabel: string
- localizedLabels: LocalizedLabels
- localizedPluralLabel: string
- localizedPluralLabels: LocalizedPluralLabels
- associationDefinitionId: string
- max: integer (int32)
- min: integer (int32)
- enabled: boolean
- relationship: string
Example
{
"id": "string",
"name": "string",
"localizedLabel": "string",
"localizedLabels": {
"localizedLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"localizedPluralLabel": "string",
"localizedPluralLabels": {
"localizedPluralLabel": [
{
"localeISOCode": "string",
"localizedLabel": "string"
}
]
},
"associationDefinitionId": "string",
"max": "integer (int32)",
"min": "integer (int32)",
"enabled": "boolean",
"relationship": "string"
}
AdminPermissionType: object
- id: string
- groupId: string
- groupName: string
- canLock: boolean
- canUnLock: boolean
- canResetPassword: boolean
- canAssignRole: boolean
- canRevokeRole: boolean
- canBrowse: boolean
- canCreate: boolean
- canModify: boolean
- canRemove: boolean
- canEnable: boolean
- canDisable: boolean
- canAddGroup: boolean
- canRemoveGroup: boolean
- canManage: boolean
Example
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
AdminPermissions: object
- adminPermission: AdminPermissionType
-
AdminPermissionType
Example
{
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
}
ApplicationPermissionType: object
- name: string
- fullName: string
- id: string
- description: string
Example
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
ApplicationPermissions: object
- applicationPermission: ApplicationPermissionType
-
ApplicationPermissionType
Example
{
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
}
GroupType: object
- links: Link
-
Link - groupName: string
- id: string
- description: string
- parentId: string
- passwordCreationDate: string (date-time)
- isLocked: boolean
- isHidden: boolean
- isDeleted: boolean
- isEnabled: boolean
- isEditable: boolean
- hasMembers: boolean
- emailAddress: string
- emailAdress: string
- adminLevel: integer (int32)
- applicationPermissions: ApplicationPermissions
- adminPermissions: AdminPermissions
- roleAssignments: RoleAssignments
Example
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
RoleAssignmentType: object
- roleName: string
- objectTypeName: string
- id: string
- role: string
- folder: string
- objectType: string
- securityPrincipal: string
- dateCreated: string (date-time)
- dateChanged: string (date-time)
Example
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
RoleAssignments: object
- roleAssignment: RoleAssignmentType
-
RoleAssignmentType
Example
{
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
Groups: object
Example
{
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
}
}
]
}
UserType: object
- userName: string
- id: string
- description: string
- firstName: string
- lastName: string
- middleName: string
- password: string
- passwordCreationDate: string (date-time)
- passwordExpiresInDays: integer (int32)
- canChangePassword: boolean
- isTemporaryPassword: boolean
- isPasswordChangeFromAdmin: boolean
- isLocked: boolean
- isSecurityAdministrator: boolean
- localeISOCode: string
- isHidden: boolean
- isDeleted: boolean
- isEnabled: boolean
- isEditable: boolean
- emailAddress: string
- emailAdress: string
- adminLevel: integer (int32)
- adminPermissions: AdminPermissions
- roleAssignments: RoleAssignments
- groups: Groups
- availableProfileNames: string[]
-
string - preferredProfileName: string
- displayName: string
Example
{
"userName": "string",
"id": "string",
"description": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"password": "string",
"passwordCreationDate": "string (date-time)",
"passwordExpiresInDays": "integer (int32)",
"canChangePassword": "boolean",
"isTemporaryPassword": "boolean",
"isPasswordChangeFromAdmin": "boolean",
"isLocked": "boolean",
"isSecurityAdministrator": "boolean",
"localeISOCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"roleAssignments": {
"roleAssignment": [
{
"roleName": "string",
"objectTypeName": "string",
"id": "string",
"role": "string",
"folder": "string",
"objectType": "string",
"securityPrincipal": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)"
}
]
},
"groups": {
"group": [
{
"links": [
{
"rel": "string",
"href": "string",
"type": "string",
"hreflang": "string",
"length": "string"
}
],
"groupName": "string",
"id": "string",
"description": "string",
"parentId": "string",
"passwordCreationDate": "string (date-time)",
"isLocked": "boolean",
"isHidden": "boolean",
"isDeleted": "boolean",
"isEnabled": "boolean",
"isEditable": "boolean",
"hasMembers": "boolean",
"emailAddress": "string",
"emailAdress": "string",
"adminLevel": "integer (int32)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{}
]
}
}
]
}
}
IdFieldType: object
- id: string
- dataType: string
- name: string
- hasChanged: boolean
- value: string
Example
{
"id": "string",
"dataType": "string",
"name": "string",
"hasChanged": "boolean",
"value": "string"
}
ObjectPermissionType: object
- id: string
- objectTypeId: string
- objectTypeName: string
- canRead: object
- canWrite: object
- canDelete: object
- canAssociate: object
- rootFolderId: string
- rootFolderPath: string
Example
{
"id": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"canRead": "object",
"canWrite": "object",
"canDelete": "object",
"canAssociate": "object",
"rootFolderId": "string",
"rootFolderPath": "string"
}
ObjectPermissions: object
- objectPermission: ObjectPermissionType
-
ObjectPermissionType
Example
{
"objectPermission": [
{
"id": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"canRead": "object",
"canWrite": "object",
"canDelete": "object",
"canAssociate": "object",
"rootFolderId": "string",
"rootFolderPath": "string"
}
]
}
RoleType: object
- roleName: string
- id: string
- description: string
- isEnabled: boolean
- isLocked: boolean
- grcObjectType: string
- dateCreated: string (date-time)
- dateChanged: string (date-time)
- applicationPermissions: ApplicationPermissions
- adminPermissions: AdminPermissions
- objectPermissions: ObjectPermissions
Example
{
"roleName": "string",
"id": "string",
"description": "string",
"isEnabled": "boolean",
"isLocked": "boolean",
"grcObjectType": "string",
"dateCreated": "string (date-time)",
"dateChanged": "string (date-time)",
"applicationPermissions": {
"applicationPermission": [
{
"name": "string",
"fullName": "string",
"id": "string",
"description": "string"
}
]
},
"adminPermissions": {
"adminPermission": [
{
"id": "string",
"groupId": "string",
"groupName": "string",
"canLock": "boolean",
"canUnLock": "boolean",
"canResetPassword": "boolean",
"canAssignRole": "boolean",
"canRevokeRole": "boolean",
"canBrowse": "boolean",
"canCreate": "boolean",
"canModify": "boolean",
"canRemove": "boolean",
"canEnable": "boolean",
"canDisable": "boolean",
"canAddGroup": "boolean",
"canRemoveGroup": "boolean",
"canManage": "boolean"
}
]
},
"objectPermissions": {
"objectPermission": [
{
"id": "string",
"objectTypeId": "string",
"objectTypeName": "string",
"canRead": "object",
"canWrite": "object",
"canDelete": "object",
"canAssociate": "object",
"rootFolderId": "string",
"rootFolderPath": "string"
}
]
}
}