Resourcesearch

A resource search [Resourcesearch] is a definition of resource search criteria for a resource request queue.

—	XML	SOAP	REST	Database table
Object	Resourcesearch	oaResourcesearch	—	resourcesearch
Supported Commands	Add, Read, Modify, Delete	add(), read(), modify(), upsert(), delete()	—	—

The Resourcesearch object has the following properties:

XML / SOAP	Database	Description
advanced_options	advanced_options	JSON object detailing advanced search options (i.e. Required, Preferred, Excluding). Used for post-processing search results for ranking purposes.
as_percentage	as_percentage	A "1/0" field indicating which of the fields... hours or percentage is to be used in the search If 1 then use percentage. If 0 then use hours.
availability_search	availability_search	A 1/0 field indicating whether to search by availability.
consecutive_availability	consecutive_availability	A 1/0 field indicating no intervening bookings.
created	created	[Read-only] Time the record was created. See Date Fields.
customprofile_<N> Where <N> is an integer from 1 to 35	customprofile_<N> Where <N> is an integer from 1 to 35	Comma delimited list of customprofile_<N> that make up this search Each element is the ID followed by an optional attribute ID, separated by a colon (:).
education	education	Comma delimited list of educations that make up this search. Each element is the ID followed by an optional attribute ID, separated by a colon (:).
enddate	enddate	The end date for availability. See Date Fields.
essential	—	See Resource Search Virtual Fields.
excluding	—	See Resource Search Virtual Fields.
external_id	external_id	If the record was imported from an external system you store the unique external record ID here.
hours	hours	The number of hours of availability required over this range.
id	id	[Read-only] Unique ID. Automatically assigned by OpenAir.
include_generic_resources	include_generic_resources	A 1/0 field. Include generic resources in search?
include_inactive_resources	include_inactive_resources	A 1/0 field. Include inactive resources in search?
include_regular_resources	include_regular_resources	A 1/0 field. Include regular resources in search?
industry	industry	Comma delimited list of industries that make up this search. Each element is the ID followed by an optional attribute ID, separated by a colon (:).
jobrole	jobrole	Comma delimited list of job roles that make up this search. Each element is the ID followed by an optional attribute ID, separated by a colon (:).
location	location	Comma delimited list of locations that make up this search. Each element is the ID followed by an optional attribute ID, separated by a colon (:).
name	name	The resourcesearch name.
percentage	percentage	The percentage of time booked to this project during this daterange. This is either the actual booked percentage or derived from the hours.
preferred	—	See Resource Search Virtual Fields.
required	—	See Resource Search Virtual Fields.
resource_request_queue_id	resource_request_queue_id	The ID of the associated resource request queue.
skill	skill	Comma delimited list of skills that make up this search. Each element is the ID followed by an optional attribute ID, separated by a colon (:).
startdate	startdate	The start date for availability. See Date Fields.
updated	updated	[Read-only] Time the record was last updated or modified. See Date Fields.

Resource Search Virtual Fields

Resource searches use four virtual fields: essential, excluding, preferred and required. These fields are processed during read and write operations for Resource Demand Request (RDR) searches.

The fields use comma separated resourceprofile_type.id : attribute.id pairs to specify criteria.

Note:

Set attribute.id to 0 to include any level of the competency defined for the resource profile type or if there are no attribute sets defined for the resource profile.

The following example searches for resources who preferably have beginner CRM competencies, intermediate Linux competencies and a Master's degree:

• preferred set to the value 11:1,10:2,12:0.

• resourceprofile_type internal ID and name (id → name) pairs:

  • 10 → "Linux"

  • 11 → "CRM"

  • 12 → "Master's degree"

• attribute internal ID and name (id → name) pairs:

  • 1 → "Beginner"

  • 2 → "Intermediate"

  • 3 → "Expert"

• attribute.id = 1 for “Beginner”, 2 for “Intermediate”, and 3 for “Expert”.