Gets the task list scheme dimensions. Run in API Explorer
Ask AI
This request should be used to retrieve information around scheduled task list schemes used to generate task lists for specified engagement(s). Use TaskListSchemeKey to connect it to the TaskListDimension.
GET
/api/TaskListSchemeDimension
curl \
--request GET 'https://analyticsapi.adra.com/taskmanager/api/TaskListSchemeDimension' \
--user "username:password"
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"TaskListSchemeKey": 12,
"EngagementKey": "45c31339-96d0-4262-b051-c00f392685c1",
"ShouldIncludeRootTemplates": true,
"RecurrenceType": "EveryMonth",
"SelectedMonthsJson": null,
"PeriodTypesJson": null,
"ZeroDayType": "RelativeDay",
"ZeroDayRelativeOrdinal": "Last",
"ZeroDayRelativeDayType": "WorkDay",
"ZeroDaySpecificDay": null,
"ZeroDayMonthType": "SameMonth",
"GenerationLeadDays": 5,
"StartDate": "2026-01-01T00:00:00Z",
"EndDate": null,
"CreatedDate": "2026-01-01T00:00:00Z",
"BaseName": "Month end",
"SuffixFormatJson": "{}",
"ConfirmationMode": "AutoStart"
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]
Response examples (200)
[
{
"taskListSchemeKey": 42,
"engagementKey": "string",
"shouldIncludeRootTemplates": true,
"recurrenceType": null,
"selectedMonthsJson": null,
"periodTypesJson": null,
"zeroDayType": null,
"zeroDayRelativeOrdinal": null,
"zeroDayRelativeDayType": null,
"zeroDaySpecificDay": null,
"zeroDayMonthType": null,
"generationLeadDays": 42,
"startDate": null,
"endDate": null,
"createdDate": "2026-05-04T09:42:00Z",
"baseName": null,
"suffixFormatJson": null,
"confirmationMode": null
}
]