The REST interface for working with EDQ packaging, exporting, and importing configuration is

http://edqserver:port/edq/package

This interface allows you to perform the following tasks:

• Exporting configuration

  You must have the Package functional permission to package and export configuration objects. If case management objects are included in the export, you must have access to the Case Management Administration application.

  To package and export configuration objects, use the following interface:

  POST http://edqserver:port/edq/package/export

• Importing configuration

  You must have create and delete function permissions for all the objects that are being imported. If case management objects are included in the import, you must have access to the Case Management Administration application.

  To import configuration objects, use the following interface:

  POST http://edqserver:port/edq/package/import

• Getting packaging task status

  Export and import calls return immediately and the packaging task runs asynchronously. The result of package calls is a JSON object containing an "id" attribute, which is the "execution ID" for the task. For example:

  {"id":"58636dd0-22b6-4d7d-be16-74908d30404f"}

  To get status information on a packaging task, use the following interface:

  GET http://edqserver:port/edq/package/status/executionid

  Packaging status is retained in the system for one hour after the task has completed. If you do not specify the execution ID in the get status call, the status for all retained packaging tasks is returned.

  For example:

  GET http://server/edq/package/status/58636dd0-22b6-4d7d-be16-74908d30404f

  returns status information specific to this execution ID.

  GET http://server/edq/package/status

  returns status information for all retained packaging tasks. See Packaging Task Status Result Format for more details.

The result of the GET status call is an object in which the attributes are the currently retained execution IDs. The value of each attribute is a status object with these attributes:

The manifest for an export task is stored as the first entry in the package ZIP file. The manifest object contains these attributes:

Example status result

An export that is run with this payload:

{ ...

{ "label": "Export task1",
 
  "password": "medusa",
 
  "destination": {
    "location": "https://objectstorage.us-phoenix-1.oraclecloud.com/n/devbigdata/b/rde.bucket1/o/example.zip",
    "credentials": "OCI 1"
  },
 
  "projects": {
    "include": ["adb", "cases", "s*"],
    "exclude": ["snowflake"],
    "renames": {
      "adb": "Oracle ADB"
    }
  },
 
  "referencedata": {
    "include": ["*Country*"]
  },
 
  "storedcredentials": {
    "include": ["OCI*", "aws*"],
    "exclude": ["aws?"]
  },
 
  "casemanagement": {
 
    "sources": {
      "include": ["CS2", "Issue Remediation"]
    },
 
    "workflows": {
      "include": ["Issue Remediation*"]
    },
 
    "permissions": {
      "include": ["Permission?"]
    }
  }
}

would return this status after completion:

{ "d154aee7-9af4-46ab-af89-84ed6b12109a": {
    "start": "2023-07-13T16:44:17.809Z",
    "label": "Export task1",
    "type": "export",
    "end": "2023-07-13T16:44:26.871Z",
    "manifest": {
      "appversion": "14.1.2.0.0",
      "encrypted": true,
      "projects": [
        "Oracle ADB",
        "cases",
        "scannerbug",
        "scripts",
        "services",
        "sqlserver",
        "srvr"
      ],
      "referencedata": [
        "Country from City",
        "Nationality to Standard Country",
        "Standardize Country Names"
      ],
      "datastores": [],
      "publishedprocessors": [],
      "storedcredentials": [
        "OCI 1",
        "OCI edqtest",
        "OCI edqtest2",
        "aws - oracle",
        "aws rde",
        "aws s3"
      ],
      "casemanagement": {
        "permissions": [
          "Permission1",
          "Permission2"
        ],
        "workflows": [
          "Issue Remediation Alerts",
          "Issue Remediation Cases"
        ],
        "sources": [
          "CS2",
          "Issue Remediation"
        ]
      },
      "version": 1
    },
    "complete": true
  }
}

Groups in external realms (LDAP etc) are mapped to EDQ internal group so that the permissions and applications available to a user can be determined on login. Calls in this category return the currently defined mappings and update mappings.

Each mapping is represented by an object with these attributes:

You can perform the following tasks:

• Get current mappings

  To retrieve information about the current external group mappings, use the following interface:

  GET http://server:port/edq/useradmin/externalgroups

  The result is an array of mapping objects.

• Update mappings

  To update information about the current external group mappings, use the following interface:

  POST http://server:port/edq/useradmin/externalgroups

  The payload is an array of mapping objects. The calling user must have the Modify External Group Permissions functional permission.

  Example:

  [ 
    { "realm": "EXAMPLE.COM",
      "externalgroup": "edqgroup1",
      "internalgroups": ["Data Analysts"]
    },
    { "realm": "EXAMPLE.COM",
      "externalgroup": "edqgroup2",
      "internalgroups": ["Match Reviewers", "Executives"]
    }
  ]

The calling user must have the Access User Administration functional permission for all user administration calls.

You can perform the following tasks:

• Get all groups

  To return an array of group objects, use the following interface:

  GET http://server:port/edq/useradmin/groups

• Get named group

  To get information on a single named group, use the following interface:

  GET http://server:port/edq/useradmin/group/name

  The result is a group object. If the group does not exist, a 404 response is returned.

• Create or update single group

  To create or update a single group, use the following interface:

  POST http://server:port/edq/useradmin/group

  The payload is a single group object. If the permissions or applications attributes are not specified, the corresponding values in the group are not changed on update. If the group does not exist, the calling user must have the Add Group permission, otherwise the user must have the Modify Group permission.

• Create or update multiple groups

  To create or update multiple groups, use the following interface:

  POST http://server:port/edq/useradmin/groups

  The payload is an array of group objects.

• Delete named group

  To delete a named group, use the following interface:

  DELETE http://server:port/edq/useradmin/group/name

  The user must have the Delete Group permission.

• Update group

  To update a group, use the following interface:

  POST http://server:port/edq/useradmin/updategroup

  This request can be used to add or remove permissions or applications from an existing group. The payload is a JSON object with these attributes:

  Attribute	Description
  name	The name of the group. Always required.
  permissions	Permission additions and removals.
  applications	Application additions and removals.

  The permissions and applications attributes are object with these attributes:

  Attribute	Description
  add	Array of values to add to the group.
  remove	Array of values to remove from the group.

  Example:

  { "name": "Test Group",
    "permissions": {
      "add": [ "user_admin:*", "ops:dnviewallevents"],
      "remove": [ "server_admin:accessserveradmin"]
     },
     "applications": {
       "add": ["opsui" ]
     }
  }

• Get lists of supported applications and functional permissions

  Use the following interface:

  GET http://server:port/edq/useradmin/permissionsinfo

  Group objects list applications and functional permissions using internal identifiers. The call returns lists of all supported applications and permissions including both the display strings used in the administration web UI and the associated identifiers. Permissions are grouped by the categories shown in the group administration web UI.

  The result object contains these attributes:

  Attribute	Description
  applications	List of supported applications.
  functionalpermissions	List of permission categories. Each element contains these attributes: categorylabel - Display string for the category. For example "CM.Static" or "Director". prefix - Prefix associated with the category. For example "data:" or "user_admin:". permissions - List of permissions in the category.

  Individual application and permission objects contain these attributes:

  Attribute	Description
  label	Display string for application or permission.
  identifier	Internal identifier.

  Display strings are returned in the language implied by the web request.