RestResponse Class
Namespace
Usage
Use the System.RestResponse class to pass response data from an Apex RESTful web service method that is defined using one of the REST annotations.
RestResponse Properties
The following are properties for RestResponse.
responseBody
Signature
public Blob responseBody {get; set;}
Property Value
Type: Blob
Usage
The response is either the serialized form of the method return value or it's the value of the responseBody property based on the following rules:
- If the method returns void, then Apex REST returns the response in the responseBody property.
- If the method returns a value, then Apex REST serializes the return value as the response. If the return value contains fields with null value, those fields are not serialized in the response.
statusCode
Signature
public Integer statuscode {get; set;}
Property Value
Type: Integer
Status Codes
The following are valid response status codes. The status code is returned by the RestResponse.statusCode property.
Status Code | Description |
---|---|
200 | OK |
201 | CREATED |
202 | ACCEPTED |
204 | NO_CONTENT |
206 | PARTIAL_CONTENT |
300 | MULTIPLE_CHOICES |
301 | MOVED_PERMANENTLY |
302 | FOUND |
304 | NOT_MODIFIED |
400 | BAD_REQUEST |
401 | UNAUTHORIZED |
403 | FORBIDDEN |
404 | NOT_FOUND |
405 | METHOD_NOT_ALLOWED |
406 | NOT_ACCEPTABLE |
409 | CONFLICT |
410 | GONE |
412 | PRECONDITION_FAILED |
413 | REQUEST_ENTITY_TOO_LARGE |
414 | REQUEST_URI_TOO_LARGE |
415 | UNSUPPORTED_MEDIA_TYPE |
417 | EXPECTATION_FAILED |
500 | INTERNAL_SERVER_ERROR |
503 | SERVER_UNAVAILABLE |
RestResponse Methods
The following are instance methods for RestResponse.
addHeader(name, value)
Signature
public Void addHeader(String name, String value)
Return Value
Type: Void
Usage
- cookie
- set-cookie
- set-cookie2
- content-length
- authorization
- Header names that aren't RFC 7230 compliant