Jump to

• Request
• Response
• Examples

Query system events

get

/epm/rest/public/v1/audit/systemEvents

Request

Query Parameters

• eventCategory: string
  Event category

  Allowed Values: [ "ALL", "ALL_EXCLUDING_INDEX", "INDEX", "METADATA", "MIGRATION", "SECURITY", "SYSTEM", "TEMPLATE" ]
• eventType: string
  Event type scoped to eventCategory
• fromDate: string
  Start of date range as timestamp with UTC, time zone offset, or time zone name

  Allowed Values: [ "YYYY-MM-DDTHH:MM:SS", "YYYY-MM-DDTHH:MM:SS+hh:mm", "YYYY-MM-DDTHH:MM:SS Region/City" ]
• pageSize: string
  Number of records to return. Default 50, maximum 200.
• pageToken: string
  Opaque token returned by the previous response
• toDate: string
  End of date range as timestamp with UTC, time zone offset, or time zone name

  Allowed Values: [ "YYYY-MM-DDTHH:MM:SS", "YYYY-MM-DDTHH:MM:SS-hh:mm", "YYYY-MM-DDTHH:MM:SS Region/City" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : SystemEvents

Type: object

Show Source

• hasMore: boolean
• items: array items
• nextPageToken: string
• pageSize: integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SystemEvent"
            }
        },
        "pageSize":{
            "type":"integer",
            "format":"int32"
        },
        "nextPageToken":{
            "type":"string"
        },
        "hasMore":{
            "type":"boolean"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object SystemEvent

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SystemEvent"
    }
}

Nested Schema : SystemEvent

Type: object

Show Source

• application: object IdNameDescription
• createdBy: string
• dimension: object IdNameDescription
• eventAction: string
• eventCategory: string
• eventCategoryCode: string
• eventDate: integer(int64)
• eventDescription: string
• eventType: string
• eventTypeCode: string
• hierarchySet: object IdNameDescription
• id: string
• nodeType: object IdNameDescription
• status: string
• user: object User
• view: object IdNameDescription

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "eventCategory":{
            "type":"string"
        },
        "eventCategoryCode":{
            "type":"string"
        },
        "eventAction":{
            "type":"string"
        },
        "eventDescription":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "eventTypeCode":{
            "type":"string"
        },
        "eventDate":{
            "type":"integer",
            "format":"int64"
        },
        "status":{
            "type":"string"
        },
        "user":{
            "$ref":"#/definitions/User"
        },
        "createdBy":{
            "type":"string"
        },
        "application":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "dimension":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "hierarchySet":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "nodeType":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "view":{
            "$ref":"#/definitions/IdNameDescription"
        }
    }
}

Nested Schema : IdNameDescription

Type: object

Show Source

• description: string
• id: string(uuid)
• name: string

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : User

Type: object

Show Source

• artifactAssignments: array artifactAssignments
• associatedRoles: array associatedRoles
• dataManagerOnAny: boolean
• emailAddresses: array emailAddresses
• epmIdleSessionTimeout: integer(int32)
• firstName: string
• fullName: string
• grantPermission: string
  Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
• homePageLayoutName: string
• id: string(uuid)
• lastName: string
• links: array links
• nameInitials: string
• preferences: object Preferences
• ssoToken: string
• userName: string
• userServiceAdministrator: boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "fullName":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "ssoToken":{
            "type":"string"
        },
        "emailAddresses":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "associatedRoles":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "preferences":{
            "$ref":"#/definitions/Preferences"
        },
        "nameInitials":{
            "type":"string"
        },
        "grantPermission":{
            "type":"string",
            "enum":[
                "OWNER",
                "DATAMANAGER",
                "PARTICIPANT",
                "APPROVER",
                "NOTIFIED",
                "COMMITTER",
                "NONE",
                "METADATAMANAGER"
            ]
        },
        "dataManagerOnAny":{
            "type":"boolean"
        },
        "userServiceAdministrator":{
            "type":"boolean"
        },
        "epmIdleSessionTimeout":{
            "type":"integer",
            "format":"int32"
        },
        "homePageLayoutName":{
            "type":"string"
        },
        "artifactAssignments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ArtifactAssignment"
            }
        }
    }
}

Nested Schema : artifactAssignments

Type: array

Show Source

• Array of: object ArtifactAssignment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ArtifactAssignment"
    }
}

Nested Schema : associatedRoles

Type: array

Show Source

• Array of: object Role

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Role"
    }
}

Nested Schema : emailAddresses

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Preferences

Type: object

Show Source

• actAsThisRole: string
  Allowed Values: [ "USER", "SERVICE_ADMINISTRATOR" ]
• delegateToUserId: string(uuid)
• languageTag: string
• links: array links
• outOfOffice: boolean
• profilePictureId: string(uuid)
• timeZone: object TimeZone

{
    "type":"object",
    "properties":{
        "profilePictureId":{
            "type":"string",
            "format":"uuid"
        },
        "timeZone":{
            "$ref":"#/definitions/TimeZone"
        },
        "languageTag":{
            "type":"string"
        },
        "outOfOffice":{
            "type":"boolean"
        },
        "delegateToUserId":{
            "type":"string",
            "format":"uuid"
        },
        "actAsThisRole":{
            "type":"string",
            "enum":[
                "USER",
                "SERVICE_ADMINISTRATOR"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ArtifactAssignment

Type: object

Show Source

• artifact: object Artifact
• sortOrder: integer(int32)
• visible: boolean

{
    "type":"object",
    "properties":{
        "artifact":{
            "$ref":"#/definitions/Artifact"
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32"
        },
        "visible":{
            "type":"boolean"
        }
    }
}

Nested Schema : Artifact

Type: object

Show Source

• id: string(uuid)
• name: string
• type: string
  Allowed Values: [ "CLUSTER", "CARD" ]

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "CLUSTER",
                "CARD"
            ]
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Role

Type: object

Show Source

• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TimeZone

Type: object

Show Source

• displayName: string
• dstsavings: integer(int32)
• id: string
• rawOffset: integer(int32)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "dstsavings":{
            "type":"integer",
            "format":"int32"
        },
        "rawOffset":{
            "type":"integer",
            "format":"int32"
        }
    }
}

400 Response

Error Response

401 Response

Unauthorized

Back to Top

Examples

The following example shows how to retrieve all the system events by submitting a GET request on the REST resource using cURL.

curl --user edmcs_cloud_user -X GET https://servername.fa.us2.oraclecloud.com/epm/rest/public/v1/audit/systemEvents?eventCategory=SYSTEM&fromDate=2026-07-01T00:00:00.000Z&toDate=2026-07-04T00:00:00.000Z

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "id": "8589A507CE49475A8FC310FE9EF2E613|-",
            "eventCategory": "SYSTEM",
            "eventCategoryCode": "SYSTEM",
            "eventAction": "EVENT",
            "eventDescription": "System starting up",
            "eventType": "System Startup",
            "eventTypeCode": "SYSTEM_STARTUP",
            "eventDate": "2026-07-02T12:43:37.976Z",
            "status": "SUCCESS",
            "user": {
                "userName": "@@sysadmin",
                "fullName": "System User"
            },
            "createdBy": "83ed6845-5299-4dce-ad3f-81a92bcc0853"
        },
        {
            "id": "259E0DB848DC438D8DA3EB09C67943CA|-",
            "eventCategory": "SYSTEM",
            "eventCategoryCode": "SYSTEM",
            "eventAction": "EVENT",
            "eventDescription": "System shutting down",
            "eventType": "System Shutdown",
            "eventTypeCode": "SYSTEM_SHUTDOWN",
            "eventDate": "2026-07-02T12:30:41.830Z",
            "status": "SUCCESS",
            "user": {
                "userName": "@@sysadmin",
                "fullName": "System User"
            },
            "createdBy": "83ed6845-5299-4dce-ad3f-81a92bcc0853"
        }
    ],
    "pageSize": 2,
    "nextPageToken": "MjAyNi0wNi0zMFQxMToxOTo1NS4xMDNafEE1RTQ1NTc5MzRCMDQzRkVBQzgxMjQ5Njk0QTRENEJDfC0",
    "hasMore": true
}

Back to Top