GetWEventsApp Documentation
GetWEventsApp
Draft documentation version
Documentation is partial and not validated !
Description
Version | Alpha |
---|---|
Require User context | |
Authorization | |
Errors | TooManyRequested |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
After | 2014-09-15T13:59:20.0000000Z | Occured after | |
AppID | 5 | ID of App | |
Before | 2014-09-20T13:59:20.0000000Z | DateTime.Now or DateTime.Max to get really "last datas" from API. NULL as "no limit date, get current elements" | |
BusinessAccountID | 6 | ID of BusinessAccount concerned by request | |
Categories | Flux,Reflection | Categories WEventCategoryEnum | |
Criticity | High | Criticity CriticityEnum | |
Error | true | Request with or without Error | |
GroupKey | FC002 | Relevant to News: provide GroupKey to get detail of News. | |
Mode | Historical | Mode WEventModeEnum | |
Operation | SearchFlux | Name of request operation. Can leave empty | |
Orders | Result is ordered by array of WEventsRequestOrder | ||
Skip | 20 | Number of elements to skip | |
Span | 123 | Request response time in 1/1000 seconds | |
StatusCode | 500 | Array of HTTP Status code returned to AppRequest: 200, 300, 400 | |
Take | 10 | Number of elements to take | |
UserID | 45 | ID of User requestor | |
Verbs | Requested verb: GET, POST, PUT, PATCH, DELETE |
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.xml
suffix or?format=xml
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
After=2014-09-15T13:59:20.0000000Z&AppID=5&Before=2014-09-20T13:59:20.0000000Z&BusinessAccountID=6&Categories=Flux,Reflection&Criticity=High&Error=true&GroupKey=FC002&Mode=Historical&Operation=SearchFlux&Orders=&Skip=20&Span=123&StatusCode=500&Take=10&UserID=45&Verbs=&
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/xml" https://api.wit-datacenter.com/App/WEvent?Mode=Historical&Before=2014-09-20T13%3a59%3a20.0000000Z&After=2014-09-15T13%3a59%3a20.0000000Z&Criticity=High&GroupKey=FC002&Categories=Flux%2cReflection&Take=10&Skip=20&Orders=&UserID=45&AppID=5&BusinessAccountID=6&Operation=SearchFlux&StatusCode=500&Span=123&Error=true&Verbs=