GET api/CyclePatterns?verbose={verbose}

Request Information

URI Parameters

Name	Description	Type	Additional information
verbose		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of CyclePattern

Name	Type	Additional information
CyclePatternId	integer	None.
StartDate	date	Required
Recurrence	integer	Required
NextRunDate	date	None.
SingleRunDate	date	None.
RecurrencePatternId	integer	Required
RecurrencePattern	RecurrencePattern	Required
WeekdayId	integer	None.
Weekday	Weekday	None.
DayOfMonth	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CyclePatternId": 1,
    "StartDate": "2026-03-05T02:37:40.122263+00:00",
    "Recurrence": 3,
    "NextRunDate": "2026-03-05T02:37:40.122263+00:00",
    "SingleRunDate": "2026-03-05T02:37:40.122263+00:00",
    "RecurrencePatternId": 5,
    "RecurrencePattern": {
      "RecurrencePatternId": 1,
      "Name": "sample string 2",
      "Alias": "sample string 3",
      "Key": "sample string 4"
    },
    "WeekdayId": 6,
    "Weekday": {
      "WeekdayId": 1,
      "Name": "sample string 2",
      "Key": "sample string 3",
      "Number": 4
    },
    "DayOfMonth": 7
  },
  {
    "CyclePatternId": 1,
    "StartDate": "2026-03-05T02:37:40.122263+00:00",
    "Recurrence": 3,
    "NextRunDate": "2026-03-05T02:37:40.122263+00:00",
    "SingleRunDate": "2026-03-05T02:37:40.122263+00:00",
    "RecurrencePatternId": 5,
    "RecurrencePattern": {
      "RecurrencePatternId": 1,
      "Name": "sample string 2",
      "Alias": "sample string 3",
      "Key": "sample string 4"
    },
    "WeekdayId": 6,
    "Weekday": {
      "WeekdayId": 1,
      "Name": "sample string 2",
      "Key": "sample string 3",
      "Number": 4
    },
    "DayOfMonth": 7
  }
]

application/xml, text/xml

Sample:

<ArrayOfCyclePattern xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Starship.WebAPI.Models">
  <CyclePattern>
    <CyclePatternId>1</CyclePatternId>
    <DayOfMonth>7</DayOfMonth>
    <NextRunDate>2026-03-05T02:37:40.122263+00:00</NextRunDate>
    <Recurrence>3</Recurrence>
    <RecurrencePattern>
      <Alias>sample string 3</Alias>
      <Key>sample string 4</Key>
      <Name>sample string 2</Name>
      <RecurrencePatternId>1</RecurrencePatternId>
    </RecurrencePattern>
    <RecurrencePatternId>5</RecurrencePatternId>
    <SingleRunDate>2026-03-05T02:37:40.122263+00:00</SingleRunDate>
    <StartDate>2026-03-05T02:37:40.122263+00:00</StartDate>
    <Weekday>
      <Key>sample string 3</Key>
      <Name>sample string 2</Name>
      <Number>4</Number>
      <WeekdayId>1</WeekdayId>
    </Weekday>
    <WeekdayId>6</WeekdayId>
  </CyclePattern>
  <CyclePattern>
    <CyclePatternId>1</CyclePatternId>
    <DayOfMonth>7</DayOfMonth>
    <NextRunDate>2026-03-05T02:37:40.122263+00:00</NextRunDate>
    <Recurrence>3</Recurrence>
    <RecurrencePattern>
      <Alias>sample string 3</Alias>
      <Key>sample string 4</Key>
      <Name>sample string 2</Name>
      <RecurrencePatternId>1</RecurrencePatternId>
    </RecurrencePattern>
    <RecurrencePatternId>5</RecurrencePatternId>
    <SingleRunDate>2026-03-05T02:37:40.122263+00:00</SingleRunDate>
    <StartDate>2026-03-05T02:37:40.122263+00:00</StartDate>
    <Weekday>
      <Key>sample string 3</Key>
      <Name>sample string 2</Name>
      <Number>4</Number>
      <WeekdayId>1</WeekdayId>
    </Weekday>
    <WeekdayId>6</WeekdayId>
  </CyclePattern>
</ArrayOfCyclePattern>