isogeo_pysdk.api.routes_application module

Isogeo API v1 - API Routes for Applications entities

See: http://help.isogeo.com/api/complete/index.html

class isogeo_pysdk.api.routes_application.ApiApplication(api_client=None)[source]

Bases: object

Routes as methods of Isogeo API used to manipulate applications.

associate_group(application: isogeo_pysdk.models.application.Application, workgroup: isogeo_pysdk.models.workgroup.Workgroup, force: bool = 0) → tuple[source]

Associate a application with a workgroup.

Parameters:
  • application (Application) – Application model object to update
  • workgroup (Workgroup) – object to associate
  • force (bool) – option to force association with multiple groups changing the canHaveManyGroups property
create(application: object = {'_abilities': None, '_created': None, '_id': None, '_modified': None, 'canHaveManyGroups': None, 'client_id': None, 'client_secret': None, 'groups': [None], 'kind': None, 'name': None, 'redirect_uris': [None], 'scopes': [None], 'staff': None, 'type': None, 'url': None}, check_exists: int = 1) → isogeo_pysdk.models.application.Application[source]

Add a new application to Isogeo.

Parameters:check_exists (int) – check if a application already exists inot the workgroup:
  • 0 = no check
  • 1 = compare name [DEFAULT]
Parameters:application (class) – Application model object to create
delete(application_id: str)[source]

Delete a application from Isogeo database.

Parameters:application_id (str) – identifier of the resource to delete
dissociate_group(application: isogeo_pysdk.models.application.Application, workgroup: isogeo_pysdk.models.workgroup.Workgroup) → tuple[source]

Removes the association between the specified group and the specified application.

Parameters:
  • application (Application) – Application model object to update
  • workgroup (Workgroup) – object to associate
exists(application_id: str) → bool[source]

Check if the specified application exists and is available for the authenticated user.

Parameters:application_id (str) – identifier of the application to verify
get(application_id: str, include: tuple = ('_abilities', 'groups')) → isogeo_pysdk.models.application.Application[source]

Get details about a specific application.

Parameters:
  • application_id (str) – application UUID
  • include (tuple) – additionnal subresource to include in the response
listing[source]

Get all applications which are accessible by the authenticated user OR applications for a workgroup.

Parameters:
  • workgroup_id (str) – identifier of the owner workgroup. If None, then list applications for the autenticated user
  • include (tuple) – additionnal subresource to include in the response.
  • caching (bool) – option to cache the response
update(application: isogeo_pysdk.models.application.Application, caching: bool = 1) → isogeo_pysdk.models.application.Application[source]

Update a application owned by a workgroup.

Parameters:
  • application (class) – Application model object to update
  • caching (bool) – option to cache the response
workgroups[source]

Get all groups associated with an application.

Parameters:application_id (str) – identifier of the application