SubstituteLTU Documentation
SubstituteLTU
Draft documentation version
Documentation is partial and not validated !
Description
Remark
TODO: detail workflow here
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
LTUID | 6 | ID of LTUBase to substitute | |
WAC | WAC123456789012 | Code of BusinessAccount | |
WIDNew | 01234-01234 | WID of new LTU |
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.jsv
suffix or?format=jsv
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /jsv/reply/SubstituteLTU HTTP/1.1
Host: localhost
Content-Type: text/jsv
Content-Length: length
{
wType: SubstituteLTU,
ltuid: 0,
widNew: String,
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/LTU/6/Substitute/01234-01234
Remark
@filename.jsv
contain your request parameters serialized in JSV as described in Post Data sample bottom
Response
Returned Entity
Updated LTUBase with new WIDJSV Sample
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { wType: LTU, wid: String, widSubsitution: String, status: Disabled, lateDuration: 0, code: String, type: WIT, hard: String, softName: String, softVersion: String, softDate: 0001-01-01, url: String, infrastructureID: 0, exchangeDate: 0001-01-01, creationDate: 0001-01-01, communicationMedia: LAN, communicationType: 0, gmtOffset: 0, extendedProperties: [ { wType: ExtendedPropertyValue, value: String, extendedPropertyID: 0 } ], id: 0, picture: 00000000000000000000000000000000, name: String }