Package overit.geocallapp.wfm.orchestrator.scheduling.ux.rs1.schedulableactivities

Class SchedulableActivitiesService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.orchestrator.scheduling.ux.rs1.schedulableactivities.SchedulableActivitiesService

@RestController
@RequestMapping("scheduling/r1/ux/scheduling/schedulable-activities")
@Resource(logging=true)
public class SchedulableActivitiesService
extends PrivateService

REST service for managing schedulable activities in the daily plan.

This service provides endpoints to search and retrieve work order operations that can be scheduled.

The service is mapped to the APIPath.SCHEDULABLE_ACTIVITIES endpoint and requires authentication as it extends PrivateService.

Since:

22.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
SchedulableActivitiesService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<PageResponse<DTOSchedulableActivities>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOSchedulableActivitiesSearchFilter filter)	Retrieves a paginated collection of schedulable activities based on the provided filter criteria.

Methods inherited from class java.lang.Object

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

Constructor Details

SchedulableActivitiesService

public SchedulableActivitiesService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOSchedulableActivities>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @Valid
 @Valid DTOSchedulableActivitiesSearchFilter filter)
                                                                                              throws DAValidateException,
DAException

Retrieves a paginated collection of schedulable activities based on the provided filter criteria.

This endpoint performs a comprehensive search of work order operations that can be scheduled, applying the specified filters and returning results in a paginated format. The response can be customized using field selection and ordering parameters.

The search supports filtering by:

• Operation centers
• Work orders (ID, source, urgency)
• Request types
• Service types
• Technical object types (assets and accounts)
• Activities
• Operation statuses
• Date ranges (creation, appointment, start, end)

Parameters:

page - the pagination parameters (page number and size), required

fields - optional collection of field names to include in the response for projection

order - optional ordering specification for sorting the results

filter - the search filter containing criteria for schedulable activities

Returns:

a ResponseEntity containing a PageResponse with the list of DTOSchedulableActivities

Throws:

DAValidateException - if validation of the filter parameters fails

DAException - if a database error occurs during the search