Package org.craftercms.studio.controller.rest.v2

Class DashboardController

java.lang.Object

org.craftercms.studio.controller.rest.v2.DashboardController

@Validated
@RestController
@RequestMapping("/api/2/dashboard")
public class DashboardController
extends Object

Constructor Summary

Constructors

Constructor	Description
DashboardController(DashboardService dashboardService)

Method Summary

Modifier and Type	Method	Description
@Valid PaginatedResultList<Activity>	getActivitiesForUsers(String siteId, List<@NotBlank String> usernames, ZonedDateTime dateFrom, ZonedDateTime dateTo, List<@NotBlank String> actions, @jakarta.validation.constraints.PositiveOrZero int offset, @jakarta.validation.constraints.PositiveOrZero int limit)
@Valid PaginatedResultList<ExpiringContentItem>	getContentExpired(String siteId, @jakarta.validation.constraints.PositiveOrZero int offset, @jakarta.validation.constraints.PositiveOrZero int limit)
@Valid PaginatedResultList<ExpiringContentItem>	getContentExpiring(String siteId, ZonedDateTime dateFrom, ZonedDateTime dateTo, @jakarta.validation.constraints.PositiveOrZero int offset, @jakarta.validation.constraints.PositiveOrZero int limit)
@Valid PaginatedResultList<DetailedItem>	getContentPendingApproval(String siteId, @jakarta.validation.constraints.PositiveOrZero int offset, @jakarta.validation.constraints.PositiveOrZero int limit, List<org.craftercms.commons.rest.parameters.SortField> sortFields, List<String> systemTypes)
@Valid ResultList<SandboxItem>	getContentPendingApprovalDetail(String siteId, UUID packageId, List<org.craftercms.commons.rest.parameters.SortField> sortFields)
@Valid PaginatedResultList<SandboxItem>	getContentUnpublished(String siteId, @jakarta.validation.constraints.PositiveOrZero int offset, @jakarta.validation.constraints.PositiveOrZero int limit, List<org.craftercms.commons.rest.parameters.SortField> sortFields, List<String> systemTypes)
@Valid PaginatedResultList<Activity>	getMyActivities(String siteId, ZonedDateTime dateFrom, ZonedDateTime dateTo, List<@NotBlank String> actions, @jakarta.validation.constraints.PositiveOrZero int offset, @jakarta.validation.constraints.PositiveOrZero int limit)
@Valid PaginatedResultList<DashboardPublishingPackage>	getPublishingHistory(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, @jakarta.validation.constraints.PositiveOrZero int offset, @jakarta.validation.constraints.PositiveOrZero int limit)
@Valid PaginatedResultList<SandboxItem>	getPublishingHistoryDetail(String siteId, UUID packageId, @jakarta.validation.constraints.PositiveOrZero int offset, @jakarta.validation.constraints.PositiveOrZero int limit)
@Valid PaginatedResultList<DetailedItem>	getPublishingScheduled(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, @jakarta.validation.constraints.PositiveOrZero int offset, @jakarta.validation.constraints.PositiveOrZero int limit, List<org.craftercms.commons.rest.parameters.SortField> sortFields, List<String> systemTypes)
@Valid ResultList<SandboxItem>	getPublishingScheduledDetail(String siteId, UUID packageId)
@Valid ResultOne<PublishingStats>	getPublishingStats(String siteId, int days)

Methods inherited from class java.lang.Object

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

Constructor Details

DashboardController

@ConstructorProperties("dashboardService")
public DashboardController(DashboardService dashboardService)

Method Details

getActivitiesForUsers

@Valid
@GetMapping(value="/activity",
            produces="application/json")
public @Valid PaginatedResultList<Activity> getActivitiesForUsers(@RequestParam("siteId")
 String siteId,
 @RequestParam(value="usernames",required=false)
 List<@NotBlank String> usernames,
 @RequestParam(value="dateFrom",required=false) @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateFrom,
 @RequestParam(value="dateTo",required=false) @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateTo,
 @RequestParam(required=false)
 List<@NotBlank String> actions,
 @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
 @jakarta.validation.constraints.PositiveOrZero int offset,
 @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
 @jakarta.validation.constraints.PositiveOrZero int limit)
                                                           throws SiteNotFoundException

Throws:

SiteNotFoundException

getMyActivities

@Valid
@GetMapping(value="/activity/me",
            produces="application/json")
public @Valid PaginatedResultList<Activity> getMyActivities(@RequestParam("siteId")
 String siteId,
 @RequestParam(value="dateFrom",required=false) @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateFrom,
 @RequestParam(value="dateTo",required=false) @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateTo,
 @RequestParam(required=false)
 List<@NotBlank String> actions,
 @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
 @jakarta.validation.constraints.PositiveOrZero int offset,
 @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
 @jakarta.validation.constraints.PositiveOrZero int limit)
                                                     throws SiteNotFoundException

Throws:

SiteNotFoundException

getContentPendingApproval

@Valid
@GetMapping(value="/content/pending_approval",
            produces="application/json")
public @Valid PaginatedResultList<DetailedItem> getContentPendingApproval(@RequestParam("siteId")
 String siteId,
 @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
 @jakarta.validation.constraints.PositiveOrZero int offset,
 @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
 @jakarta.validation.constraints.PositiveOrZero int limit,
 @RequestParam(value="sort",required=false,defaultValue="dateScheduled asc")
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 @RequestParam(value="itemType",required=false,defaultValue="")
 List<String> systemTypes)
                                                                   throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

getContentPendingApprovalDetail

@Valid
@GetMapping(value="/content/pending_approval/{id}",
            produces="application/json")
public @Valid ResultList<SandboxItem> getContentPendingApprovalDetail(@RequestParam("siteId")
 String siteId,
 @PathVariable("id")
 UUID packageId,
 @RequestParam(value="sort",required=false,defaultValue="dateModified desc")
 List<org.craftercms.commons.rest.parameters.SortField> sortFields)
                                                               throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

getContentUnpublished

@Valid
@GetMapping(value="/content/unpublished",
            produces="application/json")
public @Valid PaginatedResultList<SandboxItem> getContentUnpublished(@RequestParam("siteId")
 String siteId,
 @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
 @jakarta.validation.constraints.PositiveOrZero int offset,
 @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
 @jakarta.validation.constraints.PositiveOrZero int limit,
 @RequestParam(value="sort",required=false,defaultValue="dateModified desc")
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 @RequestParam(value="itemType",required=false,defaultValue="")
 List<String> systemTypes)
                                                              throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

getContentExpiring

@Valid
@GetMapping(value="/content/expiring",
            produces="application/json")
public @Valid PaginatedResultList<ExpiringContentItem> getContentExpiring(@RequestParam("siteId")
 String siteId,
 @RequestParam("dateFrom") @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateFrom,
 @RequestParam("dateTo") @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateTo,
 @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
 @jakarta.validation.constraints.PositiveOrZero int offset,
 @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
 @jakarta.validation.constraints.PositiveOrZero int limit)
                                                                   throws AuthenticationException,
ServiceLayerException,
UserNotFoundException

Throws:

AuthenticationException

ServiceLayerException

UserNotFoundException

getContentExpired

@Valid
@GetMapping(value="/content/expired",
            produces="application/json")
public @Valid PaginatedResultList<ExpiringContentItem> getContentExpired(@RequestParam("siteId")
 String siteId,
 @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
 @jakarta.validation.constraints.PositiveOrZero int offset,
 @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
 @jakarta.validation.constraints.PositiveOrZero int limit)
                                                                  throws AuthenticationException,
ServiceLayerException,
UserNotFoundException

Throws:

AuthenticationException

ServiceLayerException

UserNotFoundException

getPublishingScheduled

@Valid
@GetMapping(value="/publishing/scheduled",
            produces="application/json")
public @Valid PaginatedResultList<DetailedItem> getPublishingScheduled(@RequestParam("siteId")
 String siteId,
 @RequestParam(value="publishingTarget",required=false)
 String publishingTarget,
 @RequestParam(value="approver",required=false)
 String approver,
 @RequestParam(value="dateFrom",required=false) @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateFrom,
 @RequestParam(value="dateTo",required=false) @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateTo,
 @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
 @jakarta.validation.constraints.PositiveOrZero int offset,
 @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
 @jakarta.validation.constraints.PositiveOrZero int limit,
 @RequestParam(value="sort",required=false,defaultValue="dateScheduled asc")
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 @RequestParam(value="itemType",required=false,defaultValue="")
 List<String> systemTypes)
                                                                throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

getPublishingScheduledDetail

@Valid
@GetMapping(value="/publishing/scheduled/{id}",
            produces="application/json")
public @Valid ResultList<SandboxItem> getPublishingScheduledDetail(@RequestParam("siteId")
 String siteId,
 @PathVariable("id")
 UUID packageId)
                                                            throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

getPublishingHistory

@Valid
@GetMapping(value="/publishing/history",
            produces="application/json")
public @Valid PaginatedResultList<DashboardPublishingPackage> getPublishingHistory(@RequestParam("siteId")
 String siteId,
 @RequestParam(value="publishingTarget",required=false)
 String publishingTarget,
 @RequestParam(value="approver",required=false)
 String approver,
 @RequestParam(value="dateFrom",required=false) @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateFrom,
 @RequestParam(value="dateTo",required=false) @DateTimeFormat(iso=DATE_TIME)
 ZonedDateTime dateTo,
 @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
 @jakarta.validation.constraints.PositiveOrZero int offset,
 @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
 @jakarta.validation.constraints.PositiveOrZero int limit)
                                                                            throws SiteNotFoundException

Throws:

SiteNotFoundException

getPublishingHistoryDetail

@Valid
@GetMapping(value="/publishing/history/{id}",
            produces="application/json")
public @Valid PaginatedResultList<SandboxItem> getPublishingHistoryDetail(@RequestParam("siteId")
 String siteId,
 @PathVariable("id")
 UUID packageId,
 @PositiveOrZero @RequestParam(value="offset",required=false,defaultValue="0")
 @jakarta.validation.constraints.PositiveOrZero int offset,
 @PositiveOrZero @RequestParam(value="limit",required=false,defaultValue="10")
 @jakarta.validation.constraints.PositiveOrZero int limit)
                                                                   throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

getPublishingStats

@Valid
@GetMapping(value="/publishing/stats",
            produces="application/json")
public @Valid ResultOne<PublishingStats> getPublishingStats(@RequestParam("siteId")
 String siteId,
 @RequestParam("days")
 int days)
                                                     throws SiteNotFoundException

Throws:

SiteNotFoundException