Standard SysML v2 REST/HTTP API

This article provides information about standard SysML v2 REST/HTTP API service availability in Teamwork Cloud. It outlines the supported API service groups, upcoming services, and current limitations.

Supported API Service Groups

Teamwork Cloud supports all of the standard API service groups and their service mappings to HTTP/REST API PSM:

• Project Services
• Project Data Versioning Services (including Tag Services, Branch Services, Commit Services)
• Element Navigation Services
• Query Service
• External Relationship Service
• Project Usage Service

Query Service Settings

By default, Query Services work out of the box in Teamwork Cloud installation; however, it does not support queries containing derived properties or those expected to return derived property values.

To enable Query Services with derived properties, you need to index projects to be queried upfront using our Elasticsearch-based indexing engine.

Limitations

The following limitations apply to the supported services:

• Project Data Versioning Services -
  • The createCommit service does not currently allow changing a version of a used project.
  • The createCommit service requires specifying implied model relationships within the request payload when creating SysML v2 model elements to ensure the end model is semantically correct.