Skip to content

Events

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/events/ List Events
GET /api/events/{id}/ Retrieve
Other Actions
GET /api/events/count/ Count
GET /api/events/event_groups/ Returns a list of groups with event types
GET /api/events/scope_types/ Returns a list of scope types acceptable by events filter

Core CRUD

List Events

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.events import events_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: events_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventsList } from 'waldur-js-client';

try {
  const response = await eventsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created_from number
created_to number
customer_uuid string (uuid) Customer UUID
field array
message string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) Project UUID
user_uuid string (uuid) User UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.events import events_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: events_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { eventsRetrieve } from 'waldur-js-client';

try {
  const response = await eventsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this event.
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any

Other Actions

Count

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/count/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.events import events_count_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_count_retrieve.sync(client=client)

print(response)
  1. API Source: events_count_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventsCountRetrieve } from 'waldur-js-client';

try {
  const response = await eventsCountRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any

Returns a list of groups with event types

Returns a list of groups with event types. Group is used in exclude_features query param.

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/event_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.events import events_event_groups_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_event_groups_retrieve.sync(client=client)

print(response)
  1. API Source: events_event_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventsEventGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await eventsEventGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any

Returns a list of scope types acceptable by events filter

Returns a list of scope types acceptable by events filter.

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/scope_types/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.events import events_scope_types_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_scope_types_retrieve.sync(client=client)

print(response)
  1. API Source: events_scope_types_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventsScopeTypesRetrieve } from 'waldur-js-client';

try {
  const response = await eventsScopeTypesRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any