Jump to

• Request
• Response

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'}

  • 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'}

• return: string

Header Parameters

• next-page-token: string
  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 Top

Response

Supported Media Types

• application/json; charset=utf-8, application/vnd.oracle.resource+json;type=collection

200 Response

Successful operation

Body ()

Root Schema : EventTypesRs

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of event types",
            "items":{
                "$ref":"#/components/schemas/EventTypeBaseRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total results",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Flag to check if more records exists"
        },
        "limit":{
            "type":"integer",
            "description":"Limit of records to be displayed",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

List of event types

Show Source

• Array of: object EventTypeBaseRs

{
    "type":"array",
    "description":"List of event types",
    "items":{
        "$ref":"#/components/schemas/EventTypeBaseRs"
    }
}

Nested Schema : EventTypeBaseRs

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Event type name"
        },
        "description":{
            "type":"string",
            "description":"Event type description"
        },
        "created":{
            "type":"string",
            "description":"Event type created date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Event type CreatedBy user name"
        },
        "usage-count":{
            "type":"integer",
            "description":"Number of integrations using the event type. Includes the usage across all revisions of the event type.",
            "format":"int32"
        },
        "id":{
            "type":"string"
        },
        "revision":{
            "type":"string",
            "description":"Event type revision"
        },
        "code":{
            "type":"string",
            "description":"Event type code"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top