View Projects

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView Projects
Description

Displays information for a specific project or for all configured projects

Allowed Role(s)WM_USER
MethodGET
URI
  • v1/projects
  • v1/projects?size=0 (view all created projects, beyond 20, by using size=0)
  • v1/projects/projectId 
  • cloudcenter-ccm-backend/api/v1/projects
  • cloudcenter-ccm-backend/api/v1/projects?size=0 (view all created projects, beyond 20, by using size=0)
  • cloudcenter-ccm-backend/api/v1/projects/projectId 
Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/projects" 
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/projects" 
Release

Introduced in CloudCenter 4.2

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.projects
  • action: get.projects
    actionparam: size=0
  • action: get.projects.projectId

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Samples Response – Get All Projects

{
    "resource": "https://<HOST>:<PORT>/v1/projects/",
    "size": 2,
    "pageNumber": 0,
    "totalElements": 2,
    "totalPages": 1,
    "projects": [
        {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/projects/1",
            "name": "venkat-sep17-1",
            "projectOwnerId": 2,
            "isDraft": false,
            "targetEndDate": 32496875638000,
            "planType": "BUDGET",
            "deleted": false,
            "quota": {
                "value": 50000,
                "measurableUnit": "$",
                "type": "LIMITED"
            },
            "projectCost": {
                "originalBalance": 100,
                "remainingBalance": 100,
                "measurableUnit": "$"
            }
        },
        {
            "id": "2",
            "resource": "https://<HOST>:<PORT>/v1/projects/2",
            "name": "Enterprise-CRM",
            "projectOwnerId": 2,
            "description": "CRM 2.0 Release",
            "isDraft": true,
            "targetEndDate": 32496875638000,
            "planType": "BUDGET",
            "quota": {
                "value": 50000,
                "measurableUnit": "dollars",
                "type": "LIMITED"
            },
            "projectCost": {
                "originalBalance": 200,
                "remainingBalance": 200,
                "measurableUnit": "$"
            }
        }
    ]
}

Response – Get a Specified Project

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/projects/136" 

{
    "id": "136",
    "resource": "https://<HOST>:<PORT>/v1/projects/136",
    "perms": [
        "read",
        "notify",
        "delete",
        "write",
        "administration"
    ],
    "name": "Enterprise-CRM",
    "projectOwnerId": 2,
    "description": "CRM 2.0 Release",
    "isDraft": true,
    "targetEndDate": 1476379896000,
    "notifyUsers": false,
    "planType": "BUDGET",
    "deleted": false,
    "quota": {
        "value": 50000,
        "measurableUnit": "$",
        "type": "LIMITED"
    },
    "projectCost": {
        "originalBalance": 800,
        "remainingBalance": 800,
        "measurableUnit": "$"
    },
    "apps": [
        {
            "id": "29",
            "resource": "https://<HOST>:<PORT>/v1/apps/29",
            "perms": [
                "read",
                "execute",
                "delete",
                "write",
                "administration"
            ],
            "appName": "SleekApp1"
        }
    ],
    "phases": [
        {
            "id": "263",
            "resource": "https://<HOST>:<PORT>/v1/projects/136/phases/263",
            "name": "CRM-Phase1"
        },
        {
            "id": "264",
            "resource": "https://<HOST>:<PORT>/v1/projects/136/phases/264",
            "name": "CRM-Phase2"
        }
    ]
}

Request Attributes

Unable to render {include} The included page could not be found.

Response Attributes

Unable to render {include} The included page could not be found.

See pageResource or Pagination for additional context

Unable to render {include} The included page could not be found.
© 2017-2019 Cisco Systems, Inc. All rights reserved