Update Phase

Details

API Details
NameUpdate Phase
Description

Updates the configured details for a phase within a project as specified by the Phase ID.

Unspecified attributes are changed to a NULL value.

MethodPUT
URI

v1/projects/projectId/phases/phaseId

CloudCenter ReleaseIntroduced in CloudCenter 4.2.
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The phase name is a mandatory request attribute and you must provide a value.
ESB Headeraction: update.projects.projectId.phases.phaseId

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/projects/2/phases/1"
  • 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.
  • You can only assign a plan to a phase if the plan fees include cloud usage costs.

Request Body

 {
    "name": "CRM-Dev-Phase1",
    "deploymentEnvironmentId": 1,
    "planId": 6,
    "order": 1,
    "bundleIds" : [1,2]
}

Response

 {
    "id": "2",
    "name": "CRM-Dev-Phase1",
    "deploymentEnvironment": {
        "id": "1",
        "resource": "https: //<HOST>:<PORT>/v1/environments/1",
        "perms": [
            "authorize",
            "execute",
            "approve",
            "write",
            "delete",
            "read",
            "move_out",
            "manage",
            "move_in",
            "administration"
        ],
        "name": "Vet-Deploy-Env"
    },
    "order": 1,
    "phasePlan": {
        "id": "6",
        "planName": "Vet_Budget-Plan2"
    },
    "phaseBundles": [
        {
            "id": "3",
            "name": "Vet-Budget-Bundle1",
            "count": 2
        }
    ],
    "phaseCost": {
        "originalBalance": 200,
        "remainingBalance": 200,
        "measurableUnit": "$"
    },
    "deployments": []
}

Request Attributes

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

Required

phaseId
  • DescriptionUnique, system-generated identifier for the phase.
  • Type: String

Required

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

  • Type: String

Required

depEnvId
  • DescriptionUnique, system-generated identifier for the deployment environment. See Deployment Environments for additional details. This attribute is the same as the environmentId attribute.
  • Type: String

planId 
  • DescriptionUnique, system-generated identifier for the plan belonging to this tenant. The default is Null.
  • Type: String

order
  • Description: The number at which a resource is to be attached. When updating a phase, use this order to re-order the resource to a different position in the array of resources.
  • Type: Long
bundleIds
  • Description: Bundle credits to be attached to phase

    Only applicable for the BUDGET project plan – all phases of the Budget Prepaid Bundle Plan allow the addition of bundles.

  • Type: Array of bundle identifiers

Response Attributes

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

  • Type: String

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

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

  • Type: String

deploymentEnvironment (click for additional details)
order
  • Description: The number at which a resource is to be attached. When updating a phase, use this order to re-order the resource to a different position in the array of resources.
  • Type: Long
phasePlan
  • Description: Identifies the plan associated with this phase
  • Type: Sequence of objects

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

    • Type: String

    planName
    • DescriptionA descriptive name for this plan
    • Type: String
phaseBundles
  • Description: List of bundles attached to the phase. This is only valid for phase(s) with Budget pre-paid Bundle plan. For other plans, an empty JSON object is displayed.
  • Type: Array of bundles

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

    • Type: String

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

    • Type: String

    count
    • Description: The number of times that this phase bundle was added/attached.

      On successful image creation, this value will always remain 0.

    • TypeInteger

phaseCost
  • Description: The cost of this phase
  • 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

deployments
  • Description: List of deployments attached to the phase 


  • Type: Array of deployments

    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)
    deploymentName
    • Description: The project name
    • Type: String
     deploymentOwnerId
    • Description: Unique, system-generated identifier for the user who owns this project.
    • Type: String
    deploymentStatus
    appName
    • Description: The name of the application in use.
    • Type: String
    appVersion
    • Description: The application build version with which a new job is started. If the appVersion is not specified, the latest application build version is used.

    • Type: String
    appLogoPath
    • Description: The relative path of the uploaded image logo file for this application.   
    • Type: String
    supportedActions
    • Description: Identifies the supported actions for each deployment. Users can perform several functions based on their deployment permissions.

      The User Privilege (see perms and Permission Control) and Job Status (see Deployment and VM States) determine the supported actions for each user. For example:

      • User Privilege: If you only have View privileges, you can only view (GET) the job details, you cannot manage the jobs/deployments.
      • Job Status: You can only see the RESUME option if the job/deployment is in a SUSPENDED state.

    • Type: Enumeration

      Enumeration Description
      APPROVEApprove a deployment request.
      DEMOTEDemote a deployment.
      DENYDeny a deployment request.
      HIDEJust hide this job (for jobs with Errors)
      MARK_FAVORITEMark a job or deployment as a favorite (see Deployments > Favorite Deployments for additional context)
      MIGRATE

      Migrate deployment – provide the following block for promoting the application:

      PUT https://<CCM HOST NAME>:<PORT>/v2/jobs/{jobId}

      Points to be noted if approval is required:

      • The MIGRATE request triggers an automatic backup process.
      • Migrate is not supported for Project-based deployments.
      • If Rejected when approval is required, no change – deployment continues to run.
      • If Approved and:
        • Successful (deployed) – Deployment is terminated (if requested via the keepExistingDeployment=true setting).
        • Migrate Fails – Deployment is suspended.
      ON_TERMINATE_PROTECTION Prevent an inadvertent stoppage from the CloudCenter platform and thus avoid interrupting production deployments by turning on the preventTermination feature. See Termination for additional context.
      OFF_TERMINATE_PROTECTION Turn off the preventTermination feature. See Termination for additional context.
      PROMOTE

      Promote a deployment – provide the following block for promoting the application:

      PUT https://<CCM HOST NAME>:<PORT>/v2/jobs/{jobId}

      Points to be noted if approval is required:

      • The PROMOTE request does not trigger a backup process.
      • If Rejected, no change – Deployment continues to run.
      • If Approved and:
        • Successful (deployed) – Deployment is terminated (if requested via the keepExistingDeployment=true setting).
        • Fails – deployment is suspended
      REMOVE_FAVORITEUn-marks a job or deployment as a favorite (see Deployments > Favorite Deployments for additional context)
      RERUNRerun the deployment – valid only for batch jobs.
      RESUMEResume a deployment – valid only for deployments.
      STARTStart a deployment.
      STOPStop a deployment – valid for both deployments and legacy jobs. It just stops the deployment (or) job.
      SUSPEND Suspend a deployment – valid only for deployments and not legacy jobs
      TERMINATETerminate a deployment.
      TERMINATE_AND_HIDETerminates and hides the deployment.

      UPDATE_TAGS

      Update tags as part of Job. If Governance mode is ON, Security profiles, policies (Aging, Scaling policies) can be updated (Update involves update, creation, deletion). See Governance for additional context.
      UPGRADEUpgrade a deployment to the next version – provide the next version of the Application to be upgraded.