Update Project

Details

API Details
NameUpdate Project
Description

Updates the configured details for a project specified by the Project ID.

Unspecified attributes are changed to a NULL value.

MethodPUT
URIv1/projects/projectId
CloudCenter ReleaseIntroduced in CloudCenter 4.2.
NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: update.projects.projectId

Example

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

Request Body to Increase Quota

  • Provide all attributes even if you do not need to update those attributes. If you do not provide all attributes, those attributes are updated to a NULL value.
  • To add more values, provide cumulative updates. For example: To add appId "1" to the existing appId "2", provide both IDs in the PUT request for the apps attribute.
 {
    "id": "2",
    "resource": "https://<HOST>:<PORT>/v1/projects/2",
    "name": "Enterprise-CRM",
    "projectOwnerId": 2,
    "description": "CRM 2.0 Release",
    "isDraft": true,
    "targetEndDate": "1476379896000",
    "planType": "BUDGET",
    "quota": {
        "value": 50000,
        "measurableUnit": "$",
        "type": "LIMITED"
    },
    "projectCost": {
        "originalBalance": 0,
        "remainingBalance": 0,
        "measurableUnit": "$"
    },
    "apps": [
        {
            "id": "566",
            "resource": "https://<HOST>:<PORT>/v1/apps/566",
            "appName": "JenkinSingleNIC"
        },
        {
            "id": "45",
            "resource": "https://<HOST>:<PORT>/v1/apps/45",
            "appName": "App2"
        }
    ]
}

Response

 {
    "id": "2",
    "resource": "https://<HOST>:<PORT>/v1/projects/2",
    "name": "Enterprise-CRM",
    "projectOwnerId": 2,
    "description": "CRM 2.0 Release",
    "isDraft": true,
    "targetEndDate": "1476379896000",
    "planType": "BUDGET",
    "quota": {
        "value": 50000,
        "measurableUnit": "$",
        "type": "LIMITED"
    },
    "projectCost": {
        "originalBalance": 0,
        "remainingBalance": 0,
        "measurableUnit": "$"
    },
    "apps": [
        {
            "id": "566",
            "resource": "https://<HOST>:<PORT>/v1/apps/566",
            "appName": "JenkinSingleNIC"
        },
        {
            "id": "45",
            "resource": "https://<HOST>:<PORT>/v1/apps/45",
            "appName": "App2"
        }
    ]
}

Request Attributes

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).

Response Attributes

All configured attributes for the project