From 3c71d6aeaae7a29fe85e4cb0573473b432574e07 Mon Sep 17 00:00:00 2001 From: Ralph Soika Date: Tue, 19 Dec 2017 14:13:57 +0100 Subject: [PATCH] documentation --- src/site/markdown/restapi/adminp.md | 56 ++++++++++++++++++++ src/site/markdown/restapi/documentservice.md | 2 +- src/site/markdown/restapi/index.md | 2 + src/site/site.xml | 1 + 4 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 src/site/markdown/restapi/adminp.md diff --git a/src/site/markdown/restapi/adminp.md b/src/site/markdown/restapi/adminp.md new file mode 100644 index 000000000..fe8adb536 --- /dev/null +++ b/src/site/markdown/restapi/adminp.md @@ -0,0 +1,56 @@ +# The AdminP Service +The resource _/adminp_ provides methods to create administrative jobs. Jobs can be monitored with the [Imixs-Admin Client](../administration.html). + + +## GET Jobs +The GET method is used to read all running ore completed jobs: + + +| URI | Method | Description | +|-------------------------|--------|------------------------------------------------------------| +| /jobs | GET | returns all jobs from the AdminP interface. | + + + + +## POST/PUT a new job +The methods PUT or POST allow to create a new job: + + +| URI | Method | Description | +|--------------|-------------|------------| +| / | POST, PUT | posts a new job to be processed by the AdminPServcie. The post data is expected in xml format | + + +The following curl example shows how to create a new job to update the Lucene fulltextindex. + + curl --user admin:adminpassword -H "Content-Type: text/xml" -d \ + ' \ + adminp \ + REBUILD_LUCENE_INDEX \ + 1000 \ + 0 \ + 1 \ + ' \ + http://localhost:8080/workflow/rest-service/adminp/jobs + + + +In case the job is not createable the attribute '$error_code' will be returned in the response. + + +## DELETE a Document +The methods DELETE allow to remove a running or completed job: + + +| URI | Method | Description | +|--------------|-------------|------------| +| /{uniqueid} | DELETE | updates ore deletes a document | + + + + + + + + \ No newline at end of file diff --git a/src/site/markdown/restapi/documentservice.md b/src/site/markdown/restapi/documentservice.md index 8994cbdb7..909549da6 100644 --- a/src/site/markdown/restapi/documentservice.md +++ b/src/site/markdown/restapi/documentservice.md @@ -23,7 +23,7 @@ The methods PUT, POST and DELETE allow to create, modify and delete a document: | URI | Method | Description | |--------------|-------------|------------| | / | POST, PUT | posts a document to be stored by the DocumentService. The post data can be x-www-form-urlencoded or in xml format | -| /{uniqueid} | POST, DELTE | updates ore deletes a document | +| /{uniqueid} | POST, DELETE | updates ore deletes a document | diff --git a/src/site/markdown/restapi/index.md b/src/site/markdown/restapi/index.md index 6431a24f1..b26aecb11 100644 --- a/src/site/markdown/restapi/index.md +++ b/src/site/markdown/restapi/index.md @@ -13,6 +13,8 @@ The different resources provided by Imixs-Workflow are divided in the following | [/model/](./modelservice.html) | The Model resource provides resources and methods to get, create or modify a workflow model| | [/report/](./reportservice.html) | The Report resource provides resources and methods to create or execute a report based on a report definition| | [/documents/](./documentservice.html) | This resource provides methods to query documents managed by the DocumentService EJB | +| [/adminp/](./adminp.html) | This resource provides methods to create and monitor adminP jobs managed by the AdminPService EJB | + Note: The root context of the REST Service is defined by the web application (web.xml) containing the REST Service. The default root context is "/rest-service/". diff --git a/src/site/site.xml b/src/site/site.xml index 39d262b22..bf582de27 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -102,6 +102,7 @@ +