get-event-types-61b71bf.md

Get Event Types

Get all available event types, including their categories and their available search parameters.

The event types you get are either for a central or for a local region, and the region you get depends on the scopes you used to access the API.

To learn more about the scopes, see SAP Cloud Management Service - Service Plans.

Prerequisites

You have obtained an access token with the $XSAPPNAME.event.read scope.

Request

URI: https://events-service.<app domain>.<landscape domain>/cloud-management/v1/events/types

HTTP Method: GET

Response

Returns the event types, their descriptions and categories.

**Content Type:**JSON

Response Status and Error Codes

Code	Description
200	OK
401	Unauthorized Possible reasons: Invalid token
403	Forbidden
404	Not Found
429	Rate Limit Exceeded
500	Internal Server Error Possible reasons: Failed to obtain global account or subaccount info

Response Objects and Their Parameters

BusinessEventTypeResponseObject

A JSON object that contains details about event types.

Parameter Name	Parameter Type	Description
category	String	Category to which the event type belongs. Possible values: LOCAL: The event is associated with the local region within a multi-region universe. CENTRAL: The event is associated with the central region within a multi-region universe.
description	String	The description of the event type.
searchParams	Array	List of all the search parameters for the event type. Provided inline. Example: <URL HOST>?searchParamKey1=searchParamValue1
type	String	The type of the event that was triggered. There are two groups of event types: Local Events and Central Events group. Only event types that belong to one of the groups are returned as the result of a single API call. The event types group you get depends on the scope you used to access the API. The examples of some of the events for both groups: Central Events group: GlobalAccount_Update, AccountDirectory_Creation, AccountDirectory_Update, AccountDirectory_Update_Type, AccountDirectory_Deletion, Subaccount_Creation, Subaccount_Deletion, Subaccount_Update, Subaccount_Move, AccountDirectoryTenant_Creation, AccountDirectoryTenant_Deletion, GlobalAccountEntitlements_Update, EntityEntitlements_Update, EntityEntitlements_Move Local Events group: SubaccountAppSubscription_Creation, SubaccountAppSubscription_Deletion, SubaccountAppSubscription_Update, AppRegistration_Creation, AppRegistration_Deletion, AppRegistration_Update, SubaccountTenant_Creation, SubaccountTenant_Update, SubaccountTenant_Deletion, EnvironmentInstance_Creation, EnvironmentInstance_Deletion, EnvironmentInstances_Deletion

Response Example

{
    "SubaccountAppSubscription_Update": {
        "searchParams": [
            "saasApplicationId",
            "saasApplicationName",
            "consumerTenantId"
        ],
        "description": "A subaccount's subscription to a multitenant application, including its dependencies, was updated.",
        "category": "LOCAL",
        "type": "SubaccountAppSubscription_Update"
    },
    "SubaccountAppSubscription_Creation": {
        "searchParams": [
            "saasApplicationId",
            "saasApplicationName",
            "consumerTenantId"
        ],
        "description": "A subaccount was subscribed to a multitenant application and its dependencies.",
        "category": "LOCAL",
        "type": "SubaccountAppSubscription_Creation"
    },
    "AppRegistration_Creation": {
        "searchParams": [
            "saasApplicationId",
            "saasApplicationName"
        ],
        "description": "A multitenant application was registered in the SaaS registry",
        "category": "LOCAL",
        "type": "AppRegistration_Creation"
    },
    "SubaccountTenant_Creation": {
        "searchParams": [],
        "description": "The tenant of a subaccount was created.",
        "category": "LOCAL",
        "type": "SubaccountTenant_Creation"
    },
    "EnvironmentInstance_Creation": {
        "searchParams": [],
        "description": "An environment instance was created. For example, a Cloud Foundry org was enabled for a subaccount.",
        "category": "LOCAL",
        "type": "EnvironmentInstance_Creation"
    },
    "AppRegistration_Update": {
        "searchParams": [
            "saasApplicationId",
            "saasApplicationName"
        ],
        "description": "The registration of a multitenant application in the SaaS registry was changed.",
        "category": "LOCAL",
        "type": "AppRegistration_Update"
    },
    "AppRegistration_Deletion": {
        "searchParams": [
            "saasApplicationId",
            "saasApplicationName"
        ],
        "description": "A multitenant application was unregistered from the SaaS registry.",
        "category": "LOCAL",
        "type": "AppRegistration_Deletion"
    },
    "EnvironmentInstances_Deletion": {
        "searchParams": [],
        "description": "All environment instances in a subaccount were deleted.",
        "category": "LOCAL",
        "type": "EnvironmentInstances_Deletion"
    },
    "SubaccountAppSubscription_Deletion": {
        "searchParams": [
            "saasApplicationId",
            "saasApplicationName",
            "consumerTenantId"
        ],
        "description": "The subscription of a subaccount to a multitenant application including its dependencies was cancelled.",
        "category": "LOCAL",
        "type": "SubaccountAppSubscription_Deletion"
    },
    "SubaccountTenant_Deletion": {
        "searchParams": [],
        "description": "The tenant of a subaccount was deleted.",
        "category": "LOCAL",
        "type": "SubaccountTenant_Deletion"
    },
    "SubaccountTenant_Update": {
        "searchParams": [],
        "description": "The tenant of a subaccount was changed.",
        "category": "LOCAL",
        "type": "SubaccountTenant_Update"
    },
    "EnvironmentInstance_Deletion": {
        "searchParams": [
            "environmentType",
            "tenantId",
            "subaccountGuid",
            "platformId"
        ],
        "description": "An environment instance was deleted. For example, a Cloud Foundry org, including its contents, was removed from a subaccount.",
        "category": "LOCAL",
        "type": "EnvironmentInstance_Deletion"
    }
}

Related Information

Getting an Access Token for SAP Cloud Management Service APIs

Using the Events Service APIs

Get Events