or run

npx @tessl/cli init
Log in

Version

Tile

Overview

Evals

Files

Files

docs

batch-processing.mdconfiguration-utilities.mdcrm-actions-functions.mdcrud-operations.mdentity-associations.mdindex.md

crm-actions-functions.mddocs/

0

# CRM Actions and Functions

1

2

Execute pre-implemented CRM actions and functions, or create custom request objects for operations not available through standard CRUD operations. The library includes 200+ pre-implemented system actions covering business processes, security, data management, and specialized CRM operations.

3

4

## Capabilities

5

6

### Execute Function

7

8

Executes CRM actions, functions, or custom operations with automatic URL building and parameter handling.

9

10

```typescript { .api }

11

/**

12

* Execute a CRM action, function, or custom operation

13

* @param request - Request object containing operation details

14

* @returns Promise resolving to the operation result

15

*/

16

function Execute(request: object): Promise<any> | any | BatchRequest;

17

```

18

19

### Base Request Class

20

21

Foundation for all CRM request objects with parameter override capabilities.

22

23

```typescript { .api }

24

/**

25

* Base class for all CRM request operations

26

*/

27

class Request implements RequestParameters {

28

/** HTTP method (GET, POST, etc.) */

29

method?: string;

30

/** Action or function name */

31

name?: string;

32

/** Whether the operation is bound to a specific entity record */

33

bound?: boolean;

34

/** Target entity logical name for bound operations */

35

entityName?: string;

36

/** Target entity record ID for bound operations */

37

entityId?: string;

38

/** Request payload for POST operations */

39

payload?: object;

40

/** Request-specific headers */

41

headers?: Array<Header>;

42

/** URL parameters for parameterized operations */

43

urlParams?: object;

44

/** Override async setting */

45

async?: boolean;

46

47

/**

48

* Create a new request with overridden parameters

49

* @param param - Parameters to override

50

* @returns New request instance with merged parameters

51

*/

52

with(param: RequestParameters): this;

53

}

54

55

interface RequestParameters extends BaseParameters {

56

method?: string;

57

name?: string;

58

bound?: boolean;

59

entityName?: string;

60

entityId?: string;

61

payload?: object;

62

urlParams?: object;

63

}

64

```

65

66

## System Information Requests

67

68

### Current User and System Information

69

70

```typescript { .api }

71

/** Get current user information */

72

class WhoAmIRequest extends Request { }

73

74

/** Get CRM version information */

75

class RetrieveVersionRequest extends Request { }

76

77

/** Get current organization information */

78

class RetrieveCurrentOrganizationRequest extends Request { }

79

```

80

81

**Usage Examples:**

82

83

```typescript

84

// Get current user info

85

const userInfo = await WebApiClient.Execute(WebApiClient.Requests.WhoAmIRequest);

86

console.log("User ID:", userInfo.UserId);

87

console.log("Organization ID:", userInfo.OrganizationId);

88

89

// Get CRM version

90

const version = await WebApiClient.Execute(WebApiClient.Requests.RetrieveVersionRequest);

91

console.log("Version:", version.Version);

92

93

// Get organization details

94

const orgInfo = await WebApiClient.Execute(WebApiClient.Requests.RetrieveCurrentOrganizationRequest);

95

```

96

97

### Security and Access Requests

98

99

```typescript { .api }

100

/** Retrieve user privileges */

101

class RetrieveUserPrivilegesRequest extends Request { }

102

103

/** Retrieve team privileges */

104

class RetrieveTeamPrivilegesRequest extends Request { }

105

106

/** Retrieve principal access rights */

107

class RetrievePrincipalAccessRequest extends Request { }

108

109

/** Add privileges to a security role */

110

class AddPrivilegesRoleRequest extends Request { }

111

112

/** Remove privileges from a security role */

113

class RemovePrivilegeRoleRequest extends Request { }

114

115

/** Replace all privileges for a security role */

116

class ReplacePrivilegesRoleRequest extends Request { }

117

```

118

119

**Usage Examples:**

120

121

```typescript

122

// Get user privileges

123

const userPrivileges = await WebApiClient.Execute(

124

WebApiClient.Requests.RetrieveUserPrivilegesRequest.with({

125

entityId: "user-guid-here"

126

})

127

);

128

129

// Get access rights for a record

130

const accessRights = await WebApiClient.Execute(

131

WebApiClient.Requests.RetrievePrincipalAccessRequest.with({

132

payload: {

133

Target: {

134

"@odata.type": "Microsoft.Dynamics.CRM.account",

135

accountid: "account-guid-here"

136

},

137

Principal: {

138

"@odata.type": "Microsoft.Dynamics.CRM.systemuser",

139

systemuserid: "user-guid-here"

140

}

141

}

142

})

143

);

144

```

145

146

## Business Process Requests

147

148

### Lead Management

149

150

```typescript { .api }

151

/** Qualify a lead into account, contact, and/or opportunity */

152

class QualifyLeadRequest extends Request { }

153

154

/** Convert lead to different entities */

155

class ConvertLeadRequest extends Request { }

156

```

157

158

### Opportunity Management

159

160

```typescript { .api }

161

/** Win an opportunity */

162

class WinOpportunityRequest extends Request { }

163

164

/** Lose an opportunity */

165

class LoseOpportunityRequest extends Request { }

166

167

/** Calculate actual value of opportunity */

168

class CalculateActualValueOpportunityRequest extends Request { }

169

170

/** Generate quote from opportunity */

171

class GenerateQuoteFromOpportunityRequest extends Request { }

172

173

/** Generate sales order from opportunity */

174

class GenerateSalesOrderFromOpportunityRequest extends Request { }

175

176

/** Generate invoice from opportunity */

177

class GenerateInvoiceFromOpportunityRequest extends Request { }

178

```

179

180

**Usage Examples:**

181

182

```typescript

183

// Qualify a lead

184

const qualifyResult = await WebApiClient.Execute(

185

WebApiClient.Requests.QualifyLeadRequest.with({

186

entityId: "lead-guid-here",

187

payload: {

188

CreateAccount: true,

189

CreateContact: true,

190

CreateOpportunity: true,

191

Status: 3 // Qualified

192

}

193

})

194

);

195

196

// Win an opportunity

197

await WebApiClient.Execute(

198

WebApiClient.Requests.WinOpportunityRequest.with({

199

entityId: "opportunity-guid-here",

200

payload: {

201

Status: 3,

202

OpportunityClose: {

203

subject: "Won the deal!",

204

actualrevenue: 50000,

205

"opportunityid@odata.bind": "/opportunities(" + opportunityId + ")"

206

}

207

}

208

})

209

);

210

```

211

212

### Case Management

213

214

```typescript { .api }

215

/** Close an incident/case */

216

class CloseIncidentRequest extends Request { }

217

218

/** Calculate total time for an incident */

219

class CalculateTotalTimeIncidentRequest extends Request { }

220

```

221

222

### Sales Process

223

224

```typescript { .api }

225

/** Convert quote to sales order */

226

class ConvertQuoteToSalesOrderRequest extends Request { }

227

228

/** Convert sales order to invoice */

229

class ConvertSalesOrderToInvoiceRequest extends Request { }

230

231

/** Fulfill a sales order */

232

class FulfillSalesOrderRequest extends Request { }

233

234

/** Cancel a sales order */

235

class CancelSalesOrderRequest extends Request { }

236

237

/** Lock/unlock invoice pricing */

238

class LockInvoicePricingRequest extends Request { }

239

class UnlockInvoicePricingRequest extends Request { }

240

```

241

242

## Data Management Requests

243

244

### Bulk Operations

245

246

```typescript { .api }

247

/** Bulk delete records */

248

class BulkDeleteRequest extends Request { }

249

250

/** Bulk detect duplicates */

251

class BulkDetectDuplicatesRequest extends Request { }

252

253

/** Import records */

254

class ImportRecordsImportRequest extends Request { }

255

```

256

257

### Entity Management

258

259

```typescript { .api }

260

/** Retrieve all entities */

261

class RetrieveAllEntitiesRequest extends Request { }

262

263

/** Retrieve entity changes */

264

class RetrieveEntityChangesRequest extends Request { }

265

266

/** Find duplicate records */

267

class RetrieveDuplicatesRequest extends Request { }

268

269

/** Merge records */

270

class MergeRequest extends Request { }

271

272

/** Initialize record from template */

273

class InitializeFromRequest extends Request { }

274

```

275

276

**Usage Examples:**

277

278

```typescript

279

// Find duplicates

280

const duplicates = await WebApiClient.Execute(

281

WebApiClient.Requests.RetrieveDuplicatesRequest.with({

282

payload: {

283

BusinessEntity: {

284

"@odata.type": "Microsoft.Dynamics.CRM.account",

285

name: "Contoso Corporation"

286

},

287

MatchingEntityName: "account",

288

PagingInfo: {

289

PageNumber: 1,

290

Count: 50

291

}

292

}

293

})

294

);

295

296

// Merge two accounts

297

await WebApiClient.Execute(

298

WebApiClient.Requests.MergeRequest.with({

299

payload: {

300

Target: {

301

"@odata.type": "Microsoft.Dynamics.CRM.account",

302

accountid: "target-account-guid"

303

},

304

Subordinate: {

305

"@odata.type": "Microsoft.Dynamics.CRM.account",

306

accountid: "source-account-guid"

307

},

308

UpdateContent: {

309

name: "Merged Account Name",

310

telephone1: "555-0123"

311

},

312

PerformParentingChecks: false

313

}

314

})

315

);

316

```

317

318

## Workflow and Process Requests

319

320

```typescript { .api }

321

/** Execute a workflow */

322

class ExecuteWorkflowRequest extends Request { }

323

324

/** Set business process flow */

325

class SetProcessRequest extends Request { }

326

327

/** Create workflow from template */

328

class CreateWorkflowFromTemplateRequest extends Request { }

329

```

330

331

**Usage Example:**

332

333

```typescript

334

// Execute a workflow

335

await WebApiClient.Execute(

336

WebApiClient.Requests.ExecuteWorkflowRequest.with({

337

payload: {

338

EntityId: "record-guid-here",

339

WorkflowId: "workflow-guid-here"

340

}

341

})

342

);

343

```

344

345

## Communication Requests

346

347

```typescript { .api }

348

/** Send email */

349

class SendEmailRequest extends Request { }

350

351

/** Send email from template */

352

class SendEmailFromTemplateRequest extends Request { }

353

354

/** Send bulk mail */

355

class SendBulkMailRequest extends Request { }

356

357

/** Send fax */

358

class SendFaxRequest extends Request { }

359

360

/** Deliver incoming email */

361

class DeliverIncomingEmailRequest extends Request { }

362

```

363

364

**Usage Examples:**

365

366

```typescript

367

// Send email

368

await WebApiClient.Execute(

369

WebApiClient.Requests.SendEmailRequest.with({

370

entityId: "email-guid-here",

371

payload: {

372

IssueSend: true

373

}

374

})

375

);

376

377

// Send email from template

378

await WebApiClient.Execute(

379

WebApiClient.Requests.SendEmailFromTemplateRequest.with({

380

payload: {

381

TemplateId: "template-guid-here",

382

RegardingId: "account-guid-here",

383

RegardingType: "account",

384

Target: {

385

"@odata.type": "Microsoft.Dynamics.CRM.systemuser",

386

systemuserid: "user-guid-here"

387

}

388

}

389

})

390

);

391

```

392

393

## Queue Management Requests

394

395

```typescript { .api }

396

/** Add item to queue */

397

class AddToQueueRequest extends Request { }

398

399

/** Pick item from queue */

400

class PickFromQueueRequest extends Request { }

401

402

/** Remove item from queue */

403

class RemoveFromQueueRequest extends Request { }

404

405

/** Release item back to queue */

406

class ReleaseToQueueRequest extends Request { }

407

408

/** Add principal to queue */

409

class AddPrincipalToQueueRequest extends Request { }

410

```

411

412

**Usage Example:**

413

414

```typescript

415

// Add case to queue

416

await WebApiClient.Execute(

417

WebApiClient.Requests.AddToQueueRequest.with({

418

entityId: "queue-guid-here",

419

payload: {

420

Target: {

421

"@odata.type": "Microsoft.Dynamics.CRM.incident",

422

incidentid: "case-guid-here"

423

}

424

}

425

})

426

);

427

```

428

429

## Team and User Management Requests

430

431

```typescript { .api }

432

/** Add members to team */

433

class AddMembersTeamRequest extends Request { }

434

435

/** Remove members from team */

436

class RemoveMembersTeamRequest extends Request { }

437

438

/** Add user to record team */

439

class AddUserToRecordTeamRequest extends Request { }

440

441

/** Remove user from record team */

442

class RemoveUserFromRecordTeamRequest extends Request { }

443

444

/** Convert owner team to access team */

445

class ConvertOwnerTeamToAccessTeamRequest extends Request { }

446

```

447

448

## Solution and Customization Requests

449

450

```typescript { .api }

451

/** Export solution */

452

class ExportSolutionRequest extends Request { }

453

454

/** Import solution */

455

class ImportSolutionRequest extends Request { }

456

457

/** Publish all XML */

458

class PublishAllXmlRequest extends Request { }

459

460

/** Publish XML */

461

class PublishXmlRequest extends Request { }

462

463

/** Add solution component */

464

class AddSolutionComponentRequest extends Request { }

465

466

/** Remove solution component */

467

class RemoveSolutionComponentRequest extends Request { }

468

```

469

470

## Custom Request Creation

471

472

For operations not yet implemented, create custom requests:

473

474

```typescript

475

// Create a custom request

476

WebApiClient.Requests.CustomActionRequest = WebApiClient.Requests.Request.prototype.with({

477

method: "POST",

478

name: "new_CustomAction",

479

bound: true,

480

entityName: "account"

481

});

482

483

// Execute the custom request

484

const result = await WebApiClient.Execute(

485

WebApiClient.Requests.CustomActionRequest.with({

486

entityId: "account-guid-here",

487

payload: {

488

InputParameter1: "value1",

489

InputParameter2: 123

490

}

491

})

492

);

493

494

// Alternative using SendRequest

495

const customResult = await WebApiClient.SendRequest(

496

"POST",

497

WebApiClient.GetApiUrl() + "accounts(" + accountId + ")/Microsoft.Dynamics.CRM.new_CustomAction",

498

{

499

InputParameter1: "value1",

500

InputParameter2: 123

501

}

502

);

503

```

504

505

## Error Handling

506

507

```typescript

508

try {

509

const result = await WebApiClient.Execute(

510

WebApiClient.Requests.WhoAmIRequest

511

);

512

console.log("Success:", result);

513

} catch (error) {

514

if (WebApiClient.PrettifyErrors) {

515

console.error("Formatted error:", error);

516

} else {

517

console.error("Raw error:", JSON.parse(error));

518

}

519

}

520

```

521

522

## Batch Execution

523

524

All requests can be executed in batches:

525

526

```typescript

527

const batch = new WebApiClient.Batch({

528

changeSets: [

529

new WebApiClient.ChangeSet({

530

requests: [

531

WebApiClient.Execute(WebApiClient.Requests.WhoAmIRequest, { asBatch: true }),

532

WebApiClient.Execute(WebApiClient.Requests.RetrieveVersionRequest, { asBatch: true })

533

]

534

})

535

]

536

});

537

538

const batchResults = await WebApiClient.SendBatch(batch);

539

```

540

541

## System and Metadata Requests

542

543

### System Information

544

545

```typescript { .api }

546

/** Get current user information */

547

class WhoAmIRequest extends Request { }

548

549

/** Retrieve CRM version information */

550

class RetrieveVersionRequest extends Request { }

551

552

/** Retrieve current timestamp */

553

class RetrieveTimestampRequest extends Request { }

554

555

/** Get all time zones with display names */

556

class GetAllTimeZonesWithDisplayNameRequest extends Request { }

557

558

/** Get time zone code by localized name */

559

class GetTimeZoneCodeByLocalizedNameRequest extends Request { }

560

561

/** Retrieve available languages */

562

class RetrieveAvailableLanguagesRequest extends Request { }

563

564

/** Retrieve installed language packs */

565

class RetrieveInstalledLanguagePacksRequest extends Request { }

566

567

/** Retrieve current organization information */

568

class RetrieveCurrentOrganizationRequest extends Request { }

569

570

/** Check if data encryption is active */

571

class IsDataEncryptionActiveRequest extends Request { }

572

573

/** Retrieve data encryption key */

574

class RetrieveDataEncryptionKeyRequest extends Request { }

575

```

576

577

### Field and Entity Metadata

578

579

```typescript { .api }

580

/** Calculate rollup field values */

581

class CalculateRollupFieldRequest extends Request { }

582

583

/** Get quantity decimal precision */

584

class GetQuantityDecimalRequest extends Request { }

585

586

/** Get default price level */

587

class GetDefaultPriceLevelRequest extends Request { }

588

589

/** Retrieve all entities metadata */

590

class RetrieveAllEntitiesRequest extends Request { }

591

592

/** Check valid many-to-many relationships */

593

class GetValidManyToManyRequest extends Request { }

594

595

/** Get valid referenced entities */

596

class GetValidReferencedEntitiesRequest extends Request { }

597

598

/** Get valid referencing entities */

599

class GetValidReferencingEntitiesRequest extends Request { }

600

601

/** Check if entity can be referenced */

602

class CanBeReferencedRequest extends Request { }

603

604

/** Check if entity can be referencing */

605

class CanBeReferencingRequest extends Request { }

606

607

/** Check if many-to-many is possible */

608

class CanManyToManyRequest extends Request { }

609

```

610

611

## Retrieve Operations (Extended)

612

613

```typescript { .api }

614

/** Retrieve absolute and site collection URL */

615

class RetrieveAbsoluteAndSiteCollectionUrlRequest extends Request { }

616

617

/** Retrieve active business process path */

618

class RetrieveActivePathRequest extends Request { }

619

620

/** Retrieve all child users for system user */

621

class RetrieveAllChildUsersSystemUserRequest extends Request { }

622

623

/** Retrieve application ribbon */

624

class RetrieveApplicationRibbonRequest extends Request { }

625

626

/** Retrieve entity ribbon */

627

class RetrieveEntityRibbonRequest extends Request { }

628

629

/** Retrieve audit partition list */

630

class RetrieveAuditPartitionListRequest extends Request { }

631

632

/** Retrieve business hierarchy for business unit */

633

class RetrieveBusinessHierarchyBusinessUnitRequest extends Request { }

634

635

/** Retrieve by group resource */

636

class RetrieveByGroupResourceRequest extends Request { }

637

638

/** Retrieve by resource resource group */

639

class RetrieveByResourceResourceGroupRequest extends Request { }

640

641

/** Retrieve by resources service */

642

class RetrieveByResourcesServiceRequest extends Request { }

643

644

/** Retrieve deployment license type */

645

class RetrieveDeploymentLicenseTypeRequest extends Request { }

646

647

/** Retrieve deprovisioned languages */

648

class RetrieveDeprovisionedLanguagesRequest extends Request { }

649

650

/** Retrieve duplicates */

651

class RetrieveDuplicatesRequest extends Request { }

652

653

/** Retrieve entity changes */

654

class RetrieveEntityChangesRequest extends Request { }

655

656

/** Retrieve exchange appointments */

657

class RetrieveExchangeAppointmentsRequest extends Request { }

658

659

/** Retrieve exchange rate */

660

class RetrieveExchangeRateRequest extends Request { }

661

662

/** Retrieve filtered forms */

663

class RetrieveFilteredFormsRequest extends Request { }

664

665

/** Retrieve formatted import job results */

666

class RetrieveFormattedImportJobResultsRequest extends Request { }

667

668

/** Retrieve installed language pack version */

669

class RetrieveInstalledLanguagePackVersionRequest extends Request { }

670

671

/** Retrieve license info */

672

class RetrieveLicenseInfoRequest extends Request { }

673

674

/** Retrieve localized labels */

675

class RetrieveLocLabelsRequest extends Request { }

676

677

/** Retrieve mailbox tracking folders */

678

class RetrieveMailboxTrackingFoldersRequest extends Request { }

679

680

/** Retrieve members of bulk operation */

681

class RetrieveMembersBulkOperationRequest extends Request { }

682

683

/** Retrieve missing components */

684

class RetrieveMissingComponentsRequest extends Request { }

685

686

/** Retrieve missing dependencies */

687

class RetrieveMissingDependenciesRequest extends Request { }

688

689

/** Retrieve organization resources */

690

class RetrieveOrganizationResourcesRequest extends Request { }

691

692

/** Retrieve parent groups for resource group */

693

class RetrieveParentGroupsResourceGroupRequest extends Request { }

694

695

/** Retrieve parsed data import file */

696

class RetrieveParsedDataImportFileRequest extends Request { }

697

698

/** Retrieve personal wall */

699

class RetrievePersonalWallRequest extends Request { }

700

701

/** Retrieve principal attribute privileges */

702

class RetrievePrincipalAttributePrivilegesRequest extends Request { }

703

704

/** Retrieve principal sync attribute mappings */

705

class RetrievePrincipalSyncAttributeMappingsRequest extends Request { }

706

707

/** Retrieve privilege set */

708

class RetrievePrivilegeSetRequest extends Request { }

709

710

/** Retrieve process instances */

711

class RetrieveProcessInstancesRequest extends Request { }

712

713

/** Retrieve product properties */

714

class RetrieveProductPropertiesRequest extends Request { }

715

716

/** Retrieve provisioned language pack version */

717

class RetrieveProvisionedLanguagePackVersionRequest extends Request { }

718

719

/** Retrieve provisioned languages */

720

class RetrieveProvisionedLanguagesRequest extends Request { }

721

722

/** Retrieve record wall */

723

class RetrieveRecordWallRequest extends Request { }

724

725

/** Retrieve required components */

726

class RetrieveRequiredComponentsRequest extends Request { }

727

728

/** Retrieve role privileges for role */

729

class RetrieveRolePrivilegesRoleRequest extends Request { }

730

731

/** Retrieve sub groups for resource group */

732

class RetrieveSubGroupsResourceGroupRequest extends Request { }

733

734

/** Retrieve unpublished records */

735

class RetrieveUnpublishedMultipleRequest extends Request { }

736

737

/** Retrieve user queues */

738

class RetrieveUserQueuesRequest extends Request { }

739

```

740

741

## Advanced Business Process Requests

742

743

### Case Management

744

745

```typescript { .api }

746

/** Close incident (case) */

747

class CloseIncidentRequest extends Request { }

748

749

/** Calculate total time for incident */

750

class CalculateTotalTimeIncidentRequest extends Request { }

751

752

/** Apply routing rule */

753

class ApplyRoutingRuleRequest extends Request { }

754

```

755

756

### Campaign Management

757

758

```typescript { .api }

759

/** Add item to campaign */

760

class AddItemCampaignRequest extends Request { }

761

762

/** Add item to campaign activity */

763

class AddItemCampaignActivityRequest extends Request { }

764

765

/** Copy campaign */

766

class CopyCampaignRequest extends Request { }

767

768

/** Copy campaign response */

769

class CopyCampaignResponseRequest extends Request { }

770

771

/** Distribute campaign activity */

772

class DistributeCampaignActivityRequest extends Request { }

773

```

774

775

### Contract Management

776

777

```typescript { .api }

778

/** Cancel contract */

779

class CancelContractRequest extends Request { }

780

781

/** Clone contract */

782

class CloneContractRequest extends Request { }

783

784

/** Renew contract */

785

class RenewContractRequest extends Request { }

786

787

/** Renew entitlement */

788

class RenewEntitlementRequest extends Request { }

789

```

790

791

### Sales Process (Extended)

792

793

```typescript { .api }

794

/** Cancel sales order */

795

class CancelSalesOrderRequest extends Request { }

796

797

/** Close quote */

798

class CloseQuoteRequest extends Request { }

799

800

/** Revise quote */

801

class ReviseQuoteRequest extends Request { }

802

803

/** Win quote */

804

class WinQuoteRequest extends Request { }

805

806

/** Convert quote to sales order */

807

class ConvertQuoteToSalesOrderRequest extends Request { }

808

809

/** Convert sales order to invoice */

810

class ConvertSalesOrderToInvoiceRequest extends Request { }

811

812

/** Calculate price */

813

class CalculatePriceRequest extends Request { }

814

815

/** Get invoice products from opportunity */

816

class GetInvoiceProductsFromOpportunityRequest extends Request { }

817

818

/** Get quote products from opportunity */

819

class GetQuoteProductsFromOpportunityRequest extends Request { }

820

821

/** Get sales order products from opportunity */

822

class GetSalesOrderProductsFromOpportunityRequest extends Request { }

823

824

/** Fulfill sales order */

825

class FulfillSalesOrderRequest extends Request { }

826

827

/** Lock invoice pricing */

828

class LockInvoicePricingRequest extends Request { }

829

830

/** Unlock invoice pricing */

831

class UnlockInvoicePricingRequest extends Request { }

832

833

/** Lock sales order pricing */

834

class LockSalesOrderPricingRequest extends Request { }

835

836

/** Unlock sales order pricing */

837

class UnlockSalesOrderPricingRequest extends Request { }

838

```

839

840

### Product Management

841

842

```typescript { .api }

843

/** Clone product */

844

class CloneProductRequest extends Request { }

845

846

/** Convert product to kit */

847

class ConvertProductToKitRequest extends Request { }

848

849

/** Revert product */

850

class RevertProductRequest extends Request { }

851

852

/** Publish product hierarchy */

853

class PublishProductHierarchyRequest extends Request { }

854

855

/** Update product properties */

856

class UpdateProductPropertiesRequest extends Request { }

857

```

858

859

## Import/Export and Data Management

860

861

```typescript { .api }

862

/** Export field translation */

863

class ExportFieldTranslationRequest extends Request { }

864

865

/** Import field translation */

866

class ImportFieldTranslationRequest extends Request { }

867

868

/** Export translation */

869

class ExportTranslationRequest extends Request { }

870

871

/** Import translation */

872

class ImportTranslationRequest extends Request { }

873

874

/** Export mappings import map */

875

class ExportMappingsImportMapRequest extends Request { }

876

877

/** Import mappings import map */

878

class ImportMappingsImportMapRequest extends Request { }

879

880

/** Import records import */

881

class ImportRecordsImportRequest extends Request { }

882

883

/** Parse import */

884

class ParseImportRequest extends Request { }

885

886

/** Transform import */

887

class TransformImportRequest extends Request { }

888

889

/** Get distinct values import file */

890

class GetDistinctValuesImportFileRequest extends Request { }

891

892

/** Get header columns import file */

893

class GetHeaderColumnsImportFileRequest extends Request { }

894

895

/** Download report definition */

896

class DownloadReportDefinitionRequest extends Request { }

897

898

/** Get report history limit */

899

class GetReportHistoryLimitRequest extends Request { }

900

901

/** Set report related */

902

class SetReportRelatedRequest extends Request { }

903

```

904

905

## Calendar and Scheduling

906

907

```typescript { .api }

908

/** Expand calendar */

909

class ExpandCalendarRequest extends Request { }

910

911

/** Query multiple schedules */

912

class QueryMultipleSchedulesRequest extends Request { }

913

914

/** Query schedule */

915

class QueryScheduleRequest extends Request { }

916

917

/** Book resource */

918

class BookRequest extends Request { }

919

920

/** Reschedule appointment */

921

class RescheduleRequest extends Request { }

922

923

/** Validate recurrence rule */

924

class ValidateRecurrenceRuleRequest extends Request { }

925

926

/** Create exception to recurring appointment */

927

class CreateExceptionRequest extends Request { }

928

929

/** Create instance of recurring appointment */

930

class CreateInstanceRequest extends Request { }

931

932

/** Add recurrence */

933

class AddRecurrenceRequest extends Request { }

934

935

/** Delete open instances */

936

class DeleteOpenInstancesRequest extends Request { }

937

938

/** Find parent resource group */

939

class FindParentResourceGroupRequest extends Request { }

940

941

/** Set business equipment */

942

class SetBusinessEquipmentRequest extends Request { }

943

944

/** Set business system user */

945

class SetBusinessSystemUserRequest extends Request { }

946

```

947

948

## Knowledge Management

949

950

```typescript { .api }

951

/** Increment knowledge article view count */

952

class IncrementKnowledgeArticleViewCountRequest extends Request { }

953

954

/** Create knowledge article translation */

955

class CreateKnowledgeArticleTranslationRequest extends Request { }

956

957

/** Create knowledge article version */

958

class CreateKnowledgeArticleVersionRequest extends Request { }

959

960

/** Full text search knowledge article */

961

class FullTextSearchKnowledgeArticleRequest extends Request { }

962

963

/** Search by body knowledge base article */

964

class SearchByBodyKbArticleRequest extends Request { }

965

966

/** Search by keywords knowledge base article */

967

class SearchByKeywordsKbArticleRequest extends Request { }

968

969

/** Search by title knowledge base article */

970

class SearchByTitleKbArticleRequest extends Request { }

971

972

/** Retrieve by top incident product knowledge base article */

973

class RetrieveByTopIncidentProductKbArticleRequest extends Request { }

974

975

/** Retrieve by top incident subject knowledge base article */

976

class RetrieveByTopIncidentSubjectKbArticleRequest extends Request { }

977

```

978

979

## List and Marketing Management

980

981

```typescript { .api }

982

/** Add list members to list */

983

class AddListMembersListRequest extends Request { }

984

985

/** Add member to list */

986

class AddMemberListRequest extends Request { }

987

988

/** Copy dynamic list to static */

989

class CopyDynamicListToStaticRequest extends Request { }

990

991

/** Copy members list */

992

class CopyMembersListRequest extends Request { }

993

994

/** Create activities list */

995

class CreateActivitiesListRequest extends Request { }

996

997

/** Qualify member list */

998

class QualifyMemberListRequest extends Request { }

999

```

1000

1001

## Duplicate Detection

1002

1003

```typescript { .api }

1004

/** Bulk detect duplicates */

1005

class BulkDetectDuplicatesRequest extends Request { }

1006

1007

/** Compound update duplicate detection rule */

1008

class CompoundUpdateDuplicateDetectionRuleRequest extends Request { }

1009

1010

/** Publish duplicate rule */

1011

class PublishDuplicateRuleRequest extends Request { }

1012

1013

/** Unpublish duplicate rule */

1014

class UnpublishDuplicateRuleRequest extends Request { }

1015

```

1016

1017

## Advanced System Operations

1018

1019

### Bulk Operations

1020

1021

```typescript { .api }

1022

/** Bulk delete */

1023

class BulkDeleteRequest extends Request { }

1024

1025

/** Send bulk mail */

1026

class SendBulkMailRequest extends Request { }

1027

```

1028

1029

### Data Validation

1030

1031

```typescript { .api }

1032

/** Validate request */

1033

class ValidateRequest extends Request { }

1034

1035

/** Validate saved query */

1036

class ValidateSavedQueryRequest extends Request { }

1037

1038

/** Is valid state transition */

1039

class IsValidStateTransitionRequest extends Request { }

1040

```

1041

1042

### System Configuration

1043

1044

```typescript { .api }

1045

/** Is component customizable */

1046

class IsComponentCustomizableRequest extends Request { }

1047

1048

/** Set data encryption key */

1049

class SetDataEncryptionKeyRequest extends Request { }

1050

1051

/** Set feature status */

1052

class SetFeatureStatusRequest extends Request { }

1053

1054

/** Update feature config */

1055

class UpdateFeatureConfigRequest extends Request { }

1056

1057

/** Set localized labels */

1058

class SetLocLabelsRequest extends Request { }

1059

1060

/** Install sample data */

1061

class InstallSampleDataRequest extends Request { }

1062

1063

/** Uninstall sample data */

1064

class UninstallSampleDataRequest extends Request { }

1065

1066

/** Provision language */

1067

class ProvisionLanguageRequest extends Request { }

1068

1069

/** Deprovision language */

1070

class DeprovisionLanguageRequest extends Request { }

1071

```

1072

1073

### Option Set Management

1074

1075

```typescript { .api }

1076

/** Insert option value */

1077

class InsertOptionValueRequest extends Request { }

1078

1079

/** Update option value */

1080

class UpdateOptionValueRequest extends Request { }

1081

1082

/** Delete option value */

1083

class DeleteOptionValueRequest extends Request { }

1084

1085

/** Order option */

1086

class OrderOptionRequest extends Request { }

1087

1088

/** Insert status value */

1089

class InsertStatusValueRequest extends Request { }

1090

1091

/** Update state value */

1092

class UpdateStateValueRequest extends Request { }

1093

```

1094

1095

### Theme and UI Management

1096

1097

```typescript { .api }

1098

/** Publish theme */

1099

class PublishThemeRequest extends Request { }

1100

1101

/** Copy system form */

1102

class CopySystemFormRequest extends Request { }

1103

1104

/** Reset user filters */

1105

class ResetUserFiltersRequest extends Request { }

1106

```

1107

1108

### Conversion and Utility

1109

1110

```typescript { .api }

1111

/** FetchXml to query expression */

1112

class FetchXmlToQueryExpressionRequest extends Request { }

1113

1114

/** Query expression to FetchXml */

1115

class QueryExpressionToFetchXmlRequest extends Request { }

1116

1117

/** Initialize from */

1118

class InitializeFromRequest extends Request { }

1119

1120

/** Auto map entity */

1121

class AutoMapEntityRequest extends Request { }

1122

```

1123

1124

### Service Endpoint

1125

1126

```typescript { .api }

1127

/** Trigger service endpoint check */

1128

class TriggerServiceEndpointCheckRequest extends Request { }

1129

```

1130

1131

### Search Operations

1132

1133

```typescript { .api }

1134

/** General search */

1135

class SearchRequest extends Request { }

1136

1137

/** Generate social profile */

1138

class GenerateSocialProfileRequest extends Request { }

1139

```

1140

1141

### Email Operations (Extended)

1142

1143

```typescript { .api }

1144

/** Check incoming email */

1145

class CheckIncomingEmailRequest extends Request { }

1146

1147

/** Check promote email */

1148

class CheckPromoteEmailRequest extends Request { }

1149

1150

/** Deliver incoming email */

1151

class DeliverIncomingEmailRequest extends Request { }

1152

1153

/** Deliver promote email */

1154

class DeliverPromoteEmailRequest extends Request { }

1155

1156

/** Process inbound email */

1157

class ProcessInboundEmailRequest extends Request { }

1158

1159

/** Send email from template */

1160

class SendEmailFromTemplateRequest extends Request { }

1161

1162

/** Send template */

1163

class SendTemplateRequest extends Request { }

1164

1165

/** Send fax */

1166

class SendFaxRequest extends Request { }

1167

1168

/** Get tracking token email */

1169

class GetTrackingTokenEmailRequest extends Request { }

1170

```

1171

1172

### Dependencies and Components

1173

1174

```typescript { .api }

1175

/** Retrieve dependencies for delete */

1176

class RetrieveDependenciesForDeleteRequest extends Request { }

1177

1178

/** Retrieve dependencies for uninstall */

1179

class RetrieveDependenciesForUninstallRequest extends Request { }

1180

1181

/** Retrieve dependent components */

1182

class RetrieveDependentComponentsRequest extends Request { }

1183

1184

/** Update solution component */

1185

class UpdateSolutionComponentRequest extends Request { }

1186

1187

/** Clone as patch */

1188

class CloneAsPatchRequest extends Request { }

1189

1190

/** Clone as solution */

1191

class CloneAsSolutionRequest extends Request { }

1192

```

1193

1194

### Mobile and Offline

1195

1196

```typescript { .api }

1197

/** Clone mobile offline profile */

1198

class CloneMobileOfflineProfileRequest extends Request { }

1199

```

1200

1201

### Customer Relationships

1202

1203

```typescript { .api }

1204

/** Create customer relationships */

1205

class CreateCustomerRelationshipsRequest extends Request { }

1206

1207

/** Remove parent */

1208

class RemoveParentRequest extends Request { }

1209

1210

/** Set parent system user */

1211

class SetParentSystemUserRequest extends Request { }

1212

```

1213

1214

### Audit and Delete

1215

1216

```typescript { .api }

1217

/** Delete audit data */

1218

class DeleteAuditDataRequest extends Request { }

1219

1220

/** Delete and promote */

1221

class DeleteAndPromoteRequest extends Request { }

1222

```

1223

1224

### Recalculation

1225

1226

```typescript { .api }

1227

/** Recalculate */

1228

class RecalculateRequest extends Request { }

1229

1230

/** Rollup */

1231

class RollupRequest extends Request { }

1232

1233

/** Propagate by expression */

1234

class PropagateByExpressionRequest extends Request { }

1235

1236

/** Apply record creation and update rule */

1237

class ApplyRecordCreationAndUpdateRuleRequest extends Request { }

1238

```

1239

1240

### Object Assignment

1241

1242

```typescript { .api }

1243

/** Reassign objects owner */

1244

class ReassignObjectsOwnerRequest extends Request { }

1245

1246

/** Reassign objects system user */

1247

class ReassignObjectsSystemUserRequest extends Request { }

1248

1249

/** Revoke access */

1250

class RevokeAccessRequest extends Request { }

1251

1252

/** Route to */

1253

class RouteToRequest extends Request { }

1254

```

1255

1256

### Templates and Instantiation

1257

1258

```typescript { .api }

1259

/** Instantiate filters */

1260

class InstantiateFiltersRequest extends Request { }

1261

1262

/** Instantiate template */

1263

class InstantiateTemplateRequest extends Request { }

1264

```