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": "92798ffe-b51d-42f8-9325-bf1ae0b835f5",
"accountID": "e3fb1247-eda8-4a60-89a0-8327ed16c751",
"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-06-03T18:30:34.1520469",
"task": "sample string 5",
"description": "sample string 6",
"lastRun": "2026-06-03T18:30:34.1520469",
"created": "2026-06-03T18:30:34.1520469",
"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>e3fb1247-eda8-4a60-89a0-8327ed16c751</AccountID>
<Created>2026-06-03T18:30:34.1520469+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>92798ffe-b51d-42f8-9325-bf1ae0b835f5</ID>
<LastRun>2026-06-03T18:30:34.1520469+00:00</LastRun>
<Registered>true</Registered>
<ScheduleType>Cron</ScheduleType>
<Starts>2026-06-03T18:30:34.1520469+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 ѓ�\�,Ƕ 5 xl/workbook.xml � (� ����0��&�C����R8q���{-[�H����[J ��mgv�ۡ�����/�ѓ �ﰌѵ�.A�p�L� �5�I�'�B(��o
&�sQ����&H�^i������ ��V�f���x@�.��
�e2�����"�)�a�EV�0
Xde�:v��ȷ*
�J��iT��xg�0J���PK ѓ�\���� � [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
ѓ�\&;�m' ' _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="Rbbbec30e3b3b45b1" /></Relationships>PK ѓ�\�'��� xl/worksheets/sheet1.xml � (� ��[s�0��
������Q;m���^}8癣�2q����DBF:}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������n>�QɆxRN��ys��>V�4����mY�X��������xg��%�W�����r�(�8NJB���G^����0�U�z\�q��!0�0#괞Tzr�s `�h1���JNr �SJ���i=���C (ƈ`\ =�畞7zc��V�o��ҋ�����QB8��^Vz��i��2g
'pZ�*�:�13�Ke��\)ѣT�5+��Aʘ�a�XO�C�x�!���OJѓ�3�����.� �i�:�p�E ɥ B����a~\A��%� 3�i�&�* �8�[|�C8
"���L I�Up/>ܷ��w��"
�t�e尩�{�0�y��L�M���A���V�e��6q�%p�w �&��m�.���M��m�K�6q�%d����M�v8f���@,W�e��|}v ��/�r�ՁX�NH�mh�wHn҇�"��Kb�}�E���X~_#�c7���9�:���uN�Nj�7�0����vT�����XG��� ���>;&�.��b�ڏL���ƥ����$M�����;�PK ѓ�\�B� � P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8NL䠦ݰa[z�'Q۲]�gc���V���X��j4��'�|�lvo�B^0���XUA����8�)�;��f��Ly"N��$��8����4� W+���qa�)�a�^���6u��P2�Ig��!:cf��N�V��0}u�'�� Èi��R����L��sӱVu��
r�z3����_�0��R�MÙj9碹��$���K��\�ɾAdBv�@δ��ѫ��~PK ѓ�\Ѓ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 ѓ�\�s�� xl/sharedStrings.xml � (� }�oo�0ƿ
���?$d�-�ӤI���ͪI;�H�b��f*߾&�:��A���sw����g�9�P**xNB/ �Z4�r�s��Qx���qn�L)�+W99j��}U���D�ܐVHڄ��^"4ꈨY�GA��PN�Z\�$6UN��{L Zd��Vf�.2�^�O��f�4,i�G�j ܞz\";�L�j��ߛs6C����9�I��<_s^�U-i��Jh���x����z���ݰ����JN�2��wx�J��%�0t���ۙ��h�M��* w�����ĭ�0��8i���
����Rw��M�`>q��&\כ$�F7�n��]��4�}E���^IO��O�p��^Ks�?��գ1���s�F��:���C�n��N�>^����\��[������a���]/PK- ѓ�\�,Ƕ 5 xl/workbook.xmlPK- ѓ�\���� � � [Content_Types].xmlPK-
ѓ�\&;�m' ' U _rels/.relsPK- ѓ�\�'��� � xl/worksheets/sheet1.xmlPK- ѓ�\�B� � P xl/_rels/workbook.xml.relsPK- ѓ�\Ѓc'2 E
I xl/styles.xmlPK- ѓ�\�s�� � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK ѓ�\ʃ�ɶ 5 xl/workbook.xml � (� ����0��&�C��`���x��}�.�H����%�x�3;��ԓ�/n�|�hB�:��*ƂPC8Y�f���k���Of�^ �xk4����`G�ʚ0(�J���G�a@�z\Q����@H�4{(�B����]L���M� �_$Ehlh(I�M64��Wj��5ɅD.�����;�f���PK ѓ�\���� � [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
ѓ�\@��K' ' _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="R05204eff7528412c" /></Relationships>PK ѓ�\�'��� xl/worksheets/sheet1.xml � (� ��[s�0��
������Q;m���^}8癣�2q����DBF:}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������n>�QɆxRN��ys��>V�4����mY�X��������xg��%�W�����r�(�8NJB���G^����0�U�z\�q��!0�0#괞Tzr�s `�h1���JNr �SJ���i=���C (ƈ`\ =�畞7zc��V�o��ҋ�����QB8��^Vz��i��2g
'pZ�*�:�13�Ke��\)ѣT�5+��Aʘ�a�XO�C�x�!���OJѓ�3�����.� �i�:�p�E ɥ B����a~\A��%� 3�i�&�* �8�[|�C8
"���L I�Up/>ܷ��w��"
�t�e尩�{�0�y��L�M���A���V�e��6q�%p�w �&��m�.���M��m�K�6q�%d����M�v8f���@,W�e��|}v ��/�r�ՁX�NH�mh�wHn҇�"��Kb�}�E���X~_#�c7���9�:���uN�Nj�7�0����vT�����XG��� ���>;&�.��b�ڏL���ƥ����$M�����;�PK ѓ�\!f˒� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8i]���ݰa[z�q�Ďl��Xp$��U$H%l����I3�����8���^@S�@��`z� 8e{��n��� s�H��)+> p9O�&�p��
�ұ!�2�4vt��(;����4�p�$���!k{��A�F��0}
�br���,�%4U�y2���Fi��(�*��L-�����;����W|�.-���8�<�X.=w��gj�]�j��Iƭ��ѫ��~PK ѓ�\Ѓ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 ѓ�\�s�� xl/sharedStrings.xml � (� }�oo�0ƿ
���?$d�-�ӤI���ͪI;�H�b��f*߾&�:��A���sw����g�9�P**xNB/ �Z4�r�s��Qx���qn�L)�+W99j��}U���D�ܐVHڄ��^"4ꈨY�GA��PN�Z\�$6UN��{L Zd��Vf�.2�^�O��f�4,i�G�j ܞz\";�L�j��ߛs6C����9�I��<_s^�U-i��Jh���x����z���ݰ����JN�2��wx�J��%�0t���ۙ��h�M��* w�����ĭ�0��8i���
����Rw��M�`>q��&\כ$�F7�n��]��4�}E���^IO��O�p��^Ks�?��գ1���s�F��:���C�n��N�>^����\��[������a���]/PK- ѓ�\ʃ�ɶ 5 xl/workbook.xmlPK- ѓ�\���� � � [Content_Types].xmlPK-
ѓ�\@��K' ' U _rels/.relsPK- ѓ�\�'��� � xl/worksheets/sheet1.xmlPK- ѓ�\!f˒� P xl/_rels/workbook.xml.relsPK- ѓ�\Ѓc'2 E
J xl/styles.xmlPK- ѓ�\�s�� � xl/sharedStrings.xmlPK � �