provisioning

Gets an existing Portfolio

Returns a single existing Portfolio, including Task Orders and Operators

get/portfolios/{portfolioId}

Response

Portfolio successfully retrieved

idstring required

Represents the unqiue ID of the Portfolio created by the vendor. In order to enable the ATAT UI to construct links back to the provisioned environment, this should be the same ID generated internally for the vendor's Portfolio-equivalent construct.

namestring required

Example response

{
  "id": "csp-portfolio-id-123",
  "name": "Sample Portfolio name",
  "task_orders": [
    {
      "id": "csp-task-order-id-123",
      "task_order_number": "HQ003421F0024",
      "clins": [
        {
          "pop_start_date": "2021-07-22",
          "pop_end_date": "2026-07-21"
        }
      ],
      "pop_start_date": "2021-07-15",
      "pop_end_date": "2026-07-14"
    }
  ]
}

Changes

Changed in 16 of the 50 revisions of this API.71452

Apr 25, 2024e5ab2d7e0f049See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  removed from the / response property allOf list for the response status
  response-property-all-of-removed
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
Oct 19, 2023a61a8cf845121See the full diff
- ○
  the ////////// response's property pattern was changed from ^[A-Za-z0-9](?:[A-Za-z0-9\-_]{0,61}[A-Za-z0-9])$ to ^[a-zA-Z][a-zA-Z0-9]{5,25}$ for the status
  response-property-pattern-changed
Oct 10, 20230fe40bce74d01See the full diff
- ○
  the ////////// response's property pattern was changed from ^[A-Za-z0-9](?:[A-Za-z0-9\-_]{0,61}[A-Za-z0-9])?$ to ^[A-Za-z0-9](?:[A-Za-z0-9\-_]{0,61}[A-Za-z0-9])$ for the status
  response-property-pattern-changed
Oct 10, 202382e60c01355b11See the full diff
- ●
  removed the optional property ////////// from the response with the status
  response-optional-property-removed
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
Oct 5, 2023955d3f2e1d8413See the full diff
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
Sep 27, 20236c8abf4c408c1See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Feb 10, 20230290bea4247c21See the full diff
- ●
  deleted the header request parameter X-Atat-Api-Version
  request-parameter-removed
- ●
  deleted the path request parameter portfolioId
  request-parameter-removed
- ○
  added the new optional header request parameter X-Atat-Api-Version to all path's operations
  new-optional-request-default-parameter-to-existing-path
Feb 10, 2023125039a132bc88See the full diff
- ●
  added the new CLOUD enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new NON_CLOUD enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new SECRET enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new SECRET enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new TOP_SECRET enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new TOP_SECRET enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new UNCLASSIFIED enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new UNCLASSIFIED enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ○
  removed the cloud enum value from the //////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the non_cloud enum value from the //////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the secret enum value from the //////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the secret enum value from the ////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the top_secret enum value from the //////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the top_secret enum value from the ////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the unclassified enum value from the //////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the unclassified enum value from the ////////// response property for the response status
  response-property-enum-value-removed
Jan 31, 20239fbf5defc05a413See the full diff
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  deleted the header request parameter X-Target-Impact-Level
  request-parameter-removed
- ○
  added to the response body allOf list for the response status
  response-body-all-of-added
- ○
  removed from the response body allOf list for the response status
  response-body-all-of-removed
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 29, 202270da8a528a1a1See the full diff
- ○
  the response required property became read-only for the status
  response-required-property-became-read-only

Full history (16 revisions)