atg-rest-append-multi-values

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. See Appending Values to Repository Item Properties.

atg-rest-count

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-class-descriptor

Use this parameter to specify the container and element Java classes for nested object property values. See Nested Multiple Value Objects in Input.

atg-rest-class-type

Use this parameter to specify a Java class when you are setting an object property value. See Object Values in Input.

atg-rest-depth

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

Use this parameter to specify which form handler values should be processed first. See Form Value Priority.

atg-rest-http-method

Use this parameter to send the 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

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

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

Use this parameter to control whether the REST Web Services server will accept standard JSON markup for setting collection or map values on repository item properties. See JSON Markup Input for Multiple Value Repository Item Properties.

atg-rest-method

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

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. See Setting Properties to Null.

atg-rest-output

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

atg-rest-param-class-types

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'}

See Specifying Java Classes for Multiple Value Input.

atg-rest-property-filter-templates

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

atg-rest-property-filters

Use this parameter to apply property filtering to individual REST Web Services Requests. See Filtering for One Request.

atg-rest-return-form-handler-exceptions

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

atg-rest-return-form-handler-properties

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

atg-rest-rql

Include RQL query strings in this parameter. See Performing RQL Queries.

atg-rest-simple-response-codes

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

atg-rest-transient

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

atg-rest-user-input

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