Package com.gentics.contentnode.rest.resource.devtools

Interface PackageResource

@Path("/devtools")
public interface PackageResource

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	add(String name)	Add the package with given name
jakarta.ws.rs.core.Response	addConstruct(String name, String construct)	Add a construct to a package
jakarta.ws.rs.core.Response	addContentRepository(String name, String contentrepository)	Add a ContentRepository to a package
jakarta.ws.rs.core.Response	addCrFragment(String name, String crFragment)	Add a ContentRepository Fragment to a package
jakarta.ws.rs.core.Response	addDatasource(String name, String datasource)	Add a datasource to a package
jakarta.ws.rs.core.Response	addObjectProperty(String name, String objectproperty)	Add an object property to a package
jakarta.ws.rs.core.Response	addPackage(String nodeId, Package addedPackage)	Add the package to the node.
jakarta.ws.rs.core.Response	addPackage(String nodeId, String packageName)	Add the package to the node.
jakarta.ws.rs.core.Response	addTemplate(String name, String template)	Add a template to a package
List<AutocompleteItem>	autocompleteConstructs(String term)	Endpoint for autocomplete UI components for constructs.
List<AutocompleteItem>	autocompleteContentRepositories(String term)	Endpoint for autocomplete UI components for contentrepositories.
List<AutocompleteItem>	autocompleteCrFragments(String term)	Endpoint for autocomplete UI components for cr fragments.
List<AutocompleteItem>	autocompleteDatasources(String term)	Endpoint for autocomplete UI components for datasources.
List<AutocompleteItem>	autocompleteObjectProperties(String term)	Endpoint for autocomplete UI components for object properties.
List<AutocompleteItem>	autocompleteTemplates(String term)	Endpoint for autocomplete UI components for templates.
jakarta.ws.rs.core.Response	delete(String name)	Delete the package with given name
Package	get(String name)	Get the package with given name
ConstructLoadResponse	getConstruct(String name, String construct)	Get the construct from the package
ContentRepositoryResponse	getContentRepository(String name, String contentrepository)	Get the ContentRepository in a package
ContentRepositoryFragmentResponse	getCrFragment(String name, String crFragment)	Get the ContentRepository Fragment in a package
DatasourceLoadResponse	getDatasource(String name, String datasource)	Get the datasource in a package
ObjectPropertyLoadResponse	getObjectProperty(String name, String objectproperty)	Get the object property in a package
SyncInfo	getSyncInfo()	Get the current status information for the automatic synchronization.
TemplateLoadResponse	getTemplate(String name, String template)	Get the template in the package
PackageListResponse	list(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging)	List available packages. The result can be filtered by name and sorted by name constructs datasources templates objectProperties crFragments contentRepositories
PagedConstructInPackageListResponse	listConstructs(String name, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms, EmbedParameterBean embed)	Get the list of constructs assigned to the package. The result can be filtered by keyword name description and sorted by keyword name description
PagedContentRepositoryInPackageListResponse	listContentRepositories(String name, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, EmbedParameterBean embed, PermsParameterBean perms)	Get the ContentRepositories in a package. The result can be filtered by name crType and sorted by name crType
PagedContentRepositoryFragmentInPackageListResponse	listCrFragments(String name, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, EmbedParameterBean embed, PermsParameterBean perms)	Get the ContentRepository Fragments in a package. The result can be filtered by name and sorted by name
PagedDatasourceInPackageListResponse	listDatasources(String name, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms)	Get the datasources in a package. The result can be filtered by name and sorted by name
org.glassfish.jersey.media.sse.EventOutput	listenPageChange(String uuid)	Listen on changes on dependencies with the given UUID
PackageListResponse	listNodePackages(String nodeId, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging)	List packages assigned to a node.
PagedObjectPropertyInPackageListResponse	listObjectProperties(String name, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, EmbedParameterBean embed, PermsParameterBean perms)	Get the object properties in a package. The result can be filtered by name description keyword and sorted by name description keyword type required inheritable construct.name
PagedTemplateInPackageListResponse	listTemplates(String name, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms)	Get the templates of a package. The result can be filtered by name description and sorted by name description
jakarta.ws.rs.core.Response	obtainPackageConsistencyCheckResult(String packageName)	Get the result from the package consistency check if available
GenericResponse	performPackageConsistencyCheck(String name, boolean checkAll, long waitMs, FilterPackageCheckBean filter, PagingParameterBean paging)	Checks the package for completeness
String	preview(String uuid)	Render the live preview of the page, which was registered before
jakarta.ws.rs.core.Response	removeConstruct(String name, String construct)	Remove a construct from a package
jakarta.ws.rs.core.Response	removeContentRepository(String name, String contentrepository)	Remove a ContentRepository from a package
jakarta.ws.rs.core.Response	removeCrFragment(String name, String crFragment)	Remove a ContentRepository Fragment from a package
jakarta.ws.rs.core.Response	removeDatasource(String name, String datasource)	Remove a datasource from a package
jakarta.ws.rs.core.Response	removeListener(String uuid)	Remove the listener with given UUID
jakarta.ws.rs.core.Response	removeObjectProperty(String name, String objectproperty)	Remove an object property from a package
jakarta.ws.rs.core.Response	removePackage(String nodeId, String packageName)	Remove the package from the node.
jakarta.ws.rs.core.Response	removeTemplate(String name, String template)	Remove a template from a package
String	renderPage(String id, String nodeId)	Get self refreshing live preview of the given page
SyncInfo	startSync()	Start the sync for the current user (if not started before)
jakarta.ws.rs.core.Response	stopSync()	Stop the sync, if it was started by the current user
GenericResponse	synchronizeFromFS(String name, long waitMs)	Trigger synchronization of all objects in the given package to the cms
GenericResponse	synchronizeToFS(String name, long waitMs)	Trigger synchronization of all objects in the given package to the filesystem

Method Details

list

@GET
@Path("/packages")
PackageListResponse list(@BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging)
                  throws Exception

List available packages.
The result can be filtered by

• name

and sorted by

• name
• constructs
• datasources
• templates
• objectProperties
• crFragments
• contentRepositories

Parameters:

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

Returns:

List of packages

Throws:

Exception

get

@GET
@Path("/packages/{name}")
Package get(@PathParam("name")
 String name)
     throws Exception

Get the package with given name

Parameters:

name - Package name

Returns:

package

Throws:

Exception

add

@PUT
@Path("/packages/{name}")
jakarta.ws.rs.core.Response add(@PathParam("name")
 String name)
                         throws Exception

Add the package with given name

Parameters:

name - Package name

Returns:

response

Throws:

Exception

delete

@DELETE
@Path("/packages/{name}")
jakarta.ws.rs.core.Response delete(@PathParam("name")
 String name)
                            throws Exception

Delete the package with given name

Parameters:

name - Package name

Returns:

response

Throws:

Exception

performPackageConsistencyCheck

@GET
@Path("/package/{name}/check")
GenericResponse performPackageConsistencyCheck(@PathParam("name")
 String name,
 @QueryParam("checkAll") @DefaultValue("false")
 boolean checkAll,
 @QueryParam("wait") @DefaultValue("0")
 long waitMs,
 @BeanParam
 FilterPackageCheckBean filter,
 @BeanParam
 PagingParameterBean paging)
                                        throws Exception

Checks the package for completeness

Parameters:

name - name of the package to check

checkAll - if true, other packages are also searched

waitMs - wait timeout in ms. When set to 0, response will be sent, when the action completes

filter - filter options. The dependency type can be filtered (e.g.: type=CONSTRUCT). Additionally, missing references can be filtered (e.g.: filter=INCOMPLETE)

paging - the paging parameter

Returns:

list of dependencies

Throws:

Exception

obtainPackageConsistencyCheckResult

@GET
@Path("/package/{name}/check/result")
jakarta.ws.rs.core.Response obtainPackageConsistencyCheckResult(@PathParam("name")
 String packageName)
                                                         throws Exception

Get the result from the package consistency check if available

Parameters:

packageName - name of the package

Returns:

the result of the check

Throws:

Exception

synchronizeToFS

@PUT
@Path("/packages/{name}/cms2fs")
GenericResponse synchronizeToFS(@PathParam("name")
 String name,
 @QueryParam("wait") @DefaultValue("0")
 long waitMs)
                         throws Exception

Trigger synchronization of all objects in the given package to the filesystem

Parameters:

name - name of the package

waitMs - wait timeout in ms. When set to 0, response will be sent, when the action completes

Returns:

response

Throws:

Exception

synchronizeFromFS

@PUT
@Path("/packages/{name}/fs2cms")
GenericResponse synchronizeFromFS(@PathParam("name")
 String name,
 @QueryParam("wait") @DefaultValue("0")
 long waitMs)
                           throws Exception

Trigger synchronization of all objects in the given package to the cms

Parameters:

name - name of the package

waitMs - wait timeout in ms. When set to 0, response will be sent, when the action completes

Returns:

response

Throws:

Exception

listConstructs

@GET
@Path("/packages/{name}/constructs")
PagedConstructInPackageListResponse listConstructs(@PathParam("name")
 String name,
 @BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging,
 @BeanParam
 PermsParameterBean perms,
 @BeanParam
 EmbedParameterBean embed)
                                            throws Exception

Get the list of constructs assigned to the package.
The result can be filtered by

• keyword
• name
• description

and sorted by

• keyword
• name
• description

Parameters:

name - Package name

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - permissions parameters

embed - optionally embed the referenced objects (category)

Returns:

List of constructs

Throws:

Exception

getConstruct

@GET
@Path("/packages/{name}/constructs/{construct}")
ConstructLoadResponse getConstruct(@PathParam("name")
 String name,
 @PathParam("construct")
 String construct)
                            throws Exception

Get the construct from the package

Parameters:

name - Package name

construct - construct ID (internal or global) or keyword

Returns:

construct response

Throws:

Exception

addConstruct

@PUT
@Path("/packages/{name}/constructs/{construct}")
jakarta.ws.rs.core.Response addConstruct(@PathParam("name")
 String name,
 @PathParam("construct")
 String construct)
                                  throws Exception

Add a construct to a package

Parameters:

name - Package name

construct - construct ID (internal or global) or keyword

Returns:

response

Throws:

Exception

removeConstruct

@DELETE
@Path("/packages/{name}/constructs/{construct}")
jakarta.ws.rs.core.Response removeConstruct(@PathParam("name")
 String name,
 @PathParam("construct")
 String construct)
                                     throws Exception

Remove a construct from a package

Parameters:

name - Package name

construct - construct ID (internal or global) or keyword

Returns:

response

Throws:

Exception

listTemplates

@GET
@Path("/packages/{name}/templates")
PagedTemplateInPackageListResponse listTemplates(@PathParam("name")
 String name,
 @BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging,
 @BeanParam
 PermsParameterBean perms)
                                          throws Exception

Get the templates of a package.
The result can be filtered by

• name
• description

and sorted by

• name
• description

Parameters:

name - Package name

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - permissions parameters

Returns:

List of templates

Throws:

Exception

getTemplate

@GET
@Path("/packages/{name}/templates/{template}")
TemplateLoadResponse getTemplate(@PathParam("name")
 String name,
 @PathParam("template")
 String template)
                          throws Exception

Get the template in the package

Parameters:

name - Package name

template - global template ID (uuid)

Returns:

template response

Throws:

Exception

addTemplate

@PUT
@Path("/packages/{name}/templates/{template}")
jakarta.ws.rs.core.Response addTemplate(@PathParam("name")
 String name,
 @PathParam("template")
 String template)
                                 throws Exception

Add a template to a package

Parameters:

name - Package name

template - global template ID (uuid)

Returns:

response

Throws:

Exception

removeTemplate

@DELETE
@Path("/packages/{name}/templates/{template}")
jakarta.ws.rs.core.Response removeTemplate(@PathParam("name")
 String name,
 @PathParam("template")
 String template)
                                    throws Exception

Remove a template from a package

Parameters:

name - Package name

template - global template ID (uuid)

Returns:

response

Throws:

Exception

listDatasources

@GET
@Path("/packages/{name}/datasources")
PagedDatasourceInPackageListResponse listDatasources(@PathParam("name")
 String name,
 @BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging,
 @BeanParam
 PermsParameterBean perms)
                                              throws Exception

Get the datasources in a package.
The result can be filtered by

• name

and sorted by

• name

Parameters:

name - Package name

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - permissions parameters

Returns:

List of datasources

Throws:

Exception

getDatasource

@GET
@Path("/packages/{name}/datasources/{datasource}")
DatasourceLoadResponse getDatasource(@PathParam("name")
 String name,
 @PathParam("datasource")
 String datasource)
                              throws Exception

Get the datasource in a package

Parameters:

name - Package name

datasource - datasource name

Returns:

datasource response

Throws:

Exception

addDatasource

@PUT
@Path("/packages/{name}/datasources/{datasource}")
jakarta.ws.rs.core.Response addDatasource(@PathParam("name")
 String name,
 @PathParam("datasource")
 String datasource)
                                   throws Exception

Add a datasource to a package

Parameters:

name - Package name

datasource - datasource name

Returns:

response

Throws:

Exception

removeDatasource

@DELETE
@Path("/packages/{name}/datasources/{datasource}")
jakarta.ws.rs.core.Response removeDatasource(@PathParam("name")
 String name,
 @PathParam("datasource")
 String datasource)
                                      throws Exception

Remove a datasource from a package

Parameters:

name - Package name

datasource - datasource name

Returns:

response

Throws:

Exception

listObjectProperties

@GET
@Path("/packages/{name}/objectproperties")
PagedObjectPropertyInPackageListResponse listObjectProperties(@PathParam("name")
 String name,
 @BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging,
 @BeanParam
 EmbedParameterBean embed,
 @BeanParam
 PermsParameterBean perms)
                                                       throws Exception

Get the object properties in a package.
The result can be filtered by

• name
• description
• keyword

and sorted by

• name
• description
• keyword
• type
• required
• inheritable
• construct.name

Parameters:

name - Package name

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

embed - embed parameters

perms - permissions parameters

Returns:

List of object properties

Throws:

Exception

getObjectProperty

@GET
@Path("/packages/{name}/objectproperties/{objectproperty}")
ObjectPropertyLoadResponse getObjectProperty(@PathParam("name")
 String name,
 @PathParam("objectproperty")
 String objectproperty)
                                      throws Exception

Get the object property in a package

Parameters:

name - Package name

objectproperty - object property keyword

Returns:

object property response

Throws:

Exception

addObjectProperty

@PUT
@Path("/packages/{name}/objectproperties/{objectproperty}")
jakarta.ws.rs.core.Response addObjectProperty(@PathParam("name")
 String name,
 @PathParam("objectproperty")
 String objectproperty)
                                       throws Exception

Add an object property to a package

Parameters:

name - Package name

objectproperty - object property keyword

Returns:

response

Throws:

Exception

removeObjectProperty

@DELETE
@Path("/packages/{name}/objectproperties/{objectproperty}")
jakarta.ws.rs.core.Response removeObjectProperty(@PathParam("name")
 String name,
 @PathParam("objectproperty")
 String objectproperty)
                                          throws Exception

Remove an object property from a package

Parameters:

name - Package name

objectproperty - object property keyword

Returns:

response

Throws:

Exception

listCrFragments

@GET
@Path("/packages/{name}/cr_fragments")
PagedContentRepositoryFragmentInPackageListResponse listCrFragments(@PathParam("name")
 String name,
 @BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging,
 @BeanParam
 EmbedParameterBean embed,
 @BeanParam
 PermsParameterBean perms)
                                                             throws Exception

Get the ContentRepository Fragments in a package.
The result can be filtered by

• name

and sorted by

• name

Parameters:

name - Package name

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

embed - embed parameters

perms - permissions parameters

Returns:

List of ContentRepository Fragments

Throws:

Exception

getCrFragment

@GET
@Path("/packages/{name}/cr_fragments/{cr_fragment}")
ContentRepositoryFragmentResponse getCrFragment(@PathParam("name")
 String name,
 @PathParam("cr_fragment")
 String crFragment)
                                         throws Exception

Get the ContentRepository Fragment in a package

Parameters:

name - Package name

crFragment - ContentRepository Fragment name, local ID or global ID

Returns:

ContentRepository Fragment response

Throws:

Exception

addCrFragment

@PUT
@Path("/packages/{name}/cr_fragments/{cr_fragment}")
jakarta.ws.rs.core.Response addCrFragment(@PathParam("name")
 String name,
 @PathParam("cr_fragment")
 String crFragment)
                                   throws Exception

Add a ContentRepository Fragment to a package

Parameters:

name - Package name

crFragment - ContentRepository Fragment name, local ID or global ID

Returns:

response

Throws:

Exception

removeCrFragment

@DELETE
@Path("/packages/{name}/cr_fragments/{cr_fragment}")
jakarta.ws.rs.core.Response removeCrFragment(@PathParam("name")
 String name,
 @PathParam("cr_fragment")
 String crFragment)
                                      throws Exception

Remove a ContentRepository Fragment from a package

Parameters:

name - Package name

crFragment - ContentRepository Fragment name, local ID or global ID

Returns:

response

Throws:

Exception

listContentRepositories

@GET
@Path("/packages/{name}/contentrepositories")
PagedContentRepositoryInPackageListResponse listContentRepositories(@PathParam("name")
 String name,
 @BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging,
 @BeanParam
 EmbedParameterBean embed,
 @BeanParam
 PermsParameterBean perms)
                                                             throws Exception

Get the ContentRepositories in a package.
The result can be filtered by

• name
• crType

and sorted by

• name
• crType

Parameters:

name - Package name

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

embed - embed parameters

perms - permissions parameters

Returns:

List of ContentRepositories

Throws:

Exception

getContentRepository

@GET
@Path("/packages/{name}/contentrepositories/{contentrepository}")
ContentRepositoryResponse getContentRepository(@PathParam("name")
 String name,
 @PathParam("contentrepository")
 String contentrepository)
                                        throws Exception

Get the ContentRepository in a package

Parameters:

name - Package name

contentrepository - ContentRepository name, local ID or global ID

Returns:

ContentRepository response

Throws:

Exception

addContentRepository

@PUT
@Path("/packages/{name}/contentrepositories/{contentrepository}")
jakarta.ws.rs.core.Response addContentRepository(@PathParam("name")
 String name,
 @PathParam("contentrepository")
 String contentrepository)
                                          throws Exception

Add a ContentRepository to a package

Parameters:

name - Package name

contentrepository - ContentRepository name, local ID or global ID

Returns:

response

Throws:

Exception

removeContentRepository

@DELETE
@Path("/packages/{name}/contentrepositories/{contentrepository}")
jakarta.ws.rs.core.Response removeContentRepository(@PathParam("name")
 String name,
 @PathParam("contentrepository")
 String contentrepository)
                                             throws Exception

Remove a ContentRepository from a package

Parameters:

name - Package name

contentrepository - ContentRepository name, local ID or global ID

Returns:

response

Throws:

Exception

listNodePackages

@GET
@Path("/nodes/{nodeId}/packages")
PackageListResponse listNodePackages(@PathParam("nodeId")
 String nodeId,
 @BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging)
                              throws Exception

List packages assigned to a node. It is not possible to get packages to channels.
The result can be filtered by

• name

and sorted by

• name
• constructs
• datasources
• templates
• objectProperties
• crFragments
• contentRepositories

Parameters:

nodeId - Node ID (either global or local)

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

Returns:

List of packages in the node

Throws:

Exception

removePackage

@DELETE
@Path("/nodes/{nodeId}/packages/{packageName}")
jakarta.ws.rs.core.Response removePackage(@PathParam("nodeId")
 String nodeId,
 @PathParam("packageName")
 String packageName)
                                   throws Exception

Remove the package from the node. It is not possible to remove packages from channels

Parameters:

nodeId - node ID (either global or local)

packageName - Package name

Returns:

generic response

Throws:

Exception

addPackage

@PUT
@Path("/nodes/{nodeId}/packages/{packageName}")
jakarta.ws.rs.core.Response addPackage(@PathParam("nodeId")
 String nodeId,
 @PathParam("packageName")
 String packageName)
                                throws Exception

Add the package to the node. It is not possible to add packages to channels

Parameters:

nodeId - node ID (either global or local)

packageName - Package name

Returns:

generic response

Throws:

Exception

addPackage

@PUT
@Path("/nodes/{nodeId}/packages")
jakarta.ws.rs.core.Response addPackage(@PathParam("nodeId")
 String nodeId,
 Package addedPackage)
                                throws Exception

Add the package to the node. It is not possible to add packages to channels

Parameters:

nodeId - node ID (either global or local)

addedPackage - Package to add

Returns:

generic response

Throws:

Exception

renderPage

@GET
@Path("/preview/page/{id}")
@Produces("text/html")
String renderPage(@PathParam("id")
 String id,
 @QueryParam("nodeId")
 String nodeId)
           throws Exception

Get self refreshing live preview of the given page

Parameters:

id - page ID

nodeId - node ID

Returns:

HTML page that contains the live preview of the page was iframe.

Throws:

Exception

listenPageChange

@GET
@Path("/listen/{uuid}")
@Produces("text/event-stream")
org.glassfish.jersey.media.sse.EventOutput listenPageChange(@PathParam("uuid")
 String uuid)
                                                     throws Exception

Listen on changes on dependencies with the given UUID

Parameters:

uuid - UUID of the registration

Returns:

Events that are emitted, when a dependency changes.

Throws:

Exception

removeListener

@POST
@Path("/stoplisten/{uuid}")
jakarta.ws.rs.core.Response removeListener(@PathParam("uuid")
 String uuid)
                                    throws Exception

Remove the listener with given UUID

Parameters:

uuid - UUID of the registration

Returns:

empty response

Throws:

Exception

preview

@GET
@Path("/preview/{uuid}")
@Produces("text/html")
String preview(@PathParam("uuid")
 String uuid)
        throws Exception

Render the live preview of the page, which was registered before

Parameters:

uuid - UUID of the registration

Returns:

Rendered page

Throws:

Exception

autocompleteConstructs

@GET
@Path("/autocomplete/constructs")
List<AutocompleteItem> autocompleteConstructs(@QueryParam("term")
 String term)
                                       throws Exception

Endpoint for autocomplete UI components for constructs. Returns at most 10 constructs matching the given term

Parameters:

term - term to match

Returns:

list of at most 10 constructs

Throws:

Exception

autocompleteTemplates

@GET
@Path("/autocomplete/templates")
List<AutocompleteItem> autocompleteTemplates(@QueryParam("term")
 String term)
                                      throws Exception

Endpoint for autocomplete UI components for templates. Returns at most 10 templates matching the given term

Parameters:

term - term to match

Returns:

list of at most 10 templates

Throws:

Exception

autocompleteDatasources

@GET
@Path("/autocomplete/datasources")
List<AutocompleteItem> autocompleteDatasources(@QueryParam("term")
 String term)
                                        throws Exception

Endpoint for autocomplete UI components for datasources. Returns at most 10 datasources matching the given term

Parameters:

term - term to match

Returns:

list of at most 10 datasources

Throws:

Exception

autocompleteObjectProperties

@GET
@Path("/autocomplete/objectproperties")
List<AutocompleteItem> autocompleteObjectProperties(@QueryParam("term")
 String term)
                                             throws Exception

Endpoint for autocomplete UI components for object properties. Returns at most 10 object properties matching the given term

Parameters:

term - term to match

Returns:

list of at most 10 object properties

Throws:

Exception

autocompleteCrFragments

@GET
@Path("/autocomplete/cr_fragments")
List<AutocompleteItem> autocompleteCrFragments(@QueryParam("term")
 String term)
                                        throws Exception

Endpoint for autocomplete UI components for cr fragments. Returns at most 10 cr fragments matching the given term

Parameters:

term - term to match

Returns:

list of at most 10 cr fragments

Throws:

Exception

autocompleteContentRepositories

@GET
@Path("/autocomplete/contentrepositories")
List<AutocompleteItem> autocompleteContentRepositories(@QueryParam("term")
 String term)
                                                throws Exception

Endpoint for autocomplete UI components for contentrepositories. Returns at most 10 contentrepositories matching the given term

Parameters:

term - term to match

Returns:

list of at most 10 contentrepositories

Throws:

Exception

getSyncInfo

@GET
@Path("/sync")
SyncInfo getSyncInfo()
              throws Exception

Get the current status information for the automatic synchronization.

Returns:

Sync information

Throws:

Exception

startSync

@PUT
@Path("/sync")
SyncInfo startSync()
            throws Exception

Start the sync for the current user (if not started before)

Returns:

sync info

Throws:

Exception

stopSync

@DELETE
@Path("/sync")
jakarta.ws.rs.core.Response stopSync()
                              throws Exception

Stop the sync, if it was started by the current user

Returns:

response

Throws:

Exception