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
.xml
suffix or?format=xml
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /xml/reply/UpdateFlux HTTP/1.1
Host: localhost
Content-Type: application/xml
Content-Length: length
<UpdateFlux xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WIT.DataCenter.DTOs.Request">
<WAC>String</WAC>
<Description>String</Description>
<FluxID>0</FluxID>
<Name>String</Name>
</UpdateFlux>
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/xml" -X PUT -d @filename.xml https://api.wit-datacenter.com/WAC123456789012/Flux/21
Remark
@filename.xml
contain your request parameters serialized in XML as described in Post Data sample bottom
Response
Returned Entity
Updated FluxXML Sample
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <Flux xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.wit-datacenter.com/"> <ID>0</ID> <Name>String</Name> <Picture>00000000-0000-0000-0000-000000000000</Picture> <Description>String</Description> <FirstDataDate>0001-01-01T00:00:00</FirstDataDate> <InfrastructureID>0</InfrastructureID> <LastDataDate>0001-01-01T00:00:00</LastDataDate> <Period>String</Period> <ClassID>0</ClassID> <CreationDate>0001-01-01T00:00:00</CreationDate> <ExchangeDate>0001-01-01T00:00:00</ExchangeDate> <LTUID>0</LTUID> <Level>Ventilated</Level> <ParentFluxID>0</ParentFluxID> <PointsCount>0</PointsCount> <Size>0</Size> <Status>Disabled</Status> <UpdateDate>0001-01-01T00:00:00</UpdateDate> <WCI>String</WCI> </Flux>