HomeGuidesAPI ReferenceChangelog
Log In
API Reference

ScriptConfig

a script config defines execution properties for a specific script.
usually to define how a pipeline should call your script.

Attributes

NameTypeDescription
functionstrname of function referencing the script.
propertiesdictspecific properties to configure the script.
properties_mappingdictmapping used to rename properties from context to script expected name.

Methods

api_id()

return current object id on Web API format.

api_key()

return current object logical unique key (e.g. hardware_id, key, name).

returns None if the entity has no logical key.

endpoint()

return endpoint name used to contact backend.

from_json()

load the object from a dict originating of a JSON format.

NameTypeDefaultDescription
objobject to load information from.

infer_script_type()

Return explicit script_type if set, otherwise infer from convention:

  • function starts with "wizata." -> LIBRARY_WIZATA

  • library field is set -> LIBRARY_CUSTOM

  • else -> API

Note: RAW cannot be inferred; must be set explicitly.

set_id()

specify the id_value neutrally

NameTypeDefaultDescription
id_value
return:

to_json()

transform current object into a dict that could be JSONIFY.

NameTypeDefaultDescription
targetstrNone
return: dumpable dict.