docu

bvfalcon · Jan 21, 2020 · 1739c8c · 1739c8c
1 parent 7be6be0
commit 1739c8c
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/src/site/markdown/restapi/documentservice.md b/src/site/markdown/restapi/documentservice.md
@@ -116,5 +116,19 @@ The Document Rest Service provides resource URIs for administrative purpose. To
 
 
 
+
+## Error Codes
+
+The Imixs workflow rest API may send an HTTP error code if a request could not be processed for various reasons:
+
+
+| HTTP Error Code      | Method               | Description                               | 
+|----------------------|----------------------|-------------------------------------------|
+| 404 (Not Found)      | GET/PUT/POST/DELTE   | The requested document was not found or is read protected. See also the section [security model](../engine/acl.html).
+| 406 (Not Acceptable) | PUT/POST             | The data in the request was incomplete or could not be processed. 
+
+
+In case of a PUT/POST request a HTTP Error Code 406 may also includes a response object with a detailed error message and an error code. 
+The error code is stored in the item '$error\_code'. An error message is stored in the item '$error\_message',
 
 
diff --git a/src/site/markdown/restapi/workflowservice.md b/src/site/markdown/restapi/workflowservice.md
@@ -84,3 +84,18 @@ The subresource _/workflow/events/_ provides a GETer method to read the current
 | URI                                           | Method | Description                               | 
 |-----------------------------------------------|--------|-----------------------------------|
 | /workitem/events/{uniqueid}                | GET    | Returns a collection of events of a workitem, visible to the current user
+
+
+## Error Codes
+
+The Imixs workflow rest API may send an HTTP error code if a request could not be processed for various reasons:
+
+
+| HTTP Error Code      | Method               | Description                               | 
+|----------------------|----------------------|-------------------------------------------|
+| 404 (Not Found)      | GET/PUT/POST/DELTE   | The requested workitem was not found or is read protected. See also the section [security model](../engine/acl.html).
+| 406 (Not Acceptable) | PUT/POST             | The data in the request was incomplete or could not be processed. 
+
+
+In case of a PUT/POST request a HTTP Error Code 406 may also includes a response object with a detailed error message and an error code. 
+The error code is stored in the item '$error\_code'. An error message is stored in the item '$error\_message',