Arlo

REST Auth API: EventTemplateContentFieldDefinition

EventTemplateContentFieldDefinition resources are metadata resources that define common types of information used when describing EventTemplate resources.

For example, a platform may have definitions for commonly used fields of type Prerequistes, Outcomes, and Testimonials. These definitions are referenced by EventContentField resources to indicate the type of the field when defining custom content.

EventTemplateContentFieldDefinition resources are used to ensure a consistent, reusable set of fields are used when describing all EventTemplates within a platform.

EventTemplateContentFieldDefinition instance resource

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/{FieldDefinitionID}/

Resource properties

Property Description
FieldDefinitionID A integer value that uniquely identifies this resource within the platform.
Name A string representing the name of this field, up to 64 characters long.

HTTP GET

Returns a representation of an EventTemplateContentFieldDefinition, including the properties above.

Example

GET /demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/4/

<EventTemplateContentFieldDefinition>
  <FieldDefinitionID>4</FieldDefinitionID>
  <Name>Prerequisites</Name>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/4/"/>
</EventTemplateContentFieldDefinition>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

EventTemplateContentFieldDefinition collection resource

The EventTemplateContentFieldDefinition collection resource represents the set of EventTemplateContentFieldDefinition resources available on the platform.

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual EventTemplateContentFieldDefinition 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.
filter A filter expression to apply to the collection. See collection filters. The following properties (and link titles) may be used in filter expressions:
  • FieldDefinitionID
  • Name
orderby A sort expression to apply to the collection. See collection sorting. The following properties may be used in sort expressions:
  • FieldDefinitionID
  • Name
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 EventTemplateContentFieldDefinition links with the default parameters, and no link expansion.

GET /demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/

<EventTemplateContentFieldDefinitions>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentFieldDefinition" type="application/xml" title="EventTemplateContentFieldDefinition" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/4/">
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentFieldDefinition" type="application/xml" title="EventTemplateContentFieldDefinition" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/5/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentFieldDefinition" type="application/xml" title="EventTemplateContentFieldDefinition" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/6/"/>
  ...
  <Link rel="next" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/"/>
</EventTemplateContentFieldDefinitions>
Example 2

Retrieve a collection of EventTemplateContentFieldDefinition links with the default parameters, with EventTemplateContentFieldDefinition link expansion.

GET /demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/?expand=EventTemplateContentFieldDefinition

<EventTemplateContentFieldDefinitions>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentFieldDefinition" type="application/xml" title="EventTemplateContentFieldDefinition" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/4/">
    <EventTemplateContentFieldDefinition>
      <FieldDefinitionID>4</FieldDefinitionID>
      <Name>Prerequisites</Name>
      <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/4/"/>
    </EventTemplateContentFieldDefinition>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentFieldDefinition" type="application/xml" title="EventTemplateContentFieldDefinition" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/5/">
    <EventTemplateContentFieldDefinition>
      <FieldDefinitionID>5</FieldDefinitionID>
      <Name>Outcomes</Name>
      <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/5/"/>
    </EventTemplateContentFieldDefinition>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentFieldDefinition" type="application/xml" title="EventTemplateContentFieldDefinition" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/6/">
    <EventTemplateContentFieldDefinition>
      <FieldDefinitionID>6</FieldDefinitionID>
      <Name>Testimonials</Name>
      <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/6/"/>
    </EventTemplateContentFieldDefinition>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/?expand=EventTemplateContentFieldDefinition&skip=100"/>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinitions/?expand=EventTemplateContentFieldDefinition"/>
</EventTemplateContentFieldDefinitions>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.