RestContext Class

Contains the RestRequest and RestResponse objects.

Namespace

System

Usage

Use the System.RestContext class to access the RestRequest and RestResponse objects in your Apex REST methods.

Sample

The following example shows how to use RestContext to access the RestRequest and RestResponse objects in an Apex REST method.

@RestResource(urlMapping='/MyRestContextExample/*')
global with sharing class MyRestContextExample {

    @HttpGet
    global static Account doGet() {
        RestRequest req = RestContext.request;
        RestResponse res = RestContext.response;
        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1);
        Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
        return result;
    }
  
}

RestContext Properties

The following are properties for RestContext.

  • request
    Returns the RestRequest for your Apex REST method.
  • response
    Returns the RestResponse for your Apex REST method.

request

Returns the RestRequest for your Apex REST method.

Signature

public RestRequest request {get; set;}

Property Value

Type: System.RestRequest

response

Returns the RestResponse for your Apex REST method.

Signature

public RestResponse response {get; set;}

Property Value

Type: System.RestResponse