Project Version 2

Logical Business Objects

Projects : Project Foundation : Project

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type	Object or Service
Handles	Project Error Message SDO Version 2
Handles	Current Project Status SDO Version 2
Handles	Project Error Message Token SDO Version 2
Handles	Project and Task Owning Organization SDO Version 2
Handles	Project Partner Organization SDO Version 2
Handles	Next Allowable Project Statuses SDO Version 2
Handles	Project Status SDO Version 2
Handles	Project Customer Organization Version 2
Handles	Project Supplier Organization Version 2
Handles	Project SDO Version 2
Handles	Project Status Message SDO Version 2
Handles	Project Details Update Translation SDO Version 2
Handles	Project Details Update SDO Version 2
Handles	Project Key SDO Version 2
Handles	Project Update SDO Version 2
Handles	Project Team Member Version 2
Handles	Project Classification Descriptive Flexfields SDO Version 2
Handles	Project Classification Version 2
Handles	Project Attachment Version 2
Handles	Project Classification SDO Version 2
Handles	Project Status Results SDO Version 2
Handles	Asset SDO Version 2
Handles	Project Descriptive Flexfields SDO

getProjectOrganizationByTemplate

Returns a list of valid project-owning organizations for a project template.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
templateKey	string	Gets the number of the project template for which valid organizations are retrieved.

Response Payload

Element Name	Type	Description
result	Project and Task Owning Organization Version 2	Returns a list of valid project-owning organizations for the project template.

isProjectKeyUnique

Checks if the attributes in the project key are unique.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
projectKey	Project Key Version 2	Tests whether project attributes, such as project name and project number, are unique.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}BooleanResult	Returns whether the key project attributes are unique.

updateProject

Updates a project. WARNING: The operation does not support all the attributes. Please read description for each payload attributes before using this service operation.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
inProject	Project Update Version 2	Details of the project to be updated.

Response Payload

Element Name	Type	Description
result	Project Update Version 2	Returns the updated project or the exceptions generated when attempting to update the project.

createProject

Creates a project using a project template.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
inProject	Project Version 2	Details of the project to be created.

Response Payload

Element Name	Type	Description
result	Project Version 2	Returns the created project or the exceptions generated when attempting to create the project.

getProjectStatus

Retrieves the current project status and the next allowable statuses.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
projectStatusInputRow	Project Status Version 2	The identifier of the project for which statuses are retrieved. A value must be provided for at least one of the following attributes: Project ID, Project Number, Project Name, or Client Project Key. If the Client Project Key is used, the Client Key is also required.

Response Payload

Element Name	Type	Description
result	Project Status Results Version 2	Returns the status code indicating whether the operation completed successfully. The parameter also contains a child view object that returns the current project status, the next allowable statuses, and the status message.

changeProjectStatus

Changes the status of a project.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
projectStatusInputRow	Project Status Version 2	The project identifier, the new project status, and the status change comments. The New Status Code or New Status Name must be entered. To identify the project, a value must be provided for at least one of the following attributes: Project ID, Project Number, Project Name, or Client Project Key. If the Client Project Key is used, the Client Key is also required.

Response Payload

Element Name	Type	Description
result	Project Status Results Version 2	Returns the status code indicating whether the operation completed successfully. The parameter also contains a child view object that returns status messages.

getProject

Retrieves details for a project.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
projectId	long	Identifier of the project to be retrieved.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/apps/projects/foundation/projectDefinition/publicService/maintainProjectV2/}ProjectResult	Returns project details for the selected project.

findProject

Finds projects that meet the specified criteria.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	Criteria used to filter query results.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Reserved for future use.

Response Payload

Element Name	Type	Description
result	Project Version 2	Returns a list of projects that match the criteria and any warnings or information messages generated.

findProjectsUpdatedAfter

Searches for a list of projects that were updated after a given date.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	Criteria used to filter query results.
paramUpdateDate	string	Latest date on which projects must be updated to be retrieved.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Reserved for future use.

Response Payload

Element Name	Type	Description
result	Project Version 2	Returns a list of projects matching the criteria and any warnings or information messages generated.

mergeProjectData

Updates project attributes and descriptive flexfields. Assigns and updates project classifications. Use one of the following parameters to identify the project you want to update: 1. ProjectId 2. ProjectNumber 3. ProjectName If you provide valid values for more than one parameter, then the project is identified by using only one parameter in the order in which they are listed above.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
projectData	Project Details Update Version 2	Input parameters required to update project attributes, descriptive flexfields, and classifications.

Response Payload

Element Name	Type	Description
result	Project Details Update Version 2	Returns the updated project attributes, descriptive flex fields and project classifications.

getDfltObjAttrHints

Retrieves user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
viewName	string	The service view usage name, an internal name for the service data object. Specify the value of the element from the getEntityList operation response payload.
localeName	string	The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints	Returns the label and user interface hints for the specified service data object and its attributes in a name-value pair format.

getServiceLastUpdateTime

Returns the date and time when the schema files referenced in the service definition last changed.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	Returns the date and time when the service definition last changed in ISO 8601 format.

getEntityList

Gets the list of service data objects defined on this service.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo	Returns a list of service data objects defined on this service. For each service data object, the result includes the QName, internal name, and boolean values indicating whether create, update, merge, and delete operations can be performed on the object.

Security

The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.

Service Operations to Privileges Mapping

Operation Name	Privilege Code	Privilege Name	Privilege Description
All Operations	PJF_UPDATE_PROJECT_DEFINITION_PRIV	Update Project Definition	Allows the project definition web service to update the attributes on a project.
All Operations	PJF_CREATE_PROJECT_PRIV	Create Project	Allows creation of project from another existing project or a project template.

Privileges to Duty Roles Mapping

Privilege Code	Granted to Duty Role Code	Granted to Duty Role Name	Granted To Duty Role Description
PJF_CREATE_PROJECT_PRIV	ORA_PJF_PROJECT_ADMINISTRATOR_JOB	Project Administrator	Assists the project manager with the administrative functions of a project, particularly the functions related to collecting and entering information into the project application.
PJF_CREATE_PROJECT_PRIV	ORA_PJF_PROJECT_CREATOR_ABSTRACT	Project Creator	Identifies the person who creates projects.
PJF_CREATE_PROJECT_PRIV	ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	Grants Department Administrator	Assists the principal investigator with the administrative functions of an award and its related projects, particularly with data collection and data entry tasks for one or more departments within the enterprise.
PJF_UPDATE_PROJECT_DEFINITION_PRIV	ORA_PJF_PROJECT_DEFINITION_DUTY	Project Definition	Edits project and task attributes.

Duty Roles to Duty or Job Roles Mapping

Duty Role Code	Granted to Duty or Job Role Code	Granted to Duty or Job Role Name	Granted To Duty or Job Role Description
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_GMS_AWARD_MANAGEMENT_DUTY	Award Management	Creates awards and related contract information. Manages award information such as keywords, funding sources, and budget periods. Manages projects associated with awards. Manages funding assigned to the award and allocated to projects and tasks. Submits process to update financial performance data for awards and award projects and views the financial data. Generates reports for submission to federal agencies.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_OKC_CONTRACT_SETUP_DUTY	Contract Setup	Contract Setup
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_OKC_CONTRACT_TERMS_AUTHORING_OVERRIDE_DUTY	Contract Terms and Conditions Override Controls	Edits protected clauses, and deletes mandatory clauses and sections in addition to authoring nonstandard terms and conditions.
ORA_PJF_PROJECT_ADMINISTRATOR_JOB	ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY	FSCM Load Interface Administration	Manages load interface file for import
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY	FSCM Load Interface Administration	Manages load interface file for import
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_OKC_GRANT_CONTRACT_AMENDMENT_DUTY	Grant Contract Amendment	Amends approved grant contracts. This includes initiating an amendment, reverting the contract to the previous signed version, updating all allowable attributes, and submitting the amendment for approval.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_OKC_GRANT_CONTRACT_AUTHORING_DUTY	Grant Contract Authoring	Authors grant contracts, including terms and conditions, interactions, and customer account information.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_OKC_GRANT_CONTRACT_SEARCH_VIEW_DUTY	Grant Contract Search and View Access	Searches and views grant contracts for the assigned business units.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_PER_MANAGE_USER_AND_ROLES_DUTY_FSCM	Manage Users	Creates and updates users and assigns roles to users.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_OKC_CONTRACT_TERMS_AUTHORING_NON_STANDARD_DUTY	Nonstandard Contract Terms and Conditions Authoring	Authors nonstandard terms and conditions in addition to standard terms and conditions. Nonstandard terms authoring includes editing standard clauses, creating nonstandard clauses, deleting nonstandard clauses and sections, and removing contract terms.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_PJO_PROJECT_BUDGET_BASELINE_CREATION_DUTY	Project Budget Baseline Creation	Allows creation of baseline version of project budget.
ORA_PJF_PROJECT_ADMINISTRATOR_JOB	ORA_PJO_PROJECT_BUDGET_MANAGEMENT_DUTY	Project Budget Management	Creates, edits, and deletes working budget versions. Edits versions in Excel. Submits versions for baseline creation.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_PJO_PROJECT_BUDGET_MANAGEMENT_DUTY	Project Budget Management	Creates, edits, and deletes working budget versions. Edits versions in Excel. Submits versions for baseline creation.
ORA_PJF_PROJECT_CREATOR_ABSTRACT	ORA_PJF_PROJECT_DEFINITION_DUTY	Project Definition	Edits project and task attributes.
ORA_PJF_PROJECT_ADMINISTRATOR_JOB	ORA_PJF_PROJECT_DEFINITION_DUTY	Project Definition	Edits project and task attributes.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_PJF_PROJECT_DEFINITION_DUTY	Project Definition	Edits project and task attributes.
ORA_PJF_PROJECT_ADMINISTRATOR_JOB	ORA_PJO_PROJECT_PLAN_MANAGEMENT_DUTY	Project Plan Management	Creates, edits, and deletes task assignments and views project progress.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_PJO_PROJECT_PLAN_MANAGEMENT_DUTY	Project Plan Management	Creates, edits, and deletes task assignments and views project progress.
ORA_PJF_PROJECT_ADMINISTRATOR_JOB	ORA_PJF_PROJECTS_REPORTING_ANALYSIS_DUTY	Projects Reporting Analysis	Access project Business Intelligence Applications data.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_PJF_PROJECTS_REPORTING_ANALYSIS_DUTY	Projects Reporting Analysis	Access project Business Intelligence Applications data.
ORA_PJF_PROJECT_ADMINISTRATOR_JOB	ORA_XCC_TRANSACTIONAL_DUTY	Transaction Entry with Budgetary Control	Manages the budgetary control tasks by job roles who perform transactions that are subject to budgetary control, such as accounts payable manager.
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB	ORA_XCC_TRANSACTIONAL_DUTY	Transaction Entry with Budgetary Control	Manages the budgetary control tasks by job roles who perform transactions that are subject to budgetary control, such as accounts payable manager.