UpdateData Documentation
UpdateData
Draft documentation version
Documentation is partial and not validated !
Description
Remark
For Data owned by 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 | Beta |
|---|---|
| Require User context | |
| Authorization | |
| Errors |
Request
Route
Parameters
| Parameter | Required | Sample | Description |
|---|---|---|---|
| DataID | 34 | ID of Data | |
| WAC | WAC123456789012 | Code of BusinessAccount | |
| Description | My Data description | Full description | |
| Label | Label (DO NOT USE as OBSOLETE) | ||
| Name | My Data name | Name (view remarks above) | |
| Wums | WUM |
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/UpdateData HTTP/1.1
Host: localhost
Content-Type: text/jsv
Content-Length: length
{
wType: UpdateData,
dataID: 0,
name: String,
label: String,
description: String,
wums:
{
wType: WUM,
wumUnitItemID: 0,
wumFunctionID: 0,
wumMaterialID: 0,
wumTypeID: 0
},
wac: String
}
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/jsv" -X PUT -d @filename.jsv https://api.wit-datacenter.com/WAC123456789012/Data/34
Remark
@filename.jsv contain your request parameters serialized in JSV as described in Post Data sample bottom
Response
Returned Entity
Updated DataJSV Sample
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
wType: Data,
firstDataDate: 0001-01-01,
lastDataDate: 0001-01-01,
description: String,
label: String,
fluxID: 0,
wum:
{
wType: WUM,
wumUnitItemID: 0,
wumFunctionID: 0,
wumMaterialID: 0,
wumTypeID: 0
},
id: 0,
picture: 00000000000000000000000000000000,
name: String
}
SDK DotNet
SDK Android
SDK IOS