Jump to

• Request
• Response

Retrieve an Event Type

get

/ic/api/integration/v1/eventTypes/{id}

Retrieves detailed information about the event type with the specified code and revision.

Request

Path Parameters

• id(required): string
  Event type composite identifier. The ID consists of the code and the revision separated by the | (vertical line) character. Format: code%7Crevision. Example: MY_EVENT_TYPE%7C1. When using cURL, substitute the %7C code for the vertical line.

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.

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=singular

200 Response

Successful operation

Body ()

Root Schema : EventTypeRs

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
• schema: string
  Schema associated with the event type.
• schema-type: string
  Type of schema associated with the event type. For example: json
• usage-count: integer (int32)
  Number of integrations using the event type. Includes the usage across all revisions of the event type.
• usage-details: object EventTypeUsageRs

{
    "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"
        },
        "schema-type":{
            "type":"string",
            "description":"Type of schema associated with the event type. For example: json"
        },
        "schema":{
            "type":"string",
            "description":"Schema associated with the event type."
        },
        "usage-details":{
            "$ref":"#/components/schemas/EventTypeUsageRs"
        }
    }
}

Nested Schema : EventTypeUsageRs

Type: object

Show Source

• links: array links
• name: string
• publishing-integrations: array publishing-integrations
• subscribing-integrations: array subscribing-integrations

{
    "type":"object",
    "properties":{
        "publishing-integrations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationUsageRs"
            }
        },
        "subscribing-integrations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationUsageRs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : publishing-integrations

Type: array

Show Source

• Array of: object IntegrationUsageRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationUsageRs"
    }
}

Nested Schema : subscribing-integrations

Type: array

Show Source

• Array of: object IntegrationUsageRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationUsageRs"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationUsageRs

Type: object

Show Source

• code: string
• is-locked: boolean
• links: array links
• name: string
• reactivation-status: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "is-locked":{
            "type":"boolean"
        },
        "reactivation-status":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

404 Response

Event type not found

500 Response

Server error

Back to Top