Check if a previous session can be resumed with a previously stored token (and resume it, of so).
true if a previous session was resumed.
Connect to a running Mayan EDMS instance. Username and password are the credentials of a user with access to the API. If valid, Mayan will return a token which is stored locally and will be used for all further requests.
The base URL of the server (e.g. https://mayan.example.com)
if true, the token is stored in local storage and can be used to resume the session later
true on success
Create a new cabinet
label for the cabinet
null to create toplevel cabinet, or the id of the parent cabinet
tne newly created cabinet
Create a Document Type
Arbitrary name for the document type
Create a new tag. A Tag is a label which can be attached to documents. It has a name and a coler (for display in an UI)
a color in hex format (e.g. #FF0000)
the newly cxreated tag
Remove a cabinet
true on success
Delete a document (i.e. move it to the trash)
true on success
Delete a document typ. Note: At least one document type must exist in the system. This is usually "Default"
Delete a tag. This will remove the tag from all documents it is attached to.
true on success
retrieve documents matching a given query
a search term
the list of matching documents
Fetch the preview images for a document
a list of URLs with image data
List all cabinets
Optional
segm: querySegmenta possibly empty list of cabinets
List all documents. This is probably a very expensive operation.
Optional
segm: querySegmentList all documents in a cabinet
Optional
segm: querySegmentList all available document types (Current user need permission to view document types)
Optional
segm: querySegmentList all favourite documents of the current user
Optional
segm: querySegmentretrieve recently accessed documents
Optional
segm: querySegment{page: number, pagesize: number}={page: 1, pagesize: 25}
Retrieve recently added documents
Optional
segm: querySegment{page: number, pagesize: number}={page: 1, pagesize: 25}
List all tags in the system. (Current user need permission to view tags)
Optional
segm: querySegmentGeneric retrieve a single object from Mayan (used e.g. to download files)
the URL to retrieve
Generic retrieve an image from Mayan (used to download preview images)
the URL to retrieve
an ObjectURL for the image
Logout from the current session. The token is removed from the local storage
remove a document from a cabinet (Current user need permission to remove documents from cabinets)
remove document from the current user's favorite list
true on success
generic GET request to Mayan (internally used by other methods) The method will call the endpoint repeatedly until all results are fetched or the limit is reached
REST Endpoint to call
Optional
segment: querySegment = ...the page and pagesize to fetch
Optional
params: stringquery parameters to pass to the endpoint
Add a document to a cabinet (Current user need permission to add documents to cabinets)