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
ScheduledTaskName | 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": "4f4d1612-0ad5-4ac6-b348-e7ecfb38233a", "accountID": "9cc8c020-982e-40a5-bc99-af8c2cd9f49f", "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": "2025-08-02T23:26:04.8169574", "task": "sample string 5", "description": "sample string 6", "lastRun": "2025-08-02T23:26:04.8169574", "created": "2025-08-02T23:26:04.8169574", "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>9cc8c020-982e-40a5-bc99-af8c2cd9f49f</AccountID> <Created>2025-08-02T23:26:04.8169574+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>4f4d1612-0ad5-4ac6-b348-e7ecfb38233a</ID> <LastRun>2025-08-02T23:26:04.8169574+00:00</LastRun> <Registered>true</Registered> <ScheduleType>Cron</ScheduleType> <Starts>2025-08-02T23:26:04.8169574+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 B�[�#��� 5 xl/workbook.xml � (� ����0D�&�C�����N\�z��" �%��|�o�vfgߎ��Jk;�ѽ��e��~H���E t��i�X��Oҽ�mUaa��F�Et<&�a^YC��/�X48��ZD���A��w�ɹ�S�HAN�Zw6�XB�7%l��И�<p�{��g.U���۵<�UM�\���{�I��οPK B�[���� � [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 B�[���' ' _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="R42b03a5749ba4d83" /></Relationships>PK B�[��� xl/worksheets/sheet1.xml � (� ��[s�0�� ������Q;m���^}8癣�2q����DBF:}Q�|k'YYl�%+�Sgy���>���z�������(��>l��=_j]x_�g��_��,��R'Q��6c�4K���foa�X�3=Ng�^!F���^E��*_ƛ��W�N�|��h^.!Y�K%Q��G�yl��V�ez1�/�l�}/ J�O���ѵ��ɿ4}���͇>*ٰO��_2o��Ǫ���[�-c+5�t���^��$�*���X}"�$�BpɌj��i�w?u��Wz��y�F �GM*59�9 0�0�H0|ZN+9=ȁ�N)E ����ҳF�T�#�q��Wz��y�� ��D�J/Z�W�"F ���zY�e�����l�)��i�������/���r�D�P�Ԭ )cJ�`� 8��� ���R��@�@�?�P��OwQ�O+�Q��,� �H."dO��#�� B .8,YO��N#4qTP���b�sGAd�4!H�(��Qٹ�Q�Y���r���]]�˼�w���q~�� ��i+�K@����M��i�]���I�`m�K�6q�%D����M�w �&~;�L}p ���IJ�ɁX�>;��b9��@,k���64�;�7��]�e������"��{�@,��kđ�ɉ�Gi�n�uNw�:���EPf�V���U�ͫ�J���u�Ī��� ���>;&��b���:e%2<�K�)��I�:+����v�PK B�[��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8M����vÆm�{GMl�v���G� XE�Tb�������4����ݿ�yAFk:Xe94�����zX�~�=��c�zt��:�1� �Ah�yȬC�:���ǔ��:.N|@Z�yM���Lr�8��*5 |��<�������#�#��~J�^�*KT O���M_V�⪪Y]�@���B�L~���L���Fbu)�*��G�}���iY^�չd�Q�WY/������PK B�[Ѓ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 B�[s^� xl/sharedStrings.xml � (� }�Qo�0�� �y$� ���V�&Mj��U�vc.�7lS�L���dQ�b��{>�����y���fR��*�|� �����%��i��N ,����T��Ƴ�B��ј�CjzD:�= KZ�8[�C�{���#��]G�&����Q9S��=u�i��`�`Ua�/u������\P��%��hP/�ۓ�%���z��V����g3t�{�������η�FM����q�@�q�^���L l�����\�����QcC�l��\N۴YmV1��Y���4#�i�O�8I��rJ3�ɳI���i�h3�&oӼuV7Z�<�ʮC:�Ew(P1��$�ŏ����7�ݹ���m�~^�9]�GN��5 ��о�i��\��u���7s��'Է#V�+���PK- B�[�#��� 5 xl/workbook.xmlPK- B�[���� � � [Content_Types].xmlPK- B�[���' ' U _rels/.relsPK- B�[��� � xl/worksheets/sheet1.xmlPK- B�[��� P xl/_rels/workbook.xml.relsPK- B�[Ѓc'2 E K xl/styles.xmlPK- B�[s^� � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK B�[��(� 5 xl/workbook.xml � (� ����0D�&�C�� ��N\�z��" �%m ~��o�vfg���j��)h�ܔ3f�%ؓ�P�]���y1�u��J7o�ʱse��Nhe{1Y���a�� ��Gtr\Q����@_�=�6Holu��5�~S<��������%����)1���#K��vI뤉!��_l������PK B�[���� � [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 B�[!0I' ' _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="R955e5a7d32f540b3" /></Relationships>PK B�[��� xl/worksheets/sheet1.xml � (� ��[s�0�� ������Q;m���^}8癣�2q����DBF:}Q�|k'YYl�%+�Sgy���>���z�������(��>l��=_j]x_�g��_��,��R'Q��6c�4K���foa�X�3=Ng�^!F���^E��*_ƛ��W�N�|��h^.!Y�K%Q��G�yl��V�ez1�/�l�}/ J�O���ѵ��ɿ4}���͇>*ٰO��_2o��Ǫ���[�-c+5�t���^��$�*���X}"�$�BpɌj��i�w?u��Wz��y�F �GM*59�9 0�0�H0|ZN+9=ȁ�N)E ����ҳF�T�#�q��Wz��y�� ��D�J/Z�W�"F ���zY�e�����l�)��i�������/���r�D�P�Ԭ )cJ�`� 8��� ���R��@�@�?�P��OwQ�O+�Q��,� �H."dO��#�� B .8,YO��N#4qTP���b�sGAd�4!H�(��Qٹ�Q�Y���r���]]�˼�w���q~�� ��i+�K@����M��i�]���I�`m�K�6q�%D����M�w �&~;�L}p ���IJ�ɁX�>;��b9��@,k���64�;�7��]�e������"��{�@,��kđ�ɉ�Gi�n�uNw�:���EPf�V���U�ͫ�J���u�Ī��� ���>;&��b���:e%2<�K�)��I�:+����v�PK B�["��L� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞��T�6lK/�8�8jb[��l,8W�*�6]����������m���0Y�!�4��9����`���q1M=�@Ҋ t��� 5."d֡Ie�"bJ�H��G1"-k�_3�Ig��!Z�&��V�4�0}��4br~����%�Y�y8웲*���K���9z3��3�_��|%��J��o���W�W7�����}���i]^�+�u�Ȫ.�E�^���PK B�[Ѓ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 B�[s^� xl/sharedStrings.xml � (� }�Qo�0�� �y$� ���V�&Mj��U�vc.�7lS�L���dQ�b��{>�����y���fR��*�|� �����%��i��N ,����T��Ƴ�B��ј�CjzD:�= KZ�8[�C�{���#��]G�&����Q9S��=u�i��`�`Ua�/u������\P��%��hP/�ۓ�%���z��V����g3t�{�������η�FM����q�@�q�^���L l�����\�����QcC�l��\N۴YmV1��Y���4#�i�O�8I��rJ3�ɳI���i�h3�&oӼuV7Z�<�ʮC:�Ew(P1��$�ŏ����7�ݹ���m�~^�9]�GN��5 ��о�i��\��u���7s��'Է#V�+���PK- B�[��(� 5 xl/workbook.xmlPK- B�[���� � [Content_Types].xmlPK- B�[!0I' ' V _rels/.relsPK- B�[��� � xl/worksheets/sheet1.xmlPK- B�["��L� P xl/_rels/workbook.xml.relsPK- B�[Ѓc'2 E K xl/styles.xmlPK- B�[s^� � xl/sharedStrings.xmlPK � �