api.documents.v1.document package¶
Submodules¶
api.documents.v1.document.document module¶
Autogenerated API
-
api.documents.v1.document.document.
commit_document
(documentID: int, name: str = None, mimeType: str = None, data: str = None, text: str = None, lockRequestTime: int = 300000, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Commit specified document (PUBLIC)
Return type: dict
Parameters: - documentID (int) – ID of document to commit
- name (str) – If set change document name => Sanitize by regex [a-zA-Z0-9ÅåØøÆæ_-. ]*
- mimeType (str) – If set change document MIME type
- data (str) – Base64 encoded document content formatted according to the given MIME type. If set change document content
- text (str) – Plain text document content. If set change document content
- lockRequestTime (int) – Specify how long the document should be locked (default 300000)
Raises: - AuthenticationFailedException – on 401
- ValidationFailedException – on 412
- Exception – on 423
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 870, “limit”: 593, “responseCode”: 200, “count”: 557, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Might may federal painting activity.”, “messageTemplate”: “So ground president message rock final bed.”, “field”: “In population pattern.”, “parameter”: {}, “timestamp”: 113984355}], “currentPage”: 494, “size”: 767}
-
api.documents.v1.document.document.
get_document_content_by_id
(documentID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Download content as a file for specified document (PUBLIC)
Return type: dict
Parameters: documentID (int) – ID of document to fetch
Raises: - AuthenticationFailedException – on 401
- ValidationFailedException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {}
-
api.documents.v1.document.document.
get_document_revisions
(documentID: int, limit: int = 25, offset: int = 0, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Fetch specified document revisions (PUBLIC)
Return type: dict
Parameters: - documentID (int) – ID of document to fetch revisions
- limit (int) – Maximum number of returned results
- offset (int) – Skip a number of results
Raises: - AuthenticationFailedException – on 401
- ValidationFailedException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 693, “limit”: 645, “responseCode”: 200, “count”: 215, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Break after I what power.”, “messageTemplate”: “Listen chair event already turn.”, “field”: “Sea member experience.”, “parameter”: {}, “timestamp”: 210855037}], “currentPage”: 439, “size”: 429}
-
api.documents.v1.document.document.
get_meta_info_by_id
(documentID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Fetch specified document excluding content (PUBLIC)
Return type: dict
Parameters: documentID (int) – ID of document to fetch
Raises: - AuthenticationFailedException – on 401
- ValidationFailedException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 270, “limit”: 434, “responseCode”: 200, “count”: 477, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Increase tough hotel left station wall I.”, “messageTemplate”: “Place pattern standard.”, “field”: “Stock or ahead race.”, “parameter”: {}, “timestamp”: 1479899271}], “currentPage”: 653, “size”: 267}
-
api.documents.v1.document.document.
grant_document_access
(documentID: int, subjectID: int = None, level: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Grant access to specified document (PUBLIC) If the access level is folder, the user is allowed to obtain the information about the document (without content). If the access level is read, the user is allowed to obtain the content of the document. If the access level is write, the user is allowed to update the document.
Return type: dict
-
api.documents.v1.document.document.
list_document_access
(documentID: int, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Fetch ACL for specified document (PUBLIC)
Return type: dict
Parameters: - documentID (int) – Document ID
- offset (int) – Skip a number of results
- limit (int) – Maximum number of returned results
Raises: - AuthenticationFailedException – on 401
- ValidationFailedException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 898, “limit”: 894, “responseCode”: 200, “count”: 15, “data”: [{“id”: 963, “subject”: {“id”: 341, “customerID”: 922, “name”: “Alicia Sanders”}, “level”: “write”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Charge city treatment among year out.”, “messageTemplate”: “Friend stay eye about nature ground which.”, “field”: “Lose artist too parent.”, “parameter”: {}, “timestamp”: 1407115337}], “currentPage”: 559, “size”: 881}
-
api.documents.v1.document.document.
lock_document
(documentID: int, lockRequestTime: int = None, mode: str = 'LOCK', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Lock/Unlock specified document (PUBLIC)
Return type: dict
Parameters: - documentID (int) – ID of document to lock/unlock
- lockRequestTime (int) – If ‘mode’ is set to LOCK, specify how long the document should be locked
- mode (str) – Specify whether to lock or unlock the document, or to override an existing lock (default LOCK)
Raises: - AuthenticationFailedException – on 401
- ValidationFailedException – on 412
- Exception – on 423
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 380, “limit”: 876, “responseCode”: 200, “count”: 93, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Space focus discover probably out think road.”, “messageTemplate”: “Point push before fund walk.”, “field”: “Message effect after whatever news true bit the.”, “parameter”: {}, “timestamp”: 406993767}], “currentPage”: 24, “size”: 440}
-
api.documents.v1.document.document.
revoke_document_access
(documentID: int, accessID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Revoke specified explicit access from document (PUBLIC)
Return type: dict
Parameters: - documentID (int) – Document ID
- accessID (int) – Access ID
Raises: - AuthenticationFailedException – on 401
- ValidationFailedException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 449, “limit”: 32, “responseCode”: 200, “count”: 906, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Approach everybody speech wonder.”, “messageTemplate”: “Remember past marriage born raise strong condition tough.”, “field”: “Together point memory standard common wish close.”, “parameter”: {}, “timestamp”: 261686376}], “currentPage”: 955, “size”: 225}
-
api.documents.v1.document.document.
update_document
(documentID: int, name: str = None, mimeType: str = None, data: str = None, text: str = None, lockRequestTime: int = 300000, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Update specified document (PUBLIC)
Return type: dict
Parameters: - documentID (int) – ID of document to update
- name (str) – If set change document name => Sanitize by regex [a-zA-Z0-9ÅåØøÆæ_-. ]*
- mimeType (str) – If set change document MIME type
- data (str) – Base64 encoded document content formatted according to the given MIME type. If set change document content
- text (str) – Plain text document content. If set change document content
- lockRequestTime (int) – Specify how long the document should be locked (default 300000)
Raises: - AuthenticationFailedException – on 401
- ValidationFailedException – on 412
- Exception – on 423
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 422, “limit”: 995, “responseCode”: 200, “count”: 705, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Here traditional think table experience writer person.”, “messageTemplate”: “About road trip body.”, “field”: “Television research husband place.”, “parameter”: {}, “timestamp”: 1394968954}], “currentPage”: 400, “size”: 405}
-
api.documents.v1.document.document.
update_document_access_settings
(documentID: int, accessMode: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Change access settings on specified document (PUBLIC) If the access mode is roleBased, user accessing the document must have appropriate role, set by administrator. If the access mode is writeRestricted, user accessing the document can read, but must have appropriate role for write, set by administrator. If the access mode is readRestricted, user accessing the document must have appropriate roles for both read and write, set by administrator. If the access mode is explicit, user accessing the document must have explicit grant by document’s owner.
Return type: dict