GetWEventsBusinessAccount
Draft documentation version
Documentation is partial and not validated !
Return
WEvent filtered by parameters
Route
Parameters
Parameter |
Required |
Sample |
Description |
WAC |
|
WAC123456789012
|
Code of BusinessAccount
|
Skip |
|
0
|
Number of elements to skip
|
Take |
|
10
|
Number of elements to take
|
After |
|
2014-09-15T13:59:20.0000000Z
|
Occured after
|
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"
|
Categories |
|
Flux,Reflection
|
Categories WEventCategoryEnum
|
ClassIDs |
|
1,2,3
|
Array of ReflectionClass or FluxClass IDs. Depend on WEntityType set
|
Criticity |
|
High
|
Criticity CriticityEnum
|
GroupKey |
|
FC002
|
Relevant to News: provide GroupKey to get detail of News.
|
InfrastructureIDs |
|
1,2,3
|
Array of InfrastructureBase IDs. Leave empty if No Filter. Add value 0 in array if you want to include WEvent not localized
|
Mode |
|
Historical
|
Mode WEventModeEnum
|
Orders |
|
|
Result is ordered by array of WEventsRequestOrder
|
Text |
|
text ...
|
Search message with Text. Relevant only to WEvent from Automat ressources (with a WEventCategoryEnum with value WEventCategoryEnum)
|
WEntityIDs |
|
1,2,3
|
Array of LTU, Flux or ReflectionBase IDs. Type must be specified with WEntityType parameter.
|
WEntityType |
|
OneShot
|
Filter WEvent related to WEntityTypeEnum. Only values Flux, Reflection and LTU is implemented.
|
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.json
suffix or ?format=json
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
Skip=0&Take=10&After=2014-09-15T13:59:20.0000000Z&Before=2014-09-20T13:59:20.0000000Z&Categories=Flux,Reflection&ClassIDs=1,2,3&Criticity=High&GroupKey=FC002&InfrastructureIDs=1,2,3&Mode=Historical&Orders=&Text=text ...&WEntityIDs=1,2,3&WEntityType=OneShot&
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/json" https://api.wit-datacenter.com/WAC123456789012/WEvent?Mode=Historical&InfrastructureIDs=1%2c2%2c3&WEntityIDs=1%2c2%2c3&WEntityType=OneShot&ClassIDs=1%2c2%2c3&Text=text+...&Before=2014-09-20T13%3a59%3a20.0000000Z&After=2014-09-15T13%3a59%3a20.0000000Z&Criticity=High&GroupKey=FC002&Categories=Flux%2cReflection&Take=10&Skip=0&Orders=
Returned Entity
WEventsContainer
JSON Sample
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"wType":"WEventsContainer","count":0,"checkSum":0,"weVents":[{"wType":"WEvent","nameShort":"String","dateOccur":"0001-01-01T00:00:00.0000000Z","dateOpposite":"0001-01-01T00:00:00.0000000Z","isViewed":false,"isInProgress":false,"operation":"0","criticity":"VeryHigh","type":"OneShot","wEventType":"Organization_NotValidated","category":"None","relatedEntities":[{"wType":"WEventItem","key":"Role","entityRole":"0"}],"groupKey":"String","groupCount":0,"id":0,"picture":"00000000000000000000000000000000","name":"String"}]}