Include control parameters with HTTP requests to alter the way that the REST Web Services handle them. For example, if you would like the server to include an identifying string in the response, you can use the atg-rest-user-input control parameter to specify that identifying string.

You can include control parameters either in the URL for the REST Web Service or in the message body of a POST or PUT request.

Note: Several control parameters have equivalent configuration properties. Set these configuration properties to control the way that REST MVC Web Services are processed by default. See The REST MVC Definition Framework.

The following table explains the control parameters recognized by the REST Web Services server. This table also identifies if the parameter is used in the Legacy REST Web Services or the REST MVC Web Services.

Parameter

REST Version

Explanation

atg-rest-append-multi-values

Legacy Only

Use this parameter to control whether setting a value on a repository item property will add the value to an existing set of values or replace them. This only applies to repository item properties that hold multiple values.

atg-rest-class-descriptor

Both Legacy and
MVC

Use this parameter to specify the container and element Java classes for nested object property values. For additional information, refer to the Using Nested Multiple Value Objects in Input section.

atg-rest-class-type

Both Legacy and MVC

Use this parameter to specify a Java class when you are setting an object property value. For additional information, refer to the Using Object Values in Input section.

atg-rest-count

Legacy Only

For requests which return an array or ordered list, adding this parameter with an integer value allows the caller to specify the number of elements to return. Used with atg-rest-index.

atg-rest-depth

Legacy Only

The number of references to traverse when rendering output. By default it is zero which causes only the top level object to be returned.

atg-rest-form-tag-priorities

Legacy Only

Use this parameter to specify which form handler values should be processed first.

atg-rest-http-method

Legacy Only

Use this parameter to send the Legacy REST Web Server a POST HTTP request but have it process the request as if it used a different HTTP method.

For example you can use this control parameter to include message body data in a POST HTTP request but have the server process the request as if it used the GET method.

Set the value of this parameter to GET, PUT, or DELETE.

atg-rest-index

Legacy Only

Use this parameter to specify the entry in an array or ordered list that will be the starting point when that array or ordered list is returned by the server. Set the value of the parameter to the integer value of the starting position.

Use this parameter with atg-rest-count.

atg-rest-input

Both Legacy and MVC

Use this parameter to override the default input format configured for the server.

Set the value of this parameter to json or xml.

atg-rest-json-input

Legacy Only

Use this parameter to control whether the Legacy REST Web Services server will accept standard JSON markup for setting collection or map values on repository item properties.

atg-rest-method

Legacy Only

Use this parameter to specify the Java method signature when calling an overloaded method.

This parameter is only needed if two or more instances of the overloaded method have the same number of arguments.

atg-rest-null

Both Legacy and MVC

Use this parameter to set the value of a component or repository item property to null. Set the property and include this parameter as the new value.

atg-rest-output

Both Legacy and MVC

Use this parameter to override the default output format configured for the server. Set the value of this parameter to json or xml.

atg-rest-param-class-types

Both Legacy and MVC

Use this parameter to specify the Java classes for multiple values in JSON functional parameters. The atg-rest-param-class-types parameter includes three components, container-class, element-class, and key-class.

For example, if a functional parameter is a java.util.ArrayList<String>, set the atg-rest-param-class-types as shown below.

{'container-class':
'java.util.ArrayList',
'element-class':'java.lang.String'}

Use the key-class attribute when the container-class implements java.util.Map. For example:

{'container-class':'java.util.HashMap',
'key-class':'java.lang.String',
'element-class':'java.lang.String'}

atg-rest-property-filters

Legacy Only

Use this parameter to apply property filtering to individual Legacy REST Web Services Requests.

atg-rest-property-filter-templates

Legacy Only

Use this parameter to apply property filter templates to individual REST Web Services Requests.

atg-rest-return-form-handler-exceptions

Legacy Only

Use this parameter to specify that the Legacy REST Web Services server should return exceptions it encounters when invoking form handlers in the HTTP response.

atg-rest-return-form-handler-properties

Legacy Only

Use this parameter to specify that the Legacy REST Web Services server should return the properties of the form handler objects it invokes in the HTTP response.

atg-rest-rql

Legacy Only

Include RQL query strings in this parameter.

atg-rest-simple-response-codes

Legacy Only

Include this parameter to cause the server to return OK (200) for success rather than CREATED (201) or GONE (410).

atg-rest-transient

Legacy Only

Use this parameter to create transient repository items. Include the parameter with the value true with a Legacy REST Web Services request to create a repository item.

atg-rest-user-input

Both Legacy and MVC

Use this parameter to specify an identifying string that the REST Web Services server will include in the HTTP response.


Copyright © 1997, 2013 Oracle and/or its affiliates. All rights reserved. Legal Notices