Package org.alfresco.rest.requests.modelAPI

Class RestModelAPI

java.lang.Object

org.alfresco.rest.requests.ModelRequest<RestModelAPI>

org.alfresco.rest.requests.modelAPI.RestModelAPI

public class RestModelAPI
extends ModelRequest<RestModelAPI>

Defines the entire Rest Model API

invalid @link

{@link https://api-explorer.alfresco.com/api-explorer/

} select "Model API"

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
RestModelAPI(RestWrapper restWrapper)

Method Summary

Modifier and Type	Method	Description
RestAspectModel	getAspect(String aspectId)	Retrieve aspect by id using GET call on "aspects/{aspectId}"
RestAspectsCollection	getAspects()	Retrieve all aspects using GET call on "aspects"
RestTypeModel	getType(String typeId)	Retrieve Type by id using GET call on "types/{typeId}"
RestTypesCollection	getTypes()	Retrieve all types using GET call on "types"

Methods inherited from class org.alfresco.rest.requests.ModelRequest

include, includePath, usingParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RestModelAPI

public RestModelAPI(RestWrapper restWrapper)

Method Details

getAspects

public RestAspectsCollection getAspects()

Retrieve all aspects using GET call on "aspects"

Returns:

RestAspectsCollection

Throws:

JsonToModelConversionException

getAspect

public RestAspectModel getAspect(String aspectId)

Retrieve aspect by id using GET call on "aspects/{aspectId}"

Returns:

RestAspectModel

Throws:

JsonToModelConversionException

getTypes

public RestTypesCollection getTypes()

Retrieve all types using GET call on "types"

Returns:

RestTypesCollection

Throws:

JsonToModelConversionException

getType

public RestTypeModel getType(String typeId)

Retrieve Type by id using GET call on "types/{typeId}"

Returns:

RestTypeModel

Throws:

JsonToModelConversionException