ShareFlux Documentation
ShareFlux
Draft documentation version
Documentation is partial and not validated !
Description
Remark
You need to take two decisions when you share a Flux:
- share for outside request on WAPI
- share as OpenData file on WebApp Developer view OpenData section above
Version | Alpha |
---|---|
Require User context | |
Authorization | |
Errors |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
FluxID | 21 | ID of Flux | |
Public | true |
When |
|
WAC | WAC123456789012 | Code of BusinessAccount | |
IsOpenData | false |
When |
|
IsPublic | true |
When |
|
OpenData | false |
When |
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
POST /json/reply/ShareFlux HTTP/1.1
Host: localhost
Content-Type: application/json
Content-Length: length
{"wType":"ShareFlux","fluxID":0,"public":false,"openData":false,"wac":"String"}
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/json" -X PATCH -d @filename.json https://api.wit-datacenter.com/WAC123456789012/Flux/21/Share/true
Remark
@filename.json
contain your request parameters serialized in JSON as described in Post Data sample bottom
Response
Returned Entity
Shared FluxJSON Sample
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"wType":"Flux","ltuid":0,"parentFluxID":0,"level":"Ventilated","classID":0,"creationDate":"0001-01-01T00:00:00.0000000Z","updateDate":"0001-01-01T00:00:00.0000000Z","exchangeDate":"0001-01-01T00:00:00.0000000Z","status":"Disabled","wci":"String","pointsCount":0,"size":0,"description":"String","infrastructureID":0,"period":"String","lastDataDate":"0001-01-01T00:00:00.0000000Z","firstDataDate":"0001-01-01T00:00:00.0000000Z","id":0,"picture":"00000000000000000000000000000000","name":"String"}