sfgboxapi

<back to all web services

SystemEntitiesEdit

Requires Authentication
The following routes are available for this service:
PUT/system_entities/{Id}
SystemEntitiesEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathlongYes
EntitybodystringYes
LongDescriptionbodystringYes
SystemEntitiesEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EntityformstringNo
LongDescriptionformstringNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /system_entities/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"entity":"String","longDescription":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":0,"entity":"String","longDescription":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}