DeleteInfrastructure Documentation
DeleteInfrastructure
Draft documentation version
Documentation is partial and not validated !
Description
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors | NotExist |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
InfrastructureID | 6 | ID of InfrastructureBase | |
WAC | WAC123456789012 | Code of BusinessAccount | |
AutoLocalize | true | Flux, ReflectionBase and LTUBase localized on deleted infrastructure are automatically localized on parent InfrastructureBase (if any) | |
DeleteChilds | true |
When True : childs InfrastructureBase are automatically removed.
When False : error is throwed if any Childs
|
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/DeleteInfrastructure HTTP/1.1
Host: localhost
Content-Type: text/jsv
Content-Length: length
{
wType: DeleteInfrastructure,
infrastructureID: 0,
deleteChilds: False,
autoLocalize: False,
wac: String
}
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/jsv" -X DELETE -d @filename.jsv https://api.wit-datacenter.com/WAC123456789012/Infrastructure/6
Remark
@filename.jsv
contain your request parameters serialized in JSV as described in Post Data sample bottom
Response
Returned Entity
Deleted InfrastructureBaseJSV Sample
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { wType: InfrastructureBase, parentInfrastructureID: 0, description: String, creationDate: 0001-01-01, updateDate: 0001-01-01, id: 0, picture: 00000000000000000000000000000000, name: String }