Introduction§

The Yesplan query language makes it possible to search for certain information in Yesplan. You do this by performing queries.

In its simplest form, a query consists of looking up all elements (such as events, resources, contacts, etc.) with a certain name. The power of the query language lies in its ability to search specifically using a wide range of characteristics from those elements, such as the type of element (event, resource, contact, etc.), a date, a certain period, a label, a certain custom data field value, etc.

The result of a query is a list of elements that match the characteristics that were requested in the query.

This document consists of two parts:

  1. A description of how the query language works and how queries are composed.
  2. Examples of the query language’s capabilities.

The Query Language§

Search Boxes§

There are two types of search boxes in Yesplan: a general search box and search boxes for specific elements (events, resources, contacts and tasks).

In each of the search boxes you can enter a query in the search field at the top. The list of results displayed in the search box will be limited to items that match the query. In a specific search box, the results are limited to that specific type. In other words, events cannot be looked up in the contacts search box. Query results can also be filtered so that you are only searching within elements that belong to your own user group.

Specific search boxes are called up by clicking on the “Search …” menu item of the “Events”, “Resources”, “Contacts” or “Tasks” navigation menu items.

You can search through all elements, regardless of their type, in the general search box. This search box is activated by clicking on “Search” in the navigation menu.

In the search boxes you can save a query for future use. You do this by clicking on “Saved Queries” then making a query (“Add Query”) or choosing an existing query. The selected query will be performed immediately. You can also customize saved queries via the “Edit” button.

The Structure of a Query§

In the most general form, a Yesplan query consists of three parts:

scope:keyword:word

A few examples:

The scope of a query determines which type of element you will search in. If you are only looking for events, you use event as the scope, for resources you use resource, etc. A summary of scopes at the end of this document displays a list of all scopes supported by Yesplan. Please note that the word scope is written in English even if you set the Yesplan language to Dutch.

The keyword determines which characteristic of an element will be searched. Some examples include name, location, date, label, etc. A summary of keywords at the end of this document displays a list of valid keywords that you can use in Yesplan as well as the scope in which they are applicable. Please note that the word keyword is written in English even if you set the Yesplan language to Dutch.

The last part of a query is a word . This describes the textual value that you search in within the characteristics that you have indicated based on the keyword. The query resource:role:sound will search for all resources whose role contains the name ‘sound’. Please note that the word enter in the query (e.g. ‘sound’) only has to be part of the effective value in Yesplan. The previous query will also result in all resources with a ‘sound engineer’ role.

Please note that the word is not case-sensitive; ‘jan’ gives the same results as ‘Jan’.

Simple Queries§

We will explain the concepts above based on a few examples.

Let’s take a look at the query below:

event:name:othello

The scope of this query is event, the keyword is name and the word is othello.

The result of this query will be a list of all events whose name contains ‘othello’. The word doesn’t have to match the value of the characteristic exactly; it can be part of the value. In the example below you see that events with the name “Othello”, “Othello 1”, “Othello 2” and “Othello 3” are displayed as results. Please note that this rule applies to most keywords in which the desired characteristic is a name or a piece of text such as name. For keywords in which the desired characteristic is a date or a number, the match will have to be exact.

Please note that a word cannot contain spaces. If you want a search term to contain spaces, you must add double quotation marks ("…") around the words, for example:

group:name:"The Film Festival"

The result of this query will contain the event group with the name ‘The Film Festival’.

In addition to spaces, a word cannot contain the following symbols: * # : ( ). These symbols are part of the syntax of the query language. This will become clear in a moment. If you want to include one of these symbols in a word, you must use double quotation marks.

A special case that is supported within the query language is an empty word with quotation marks around it (""). If you use this then the absence of a value for the keyword will be checked. The query below will request all people who don’t have a label.

person:label:""

The absence of a value is only checked where the keyword is applicable. Under resources, for example, the keyword team is only applicable on resources of the “Person” type because only such resources can be part of a team. The query below requests all resources in which the team keyword is applicable but there is no value. The result is all resources of the “Person” type that are not part of a team. Resources of other types will not appear in the results.

resource:team:""

If the type of element that you want to look up is not important, you can omit the scope of a query. If we want to search for all elements in Yesplan that have a ‘rental’ label, you enter the following query:

label:rental

The result is a list of different types of elements, e.g. an event, a resource and a contact.

Finally, it is also possible to omit the keyword in a query and only enter a word. In that case the query language will search all elements in Yesplan whose name contains the word.

For example:

othe

The result of this query will show the events “Othello”, “Othello 1”, “Othello 2”, “Othello 3”, as well as the event group “Othello production”.

Using a Wildcard§

To indicate that it does not matter what the value of a certain characteristic is, you can use a wildcard. The wildcard is written as an asterisk (*). The wildcard works like the reverse of an empty word ("") and it checks the presence of a value.

The query below requests all resources of any type:

resource:type:*

Please note that when you use a wildcard as a word it can only give results that have a value for the keyword that you entered.

Let’s take a look at the query below:

person:label:*

This query will request all people who have a label; people without a label will not be displayed.

If a keyword is not applicable, it cannot have a value. The query below requests all resources that are part of a team. These will always be resources of the “Person” type: the keyword team is only applicable on such resources because only they can be part of a team.

resource:team:*

The wildcard can also be used as a keyword. The query below will request all contacts for which any characteristic contains the value ‘jan’.

contact:*:jan

Use of Dates and Periods§

The query language offers extensive functionality to ask questions in which the desired characteristic is a certain date or falls in a certain period.

For dates you can search for an exact match with a certain date. A date is entered in the format dd-mm-yyyy (day, month, year). The query below will request all events that take place on 28 March 2013:

event:date:28-03-2013

Remark

For keywords where the desired characteristic is a date, different rules apply for finding a match than for textual characteristics. For textual characteristics there is a match if the value of the characteristic contains the entered word. The match will be exact for dates.

The query language enables you to use a period as a word. A period is noted using two dates that are separated by TO. Please note that you must separate the dates from the word TO with a space. There is a match if the date falls within the entered period. For example, we can request all events from 15 March through 30 March 2013 using the query below:

event:date:15-03-2013 TO 30-03-2013

In addition to searching for a specific date, or a specific period, the query language also offers some special words that can be used to select by date.

For example:

event:date:#today

This query uses the word #today to limit the request to all events that take place today. Similar special words include:

Word Description
#tomorrow the date matches tomorrow
#yesterday the date matches yesterday
#thisweek the date falls in the current calendar week; this is the week that starts on the most recent Monday and runs through the next Sunday
#previousweek the date falls in the previous calendar week; this is the week that ends before the most recent Monday
#nextweek the date falls in the next calendar week; this is the week that begins after the next Sunday
#thismonth the date falls in the current calendar month
#previousmonth the date falls in the previous calendar month
#nextmonth the date falls in the next calendar month
#thisyear the date falls within the current calendar year
#previousyear the date falls within the previous calendar year
#nextyear the date falls within the next calendar year
#nextXdays the date falls in the X number of calendar days after today; #next1days is the same as #tomorrow
#previousXdays the date falls in the X number of calendar days preceding today; #previous1days is the same as #yesterday
#nextXweeks the date falls in the X number of calendar weeks following the calendar week from today; #next1weeks is the same as #nextweek
#previousXweeks the date falls in the X number of calendar weeks preceding the calendar week from today; #previous1weeks is the same as #previousweek
#nextXmonths the date falls in the X number of calendar months following the calendar month from today; #next1months is the same as #nextmonth
#previousXmonths the date falls in the X number of calendar months preceding the calendar month from today; #previous1months is the same as #previousmonth
#nextXyears the date falls in the X number of calendar years following the calendar year from today; #next1years is the same as #nextyear
#previousXyears the date falls in the X number of calendar years preceding the calendar year from today; #previous1years is the same as #previousyear

Notice that for the #nextX… and #previousX… keywords, the X must be replaced with a number; event:date:#nextXdays will not work, event:date:#next7days will work.

Requesting Custom Data§

With the query language we can also search for Yesplan elements based on custom data field values. To do this, the custom data field keyword must be used as a keyword in the query.

Every custom data field automatically receives a keyword. This is displayed in the system settings under the custom data field definition. Administrators can also determine this automatically awarded keyword themselves by overriding the value.

The automatically awarded keyword is a compilation of the group, the block and the label of the custom data field, always separated by an _ (underscore). Please note that all spaces and special characters (like ! ? ; etc.) must be deleted and that capital letters must be converted to lower case letters. This automatically awarded keyword is called the ‘hierarchic label’.

For example, the custom data field with the label “Manager” in the picture below automatically receives the keyword production_info_manager.

Then you can request all resources where the “Manager” is “Sarah Peeters” with the following query:

resource:production_info_manager:"Sarah Peeters"

It’s often easier – or advisable – for a Yesplan administrator to set the custom data field keywords. Please take into account that the custom data field keyword must be unique; it cannot result in two equal values.

For example, the picture below shows the custom data field definition with the label “Operator” for which the administrator awarded the keyword “operator”.

All resource bookings for which the custom data field has the value “Jan Janssens” can be requested with the following query:

resourcebooking:operator:"Jan Janssens"

Remark

Notice that specifying a keyword for a custom data field does not exclude the use of the hierarchic label for this custom data field. In other words, the queries resourcebooking:operator:"Jan Janssens" and resourcebooking:production_info_operator:"Jan Janssens" both give in the same result.

Requesting Numeric Fields§

For keywords where the desired characteristic is a number, different rules apply for finding a match than for textual characteristics.

For textual characteristics there is a match if the value of the characteristic contains the entered word. For example, the query event:name:othello will find an event named “Othello” as well as an event named “Othello 2”.

For numbers, there is a match if the value matches exactly. For example, if free_seats is the keyword of a numeric custom data field, the result of the query event:free_seats:23 will only find events for which the value of the custom data field is exactly ‘23’ and not events where the value of the custom data field is ‘123’ or ‘234’.

Please note that this exact match is not valid for regular input fields where you (sometimes or always) enter a number. A numeric input field is a specific type of custom data field.

Requesting Addresses of Contacts§

A contact can have one or more addresses. Each of these addresses is of a certain address type. Per contact there is always one address marked as “default”, the default address. Address types are managed via the system settings.

The keywords address, street, zip, city, country and country code always request the default address. The query language also foresees keywords for all the different types of addresses that a contact can have. These variants are formed by the default keyword, preceded by the name of the address type and an _ (underscore).

For example: for the “Billing” address type the keywords are billing_address, billing_street, billing_zip, billing_city, billing_country and billing_countrycode.

Please note: when composing the keyword, the same rules apply as for the automatic awarding of keywords for custom data fields. Spaces and special characters (e.g. ! ? ; etc.) are deleted and capital letters are converted to lower case letters. (An administrator can find the keyword in the system settings under the “Contacts” tab under “Address Types”.)

For example: for the “Headquarters” address type the keywords are headquarters_address, headquarters_zip, etc.

The variants of the keywords always request the address of a certain address type, whether this address is marked as the default address or not.

For example, with the query contact:city:Gent you search for all contacts whose city contains “Gent” in the default address. With the query contact:billing_city:Gent you search for all contacts whose city contains “Gent” in the “billing” type of address.

Composing Queries§

With the query language it is possible to combine the results of different queries: you can calculate the intersection, the union or the difference of query results.

The Intersection of Two Queries§

The intersection of the results of two queries is obtained by writing them in one query separated with a space. An intersection allows you to search for Yesplan elements that match multiple conditions. In other words, both the first query and the second query must be true.

For example, if we are looking for all events that contain the name ‘Shakespeare’ and that are taking place this week, we would use the following compound query:

event:date:#thisweek event:name:Shakespeare

The first part of this compound query is the condition event:date:#thisweek, which brings up all events that take place this week. The second condition in this compound query, event:name:Shakespeare, will further limit the results of the first part to those that also contain the name ‘Shakespeare’.

Tip

Please note: on a technical level, the intersection is calculated by calculating the results of the first query then further limiting them to the results that also match the second query. To get results as quickly as possible, it is opportune to place the query that will limit the number of results the most at the beginning of the compound query.

Consider the next two queries, which request all events where the custom data field ‘Responsible’ contains the value ‘Jan Janssens’ and that takes place today.

event:responsible:"Jan Janssens" event:date:#today

and

event:date:#today event:responsible:"Jan Janssens"

Both queries will provide the same results, but the second example offers a better solution since the events are limited to those taking place today before further filtering for the value of the custom data field. The first query will have to run through all events in order to find those where the value ‘Jan Janssens’ is entered under ‘Responsible’. Then these results will be further limited to events that take place today.

When creating compound queries that request a certain time period, it’s generally better to place the part that limits the events to a certain period first, before filtering these results further.

The Union of Two Queries§

By using a + between two queries, we get the union of the results of both queries. A union is useful when you are looking for elements that match either one condition or the other. Let’s illustrate a union with an example. We want to find all resources in Yesplan that are either of the ‘material’ type or the ‘human’ type:

resource:type:material + resource:type:human

Please note that it’s important to place a space before and after the + to separate the two queries.

The Difference Between Two Queries§

By using a - between two queries, we get the difference between the results of both queries. The difference is all elements that match the first part of the compound query, but not the second part. For example, de next query searches for all events that take place this month, but not this week:

event:date:#thismonth - event:date:#thisweek

Please note that it’s important to place a space before and after the - to separate the two queries.

Compound Queries with More Than Two Queries§

When compounding queries, you are not limited to two. You can combine an arbitrary number of queries.

In a compound query, when we only use the union (+) or the intersection (space), we simply place the different parts of the query after each other.

For example:

event:location:ballroom + event:location:theatre + event:location:gymnasium

When you mix different operators (+, - or space) in a query, you must indicate which parts of the query belong together. To do this you use round brackets, ( and ).

For example, if we want to look for all events that occur in the Ballroom and take place either this week or whose name contains ‘Hamlet’ then the query would be:

event:location:ballroom (event:date:#thisweek + event:name:hamlet)

If we leave out the brackets – event:location:ballroom event:date:#thisweek + event:name:hamlet – then the meaning of the query is ambiguous. An order has not been defined for executing the intersection and the union. As a result, Yesplan will choose between the next two possible meanings:

The next query results in all events that contain ‘Hamlet’ or that take place this month but not this week:

event:name:hamlet + (event:date:#thismonth - event:date:#thisweek)

If we want to express that we are searching for all events that either contain ‘Hamlet’ or take place this month, and that do not take place this week, then you must change the query above like this:

(event:name:hamlet + event:date:#thismonth) - event:date:#thisweek

Query Language Summary§

Summary of Scopes§

The tables below give a summary of all possible values for the scope of a query with a description of exactly which elements are being requested.

Scopes Events§

Scope Description
event All events.
group All event groups.
production All events and event groups that are a production.

Scopes Contacts§

Scope Description
contact All people and organizations as well as the links between both.
person_or_organization All people and organizations, excluding the links.
person All people.
organization All organizations.
contactlink All links between people and organizations.
contactbooking All bookings of people, organizations or the links between both.

Scopes Resources§

Scope Description
resource All resources (including placeholders).
resourceplaceholder All placeholders.
location All locations.
team All teams.
resourcebooking All resource bookings (including placeholders) or locations.

Scopes Tasks§

Scope Description
task All tasks.
taskgroup All task groups.

Summary of Keywords§

Some keywords are general and can be used for multiple scopes. They include the keywords id, name, owner, ownergroup and history.

The tables below give a summary of all possible keywords per scope, with a description of what exactly is being requested from the elements.

Keywords for Events, Event Groups and Productions§

The table below gives a summary of information that can be requested with the scope event, group or production.

Keyword Valid scopes Description
contact event, group, production The element’s contacts (excluding the contacts booked via custom data fields).
contactrole event, group, production The roles of the element’s booked contacts (excluding the contacts booked via custom data fields).
date event, group, production The date when the element takes place.
defaultschedule event The description of the displayed start or end time of the element’s schedule.
document event, group, production The element’s attachments (documents and other things) (excluding the attachments added via custom data fields).
end event The end date of an event.
group event, group, production The event group that the element belongs to.
history event, group, production The items that were added manually to the element’s history.
id event, group, production The element’s Yesplan ID.
inproduction event, group It is true if the element is in a production, otherwise it is false.
isproduction event, group It is true if the element is a production, otherwise it is false.
label event, group, production The element’s labels.
location event, group, production The locations where the element takes place.
name event, group, production The element’s name.
owner event, group, production The element’s owner.
ownergroup event, group, production The user group that owns the element.
production event, group The production that the element belongs to.
profile event, group, production The element’s profile; if an event group exists whose events have different profiles, this will return a n/a.
profiles event, group, production The element’s profile; for an event group this will yield a result if at least one event in the event group has this profile.
schedule event The description of a schedule item of the element’s schedule.
start event The start date of an event.
status event, group, production The element’s status; if an event group exists whose events have different statuses, this will return a n/a.
statuses event, group, production The element’s status; for an event group this will yield a result if at least one event in the event group has this status.
statustype event, group The element’s status type; if an event group exists whose events have different statuses, this will not yield a result.
subevent group The name of the events that are part of the event group.

Keywords for Resources, Placeholders, Locations and Teams§

The table below gives a summary of information that can be requested with the scope resource, resourceplaceholder, location or team.

Keyword Valid scopes Description
account resource, resourceplaceholder, location, team The accounting number of the element’s default price definition.
activecontract resource The active contract; only applicable for resources of type human.
active resource, resourceplaceholder, location, team It is true if the element is active, otherwise it is false.
contact resource, resourceplaceholder, location, team The element’s contacts (excluding the contacts booked via custom data fields).
contract resource, location The contracts that are applicable on the resource; only applicable for resources of type human.
costprofile resource, resourceplaceholder, location, team The event profile associated with the element’s default price definition.
costprofiles resource, resourceplaceholder, location, team The event profiles associated with an element’s price definition.
date resource, location The (purchase) date of the resource; not applicable on resource sets.
description resource, location, team A description of the element.
document resource, resourceplaceholder, location, team The element’s attachments (documents and other things) (excluding the attachments added via custom data fields); not applicable on resource sets.
external resource, resourceplaceholder, location, team It is true if the element is external, otherwise it is false.
group resource, resourceplaceholder, location, team The resource group that the element belongs to.
history resource, resourceplaceholder, location, team The items that were added manually to the element’s history.
id resource, resourceplaceholder, location, team The element’s Yesplan ID.
invoice resource, resourceplaceholder, location, team It is true if the default price definition is to be billed, otherwise it is false (refers to the field “To Be Billed”).
label resource, resourceplaceholder, location, team The element’s roles; identical to keyword role.
member team The human resources that are part of the team.
name resource, resourceplaceholder, location, team The element’s name.
owner resource, location, team The element’s owner.
ownergroup resource, location, team The user group that owns the element.
productcode resource, location The element’s product code; not applicable on resource sets.
resourcespecies resource, resourceplaceholder, location, team The type of resource; possible values are set, adhoc, bulk, placeholder and instantiatable.
rented resource, resourceplaceholder, location, team It is true if the element is rented, otherwise it is false.
role resource, resourceplaceholder, location The element’s roles.
serialnumber resource, location The element’s serial number; not applicable on resource sets.
team resource, team The element’s team; only applicable for resources of type human.
type resource, resourceplaceholder, location The element’s type; possible values are human, material, service or financial.

Keywords for Resource Bookings§

The table below gives a summary of information that can be requested with the scope resourcebooking.

Keyword Valid scopes Description
account resourcebooking The account number of the booking’s cost set.
accountableto resourcebooking The contact to which the booking was awarded for the price calculation (refers to the field “Billable to”).
actualstart resourcebooking The actual start date of the booking; only applicable for bookings on events with an “allow actuals” status type.
actualend resourcebooking The actual end date of the booking; only applicable for bookings on events with an “allow actuals” status type.
costprofile resourcebooking The cost set used for the booking.
date resourcebooking The date when the booking takes place.
description resourcebooking A description of the resource of the booking; not applicable for bookings of placeholders.
end resourcebooking The end date of the booking.
event resourcebooking The event of the booking.
external resourcebooking It is true if the resource of the booking is external, otherwise it is false.
group resourcebooking The group of the booked resource.
history resourcebooking The items that were added manually to the element’s history (the booking does not have its own history).
id resourcebooking The element’s Yesplan ID.
invoice resourcebooking It is true if the booking is to be billed, otherwise it is false (refers to the field “To Be Billed”).
label resourcebooking The element’s labels.
location resourcebooking The location where the event of the booking takes places.
name resourcebooking The element’s name.
owner resourcebooking The element’s owner.
ownergroup resourcebooking The user group that owns the element.
productcode resourcebooking The product code of the booked resource.
resourcespecies resourcebooking The type of booked resource; possible values are set, adhoc, bulk, placeholder and instantiatable.
rented resourcebooking It is true if the booked resource is rented, otherwise it is false.
role resourcebooking All roles of the booked resource.
serialnumber resourcebooking The serial number of the booked resource.
start resourcebooking The start date of the booking.
team resourcebooking The bookings of the people who belong to a certain team.; only applicable for resource bookings of type human.
type resourcebooking The type of the booked resource.
usedrole resourcebooking The role used for the booking; only applicable for resource bookings of type human.

Keywords for Contacts§

The table below gives a summary of information that can be requested with the scope contact, person, organization, person_or_organization or contactlink.

Keyword Valid scopes Description
address contact, person, organization, person_or_organization The full default address of the element.
{adrestype}_address contact, person, organization, person_or_organization The full address of the element’s {adrestype} type.
anycomment contact, person, organization, person_or_organization, contactlink The value of the element’s comment field; for person, organization and person_or_organization, the comment of their contact links are taken into as well.
anycontactinfo contact, person, organization, person_or_organization, contactlink The element’s contact information; for person, organization and person_or_organization, the contact information of their contact links are taken into account as well.
anylabel contact, person, organization, person_or_organization, contactlink The element’s labels; for person, organization and person_or_organization, the labels of their contact links are taken into account as well.
city contact, person, organization, person_or_organization The city of the element’s default address.
{adrestype}_city contact, person, organization, person_or_organization The city of the address with the element’s {adrestype} type.
comment contact, person, organization, person_or_organization, contactlink The value of the element’s comment field.
contactinfo contact, person, organization, person_or_organization, contactlink The element’s contact information.
country contact, person, organization, person_or_organization The country of the element’s default address.
{adrestype}_country contact, person, organization, person_or_organization The country of the address with the element’s {adrestype} type.
countrycode contact, person, organization, person_or_organization The country code of the element’s default address.
{adrestype}_countrycode contact, person, organization, person_or_organization The country code of the address with the element’s {adrestype} type.
department contact, person, organization, person_or_organization The department of one of the links of a person or organization.
document contact, person, organization, person_or_organization, contactlink The element’s attachments (documents and other things) (excluding the attachments added via custom data fields).
duplicate contact, person, organization, person_or_organization The name of the contacts that are a possible double of this contact.
firstname person The first name of a person.
history contact, person, organization, person_or_organization, contactlink The items that were added manually to the element’s history.
id contact, person, organization, person_or_organization, contactlink The element’s Yesplan ID.
jobtitle contact, person, organization, person_or_organization The job title of one of the links of a person or organization.
label contact, person, organization, person_or_organization, contactlink The element’s labels.
language contact, person, organization, person_or_organization The element’s language.
languagecode contact, person, organization, contact, person_or_organization The language code of the element confer the ISO 639.2 list.
lastname person The last name of a person.
link contact, person, organization, person_or_organization The name of the element’s link.
name contact, person, organization, person_or_organization, contactlink The element’s name.
owner contact, person, organization, person_or_organization, contactlink The element’s owner.
ownergroup contact, person, organization, person_or_organization, contactlink The user group that owns the element.
street contact, person, organization, person_or_organization The street name and street number (the two lines with the label ‘Street’) of the element’s default address.
{adrestype}_street contact, person, organization, person_or_organization The street name and street number (the two lines with the label ‘Street’) of the address with the element’s {adrestype} type.
title person The title of a person.
type organization The business entity of an organization.
zip contact, person, organization, person_or_organization The ZIP code of the element’s default address.
{adrestype}_zip contact, person, organization, person_or_organization The ZIP code of the address with the element’s {adrestype} type.

Keywords for Contact Bookings§

The table below gives a summary of information that can be requested with the scope contactbooking.

Keyword Valid scopes Description
contact contactbooking A contact booking for a certain contact – notice the difference with the keyword ofcontact.
contactrole contactbooking The roles of the booked contacts (including the contacts booked via custom data fields).
event contactbooking A contact booking for a certain event (including the contacts booked via custom data fields).
eventdate contactbooking A contact booking for an event that takes place on a certain date.
history contactbooking The items that were added manually to the element’s history (the booking does not have its own history).
id contactbooking The element’s Yesplan ID.
label contactbooking The element’s labels.
name contactbooking The element’s name.
ofcontact contactbooking The booked contact – notice the difference with the keyword contact.
owner contactbooking The element’s owner.
ownergroup contactbooking The user group that owns the element.
resource contactbooking A contact booking for a certain resource.
type contactbooking The business entity of the booked organization.

Keywords for Tasks and Task Groups§

The table below gives a summary of information that can be requested with the scope task and taskgroup.

Keyword Valid scopes Description
assignedby task, taskgroup The person who assigned the task.
assignedto task, taskgroup The person to whom the task is assigned.
description task A description of the task.
document task, taskgroup The element’s attachments (documents and other things).
due task, taskgroup The due date of the task.
event task, taskgroup The event to which the element is linked.
history task, taskgroup The items that were added manually to the element’s history.
id task, taskgroup The element’s Yesplan ID.
name task, taskgroup The element’s name.
owner task, taskgroup The element’s owner.
ownergroup task, taskgroup The user group that owns the element.
start task, taskgroup The start date of the element.
status task, taskgroup The element’s status; possible values are new, started, done on hold and obsolete.
team task, taskgroup The team to which the task is awarded.