Approach

create_approach(self, name: str = None, description: str = None, icon: str = None, color: str = None) ApproachUtilities

Returns WKC Model usecase approache. Supported for CPD version >=4.7.0

Parameters:
  • name (str) – Name of approach

  • description (str) – (Optional) Description of approach

  • icon (str) – (Optional) Approach’s icon Available options are in Icon

  • color (str) – (Optional) Approach’s color,Available options are in Color

Return type:

ApproachUtilities

Returns:

WKC Model usecase approache

Example,:

ai_usecase.create_approach(name=<approach name>,description=<approach description>,icon=<approach icon>,color=<approach color>)
ai_usecase.create_approach(name=<approach name>)
get_approach(self, approach_id: str = None) ApproachUtilities

Returns WKC Model usecase approaches. Supported for CPD version >=4.7.0

Parameters:

approach_id (str) – Approach ID

Return type:

ApproachUtilities

Returns:

Specific WKC Model usecase approache

Example,:

ai_usecase.get_approach(approach_id=<approach_id>)
get_approaches(self) list

Returns list of WKC Model usecase approaches. Supported for CPD version >=4.7.0

Returns:

All WKC Model usecase approaches

Return type:

list(ApproachUtilities)

Example:

ai_usecase.get_approaches()
remove_approach(self, approach: ApproachUtilities = None)

Returns WKC Model usecase removed approache. Supported for CPD version >=4.7.0

Parameters:

approach (ApproachUtilities) – Object or instance of ApproachUtilities

Return type:

None

Returns:

WKC Model usecase approache is removed

Example,:

ai_usecase.remove_approach(approach=ApproachUtilities)
get_versions(self) list

Returns list of WKC Model usecase approache versions. Supported for CPD version >=4.7.0

Returns:

All WKC Model usecase approache versions

Return type:

list

Example.:

ai_usecase.get_approach.get_versions()
set_name(self, name: str = None)

Returns WKC Model usecase updated approach. Supported for CPD version >=4.7.0

Parameters:

name (str) – New name for approach

Return type:

ApproachUtilities

Returns:

WKC Model usecase approache is updated

Example,:

ai_usecase.get_approach.set_name(name=<new approach name>)
get_description(self) str

Returns approach description

Returns:

Approach description

Return type:

str

Example,:

ai_usecase.get_approach.get_description()
set_description(self, description: str = None)

Returns WKC Model usecase updated approach. Supported for CPD version >=4.7.0

Parameters:

description (str) – New description for approach

Return type:

ApproachUtilities

Returns:

WKC Model usecase approache is updated

Example,:

ai_usecase.get_approach.set_description(description=<new approach description>)
get_name(self) str

Returns model approach name

Returns:

Model approach name

Return type:

str

Example,:

ai_usecase.get_approach.get_name()
get_id(self) str

Returns approach ID

Returns:

Approach ID

Return type:

str

Example,:

ai_usecase.get_approach.get_id()
get_model_useacse_id(self) str

Returns model usecase asset ID to which approach is defined

Returns:

Model usecase asset ID to which approach is defined

Return type:

str

Example,:

model_usecase.get_approach.get_model_useacse_id()
get_model_usecase_container_type(self) str

Returns model usecase container type to which approach is defined

Returns:

Model usecase container type to which approach is defined

Return type:

str

Example,:

model_usecase.get_approach.get_model_usecase_container_type()
get_model_usecase_container_id(self) str

Returns model usecase container ID to which approach is defined

Returns:

Model usecase container ID to which approach is defined

Return type:

str

Example,:

model_usecase.get_approach.get_model_usecase_container_id()