COMOS - REST API

Number of APIs: 33

The COMOS REST API is designed for integrating with the COMOS platform, offering a wide range of functionalities for plant engineering and lifecycle management. This API is ideal for developers and integrators looking to enhance plant design, maintenance, and operational efficiency by leveraging COMOS's extensive engineering data management capabilities.

  1. public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid}-actions - Checks in a document POST {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/documents/:docid/actions/checkin?overlayid=<string>&lcid=<string>

  2. public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid}-actions - Posts a specific revision. POST {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/documents/:docid/actions/create_revision?overlayid=<string>&lcid=<string>

  3. public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid} - Downloads a document based on document Id GET {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/documents/:docid?overlayid=<string>&lcid=<string>&export_type=<string>

  4. public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid} - Gets the revisons of a document GET {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/documents/:docid/revisions?overlayid=<string>&lcid=<string>

  5. public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}-specs - Get the specifications for an object GET {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/objects/:objid/specs?fields=<string>&nested_names=<string>&recursion_depth=<integer>&overlayid=<string>&lcid=<string>

  6. public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}-specs - Updates the specifications for an object PATCH {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/objects/:objid/specs?fields=<string>&overlayid=<string>&lcid=<string>

  7. public/api-projects/v1/dbs/{dbid}/projects-{projid} - Gets the object properties GET {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/object?pathfullname=<string>&fields=<string>&overlayid=<string>&lcid=<string>

  8. public/api-projects/v1/dbs/{dbid}/projects-{projid} - Gets the data for a given query GET {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/queries/:qid/result?start_objid=<string>&overlayid=<string>&lcid=<string>

  9. public/api-projects/v1/dbs/{dbid}/projects - Gets a collection of projects GET {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects?lcid=<string>

  10. public/api-sessions/v1/sessions/actions - Creates a new session for the current user POST {{baseUrl}}/public/api/sessions/v1/sessions/actions/login