This article gives a brief description of the APIs that you can use to integrate project data from an external system with Oracle Projects. The procedures discussed below are located in the public API package PA_PROJECT_PUB.
Project Procedures:
1]CREATE_PROJECT
CREATE_PROJECT is a PL/SQL procedure that creates a project in Oracle Projects using a template or an existing project.
The Parameters:
Name | Description |
P_API_VERSION_NUMBER | API standard version number |
P_COMMIT | API standard (default = ‘F’) indicates if transaction will be committed |
P_INIT_MSG_LIST | API standard (default = ‘F’) indicates if message stack will be initialized |
P_MSG_COUNT | API standard count of error messages |
P_MSG_DATA | API standard error message |
P_RETURN_STATUS | API standard Return of the API success/failure/unexpected error) |
P_WORKFLOW_STARTED | Shows if a workflow has been started (Y or N) |
P_PM_PRODUCT_CODE | Identifier of the external systems from which the project was imported |
P_PROJECT_IN | Input project details |
P_PROJECT_OUT | Output project details |
P_KEY_MEMBERS | The identification code for the role that the members have on the project |
P_CLASS_CATEGORIES | Identification code for the categories by which the project is classified |
P_TASKS_IN | Input task details of the project |
P_TASKS_OUT | Output task details of the project |
P_ORG_ROLES | Identifier for organization roles for project |
P_STRUCTURE_IN | Identifier of structure data |
P_EXT_ATTR_TBL_IN | Identifier of external attributes |
2] DELETE_PROJECT
DELETE_PROJECT is a PL/SQL procedure used to delete a project and its tasks from Oracle Projects.
The Parameters:
Name | Description |
P_API_VERSION_NUMBER | API standard version number |
P_COMMIT | API standard (default = ‘F’) indicates if transaction will be committed |
P_INIT_MSG_LIST | API standard (default = ‘F’) indicates if message stack will be initialized |
P_MSG_COUNT | API standard count of error messages |
P_MSG_DATA | API standard error message |
P_RETURN_STATUS | API standard Return of the API success/failure/unexpected error) |
P_PM_PRODUCT_CODE | Identifier of the external systems from which the project was imported |
P_PM_PROJECT_REFERENCE | The reference code that uniquely identifies the project in the external system |
P_PA_PROJECT_ID | The reference code that uniquely identifies the project in Oracle Projects |
3] UPDATE_PROJECT
UPDATE_PROJECT is a PL/SQL procedure that updates project and task information from your external system to Oracle Projects to reflect changes you have made in the external system. UPDATE_PROJECT uses composite datatypes.
The Parameters:
Name | Description |
P_API_VERSION_NUMBER | API standard version number |
P_COMMIT | API standard (default = ‘F’) indicates if transaction will be committed |
P_INIT_MSG_LIST | API standard (default = ‘F’) indicates if message stack will be initialized |
P_MSG_COUNT | API standard count of error messages |
P_MSG_DATA | API standard error message |
P_RETURN_STATUS | API standard Return of the API success/failure/unexpected error) |
P_WORKFLOW_STARTED | Shows if a workflow has been started (Y or N) |
P_PM_PRODUCT_CODE | Identifier of the external systems from which the project was imported |
P_PROJECT_IN | Input project details |
P_PROJECT_OUT | Output project details |
P_KEY_MEMBERS | The identification code for the role that the members have on the project |
P_CLASS_CATEGORIES | Identification code for the categories by which the project is classified |
P_TASKS_IN | Input task details of the project |
P_TASKS_OUT | Output task details of the project |
P_ORG_ROLES | Identifier for organization roles for project |
P_STRUCTURE_IN | Identifier of structure data |
P_PASS_ENTIRE_STRUCTURE | Flag indicating whether to pass entire structure |
P_EXT_ATTR_TBL_IN | Identifier of external attributes. |
Load-Execute-Fetch Procedures:
The following is the list of API’s for Load-Execute-Fetch and should be executed in the order of sequence.
- INIT_PROJECT
- LOAD_PROJECT
- LOAD_TASK
- LOAD_CLASS_CATEGORY
- LOAD_KEY_MEMBER
- EXECUTE_CREATE_PROJECT/EXECUTE_UPDATE_PROJECT
- FETCH_TASK
- CLEAR_PROJECT
Check Procedures:
CHECK_DELETE_PROJECT_OK | This API is used to determine if you can delete a project. |
CHECK_CHANGE_PROJECT_ORG_OK | This API is used to determine if you can change the CARRYING_OUT_ORGANIZATION_ID field for a particular project or task. |
CHECK_CHANGE_PARENT_OK | This API is used to determine if you can move a task from one parent task to another. |
CHECK_UNIQUE_PROJECT_REFERENCE | This API is used to determine if a new or changed project reference(PM_PROJECT_REFERENCE) is unique |
CHECK_ADD_SUBTASK_OK | This API is used to determine if a subtask can be added to a parent task. |
CHECK_DELETE_TASK_OK | This API is used to determine if you can delete a task. |
CHECK_TASK_NUMBER_CHANGE_OK | This API is used to determine if you can change a tasks number. |
CHECK_UNIQUE_TASK_NUMBER | This API is used to determine if a new or changed task number is unique within a project. |
CHECK_UNIQUE_TASK_REFERENCE | This API is used to determine if a new or changed task reference (PM_TASK_REFERENCE) is unique |
There's a lot more to do with APIs
Lates Tech Blog
An API defines functionalities that are independent of their respective implementations, which allows those implementations and definitions to vary without compromising each other.
Today, implementing a quality document management system is critical for a business to succeed. Therefore, when searching for a reputable document management system, Read more…
Volusion Development Services We have expert Volusion developers who can build you a flourishing online store by utilizing Volusion’s functionality to the optimum. Read more…