REST API Changes in AMS 1.4.0
Overview
The following REST API was changed in 1.4.0 to more accurately represent the request and response models for the following endpoint. For more information about viewing the API, see AMS API.
-
Authentication-
/login -
/login/signup -
/login/validateToken
-
-
Projects-
/projects/{projectId}/artifacts -
/projects/{projectId}/commits -
/projects/{projectId}/checkout
-
-
Artifacts-
/artifacts/{artifactId}/fetch/{version} -
/artifacts/{checkedOutArtifactId}/sync -
/artifacts/revisions/{artifactRevisionId} -
/artifacts/checkout -
/artifacts/{checkedOutArtifactId} -
/artifacts/{checkoutId}/add -
/artifacts/{projectName}/publish -
/artifacts/{checkedOutArtifactId}/update
-
-
Lifecycle-
/lifecycle/checkouts -
/lifecycle/checkouts/{checkoutId} -
/lifecycle/checkouts/{checkoutId}/committables -
/lifecycle/checkouts/{checkoutId}/commit -
/lifecycle/commits
-
-
Worklist-
/worklist -
/worklist/{commitId}
-
-
Users-
/Users -
/Users/{username}
-
REST API endpoints whose response contains artifact content now contains one new response property: artifactLength. This property is the content's character length of the artifact. The following endpoints are affected:
-
Projects-
/projects/{projectId}/artifacts -
/projects/{projectId}/commits -
/projects/{projectId}/checkout
-
-
Artifacts-
/artifacts/{artifactId}/fetch/{version} -
/artifacts/{checkedOutArtifactId}/sync -
/artifacts/revisions/{artifactRevisionId} -
/artifacts/checkout -
/artifacts/{checkedOutArtifactId} -
/artifacts/{checkoutId}/add -
/artifacts/{projectName}/publish -
/artifacts/{checkedOutArtifactId}/update
-
-
Lifecycle-
/lifecycle/checkouts -
/lifecycle/checkouts/{checkoutId} -
/lifecycle/checkouts/{checkoutId}/committables -
/lifecycle/checkouts/{checkoutId}/commit -
/lifecycle/commits
-
-
Worklist-
/worklist -
/worklist/{commitId}
-
![[Note]](images/note_826758100.png) | Note |
|---|---|
|
Strict JSON parser may result in an error when an unexpected property is found in the response payload. |
Many REST API endpoints whose response contains artifact content now support query parameters to include, exclude, or convert the content and metadata of an artifact. The convert parameter affects only the content and convert between Excel and XML formats, depending on the type of request (GET, PUT, or POST). The query parameter defaults (the value used when the parameter is not specified in the request), are defined to maintain the AMS 1.3.0 behavior. The following endpoints are affected:
-
Projects-
/projects/{projectId}/artifacts -
/projects/{projectId}/commits -
/projects/{projectId}/checkout
-
-
Artifacts-
/artifacts/{checkedOutArtifactId} -
/artifacts/{checkoutId}/add -
/artifacts/{checkedOutArtifactId}/update
-
-
Lifecycle-
/lifecycle/checkouts
-
REST API endpoints whose request supports adding or updating artifact content now contain one new request property: contentCompressed. This property indicates the contents in the request have been zipped and Base64 encoded. When the artifact's encoding is not ZIP_BASE64, AMS decodes and uncompresses the content before saving it with the artifact version. The decoded/uncompressed content is returned in all subsequent response payloads containing the artifact's content. The following endpoints are affected:
-
Projects-
/projects/{projectName}/import
-
-
Artifacts-
/artifacts/{checkoutId}/add -
/artifacts/{projectName}/publish -
/artifacts/{checkedOutArtifactId}/update
-
New Endpoints in AMS 1.4.0
The following endpoints are new in AMS 1.4.0:
-
Health Check-
/healthCheck
-