CliQr is now part of Cisco Learn More About Cisco

View Projects

Details

API Details
NameView Projects
DescriptionDisplays information for a specific project or for all configured projects.
MethodGET
URI
  • v1/projects
  • v1/projects?size=0 (view all created projects, beyond 20, by using size=0)
  • v1/projects/projectId 
CloudCenter ReleaseIntroduced in CloudCenter 4.2.
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.

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

Examples

Response – Get All Projects

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

Response – Get a Specified Project

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

Request Attributes

projectId
  • DescriptionUnique, system-generated identifier for the project
  • Type: Long (path variable in the URL)

Response Attributes

resource
  • Description: Unique URL to access this resource
  • Type: String

See pageResource or Pagination for additional context

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource
  • Type: String
perms (click for additional details)

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

projectOwnerId
  • Description: Unique, system-generated identifier for the project owner.

  • Type: String
description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String
 isDraft 
  • Description: The project draft status
  • Type: Boolean
    • true = This project is in the draft state
    • false = This project is now published
 targetEndDate 
  • Description: The targeted end date for this project in  Unix time format.
  • Type: String
notifyUsers
  • Description: Identifies if notification is enabled for this project:
    • true = Notification is enabled
    • false = Default. Notification is disabled
  • Type: Boolean
 planType 
  • Description: The type of plan for this project. See CloudCenter Subscription Types for additional context.
  • Type: Enumeration

    EnumerationDescription
    BUDGETPrepaid Budget Bundle
    VMVM Subscription
    UNDEFINEDPlan not defined
deleted
  • Description: Identifies if this resource is deleted in the CloudCenter platform.
  • Type: Boolean
    • true = The resource is deleted.
    • false = The resource is not deleted.

quota
  • Description: The value and type for the project quota.
  • Type: An enclosure for project quota information

    value
    • Description: Indicates the set value for this property
    • Type: Float

    Indicates the total quota (balance) for the project
    measurableUnit
    • Type: String
    type
    • Description: The type of quota used for a project. Examples:

      Quota DefinitionExamples
      No definition
      "quota' : { "type" : "UNLIMITED" }
      Unlimited
      "quota' : { "type" : "UNLIMITED" }
      Limited
      • "quota" : {
            "value": 5000,
            "type": "LIMITED"}
      • "quota" : {
            "value": 5000,
            "type": "LIMITED"}
    • Type: Enumeration

      EnumerationDescription
      LIMITEDProvide a well defined value for quota
      UNLIMITEDDefault. No quota limit

     

projectCost
  • Description: The cost of this project
  • Type: Sequence of objects

    originalBalance
    • Description: The opening account balance for this user, project, or phase
    • Type: Float
    remainingBalance
    • Description: Available balance in this user's plan, project, or phase
    • Type: Float
    measurableUnit
    • Type: String
apps
  • Description: List of applications associated with this project
  • String: Array of application identifiers

    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String
    resource
    • Description: Unique URL to access this resource
    • Type: String
    perms (click for additional details)

    appName
    • Description: The name of the application in use.
    • Type: String

phases (click for additional details)

The phases attribute is not displayed for v1/projects. This attribute displays the idresource, and name when you specify a project (v1/projects/projectId).