isogeo_pysdk.models.format module

Isogeo API v1 - Model of Format entity

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

class isogeo_pysdk.models.format.Format(_id: str = None, _tag: str = None, aliases: list = None, code: str = None, name: str = None, type: str = None, versions: list = None)[source]

Bases: object

Formats are entities included as subresource into metadata for data history code.

Example:
{
    "_id": string (uuid),
    "_tag": "format:dgn",
    "aliases": [
        "dgnv7",
        "dgnv8",
        "igds"
    ],
    "code": "dgn",
    "name": "DGN",
    "type": "dataset",
    "versions": [
        "v8",
        "V7",
        null
    ]
}
aliases

Gets the aliases of this Format.

Returns:The aliases of this Format.
Return type:list
attr_crea = {'aliases': <class 'list'>, 'code': <class 'str'>, 'name': <class 'str'>, 'type': <class 'str'>, 'versions': <class 'list'>}
attr_map = {}
attr_types = {'_id': <class 'str'>, '_tag': <class 'str'>, 'aliases': <class 'list'>, 'code': <class 'str'>, 'name': <class 'str'>, 'type': <class 'str'>, 'versions': <class 'list'>}
code

Gets the code of this Format.

Returns:The code of this Format.
Return type:str
name

Gets the name of this Format.

Returns:The name of this Format.
Return type:str
to_dict() → dict[source]

Returns the model properties as a dict

to_dict_creation() → dict[source]

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

to_str() → str[source]

Returns the string representation of the model

type

Gets the type of this Format.

Returns:The type of this Format.
Return type:str
versions

Gets the versions of this Format.

Returns:The versions of this Format.
Return type:list