TaskService


Click here for a complete list of operations.

UpdateTask

Update task with specified id (GUID)
For details of TaskEditableData see CreateTask method

Hint 1
You could use TaskEditableData (in contrast to Create methods) in Update methods.
This will result in updating general properties of tasks (of all types). For updating specific properties (for ex. for http task) you should use derived structures (HttpTaskEditableData, PingTaskEditableData, PortTaskEditableData)
Soap client faults:
  • WrongInterval - interval for task is not in range of available regular task intervals (see GetTaskIntervals method)
  • WrongEditableTaskDataType - type of task in db and type of input editable data is not the same.
  • DeniedAccessToMonitoringAgents - you could not set monitoring points for task by default. Contact us if you want to do this.
  • BadIP - bad ip specified in host or url
  • WrongUrl - url is wrong
  • UrlInBlackList - url is in black list
  • WrongHttpMethod - http method is wrong (see GetTask for allowed methods)
  • WrongKeywordMode - http task keyword mode is wrong (see GetTask for allowed modes)
  • WrongPort - port of port task is wrong
  • WrongTaskType - task type is wrong (see GetTaskTypes for allowed types)
  • WrongTaskStatus - allowed enabled and disabled values
  • SimilarExists - some of your tasks have same url or host or host:port specified
  • Subscription error codes - see subscription service for available Soap client faults

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/soap/v1/task.asmx HTTP/1.1
Host: www.host-tracker.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.host-tracker.com/Services/UpdateTask"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="http://www.host-tracker.com/Services">
      <login>string</login>
      <password>string</password>
      <ticket>string</ticket>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <UpdateTask xmlns="http://www.host-tracker.com/Services">
      <id>guid</id>
      <taskData>
        <id>guid</id>
        <enabled>boolean</enabled>
        <interval>int</interval>
        <name>string</name>
        <fullLog>boolean</fullLog>
        <openStat>boolean</openStat>
        <tags>
          <string>string</string>
          <string>string</string>
        </tags>
        <agentPools>
          <string>string</string>
          <string>string</string>
        </agentPools>
        <subscriptions>
          <Subscription>
            <alertTypes xsi:nil="true" />
            <reportTypes xsi:nil="true" />
            <taskIds xsi:nil="true" />
            <contactIds xsi:nil="true" />
          </Subscription>
          <Subscription>
            <alertTypes xsi:nil="true" />
            <reportTypes xsi:nil="true" />
            <taskIds xsi:nil="true" />
            <contactIds xsi:nil="true" />
          </Subscription>
        </subscriptions>
      </taskData>
    </UpdateTask>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UpdateTaskResponse xmlns="http://www.host-tracker.com/Services">
      <UpdateTaskResult>
        <creationTime>dateTime</creationTime>
        <taskType>string</taskType>
        <enabled>boolean</enabled>
        <interval>int</interval>
        <upFromTime>dateTime</upFromTime>
        <lastState>boolean</lastState>
        <lastStateChangeTime>dateTime</lastStateChangeTime>
        <openStatEnabled>boolean</openStatEnabled>
        <fullLogEnabled>boolean</fullLogEnabled>
        <disablenceReason>string</disablenceReason>
        <disablenceTime>dateTime</disablenceTime>
        <holdResults>boolean</holdResults>
        <agentStat>boolean</agentStat>
        <billingOverlimits>
          <string>string</string>
          <string>string</string>
        </billingOverlimits>
        <tags>
          <string>string</string>
          <string>string</string>
        </tags>
        <subscriptions>
          <Subscription>
            <alertTypes xsi:nil="true" />
            <reportTypes xsi:nil="true" />
            <taskIds xsi:nil="true" />
            <contactIds xsi:nil="true" />
          </Subscription>
          <Subscription>
            <alertTypes xsi:nil="true" />
            <reportTypes xsi:nil="true" />
            <taskIds xsi:nil="true" />
            <contactIds xsi:nil="true" />
          </Subscription>
        </subscriptions>
        <stats>
          <daily>double</daily>
          <monthly>double</monthly>
          <yearly>double</yearly>
          <total>double</total>
        </stats>
        <agentPools>
          <string>string</string>
          <string>string</string>
        </agentPools>
        <deleted>boolean</deleted>
        <dnsbl>
          <lastChecked>dateTime</lastChecked>
          <interval>int</interval>
          <lastState>boolean</lastState>
          <lastStateChangeTime>dateTime</lastStateChangeTime>
        </dnsbl>
      </UpdateTaskResult>
    </UpdateTaskResponse>
  </soap:Body>
</soap:Envelope>