ATG Web Services and Integration Framework Guide

atg-rest-depth

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

atg-rest-output

Allows the request to override the server default’s output format.

Can be either “json” or “xml”

atg-rest-input

Allows the request to override the server default’s input format.

Can be either “json” or “xml”

atg-rest-index

For requests which return an array or ordered list, adding this parameter with an integer value allows the caller to specify from which entry to begin the output. Used with atg-rest-count.

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-rql

When making an RQL query request, this parameter’s string value contains the RQL query string.

atg-rest-transient

When creating a repository item, adding this parameter with a value of “true” tells the server to create a transient item.

atg-rest-method

When calling an overloaded method, this parameter’s string value should specify the Java method signature.

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

atg-rest-http-method

For client applications which do not support the PUT or DELETE HTTP method types, this string parameter allows the caller to issue a POST request, specifying either PUT or DELETE for this parameter. The server will treat the request using the method specified in this parameter.

atg-rest-simple-response-codes

Tells the server to return OK (200) for success rather than CREATED (201) or GONE (410).