space

Autogenerated API

argus_api.lib.documents.v1.space.get_available_spaces(keywords: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict

List available document spaces (PUBLIC)

Parameters

• keywords (list) – Limit results to spaces where the name (currently: customer name) matches given keywords

• limit (int) – Maximum number of returned results

• offset (int) – Skip a number of results

• json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

• verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

• apiKey – Argus API key.

• authentication – authentication override

• server_url – API base URL override

• body – body of the request. other parameters will override keys defined in the body.

• api_session – session to use for this request. If not set, the global session will be used.

Raises

• AuthenticationFailedException – on 401

• AccessDeniedException – on 403

• ValidationFailedException – on 412

• ArgusException – on other status codes

Returns

dictionary translated from JSON