Logo
Siemens Xcelerator Developer Portal API Documentation

Checks out a document.

POST {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/documents/:docid/actions/checkout?overlayid=<string>&lcid=<string>

Note that this operation does not do a download - it must be done by calling the route ... {projid}/documents/{docid}.

 

Body PARAM

Key Datatype Required Description 
overlayid
string Overlay Id
lcid
string Project language



HEADERS

Key Datatype Required Description 
Comos-API-Session
string (Required) Comos SessionId that needs to be passed with every request except Login
Content-Type
string
Accept
string




RESPONSES

status



Curl
curl -X POST '//public/api/projects/v1/dbs/:dbid/projects/:projid/documents/:docid/actions/checkout?overlayid=<string>&lcid=<string>?overlayid=<string>&lcid=<string>' -H 'Comos-API-Session: <string>' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept: application/json' --data-urlencode '%7B%22name%22%3D%3E%22Comment%22%2C+%22value%22%3D%3E%22%3Cstring%3E%22%2C+%22datatype%22%3D%3E%22string%22%7D'

ENDPOINTS