isogeo_pysdk.models.keyword module

Isogeo API v1 - Model of Keyword entity

See: http://help.isogeo.com/api/complete/index.html#definition-keyword

class isogeo_pysdk.models.keyword.Keyword(_abilities=None, _created=None, _id=None, _modified=None, _tag=None, code=None, count=None, description=None, thesaurus=None, text=None)

Bases: object

Keywords are entities used to organize and shares metadata of a workgroup.

Example

{
    '_abilities': [
        'keyword:delete',
        'keyword:restrict'
        ],
    '_created': None,
    '_id': 'ac56a9fbe6f348a79ec9899ebce2d6da',
    '_modified': None,
    '_tag': 'keyword:isogeo:tests-unitaires',
    'code': 'tests-unitaires',
    'count': {
        'isogeo': 0
        },
    'description': None,
    'text': 'tests unitaires',
    'thesaurus': {
        '_id': '1616597fbc4348c8b11ef9d59cf594c8',
        'code': 'isogeo'
        }
}

ATTR_CREA = {'text': <class 'str'>}

ATTR_MAP = {}

ATTR_TYPES = {'_abilities': <class 'list'>, '_created': <class 'str'>, '_id': <class 'str'>, '_modified': <class 'str'>, '_tag': <class 'str'>, 'code': <class 'str'>, 'count': <class 'dict'>, 'description': <class 'str'>, 'text': <class 'str'>, 'thesaurus': <class 'isogeo_pysdk.models.thesaurus.Thesaurus'>}

property code: str

Gets the code of this Keyword.

Returns: The code of this Keyword.
Return type: str

property count: dict

Gets the count of this Keyword.

Returns: The count of this Keyword.
Return type: dict

property description: str

Gets the description of this Keyword.

Returns: The description of this Keyword.
Return type: str

property text: bool

Gets the text of this Keyword.

Returns: The text of this Keyword.
Return type: bool

property thesaurus

Gets the thesaurus of this Keyword. # noqa: E501.

Returns: The thesaurus of this Keyword. # noqa: E501
Return type: Thesaurus

to_dict()

Returns the model properties as a dict.

Return type: dict

to_dict_creation()

Returns the model properties as a dict structured for creation purpose (POST)

Return type: dict

to_str()

Returns the string representation of the model.

Return type: str