2021-09

The changes in this release align the REST API pilot implementation to the revised submission of the Systems Modeling API and Services specification.

New

• Implement putProjectById, deleteProjectById, deleteBranchByProjectAndId, and deleteQueryByProjectAndId API endpoints
• Integrate all Data realizations, i.e. SysML types - Element, Relationship, Item, etc. - and API types - ExternalData, ExternalRelationship, ProjectUsage (see below) - such that they can be versioned and configuration managed analogously in a Commit.
• Introduce Tag API concept and accompanying endpoints, i.e. getTagsByProject, postTagByProject, getTagByProjectAndId, and deleteTagByProjectAndId
• Introduce ProjectUsage API concept that is used to declare usage dependencies on other Projects. By virtue of being a Data realization it is fully integrated with API versioning and querying capabilities.

Fixed

• Element concept is abstracted to Data
• ElementIdentity is renamed to DataIdentity
• ElementVersion is renamed to DataVersion

2021-08

No functionality changes relative to 2021-06.

2021-06

New

• Updated to 2021-06 metamodel baseline.

• The following endpoints can now produce JSON-LD application/ld+json responses, in addition to JSON application/json:

  • getProjects
  • postProject
  • getProjectById
  • getBranchesByProject
  • postBranchByProject
  • getBranchesByProjectAndId
  • getCommitsByProject
  • postCommitByProject

  This is represented in the OpenAPI specification, i.e. the HTTP REST API PSM, which also allows the pilot implementation to be tested through the Swagger UI app by selecting application/ld+json in the Response content type dropdown menu in addition to any of the other methods of interacting with HTTP REST APIs.

  Note that this change additionally aligns the JSON and JSON-LD responses, most notably by renaming Record::id to Record::@id which affects all lifecycle concepts as they specialize from Record. This change will require regeneration of provided clients and is backwards-incompatible.

2021-06 RC2

2021-06-rc2

2021-06-rc2

2021-06 RC1

2021-06-rc1

2021-06-rc1

2021-05

New

• Updated to 2021-05 metamodel baseline.

Fixed

• Added Project#defaultBranch to the OpenAPI specification and client libraries.

2021-05 RC1

2021-05-rc1

2021-05-rc1

2021-04

New

• Introduced branching capability to enable multiple commit histories. This adds a number of new endpoints to create, read, and update branches, e.g. projects/$project_id/branches. It additionally integrates with the commit creation allowing for a commit to be added to a branch. Refer to specification document for details.
• Updated to 2021-04 metamodel baseline.

Fixed

• Commit#containingProject renamed to Commit#owningProject
• Query#containingProject renamed to Query#owningProject
• Removed GET projects/$project_id/head in favor of branching. To get the id of the head commit of the default branch of a project:
  • GET projects/$project_id and obtain the defaultBranch.id from the response
  • GET projects/$project_id/branches/$branch_id and obtain the head.id from the response

2021-04 RC1

2021-04-rc1

2021-04-rc1

2021-03

New

• The default Accept for requests, i.e. the content type of the response when not specified in the request, has been changed from application/ld+json to application/json. Clients desiring responses in JSON-LD can receive it by specifying the header appropriately, e.g. Accept: application/ld+json.
• Updated to 2021-03 metamodel baseline.