POST api/scheduledtasks
Saves scheduled task and returns identifier.
Request Information
URI Parameters
None.
Body Parameters
Scheduled task
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. |
Request Formats
application/json, text/json
{
"id": "17a2e50a-de07-40f8-886d-ece6367ece81",
"accountID": "f0c4eeb7-93d7-45bc-8c85-fc8bd9cd93eb",
"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:29:47.5143717",
"task": "sample string 5",
"description": "sample string 6",
"lastRun": "2026-06-03T18:29:47.5143717",
"created": "2026-06-03T18:29:47.5143717",
"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>f0c4eeb7-93d7-45bc-8c85-fc8bd9cd93eb</AccountID>
<Created>2026-06-03T18:29:47.5143717+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>17a2e50a-de07-40f8-886d-ece6367ece81</ID>
<LastRun>2026-06-03T18:29:47.5143717+00:00</LastRun>
<Registered>true</Registered>
<ScheduleType>Cron</ScheduleType>
<Starts>2026-06-03T18:29:47.5143717+00:00</Starts>
<Task>sample string 5</Task>
<TimeZone xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
</ScheduledTask>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Identifier of new Scheduled Task
globally unique identifierResponse Formats
application/json, text/json
"45b59136-6200-4579-9319-82b303bdb395"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">45b59136-6200-4579-9319-82b303bdb395</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK ���\��`�� 5 xl/workbook.xml � (� ����0D�&�C�p��8q�����m�-ik��-%�x�3;�v���Wk̋}Ԩ]a+.��
� R�Nf"v��
}�� fdG��ފ��,Ir�4��F;!'�W�?,7Y�� "���Pj^��K����E���b2XC�*#l���iTT�=r�[_�3[�0ܯ�4Үͳ�΄-��;���w�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
���\d��' ' _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="R1ce77644b4654ca6" /></Relationships>PK ���\
@��% � xl/worksheets/sheet1.xml � (� �QMo� �+��Bҏ)��T��j�M;lg�85���?@�i�.; �����w3�i�5/��3�-v�^k>����ǦZ��Hx������ �
��G��֣3҇�]��n��d�z���G�`�>H��#��?\4:�]�`���HmySu:�G��A_�S��h��|װЯ��1>o1y�j�'���$�W�:��4�7\�A_�ڧ�J73:�3#��]t�UͷO�f�)�b�-�rWr�N��|��եXi��Yz�T�R9��(�C�i�0��䕘co8���WaK�.�\R����PK ���\Rt�"� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞86I����tö��=��&vd����G�
XE�Tb�������4����M#9���-�,�V:5ؾ�S�5l7�=�"��`�9��bC&����
N"dnF�:��IĔ���BE���yE���Lr�����z��s�4������`#���=�~J�^�ȳja߬�Lv�X��л��x1�z}���T��0%tQv�2FxT/ѧK/����~l8jY���U�����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 ���\��� � xl/sharedStrings.xml � (� 5�An�0E�b��1āƕq�z�� ��Sf����]t��������W�ĝS��S
i*s�� �o�
�%��B8�2�[�̢*J<�"���ӂ9�lH��,{�R��0��g^%���4��1��$U��u��?WA
^¥;��^��җ��ig[����6v�G�:o$x�7�U�PK- ���\��`�� 5 xl/workbook.xmlPK- ���\���� � � [Content_Types].xmlPK-
���\d��' ' U _rels/.relsPK- ���\
@��% � � xl/worksheets/sheet1.xmlPK- ���\Rt�"� P 8 xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
~ xl/styles.xmlPK- ���\��� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK ���\#�
�� 5 xl/workbook.xml � (� ��;�0D�H���Đ/ ��I�"�b�`�?���ǀ@J�ngv��䣶}�uO>rP.��7c�w(��Av��|���t�
���o�ʳc]�����u�8���a9c�!z9,( B�r�#$��=�n��X�N&aK�����]̊(�X�
<P2;���1%6ax�i£(Io��>э��r��.�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
���\c�>' ' _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="R6e3f79dfbe264740" /></Relationships>PK ���\
@��% � xl/worksheets/sheet1.xml � (� �QMo� �+��Bҏ)��T��j�M;lg�85���?@�i�.; �����w3�i�5/��3�-v�^k>����ǦZ��Hx������ �
��G��֣3҇�]��n��d�z���G�`�>H��#��?\4:�]�`���HmySu:�G��A_�S��h��|װЯ��1>o1y�j�'���$�W�:��4�7\�A_�ڧ�J73:�3#��]t�UͷO�f�)�b�-�rWr�N��|��եXi��Yz�T�R9��(�C�i�0��䕘co8���WaK�.�\R����PK ���\Z5>� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;�8P�
ɦ�l�\`0c@�Nڜ���W��J-���&�����4����M#;��55�� FF�v0]
��J�n�{1� ��gq����'ν�iB�ؙL�h�&1u�Q�#.�x�nɀ[&;\f��j=(z��4� ���uG�`t�~J�_C�D*�][�>�J%DY9�L7+`�nj>\F�^��BF�Y!e�U.E����L��ڗ�⥗N��B��.P4X)��TzU�7��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 ���\��� � xl/sharedStrings.xml � (� 5�An�0E�b��1āƕq�z�� ��Sf����]t��������W�ĝS��S
i*s�� �o�
�%��B8�2�[�̢*J<�"���ӂ9�lH��,{�R��0��g^%���4��1��$U��u��?WA
^¥;��^��җ��ig[����6v�G�:o$x�7�U�PK- ���\#�
�� 5 xl/workbook.xmlPK- ���\���� � � [Content_Types].xmlPK-
���\c�>' ' U _rels/.relsPK- ���\
@��% � � xl/worksheets/sheet1.xmlPK- ���\Z5>� P 8 xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
xl/styles.xmlPK- ���\��� � � xl/sharedStrings.xmlPK � �