NextGen APIs

GET /workforce/resources/r1/resources

nameHttp Verb

GET

Url

/workforce/resources/r1/resources

Permissions required

Resource Configuration: View (fsm.core.resource.configuration.view)

Personally Identifiable Information (PII)

Si

Sensitive Information

No

Last Modified Version

r1

Released since

2024 W1 (FSM 16.0)

Deprecated since


Removed since


Tech Tags

PAGINATION ORDERING-SERVER-SIDE

Business Logic

This API returns a list of Resources filtered by input criteria.

Query String Parameters

Filter ℹ️

Field

Validations

Note

id

 


surname

 


name



birthDate

Format: ISO-8601


startDate

Format: ISO-8601


endDate

Format: ISO-8601


email

Format: RFC 5322 email address format


operationCenterId

 


mobilePhone



startAddressId



endAddressId



identificationNumber



secondaryIdentificationNumber



resourceTypeId



color

Format: Hexadecimal i.e. #FF990C


vehicleId



order



singleTeamId



workCenterId



loan


2024 W3 (FSM 18.0)

loanSourceId


2024 W3 (FSM 18.0) In case of loaned resource record, it refers to the id of the origin resource.

copyCompetencies


2024 W3 (FSM 18.0) Checks whether the competencies (only skills for now) need to be copied from the original source to all the related resource on loan during update.

Order ℹ️

Default Order

order (ASC), surname (ASC), name (ASC)

Possible order values

All response payload fields.

Page ℹ️

Default.

Fields ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields


Field

Note

id

 

surname


name


birthDate

 

startDate


endDate


email

 

operationCenterId

 

mobilePhone

 

startAddressId


endAddressId


identificationNumber


secondaryIdentificationNumber


resourceTypeId


color


vehicleId


order


singleTeamId


workCenterId


loan

2024 W3 (FSM 18.0)

loanSourceId

2024 W3 (FSM 18.0)

copyCompetencies

2024 W3 (FSM 18.0)

Response error codes

BASE_0001