Event Hub
Base URL: /domains/eventhub
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/archives | GET | Retrieve Events from the Event Archive. Most events are available for 45 days. |
OPTIONS | What can this endpoint do? | |
/domains | GET | Lists the set of Domains visible on the Administrative Portal. |
OPTIONS | What can this endpoint do? | |
POST | Defines a new Domain. We are using Internet accepted domains. Event Types are grouped in Domains and then Entities. This makes the new Domain visible on the Administrative Portal. The Administrative Portal is used by developers to manage their subscriptions. | |
/domains/{domain} | DELETE | Delete a Domain |
OPTIONS | What can this endpoint do? | |
/entities | GET | Lists the set of entities visible on the Administrative Portal. |
OPTIONS | What can this endpoint do? | |
POST | Defines a new Entity. | |
/entities/{domain}/{entity} | DELETE | Delete a entity |
OPTIONS | What can this endpoint do? | |
/event-types | GET | Lists the set of event-types visible on the Administrative Portal. |
OPTIONS | What can this endpoint do? | |
POST | Defines a new event type. | |
/event-types/{domain}/{entity}/{event_type} | DELETE | Delete an event type |
OPTIONS | What can this endpoint do? | |
PUT | Modify an event type | |
/events | GET | Retrieve a collection of events |
OPTIONS | What can this endpoint do? | |
POST | Create a new event | |
/events/{eventID} | DELETE | Acknowledge an event |
OPTIONS | What can this endpoint do? | |
PUT | Acknowledge an event | |
/subscriptions | GET | Lists the set of subscriptions visible on the Administrative Portal. |
OPTIONS | What can this endpoint do? | |
POST | Defines a new subscription. | |
/subscriptions/{domain}/{entity}/{event_type} | DELETE | Delete a subscription |
OPTIONS | What can this endpoint do? | |
/summaries | GET | Lists the set of summaries visible on the Administrative Portal. |
OPTIONS | What can this endpoint do? | |
/webhooks | DELETE | Delete a webhook |
GET | Retrieve a collection of webhooks | |
OPTIONS | What can this endpoint do? | |
POST | Register webhook | |
PUT | Modify a webhook |
Paths
GET /archives
Tags: archivesdomain | Limits the list where the domain attribute matches the string expression. The string may include wild characters (''). Since domains contain an embedded dot ("."), the period must be explicitly expressed in the search string. For example, 'edu.byu' will limit the search to a specific domain, 'edu.' will limit the search to all 'edu' domains, and '.byu' will limit the search to any domain that starts with 'byu' in the first part of the domain. | query | string | |
entity | Limits the list where the entity attribute matches the string expression. The string may include wild characters ('*'). | query | string | |
event_dt | Defines a date-time range for the search. The expected parameter should be of the format '(start_dt, end_dt)'. The dates should be standard ISO format expressed in zulu time. Maximum time span is one day. | query | string | |
event_type | query | string | ||
page_start | Specifies how far to skip into a large set | query | integer 1 | |
page_size | Specifies how many items to return from a large set | query | integer 50 |
Uses default content-types: application/json
- 200 OK
-
Events Retrieved
- 204 No Content
-
No results found with search criteria
- 400 Bad Request
-
Unknown parameter in search criteria
Uses default content-types: application/json
- 200 OK
-
Domains Retrieved
- 204 No Content
-
No results found
POST /domains
Tags: domainsUses default content-types: application/json
Request Body
Uses default content-types: application/json
- 201 Created
-
Domain Added
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to add a domain
- 403 Forbidden
-
Access denied - not authorized to add a domain
- 409 Conflict
-
Body of the request contains conflicting, malformed, or invalid data
domain | domain | path | string |
Uses default content-types: application/json
- 204 No Content
-
Domain successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to delete a domain
- 403 Forbidden
-
Access denied - not authorized to delete a domain
entity | query | string |
Uses default content-types: application/json
- 200 OK
-
entities Retrieved
- 204 No Content
-
No results found
Uses default content-types: application/json
Request Body
Uses default content-types: application/json
- 201 Created
-
Entity Added
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to add an entity
- 403 Forbidden
-
Access denied - not authorized to add an entity
- 409 Conflict
-
Body of the request contains conflicting, malformed, or invalid data
domain | domain | path | string | |
entity | entity | path | string |
Uses default content-types: application/json
- 204 No Content
-
Entity successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to delete an entity
- 403 Forbidden
-
Access denied - not authorized to delete an entity
- 404 Not Found
-
Entity not found
GET /event-types
Tags: event-typesdomain | query | string | ||
entity | query | string | ||
event-type | query | string |
Uses default content-types: application/json
- 200 OK
-
event-types Retrieved
- 204 No Content
-
No results found
- 400 Bad Request
-
Unknown parameter in search criteria
Uses default content-types: application/json
Request Body
Uses default content-types: application/json
- 201 Created
-
Event type Added
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to add a event type
- 403 Forbidden
-
Access denied - not authorized to add a event type
- 409 Conflict
-
Body of the request contains conflicting, malformed, or invalid data
domain | domain | path | string | |
entity | entity | path | string | |
event_type | event_type | path | string |
Uses default content-types: application/json
- 204 No Content
-
Event type successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to delete an event type
- 403 Forbidden
-
Access denied - not authorized to delete an event type
- 404 Not Found
-
Event type not found
Uses default content-types: application/json
Request Body
domain | domain | path | string | |
entity | entity | path | string | |
event_type | event_type | path | string |
Uses default content-types: application/json
- 200 OK
-
Event type successfully modified
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to modify an event type
- 403 Forbidden
-
Access denied - not authorized to modify an event type
- 409 Conflict
-
Body of the request contains conflicting, malformed, or invalid data
count | Defines how many events to return. Defaults to 1. | query | integer 1 |
application/json application/xml
- 200 OK
-
Collection Retrieved
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No Cars satisfy the query parameters - the collection is empty
- 409 Conflict
-
Query parameters conflict or are malformed
Uses default content-types: application/json
Request Body
Uses default content-types: application/json
- 201 Created
-
Event raised
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to add an event
- 403 Forbidden
-
Access denied - not authorized to add an event
- 409 Conflict
-
Body of the request contains conflicting, malformed, or invalid data
eventID | eventID | path | string |
Uses default content-types: application/json
- 200 OK
-
Event Item Acknowledged
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No events found - invalid event_id
eventID | eventID | path | string | |
single | single | query | boolean |
Uses default content-types: application/json
- 200 OK
-
Event Item Acknowledged
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No events found - invalid event_id
GET /subscriptions
Tags: subscriptionseca_identity_id | query | string | ||
domain | query | string | ||
entity | query | string | ||
event_type | query | string |
Uses default content-types: application/json
- 200 OK
-
subscriptions Retrieved
- 204 No Content
-
No results found
Uses default content-types: application/json
Request Body
Uses default content-types: application/json
- 201 Created
-
Subscription Added
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to add an entity
- 403 Forbidden
-
Access denied - not authorized to add an entity
- 409 Conflict
-
Body of the request contains conflicting, malformed, or invalid data
domain | domain | path | string | |
entity | entity | path | string | |
event_type | event_type | path | string |
Uses default content-types: application/json
- 204 No Content
-
Entity successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to delete an subscription
- 403 Forbidden
-
Access denied - not authorized to delete an subscription
- 404 Not Found
-
Entity not found
domain | query | string | ||
entity | query | string | ||
event_date | query | string | ||
event_type | query | string | ||
page_start | Specifies how far to skip into a large set | query | integer 1 | |
page_size | Specifies how many items to return from a large set | query | integer 10 |
Uses default content-types: application/json
- 200 OK
-
summaries Retrieved
- 204 No Content
-
No results found
Uses default content-types: application/json
- 204 No Content
-
Webhook successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to delete an subscription
- 403 Forbidden
-
Access denied - not authorized to delete an subscription
- 404 Not Found
-
Webhook not found
identity_id | query | string | ||
identity_name | query | string | ||
endpoint | query | string | ||
push_option | query | string |
Uses default content-types: application/json
- 200 OK
-
Collection Retrieved
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No Cars satisfy the query parameters - the collection is empty
- 409 Conflict
-
Query parameters conflict or are malformed
Register webhook
Uses default content-types: application/json
Request Body
Uses default content-types: application/json
- 201 Created
-
Event raised
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to add a webhook
- 403 Forbidden
-
Access denied - not authorized to add a webhook
- 409 Conflict
-
Body of the request contains conflicting, malformed, or invalid data
Uses default content-types: application/json
Request Body
Uses default content-types: application/json
- 200 OK
-
Event Item Retrieved
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
Webhook not found
Schema definitions
domain_definition
- domain_definition: domain_definition_array
-
domain_definition_array
domain_definition_create
- domain_definition: domain
-
- entities: entity_definition
-
- entity_definition: entity_array
-
- entity_definition: entity
-
Additional explanation for error conditions
- explanation: string
-
Detailed explanation of the error
- error_data: string
-
When appropriate, the data value that caused the error
- return_code: integer (int32)
-
The HTTP Status code
- event: event_array
-
- event_types: event_type_definition
-
- teaching_area: string
-
- section_number: string
-
- person_id: string
-
- title_code: string
-
- catalog_number: string
-
- student_name: string
-
- curriculum_id: string
-
- year_term: string
-
- credit_hours: string
-
- source_dt: string (date-time)
-
- source_id: integer (int32)
-
- event_dt: string (date-time)
-
- event_type: string
-
- entity: string
-
- domain: string (uri)
-
- event_id: string
-
- dispatch_id: string
-
event_header_item
- source_dt: string (date-time)
-
- source_id: string
-
- event_dt: string (date-time)
-
- event_type: string
-
- entity: string
-
- domain: string (uri)
-
- event_id: string
-
- dispatch_id: string
-
- history: history
-
- event_header: event_header
-
- event_body: event_body
-
- filters: filters
-
- event_type_definition: event_type_array
-
- event_type_definition: event_type_item
-
- domain: string
-
- entity: string
-
- event_type: string
-
- description: string
-
- filter_names: filter_names
-
- events: event
-
- filter_name: filter_name
-
- filter: filter_array
-
- event_header: event_header_array
-
- subscription: subscription_array
-
- subscription: subscription_item
-
- eca_identity_id: string
-
- event_type: string
-
- entity: string
-
- domain: string
-
- eca_identity_name: string
-
- subscriptions: subscription
-
- count: string
-
- event_type: string
-
- entity: string
-
- event_date: string
-
- domain: string (uri)
-
- webhook: webhook_array
-
- identity_id: string
-
- security_option: string
-
- identity_name: string
-
- push_option: string
-
- content_type: string
-
- endpoint: string
-
- security_key: string
-
- webhook: webhook_item
-
- webhooks: webhook
-