Using Object Group Permission General module¶
Assuming that you have Client Factory instantiated (see How to Instantiate Client Factory) at client variable, in order to access methods relative to Object Group Permission General module you need to call create_api_object_group_permission_general() at client.
Example:
ogpg_module = client.create_api_object_group_permission_general()
For more information, please look GloboNetworkAPI documentation.
GET¶
The List of fields available at Object Group Permission General module is:
- id
- user_group
- object_type
- read
- write
- change_config
- delete
Obtain List of Object Group Permissions General through id’s¶
Here you need to call get() method at ogpg_module.
- You can pass up to 5 parameters:
- ids: List containing identifiers of Object Group Permissions General.
- include: Array containing fields to include on response.
- exclude: Array containing fields to exclude on response.
- fields: Array containing fields to override default fields.
- kind: string where you can choose between “basic” or “details”.
The response will be a dict with a list of Object Group Permissions General.
Examples:
ogpgs = ogpg_module.get(ids=[1, 2, 3])
ogpgs = ogpg_module.get(ids=[1, 2, 3],
include=['read'],
exclude=['write', 'delete'],
kind='basic')
ogpgs = ogpg_module.get(ids=[1, 2, 3],
fields=['id', 'read', 'delete'])
Obtain List of Object Group Permissions General through extended search¶
Here you need to call search() method at ogpg_module.
- You can pass up to 5 parameters:
- search: Dict containing QuerySets to find Object Group Permissions General.
- include: Array containing fields to include on response.
- exclude: Array containing fields to exclude on response.
- fields: Array containing fields to override default fields.
- kind: string where you can choose between “basic” or “details”.
The response will be a dict with a list of Object Group Permissions General.
Example:
search = {
'extends_search': [{
"read": True
}],
'start_record': 0,
'custom_search': '',
'end_record': 25,
'asorting_cols': [],
'searchable_columns': []}
fields = ['id', 'user_group', 'read']
ogpgs = ogpg_module.search(search=search, fields=fields)
POST¶
The List of fields available for create an Object Group Permission General is:
- user_group - Mandatory
- object_type - Mandatory
- read - Mandatory
- write - Mandatory
- change_config - Mandatory
- delete - Mandatory
Create List of Object Group Permissions General¶
Here you need to call create() method at ogpg_module.
- You need to pass 1 parameter:
- ogpgs: List containing Object Group Permissions General that you want to create.
Example:
ogpgs_to_create = [
{
"user_group": 1,
"object_type": 2,
"read": True,
"write": True,
"change_config": True,
"delete": False
},
{
"user_group": 1,
"object_type": 2,
"read": True,
"write": True,
"change_config": True,
"delete": False
}
]
ogpg_module.create(ogpgs=ogpgs_to_create)
PUT¶
The List of fields available for update an Object Group Permission General is:
- id - Mandatory
- read
- write
- change_config
- delete
Update List of Object Group Permissions General¶
Here you need to call update() method at ogpg_module.
- You need to pass 1 parameter:
- ogpgs: List containing Object Group Permissions General that you want to update.
Example:
ogpgs_to_update = [
{
"id": 1,
"read": False,
"write": False,
"change_config": True,
"delete": False
},
{
"id": 2,
"read": False,
"write": False,
"change_config": True,
"delete": False
}
]
ogpg_module.update(ogpgs=ogpgs_to_update)