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": "99cf7c45-73e7-43f8-bacb-6e1e1114564f", "accountID": "364030fa-830c-4e9e-8a8a-c3ab5ff0bbbf", "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-08-02T23:27:05.4893181", "task": "sample string 5", "description": "sample string 6", "lastRun": "2025-08-02T23:27:05.4893181", "created": "2025-08-02T23:27:05.4893181", "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>364030fa-830c-4e9e-8a8a-c3ab5ff0bbbf</AccountID> <Created>2025-08-02T23:27:05.4893181+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>99cf7c45-73e7-43f8-bacb-6e1e1114564f</ID> <LastRun>2025-08-02T23:27:05.4893181+00:00</LastRun> <Registered>true</Registered> <ScheduleType>Cron</ScheduleType> <Starts>2025-08-02T23:27:05.4893181+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
"709c9d1a-c6ec-4c7d-be27-8f2d53ece52d"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">709c9d1a-c6ec-4c7d-be27-8f2d53ece52d</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK b�[E�o� 5 xl/workbook.xml � (� ����0D�&�C��U *)��x��}��4Ж�5��$��ξ1Z�U�v�{�3��6�!c��-j�;��;i���{1+�����[� ��y���5�U����B�[Ġ��AZ�w����S��g���d���oJ̰�bVĀƜ���ٹ79=R�2�\�suK�\b�\x\�� &����PK b�[���� � [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 b�[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="R49201c9d26a94b6c" /></Relationships>PK b�[���$ � xl/worksheets/sheet1.xml � (� �QMo� �+����TU�jRUm�i���'�i��D�&�`���=��t7���l� ���V۾�)t8��L��b`n��U�B���F��~E#�X��b�zN]�<S3��o�x���Wz����ˏe�-�a�2R[��VG��9�*xZ�u���g�+fi�O�kJ^� D��?�KV~u��NNCx��u�B��>�44�|3��ހy��۠*������bS��8 k&�|,��%_h��YY��f�r9��(���(�㼷Z���z��o�K��[Bw! �����_PK b�[Оs=� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�IL��ݰa[z��Q;�]�gc���V� �X��j4��'�|�lvo�H^0��;e���Ӿ\/��]��f��Ly"�a�$��(��4�)���$c�gt�c|�d�i��,�Q�H+���f��y���1��G�O�����p�19��c�S���"S�<u��U�z�-3��+�Л��t1�z}��:+(��ژ����T�ʀ�s ��K�ey��y�Z�]c��W���F��b�PK b�[Ѓ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 b�[��U� � xl/sharedStrings.xml � (� 5�An�0E�b��8�$�RO����������]�|���}{y�Y=q�Th����JL����SA�x�~.�#�"��8�,�N�G�D��1&̞weA�ɽ��K��axY�G�%Ϧm��d�T(IՂ�(�lx}s$g� �)�����cЇ0D}�v��{�ص�q���M}�� PK- b�[E�o� 5 xl/workbook.xmlPK- b�[���� � [Content_Types].xmlPK- b�[j�,' ' V _rels/.relsPK- b�[���$ � � xl/worksheets/sheet1.xmlPK- b�[Оs=� P 8 xl/_rels/workbook.xml.relsPK- b�[Ѓc'2 E ~ xl/styles.xmlPK- b�[��U� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK b�[OQ]� 5 xl/workbook.xml � (� ����0��&�C�����N\�z�^�b�O�||K $���~;t2nh��G�ڗ��"[� ���X�q��X�ҽ��{ɡ1��@r:���Ȃ4�i=^h���u�:/ ��bR�z�C��͞&�d4ֺ���"�)�`�ERH3nX`%��U8�ȕ2���8缃�vi���`����/PK b�[���� � [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 b�[9]��' ' _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="Rc78c75c9d6ed4fae" /></Relationships>PK b�[���$ � xl/worksheets/sheet1.xml � (� �QMo� �+����TU�jRUm�i���'�i��D�&�`���=��t7���l� ���V۾�)t8��L��b`n��U�B���F��~E#�X��b�zN]�<S3��o�x���Wz����ˏe�-�a�2R[��VG��9�*xZ�u���g�+fi�O�kJ^� D��?�KV~u��NNCx��u�B��>�44�|3��ހy��۠*������bS��8 k&�|,��%_h��YY��f�r9��(���(�㼷Z���z��o�K��[Bw! �����_PK b�[��ѣ� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8Ic���ݰa[z��3��&�e�@�Ƃ#q,*A*�`��h~OO��|����扽��5 Y����h�N���a���i&�]`ińt�n�yP�f�udR��~ƘR?p���2��_2��gG�!ھ=Zu���?����c�D��@���R�ߡ��S��^�B�\���C��7S�<Q������d�u'ĢR����FO�s���K�ey�V�-���(ʶR�E�_���PK b�[Ѓ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 b�[��U� � xl/sharedStrings.xml � (� 5�An�0E�b��8�$�RO����������]�|���}{y�Y=q�Th����JL����SA�x�~.�#�"��8�,�N�G�D��1&̞weA�ɽ��K��axY�G�%Ϧm��d�T(IՂ�(�lx}s$g� �)�����cЇ0D}�v��{�ص�q���M}�� PK- b�[OQ]� 5 xl/workbook.xmlPK- b�[���� � � [Content_Types].xmlPK- b�[9]��' ' U _rels/.relsPK- b�[���$ � � xl/worksheets/sheet1.xmlPK- b�[��ѣ� P 7 xl/_rels/workbook.xml.relsPK- b�[Ѓc'2 E | xl/styles.xmlPK- b�[��U� � � xl/sharedStrings.xmlPK � �