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:
Returns:

{“offset”: 870, “limit”: 838, “responseCode”: 200, “count”: 250, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Sell image through station.”, “messageTemplate”: “Him attack approach account performance.”, “field”: “Police defense expert available peace along management particularly.”, “parameter”: {}, “timestamp”: 407418671}], “currentPage”: 101, “size”: 517}

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:
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:
Returns:

{“offset”: 449, “limit”: 247, “responseCode”: 200, “count”: 554, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Federal growth history car.”, “messageTemplate”: “Different popular method affect smile thousand.”, “field”: “Prove statement charge go dinner glass.”, “parameter”: {}, “timestamp”: 547684035}], “currentPage”: 231, “size”: 588}

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:
Returns:

{“offset”: 582, “limit”: 511, “responseCode”: 200, “count”: 111, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Create know relationship show.”, “messageTemplate”: “Civil born per candidate big quality threat.”, “field”: “From summer clearly teacher.”, “parameter”: {}, “timestamp”: 933090053}], “currentPage”: 885, “size”: 439}

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:
Returns:

{“offset”: 763, “limit”: 702, “responseCode”: 200, “count”: 473, “data”: [{“id”: 134, “subject”: {“id”: 172, “customerID”: 907, “name”: “Rachel Herrera”}, “level”: “write”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Example side land story war century newspaper address.”, “messageTemplate”: “Unit surface without meet.”, “field”: “International condition rest mouth might evidence.”, “parameter”: {}, “timestamp”: 1368491158}], “currentPage”: 958, “size”: 396}

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:
Returns:

{“offset”: 402, “limit”: 20, “responseCode”: 200, “count”: 146, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Both strategy real high sell throw old wide.”, “messageTemplate”: “Stock country item space how billion build anything.”, “field”: “Represent professional born.”, “parameter”: {}, “timestamp”: 1443897217}], “currentPage”: 67, “size”: 98}

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:
Returns:

{“offset”: 319, “limit”: 503, “responseCode”: 200, “count”: 950, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Degree size that.”, “messageTemplate”: “Thought doctor item there continue.”, “field”: “Similar both gas develop several outside ground blue.”, “parameter”: {}, “timestamp”: 1180308702}], “currentPage”: 818, “size”: 931}

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:
Returns:

{“offset”: 914, “limit”: 974, “responseCode”: 200, “count”: 831, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Lot later leader increase.”, “messageTemplate”: “Guy after edge court face interview.”, “field”: “Have manage may identify line.”, “parameter”: {}, “timestamp”: 845500974}], “currentPage”: 89, “size”: 977}

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

Module contents