Package org.alfresco.rest.requests.coreAPI

Class RestCoreAPI

java.lang.Object

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

org.alfresco.rest.requests.coreAPI.RestCoreAPI

public class RestCoreAPI
extends ModelRequest<RestCoreAPI>

Defines the entire Rest Core API {@link https://api-explorer.alfresco.com/api-explorer/} select "Core API"

Field Summary

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

restWrapper

Constructor Summary

Constructors

Constructor	Description
RestCoreAPI(RestWrapper restWrapper)

Method Summary

Modifier and Type	Method	Description
RestSiteModelsCollection	getSites()	Provides DSL on all REST calls under /sites API path
RestTagModel	getTag(RestTagModel tag)
RestTagModelsCollection	getTags()
Actions	usingActions()
Audit	usingAudit()
People	usingAuthUser()	Make REST calls using current authenticated user.
Downloads	usingDownloads()
Downloads	usingDownloads(RestDownloadsModel downloadsModel)
Groups	usingGroups()
People	usingMe()	Make REST calls using current authenticated user, but using -me- instead of username
Networks	usingNetworks()	Provides DSL on all REST calls under /network API path
Node	usingNode()
Node	usingNode(org.alfresco.utility.model.RepoTestModel node)	synonym for usingResource(RepoTestModel)
Queries	usingQueries()
Node	usingResource(org.alfresco.utility.model.RepoTestModel node)	Provides DSL on all REST calls under /nodes API path
SharedLinks	usingSharedLinks()	SharedLinks api endpoint
Site	usingSite(java.lang.String siteId)	Provides DSL on all REST calls under sites/{siteId}/... API path
Site	usingSite(org.alfresco.utility.model.SiteModel siteModel)	Provides DSL on all REST calls under sites/{siteId}/... API path
Tags	usingTag(RestTagModel tag)
Trashcan	usingTrashcan()
People	usingUser(org.alfresco.utility.model.UserModel person)	Provides DSL of all REST calls under /people API path

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

includePath, usingParams

Methods inherited from class java.lang.Object

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

Constructor Detail

RestCoreAPI

public RestCoreAPI(RestWrapper restWrapper)

Method Detail

usingSite

public Site usingSite(java.lang.String siteId)

Provides DSL on all REST calls under sites/{siteId}/... API path

Parameters:

siteId -

Returns:

Site

usingSite

public Site usingSite(org.alfresco.utility.model.SiteModel siteModel)

Provides DSL on all REST calls under sites/{siteId}/... API path

Parameters:

SiteModel -

Returns:

Site

getSites

public RestSiteModelsCollection getSites()
                                  throws java.lang.Exception

Provides DSL on all REST calls under /sites API path

Returns:

Site

Throws:

java.lang.Exception

usingResource

public Node usingResource(org.alfresco.utility.model.RepoTestModel node)
                   throws java.lang.Exception

Provides DSL on all REST calls under /nodes API path

Returns:

Node

Throws:

java.lang.Exception

usingNode

public Node usingNode(org.alfresco.utility.model.RepoTestModel node)
               throws java.lang.Exception

synonym for usingResource(RepoTestModel)

Parameters:

node -

Returns:

Throws:

java.lang.Exception

usingNode

public Node usingNode()
               throws java.lang.Exception

Throws:

java.lang.Exception

usingUser

public People usingUser(org.alfresco.utility.model.UserModel person)
                 throws java.lang.Exception

Provides DSL of all REST calls under /people API path

Returns:

People

Throws:

java.lang.Exception

usingMe

public People usingMe()
               throws java.lang.Exception

Make REST calls using current authenticated user, but using -me- instead of username

Returns:

People

Throws:

java.lang.Exception

usingAuthUser

public People usingAuthUser()
                     throws java.lang.Exception

Make REST calls using current authenticated user. This is set on the #authenticateUser(UserModel) call

Returns:

People

Throws:

java.lang.Exception

usingNetworks

public Networks usingNetworks()

Provides DSL on all REST calls under /network API path

Returns:

Networks

usingTag

public Tags usingTag(RestTagModel tag)

getTags

public RestTagModelsCollection getTags()
                                throws java.lang.Exception

Throws:

java.lang.Exception

getTag

public RestTagModel getTag(RestTagModel tag)
                    throws java.lang.Exception

Throws:

java.lang.Exception

usingQueries

public Queries usingQueries()

usingAudit

public Audit usingAudit()
                 throws java.lang.Exception

Throws:

java.lang.Exception

usingTrashcan

public Trashcan usingTrashcan()

usingSharedLinks

public SharedLinks usingSharedLinks()

SharedLinks api endpoint

Returns:

SharedLinks api endpoint

usingGroups

public Groups usingGroups()

usingActions

public Actions usingActions()

usingDownloads

public Downloads usingDownloads()

usingDownloads

public Downloads usingDownloads(RestDownloadsModel downloadsModel)
                         throws java.lang.Exception

Throws:

java.lang.Exception