Retrieve Event Types
get
/ic/api/integration/v1/eventTypes
Retrieves information about all the event types ordered by the last updated time. Retrieves the latest revision of each event type.
Request
Query Parameters
-
integrationInstance(required): string
This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
-
limit: integer(int32)
-
orderBy: string
Orders results by event type name or created time.
Valid values:
- name: Order event types by name in the ascending order. Example: orderBy=name.
- time: Order event types by the created time in the descending order. Example: orderBy=time.
-
q: string
Filters event types by name and code.
Valid parameters:
- name: Name of the event type. Supports full match and exact matches. For example:
- To retrieve event type that is an exact match in the name, specify:
q={name:'My Event Type'}
- To retrieve event type that is an exact match in the name, specify:
- code: Code of the event type. Supports full match and exact matches. For example:
- To retrieve event type that is an exact match in the code, specify:
q={name:'My_Event_Type'}
- To retrieve event type that is an exact match in the code, specify:
- name: Name of the event type. Supports full match and exact matches. For example:
-
return: string
Header Parameters
-
next-page-token:
Use for paginating through the returned results. This is not a mandatory parameter. This parameter can be skipped in the first request. For the subsequent requests, obtain the value for the parameter from the response header named 'nextpagetoken' in the previous request.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json; charset=utf-8, application/vnd.oracle.resource+json;type=collection
200 Response
Successful operation
Root Schema : EventTypesRs
Type:
Show Source
object
-
has-more: boolean
Flag to check if more records exists
-
items: array
items
List of event types
-
limit: integer
(int32)
Limit of records to be displayed
-
total-results: integer
(int32)
Total results
Nested Schema : EventTypeBaseRs
Type:
Show Source
object
-
code: string
Event type code
-
created: string
(date-time)
Event type created date
-
created-by: string
Event type CreatedBy user name
-
description: string
Event type description
-
id: string
-
name: string
Event type name
-
revision: string
Event type revision
-
usage-count: integer
(int32)
Number of integrations using the event type. Includes the usage across all revisions of the event type.
400 Response
Malformed parameters
500 Response
Server error