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": "3ba5fb1d-ddde-4e57-97af-a5c11f61e98f", "accountID": "f94699bf-1625-46bb-9fce-84064de7ac29", "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-06-14T06:06:47.5011278", "task": "sample string 5", "description": "sample string 6", "lastRun": "2025-06-14T06:06:47.5011278", "created": "2025-06-14T06:06:47.5011278", "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>f94699bf-1625-46bb-9fce-84064de7ac29</AccountID> <Created>2025-06-14T06:06:47.5011278+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>3ba5fb1d-ddde-4e57-97af-a5c11f61e98f</ID> <LastRun>2025-06-14T06:06:47.5011278+00:00</LastRun> <Registered>true</Registered> <ScheduleType>Cron</ScheduleType> <Starts>2025-06-14T06:06:47.5011278+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 �0�ZW^1� 5 xl/workbook.xml � (� ����0��&�C����� '.^=x_�V�O�||�o�vfg��r4�ӓ��/\E�l���*�cQO;a��0I�bFɱ1��PvL��9 H�}'�������bPÂR 5��;Bʹ�C�補���l���o����"*�AaE@ItnmESJ\!��~N���K~��NiK7�+����PK �0�Z���� � [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 �0�Zd���' ' _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="Rfc7abef1dcea4234" /></Relationships>PK �0�Z�)%�� xl/worksheets/sheet1.xml � (� ��[s�0�� ������Q;m���^}8癣�2q����BF:}Q�|kgge%28�JVާ��8]}����,��뷡�Q,~I�|4ئ�{�Ժ���ϲ��,��Y泥N�<H7zm�i�D������b��8�}$z]�!fzf�|or_�;��M��y�B�ڗJ�x���T�u�ez1�/�l�}/ J�O��y��ۭ�_���~�͇>*ٰO��_2o��Ǫ���[�-c+5�t���^��$�*���X}" aL�$Tqߛ}�E���C]e�Ǖ7�� @�"!���zR��A�I��1�F���rZ��A$`�pJ)R �8�g���H�1"7����JϏz(&��8Q���ҋV�JPc!���'+�<�i��2g 'pZ�*�:�13�Ke��\)ѣT�;��Aʘ�ܤH�� �Bs �!���OJѓ�3�����*� �i�:���" ��R�)dO��#�f!���'�P��qTP�q_�u�DHs�09 ����uT�]㨈F�,�zY9l��.�c^�x�����9B��s����.m�K�61��M\w �&&]����.���m�m�K�6q�%T���p�2���X�>:��'b���@,c_������:���� �!}��>�Yv_:��.�-������F ���q����ցX�t�@�}�o6A��8�̼�cn���Q���bm���'|�>���:�/Ī�ڏL��6�ƥy���$M�����w�PK �0�ZR�R� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�I�$TM�aö��'Q۲]�gc���V���X��j4��'�|�lvo�L^ЇɚʂA#�����)�v��g�D'HZ1��1F��4� �Ф��~1�~�Nȣ�V�5���f�����V�I⃕�M�L_�?�19?`���%�E�yT=�WL�N�M˙�u��Л��x�1�z}癌d���a�-c\��ʌ£z�>]:w�˙Z��Z1!9֜KqQ�W��PK �0�ZЃ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 �0�Z�~�� xl/sharedStrings.xml � (� }�_o�0ſ �y�K�� ���N�&Mj��U�v�/�[��m���kҨS1��=?���^;�y�Z�J�/��]9��C����z[�Q8�Vp,���ܔ�R�1V� ��u�19b�=rC!;Ц��@���#���`�i��C��u�ͩgܽ �V��V�.�`�^�O�d�A��ϣF�nO��Nt&���2���?���~�q�vR�/ϗ��i��H��#4Hm%ރz��^n���B h�Vs��/��~��4J�QaCkM=���!i�z�R�bL6^��ƃ�DQ�F�m�����4��Ƌ�U��i]{YC���aS� Ye��F���w�m�LcQ�W�(�+v@�V���47�ù�Q?��=�k�`�i�sMAh����Y_��u�\��[������-��?̻._ PK- �0�ZW^1� 5 xl/workbook.xmlPK- �0�Z���� � [Content_Types].xmlPK- �0�Zd���' ' V _rels/.relsPK- �0�Z�)%�� � xl/worksheets/sheet1.xmlPK- �0�ZR�R� P xl/_rels/workbook.xml.relsPK- �0�ZЃc'2 E M xl/styles.xmlPK- �0�Z�~�� � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK �0�Z���� 5 xl/workbook.xml � (� ����0��&�C���Lp��Ճ��l������Ƿ�@������S�֏OkG�ѓ �o���b@ �d����k�I��R*��o�&��%�8ATքA�@W�?��<BĨ��A���K���9d����b���o�ΰ�"+b@cC;�@Ivn}Cϔ�J��.9��sQ��+p��wXͶ��PK �0�Z���� � [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 �0�Z�i��' ' _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="R0a9da8da6caa452e" /></Relationships>PK �0�Z�)%�� xl/worksheets/sheet1.xml � (� ��[s�0�� ������Q;m���^}8癣�2q����BF:}Q�|kgge%28�JVާ��8]}����,��뷡�Q,~I�|4ئ�{�Ժ���ϲ��,��Y泥N�<H7zm�i�D������b��8�}$z]�!fzf�|or_�;��M��y�B�ڗJ�x���T�u�ez1�/�l�}/ J�O��y��ۭ�_���~�͇>*ٰO��_2o��Ǫ���[�-c+5�t���^��$�*���X}" aL�$Tqߛ}�E���C]e�Ǖ7�� @�"!���zR��A�I��1�F���rZ��A$`�pJ)R �8�g���H�1"7����JϏz(&��8Q���ҋV�JPc!���'+�<�i��2g 'pZ�*�:�13�Ke��\)ѣT�;��Aʘ�ܤH�� �Bs �!���OJѓ�3�����*� �i�:���" ��R�)dO��#�f!���'�P��qTP�q_�u�DHs�09 ����uT�]㨈F�,�zY9l��.�c^�x�����9B��s����.m�K�61��M\w �&&]����.���m�m�K�6q�%T���p�2���X�>:��'b���@,c_������:���� �!}��>�Yv_:��.�-������F ���q����ցX�t�@�}�o6A��8�̼�cn���Q���bm���'|�>���:�/Ī�ڏL��6�ƥy���$M�����w�PK �0�ZWh�� P xl/_rels/workbook.xml.rels � (� ��An� E������N'�n�Ms�1���9[=R�P�J-���&+4�鍆�����m��}�i����V��o�)ꇆn7�=NӍ0�.��Ą�1�cA8C(�C�:��b*}��#��J�+�s�e�����V�Qⳕ�M��^�?�1Rr �cl�O��X�J�N�t�9T�sY ࢆ4>��Z�� ï�w��,�|j��.A(����Q�D�6�;�q�֕���B.���U�����PK �0�ZЃ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 �0�Z�~�� xl/sharedStrings.xml � (� }�_o�0ſ �y�K�� ���N�&Mj��U�v�/�[��m���kҨS1��=?���^;�y�Z�J�/��]9��C����z[�Q8�Vp,���ܔ�R�1V� ��u�19b�=rC!;Ц��@���#���`�i��C��u�ͩgܽ �V��V�.�`�^�O�d�A��ϣF�nO��Nt&���2���?���~�q�vR�/ϗ��i��H��#4Hm%ރz��^n���B h�Vs��/��~��4J�QaCkM=���!i�z�R�bL6^��ƃ�DQ�F�m�����4��Ƌ�U��i]{YC���aS� Ye��F���w�m�LcQ�W�(�+v@�V���47�ù�Q?��=�k�`�i�sMAh����Y_��u�\��[������-��?̻._ PK- �0�Z���� 5 xl/workbook.xmlPK- �0�Z���� � � [Content_Types].xmlPK- �0�Z�i��' ' T _rels/.relsPK- �0�Z�)%�� � xl/worksheets/sheet1.xmlPK- �0�ZWh�� P xl/_rels/workbook.xml.relsPK- �0�ZЃc'2 E K xl/styles.xmlPK- �0�Z�~�� � xl/sharedStrings.xmlPK � �