recurringDeployment resource

Resource that manages recurring deployments.

JSON request templates

Some commands in this resource generate JSON output in multiple formats, as specified by the format parameter. These output formats include different subsets of properties for the requested elements, as appropriate for different use cases. The included properties for each format are described in the JSON templates below.
TEMPLATE_ROOT
{
  "autoManualTaskNotification": "true if a notification 
  must be sent when an automatically started Scheduled 
  Deployment created from that rule has a manual task in its 
  first Segment (true or false).",
  "autoPickVersions": "true if the versions will be 
  selected automatically (true or false).",
  "autoStart": "true if the Scheduled Deployment created 
  from that rule will be started automatically (true or 
  false).",
  "dateCreated": "Timestamp that represents the date when 
  the Recurring Rule has been created.",
  "deploymentPlan": {
    "dateCreated": "Timestamp that represents the date 
  when the Deployment Plan has been created.",
    "ghostedDate": "Timestamp that represents the date 
  when the Deployment Plan has been deleted. If greater than 
  0 the Deployment Plan has been removed.",
    "id": "Deployment Plan ID",
    "name": "Deployment Plan Name",
    "version": "Version number"
  },
  "description": "Recurring Rule Description",
  "environment": {
    "dateCreated": "Timestamp that represents the date 
  when the Environment has been created.",
    "description": "Environment Description",
    "ghostedDate": "Timestamp that represents the date 
  when the Environment has been deleted. If greater than 0 
  the Environment has been removed.",
    "id": "Environment ID",
    "name": "Environment Name",
    "version": "Version number"
  },
  "ghostedDate": "Timestamp that represents the date when 
  the Recurring Rule has been deleted. If greater than 0 the 
  Recurring Rule has been removed.",
  "id": "Recurring Rule ID",
  "phase": {
    "approvals": [{
      "dateCreated": "Timestamp that represents the date 
  when the Approval has been created.",
      "executorRole": {
        "actions": "Array of IDs representing allowed 
  actions for this role -- GET /roles/actions for the list 
  of possible actions",
        "description": "Role description",
        "id": "Role ID",
        "name": "Role name"
      },
      "id": "Approval ID",
      "name": "Approval Name",
      "status": "Approval Status (PLANNED, OPEN, 
  EXECUTING, CLOSED)",
      "version": "Version number"
    }],
    "dateCreated": "Timestamp that represents the date 
  when the Phase has been created.",
    "deploymentPlan": {
      "dateCreated": "Timestamp that represents the date 
  when the Deployment Plan has been created.",
      "ghostedDate": "Timestamp that represents the date 
  when the Deployment Plan has been deleted. If greater than 
  0 the Deployment Plan has been removed.",
      "id": "Deployment Plan ID",
      "name": "Deployment Plan Name",
      "version": "Version number"
    },
    "endDate": "Timestamp that represents the date when 
  the Phase ends.",
    "environments": [{
      "dateCreated": "Timestamp that represents the date 
  when the Environment has been created.",
      "description": "Environment Description",
      "ghostedDate": "Timestamp that represents the date 
  when the Environment has been deleted. If greater than 0 
  the Environment has been removed.",
      "id": "Environment ID",
      "name": "Environment Name",
      "version": "Version number"
    }],
    "ghostedDate": "Timestamp that represents the date 
  when the Phase has been deleted. If greater than 0 the 
  Phase has been removed.",
    "id": "Phase ID",
    "name": "Phase Name",
    "phaseModel": {
      "dateCreated": "Timestamp that represents the date 
  when the PhaseModel has been created.",
      "exemptions": [{
        "application": "(See: application TEMPLATE_ROOT)",
        "createdByUserId": "User ID who have created the 
  Exemption",
        "dateCreated": "Timestamp that represents the date 
  when the Version has been created.",
        "expiryDate": "Date when the exemption will expire 
  (Timestamp)",
        "id": "Exemption ID",
        "name": "Version Name",
        "phaseModel": {
          "dateCreated": "Timestamp that represents the 
  date when the PhaseModel has been created.",
          "ghostedDate": "Timestamp that represents the 
  date when the PhaseModel has been deleted. If greater than 
  0 the PhaseModel has been removed.",
          "id": "PhaseModel ID",
          "indexOrder": "PhaseModel order",
          "name": "PhaseModel Name",
          "version": "Version number"
        },
        "release": "(See: release TEMPLATE_ROOT",
        "version": "Version number"
      }],
      "gates": [{
        "dateCreated": "Timestamp that represents the date 
  when the Gate has been created.",
        "description": "Gate Description",
        "id": "Gate ID",
        "name": "Gate Name",
        "status": {
          "color": "Status color (Hexadecimal)",
          "dateCreated": "Timestamp that represents the 
  date when the Status has been created.",
          "description": "Status Description",
          "id": "Status ID",
          "name": "Status Name",
          "order": "Status order",
          "version": "Version number"
        },
        "version": "Version number"
      }],
      "ghostedDate": "Timestamp that represents the date 
  when the PhaseModel has been deleted. If greater than 0 
  the PhaseModel has been removed.",
      "id": "PhaseModel ID",
      "indexOrder": "PhaseModel order",
      "name": "PhaseModel Name",
      "version": "Version number"
    },
    "reservations": "[Array of Environment Reservations 
  (See: environmentReservation TEMPLATE_LIST)]",
    "startDate": "Timestamp that represents the date when 
  the Phase starts.",
    "version": "Version number"
  },
  "regexPattern": "Regular expression that will be used to 
  select the versions",
  "release": "(See: release TEMPLATE_ROOT)",
  "type": "Recurring Rule Type (CRON, HOURLY, DAILY, 
  WEEKLY)",
  "version": "Version number"
}
list, detail
{
  "autoManualTaskNotification": "true if a notification 
  must be sent when an automatically started Scheduled 
  Deployment created from that rule has a manual task in its 
  first Segment (true or false).",
  "autoPickVersions": "true if the versions will be 
  selected automatically (true or false).",
  "autoStart": "true if the Scheduled Deployment created 
  from that rule will be started automatically (true or 
  false).",
  "dateCreated": "Timestamp that represents the date when 
  the Recurring Rule has been created.",
  "deploymentPlan": {
    "dateCreated": "Timestamp that represents the date 
  when the Deployment Plan has been created.",
    "ghostedDate": "Timestamp that represents the date 
  when the Deployment Plan has been deleted. If greater than 
  0 the Deployment Plan has been removed.",
    "id": "Deployment Plan ID",
    "name": "Deployment Plan Name",
    "version": "Version number"
  },
  "description": "Recurring Rule Description",
  "environment": {
    "dateCreated": "Timestamp that represents the date 
  when the Environment has been created.",
    "description": "Environment Description",
    "ghostedDate": "Timestamp that represents the date 
  when the Environment has been deleted. If greater than 0 
  the Environment has been removed.",
    "id": "Environment ID",
    "name": "Environment Name",
    "version": "Version number"
  },
  "ghostedDate": "Timestamp that represents the date when 
  the Recurring Rule has been deleted. If greater than 0 the 
  Recurring Rule has been removed.",
  "id": "Recurring Rule ID",
  "phase": {
    "approvals": [{
      "dateCreated": "Timestamp that represents the date 
  when the Approval has been created.",
      "executorRole": {
        "actions": "Array of IDs representing allowed 
  actions for this role -- GET /roles/actions for the list 
  of possible actions",
        "description": "Role description",
        "id": "Role ID",
        "name": "Role name"
      },
      "id": "Approval ID",
      "name": "Approval Name",
      "status": "Approval Status (PLANNED, OPEN, 
  EXECUTING, CLOSED)",
      "version": "Version number"
    }],
    "dateCreated": "Timestamp that represents the date 
  when the Phase has been created.",
    "deploymentPlan": {
      "dateCreated": "Timestamp that represents the date 
  when the Deployment Plan has been created.",
      "ghostedDate": "Timestamp that represents the date 
  when the Deployment Plan has been deleted. If greater than 
  0 the Deployment Plan has been removed.",
      "id": "Deployment Plan ID",
      "name": "Deployment Plan Name",
      "version": "Version number"
    },
    "endDate": "Timestamp that represents the date when 
  the Phase ends.",
    "environments": [{
      "dateCreated": "Timestamp that represents the date 
  when the Environment has been created.",
      "description": "Environment Description",
      "ghostedDate": "Timestamp that represents the date 
  when the Environment has been deleted. If greater than 0 
  the Environment has been removed.",
      "id": "Environment ID",
      "name": "Environment Name",
      "version": "Version number"
    }],
    "ghostedDate": "Timestamp that represents the date 
  when the Phase has been deleted. If greater than 0 the 
  Phase has been removed.",
    "id": "Phase ID",
    "name": "Phase Name",
    "phaseModel": {
      "dateCreated": "Timestamp that represents the date 
  when the PhaseModel has been created.",
      "exemptions": [{
        "application": "(See: application TEMPLATE_ROOT)",
        "createdByUserId": "User ID who have created the 
  Exemption",
        "dateCreated": "Timestamp that represents the date 
  when the Version has been created.",
        "expiryDate": "Date when the exemption will expire 
  (Timestamp)",
        "id": "Exemption ID",
        "name": "Version Name",
        "phaseModel": {
          "dateCreated": "Timestamp that represents the 
  date when the PhaseModel has been created.",
          "ghostedDate": "Timestamp that represents the 
  date when the PhaseModel has been deleted. If greater than 
  0 the PhaseModel has been removed.",
          "id": "PhaseModel ID",
          "indexOrder": "PhaseModel order",
          "name": "PhaseModel Name",
          "version": "Version number"
        },
        "release": "(See: release TEMPLATE_ROOT",
        "version": "Version number"
      }],
      "gates": [{
        "dateCreated": "Timestamp that represents the date 
  when the Gate has been created.",
        "description": "Gate Description",
        "id": "Gate ID",
        "name": "Gate Name",
        "status": {
          "color": "Status color (Hexadecimal)",
          "dateCreated": "Timestamp that represents the 
  date when the Status has been created.",
          "description": "Status Description",
          "id": "Status ID",
          "name": "Status Name",
          "order": "Status order",
          "version": "Version number"
        },
        "version": "Version number"
      }],
      "ghostedDate": "Timestamp that represents the date 
  when the PhaseModel has been deleted. If greater than 0 
  the PhaseModel has been removed.",
      "id": "PhaseModel ID",
      "indexOrder": "PhaseModel order",
      "name": "PhaseModel Name",
      "version": "Version number"
    },
    "reservations": "[Array of Environment Reservations 
  (See: environmentReservation TEMPLATE_LIST)]",
    "startDate": "Timestamp that represents the date when 
  the Phase starts.",
    "version": "Version number"
  },
  "regexPattern": "Regular expression that will be used to 
  select the versions",
  "release": "(See: release TEMPLATE_ROOT)",
  "type": "Recurring Rule Type (CRON, HOURLY, DAILY, 
  WEEKLY)",
  "version": "Version number"
}

Feedback