POST api/collection/v{version}/{collectionId}/EventData

Return all events data, including keywords, corresponding to the given collection. This method can be used in analysis services REST API Connectors.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
collectionId

ID of the specific collection (must correspond to the channel key)

integer

Required

version

string

None.

Body Parameters

optional data parameters

DataParam
NameDescriptionTypeAdditional information
IncludeMatchKeywords

Includes match keywords when set to true (default value is false)

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "IncludeMatchKeywords": false
}

application/xml, text/xml

Sample:
<DataParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dartfish.WebAPI">
  <IncludeMatchKeywords>false</IncludeMatchKeywords>
</DataParam>

Response Information

Resource Description

A string representing events data, including keywords, for all events in the collection

string

Response Formats

application/json, text/json

Sample:
{
  "Events": 
  [
    {
      "Name": "Event 1",
      "Position": 1000,
      "Duration": 100,
      "Category 1": "Value",
      "Category 2": "Value"
    },
    {
      "Name": "Event 2",
      "Position": 5000,
      "Duration": 100,
      "Category 1": "Value",
      "Category 2": "Value"
    }
  ]
}

application/xml, text/xml

Sample:
<Events version="1.0">
  <Event>
    <Name>Event 1</Name>
    <Position>1000</Position>
    <Duration>100</Duration>
    <Category 1>Value</Category 1>
    <Category 2>Value</Category 2>
  </Event>
  <Event>
    <Name>Event 2</Name>
    <Position>5000</Position>
    <Duration>100</Duration>
    <Category 1>Value</Category 1>
    <Category 2>Value</Category 2>
  </Event>
 </Events>