GET api/scheduledtask/{type}
Get a scheduled task based on the task type
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| type |
Scheduled Task type |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Matching ScheduledTask based on task type
ScheduledTask| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | globally unique identifier |
None. |
|
| AccountID |
Tenant or Administrator ID |
globally unique identifier |
None. |
| Data |
Parameters to pass to the task |
Dictionary of string [key] and Object [value] |
None. |
| DataBytes | Collection of byte |
None. |
|
| DataFormat | integer |
None. |
|
| DataCompression | integer |
None. |
|
| ScheduleType |
Schedule type |
ScheduleType |
None. |
| CronExpression |
When ScheduleType is Cron, the background service uses this to schedule the task |
string |
None. |
| CronExpressionDescription |
User-readable Cron expression description |
string |
None. |
| Starts |
When the tasks's ScheduleType is OnceOff, this is the time the task should run. If set to null, the task should run immediately |
date |
None. |
| Task |
Task type identifier |
string |
None. |
| Description |
Display, or user-friendly description |
string |
None. |
| LastRun |
The last time (UTC) the task ran to completion |
date |
None. |
| Created |
Date and time (UTC) the ScheduledTask was created |
date |
None. |
| TimeZone |
Account's time zone |
TimeZoneInfo |
None. |
| Registered |
This task has been scheduled by the BackgroundService |
boolean |
None. |
| Default |
This is a default scheduled task |
boolean |
None. |
| Account | string |
Relation. This field may not always be loaded or used for updates. |
Response Formats
application/json, text/json
{
"id": "c4964b2f-0fdf-44ae-9336-910aed6c4a07",
"accountID": "922bca66-0317-4ab7-be9e-efaf04e8dc2d",
"data": {
"$id": "2",
"sample string 1": {
"$id": "3"
},
"sample string 3": {
"$id": "4"
}
},
"dataBytes": "QEA=",
"dataFormat": 1,
"dataCompression": 1,
"scheduleType": 0,
"cronExpression": "sample string 3",
"cronExpressionDescription": "sample string 4",
"starts": "2026-04-03T06:20:27.5900592",
"task": "sample string 5",
"description": "sample string 6",
"lastRun": "2026-04-03T06:20:27.5900592",
"created": "2026-04-03T06:20:27.5900592",
"registered": true,
"default": true,
"account": "sample string 10"
}
application/xml, text/xml
<ScheduledTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.ScheduledTasks">
<Account>sample string 10</Account>
<AccountID>922bca66-0317-4ab7-be9e-efaf04e8dc2d</AccountID>
<Created>2026-04-03T06:20:27.5900592+00:00</Created>
<CronExpression>sample string 3</CronExpression>
<CronExpressionDescription>sample string 4</CronExpressionDescription>
<Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</Data>
<DataBytes>QEA=</DataBytes>
<DataCompression>1</DataCompression>
<DataFormat>1</DataFormat>
<Default>true</Default>
<Description>sample string 6</Description>
<ID>c4964b2f-0fdf-44ae-9336-910aed6c4a07</ID>
<LastRun>2026-04-03T06:20:27.5900592+00:00</LastRun>
<Registered>true</Registered>
<ScheduleType>Cron</ScheduleType>
<Starts>2026-04-03T06:20:27.5900592+00:00</Starts>
<Task>sample string 5</Task>
<TimeZone xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
</ScheduledTask>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK �2�\��ʵ 5 xl/workbook.xml � (� ����0��&�C���D��x��}-[�@����[J ��mgv�۩'뇧���ф�7T��*���!�C�v�z
1I�bVű����Dv*��8BT��\��Vp�1�qAiP���!���p
Y&c�;��-!���3l�Ȋ���"P��[��#%�Ri�s�r˳�e��n�
V��w�PK �2�\���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
�2�\d6,@' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R8e69e44b1def4432" /></Relationships>PK �2�\�e��� xl/worksheets/sheet1.xml � (� ��[s�0��
������Q;m���^}8癣�2q����BF:}Q�|k'YY����+Yy�:��t=�!@��׳t�߆�G��%���`�f��R��3�:?ˆ��(6ga�ϖ:�� ��[�Y�5{��"��q:�H�1B<��**�T�2�����wj�LG�r �j_*��?�cS}�z/Ӌ�gS�{�hP�b����n'���}�r7��d�<)'ɼ�^D�b�nou��,�I����U^�zI����������b9���T(E�b`V5�ȋ4�����^�+=n�� D ��jR��A�I��1����z&����@� ��"B��zV��Q�T�#�q��Wz~��@1(`ʼn:��^�֯E�������ˣ�J*�q�0p���ҫ�3c�T�zʕ=z@uz�q�8HS�#�UO �?h�A0DPť=�:��Z�N!���"ПV���,� �H."dO��#�f!���'�P��qTP��n1�9�FY �%dI��{����k�h��[/+�M��Ӆy��~gZXn��
�ϝ�".����.��ĸK�6q�%h��t �&n�o�]B���.!��}�Pm��1��b���@,[������}q ���IJv�@�ކ&x���c�pWd�}�@,�����;���q$|rb��Q�:�[b�ӝ��龹��� �)F��㷣�u�Ī��� ���>;&�.��b�ڏL��6z��|J�l������y���PK �2�\$ӆ�� P xl/_rels/workbook.xml.rels � (� ��MN�0F�b͞�
I)�i7lؖ^`dN�&vd�@�Ƃ#q�"A*�`��h���4������xA��w
-
EN{ӻ��c�7+�n�;��D��)���bC]JӃ�Qw9~�����)�������RK��d��i����^������ �W��=����R��(2�ēih�q�-kT�VW����ZL����;��0�l���75W��2����N��L
�͢T�ڢ���YM^���PK �2�\Ѓc'2 E
xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK �2�\��G� xl/sharedStrings.xml � (� }�Q��0��
�Y��,������ō��r����b�o'���<��q�=���3�ߨ4���7!�=T�LK���!��=m@��K��?�������x�*t韌�D��'�C9��������:FzP�>!�G1!Yā ߣr��;u������T�"2U��_�-=�\P��5��dP���s�5���f��,���g;�x�\������5�KZ���
fm�e���?��כ|mǕ[�9���nx�?�i��u����;�w��R�i��M��k� M�<I� ��6�)��ғ�qC!��l�A
�6h0���H�w-��T�ɦ��N�=��Xt�*FÚ�P�������({�_]���k�v��|��8/u�i�C����ͽ�6No�q���b��,�e�
��#���?PK- �2�\��ʵ 5 xl/workbook.xmlPK- �2�\���� � � [Content_Types].xmlPK-
�2�\d6,@' ' T _rels/.relsPK- �2�\�e��� � xl/worksheets/sheet1.xmlPK- �2�\$ӆ�� P xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
E xl/styles.xmlPK- �2�\��G� � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK �2�\ArCU� 5 xl/workbook.xml � (� ����0��&�C���(N\�z��"
�'m
>��7o;���N1i;<��G��嶤��&g�5=Jp'mP�]���}1�u��Z7o�ʳ��Y��\/��+��3�u=��㊒ ��B���C�����l���o�X`�Ţ��%��%�skKQbs�;�ig��\�Q����;�`���PK �2�\���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
�2�\a>ŕ' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R7b44a0a7c0ed4efe" /></Relationships>PK �2�\�e��� xl/worksheets/sheet1.xml � (� ��[s�0��
������Q;m���^}8癣�2q����BF:}Q�|k'YY����+Yy�:��t=�!@��׳t�߆�G��%���`�f��R��3�:?ˆ��(6ga�ϖ:�� ��[�Y�5{��"��q:�H�1B<��**�T�2�����wj�LG�r �j_*��?�cS}�z/Ӌ�gS�{�hP�b����n'���}�r7��d�<)'ɼ�^D�b�nou��,�I����U^�zI����������b9���T(E�b`V5�ȋ4�����^�+=n�� D ��jR��A�I��1����z&����@� ��"B��zV��Q�T�#�q��Wz~��@1(`ʼn:��^�֯E�������ˣ�J*�q�0p���ҫ�3c�T�zʕ=z@uz�q�8HS�#�UO �?h�A0DPť=�:��Z�N!���"ПV���,� �H."dO��#�f!���'�P��qTP��n1�9�FY �%dI��{����k�h��[/+�M��Ӆy��~gZXn��
�ϝ�".����.��ĸK�6q�%h��t �&n�o�]B���.!��}�Pm��1��b���@,[������}q ���IJv�@�ކ&x���c�pWd�}�@,�����;���q$|rb��Q�:�[b�ӝ��龹��� �)F��㷣�u�Ī��� ���>;&�.��b�ڏL��6z��|J�l������y���PK �2�\U��e� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�N���ݰ���=N�&�e����G�
XE�Tb�������4����ڼM#9c���-�A��l��)��6��G��D�I^���>%�DiT=N2Σ���$SNCG�TG�!-4�p�$�����1��g�N�����p�=b������O)�k�E���v��y)زj�bZ�wS��2b����g2x�e��Eë�Q�U���K
��s�yy�vP��F.F�a�Fo�b�PK �2�\Ѓc'2 E
xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK �2�\��G� xl/sharedStrings.xml � (� }�Q��0��
�Y��,������ō��r����b�o'���<��q�=���3�ߨ4���7!�=T�LK���!��=m@��K��?�������x�*t韌�D��'�C9��������:FzP�>!�G1!Yā ߣr��;u������T�"2U��_�-=�\P��5��dP���s�5���f��,���g;�x�\������5�KZ���
fm�e���?��כ|mǕ[�9���nx�?�i��u����;�w��R�i��M��k� M�<I� ��6�)��ғ�qC!��l�A
�6h0���H�w-��T�ɦ��N�=��Xt�*FÚ�P�������({�_]���k�v��|��8/u�i�C����ͽ�6No�q���b��,�e�
��#���?PK- �2�\ArCU� 5 xl/workbook.xmlPK- �2�\���� � [Content_Types].xmlPK-
�2�\a>ŕ' ' V _rels/.relsPK- �2�\�e��� � xl/worksheets/sheet1.xmlPK- �2�\U��e� P xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
K xl/styles.xmlPK- �2�\��G� � xl/sharedStrings.xmlPK � �