org.alfresco.rest.framework

Annotation Type WebApiParam

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface WebApiParam

A parameter used on a resource method operation in the Rest API The parameter kind is one of : QUERY_STRING - A query string parameter as part of the URL HTTP_BODY_OBJECT - A JSON object specified in a HTTP_BODY used by either a POST or PUT URL_PATH - Included as part of the actual url, e.g. entity id. (Does not support multiple values) HTTP_HEADER - Included in the request's HTTP Header

Author:

Gethin James

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name
String	title

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowMultiple
String	description
ResourceParameter.KIND	kind
boolean	required

Element Detail

name

public abstract String name

title

public abstract String title

description

public abstract String description

Default:

""

required

public abstract boolean required

Default:

false

kind

public abstract ResourceParameter.KIND kind

Default:

org.alfresco.rest.framework.core.ResourceParameter.KIND.URL_PATH

allowMultiple

public abstract boolean allowMultiple

Default:

true