POST api/ScheduledTasks/retrieve_tasks

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of scheduled_task
NameDescriptionTypeAdditional information
identifier

globally unique identifier

None.

name

string

None.

interval

integer

None.

path

string

None.

import_affiliation

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "identifier": "e8b35ee7-ff13-4ce4-9798-f73a882b21ef",
    "name": "sample string 2",
    "interval": 1,
    "path": "sample string 3",
    "import_affiliation": "sample string 4"
  },
  {
    "identifier": "e8b35ee7-ff13-4ce4-9798-f73a882b21ef",
    "name": "sample string 2",
    "interval": 1,
    "path": "sample string 3",
    "import_affiliation": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfscheduled_task xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Totara.WEBAPI">
  <scheduled_task>
    <identifier>e8b35ee7-ff13-4ce4-9798-f73a882b21ef</identifier>
    <import_affiliation>sample string 4</import_affiliation>
    <interval>1</interval>
    <name>sample string 2</name>
    <path>sample string 3</path>
  </scheduled_task>
  <scheduled_task>
    <identifier>e8b35ee7-ff13-4ce4-9798-f73a882b21ef</identifier>
    <import_affiliation>sample string 4</import_affiliation>
    <interval>1</interval>
    <name>sample string 2</name>
    <path>sample string 3</path>
  </scheduled_task>
</ArrayOfscheduled_task>