Skip to main content

Foundation Functions

Each module supports a variety of functions for querying, modifying and extracting model data. These functions are specific to each module and customized for the type of operations relevant to the associated models.

Detailed SDK Usage​

Prerequisite: Install Istari SDK and initialize Istari Client per instructions here​

Example: General model extraction function​

Demonstrates extraction of standard model data from a 3DExperience model​

extraction_job = client.add_job(
    model_id  = model.id,
    function  = "@istari:extract",
    tool_name = "dassault_3dexperience",
    tool_version = "2023x",
    operating_system = "Windows 11",
)
print(f"Extraction started for model ID {model.id}, job ID: {extraction_job.id}")

Example: List model parameters​

List all (model and user) parameters in a 3DExperience model​

This example demonstrates calling a module function that requires input parameters

job = client.add_job(
    model_id = model.id,
    function = "@istari:extract_parameters",
    tool_name = "dassault_3dexperience",
    tool_version = "2023x",
    operating_system = "Windows 11",
    parameters = '{"full_extract": true}'
)

Example: Check a job status​

Wait for a specified job to finish and print job status​

extraction_job.poll_job()