Input Parameters

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

Name

Data Type

Value Required?

Placeholder or Constant

Description

global_properties

Object

Yes

Not
applicable

This object lists the global settings for your EnterpriseTrack instance.

See "global_properties Object" for details.

application_data

Object

Yes

Not
applicable

This object lists the search criteria and provides the results.

See "application_data" for details.

application_data

pcs

String

No

<pcs>

Specifies the initiative attribute for the project.

project_id

Integer

No

<project_ID>

Specifies the project ID.

project_name

String

No

<project_
name>

Specifies the project name.

project_keyword

String

No

<project_keyword>

Specifies a keyword associated for the project.

project_status

String

No

<project_status>

Specifies one (or more) status values for the project.

Multiple values should be separated by commas.

project_on_time_
status

String

No

<project_on_
time_status>

Specifies one (or more) status values for the project.

Multiple values should be separated by commas.

project_org_
descriptor

Object

No

Not
applicable

This object specifies the organization information.

See "project_org_descriptor" for details.

project_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 date.

project_start_
date_to

Date

No

<start_to>

Specifies the beginning date for the range of start dates.

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

planned_
realization_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.

planned_
realization_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.

project_
classification_
descriptor

Object

No

Not
applicable

This object specifies the project classification.

See "project_classification_descriptor" for details.

project_
methodology_
descriptor

Object

No

Not
applicable

This object specifies the project methodology.

See "project_methodology_descriptor" for details.

program

String

No

<program>

Restricts the search to include only those projects in this program.

finance_detail_
level

String

No

<detail_level>

Specifies the level of finance elements to report.

Valid values are:

  • Total (default)
  • Group
  • Category
  • Element

show_upper_
levels

Boolean

No

<show_levels>

If finance_detail_level has a value of Category, this indicates whether or not to include the group in the report.

Value values are:

  • TRUE (default)
  • FALSE

rpt_currency

String

No

<currency>

Specifies the type of currency to use.

The default is USD.

fin_templates

String

No

<template>

Specifies one (or more) finance templates to use.

Multiple values should be separated by commas.

finance_date_
range_from

Date

No

<range_from>

Specifies the beginning date for the finance data that is to be reported.

finance_date_
range_to

Date

No

<range_to>

Specifies the ending date for the finance data that is to be reported.

finance_dataset

String

No

<dataset>

Specifies which data stream should be considered.

Valid values are:

  • CURRENT (default)
  • PLAN

finance_snapshot_name

String

No

<snapshot>

If finance_dataset has a value of PLAN, this specifies the name of the finance snapshot that should be used for the report.

starting_month

Date

No

<start_mo>

Specifies the beginning month to be shown in the month‑by‑month breakdown.

The default is the beginning of the previous fiscal year.

no_of_months

Integer

No

<num_mo>

Specifies the number of months to be included in the month‑by‑month breakdown.

The default is 36.

project_org_descriptor

division

String

No

<division>

Specifies one (or more) level 1 fields configured for the project hierarchy.

Multiple values should be separated by commas.

business_unit

String

No

<bus_unit>

Specifies one (or more) level 2 fields configured for the project hierarchy.

Multiple values should be separated by commas.

sub_business_unit

String

No

<sub_unit>

Specifies one (or more) level 3 fields configured for the project hierarchy.

Multiple values should be separated by commas.

location

String

No

<location>

Specifies one (or more) level 4 fields configured for the project hierarchy.

Multiple values should be separated by commas.

region

String

No

<region>

Specifies one (or more) level 5 fields configured for the project hierarchy.

Multiple values should be separated by commas.

project_classification_descriptor

project_source

String

No

<proj_source>

Specifies one or more project sources for the associated initiative.

Multiple values should be separated by commas.

functional_area

String

No

<proj_area>

Specifies one or more functional areas for the associated initiative.

Multiple values should be separated by commas.

products

String

No

<products>

Specifies one or more products for the associated initiative.

Multiple values should be separated by commas.

process

String

No

<process>

Specifies one or more processes for the associated initiative.

Multiple values should be separated by commas.

project_methodology_descriptor

phase_type

String

No

<phase_type>

Specifies one (or more) top level activities configured for the associated initiative.

This field is dependent on the initiative and will be ignored is the initiative is NULL.

Multiple values should be separated by commas.

project_type

String

No

<proj_type>

Specifies one (or more) project types configured for the associated initiative.

This field is dependent on the initiative and will be ignored is the initiative is NULL.

Multiple values should be separated by commas.

roadmap

String

No

<roadmap>

Specifies one (or more) roadmaps configured for the associated initiative.

This field is dependent on the initiative and will be ignored is the initiative is NULL.

Multiple values should be separated by commas.

Related Topics

GetFinanceData Function

Input Examples

Invocation Parameters

Output Parameters



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

Last Published Thursday, May 03, 2018