Get season plan

GET

https://api.sureshake.com/v2/execution/cycles/{cycleId}/plan

Path parameters

cycleId
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- cycleId
  string
  required
  format: uuid
- phases
  array of
  object
  required
  id
  string
  required
  format: uuid
  entityId
  string
  required
  format: uuid
  cycleId
  string
  required
  format: uuid
  name
  string
  required
  maxLength: 120 · minLength: 1
  purpose
  string
  or null
  required
  maxLength: 2000 · minLength: 1
  sequence
  integer
  required
  maximum: 1000 · minimum: 1
  startDate
  string
  required
  format: date-time
  endDate
  string
  required
  format: date-time
  createdBy
  string
  required
  minLength: 1
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
- milestones
  array of
  object
  required
  id
  string
  required
  format: uuid
  entityId
  string
  required
  format: uuid
  cycleId
  string
  required
  format: uuid
  phaseId
  string
  or null
  required
  format: uuid
  title
  string
  required
  maxLength: 160 · minLength: 1
  description
  string
  or null
  required
  maxLength: 4000 · minLength: 1
  eventAt
  string
  required
  format: date-time
  priority
  primary
  or
  supporting
  or
  exploratory
  required
  createdBy
  string
  required
  minLength: 1
  createdAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

502

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}