Lesson 2: Facts
These code samples provide a basic introduction on setting and getting Facts on entities. For an in-depth description of Facts and their role in Avial modeling, please visit our wiki <https://docs.ledr.io/en/the-orchestra-platfrom/avial-model#facts>
Set Facts on Person Entity
- module.utils.set_person_facts.set_person_facts(person_entity: AvEntity, name: str, address: str, occupation: str, company: str, auth: AvAuthorization)[source]
This function shows how to add a few Facts to an existing person entity. It’s probably obvious that a person can have one or more facts.
- Parameters:
person_entity – The entity ID of the person entity to add the facts.
name – The Person’s name
address – Person’s address
occupation – Person’s occupation
company – Person’s company
auth – The Orchestra server authorization that allows entity operations.
Set Facts on Company Entity
- module.utils.set_company_facts.set_company_facts(company_entity: AvEntity, name: str, address: str, employee: str, auth: AvAuthorization)[source]
This function shows how to add a few Facts to an existing company entity. It’s probably obvious that a company can have one or more facts.
- Parameters:
employee – Company employee
company_entity – The entity ID of the company entity to add the facts.
name – Company Name
address – Company Address
auth – The Orchestra server authorization that allows entity operations.
How to get Facts From Entities
- module.utils.how_to_get_facts_from_entities.examples_of_get_facts_by_brute_force(entity: AvEntity, auth: AvAuthorization)[source]
This function shows how to get facts from an entity, by specifying which attributes you want to get.
- Parameters:
entity – The entity ID of the entity to get the facts.
auth – The Orchestra server authorization that allows entity operations.
- module.utils.how_to_get_facts_from_entities.examples_of_get_facts_by_retrieve(entity: AvEntity, auth: AvAuthorization)[source]
This function shows how to get facts from an entity. Its extremely helpful when you don’t actually know what facts are in an entity or need to iterate though the facts.
- Parameters:
entity – The entity ID of the entity to get the facts.
auth – The Orchestra server authorization that allows entity operations.