Logo
Siemens Xcelerator Developer Portal API Documentation

Checks in a document

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

This API can do a first checkin or a consecutive checkin.

  • Check if the document can be checked in , eg Check if the document is checked out .
  • Checks for Mandatory Attributes
  • Check in the document
The API expects multi-part form data that consists of

Sample format 1. values
[{ NestedName:string, //Required Value:string,
SIValue:double, LinkObject:{ UID:string, ProjectUID:string, OverlayUID:string }, XValues:[{ Index:int, XValue:string, SIXValue:double }] }] 2. comment comment:string 3. file : The file to be checked in

 

Body PARAM

Key Datatype Required Description 
overlayid
string Overlay id
lcid
string Language id



HEADERS

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




RESPONSES

status



Curl
curl -X POST '//public/api/projects/v1/dbs/:dbid/projects/:projid/documents/:docid/actions/checkin?overlayid=<string>&lcid=<string>?overlayid=<string>&lcid=<string>' -H 'Comos-API-Session: <string>' -H 'Accept: application/json'

ENDPOINTS