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": "110330fa-683c-4f1d-9aae-fa3cb6969e15",
"accountID": "045f20c3-22da-4190-a12b-6c1d572da4da",
"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-04-03T06:24:32.0693347",
"task": "sample string 5",
"description": "sample string 6",
"lastRun": "2026-04-03T06:24:32.0693347",
"created": "2026-04-03T06:24:32.0693347",
"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>045f20c3-22da-4190-a12b-6c1d572da4da</AccountID>
<Created>2026-04-03T06:24:32.0693347+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>110330fa-683c-4f1d-9aae-fa3cb6969e15</ID>
<LastRun>2026-04-03T06:24:32.0693347+00:00</LastRun>
<Registered>true</Registered>
<ScheduleType>Cron</ScheduleType>
<Starts>2026-04-03T06:24:32.0693347+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
"725fc347-3915-41c3-a48c-840106a2b364"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">725fc347-3915-41c3-a48c-840106a2b364</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK 3�\nj`�� 5 xl/workbook.xml � (� ����0��&�C��@ #)��x���V�O�||K $���~;t�v괞�G��U�ƣ��"��#H�.ڀ
;��d>H�"�s�C����I�$%�03/�r�0o�X�X`���7�dB��|B��͞e0�����"�)a�ETH1 5n�gE�>�8��V"��(ny�wגgyZ>����w�PK 3�\���� � [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
3�\@���' ' _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="Ra1b2e2a34e514587" /></Relationships>PK 3�\�W�G$ � xl/worksheets/sheet1.xml � (� �Q�N�0���w�
lS� i��8�9����+']��$�@H\8$������j��� {C���� ���θS
S�o6�o����5b���k�!�;)}��*��]���V���IRߛ�N]��E� ���f����ˏ����PYe4Ug"{r/��� dSe�����E�蜒���"c��1+���W��h~Fs�!n�>��4�|k��@Xu��l��k�{\m�eY����bS�h'�~,�Ť\X��A�TL��\��)J��l4j�8�)*yI��D����_�%!�rV����PK 3�\�y�@� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8'
�i7lؖ^`�㨉�.г��H\�H�J,�t5��ӓf>�?�۷yb/��hME�##m?���SPw-l7�M����Y\1�������f�]�Ď�n�S7���e�7ܥ�f��y���R��G+O3����Zw�( ۣ(t�S���,R�=��u}/rqX5�EC����|8O����D�E�*T�,sM��TF���9�x��)-'j���Q]�T%E��Ư�b�PK 3�\Ѓ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 3�\���� � xl/sharedStrings.xml � (� 5�An� E����M��d)'h@�$F2��G��K]>�������"^�Q*8��`� �eJ����M
R��RF�$��;"u�4ʙy�К�9С��5y�-��=5���f n��u ��eG�Z)vL�;\��
�w�O��;{Rݹ9*��N;D5XӘ>����N�w����+�PK- 3�\nj`�� 5 xl/workbook.xmlPK- 3�\���� � [Content_Types].xmlPK-
3�\@���' ' V _rels/.relsPK- 3�\�W�G$ � � xl/worksheets/sheet1.xmlPK- 3�\�y�@� P 8 xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
~ xl/styles.xmlPK- 3�\���� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK 3�\C��� 5 xl/workbook.xml � (� ����0D�&�C���h)��x��}-[i�-ik��-%�x�3;�v�d]���'=_��v!�%c^t���&�uB��Ŭ�J`c�[� �e�p����=]h����Z�!=,(
��z�#���
'�d4ֺ�I�b�)�`�ERĀƊ6����ڊ攸R����9��<�C+{�q����PK 3�\���� � [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
3�\x'W�' ' _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="R8fd5c910d0f9454d" /></Relationships>PK 3�\�W�G$ � xl/worksheets/sheet1.xml � (� �Q�N�0���w�
lS� i��8�9����+']��$�@H\8$������j��� {C���� ���θS
S�o6�o����5b���k�!�;)}��*��]���V���IRߛ�N]��E� ���f����ˏ����PYe4Ug"{r/��� dSe�����E�蜒���"c��1+���W��h~Fs�!n�>��4�|k��@Xu��l��k�{\m�eY����bS�h'�~,�Ť\X��A�TL��\��)J��l4j�8�)*yI��D����_�%!�rV����PK 3�\y�J� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�i��VM�aö�f2��&vd�@�Ƃ#q�"�+�`��h~OO��|���ަ�����-�� F]7ؾ�S�w
춛=�*��`�9��bC&�y�y@C�
��ɦ�v~R1���£�/����p�d��L�!:�����l��_�?C���)��S
��"Q�=v-��Bʪԝ^Jl0~3��#�_��<��u�Z������2FyꞢO�Ν�r�V��r���/K��Z^���_l� PK 3�\Ѓ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 3�\���� � xl/sharedStrings.xml � (� 5�An� E����M��d)'h@�$F2��G��K]>�������"^�Q*8��`� �eJ����M
R��RF�$��;"u�4ʙy�К�9С��5y�-��=5���f n��u ��eG�Z)vL�;\��
�w�O��;{Rݹ9*��N;D5XӘ>����N�w����+�PK- 3�\C��� 5 xl/workbook.xmlPK- 3�\���� � � [Content_Types].xmlPK-
3�\x'W�' ' U _rels/.relsPK- 3�\�W�G$ � � xl/worksheets/sheet1.xmlPK- 3�\y�J� P 7 xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
} xl/styles.xmlPK- 3�\���� � � xl/sharedStrings.xmlPK � �