Arlo

REST Auth API: PlatformEvents

PlatformEvent resources represent a event on a given platform. These events can be polled or delivered to a configured webhook.

PlatformEvent instance resource

Resource URI

/api/2012-02-01/auth/resources/platformevents/{PlatformEventID}/

Resource properties

Property Description
ID An integer value that uniquely identifies this resource within the platform.
Type A string representing the type of this PlatformEvent, one of Created, Updated or Deleted.
ResourceType A string representing the resource for this platformevent.
ResourceID A string representing the ID of the resource.

HTTP GET

Returns a representation of a PlatformEvent, including the properties and links above.

Optional parameters
Parameter Description
expand Expression referencing Link elements to expand when generating the response. See link expansion.
Example

GET /api/2012-02-01/auth/resources/platformevents/847/

<PlatformEvent>
    <ID>1547</ID>
    <Type>Updated</Type>
    <ResourceType>Contact</ResourceType>
    <ResourceID>10987</ResourceID>
    <Link href="https://api.arlo.co/api/2012-02-01/auth/resources/platformevents/1547/" rel="self" type="application/xml"/>
    <Link href="https://api.arlo.co/api/2012-02-01/auth/resources/contacts/10987/" rel="http://schemas.arlo.co/api/2012/02/auth/related/Link" title="Link" type="application/xml"/>
    <Link href="https://api.arlo.co/api/2012-02-01/auth/resources/contacts/10987/" rel="http://schemas.arlo.co/api/2012/02/auth/related/Contact" title="Contact" type="application/xml"/>
</PlatformEvent>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

PlatformEvent collection resource

The PlatformEvent collection resource represents the set of PlatformEvent resources on the platform.

Resource URI

/api/2012-02-01/auth/resources/platformevents/

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual PlatformEvent resources, or link expansion can be used via the expand query parameter to inline the entities with the HTTP GET response. See querying collections for general information on handling resource collections.

Optional parameters
Parameter Description
expand Expression referencing Link elements to expand when generating the response. See link expansion.
skip Returns a subset of records from the collection, starting at index N+1 specified by this parameter. The skip and top parameters are generally used for collection paging.
top Returns a subset of records from the collection, starting at index 0 or index skip, and returns the first N records. The skip and top parameters are generally used for collection paging.
Example 1

Retrieve a collection of PlatformEvent links with the default parameters, and no link expansion.

GET /api/2012-02-01/auth/resources/PlatformEvents/

<PlatformEvents>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/platformevents" type="application/xml" title="PlatformEvent" href="https://demo.arlo.co/api/2012-02-01/auth/resources/platformevents/847/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/platformevents" type="application/xml" title="PlatformEvent" href="https://demo.arlo.co/api/2012-02-01/auth/resources/platformevents/848/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/platformevents" type="application/xml" title="PlatformEvent" href="https://demo.arlo.co/api/2012-02-01/auth/resources/platformevents/849/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/platformevents" type="application/xml" title="PlatformEvent" href="https://demo.arlo.co/api/2012-02-01/auth/resources/platformevents/850/"/>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/platformevents/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/platformevents/"/>
</PlatformEvents>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.