Output Parameters

global_properties

Object

This object lists the global settings for your EnterpriseTrack instance.

See "Global Properties Object" for details.

application_data

Object

This object provides the results.

See "application_data" for details.

application_data

et_transaction_id

String

This is the unique EnterpriseTrack transaction ID that is stored in the audit tables.

result_code

String

Provides the result code for the completion status of the function.

result_reason

String

If the function is successful, NULL is returned.

Otherwise, the reason for the error is returned.

project_descriptor

Object

This object contains the details of the project.

See "project_descriptor" for details.

timesheet_
descriptor

Object

This object contains the details of the timesheet.

This is provided only if the effort is tracked using EnterpriseTrack timesheets.

See "timesheet_descriptor" for details.

project_descriptor

project_id

Integer

Provides the ID for the project.

project_name

String

Provides the name for the project.

project_manager

String

Provides the name of the manager of the project.

project_status

String

Provides 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

Provides the name of the program associated with the project.

activity_
descriptor

Object

This object contains the details of an activity.

See "activity_descriptor" for details.

time_category_
descriptor

Object

This object contains the details of the time category of an activity.

See "time_category_descriptor" for details.

activity_descriptor

activity_id

String

Provides the ID of the activity.

activity_desc

String

Provides the description of the activity.

activity_total_
effort

Integer

Provides the total number of hours (to date) for the activity.

activity_name

String

Provides the name of the activity.

time_category_descriptor

time_category_
desc

String

Provides the description of the time category.

effort_descriptor

Object

This object specifies the effort details.

See "effort_descriptor" for details.

effort_descriptor

update_action_
code

String

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 and then updates using the new sum.

date

Date

Specifies the date to be assigned to the effort.

If:

The effort is tracked using EnterpriseTrack timesheets and then the effort will be revised for the specified date.

Else 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

Specifies the number of non-overtime hours to include.

See update_action_code for additional detail.

overtime_hours

Integer

Specifies the number of overtime hours to include.

See update_action_code for additional detail.

notes

String

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.

timesheet_descriptor

timesheet_id

String

Provides the ID of the activity.

timesheet_start_
date

Date

Provides the start date of the activity.

timesheet_end_
date

Date

Provides the end date of the activity.

timesheet_total_
hours

Integer

Provides the total number of hours (to date) for the activity.

timesheet_
overtime_hours

Integer

Provides the total number of overtime hours (to date) for the activity

timesheet_
approver

String

Provides the name of the timesheet approver.