Sequence Events Feed

Introduction

In order to track changes in resources, a client of the Sequence API can use the events feed.

Each event in the feed represents a change on a specified resource at specified time.

Currently, there are three types of events per resource:

• The creation of the resource.
• The modification of any attribute or link of the resource.
• The deletion of the resource.

This is an example of the XML representation of the event feed:

<events type="array">
  <event>
    <id type="integer">40393</id>
    <event-type>job_created</event-type>
    <timestamp type="datetime">2012-12-03T09:35:37+00:00</timestamp>
    <link href="https://sequence/api/work_areas/85/jobs/97185" rel="subject"/>
  </event>
  <event>
    <id type="integer">40397</id>
    <event-type>asset_updated</event-type>
    <changes>status,name</changes>
    <timestamp type="datetime">2012-12-03T09:35:39+00:00</timestamp>
    <link href="https://sequence/api/work_areas/85/jobs/97185/assets/467237" rel="subject"/>
  </event>
  <event>
    <id type="integer">40401</id>
    <event-type>task_destroyed</event-type>
    <timestamp type="datetime">2012-12-04T14:46:55+00:00</timestamp>
    <link href="https://sequence/api/work_areas/85/jobs/97144/tasks/3030" rel="subject"/>
  </event>
</events>

Available attributes:

Event ID (id)

Integer: Read only

The identifier of the event. Events are presented sorted by id and can be filtered with the newer_than parameter (see below). Clients may want to store the id of the last processed event so that they don't process twice the same event.

Event Type (event-type)

String: Read only

The type of the event. The list of supported events is specified below. The format of the event-type is as follows:

{{resource_type}}_{{operation}}

Currently, there are three possible operations:

• created. For the creation of the resource.
• updated. For the modification of any attribute or link of the resource.
• deleted. For the deletion of the resource.

Changes (event-type)

Comma-separated string: Read only

The list of attributes and links that changed. This attribute is only present if the event-type is an _update.

Timestamp (timestamp)

Datetime: Read only

The date and time when the event occurred.

Available links:

Subject (subject)

The resource that was created, updated or deleted.