Server objects

Server logic provides built-in objects under the server namespace. These objects simplify development by letting you log messages, call external services, work with Dataverse, or access request details.

HttpClient

Use the HTTP client to integrate with external services by sending HTTP requests.

Note

Currently, server logic supports only application/json, text/html, and application/x-www-form-urlencoded content types in the request body.

Examples

HTTP GET

let url = "https://contoso.com/objects";
let header = { client_id: "00001111-aaaa-2222-bbbb-3333cccc4444" };

let response = await Server.Connector.HttpClient.GetAsync(url, header);

HTTP POST

let url = "https://contoso.com/objects";
let body = JSON.stringify({ name: "Sample Account" });
let header = { client_id: "00001111-aaaa-2222-bbbb-3333cccc4444" };
let contentType = "application/json";

// Make the POST request
let response = await Server.Connector.HttpClient.PostAsync(url, body, header, contentType);

HTTP PUT

let url = "https://contoso.com/objects/6";
let body = JSON.stringify({ name: "Updated Sample Account" });
let header = { client_id: "00001111-aaaa-2222-bbbb-3333cccc4444" };
let contentType = "application/json";

// Make the PUT request
let response = await Server.Connector.HttpClient.PutAsync(url, body, header, contentType);

HTTP PATCH

let url = "https://contoso.com/objects/6";
let body = JSON.stringify({ name: "{\"capacity\": \"2 TB\"}" });
let header = { client_id: "00001111-aaaa-2222-bbbb-3333cccc4444" };
let contentType = "application/json";

// Make the PATCH request
let response = await Server.Connector.HttpClient.PatchAsync(url, body, header, contentType);

HTTP DELETE

let url = "https://contoso.com/objects/6";
let header = { contentType: "application/json" };

let response = await Server.Connector.HttpClient.DeleteAsync(url, header);

Example: Response

{
    "StatusCode": 200,
    "Body": "JsonString",
    "IsSuccessStatusCode": true,
    "ReasonPhrase": "OK",
    "ServerError": false,
    "ServerErrorMessage": null,
    "Headers": {
        "Transfer-Encoding": "chunked",
        "Connection": "keep-alive",
        "Server": "",
        "Content-Type": "application/json"
    }
}

SiteSetting

Allows you to read site setting values for the current website.

Note

Don't store secrets, such as API keys or credentials, directly in server logic. Instead, store them securely in Azure Key Vault, source them through environment variables, and reference them by using site settings.

Example

Server.SiteSetting.Get("Search/Enabled");

EnvironmentVariable

Reads the value of an environment variable.

Example

Server.EnvironmentVariable.get("SITEPATH");

Website

Provides details of the current website record in Dataverse.

Example

Server.Website.adx_primarydomain;

User

Provides details of the signed-in user. Returns null if anonymous.

Example

Server.User.fullname;

Dataverse

Use the Server.Connector.Dataverse object to perform CRUD operations on Dataverse tables and invoke custom APIs.

Note

When you refer to Dataverse tables in your code, use the EntitySetName. For example, to access the account table, use the EntitySetName accounts.

CreateRecord

Create new record.

Server.Connector.Dataverse.CreateRecord(string entitySetName, string payload)

Example

Server.Connector.Dataverse.CreateRecord("accounts", "{\"name\": \"Contoso Ltd.\", \"telephone1\": \"555-555-0100\", \"websiteurl\": \"https://contoso.com\"}");

RetrieveRecord

Retrieves a single record by ID.

Server.Connector.Dataverse.RetrieveRecord(string entitySetName, string id)
Server.Connector.Dataverse.RetrieveRecord(string entitySetName, string id, string options)
Server.Connector.Dataverse.RetrieveRecord(string entitySetName, string id, string options, bool skipCache)

Example

Server.Connector.Dataverse.RetrieveRecord("accounts", "00000000-0000-0000-0000-000000000001", "$select=name,telephone1");

RetrieveMultipleRecords

Retrieves a collection of records.

Server.Connector.Dataverse.RetrieveMultipleRecords(string entitySetName)
Server.Connector.Dataverse.RetrieveMultipleRecords(string entitySetName, string options)
Server.Connector.Dataverse.RetrieveMultipleRecords(string entitySetName, string options, bool skipCache)

Example

Server.Connector.Dataverse.RetrieveMultipleRecords("accounts", "$select=name,emailaddress1&$top=3");

UpdateRecord

Updates an existing record by ID.

Server.Connector.Dataverse.UpdateRecord(string entitySetName, string id, string payload)

Example

Server.Connector.Dataverse.UpdateRecord("accounts", "00000000-0000-0000-0000-000000000001", "{ \"telephone1\": \"555-555-0100\" }");

DeleteRecord

Deletes a record by ID.

Server.Connector.Dataverse.DeleteRecord(string entitySetName, string id)

Example

Server.Connector.Dataverse.DeleteRecord("accounts", "00000000-0000-0000-0000-000000000001");

InvokeCustomApi

Server.Connector.Dataverse.InvokeCustomApi(string httpMethod, string url, string payload = null)

Invoke a bound function:

Server.Connector.Dataverse.InvokeCustomApi("get", "accounts(00000000-0000-0000-0000-000000000001)/Microsoft.Dynamics.CRM.new_CustomBoundFunction");

Invoke a bound action:

Server.Connector.Dataverse.InvokeCustomApi("post", "accounts(00000000-0000-0000-0000-000000000001)/Microsoft.Dynamics.CRM.new_CustomBoundAction", "{ \"parameter1\": \"value1\" }");

Invoke an unbound action:

Server.Connector.Dataverse.InvokeCustomApi("post", "new_Action", "{ \"parameter1\": \"value1\" }");

Example: Response

{
    "StatusCode": 204,
    "Body": "",
    "IsSuccessStatusCode": true,
    "ReasonPhrase": "No Content",
    "ServerError": false,
    "ServerErrorMessage": null,
    "Headers": {
        "x-ms-cds-service-request-id": "00001111-aaaa-2222-bbbb-3333cccc4444"
    }
}

Logger

Use the logger to write diagnostic messages that you can view in the DevTools extension.

Example:

Server.Logger.Log("Information message");
Server.Logger.Warn("Warning message");
Server.Logger.Error("Error message");

Context

The Server.Context object provides information about the current server logic invocation. The available properties depend on whether the server logic was invoked through an HTTP request or from a Liquid template.

Properties

Name	Available for	Description
`ActivityId`	HTTP and Liquid	Unique identifier for the server logic invocation. Use this value to correlate logs and troubleshoot an operation.
`Body`	HTTP	Raw HTTP request body.
`FunctionName`	HTTP and Liquid	Name of the JavaScript function being invoked. For a Liquid invocation, this value corresponds to the `operation` parameter of the `serverlogic` tag.
`Headers`	HTTP	HTTP request headers.
`HttpMethod`	HTTP	HTTP request method, such as `GET`, `POST`, `PUT`, `PATCH`, or `DELETE`.
`Input`	Liquid	Input string supplied through the `input` parameter of the `serverlogic` Liquid tag. When the input contains structured data, parse it as JSON before using it.
`QueryParameters`	HTTP	Query-string parameters from the HTTP request.
`ServerLogicName`	HTTP and Liquid	Name of the server logic record being invoked.
`Url`	HTTP	Full URL of the HTTP request.

Access HTTP request context

The following example reads the id query parameter when server logic is invoked through an HTTP request:

var id = Server.Context.QueryParameters["id"];

You can also access request metadata:

function getRequestInformation() {
    return JSON.stringify({
        activityId: Server.Context.ActivityId,
        functionName: Server.Context.FunctionName,
        httpMethod: Server.Context.HttpMethod,
        serverLogicName: Server.Context.ServerLogicName,
        url: Server.Context.Url
    });
}

Access Liquid invocation context

When server logic is invoked from Liquid, use Server.Context.Input to read the value supplied through the tag's input parameter.

For example, the following Liquid passes JSON input:

{% assign inputData = '{"category":"active","maximumResults":5}' %}

{% serverlogic output: result, name: 'customer-summary', operation: 'getSummary', input: inputData %}

The server logic operation can parse the input and access information about the Liquid invocation:

function getSummary() {
    var input = JSON.parse(Server.Context.Input || "{}");

    return JSON.stringify({
        category: input.category,
        maximumResults: input.maximumResults,
        activityId: Server.Context.ActivityId,
        functionName: Server.Context.FunctionName,
        serverLogicName: Server.Context.ServerLogicName
    });
}

Next step

How to interact with Dataverse tables using server logic

Server logic overview
Author server logic

Feedback

Was this page helpful?

Last updated on 2026-08-10

Server objects

HttpClient

Examples

HTTP GET

HTTP POST

HTTP PUT

HTTP PATCH

HTTP DELETE

Example: Response

SiteSetting

EnvironmentVariable

Website

User

Dataverse

CreateRecord

Example

RetrieveRecord

RetrieveMultipleRecords

UpdateRecord

DeleteRecord

InvokeCustomApi

Example: Response

Logger

Context

Properties

Access HTTP request context

Access Liquid invocation context

Next step

Related information

Feedback

Additional resources