Input Parameters

Name

Data Type

Value Required?

Placeholder or Constant

Description

global_properties

Object

Yes

Not
applicable

This object specifies the global settings for your EnterpriseTrack instance.

See "global_properties Object" for details.

application_data

Object

Yes

Not
applicable

This object specifies the search criteria.

See "application_data" for details.

application_data

resource_
descriptor

Object

Yes

Not
applicable

This object specifies the resource.

An error results in the event a matching resource cannot be found.

See "resource_descriptor" for details.

start_date_from

Date

No

<start_from>

Specifies the beginning date for the range of start dates.

This filters on actual (if present) or planned activity dates.

start_date_to

Date

No

<start_to>

Specifies the ending date for the range of start dates.

This filters on actual (if present) or planned activity dates.

end_date_from

Date

No

<end_from>

Specifies the beginning date for the range of end dates.

This filters on actual (if present) or planned activity dates.

end_date_to

Date

No

<end_to>

Specifies the ending date for the range of end dates.

This filters on actual (if present) or planned activity dates.

include_external_wa

Boolean

No

<incl_
external>

Indicates whether or not to consider external activities.

Valid values are:

TRUE

FALSE

include_closed_
wa

Boolean

No

<incl_closed>

Indicates whether or not to include closed activities.

Valid values are:

TRUE

FALSE (default)

max_rows

Integer

No

<max_rows>

Specifies the maximum number of rows of data to be fetched.

The default value is 20.

resource_descriptor

A value for at least one of the following parameters must be provided.

resource_id

String

No

<resource_
ID>

Specifies the resource ID.

If:

A resource_id value is specified

Then:

All other parameters are ignored.

Otherwise:

The other resource_descriptor parameters will be used to help identify the resource.

resource_login_id

String

No

<resource_
login_ID>

Specifies the login ID.

If:

A resource_id value is not specified

-and if-

A resource_login_id value is specified

Then:

All other parameters are ignored.

Otherwise:

The other resource_descriptor parameters will be used to help identify the resource.

resource_email

String

No

<resource_
email>

Specifies the e-mail address.

If:

A resource_id value is not specified

-and if-

A resource_login_id value is not specified

-and if-

A resource_email value is specified

Then:

All other parameters are ignored unless multiple resources use the same e‑mail address.

Otherwise:

The other resource_descriptor parameters will be used to help identify the resource.

resource_last_
name

String

No

<resource_
last_name>

Specifies the last name.

If:

A resource_id value is not specified

-and if-

A resource_login_id value is not specified

-and if-

A resource_email value is not specified, or multiple resources have the same e­mail address

Then:

A combination of the resource_last_name and resource_first_name values is used to identify the resource.

Otherwise:

The resource cannot be found and an error results.

resource_first_
name

String

No

<resource_
first_name>

Specifies the first name.