MarkLogic 9 Product Documentation
PUT /manage/v2/databases/{id|name}/pipelines/{id|name}/properties

Summary

This resource address can be used to update the properties of the specified pipeline for the specified database.

URL Parameters
format	The format of the posted data. Can be either `json` (default) or `xml`. 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.
Content-type	The MIME type of the data in the request body, either `application/xml` or `application/json`.

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, either `application/xml` or `application/json`.

Response

Upon success, MarkLogic Server returns status code 200 (OK). If the payload is malformed or the database does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-admin role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage-admin

Usage Notes

The structure of the data in the request body is as follows.

annotation

Transition description

pipeline-id

A pipeline unique identifier.

pipeline-name

A pipeline name.

pipeline-description

A pipeline description.

success-action

success action

failure-action

failure action

status-transition

A transition defining what actions to take on create, update, or delete.

This is a complex structure with the following children:

annotation

Transition description

status

status

on-success

on-success

on-failure

on-failure

priority

priority

always

always

default-action

default-action

execute

A condition/action pair defining what to execute.

This is a complex structure with the following children:

annotation: Transition description
condition: condition
action: action

state-transition

A transition defining what actions to take on entry into a state.

This is a complex structure with the following children:

annotation

Transition description

state

state

on-success

on-success

on-failure

on-failure

priority

priority

always

always

default-action

default-action

execute

A condition/action pair defining what to execute.

This is a complex structure with the following children:

annotation: Transition description
condition: condition
action: action

event-transition

A transition defining what actions to take on a transition event.

This is a complex structure with the following children:

annotation

Transition description

event

event

priority

priority

default-action

default-action

execute

A condition/action pair defining what to execute.

This is a complex structure with the following children:

annotation: Transition description
condition: condition
action: action

Example


 
curl -X PUT --anyauth --user admin:admin --header "Content-Type:application/json" \
-d'{"pipeline-description": "Out-of-the-box document status handling."}' \
http://localhost:8002/manage/v2/databases/Documents/pipelines/MyPipeline/properties

==> Changes the description of the "MyPipeline" pipeline for the Documents database.

MarkLogic 9 Product DocumentationPUT /manage/v2/databases/{id|name}/pipelines/{id|name}/properties

Summary

Response

Required Privileges

Usage Notes

Example

MarkLogic 9 Product Documentation
PUT /manage/v2/databases/{id|name}/pipelines/{id|name}/properties