d365fo-client: Command for GitHub Copilot

OData Action Implementation Prompt

You are a Python developer working on the d365fo-client package. Your task is to implement a method for calling an OData action in Microsoft Dynamics 365 Finance & Operations. Follow these steps systematically:

Step 1: Search and Analyze Action Metadata

First, search the metadata to find details about the OData action:

# Search for the action in the metadata
action_info = client.get_action_info("ActionName")

# If not found in cached metadata, search in PublicEntities
entity_info = await client.get_public_entity_info("EntityName")
if entity_info and entity_info.actions:
    action_info = next((a for a in entity_info.actions if a.name == "ActionName"), None)

Step 2: Determine Action Binding Type

Analyze if the action is:

• Static Action: Not bound to any entity (is_bound=False or binding_kind="")
• Entity Bound: Bound to a single entity instance (binding_kind="Entity")
• Collection Bound: Bound to an entity set (binding_kind="Collection")

if action_info.binding_kind == "Entity":
    # Entity-bound action - requires entity key
    binding_type = "entity"
elif action_info.binding_kind == "Collection":
    # Collection-bound action - operates on entity set
    binding_type = "collection"
else:
    # Static action - no binding required
    binding_type = "static"

Step 3: Analyze Parameters and Return Type

Extract parameter information and return type:

# Analyze parameters
parameters = []
for param in action_info.parameters:
    param_info = {
        'name': param.name,
        'type': param.type.type_name,
        'is_collection': param.type.is_collection,
        'is_optional': False  # Determine from metadata
    }
    parameters.append(param_info)

# Analyze return type
return_type = None
if action_info.return_type:
    return_type = {
        'type': action_info.return_type.type_name,
        'is_collection': action_info.return_type.is_collection
    }