RunCadenceRead

Fields

20 fields

created_at · required: string (date-time)
created_by_name: string or null
cron: string or null
effective_from · required: string (date-time)
expected_by: string or null
grace_minutes: integer
id · required: string (uuid)
mode: string
next_deadline: string (date-time) or null
paused: boolean
paused_at: string (date-time) or null
paused_by_name: string or null
paused_reason: string or null
paused_until: string (date-time) or null
project_id · required: string (uuid)
suite_name: string or null
summary: string
timezone: string
updated_at · required: string (date-time)
weekdays: array of string or null

Raw schema (JSON)

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "created_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By Name"
    },
    "cron": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cron"
    },
    "effective_from": {
      "format": "date-time",
      "title": "Effective From",
      "type": "string"
    },
    "expected_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expected By"
    },
    "grace_minutes": {
      "default": 60,
      "title": "Grace Minutes",
      "type": "integer"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "mode": {
      "default": "weekly",
      "title": "Mode",
      "type": "string"
    },
    "next_deadline": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Deadline"
    },
    "paused": {
      "default": false,
      "title": "Paused",
      "type": "boolean"
    },
    "paused_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Paused At"
    },
    "paused_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Paused By Name"
    },
    "paused_reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Paused Reason"
    },
    "paused_until": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Paused Until"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "suite_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Suite Name"
    },
    "summary": {
      "default": "",
      "title": "Summary",
      "type": "string"
    },
    "timezone": {
      "default": "UTC",
      "title": "Timezone",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "title": "Updated At",
      "type": "string"
    },
    "weekdays": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Weekdays"
    }
  },
  "required": [
    "id",
    "project_id",
    "effective_from",
    "created_at",
    "updated_at"
  ],
  "title": "RunCadenceRead",
  "type": "object"
}

Used by endpoints

6 endpoints send or return this schema, on its own or inside another schema.

POST /api/v1/projects/{project_id}/run-cadences — Create Run Cadence
PATCH /api/v1/projects/{project_id}/run-cadences/{cadence_id} — Update Run Cadence
POST /api/v1/projects/{project_id}/run-cadences/{cadence_id}/pause — Pause Run Cadence
POST /api/v1/projects/{project_id}/run-cadences/{cadence_id}/resume — Resume Run Cadence
GET /api/v1/projects/{project_id}/run-cadences — List Run Cadences
GET /api/v1/projects/{project_id}/run-cadences/status — Run Cadence Status

Used by schemas

More details

Specification: OpenAPI JSON