POST api/scheduledtasks

Saves scheduled task and returns identifier.

Request Information

URI Parameters

None.

Body Parameters

Scheduled task

ScheduledTask
NameDescriptionTypeAdditional 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

Sample:
{
  "id": "3449a61b-9289-4459-bb73-bdb0289f14ad",
  "accountID": "93773e97-bcc8-4577-a471-900b5e5762b6",
  "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-06-14T06:14:03.4327762",
  "task": "sample string 5",
  "description": "sample string 6",
  "lastRun": "2025-06-14T06:14:03.4327762",
  "created": "2025-06-14T06:14:03.4327762",
  "registered": true,
  "default": true,
  "account": "sample string 10"
}

application/xml, text/xml

Sample:
<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>93773e97-bcc8-4577-a471-900b5e5762b6</AccountID>
  <Created>2025-06-14T06:14:03.4327762+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>3449a61b-9289-4459-bb73-bdb0289f14ad</ID>
  <LastRun>2025-06-14T06:14:03.4327762+00:00</LastRun>
  <Registered>true</Registered>
  <ScheduleType>Cron</ScheduleType>
  <Starts>2025-06-14T06:14:03.4327762+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:

Sample not available.

Response Information

Resource Description

Identifier of new Scheduled Task

globally unique identifier

Response Formats

application/json, text/json

Sample:
"20b50cf8-7187-4c4b-9864-882cec5068ee"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">20b50cf8-7187-4c4b-9864-882cec5068ee</guid>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:
PK�1�Z��Ͷ5xl/workbook.xml �(�����0��J}�(�
�B��ҵCw�D%?JR��o�[7�����E�W���|�\ik:yoJ�\?�w�U؍�J�A�'��(zlu���<˒�`g�B+7	��F���E܄�弡$E��jm���(���]M¶�MUv\DEH�i(��m�iJ�-E�W^t�A�y��`����/PK�1�Z����	�[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
�1�Z"^M(''_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="R3d0200ab183942bb" /></Relationships>PK�1�Z_Z� %�xl/worksheets/sheet1.xml �(��Q�N�0��(w�֭Lm'�i���кM�&���瓤!q�Ė��{v���lGmŷ��3�
����|wW�S].认<pKGWq��x�F�G��֡3҇���N7p�f2`��ϲ�p0H�H����.�6Y0�Je���.[أ{栫�Ӗ3Q�	��a�_1�c|"^c��V<KX�|Iʯ����i�o�<���SO����ƙ���.�������6��]q�wE�Y3�G�W�b�I�g�e]:\�K���8%�A�¼s��b�������_�-�� zpI����/PK�1�Z����Pxl/_rels/workbook.xml.rels �(���Mn� F��f_c��Q�l��6�&0�Ql@@��l]�H�BQ*���E7Y����f�|���ަ����5
Y���z0]��>�`���iĘn�~p��'&4���֜�ӄ!��L��OS�;�P��#����9n��pq��m�AѣU�L��_�?��(;��(6�~=�,Q�=��+Y%�r���eQ�wS�2R����g2����VBhU�J����I?G�6=w���9�9"��J֥�����PK�1�ZЃc'2E
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�1�Zm���xl/sharedStrings.xml �(�5�An� E��fO ���
�E�� =����g\5�/]t�������S���J#R�S��_�O�@�D��R	Gx!���,�M�G�E�wc8�X"�Ԓ{�J�����a�xF��������	T�;Iӂ�)?w���&��K���d����ѝu���~sC������7����*�PK-�1�Z��Ͷ5xl/workbook.xmlPK-�1�Z����	��[Content_Types].xmlPK-
�1�Z"^M(''U_rels/.relsPK-�1�Z_Z� %��xl/worksheets/sheet1.xmlPK-�1�Z����P8xl/_rels/workbook.xml.relsPK-�1�ZЃc'2E
�xl/styles.xmlPK-�1�Zm����xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample:
PK�1�Z�zwW�5xl/workbook.xml �(���=�0��J�C�4��"!`b�ڡ{
NA~����o�[������ٸ�i�H>jҾr
�lE��*�OƢ�3n�b!J���s�cg��Bh�eW�pbA텴V�?,o��Ġ��������g��O2ۻ�I����:�����f
�X`@�sȁ�J��^^�1�!��D��;�����PK�1�Z����	�[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
�1�Z���''_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="Rf669d082d6684fdf" /></Relationships>PK�1�Z_Z� %�xl/worksheets/sheet1.xml �(��Q�N�0��(w�֭Lm'�i���кM�&���瓤!q�Ė��{v���lGmŷ��3�
����|wW�S].认<pKGWq��x�F�G��֡3҇���N7p�f2`��ϲ�p0H�H����.�6Y0�Je���.[أ{栫�Ӗ3Q�	��a�_1�c|"^c��V<KX�|Iʯ����i�o�<���SO����ƙ���.�������6��]q�wE�Y3�G�W�b�I�g�e]:\�K���8%�A�¼s��b�������_�-�� zpI����/PK�1�Z�4e��Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�		N��ݰa[z��=N�&vd�@�Ƃ#q�"�+�`�͌��'y>�?6��yb/���le!��UN�����]��fOƴ�q	,=���!�e�yP�
��M���1����#��+!��p�d��B�!:cFE�N�f��0u��쀾���O+�K*�D��;�˦�D)��ԕ$`�fj!�'
�^�u&c���X��^U�2z��ѧ�Ν�v��W�P�%�ljDuQ�Ww��PK�1�ZЃc'2E
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�1�Zm���xl/sharedStrings.xml �(�5�An� E��fO ���
�E�� =����g\5�/]t�������S���J#R�S��_�O�@�D��R	Gx!���,�M�G�E�wc8�X"�Ԓ{�J�����a�xF��������	T�;Iӂ�)?w���&��K���d����ѝu���~sC������7����*�PK-�1�Z�zwW�5xl/workbook.xmlPK-�1�Z����	��[Content_Types].xmlPK-
�1�Z���''U_rels/.relsPK-�1�Z_Z� %��xl/worksheets/sheet1.xmlPK-�1�Z�4e��P8xl/_rels/workbook.xml.relsPK-�1�ZЃc'2E
}xl/styles.xmlPK-�1�Zm����xl/sharedStrings.xmlPK��