From 5a751ed8991a7029164dd7c1fc5245a358e2427d Mon Sep 17 00:00:00 2001 From: Peter Schellenbach Date: Tue, 1 Feb 2022 15:56:43 -0800 Subject: [PATCH] Add common error codes to REST FS documentation. --- doc/MV REST File System API.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/MV REST File System API.md b/doc/MV REST File System API.md index 04cf33d..4f80738 100644 --- a/doc/MV REST File System API.md +++ b/doc/MV REST File System API.md @@ -1382,6 +1382,22 @@ curl --location --request POST 'http://localhost:3181/mvsvr/restfs/call/FTFSDBG' ATTR_DATAONLY is not a true attribute. For MultiValue systems using the AccuTerm RestFS connector, it is used to limit the response from a 'dir' request to items in a data level file. Items in the account (MD or VOC) or a dictionary level file are skipped. +## **Error Codes** + +Common error codes returned by the AccuTerm RestFS connector were inspired by D3 error message numbers. These codes typically are returned when the request status is one of the 4xx codes. + +| Code | Description | +|------|-----------------------------------------| +| 200 | File name missing | +| 201 | Invalid file name | +| 202 | Item not found | +| 203 | Item ID missing | +| 223 | Item exists | +| 235 | Record is locked | +| 260 | Failed to lock record | +| 261 | Update failed | + + ## **Resources** A Postman collection containing examples for each of the API functions: