generate_webapi_call
Generate HTTP requests, curl commands, and JavaScript examples for Dataverse WebAPI operations including CRUD operations, associations, actions, and functions with proper OData query parameters and headers.
Instructions
Generate HTTP requests, curl commands, and JavaScript examples for Dataverse WebAPI operations. Supports all CRUD operations, associations, actions, and functions with proper OData query parameters and headers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| actionOrFunctionName | No | Name of the action or function to call | |
| callerId | No | MSCRMCallerID header for impersonation | |
| count | No | Include count of records | |
| data | No | Data to send in request body for create/update operations | |
| entityId | No | Entity ID for single record operations | |
| entitySetName | No | Entity set name or logical entity name (e.g., 'account', 'contact') - will be automatically suffixed with 's' for Dataverse API URLs | |
| expand | No | Related entities to expand | |
| filter | No | OData filter expression | |
| ifMatch | No | If-Match header for conditional updates | |
| ifNoneMatch | No | If-None-Match header | |
| includeAuthHeader | No | Include Authorization header placeholder in output | |
| includeSolutionContext | No | Include current solution context in headers | |
| operation | Yes | Type of operation to perform | |
| orderby | No | OData orderby expression | |
| parameters | No | Parameters for action/function calls | |
| prefer | No | Prefer header values (e.g., ['return=representation', 'odata.include-annotations=*']) | |
| relatedEntityId | No | Related entity ID for associations | |
| relatedEntitySetName | No | Related entity set name for associations | |
| relationshipName | No | Relationship name for associate/disassociate operations | |
| select | No | Fields to select (e.g., ['name', 'emailaddress1']) | |
| skip | No | Number of records to skip | |
| top | No | Number of records to return |
Input Schema (JSON Schema)
{
"properties": {
"actionOrFunctionName": {
"description": "Name of the action or function to call",
"type": "string"
},
"callerId": {
"description": "MSCRMCallerID header for impersonation",
"type": "string"
},
"count": {
"description": "Include count of records",
"type": "boolean"
},
"data": {
"additionalProperties": {},
"description": "Data to send in request body for create/update operations",
"type": "object"
},
"entityId": {
"description": "Entity ID for single record operations",
"type": "string"
},
"entitySetName": {
"description": "Entity set name or logical entity name (e.g., 'account', 'contact') - will be automatically suffixed with 's' for Dataverse API URLs",
"type": "string"
},
"expand": {
"description": "Related entities to expand",
"type": "string"
},
"filter": {
"description": "OData filter expression",
"type": "string"
},
"ifMatch": {
"description": "If-Match header for conditional updates",
"type": "string"
},
"ifNoneMatch": {
"description": "If-None-Match header",
"type": "string"
},
"includeAuthHeader": {
"default": false,
"description": "Include Authorization header placeholder in output",
"type": "boolean"
},
"includeSolutionContext": {
"default": true,
"description": "Include current solution context in headers",
"type": "boolean"
},
"operation": {
"description": "Type of operation to perform",
"enum": [
"retrieve",
"retrieveMultiple",
"create",
"update",
"delete",
"associate",
"disassociate",
"callAction",
"callFunction"
],
"type": "string"
},
"orderby": {
"description": "OData orderby expression",
"type": "string"
},
"parameters": {
"additionalProperties": {},
"description": "Parameters for action/function calls",
"type": "object"
},
"prefer": {
"description": "Prefer header values (e.g., ['return=representation', 'odata.include-annotations=*'])",
"items": {
"type": "string"
},
"type": "array"
},
"relatedEntityId": {
"description": "Related entity ID for associations",
"type": "string"
},
"relatedEntitySetName": {
"description": "Related entity set name for associations",
"type": "string"
},
"relationshipName": {
"description": "Relationship name for associate/disassociate operations",
"type": "string"
},
"select": {
"description": "Fields to select (e.g., ['name', 'emailaddress1'])",
"items": {
"type": "string"
},
"type": "array"
},
"skip": {
"description": "Number of records to skip",
"type": "number"
},
"top": {
"description": "Number of records to return",
"type": "number"
}
},
"required": [
"operation"
],
"type": "object"
}