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": "62b6cd9f-3651-4002-93c3-c5c57e894b67", "accountID": "8705b3e4-633a-4967-9a7a-ef06913933c4", "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-10-04T23:57:20.4444499", "task": "sample string 5", "description": "sample string 6", "lastRun": "2025-10-04T23:57:20.4444499", "created": "2025-10-04T23:57:20.4444499", "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>8705b3e4-633a-4967-9a7a-ef06913933c4</AccountID> <Created>2025-10-04T23:57:20.4444499+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>62b6cd9f-3651-4002-93c3-c5c57e894b67</ID> <LastRun>2025-10-04T23:57:20.4444499+00:00</LastRun> <Registered>true</Registered> <ScheduleType>Cron</ScheduleType> <Starts>2025-10-04T23:57:20.4444499+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 *�D[��d;� 5 xl/workbook.xml � (� ����0��&�C���p��Ճ�R�@����[J ��mgv�۩f����}�dB�k,ct%!AH�<���v����$���aPZ+�L$���0� R��W�?��<�>H�����2�9��fOs�2[��Dd ��T�a�EV�p 5ny�e������/U�`�`eF�xgﰊl��/PK *�D[���� � [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 *�D[�|x�' ' _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="R1f1a05d3ed7d4048" /></Relationships>PK *�D[1�3�� xl/worksheets/sheet1.xml � (� ��[s�0�� ������Q;m���^}8癣�2q����DBF:}Q�|kgge�%+�Sgy���>���z�������(��>l��=_j]x_�g��_��,��R'Q��6c�4K���foa�X�3=Ng�^!F���^E��*_ƛ��W�N�|��h^������(^���<6�w�{�^�8�b�G���m~t��V�/M�w7w�J6���r�̛�E�*���V�o��J�,]�寗�;�|/����m</�C��@)J)(ɑ��7�ȋ4�����^�+9n�2�L�A"SC�֓JOzN�1�0���JNr ㄛ����i=���C (ƈ`\@��y�獞� `@+Nz�/*�h��E��������FO%�Y8S8��zU��A���_*c=�J�=�:>�� )c��`�XO�C �x �!��*.��� ��� u ��tu���BE8�" ��R !B�d �0?� ��<�X��0C�Fh�������QY �C���< ����iT]㨈F�,�zY9l��.�e^x�����9B��s����.m�K�61��M\w �&&]����.���m�m�K�6q�%T���p�2���X�>:��'b���@,c_������:�����>ܤwE�ݗ�����`������G�''�n��}�u �>�9k��L�.R�� �oG1kG����ߞ����cZyq V&^���QVã�qi>$u6I�Bg��y���PK *�D[fhk� P xl/_rels/workbook.xml.rels � (� ��Kn� @��f_�1����M6ݦ� ƃm�Hۜ���W(J�֑��&�����4����ٽ�y�G�(�������>H�m7�t�q�H� )-��F3�c�t�c}�u�i���I�H9c5 k�2��������ޛ�.���>�‘�u�15�S���"S�<u ��\��3ѢB��e������ddgm�D���C~W�A�Sȗ^;��+5!uY�T�\��^���_l� PK *�D[Ѓ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 *�D[]Q�)� xl/sharedStrings.xml � (� }�ݎ�0�_%�5N�:? J���EHHH���3m �lm�~�R��{9������ݳ�?� W�B�0FH�Z.�����KeK;%�B#�ե16p��T�dm�6�;��&T=HGJj]����5�֜ ��ug��\���A� �u��� ��k���֟�2�uM�_�;�����.i�Gf ܟ=.��γ��2Ǐ����n�aζZ�Ϸ2�i�i�ۥ�j�9�Q���z��gj�ð`���+�|s��p�Ƃ�38С�w��\�������,]�$� �`��4�M��|����tO �!'E����!Ί)a�7�ѹ�Vu�i,&�4ga�������ܣ��D_�?]��5�g���i�s�P�w���T< �c� �8}gs�-V�R�K���<r��~PK- *�D[��d;� 5 xl/workbook.xmlPK- *�D[���� � � [Content_Types].xmlPK- *�D[�|x�' ' U _rels/.relsPK- *�D[1�3�� � xl/worksheets/sheet1.xmlPK- *�D[fhk� P xl/_rels/workbook.xml.relsPK- *�D[Ѓc'2 E J xl/styles.xmlPK- *�D[]Q�)� � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK *�D[4�h˶ 5 xl/workbook.xml � (� ����0D�J��(� ET���ҵCw�� JR��o �ԭ��|~>>;4��F� [R��T0�Z� ��L�î7V�Ҿ��{�bmڷB�YE�8��F;!'G7�?,7Y�� D�� �@jZ�O���S��V���b���o����bUD����չw%�)���#Ȣ.N��-O���q����PK *�D[���� � [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 *�D[*%�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="Ra53b03e5d60c4845" /></Relationships>PK *�D[1�3�� xl/worksheets/sheet1.xml � (� ��[s�0�� ������Q;m���^}8癣�2q����DBF:}Q�|kgge�%+�Sgy���>���z�������(��>l��=_j]x_�g��_��,��R'Q��6c�4K���foa�X�3=Ng�^!F���^E��*_ƛ��W�N�|��h^������(^���<6�w�{�^�8�b�G���m~t��V�/M�w7w�J6���r�̛�E�*���V�o��J�,]�寗�;�|/����m</�C��@)J)(ɑ��7�ȋ4�����^�+9n�2�L�A"SC�֓JOzN�1�0���JNr ㄛ����i=���C (ƈ`\@��y�獞� `@+Nz�/*�h��E��������FO%�Y8S8��zU��A���_*c=�J�=�:>�� )c��`�XO�C �x �!��*.��� ��� u ��tu���BE8�" ��R !B�d �0?� ��<�X��0C�Fh�������QY �C���< ����iT]㨈F�,�zY9l��.�e^x�����9B��s����.m�K�61��M\w �&&]����.���m�m�K�6q�%T���p�2���X�>:��'b���@,c_������:�����>ܤwE�ݗ�����`������G�''�n��}�u �>�9k��L�.R�� �oG1kG����ߞ����cZyq V&^���QVã�qi>$u6I�Bg��y���PK *�D[��@�� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;��8$ �n�R.08��H��6�����W�E�6H]t�j4��'�|���o��^��ޚ �D #�mݛ��sh�J�n�{0� ���gq�� ���^w4�O�D&v�F1u-�P��%.�Xp7g�=����h����l�y$� �u'�`t-� ~J��B�D*�]]�^!.D��LK�TG`�aj>\�^��L�H����Z��y�L������N��LM�"/�2C!k%r}S�w��PK *�D[Ѓ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 *�D[]Q�)� xl/sharedStrings.xml � (� }�ݎ�0�_%�5N�:? J���EHHH���3m �lm�~�R��{9������ݳ�?� W�B�0FH�Z.�����KeK;%�B#�ե16p��T�dm�6�;��&T=HGJj]����5�֜ ��ug��\���A� �u��� ��k���֟�2�uM�_�;�����.i�Gf ܟ=.��γ��2Ǐ����n�aζZ�Ϸ2�i�i�ۥ�j�9�Q���z��gj�ð`���+�|s��p�Ƃ�38С�w��\�������,]�$� �`��4�M��|����tO �!'E����!Ί)a�7�ѹ�Vu�i,&�4ga�������ܣ��D_�?]��5�g���i�s�P�w���T< �c� �8}gs�-V�R�K���<r��~PK- *�D[4�h˶ 5 xl/workbook.xmlPK- *�D[���� � � [Content_Types].xmlPK- *�D[*%�b' ' U _rels/.relsPK- *�D[1�3�� � xl/worksheets/sheet1.xmlPK- *�D[��@�� P xl/_rels/workbook.xml.relsPK- *�D[Ѓc'2 E K xl/styles.xmlPK- *�D[]Q�)� � xl/sharedStrings.xmlPK � �