NextGen APIs

GET /workforce/crew-shells/r1/{crewShellId}/workshift-processing

Http Verb

GET

Url

/workforce/crew-shells/r1/{crewShellId}/workshift-processing

Permissions required

fsm.crewshells.workshifts.view

Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

FSM 25.0 (source @since)

Deprecated since

Not declared.

Removed since

Not declared.

Tech Tags

PAGINATION ORDERING-SERVER-SIDE

Pagination and ordering apply to the collection endpoint only. Field selection is available on both endpoints.

Business Logic

CrewShellWorkShiftProcessingService exposes read operations for crew shell work shift processing records.

Path parameters

Field

Validations

Note

crewShellId

Required

Destination crew shell ID of the process for collection search.

Query String Parameters

Field

Validations

Note

id

Collection of Long

Processing record IDs.

uuid

Collection of String

Processing UUID filter.

originalStartDate

ZonedDateTimeRange; FORM, explode=false

Original interval start date range.

originalEndDate

ZonedDateTimeRange; FORM, explode=false

Original interval end date range.

destinationStartDate

ZonedDateTimeRange; FORM, explode=false

Declared destination interval start filter. The business filter uses slotStartDate; end-to-end mapping is not established by the DTO declaration alone.

destinationEndDate

ZonedDateTimeRange; FORM, explode=false

Declared destination interval end filter. The business filter uses slotEndDate; end-to-end mapping is not established by the DTO declaration alone.

statusId

Collection of Long

Status IDs: 1 QUEUED, 2 IN_PROCESS, 3 COMPLETED, 4 ERROR. DTO provides getStatus() for mapping to the business filter.

processingDate

ZonedDateTimeRange; FORM, explode=false

Processing start date range.

creationUser

Collection of Long

Creating user IDs.

processingDuration

Long; optional

Filters by processing duration in minutes.

totalDays

Long; optional

Filters by total days in the destination interval.

workShiftsDuplicated

Long; optional

Filters by duplicated work shifts.

emptiedWorkShifts

Long; optional

Filters by emptied work shifts.

totalCompositions

Long; optional

Filters by total compositions.

emptiedCompositions

Long; optional

Filters by emptied compositions.

Order

Optional _order string, available on the collection endpoint; forwarded to the shared REST search helper.

Page

Fields

Optional _fields collection of strings on both endpoints. Passed to the shared REST helper for response field selection. Use the response DTO field names listed below.

Header Parameters

Default private-service headers and authentication. No additional endpoint-specific header parameters are declared. Response Content-Type: application/json.

Response documentation

Response payload fields

Field

Note

id


sourceCrewshellId


destinationCrewshellId


uuid


originalStartDate


originalEndDate


destinationStartDate


destinationEndDate


statusId


logMasterId


processingDate


totalWorkshifts


workShiftsErrors


compositionErrors


creationUserId


processingDuration

Long. Processing duration in minutes.

totalDays

Long. Total days in the destination interval.

workShiftsDuplicated

Long. Duplicated work shifts.

emptiedWorkShifts

Long. Emptied work shifts.

totalCompositions

Long. Total compositions.

emptiedCompositions

Long. Emptied compositions.

Response error