@Path(value="/construct") public interface ConstructResource extends AuthenticatedResource
Modifier and Type | Method and Description |
---|---|
GenericResponse |
deletePart(String constructId,
String idOrKeyname)
Delete a part of a construct.
|
ConstructListResponse |
list(Integer skipCount,
Integer maxItems,
String search,
Boolean changeable,
Integer pageId,
Integer nodeId,
Integer categoryId,
List<Integer> partTypeId,
ConstructSortAttribute sortBy,
SortOrder sortOrder)
Get the list of constructs that are used by the tags in the given page.
|
ConstructLoadResponse |
load(Integer id)
Load the insertable construct and it's categories for a given constructId
|
setSessionId
@GET @Path(value="/load/{constructId}") ConstructLoadResponse load(@PathParam(value="constructId") Integer id)
@GET @Path(value="/list") ConstructListResponse list(@QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems, @QueryParam(value="search") String search, @QueryParam(value="changeable") Boolean changeable, @QueryParam(value="pageId") Integer pageId, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="category") Integer categoryId, @QueryParam(value="partTypeId") List<Integer> partTypeId, @QueryParam(value="sortby") ConstructSortAttribute sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") SortOrder sortOrder)
skipCount
- number of items to be skipped (paging)maxItems
- maximum number of items to be returned (paging). -1 for getting all items.search
- search string for filtering itemschangeable
- true to only get changeable constructs, false for only getting not changeable items. Leave empty to get allpageId
- ID of the page form which to get constructs.nodeId
- ID of the node for getting constructs linked to a nodecategoryId
- ID of the category for filteringpartTypeId
- IDs of part types for filteringsortBy
- attribute for sortingsortOrder
- sort order@POST @Path(value="/delete/{constructId}/{idOrKeyname}") GenericResponse deletePart(@PathParam(value="constructId") String constructId, @PathParam(value="idOrKeyname") String idOrKeyname)
constructId
- The ID of the construct where the part is inidOrKeyname
- The ID or the keyword of the part to delete. It will first try to delete by ID, if the value is numeric.Copyright © 2020 Gentics Software. All rights reserved.