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
.jsvsuffix or?format=jsv - To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /jsv/reply/ShareFlux HTTP/1.1
Host: localhost
Content-Type: text/jsv
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/jsv" -X PATCH -d @filename.jsv https://api.wit-datacenter.com/WAC123456789012/Flux/21/Share/true
Remark
@filename.jsv contain your request parameters serialized in JSV as described in Post Data sample bottom
Response
Returned Entity
Shared FluxJSV Sample
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
wType: Flux,
ltuid: 0,
parentFluxID: 0,
level: Ventilated,
classID: 0,
creationDate: 0001-01-01,
updateDate: 0001-01-01,
exchangeDate: 0001-01-01,
status: Disabled,
wci: String,
pointsCount: 0,
size: 0,
description: String,
infrastructureID: 0,
period: String,
lastDataDate: 0001-01-01,
firstDataDate: 0001-01-01,
id: 0,
picture: 00000000000000000000000000000000,
name: String
}
SDK DotNet
SDK Android
SDK IOS