POST api/scheduledtasks
Saves scheduled task and returns identifier.
Request Information
URI Parameters
None.
Body Parameters
Scheduled task
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. |
Request Formats
application/json, text/json
{ "id": "d5f52f5b-30ae-43d5-8302-4981debcc3b9", "accountID": "409febe2-eadb-4482-b354-c5440e7415c9", "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:56:32.0972616", "task": "sample string 5", "description": "sample string 6", "lastRun": "2025-10-04T23:56:32.0972616", "created": "2025-10-04T23:56:32.0972616", "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>409febe2-eadb-4482-b354-c5440e7415c9</AccountID> <Created>2025-10-04T23:56:32.0972616+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>d5f52f5b-30ae-43d5-8302-4981debcc3b9</ID> <LastRun>2025-10-04T23:56:32.0972616+00:00</LastRun> <Registered>true</Registered> <ScheduleType>Cron</ScheduleType> <Starts>2025-10-04T23:56:32.0972616+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
"f3c1e03a-553f-4d66-9a73-bf7b9bd2f54b"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">f3c1e03a-553f-4d66-9a73-bf7b9bd2f54b</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK �D[��ǀ� 5 xl/workbook.xml � (� ����0D�&�C���R8q���� [i�-ik��H�yۙ�};b��Zۓ��/\I�Ƃ1�t����f�I�4�Y��R�kۼ5��Rί�� AY�;5z���a��!��CzXQ����@�X�=N>����.&ak���D��QKZC J�skK�P� 5�4M�d�c���Lҝ���~W_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[J$��' ' _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="Rf547ae7e8f904737" /></Relationships>PK �D[,���% � xl/worksheets/sheet1.xml � (� �QMo� �+��B����T��j�M;lg�85���?@�i�.; ����Nw3�8�hk^d9g`[�j>����OM�����,�-]͕��QjIN`C�Gg����n��l�zQ��N8�R��D|e�Md�,�q�2R[�T���=s�����L4UB�kX�W����ט�t5�V�_��c�r�.Ϡ�Æ���ő�͌�{���{z�yU��>+7e�+v���x<p����|��եXi��Yz�T�R9��(�C�i�0��+q�������_�-�� zpI���/PK �D[+���� P xl/_rels/workbook.xml.rels � (� ��Kn� ���f_��+��d�M�i.��`��`i��e�#� E��:R�d����i����fw�F�>ζ�3�r�`�NQ?�`���q�1�f�IOlh��8�) ��$C�f�����dL���,�Q�Hc�K�3��2��N�A�S� m�Lߝ?����1���}�,Q��t-�9c����5�0�/#�_�[���j.T'˦Q�P�?T�H��k�i�K�e�P��U�dQ���E�os�w�b�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[E�D� � xl/sharedStrings.xml � (� 5�An� E��fOp��i"L�z�� �1�\�8Jo_�����������čS����TB�� _�� ���B8�2���̢�x�Yd��ӌ��H5�e�^*n��>�(y1���M��@Me'�ZP;����� ���b;�i��6�s�{}��V��2^�p��y�F�5}S_�_PK- �D[��ǀ� 5 xl/workbook.xmlPK- �D[���� � � [Content_Types].xmlPK- �D[J$��' ' U _rels/.relsPK- �D[,���% � � xl/worksheets/sheet1.xmlPK- �D[+���� P 8 xl/_rels/workbook.xml.relsPK- �D[Ѓc'2 E xl/styles.xmlPK- �D[E�D� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK �D[���ƶ 5 xl/workbook.xml � (� ����0��&�C���`�N\�zm�-ik���'�x�3;�������\K>����%U1�cA(4�G;���(��9)��ډ�A�1I��cQ;��]h��B������mi��§f�C��h�u'��%�~S|�m�"�����έ)iJ�/�8ܯ�O�Lsi2�{�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[��Gv' ' _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="Rd0949cbc78ea4a31" /></Relationships>PK �D[,���% � xl/worksheets/sheet1.xml � (� �QMo� �+��B����T��j�M;lg�85���?@�i�.; ����Nw3�8�hk^d9g`[�j>����OM�����,�-]͕��QjIN`C�Gg����n��l�zQ��N8�R��D|e�Md�,�q�2R[�T���=s�����L4UB�kX�W����ט�t5�V�_��c�r�.Ϡ�Æ���ő�͌�{���{z�yU��>+7e�+v���x<p����|��եXi��Yz�T�R9��(�C�i�0��+q�������_�-�� zpI���/PK �D[k�=� P xl/_rels/workbook.xml.rels � (� ��Kn� @��f_cl�*N6�t��ۊ Hۜ���W(j��H]t��h~OO��|�Xo�扼`������V9=ھ�s2���'��DFI^���!%�HiT�2VΣ���,SNCO�T'�#m�zICɀ[&9\<����:�h�`���)� �A�S?�H��2ȓ�`��h�a%���wS��2a����̲�XQ�G}W�A��)�K�Ne�Pk�Q-�բ捸�ћ��|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[E�D� � xl/sharedStrings.xml � (� 5�An� E��fOp��i"L�z�� �1�\�8Jo_�����������čS����TB�� _�� ���B8�2���̢�x�Yd��ӌ��H5�e�^*n��>�(y1���M��@Me'�ZP;����� ���b;�i��6�s�{}��V��2^�p��y�F�5}S_�_PK- �D[���ƶ 5 xl/workbook.xmlPK- �D[���� � � [Content_Types].xmlPK- �D[��Gv' ' U _rels/.relsPK- �D[,���% � � xl/worksheets/sheet1.xmlPK- �D[k�=� P 8 xl/_rels/workbook.xml.relsPK- �D[Ѓc'2 E } xl/styles.xmlPK- �D[E�D� � � xl/sharedStrings.xmlPK � �