NextGen APIs

GET /work-orders/execution/r1/interventions-resources

Http Verb

GET

Url

/work-orders/execution/r1/interventions-resources

Permissions required


Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2024 W3 (FSM 18.0)

Deprecated since


Removed since


Tech Tags

PAGINATION ORDERING-SERVER-SIDE

Business Logic

This API returns a list of resources and their related interventions filtered by input criteria. This API returns only resources that has at least one intervention in the provided input date range.

  • Resource ID (list)

  • Team Leader [not null] (Yes/No → Any)

  • Dates ranges

    • Expected/Actual [not null] → expected = interventionId.startDate/interventionId.endDate, actual = interventionId.outcome.startDate/interventionId.outcome.endDate

    • Start/end date range [not null] (limited to <= N days: ~ 7 days → configurable via company properties) → property on execution module

    • Start date and end date are the Intervention start and end date. We do not consider the take in charge and arrival dates. We can add these later if needed.

    • The Intervention end date may also be NULL in case of Actual dates.

  • Intervention status ID (list) – Document status sets that represent a functional status of the Intervention

  • Work Order ID (list) → call the wo operation search with the headers with integration services, and use the retrieved operations as filter

  • Work Order Operation ID (list)

Query String Parameters

Filter ℹ️

Field

Validations

Note

resourceId


Collection of Ids

operationCenterId



teamLeader



interventionRangeType

Not null

EXPECTED, EXPECTED_START, EXPECTED_END, ACTUAL, ACTUAL_START, ACTUAL_END

dateRange

Not null


statusId


Collection of Ids

workOrderId


Collection of Ids

workOrderOperationId


Collection of Ids

Order ℹ️

Default Order

Default.

Possible order values

No other ordering options available.

Page ℹ️

Default.

Fields ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

List of objects

Field

Note

resourceId


interventions

List of objects

interventions[item].interventionId


interventions[item].teamLeader


Response error codes

BASE_0003, WORKORDERS_ORCHESTRATOR_007, WORKORDERS_ORCHESTRATOR_008, WORKORDERS_ORCHESTRATOR_009