Files
simstudioai--sim/apps/sim/tools/microsoft_dataverse/update_multiple.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

115 lines
3.7 KiB
TypeScript

import { createLogger } from '@sim/logger'
import type {
DataverseUpdateMultipleParams,
DataverseUpdateMultipleResponse,
} from '@/tools/microsoft_dataverse/types'
import { getDataverseBaseUrl } from '@/tools/microsoft_dataverse/utils'
import type { ToolConfig } from '@/tools/types'
const logger = createLogger('DataverseUpdateMultiple')
export const dataverseUpdateMultipleTool: ToolConfig<
DataverseUpdateMultipleParams,
DataverseUpdateMultipleResponse
> = {
id: 'microsoft_dataverse_update_multiple',
name: 'Update Multiple Microsoft Dataverse Records',
description:
'Update multiple records of the same table type in a single request. Each record must include its primary key. Only include columns that need to be changed. Recommended batch size: 100-1000 records.',
version: '1.0.0',
oauth: { required: true, provider: 'microsoft-dataverse' },
errorExtractor: 'nested-error-object',
params: {
accessToken: {
type: 'string',
required: true,
visibility: 'hidden',
description: 'OAuth access token for Microsoft Dataverse API',
},
environmentUrl: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Dataverse environment URL (e.g., https://myorg.crm.dynamics.com)',
},
entitySetName: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Entity set name (plural table name, e.g., accounts, contacts)',
},
entityLogicalName: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description:
'Table logical name for @odata.type annotation (e.g., account, contact). Used to set Microsoft.Dynamics.CRM.{entityLogicalName} on each record.',
},
records: {
type: 'object',
required: true,
visibility: 'user-or-llm',
description:
'Array of record objects to update. Each record must include its primary key (e.g., accountid) and only the columns being changed. The @odata.type annotation is added automatically.',
},
},
request: {
url: (params) => {
const baseUrl = getDataverseBaseUrl(params.environmentUrl)
return `${baseUrl}/api/data/v9.2/${params.entitySetName.trim()}/Microsoft.Dynamics.CRM.UpdateMultiple`
},
method: 'POST',
headers: (params) => ({
Authorization: `Bearer ${params.accessToken}`,
'Content-Type': 'application/json',
'OData-MaxVersion': '4.0',
'OData-Version': '4.0',
Accept: 'application/json',
}),
body: (params) => {
let records = params.records
if (typeof records === 'string') {
try {
records = JSON.parse(records)
} catch {
throw new Error('Invalid JSON format for records array')
}
}
if (!Array.isArray(records)) {
throw new Error('Records must be an array of objects')
}
const entityLogicalName = params.entityLogicalName.trim()
const targets = records.map((record: Record<string, unknown>) => ({
...record,
'@odata.type': `Microsoft.Dynamics.CRM.${entityLogicalName}`,
}))
return { Targets: targets }
},
},
transformResponse: async (response: Response) => {
if (!response.ok) {
const errorData = await response.json().catch(() => ({}))
const errorMessage =
errorData?.error?.message ??
`Dataverse API error: ${response.status} ${response.statusText}`
logger.error('Dataverse update multiple failed', { errorData, status: response.status })
throw new Error(errorMessage)
}
return {
success: true,
output: {
success: true,
},
}
},
outputs: {
success: { type: 'boolean', description: 'Whether all records were updated successfully' },
},
}