Loading TOC...

MarkLogic 9 Product Documentation
GET /manage/v2/tasks/{id|name}

Summary

This resource address returns the configuration for the specified task.

URL Parameters
group-id The id or name of the group to which the tasks belong. The group must be specified by this parameter or by the group-name property in the request payload. If it is specified in both places, the values must be the same.
format The format of the returned data. Can be either html, json, or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the security and manage-admin roles.

Usage Notes

The structure of the output returned from this REST API is as follows:

scheduled-task-relations

The relations of the scheduled task.

This is a complex structure with the following children:

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

relation-id

A group or host related to the server.

task-id

The task ID.

task-enabled

Whether or not a task is enabled

task-path

The module to invoke.

task-root

The path to the module directory root.

task-type

What type of scheduled task is this.

task-period

How often this task should run (every n months, weeks, days, hours or minutes).

task-month-day

The day of the month that this task runs on.

task-days

The days that this task runs on.

This is a complex structure with the following children:

task-day

A day that this task runs on.

task-start-date

The starting date (in MM/DD/YYYY notation) for this task.

task-start-time

The starting time (in 24:00 notation) for this task.

task-timestamp

The date and time this task was created.

task-user

The user to run this task as.

task-priority

The priority of this task.

Example


http://localhost:8002/manage/v2/tasks/myTask?group-id=Default

==> Returns the configuration of the task, "myTask,"
    in the Default group.
    

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.