Prev   Next

REST API Changes in AMS 1.5.0

Table of Contents
Overview

Overview

The REST API documentation changed to more accurately represent the request and response models for the following endpoint. Changes are summarized below.

  • Projects

    • /projects/{projectId}/artifacts

  • Artifacts

    • /artifacts/{checkedOutArtifactId}

    • /artifacts/{checkoutId}/add

    • /artifacts/{projectName}/publish

    • /artifacts/{checkedOutArtifactId}/update

  • Lifecycle

    • /lifecycle/checkouts/{checkoutId}

    • /lifecycle/checkouts/{checkoutId}/committables

    • /lifecycle/checkouts/{checkoutId}/commit

    • /lifecycle/commits

  • Worklist

    • /worklist

    • /worklist/{commitId}

REST API endpoints whose response contains artifact content now contain one new response property: contentCompressed. This property indicates the content data in the response is in compressed/Base64 format. The following endpoints are affected:

  • Projects

    • /projects/{projectId}/artifacts

    • /projects/{projectId}/commits

    • /projects/{projectId}/checkout

  • Artifacts

    • /artifacts/{checkedOutArtifactId}

    • /artifacts/{checkoutId}/add

    • /artifacts/{projectName}/publish

    • /artifacts/{checkedOutArtifactId}/update

  • Lifecycle

    • /lifecycle/checkouts/{checkoutId}

    • /lifecycle/checkouts/{checkoutId}/committables

    • /lifecycle/checkouts/{checkoutId}/commit

    • /lifecycle/commits

  • Worklist

    • /worklist

    • /worklist/{commitId}

REST API endpoints whose response contains artifact content now contain one new query parameter: acceptsCompressedContent. This query parameter indicates the requestor accepts text-based content data in compressed/Base64 format.

  • 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

  • Lifecycle

    • /lifecycle/checkouts

[Note]Note

Strict JSON parser may result in an error when an unexpected property is found in the response payload.

All REST API endpoints whose response contains artifact content now support query parameters to include, exclude, convert, and accepts-compressed-content for the content and metadata of an artifact. The convert parameter affects only the content and conversion between Excel and XML formats, depending on the type of request (GET, PUT, or POST). The accepts-compressed-content affects only the content having NONE encoding or content conversion from Excel to XML format. The query parameter defaults (the value used when the parameter is not specified in the request), are defined to maintain the 1.4.0 behavior. 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

  • Lifecycle

    • /lifecycle/checkouts

Summary of 1.5.0 REST API changes in detail:

  • Projects

    • /projects/{projectId}/artifacts

      • Added the accepts-compressed-content query parameter

      • Updated the ArtifactRecord model (includes the new contentCompressed property)

    • /projects/{projectId}/commits

      • Added the accepts-compressed-content query parameter

      • Updated the CommitCandidateRecord model (includes the new contentCompressed property)

    • /projects/{projectId}/checkout

      • Added the accepts-compressed-content query parameter

      • Updated the CheckedOutArtifactRecord model (includes the new contentCompressed property)

  • Artifacts

    • /artifacts/{artifactId}/fetch/{version}

      • Added the accepts-compressed-content query parameter

      • Updated the ArtifactRecord model (includes the new contentCompressed property)J

    • /artifacts/{checkedOutArtifactId}/sync

      • Added the Excel-to-XML, include-content, include-metadata, and accepts-compressed-content query parameters

      • Updated the CheckedOutArtifactRecord model (includes the new contentCompressed property)

    • /artifacts/revisions/{artifactRevisionId}

      • Added the accepts-compressed-content query parameter

      • Updated the ArtifactRecord model (includes the new contentCompressed property)

    • /artifacts/checkout

      • Added the Excel-to-XML, include-content, include-metadata, and accepts-compressed-content query parameters

      • Updated the CheckedOutArtifactRecord model (includes the new contentCompressed property)J

    • /artifacts/{checkedOutArtifactId}

      • Added the accepts-compressed-content query parameter

      • Updated the CheckedOutArtifactRecord model (includes the new contentCompressed property)

    • /artifacts/{checkoutId}/add

      • Added the accepts-compressed-content query parameter

      • Updated the CheckedOutArtifactRecord model (includes the new contentCompressed property)

  • Lifecycle

    • /lifecycle/checkouts

      • Added the Excel-to-XML and accepts-compressed-content query parameters

      • Updated the CheckedOutArtifactRecord model (includes the new contentCompressed property)J

  • Deployment

    • /deployment

      • Updated the DeploymentDescriptorRecord model (includes the new type and serviceAddresses property)

    • /deployment/{deploymentDescriptorId}

      • Updated the DeploymentDescriptorRecord model (includes the new type and serviceAddresses property)

    • /deployment/create

      • Updated the DeploymentDescriptorItem model (includes the new type property)

      • Updated the DeploymentDescriptorRecord model (includes the new type and serviceAddresses property)

    • /deployment/{deploymentDescriptorId}/update

      • Updated the DeploymentDescriptorItem model (includes the new type property)

      • Updated the DeploymentDescriptorRecord model (includes the new type and serviceAddresses property)

    • /deployment/serviceAddresses

      • New endpoint that retrieves all the deployment service addresses

    • /deployment/serviceAddresses/{deploymentServiceAddressId}

      • New endpoint that retrieves a specific deployment service address

    • /deployment/serviceAddresses/create

      • New endpoint that creates a deployment service address

    • /deployment/serviceAddresses/{deploymentServiceAddressId}/update

      • New endpoint that updates a specific deployment service address

    • /deployment/serviceAddresses/{deploymentServiceAddressId}/delete

      • New endpoint that deletes a specific deployment service address

    • /deployment/target/get/all

      • Updated the DeploymentTargetRecord model (includes the new type and serviceAddresses property)

    • /deployment/target/{deploymentTargetId}/get

      • Updated the DeploymentTargetRecord model (includes the new type and serviceAddresses property)

    • /deployment/target/create

      • Updated the DeploymentTargetItem model (includes the new type property)

      • Updated the DeploymentTargetRecord model (includes the new type and serviceAddresses property)

    • /deployment/target/{deploymentTargetId}/update

      • Updated the DeploymentTargetItem model (includes the new type property)

      • Updated the DeploymentTargetRecord model (includes the new type and serviceAddresses property)

Prev Up Next
 Home 
Generated by <oXygen/> XML WebHelp