UpdateFlux Documentation
UpdateFlux
Draft documentation version
Documentation is partial and not validated !
Description
Remark
For Flux having a FluxLevelEnum of type Raw:
- You can override Name defined in LocalTechnicalUnit (*): just set Name parameter. In this case Name is set in WDC Plateform only (not in LocalTechnicalUnit)
- you can reset Name to default one defined in LocalTechnicalUnit (*): just pass a Null or Empty value on Name parameter
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors | NotExist |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
FluxID | 21 | ID of Flux | |
WAC | WAC123456789012 | Code of BusinessAccount | |
Description | My Flux description | Full description | |
Name | My Flux name | Name (view remarks above) |
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/UpdateFlux HTTP/1.1
Host: localhost
Content-Type: application/json
Content-Length: length
{"wType":"UpdateFlux","fluxID":0,"name":"String","description":"String","wac":"String"}
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/json" -X PUT -d @filename.json https://api.wit-datacenter.com/WAC123456789012/Flux/21
Remark
@filename.json
contain your request parameters serialized in JSON as described in Post Data sample bottom
Response
Returned Entity
Updated 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"}