REST API Changes in AMS 1.6.0
Overview
Response models containing artifact data has one new property (contentType) that may affect backwards compatibility for REST API clients that perform strict parsing of the response payload. See the REST API documentation for more information.
REST APIs documentation have changed to more accurately represent the request and response models for the following end-point.
-
Artifacts
-
/artifacts/validate
-
-
Users
-
/users/{username}
-
-
Worklist
-
/worklist/{worklistItemId}/approve
-
REST API end-points whose request or response contains artifact content now has one new property: contentType. This property indicates the content-type of the data. The following end-points are affected:
-
Projects
-
/projects/{projectId}/artifacts
-
/projects/{projectId}/commits
-
/projects/{projectName}/import
-
/projects/{projectId}/checkout
-
-
Artifacts
-
/artifacts/{artifactId}/fetch/{version}
-
/artifacts/{checkedOutArtifactId}/sync
-
/artifacts/revisions/{artifactRevisionId}
-
/artifacts/{checkedOutArtifactId}
-
/artifacts/{checkoutId}/add
-
/artifacts/{projectName}/publish
-
/artifacts/{checkedOutArtifactId}/update
-
-
Lifecycle
-
/lifecycle/checkouts
-
/lifecycle/checkouts/{checkoutId}/committables
-
/lifecycle/checkouts/{checkoutId}/commit
-
/lifecycle/commits/{commitId}
-
-
Worklist
-
/worklist
-
/worklist/{commitId}
-
![[Note]](images/note_826758100.png) | Note |
|---|---|
|
Strict JSON parsing may result in an error when an unexpected property is found in the response payload. |
Summary of 1.6.0 REST API changes:
Projects
-
/projects/{projectId}/artifacts
Updated the ArtifactRecord model (includes the new contentType property)
-
/projects/{projectId}/commits
Updated the CommitCandidateRecord model (includes the new contentType property)
-
/projects/{projectName}/import
Updated the ArtifactItem model (includes the new contentType property)
-
/projects/{projectId}/checkout
Updated the CheckedOutArtifactRecord model (includes the new contentType property)
Artifacts
-
/artifacts/{artifactId}/fetch/{version}
Updated the ArtifactRecord model (includes the new contentType property)
-
/artifacts/{checkedOutArtifactId}/sync
Updated the CheckedOutArtifactRecord model (includes the new contentType property)
-
/artifacts/revisions/{artifactRevisionId}
Updated the ArtifactRecord model (includes the new contentType property)
-
/artifacts/{checkedOutArtifactId}
Updated the CheckedOutArtifactRecord model (includes the new contentType property)
-
/artifacts/{checkoutId}/add
Updated the CheckedOutArtifactRecord model (includes the new contentType property)
-
/artifacts/{projectName}/publish
Updated the ArtifactItem model (includes the new contentType property)
Updated the CommitCandidateRecord model (includes the new contentType property)
-
/artifacts/{checkedOutArtifactId}/update
Updated the ArtifactItem model (includes the new contentType property)
Updated the CheckedOutArtifactRecord model (includes the new contentType property)
Lifecycle
-
/lifecycle/checkouts
Updated the CheckedOutArtifactRecord model (includes the new contentType property)
-
/lifecycle/checkouts/{checkoutId}/committables
Updated the CheckedOutArtifactRecord model (includes the new contentType property)
-
/lifecycle/checkouts/{checkoutId}/commit
Updated the CommitCandidateRecord model (includes the new contentType property)
-
/lifecycle/commits/{commitId}
Updated the CommitCandidateRecord model (includes the new contentType property)
Worklist
-
/worklist
Updated the CommitRecord model (includes the new contentType property)
-
/worklist/{commitId}
Updated the CommitRecord model (includes the new contentType property)