Input Parameters

The input parameters described in the following table provide the search criteria (filter data) to identify the activity, as well as to specify the updated effort data you want to commit. This information should be provided in the JSON formatted data specified by <input_params>. Unless otherwise specified, all values are not case sensitive.

Note: This function includes a "test" feature (see test_mode) that allows you to verify that the information you include in the input parameters can be successfully committed. Since there is no mechanism to "roll back" invalid data, you are encouraged to "test" the data before actually committing any updates.

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 the "global_properties Object" for details.

application_data

Object

Yes

Not applicable

This object specifies the search criteria as well as the revised effort data. 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 tables. 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

Optionally required (see description)

Not applicable

Required only if operation_type has one of the following values:

  • INTERNAL_ACTIVITY
  • EXTERNAL_ACTIVITY
  • PROJECT_TIME

This object specifies the project details. See "project_descriptor" for details.

time_category_descriptor

Object

Optionally required (see description)

Not applicable

Required only if operation_type has one of the following values:

  • NON_PROJECT_TIME
  • NON_WORKING_TIME

This object specifies the category information for the effort. See "time_category_descriptor" for details.

operation_type

String

Yes

<op_type>

Specifies the type of operation. Valid values are:

  • INTERNAL_ACTIVITY
  • EXTERNAL_ACTIVITY
  • PROJECT_TIME
  • NON_PROJECT
  • NON_WORKING_TIME

test_mode

Boolean

No

<test_mode>

Indicates whether or not this invocation of the 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 following value:

  • AUTHORIZE_WITH_
    AUTHORIZATION_
    POLICY_GIVEN_
    RESOURCE - 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 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

<auth_

resource_

last_name>

Specifies the last name of the authorized resource.

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

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

<resource_first_name>

Specifies the first name of the resource.

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 the 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 if 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
  • Canceled
  • 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.

time_category_descriptor

Object

Yes

Not applicable

This object specifies the category for the effort. See "time_category_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_desc

String

No

<act_desc>

Specifies the external activity description to match.

For internal or miscellaneous activities, this can be NULL.

For external activities, this should match the name of the activity assigned in the EnterpriseTrack.

role_descriptor

Object

Yes

Not applicable

This object specifies the role. See "role_descriptor" for details.

effort_descriptor

Object

Yes

Not applicable

This object specifies the effort details. See "effort_descriptor" for details.

role_descriptor

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

If the role_id and the role_desc are both NULL and the resource has multiple roles in the specified project, an error results.

role_id

String

No

<role_ID>

Specifies the role ID to match.

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

role_desc

String

No

<role_ID>

Specifies the role description to match.

An error results if no matching role description for the specified resource is found.

effort_descriptor

update_action_code

String

Yes

<action_code>

Specifies how the values (for total_hours and overtime_hours) should be used. Valid values are:

  • REPLACE - Replace disregards the existing value and updates using the new value.
  • INCREMENT - Increment adds the new value to the existing value, then updates using the new sum.

date

Date

Yes

<date>

Specifies the date to be assigned to the effort.

If the effort is tracked using EnterpriseTrack timesheets, then the effort will be revised for the specified date. Otherwise if the effort is tracked as activities, then either the effort will be revised for the week in which the date occurs, or the date will be ignored, and the effort will be revised for that activity.

total_hours

Integer

Yes

<total_hrs>

Specifies the number of non‑overtime hours to include. See update_action_code for additional detail.

overtime_hours

Integer

No

<ot_hrs>

Specifies the number of overtime hours to include. See update_action_code for additional detail.

notes

String

No

<notes>

Specifies the remarks to be included with the effort.

If activities are tracked using EnterpriseTrack timesheets, the note will be appended to the timesheet notes. Otherwise, the note will be appended to the activity comments.

time_category_descriptor

time_category_desc

String

Optionally required (see description)

<time_cat>

Required only if operation_type has one of the following values:

  • NON_PROJECT
  • NON_WORKING_TIME

Specifies the description of the category.

effort_descriptor

Object

Yes

Not applicable

This object specifies the effort details. See "effort_descriptor" for details.


Legal Notices
Copyright © 2000, 2018, Oracle and/or its affiliates. All rights reserved.

Last Published Thursday, May 03, 2018