arangodb/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md

@startDocuBlock post_api_new_tasks @brief creates a new task

@RESTHEADER{POST /_api/tasks, creates a task, registerTask}

@RESTBODYPARAM{name,string,required,string} The name of the task

@RESTBODYPARAM{command,string,required,string} The JavaScript code to be executed

@RESTBODYPARAM{params,string,required,string} The parameters to be passed into command

@RESTBODYPARAM{period,integer,optional,int64} number of seconds between the executions

@RESTBODYPARAM{offset,integer,optional,int64} Number of seconds initial delay

@RESTDESCRIPTION creates a new task with a generated id

@RESTRETURNCODES

@RESTRETURNCODE{200} The task was registered

@RESTREPLYBODY{id,string,required,} A string identifying the task

@RESTREPLYBODY{created,number,required,float} The timestamp when this task was created

@RESTREPLYBODY{type,string,required,} What type of task is this [ periodic, timed]

• periodic are tasks that repeat periodically
• timed are tasks that execute once at a specific time

@RESTREPLYBODY{period,number,required,} this task should run each period seconds

@RESTREPLYBODY{offset,number,required,float} time offset in seconds from the created timestamp

@RESTREPLYBODY{command,string,required,} the javascript function for this task

@RESTREPLYBODY{database,string,required,} the database this task belongs to

@RESTREPLYBODY{code,number,required,} The status code, 200 in this case.

@RESTREPLYBODY{error,boolean,required,} false in this case

@RESTRETURNCODE{400} If the post body is not accurate, a HTTP 400 is returned.

@EXAMPLES

@EXAMPLE_ARANGOSH_RUN{RestTasksCreate} var url = "/_api/tasks/";

// Note: prints stuff if server is running in non-daemon mode.
var sampleTask = {
  name: "SampleTask",
  command: "(function(params) { require('@arangodb').print(params); })(params)",
  params: { "foo": "bar", "bar": "foo"},
  period: 2
}
var response = logCurlRequest('POST', url,
                              sampleTask);

assert(response.code === 200);

logJsonResponse(response);

// Cleanup:
logCurlRequest('DELETE', url + JSON.parse(response.body).id);

@END_EXAMPLE_ARANGOSH_RUN @endDocuBlock