DOdod-ccpo
provisioning

Gets an existing Portfolio

Changed on

Returns a single existing Portfolio, including Task Orders and Operators

get/portfolios/{portfolioId}

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (https://cognito-idp-fips.us-gov-west-1.amazonaws.com/us-gov-west-1_2e6R3aYgi/.well-known/openid-configuration, scopes: atat/read-portfolio)

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

  • e5ab2d7e0f04Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed from the / response property allOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • a61a8cf84512Revision changes
    • info

      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