POST api/Task/AddTask

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientTask	ClientTask	None.
Repeating	boolean	None.
StartTime	Time	None.
StartDate	date	None.
EndTime	Time	None.
EndDate	date	None.
CronType	integer	None.
CronInterval	integer	None.
RepeatingTimes	Collection of Time	None.
GroupName	string	None.
AzUserId	string	None.
Culture	string	None.
TransactionId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientTask": {
    "ClientTaskId": "sample string 1",
    "ClientTaskLogId": "sample string 2",
    "ClientTaskTypeId": 3,
    "ExecutionMode": 4,
    "Priority": 5,
    "AzUserId": "sample string 6",
    "CreatorTypeId": 7,
    "CreationTime": "2026-07-05T04:09:29.7156588+03:00",
    "Deadline": "2026-07-05T04:09:29.7156588+03:00",
    "Parameters": "sample string 10",
    "Status": 11,
    "State": 12,
    "RunCount": 13,
    "LastUpdateTime": "2026-07-05T04:09:29.7166597+03:00",
    "StartTime": "2026-07-05T04:09:29.7166597+03:00",
    "IsCron": true,
    "Culture": "sample string 17",
    "TransactionId": "sample string 18"
  },
  "Repeating": true,
  "StartTime": {
    "Hour": 1,
    "Minute": 2,
    "Second": 3,
    "MilliSecond": 4
  },
  "StartDate": "2026-07-05T04:09:29.7166597+03:00",
  "EndTime": {
    "Hour": 1,
    "Minute": 2,
    "Second": 3,
    "MilliSecond": 4
  },
  "EndDate": "2026-07-05T04:09:29.7166597+03:00",
  "CronType": 4,
  "CronInterval": 5,
  "RepeatingTimes": [
    {
      "Hour": 1,
      "Minute": 2,
      "Second": 3,
      "MilliSecond": 4
    },
    {
      "Hour": 1,
      "Minute": 2,
      "Second": 3,
      "MilliSecond": 4
    }
  ],
  "GroupName": "sample string 6",
  "AzUserId": "sample string 7",
  "Culture": "sample string 8",
  "TransactionId": "sample string 9"
}

application/xml, text/xml

Sample:

<AddTaskCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Model.Main.Criteria.Task">
  <Culture xmlns="http://schemas.datacontract.org/2004/07/Shams.Model.Abstract.Common.Base">sample string 8</Culture>
  <TransactionId xmlns="http://schemas.datacontract.org/2004/07/Shams.Model.Abstract.Common.Base">sample string 9</TransactionId>
  <AzUserId xmlns="http://schemas.datacontract.org/2004/07/Shams.Model.Main.Common.Base">sample string 7</AzUserId>
  <ClientTask xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Model.Main.Core">
    <Culture xmlns="http://schemas.datacontract.org/2004/07/Shams.Model.Abstract.Common.Base">sample string 17</Culture>
    <TransactionId xmlns="http://schemas.datacontract.org/2004/07/Shams.Model.Abstract.Common.Base">sample string 18</TransactionId>
    <d2p1:AzUserId>sample string 6</d2p1:AzUserId>
    <d2p1:ClientTaskId>sample string 1</d2p1:ClientTaskId>
    <d2p1:ClientTaskLogId>sample string 2</d2p1:ClientTaskLogId>
    <d2p1:ClientTaskTypeId>3</d2p1:ClientTaskTypeId>
    <d2p1:CreationTime>2026-07-05T04:09:29.7156588+03:00</d2p1:CreationTime>
    <d2p1:CreatorTypeId>7</d2p1:CreatorTypeId>
    <d2p1:Deadline>2026-07-05T04:09:29.7156588+03:00</d2p1:Deadline>
    <d2p1:ExecutionMode>4</d2p1:ExecutionMode>
    <d2p1:IsCron>true</d2p1:IsCron>
    <d2p1:LastUpdateTime>2026-07-05T04:09:29.7166597+03:00</d2p1:LastUpdateTime>
    <d2p1:Parameters>sample string 10</d2p1:Parameters>
    <d2p1:Priority>5</d2p1:Priority>
    <d2p1:RunCount>13</d2p1:RunCount>
    <d2p1:StartTime>2026-07-05T04:09:29.7166597+03:00</d2p1:StartTime>
    <d2p1:State>12</d2p1:State>
    <d2p1:Status>11</d2p1:Status>
  </ClientTask>
  <CronInterval>5</CronInterval>
  <CronType>4</CronType>
  <EndDate>2026-07-05T04:09:29.7166597+03:00</EndDate>
  <EndTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Model.Abstract.DataType">
    <d2p1:Hour>1</d2p1:Hour>
    <d2p1:MilliSecond>4</d2p1:MilliSecond>
    <d2p1:Minute>2</d2p1:Minute>
    <d2p1:Second>3</d2p1:Second>
  </EndTime>
  <GroupName>sample string 6</GroupName>
  <Repeating>true</Repeating>
  <RepeatingTimes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Model.Abstract.DataType">
    <d2p1:Time>
      <d2p1:Hour>1</d2p1:Hour>
      <d2p1:MilliSecond>4</d2p1:MilliSecond>
      <d2p1:Minute>2</d2p1:Minute>
      <d2p1:Second>3</d2p1:Second>
    </d2p1:Time>
    <d2p1:Time>
      <d2p1:Hour>1</d2p1:Hour>
      <d2p1:MilliSecond>4</d2p1:MilliSecond>
      <d2p1:Minute>2</d2p1:Minute>
      <d2p1:Second>3</d2p1:Second>
    </d2p1:Time>
  </RepeatingTimes>
  <StartDate>2026-07-05T04:09:29.7166597+03:00</StartDate>
  <StartTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Model.Abstract.DataType">
    <d2p1:Hour>1</d2p1:Hour>
    <d2p1:MilliSecond>4</d2p1:MilliSecond>
    <d2p1:Minute>2</d2p1:Minute>
    <d2p1:Second>3</d2p1:Second>
  </StartTime>
</AddTaskCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OperationResultOfBoolean

Name	Type	Additional information
Response	boolean	None.
Result	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
SystemErrorMessage	string	None.
Message	string	None.
ErrorCategory	string	None.
TotalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Response": true,
  "Result": true,
  "ErrorCode": "sample string 3",
  "ErrorMessage": "sample string 4",
  "SystemErrorMessage": "sample string 5",
  "Message": "sample string 6",
  "ErrorCategory": "sample string 7",
  "TotalCount": 8
}

application/xml, text/xml

Sample:

<OperationResultOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Model.Abstract.Common.Action">
  <ErrorCategory>sample string 7</ErrorCategory>
  <ErrorCode>sample string 3</ErrorCode>
  <ErrorMessage>sample string 4</ErrorMessage>
  <Message>sample string 6</Message>
  <Result>true</Result>
  <SystemErrorMessage>sample string 5</SystemErrorMessage>
  <TotalCount>8</TotalCount>
  <Response>true</Response>
</OperationResultOfboolean>