// removed jquery ui css and js

View Phases

Details

API Details
NameView Phases
DescriptionDisplays information for a specific phase or for all configured phases within a project .
MethodGET
URI
  • v1/projects/projectId/phases
  • v1/projects/projectId/phases/phaseId
  • v1/projects/projectId/phases?status=active
    Filter jobs returned for a phase using the status filter. For example,
    • status = all
    • status = active
    • Individual status separated by |
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.projectId.phases
  • action: get.projects.projectId.phases.phaseId
  • action: get.projects.projectId.phases
    actionparam: status=active

Example

Response – Get All Phases for a Project

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/projects/1/phases" 
{
    "phases": [
        {
            "id": "4",
            "resource": "https://<HOST>:<PORT>/v1/projects/1/phases/4",
            "name": "CRM-Dev-Phase2",
            "order": 1,
            "phaseCost": {
                "originalBalance": 200,
                "remainingBalance": 200,
                "measurableUnit": "$"
            }
        },
        {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/projects/1/phases/1",
            "name": "vet-phase1",
            "order": 2,
            "phaseCost": {
                "originalBalance": 100,
                "remainingBalance": 100,
                "measurableUnit": "$"
            }
        }
    ]
}

Response – Get a Specified Phase for a Project

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/projects/134/phases/258" 
{   "id": "258",
    "resource": "https://<HOST>:<PORT>/v1/projects/134/phases/258",
    "name": "Phase1",
    "deploymentEnvironment": {
        "id": "2",
        "resource": "https://<HOST>:<PORT>/v1/environments/2",
        "perms": [
            "move_in",
            "read",
            "approve",
            "execute",
            "move_out",
            "delete",
            "write",
            "administration",
            "authorize",
            "manage"
        ],
        "name": "vet-Deploy-Env1"
    },
    "order": 1,
    "phasePlan": {
        "id": "1",
        "planName": "vet-Budget-Plan1"
    },
    "phaseBundles": [
        {
            "id": "1",
            "name": "vet-Bundle1",
            "count": 1
        }
    ],
    "phaseCost": {
        "originalBalance": 500,
        "remainingBalance": 465.6,
        "measurableUnit": "$"
    },
    "deployments": [
        {
            "id": "17",
            "resource": "https://<HOST>:<PORT>/v1/jobs/17",
            "perms": [
                "move_in",
                "read",
                "approve",
                "execute",
                "move_out",
                "delete",
                "write",
                "administration",
                "authorize",
                "manage"
            ],
            "deploymentName": "Deploy-Oct12-5",
            "deploymentOwnerId": "2",
            "deploymentStatus": "Deployed",
            "appName": "Jenkins_no_storage",
            "appLogoPath": "/assets/vendors/1/img/DefaultApp.png",
            "supportedActions": [
                "SUSPEND",
                "TERMINATE",
                "UPGRADE",
                "ON_TERMINATE_PROTECTION",
                "PROMOTE"
            ]
        }
    ]
}

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 for a specified phase.

phases (click for additional details)

Response Attributes for All Phases

phases
  • Description: Identifies configured details for each phase within a project
  • Type: Array of phases

    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.