GET /v2/events
Name | Description | Valid Values | Example Values |
---|---|---|---|
q |
Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: timestamp, type, actee |
|
|
page | Page of results to fetch |
|
|
results-per-page | Number of results per page |
|
|
order-direction | Order of the results: asc (default) or desc |
|
|
inline-relations-depth | 0 - don't inline any relations and return URLs. Otherwise, inline to depth N. |
|
|
orphan-relations | 0 - de-duplicate object entries in response |
|
|
exclude-relations | comma-delimited list of relations to drop from response |
|
|
include-relations | comma-delimited list of the only relations to include in response |
|
|
Name | Description | Default | Valid Values | Example Values |
---|---|---|---|---|
guid | The guid of the event. |
|
|
|
type | The type of the event. |
|
|
|
actor | The GUID of the actor. |
|
|
|
actor_type | The actor type. |
|
|
|
actor_name | The name of the actor. |
|
|
|
actee | The GUID of the actee. |
|
|
|
actee_type | The actee type. |
|
|
|
actee_name | The name of the actee. |
|
|
|
timestamp | The event creation time. |
|
|
|
metadata | The additional information about event. | {} |
|
|
space_guid | The guid of the associated space. |
|
|
|
organization_guid | The guid of the associated organization. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MyIsImVtYWlsIjoiZW1haWwtMzA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDl9.le5qdVfn-Pzc9bCgQuwtKkgBRp7L2Ozhzg4aNobDafA Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MyIsImVtYWlsIjoiZW1haWwtMzA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDl9.le5qdVfn-Pzc9bCgQuwtKkgBRp7L2Ozhzg4aNobDafA" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "c512725b-c1b7-44f8-b25a-68548c357c04", "url": "/v2/events/c512725b-c1b7-44f8-b25a-68548c357c04", "created_at": "2016-04-16T01:24:09Z", "updated_at": null }, "entity": { "type": "name-2357", "actor": "guid-cdfd5012-4d81-4b4e-aeb8-cf702e9e3ba3", "actor_type": "name-2358", "actor_name": "name-2359", "actee": "guid-465fa5e1-9374-4754-9fa5-55d3be3dc2ec", "actee_type": "name-2360", "actee_name": "name-2361", "timestamp": "2016-04-16T01:24:09Z", "metadata": { }, "space_guid": "e398407e-3f21-4a83-b328-700f42d5a34c", "organization_guid": "435c39a7-9745-4c8f-8aaf-4f829f819b2a" } }, { "metadata": { "guid": "9234484d-2321-4b15-b059-51c5c639e2b5", "url": "/v2/events/9234484d-2321-4b15-b059-51c5c639e2b5", "created_at": "2016-04-16T01:24:09Z", "updated_at": null }, "entity": { "type": "name-2365", "actor": "guid-39e48ecc-0146-4fe0-b56f-df64c39d9393", "actor_type": "name-2366", "actor_name": "name-2367", "actee": "guid-36fb8106-2bc3-4513-80be-5b39eaa5b3a4", "actee_type": "name-2368", "actee_name": "name-2369", "timestamp": "2016-04-16T01:24:09Z", "metadata": { }, "space_guid": "0e093ca7-48c1-4eaa-ab31-5dae457cfd98", "organization_guid": "825b02b5-f8ab-4290-bd42-68747b8f70a7" } }, { "metadata": { "guid": "072bcdde-98c2-4ac9-baf8-f3b99ad8fbf7", "url": "/v2/events/072bcdde-98c2-4ac9-baf8-f3b99ad8fbf7", "created_at": "2016-04-16T01:24:09Z", "updated_at": null }, "entity": { "type": "name-2373", "actor": "guid-d1f37ffc-7f14-4ca1-9e44-34d15926c9e9", "actor_type": "name-2374", "actor_name": "name-2375", "actee": "guid-4394d7aa-21c6-4929-a640-d05a4fdbadde", "actee_type": "name-2376", "actee_name": "name-2377", "timestamp": "2016-04-16T01:24:09Z", "metadata": { }, "space_guid": "a36c8551-7963-44f1-8038-aa84941ad8e0", "organization_guid": "48d95742-d69d-4f11-a559-91c2edfdffdf" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 1e16f580-9f05-4b3b-acd7-9e7e6ac5451c Content-Length: 2400 X-Content-Type-Options: nosniff