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

source_
application_
descriptor

Object

Yes

Not
applicable

This object specifies the information you want stored in the audit table. See "source_application_descriptor" for details.

security_
descriptor

Object

Yes

Not
applicable

This object specifies the authentication information to be verified. See "security_descriptor" for details.

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.

project_descriptor

Object

Yes

Not
applicable

This object specifies the project details.

See "project_descriptor" for details.

operation_type

String

Yes

<op_type>

Specifies the type of operation. Valid values are:

• INTERNAL_ACTIVITY
• EXTERNAL_ACTIVITY

test_mode

Boolean

No

<test_mode>

Indicates whether or not this invocation of this function is merely a test. Valid values are:

• TRUE
• FALSE (default)

If test_mode is FALSE, then the updates will be committed in the EnterpriseTrack database.

source_application_descriptor

source_app

String

Yes

<source_App>

Specifies the name of the source application.

source_ref_
unique_id

String

Yes

<source_ID>

Specifies the ID of the caller of the Integration function.

source_ref_
description

String

Yes

<source_desc>

Specifies the description of the caller of the Integration function.

source_ref_type

String

Yes

<source_type>

Specifies the reference type of the caller of the Integration function.

security_descriptor

authorization_
policy

String

Yes

<auth_policy>

Specifies the authorization policy to be used. Valid values are:

• AUTHORIZE_WITH_LOGIN_RESOURCE - Execute using the permissions of the logged in Integration user.
• AUTHORIZE_WITH_RECORD_LOCATOR_RESOURCE - Execute using the permissions of the resource specified in resource_descriptor.
• AUTHORIZE_WITH_AUTHORIZATION_
POLICY_GIVEN_RESOURCE - Execute using the permissions of the resource specified in authorization_policy_given_resource_
descriptor.

authorization_
policy_given_
resource_
descriptor

Object

Optionally required (see description)

Not applicable

Required only if authorization_policy has the AUTHORIZE_WITH_AUTHORIZATION_POLICY_GIVEN_RESOURCE value.

This object specifies the resource whose permissions should be used to execute the function. See "authorization_policy_given_resource_descriptor" for details.

authorization_policy_given_resource_descriptor

resource_id

String

No

<auth_
resource_
ID>

Specifies the resource ID of the authorized resource.

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

<auth_
resource_
login_ID>

Specifies the login ID of the authorized resource.

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

<auth_
resource_
email >

Specifies the e-mail address of the authorized resource.

If a resource_id and resource_login_id values are not specified and 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

<auth_
resource_
last_name>

Specifies the last name of the authorized resource.

If a resource_id and resource_login_id values are not specified, and a resource_email value is not specified, or multiple resources have the same e­mail address, then the combination of the resource_last_name and resource_first_name values are used to identify the resource. Otherwise, the resource cannot be found and an error results.

resource_first_
name

String

No

<auth_
resource_
first_name>

Specifies the first name of the authorized resource.

resource_descriptor:

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

resource_id

String

No

<resource_
ID>

Specifies the resource ID of the resource.

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 of the resource.

If a resource_id value is not specified and 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 of the resource.

If resource_id and resource_login_id values are not specified, and 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, and a resource_login_id value are 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 are 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.

project_descriptor

All of the values can be NULL if you do not want to filter on the project.

If you want to filter on a project, either the project_id or the project_name should be specified. If the project_id and the project_name are both NULL, the project will default to "Operations Project." An error results if there is no project with name Operations Project.

project_id

String

No

<project_ID>

Specifies the ID for the project.

If specified and there are no matches, an error results.

project_name

String

No

<project_
name>

Specifies the name for the project.

If a project_id value is not specified and a project_name value is specified, then this data used to help identify the project. An error results if a match is not found.

project_manager

String

No

<project_
manager>

Specifies the name of the manager of the project.

project_status

String

No

<project_
status>

Specifies the status of the project.

Valid values match those configured for your EnterpriseTrack application and there is no default value. Some examples of the status for are project are:

• Active
• On Hold
• Cancelled
• Completed­Post Realization
• Closed­In Realization

project_program

String

No

<project_
program>

Specifies the name of the program associated with the project.

activity_
descriptor

Object

Yes

Not
applicable

This object specifies the details of the activity. At least one value must be specified. See "activity_descriptor" for details.

activity_descriptor

activity_id

String

Yes

<act_ID>

Specifies the activity ID to match.

The value is not case sensitive.

For internal activities, this corresponds to the EnterpriseTrack activity ID.

For external activities, this corresponds to the unique ID assigned for the activities tracked outside of the EnterpriseTrack.

For miscellaneous activities, this corresponds to the Enterprise category name.

An error results if no matching activity ID for the specified resource is found.

activity_percent_
completion

Number

No

<act_percent>

Specifies the percentage completion of the activity.

status_descriptor

Object

No

Not
applicable

This object specifies the status of the activity.

See "status_descriptor" for details.

status_descriptor

status_id

String

No

<act_ID>

Provides the ID of the status.

status_desc

String

No

<act_desc>

Provides the description of the status.