REST API for Oracle Fusion Cloud Project Management

All REST Endpoints

Award Budget Summary

The Award Budget Summary resource is used to view an award budget.

Get all award budget versions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary
Get an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}

Award Budget Summary/Resources

The Resources resource is used to view the resources in the planning resource breakdown structure that are included in the award budget.

Get summary amounts for a resource for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}
Get summary amounts for all resources for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Resources

Award Budget Summary/Resources/Budget Lines

The Budget Lines resource is used to view the budget lines for a resource.

Get a budget line for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}/child/BudgetLines/{BudgetLinesUniqID}
Get all budget lines for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}/child/BudgetLines

Award Budget Summary/Resources/Budget Lines/Planning Amount Details

The Planning Amount Details resource is used to view periodic amounts for a budget line.

Get planning amount details for a period for a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}/child/BudgetLines/{BudgetLinesUniqID}/child/PlanningAmountDetails/{PlanningAmountDetailsUniqID}
Get planning amount details for all periods for a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}/child/BudgetLines/{BudgetLinesUniqID}/child/PlanningAmountDetails

Award Budget Summary/Tasks

The Tasks resource is used to view an award budget version task.

Get summary amounts for a task for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}
Get summary amounts for all tasks for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Tasks

Award Budget Summary/Tasks/Budget Lines

The Budget Lines resource is used to view the budget lines for a task.

Get a budget line for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}/child/BudgetLines/{BudgetLinesUniqID}
Get all budget lines for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}/child/BudgetLines

Award Budget Summary/Tasks/Budget Lines/Planning Amount Details

The Planning Amount Details resource is used to view periodic amounts for a budget line.

Get planning amount details for a period for a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}/child/BudgetLines/{BudgetLinesUniqID2}/child/PlanningAmountDetails/{PlanningAmountDetailsUniqID}
Get planning amount details for all periods for a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}/child/BudgetLines/{BudgetLinesUniqID}/child/PlanningAmountDetails

Award Budget Summary/Version Errors

The Version Errors resource is used to view award budget version errors.

Get all errors for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/VersionErrors
Get an error for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetSummary/{PlanVersionId}/child/VersionErrors/{VersionErrorsUniqID}

Award Budgets

The Award Budgets resource is used to view, create, update, and delete an award budget.

Adjust for range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/action/adjustForRangeOfProjects
Adjust the award budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/action/adjust
Create an award budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets
Delete an award budget version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}
Get all award budget versions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets
Get an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}
Refresh rates for range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/action/refreshRatesForRangeOfProjects
Refresh rates for the award budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/action/refreshRates
Reprocess all failed award budgets: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/action/reprocessFailedAwardBudgets
Update an award budget version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}

Award Budgets/Award Budget Attachments

The Attachment resource is used to view, create, update, and delete attachments for award budgets.

Create an attachment for an award budget: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments
Delete an attachment for an award budget: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}
Get all attachments for an award budget: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments
Get an attachment for an award budget: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}
Update an attachment for an award budget: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}

Award Budgets/Award Budget Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Award Budgets/Award Budget Attachments/Large Object (LOB) Attributes - File Web Image

The base64 encoded image of the file displayed in .png format if the source is a convertible image.

Get a File Web Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Award Budgets/Planning Options

The Planning Options resource is used to view the planning options configured for the award budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Award budget versions inherit planning options that are defined for financial plan types.

Get a planning option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}
Get all planning options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningOptions

Award Budgets/Planning Options/Planning Options Descriptive Flexfields

A listing of all the descriptive flexfields available for planning options in award budget versions.

Create a descriptive flexfield for planning options: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF
Get all descriptive flexfields for planning options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF/{PlanningOptionId2}
Get all descriptive flexfields for planning options as a collection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF
Update a descriptive flexfield for planning options: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF/{PlanningOptionId2}

Award Budgets/Planning Resources

The Planning resources is used to view, create, update, and delete an award budget line.

Create a planning resource for an award budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources
Delete a planning resource for an award budget version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}
Get a planning resource for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}
Get all planning resources for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources
Update a planning resource for an award budget version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}

Award Budgets/Planning Resources/Planning Amounts

The Planning Amounts resource is used to view, create, and delete an award budget line amounts.

Adjust the award budget line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/adjust
Create a plan line for a planning resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts
Delete a plan line for a planning resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}
Get a plan line for a planning resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}
Get all plan lines for a planning resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts
Refresh rates for the award budget line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/refreshRates

Award Budgets/Planning Resources/Planning Amounts/Plan Lines Descriptive Flexfields

The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in award budgets.

Create a descriptive flexfield for summary planning amounts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF
Get a descriptive flexfield for summary planning amounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF/{PlanLineId2}
Get all descriptive flexfields for summary planning amounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF
Update a descriptive flexfield for summary planning amounts: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF/{PlanLineId2}

Award Budgets/Planning Resources/Planning Amounts/Planning Amount Details

The Planning Amount Details resource is used to view, create, and update an award budget line periodic amounts.

Adjust the award budget line period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}/action/adjust
Create a planning amount detail for a period for a plan line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails
Delete a planning amount detail for a period for a plan line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}
Get a planning amount detail for a period for a plan line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}
Get all planning amount details for all periods for a plan line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails
Update a planning amount detail for a period for a plan line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}

Award Budgets/Version Errors

The Version Errors resource is used to view award budget version and award budget line errors.

Get all errors for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/VersionErrors
Get an error for an award budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/VersionErrors/{VersionErrorsUniqID}

Award Funding Patterns

The award funding patterns resource is used to view and manage the values that determine the pattern to use for a project cost based on the expenditure item date and other optional attributes.

Create an award funding pattern: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns
Custom action used to duplicate an existing funding pattern.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/action/copyFundingPattern
Delete an award funding pattern: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}
Get an award funding pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}
Get award funding patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns
Update an award funding pattern: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}

Award Funding Patterns/Award Funding Pattern Distribution Sets

The award funding patterns resource is used to view and manage the values that determine the pattern to use for a project cost based on the expenditure item date and other optional attributes.

Create award funding pattern distribution sets: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets
Delete an award funding pattern distribution set and rules: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets/{DistributionSetId}
Get an award funding pattern distribution set: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets/{DistributionSetId}
Get award funding pattern distribution sets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets
Update an award funding pattern distribution set: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets/{DistributionSetId}

Award Funding Patterns/Award Funding Pattern Distribution Sets/Award Funding Pattern Distribution Set Rules

The distribution set rules resource is a child of the award funding pattern distribution sets resource to view and manage the rules for a set.

Create award funding pattern distribution set rules: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets/{DistributionSetId}/child/distributionSetRules
Delete an award funding pattern distribution set rule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets/{DistributionSetId}/child/distributionSetRules/{DistributionSetRuleId}
Get an award funding pattern distribution set rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets/{DistributionSetId}/child/distributionSetRules/{DistributionSetRuleId}
Get award funding pattern distribution set rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets/{DistributionSetId}/child/distributionSetRules
Update an award funding pattern distribution set rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets/{DistributionSetId}/child/distributionSetRules/{DistributionSetRuleId}

Award Projects

The Award Projects resource is used to view award project attributes such as project name and project number.

Get all award projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardProjects
Get an award project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardProjects/{AwardProjectId}

Awards

The Awards resource is used to create, update, view, and delete awards. After creating an award in Draft status using the POST method, submit it for approval or activate it using the PATCH method. Also, update and retrieve award child resources such as award funding, award project, and a list of personnel such as principal investigator. Additionally, use the validate service to ensure that the award is correctly created. At least one project should be associated and all the associated projects must be active for the validation to succeed.

Create an award: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards
Get all awards: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards
Get an award: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}
Update an award: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}
Update dates and budget periods for an award.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates

Awards/Award Attachments

The Award Attachments resource is used to view attachments associated with the award.

Create award attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/Attachment
Delete an award attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/Attachment/{AttachmentUniqID}
Get all award attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/Attachment
Get an award attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/Attachment/{AttachmentUniqID}
Update an award attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/Attachment/{AttachmentUniqID}

Awards/Award Attachments/Large Object (LOB) Attributes - File Contents

The type of attachment files such as.pdf,.xls, when the attachment type is File.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Awards/Award Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Awards/Award Budget Periods

The Award Budget Periods resource is used to view award budget period attributes such as budget period name, start date and end date.

Create an award budget period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardBudgetPeriod
Delete an award budget period: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardBudgetPeriod/{AwardBudgetPeriodId}
Get all award budget periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardBudgetPeriod
Get an award budget period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardBudgetPeriod/{AwardBudgetPeriodId}
Update an award budget period: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardBudgetPeriod/{AwardBudgetPeriodId}

Awards/Award CFDAs

The Award CFDAs resource is used to view the attributes specific to award federal domestic assistance program.

Create an award CFDA: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCFDA
Delete an award CFDA: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCFDA/{AwardCFDAId}
Get all award CFDAs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCFDA
Get an award CFDA: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCFDA/{AwardCFDAId}
Update an award CFDA: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCFDA/{AwardCFDAId}

Awards/Award Certifications

The Award Certifications resource is used to view the certification attributes of the award.

Create an award certification: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCertification
Delete an award certification: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCertification/{AwardCertificationId}
Get all award certifications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCertification
Get an award certification: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCertification/{AwardCertificationId}
Update an award certification: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardCertification/{AwardCertificationId}

Awards/Award Department Credits

The Award Department Credits resource is used to view the organization credit attributes for the award.

Create an award department credit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardDepartmentCredit
Delete an award department credit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardDepartmentCredit/{AwardOrganizationCreditId}
Get all award department credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardDepartmentCredit
Get an award department credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardDepartmentCredit/{AwardOrganizationCreditId}
Update an award department credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardDepartmentCredit/{AwardOrganizationCreditId}

Awards/Award Descriptive Flexfields

A list of all the descriptive flexfields available for awards.

Create award descriptive flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardHeaderDFF
Get all award descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardHeaderDFF
Get an award descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardHeaderDFF/{Id}
Update an award descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardHeaderDFF/{Id}

Awards/Award Errors

The Award Errors resource is used to view validation errors associated with the award.

Get all award errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardError
Get an award error: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardError/{AwardErrorId}

Awards/Award Funding Sources

The Award Funding Sources resource is used to view the attributes used to create or update a funding source for the award.

Create an award funding source: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFundingSource
Delete an award funding source: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFundingSource/{AwardFundingSourceUniqID}
Get all award funding sources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFundingSource
Get an award funding source: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFundingSource/{AwardFundingSourceUniqID}
Update an award funding source: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFundingSource/{AwardFundingSourceUniqID}

Awards/Award Fundings

The Award Fundings resource is used to view award funding attributes such as funding issue type and funding issue name.

Create award funding: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding
Delete award funding: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding/{AwardFundingId}
Get all award funding details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding
Get award funding: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding/{AwardFundingId}
Update award funding: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding/{AwardFundingId}

Awards/Award Fundings/Award Project Fundings

The Award Project Fundings resource is used to view funding allocation attributes for the award project.

Create award project funding: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding/{AwardFundingId}/child/AwardProjectFunding
Delete award project funding: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding/{AwardFundingId}/child/AwardProjectFunding/{AwardProjectFundingId}
Get all award project funding details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding/{AwardFundingId}/child/AwardProjectFunding
Get award project funding: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding/{AwardFundingId}/child/AwardProjectFunding/{AwardProjectFundingId}
Update award project funding: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding/{AwardFundingId}/child/AwardProjectFunding/{AwardProjectFundingId}

Awards/Award Keywords

The Award Keywords resource is used to view the keyword attributes for the award.

Create an award keyword: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardKeyword
Delete an award keyword: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardKeyword/{AwardKeywordId}
Get all award keywords: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardKeyword
Get an award keyword: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardKeyword/{AwardKeywordId}
Update an award keyword: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardKeyword/{AwardKeywordId}

Awards/Award Personnel

The Award Personnel resource is used to view the award personnel attributes such as person name, role.

Create an award personnel: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel
Delete an award personnel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel/{AwardPersonnelId}
Get all award personnels: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel
Get an award personnel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel/{AwardPersonnelId}
Update an award personnel: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel/{AwardPersonnelId}

Awards/Award Personnel/Award Personnel Descriptive Flexfields

A list of all the descriptive flexfields available for award personnel.

Create award personnel descriptive flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel/{AwardPersonnelId}/child/AwardPersonnelDFF
Get all award personnel descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel/{AwardPersonnelId}/child/AwardPersonnelDFF
Get an award personnel descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel/{AwardPersonnelId}/child/AwardPersonnelDFF/{Id}
Update an award project personnel descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel/{AwardPersonnelId}/child/AwardPersonnelDFF/{Id}

Awards/Award Projects

The Award Projects resource is used to view the attributes of an award project, such as project name and project number.

Create an award project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject
Delete an award project: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}
Get all award projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject
Get an award project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}
Update an award project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}

Awards/Award Projects/Award Project Attachments

The Award Project Attachments resource is used to view attachments associated with the award project.

Create award project attachments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectAttachment
Delete an award project attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectAttachment/{AwardProjectAttachmentUniqID}
Get all award project attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectAttachment
Get an award project attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectAttachment/{AwardProjectAttachmentUniqID}
Update an award project attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectAttachment/{AwardProjectAttachmentUniqID}

Awards/Award Projects/Award Project Attachments/Large Object (LOB) Attributes - File Contents

The type of attachment files such as.pdf,.xls, when the attachment type is File.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectAttachment/{AwardProjectAttachmentUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectAttachment/{AwardProjectAttachmentUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectAttachment/{AwardProjectAttachmentUniqID}/enclosure/FileContents

Awards/Award Projects/Award Project Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectAttachment/{AwardProjectAttachmentUniqID}/enclosure/FileWebImage

Awards/Award Projects/Award Project Certifications

The Award Project Certifications resource is used to view certification attributes of the award project.

Create an award project certification: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectCertification
Delete an award project certification: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectCertification/{AwardProjectCertificationId}
Get all award project certifications: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectCertification
Get an award project certification: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectCertification/{AwardProjectCertificationId}
Update an award project certification: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectCertification/{AwardProjectCertificationId}

Awards/Award Projects/Award Project Descriptive Flexfields

A list of all the descriptive flexfields available for award projects.

Create award project descriptive flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectDFF
Get all award project descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectDFF
Get an award project descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectDFF/{Id}
Update an award project descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectDFF/{Id}

Awards/Award Projects/Award Project Funding Sources

The Award Project Funding Sources resource is used to assign funding sources to the award project.

Create an award project funding source: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectFundingSource
Delete an award project funding source: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectFundingSource/{AwardProjectFundingSourceId}
Get all award project funding sources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectFundingSource
Get an award project funding source: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectFundingSource/{AwardProjectFundingSourceId}
Update an award project funding source: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectFundingSource/{AwardProjectFundingSourceId}

Awards/Award Projects/Award Project Keywords

The Award Project Keywords resource is used to view keyword attributes for the award project.

Create an award project keyword: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectKeyword
Delete an award project keyword: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectKeyword/{AwardProjectKeywordId}
Get all award project keywords: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectKeyword
Get an award project keyword: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectKeyword/{AwardProjectKeywordId}
Update an award project keyword: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectKeyword/{AwardProjectKeywordId}

Awards/Award Projects/Award Project Organization Credits

The Award Project Organization Credits resource is used to view organization credit attributes for the award project.

Create an award project department credit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectDepartmentCredit
Delete an award project department credit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectDepartmentCredit/{AwardOrganizationCreditId}
Get all award project department credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectDepartmentCredit
Get an award project department credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectDepartmentCredit/{AwardOrganizationCreditId}
Update an award project department credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectDepartmentCredit/{AwardOrganizationCreditId}

Awards/Award Projects/Award Project Override Burden Schedules

The Award Project Override Burden Schedules resource is used to create and view the override burden schedule assigned to the award project.

Create a burden schedule for an award project.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules
Get the burden schedule override for the award project.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules
Get the specific burden schedule override for the award project.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}
Update a burden schedule for an award project.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}

Awards/Award Projects/Award Project Override Burden Schedules/Versions

The Versions resource is used to view and create versions for the override burden schedule assigned to the award project.

Create a version in burden schedule.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions
Get a specific version of the burden schedule.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions/{VersionId}
Get all versions of the burden schedule.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions
Update a version in burden schedule.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions/{VersionId}

Awards/Award Projects/Award Project Override Burden Schedules/Versions/Multipliers

The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.

Create a multiplier in burden schedule version.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions/{VersionId}/child/Multipliers
Get a specific multiplier of the burden schedule version.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions/{VersionId}/child/Multipliers/{MultiplierId}
Get all multipliers in the burden schedule version.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions/{VersionId}/child/Multipliers
Update a multiplier in burden schedule version.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions/{VersionId}/child/Multipliers/{MultiplierId}

Awards/Award Projects/Award Project Personnel

The Award Project Personnel resource is used to view personnel references associated with the award project

Create an award project personnel: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectPersonnel
Delete an award project personnel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectPersonnel/{AwardProjectPersonnelId}
Get all award project personnel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectPersonnel
Get an award project personnel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectPersonnel/{AwardProjectPersonnelId}
Update an award project personnel: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectPersonnel/{AwardProjectPersonnelId}

Awards/Award Projects/Award Project Personnel/Award Project Personnel Descriptive Flexfields

A list of all the descriptive flexfields available for award project personnel.

Create an award project personnel descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectPersonnel/{AwardProjectPersonnelId}/child/AwardProjectPersonnelDFF/{Id}
Create award project personnel descriptive flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectPersonnel/{AwardProjectPersonnelId}/child/AwardProjectPersonnelDFF
Get all award project personnel descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectPersonnel/{AwardProjectPersonnelId}/child/AwardProjectPersonnelDFF
Get an award project personnel descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectPersonnel/{AwardProjectPersonnelId}/child/AwardProjectPersonnelDFF/{Id}

Awards/Award Projects/Award Project Reference Types

The Award Project Reference Types resource is used to view attributes associated with the award project reference type.

Create an award project reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectReference
Delete an award project reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectReference/{AwardProjectReferenceId}
Get all award project references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectReference
Get an award project reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectReference/{AwardProjectReferenceId}
Update an award project reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectReference/{AwardProjectReferenceId}

Awards/Award Projects/Award Project Task Burden Schedules

The Award Project Task Burden Schedules resource is used to view the task burden schedule of the award project.

Create an award project task burden schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectTaskBurdenSchedule
Delete an award project task burden schedule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectTaskBurdenSchedule/{AwardProjectScheduleId}
Get all award project task burden schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectTaskBurdenSchedule
Get an award project task burden schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectTaskBurdenSchedule/{AwardProjectScheduleId}
Update an award project task burden schedule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectTaskBurdenSchedule/{AwardProjectScheduleId}

Awards/Award References

The Award References resource is used to view the attributes specific to award reference type.

Create an award reference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardReference
Delete an award reference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardReference/{AwardReferenceId}
Get all award references: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardReference
Get an award reference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardReference/{AwardReferenceId}
Update an award reference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardReference/{AwardReferenceId}

Awards/Award Terms

The Award Terms and Conditions resource is used to view the attributes of the terms and conditions associated to the award.

Create an award term: Method: post
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardTerms
Delete an award term: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardTerms/{AwardTermsId}
Get all award terms: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardTerms
Get an award term: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardTerms/{AwardTermsId}
Update an award term: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardTerms/{AwardTermsId}

Change Orders

The Change Order resource is used to create, view, update, or delete a change order. A change order is an event, action, or condition that affects the scope, value, or duration of a project or task.

Create a change order: Method: post
Path: /fscmRestApi/resources/11.13.18.05/changeOrders
Delete a change order: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}
Get a change order: Method: get
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}
Get all change orders: Method: get
Path: /fscmRestApi/resources/11.13.18.05/changeOrders
Update a change order: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}

Change Orders/Change Impacts

The Change Impacts resource is used to create, view, update, or delete the impacts due to the respective change order.

Create impacts for a change order: Method: post
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts
Delete an impact for a change order: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}
Get all impacts for a change order: Method: get
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts
Get an impact for change order: Method: get
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}
Update an impact for a change order: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}

Change Orders/Change Impacts/Change Impact Details

The Change Impact Details resource is used to view, create, update or delete the impact details for a change order. Change Impact Details can be created only for the impacts where the impact area is defined as Budget and Forecast.

Create impact details for a change impact: Method: post
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}/child/ChangeImpactDetails
Delete an impact detail for a change impact: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}/child/ChangeImpactDetails/{ImpactDetailsId}
Get all impact details for a change impact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}/child/ChangeImpactDetails
Get an impact detail for a change impact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}/child/ChangeImpactDetails/{ImpactDetailsId}
Update an impact detail for a change impact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}/child/ChangeImpactDetails/{ImpactDetailsId}

Change Orders/Change Participants

The Change Participants resource is used to view, create, update, or delete the participants for a change order.

Create participants for a change order: Method: post
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeParticipants
Delete a participant for a change order: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeParticipants/{ParticipantId}
Get a participant for a change order: Method: get
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeParticipants/{ParticipantId}
Get all participants for change order: Method: get
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeParticipants
Update a participant for change order: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeParticipants/{ParticipantId}

Contract Project and Task Bill Rate Overrides

The Contract Project and Task Bill Rate Overrides resource is used to view, create, update, or delete project task rate overrides defined at the contract bill plan or revenue plan level.

Create a Bill Rate Override: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contractProjectandTaskBillRateOverrides
Delete a Bill Rate Override detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contractProjectandTaskBillRateOverrides/{RateOverrideId}
Get a Bill Rate Override detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contractProjectandTaskBillRateOverrides/{RateOverrideId}
Get all Bill Rate Override details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contractProjectandTaskBillRateOverrides
Update a Bill Rate Override detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contractProjectandTaskBillRateOverrides/{RateOverrideId}

Deliverables

The deliverables resource is used to create, view, update, or delete a project deliverable. A project deliverable needs to be produced to complete a task or a requirement. It can be associated with a task or a requirement, and can have one or more attachments.

Create deliverables: Method: post
Path: /fscmRestApi/resources/11.13.18.05/deliverables
Delete a deliverable: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}
Get a deliverable: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}
Get all deliverables: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables
Update a deliverable: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}

Deliverables/Attachment to a Deliverable

The attachment resource is used to create, view, update, or delete an attachment to a project deliverable.

Create attachments for a deliverable: Method: post
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment
Delete an attachment to a deliverable: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment/{AttachmentUniqID}
Get all attachments for a deliverable: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment
Get an attachment for a deliverable: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment/{AttachmentUniqID}
Update an attachment to a deliverable: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment/{AttachmentUniqID}

Deliverables/Attachment to a Deliverable/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Deliverables/Attachment to a Deliverable/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Deliverables/Deliverable and Project Task Associations

The project task association resource is used to create, view, update, or delete an association between a deliverable and a project task. The project tasks associated with a deliverable.

Create associations between a deliverable and project tasks: Method: post
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/ProjectTaskAssociation
Delete an association between a deliverable and a project task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/ProjectTaskAssociation/{ObjectAssociationId}
Get all associations between a deliverable and project tasks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/ProjectTaskAssociation
Get an association between a deliverable and a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/ProjectTaskAssociation/{ObjectAssociationId}
Update an association between a deliverable and a project task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/ProjectTaskAssociation/{ObjectAssociationId}

Deliverables/Deliverable and Requirement Associations

The requirement association resource is used to create, view, update, or delete an association between a deliverable and a requirement. The requirements associated with a deliverable.

Create associations between a deliverable and requirements: Method: post
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/RequirementAssociation
Delete an association between a deliverable and a requirement: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/RequirementAssociation/{ObjectAssociationId}
Get all associations between a deliverable and requirements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/RequirementAssociation
Get an association between a deliverable and a requirement: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/RequirementAssociation/{ObjectAssociationId}
Update an association between a deliverable and a requirement: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/RequirementAssociation/{ObjectAssociationId}

Enterprise Project and Task Codes

The Enterprise Project and Task Codes resource is used to view the definitions of the enterprise project and task codes. Project codes are used to capture organization-specific extended attributes for projects. Similarly, task codes are used to capture organization-specific extended attributes for tasks.

Get all enterprise project and task codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/enterpriseProjectAndTaskCodes
Get an enterprise project or task code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/enterpriseProjectAndTaskCodes/{CodeId}

Enterprise Project and Task Codes/Accepted Values

List of accepted values for an enterprise project code or task code.

Get all accepted values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/enterpriseProjectAndTaskCodes/{CodeId}/child/AcceptedValues
Get an accepted value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/enterpriseProjectAndTaskCodes/{CodeId}/child/AcceptedValues/{ValueId}

Expenditure Types

The project expenditure type resource is used to list expenditure types. An expenditure type is classifications of cost that is associated an expenditure item. Expenditure types are grouped into cost groups and revenue groups.

Get all expenditure types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenditureTypes
Get an expenditure type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenditureTypes/{ExpenditureTypeId}

Financial Project Plans

The Financial Project Plan resource is used to view the financial project plan version.

Adjust for range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/adjustForRangeOfProjects
Adjust the financial project plan version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/action/adjust
Create a resource assignment for a financial project plan version using the DeferPlanning flag in UPSERT mode: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans
Get a financial project plan version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}
Get all financial project plan versions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans
Refresh rates for range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/refreshRatesForRangeOfProjects
Refresh rates for the financial project plan version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/action/refreshRates
Reprocess all failed financial project plan versions: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/reprocessFailedFinancialProjectPlans
Set the financial project plan to baseline: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/baselineFinancialProjectPlan
Sets the baseline financial project plan for a range of projects.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/baselineRangeOfFinancialProjectPlans
Update a resource assignment for a financial project plan version using the DeferPlanning flag in UPSERT mode: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}
Update actual amounts for a range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/updateActualAmountsForRangeOfProjects
Update actual amounts of a financial plan version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/action/updateActualAmounts
Update planned amounts from progress for a range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/action/updatePlannedAmountsFromProgressForRangeOfProjects
Update planned amounts from progress of a financial plan version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/action/updatePlannedAmountsFromProgress

Financial Project Plans/Plan Version Errors

The Version Errors resource is used to view the errors in a financial project plan resource assignment.

Get all errors for a financial project plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/VersionErrors
Get an error for a financial project plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/VersionErrors/{VersionErrorsUniqID}

Financial Project Plans/Planning Options

The Planning Options resource is used to view the planning options configured for the financial project plan version. Planning options are user-definable options, that include plan settings, rate settings, currency settings, and generation options, and are used to control planning scenarios. Financial project plan versions inherit planning options that are defined for the project plan type that's associated to the project.

Get a planning option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}
Get all planning options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions
Update a planning option for a financial project plan version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}

Financial Project Plans/Planning Options/Planning Currencies

The Planning Currency resource is used to view, create, update, and delete project and planning currencies.

Create a planning currency for a project financial plan version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies
Delete a planning currency for a project financial plan version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies/{PlanningCurrencyId}
Get a planning currency for a financial project plan version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies/{PlanningCurrencyId}
Get all planning currencies for a financial project plan version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies

Financial Project Plans/Planning Options/Planning Options Descriptive Flexfields

A listing of all the descriptive flexfields available for planning options in the financial project plan version.

Get all descriptive flexfields for planning options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF/{PlanningOptionId2}
Get all descriptive flexfields for planning options as a collection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF
Update a descriptive flexfield for planning options: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF/{PlanningOptionId2}

Financial Project Plans/Resource Assignments

The Resource Assignments resource is used to view, create, update, and delete a financial project plan resource assignment.

Create a resource assignments for a financial project plan version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments
Delete a resource assignment for a financial project plan version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}
Get a resource assignment for a financial project plan version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}
Get all resource assignments for a financial project plan version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments
Update a resource assignment for a financial project plan version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}

Financial Project Plans/Resource Assignments/Planning Amounts

The Planning Amounts resource is used to view, create, update, and delete a financial project plan resource assignment amounts.

Adjust the financial project plan line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/adjust
Create a planning amounts for a resource assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts
Get a planning amount for a resource assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}
Get all planning amounts for a resource assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts
Refresh rates for the financial project plan line.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/refreshRates
Update a planning amount for a resource assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}
Update planned amounts from progress for a resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/updatePlannedAmountsFromProgress

Financial Project Plans/Resource Assignments/Planning Amounts/Plan Lines Descriptive Flexfields

The Plan Lines descriptive flexfields resource is used to capture, view, and update additional information for planning amounts in financial project plans.

Create a descriptive flexfield for summary planning amounts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF
Get a descriptive flexfield for summary planning amounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF/{PlanLineId2}
Get all descriptive flexfields for summary planning amounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF
Update a descriptive flexfield for summary planning amounts: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF/{PlanLineId2}

Financial Project Plans/Resource Assignments/Planning Amounts/Planning Amount Details

The Planning Amount Details resource is used to view, create, update, and delete a financial project plan resource assignment periodic amounts.

Adjust the financial project plan line period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanningAmountDetailsUniqID}/action/adjust
Create a periodic planning amount for a resource assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails
Get a periodic detail for a planning amount for a resource assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanningAmountDetailsUniqID}
Get all periodic details for a planning amount for a resource assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails
Update a periodic planning amount for a resource assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/financialProjectPlans/{PlanVersionId}/child/ResourceAssignments/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanningAmountDetailsUniqID}

Grants Keywords

The Grants Keywords resource is used to view the grants keywords, which are used to uniquely describe and track the key subject area of an award or grants personnel.

Get a grants keyword.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/grantsKeywords/{KeywordId}
Get all grants keywords.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/grantsKeywords

Grants Personnel

The Grants Personnel resource is used to view, create, and delete Grants personnel.

Create grants personnel: Method: post
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel
Delete a grants personnel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}
Get a grants personnel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}
Get all grants personnel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel
Update a grants personnel: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}

Grants Personnel/Grants Personnel Descriptive Flexfields

A listing of all the descriptive flexfields available for Grants personnel.

Create grants personnel descriptive flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelDFF
Get a grants personnel descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelDFF/{PersonId2}
Get all grants personnel descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelDFF
Update a grants personnel descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelDFF/{PersonId2}

Grants Personnel/Grants Personnel Keywords

The Grants Personnel Keywords resource is used to view, create, and delete keywords that are associated to Grants personnel.

Create grants personnel keywords: Method: post
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelKeyword
Delete a keyword associated to a grants personnel: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelKeyword/{PersonnelKeywordId}
Get a keyword associated to a grants personnel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelKeyword/{PersonnelKeywordId}
Get all keywords associated to a grants personnel: Method: get
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelKeyword
Update a grants personnel keyword: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelKeyword/{PersonnelKeywordId}

Labor Schedule Cost Distributions

The Labor Schedule Cost Distributions resource used to see the distributions associated to a project, task, or raw labor cost.

Get labor schedule cost distributions.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCostDistributions/{RunTargetId}
Get many labor schedule cost distributions.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCostDistributions

Labor Schedule Cost Distributions/Labor Schedule Cost Distribution Errors

The Labor Schedule Cost Distribution Errors resource used to see the errors associated to distributions for resolution.

Get labor schedule cost distribution errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCostDistributions/{RunTargetId}/child/costDistributionErrors/{costDistributionErrorsUniqID}
Get many labor schedule cost distribution errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCostDistributions/{RunTargetId}/child/costDistributionErrors

Labor Schedule Costs

The Labor Schedule Costs resource is used to view the labor raw costs loaded before they're distributed.

Delete labor costs in Error status: Method: post
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/action/deleteErrors
Get a labor schedule cost.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/{LdInterfaceId}
Get many labor schedule costs.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCosts

Labor Schedule Costs Total Errors

The labor schedules costs total errors resource used to generate the total amount and row count portion of the analytic on the labor cost management page.

Get labor schedule costs total errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCostsTotalErrors/{laborSchedulesCostsTotalErrorsUniqID}
Get many labor schedule costs total errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCostsTotalErrors

Labor Schedule Costs Total Errors/Labor Schedule Costs Total Errors by Period

The labor schedule costs total errors by period resource used to generate the total amount and row count for the last 3 periods portion of the analytic on the labor cost management page.

Get labor schedule cost errors by period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCostsTotalErrors/{laborSchedulesCostsTotalErrorsUniqID}/child/errorByPeriod/{errorByPeriodUniqID}
Get many labor schedule cost errors by period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCostsTotalErrors/{laborSchedulesCostsTotalErrorsUniqID}/child/errorByPeriod

Labor Schedule Costs/Labor Schedule Cost Distributions

The Labor Schedule Cost Distributions resource used to see the distributions associated to a project, task, or raw labor cost.

Get labor schedule cost distributions.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/{LdInterfaceId}/child/laborSchedulesCostDistributions/{RunTargetId}
Get many labor schedule cost distributions.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/{LdInterfaceId}/child/laborSchedulesCostDistributions

Labor Schedule Costs/Labor Schedule Cost Distributions/Labor Schedule Cost Distribution Errors

The Labor Schedule Cost Distribution Errors resource used to see the errors associated to distributions for resolution.

Get labor schedule cost distribution errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/{LdInterfaceId}/child/laborSchedulesCostDistributions/{RunTargetId}/child/costDistributionErrors/{costDistributionErrorsUniqID}
Get many labor schedule cost distribution errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/{LdInterfaceId}/child/laborSchedulesCostDistributions/{RunTargetId}/child/costDistributionErrors

List of Values/Award Budget Periods

The Award Budget Period resource is used to view attributes such as budget period name, start date, and end date.

Get all award budget periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetPeriodsLOV
Get an award budget period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardBudgetPeriodsLOV/{awardBudgetPeriodsLOVUniqID}

List of Values/Award Funding Sources

The Award Funding Source resource is used to create or update a funding source for the award.

Get all award funding sources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardFundingSourcesLOV
Get an award funding source: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardFundingSourcesLOV/{AwardFundingSourceId}

List of Values/Descriptive Flexfield Contexts

Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

List of Values/LOV for Award Project Funding Sources

The Award Project Funding Sources LOV resource is used to view an award project funding source. The service data object contains a list of funding sources with details such as funding source name and number.

Get all award-project funding sources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardProjectFundingSourcesLOV
Get an award-project funding source: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardProjectFundingSourcesLOV/{awardProjectFundingSourcesLOVUniqID}

List of Values/LOV for Award Templates

The Award Templates LOV resource is used to view all or a filtered set of award templates. This object includes attributes which are used to display one or more attributes of one or many award templates.

Get all award templates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardTemplatesLOV
Get an award template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardTemplatesLOV/{awardTemplatesLOVUniqID}

List of Values/LOV for Awards by Projects

The Awards By Projects LOV resource is used to view the awards for a particular project. This service data object contains a list of awards with details such as award id, award name, and award number.

Get all award-project mappings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardsByProjectsLOV
Get an award-project mapping: Method: get
Path: /fscmRestApi/resources/11.13.18.05/awardsByProjectsLOV/{awardsByProjectsLOVUniqID}

List of Values/LOV for Burden Schedules

The LOV for Burden Schedules resource is used to view a list of values of burden schedules. This object includes attributes which are used to store values of a burden schedule.

Get a burden schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/burdenSchedulesLOV/{BurdenScheduleId}
Get all burden schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/burdenSchedulesLOV

List of Values/LOV for Deliverable and Work Item Types

The LOV for Deliverable and Work Item Types resource is used to list deliverable and work item type values. The deliverable type provides a way to classify the output that must be produced to complete a requirement, project, or task. Examples include functional design documents, test plans, or physical objects. Work items originate in Oracle Innovation Management, Oracle Product Development, and Oracle Sourcing.

Get a deliverable or work item type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverableTypesLOV/{DeliverableTypeId}
Get all deliverable and work item types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/deliverableTypesLOV

List of Values/LOV for Expenditure Types

The Expenditure Types LOV resource is used to view an expenditure type. This object includes attributes which are used to store values of an expenditure type.

Get all expenditure types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenditureTypesLOV
Get an expenditure type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/{ExpenditureTypeId}

List of Values/LOV for Expenditure Types/LOV for Expenditure Type Classes

The Expenditure Type Classes LOV resource is used to view an expenditure type class. This object includes attributes which are used to store values of an expenditure type class.

Get all expenditure type classes for an expenditure type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/{ExpenditureTypeId}/child/ExpenditureTypeClassesLOV
Get an expenditure type class for an expenditure type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenditureTypesLOV/{ExpenditureTypeId}/child/ExpenditureTypeClassesLOV/{ExpenditureTypeClassId}

List of Values/LOV for Funding Sources

Resource used to get all or a filtered set of funding sources.

Get a funding source: Method: get
Path: /fscmRestApi/resources/11.13.18.05/fundingSourcesLOV/{FundingSourceId}
Get all funding sources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/fundingSourcesLOV

List of Values/LOV for Labor Distribution Costs Pay Element

The Labor Schedule Costs Pay Elements LOV is used to find pay elements for searching labor schedule distributed costs.

Get a payroll cost pay element.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborScheduleCostsPayElementsLOV/{ElementTypeId}
Get many payroll cost pay elements.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborScheduleCostsPayElementsLOV

List of Values/LOV for Labor Distribution Costs Person Assignments

The Labor Distribution Costs Person Assignments LOV is used to find people and assignments that exist on costs from a labor schedule distribution.

Get a distributed payroll cost person assignment.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborScheduleCostsPersonAssignmentsLOV/{AssignmentId}
Get many person assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/laborScheduleCostsPersonAssignmentsLOV

List of Values/LOV for Organizations Classified for Projects

Lists current project expenditure organizations, project task owning organizations, and departments. Classifications categorize organizations based on their purpose. An organization classified as a project expenditure organization can incur expenditures for projects, and be used as a planning and budgeting resource. Organizations that own and manage programs, projects, and tasks are classified as project task owning organizations. Departments are organizations to which employees are assigned to within the enterprise's workforce structure and can be used to search for employees.

Get all organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectClassifiedOrganizationsLOV
Get an organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectClassifiedOrganizationsLOV/{OrganizationClassificationId}

List of Values/LOV for Project Billing Event Types

The Project Billing Event Types LOV resource is used to view a project billing event type. This object includes attributes which are used to store values of a project billing event type.

Get a project billing event type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventTypesLOV/{EventTypeId}
Get all project billing event types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/eventTypesLOV

List of Values/LOV for Project Business Units

The LOV for Project Business Units resource is used to view a list of project business units. A business unit is a unit of an enterprise that performs one or many business functions that can be rolled up in a management hierarchy. A project business unit is one within which the project is created, and in which the project customer revenue and receivable invoices are processed.

Get a project business unit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/prjBusinessUnitsLOV/{prjBusinessUnitsLOVUniqID}
Get all project business units: Method: get
Path: /fscmRestApi/resources/11.13.18.05/prjBusinessUnitsLOV

List of Values/LOV for Project Class Codes

The LOV for Project Class Codes resource is used to view a list of values of project class codes. This object includes attributes which are used to store values of a project class code.

Get a project class code: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectClassCodesLOV/{ClassCodeId}
Get all project class codes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectClassCodesLOV

List of Values/LOV for Project Organizations

The Project Organizations LOV resource is used to view a project organization. This object includes attributes which are used to store values of a project organization.

Get a project organization: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectOrganizationsLOV/{projectOrganizationsLOVUniqID}
Get all project organizations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectOrganizationsLOV

List of Values/LOV for Project Planning Resources

The Project Planning Resources LOV is used to view a list of active resources from a planning resource breakdown structure associated with a project.

Get a project planning resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbsElementsLOV/{projectPlanningRbsElementsLOVUniqID}
Get all project planning resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbsElementsLOV

List of Values/LOV for Project Programs

Get: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramsLOV/{ProjectProgramId}
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramsLOV

List of Values/LOV for Project Roles

The Project Roles LOV resource is used to view a Project Role. This object includes attributes which are used to store values of a project role.

Get a project role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectRolesLOV/{ProjectRoleId}
Get all project roles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectRolesLOV

List of Values/LOV for Project Tasks

The LOV for Project Tasks resource is used to view project tasks for a specific project.

Get a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTasksLOV/{TaskId}
Get all project tasks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTasksLOV

List of Values/LOV for Project Templates

The LOV for Project Templates resource is used to view a list of project templates. Project templates are set up to have features common in the projects that an organization wants to create. A project template is used to enable a project for financial management and the financial attributes are copied from the template to the project.

Get a project template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplatesLOV/{projectTemplatesLOVUniqID}
Get all project templates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplatesLOV

List of Values/LOV for Project Types

The Project Types LOV resource is used to view a project type. This object includes attributes which are used to store values of a project type.

Get a project type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTypesLOV/{ProjectTypeId}
Get all project types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTypesLOV

List of Values/LOV for Projects

The Projects LOV resource is used to view a list of values of projects. This object includes attributes which are used to store values of a project.

Get a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsLOV/{ProjectId}
Get all projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsLOV

List of Values/LOV for Rate Schedules

The LOV for Rate Schedules resource is used to view a list of values of rate schedules. Rate schedules contain rates or markup percentage for person, job, nonlabor, and resource class.

Get a rate schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateSchedulesLOV/{rateSchedulesLOVUniqID}
Get all rate schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateSchedulesLOV

List of Values/LOV for Work Types

The Work Types LOV resource is used to view a work type. This object includes attributes which are used to store values of a work type.

Get a work type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/workTypesLOV/{WorkTypeId}
Get all work types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/workTypesLOV

Pay Element to Expenditure Type Derivation Patterns

The Pay Element Expenditure Type Derivations resource is used to view and manage the patterns that will derive an expenditure type based on the pay element associated with a payroll cost being distributed to projects.

Create pay element expenditure type derivation patterns: Method: post
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations
Delete a pay element expenditure type derivation pattern: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}
Get a pay element expenditure type derivations pattern: Method: get
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}
Get many pay element expenditure type derivation patterns: Method: get
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations
Update a pay element expenditure type derivation pattern: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}

Pay Element to Expenditure Type Derivation Patterns/Pay Element to Expenditure Type Derivation Precedence Rules

The Pay Element Expenditure Type Derivation Precedence Rules resource is used to manage pay element expenditure type derivation precedence rules and to specify the order in which they must be applied during the distribution of payroll cost to projects.

Create pay element expenditure type derivation precedence rules: Method: post
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules
Delete a pay element expenditure type derivation precedence rule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}
Get a pay element expenditure type derivation precedence rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}
Get many pay element expenditure type derivation precedence rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules
Update a pay element expenditure type derivation precedence rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}

Pay Element to Expenditure Type Derivation Patterns/Pay Element to Expenditure Type Derivation Precedence Rules/Pay Element to Expenditure Type Results

The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.

Create pay element expenditure type derivation precedence rule expenditure types: Method: post
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}/child/expenditureTypes
Delete a pay element expenditure type derivation precedence rule expenditure type: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}/child/expenditureTypes/{ResultId}
Get a pay element expenditure type derivation precedence rule expenditure type result: Method: get
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}/child/expenditureTypes/{ResultId}
Get many pay element expenditure type derivation precedence rule expenditure types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}/child/expenditureTypes
Update a pay element expenditure type derivation precedence rule expenditure type: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}/child/expenditureTypes/{ResultId}

Pay Elements Eligible for Project Distribution

The Project Pay Elements resource is used to view and manage the pay elements that are eligible for project distribution.

Create pay elements eligible for project distribution.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPayElements
Get a pay element that has been defined as eligible for project distribution at some time interval.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPayElements/{PayElementDistributionId}
Get many pay elements defined as eligible for project distribution at some time interval.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPayElements
Update a pay element project distribution eligibility.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPayElements/{PayElementDistributionId}

Person Assignment Labor Schedules

The Person Assignment Labor Schedules resource is used to view and manage the labor schedule headers for a combination of a person and an assignment.

Copy a version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/action/copyVersion
Create many Person Assignment Labor Schedule headers.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules
Delete a Person Assignment Labor Schedule header.: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}
Get a Person Assignment Labor Schedule header.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}
Get many Person Assignment Labor Schedule headers.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules
Update a Person Assignment Labor Schedule header.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}

Person Assignment Labor Schedules/Person Assignment Labor Schedule Versions

The versions resource is used as a child of the Person Assignment Labor Schedules resource to view and manage the versions of labor schedules for a person and assignment combination.

Create many versions within a Person Assignment Labor Schedule header.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions
Delete a version within a Person Assignment Labor Schedule header.: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions/{versionsUniqID}
Get a version within a Person Assignment Labor Schedule header.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions/{versionsUniqID}
Get many versions within Person Assignment Labor Schedule header.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions
Update a version within a Person Assignment Labor Schedule header.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions/{versionsUniqID}

Person Assignment Labor Schedules/Person Assignment Labor Schedule Versions/Person Assignment Labor Schedule Version Rules

The DistributionRule services is used as a child of the Person Assignment Version resource to view and manage the distribution rules for a certain version.

Create many distribution rules within a version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions/{versionsUniqID}/child/distributionRules
Delete a distribution rule within a version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions/{versionsUniqID}/child/distributionRules/{distributionRulesUniqID}
Get a distribution rule within a version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions/{versionsUniqID}/child/distributionRules/{distributionRulesUniqID}
Get many distribution rules within a version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions/{versionsUniqID}/child/distributionRules
Update a distribution rule within a version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versions/{versionsUniqID}/child/distributionRules/{distributionRulesUniqID}

Planning Resource Breakdown Structures for Projects

The Planning Resource Breakdown Structures for Projects resource is used to view and create planning resource breakdown structure assignments to projects. You can view the header details, project information, and whether the planning resource breakdown structure is marked as primary.

Create a planning resource breakdown structure assignment to a project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs
Get a planning resource breakdown structure assigned to a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}
Get all planning resource breakdown structures assigned to projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs
Update a planning resource breakdown structure assignment to a project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}

Planning Resource Breakdown Structures for Projects/Elements

The Elements resource is used to view and create resources in a planning resource breakdown structure.

Create a resource in a planning resource breakdown structure: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}/child/Elements
Get a resource in a planning resource breakdown structure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}/child/Elements/{ElementsUniqID}
Get all resources in a planning resource breakdown structure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}/child/Elements
Update a resource in a planning resource breakdown structure: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}/child/Elements/{ElementsUniqID}

Planning Resource Breakdown Structures for Projects/Formats

The Formats resource is used to view all resource formats supported by a planning resource breakdown structure.

Get a resource format supported by a planning resource breakdown structure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}/child/Formats/{RbsFormatId}
Get all resource formats supported by a planning resource breakdown structure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}/child/Formats

Project Asset Line Identifier

The project asset line resource is used to view or update project asset lines and view project asset line details.

Get a project asset line associated with this project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssetLines/{ProjectAssetLineId}
Get all project asset lines associated with this project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssetLines
Update a project asset line associated with a project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectAssetLines/{ProjectAssetLineId}

Project Asset Line Identifier/Project Asset Line Detail Identifier

The Project Asset Line Details resource is a child of the Project Asset Line resource.

Get all project asset line details for all project asset lines associated with a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssetLines/{ProjectAssetLineId}/child/ProjectAssetLineDetails
Get project asset line details associated with this project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssetLines/{ProjectAssetLineId}/child/ProjectAssetLineDetails/{ProjAssetLineDtlUniqId}

Project Assets

The project asset resource is used to view, create, update and delete project asset and asset assignments, including those from Project Portfolio Management and those imported from third-party applications. Asset Assignment is a child of the Asset.

Create project assets: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectAssets
Delete a project asset: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}
Get a project asset: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}
Get all project assets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssets
Update a project asset: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}

Project Assets/Project Asset Assignments

The project asset assignment resource is used to view, create, update, and delete project asset assignments, including those from Project Portfolio Management and those imported from third-party applications.

Create project asset assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetAssignments
Delete an asset assignment for a project asset: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetAssignments/{AssetAssignmentId}
Get all asset assignments for a project asset: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetAssignments
Get an asset assignment for a project asset: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetAssignments/{AssetAssignmentId}

Project Assets/Project Asset Descriptive Flexfields

The operations from the Project Assets/Project Asset Descriptive Flexfields category.

Create: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetDff
Get: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetDff/{ProjectAssetId}
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetDff
Update: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetDff/{ProjectAssetId}

Project Award Distributions

The Project Award Distributions resource is used to distribute a cost using the active funding patterns for date ranges that include the expenditure item date provided.

Call the Award Distribution process: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/action/projectAwardDistribution
Get all award distributions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions
Get an award distribution: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}

Project Award Distributions/Project Award Cost Distribution Records

This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.

Get all award distribution lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}/child/ProjectAwardDistributionLines
Get all award distribution lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}/child/ProjectAwardDistributionSuccessLines
Get an award distribution line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}/child/ProjectAwardDistributionLines/{AwardDistributionLineId}
Get an award distribution line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}/child/ProjectAwardDistributionSuccessLines/{AwardDistributionLineId}

Project Award Distributions/Project Award Cost Distribution Records/Project Award Distribution Errors

This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.

Get all award distribution errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}/child/ProjectAwardDistributionLines/{AwardDistributionLineId}/child/ProjectAwardDistributionErrors
Get an award distribution error: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}/child/ProjectAwardDistributionLines/{AwardDistributionLineId}/child/ProjectAwardDistributionErrors/{TransactionErrorId}

Project Award Distributions/Project Award Distribution Errors

This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.

Get all award distribution errors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}/child/ProjectAwardDistributionErrors
Get an award distribution error: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}/child/ProjectAwardDistributionErrors/{TransactionErrorId}

Project Billing Events

The Project Billing Events resource is used to view, create, update, and delete project billing events.

Create a project billing event: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBillingEvents
Delete a project billing event: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectBillingEvents/{projectBillingEventsUniqID}
Get a project billing event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBillingEvents/{projectBillingEventsUniqID}
Get all project billing events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBillingEvents
Update a project billing event: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBillingEvents/{projectBillingEventsUniqID}

Project Billing Events/Project Billing Event Descriptive Flexfields

A listing of all the descriptive flexfields available for project billing events.

Create a project billing event descriptive flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBillingEvents/{projectBillingEventsUniqID}/child/billingEventDFF
Get a project billing event descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBillingEvents/{projectBillingEventsUniqID}/child/billingEventDFF/{EventId}
Get all project billing event descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBillingEvents/{projectBillingEventsUniqID}/child/billingEventDFF
Update a project billing event descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBillingEvents/{projectBillingEventsUniqID}/child/billingEventDFF/{EventId}

Project Budget Summary

The Project Budget Summary resource is used to view a project budget.

Get a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}
Get all project budget versions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary

Project Budget Summary/Resources

The Resources resource is used to view a project budget version resource.

Get a resource summary amounts for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}
Get all resource summary amounts for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Resources

Project Budget Summary/Resources/Budget Lines

The Budget Lines resource is used to view a resource's project budget line.

Get a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}/child/BudgetLines/{BudgetLinesUniqID}
Get all budget lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}/child/BudgetLines

Project Budget Summary/Resources/Budget Lines/Planning Amount Details

The Planning Amount Details resource is used to view a project budget line periodic amounts.

Get planning amount details for a period for a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}/child/BudgetLines/{BudgetLinesUniqID}/child/PlanningAmountDetails/{PlanningAmountDetailsUniqID}
Get planning amount details for all periods for a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Resources/{RbsElementId}/child/BudgetLines/{BudgetLinesUniqID}/child/PlanningAmountDetails

Project Budget Summary/Tasks

The Tasks resource is used to view a project budget version task.

Get a project task summary amounts for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}
Get all project tasks summary amounts for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Tasks

Project Budget Summary/Tasks/Budget Lines

The Budget Lines resource is used to view a task's project budget line.

Get a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}/child/BudgetLines/{BudgetLinesUniqID}
Get all budget lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}/child/BudgetLines

Project Budget Summary/Tasks/Budget Lines/Planning Amount Details

The Planning Amount Details resource is used to view a project budget line periodic amounts.

Get planning amount details for a period for a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}/child/BudgetLines/{BudgetLinesUniqID2}/child/PlanningAmountDetails/{PlanningAmountDetailsUniqID}
Get planning amount details for all periods for a budget line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/Tasks/{TaskId}/child/BudgetLines/{BudgetLinesUniqID}/child/PlanningAmountDetails

Project Budget Summary/Version Errors

The Version Errors resource is used to view project budget version errors.

Get all errors for a budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/VersionErrors
Get an error for a budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgetSummary/{PlanVersionId}/child/VersionErrors/{VersionErrorsUniqID}

Project Budgets

The Project Budgets resource is used to view, create, update, and delete a project budget.

Adjust for range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/action/adjustForRangeOfProjects
Adjust the budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/action/adjust
Create a project budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets
Delete a project budget version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}
Get a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}
Get all project budget versions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets
Refresh rates for range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/action/refreshRatesForRangeOfProjects
Refresh rates for the budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/action/refreshRates
Reprocess all failed project budgets: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/action/reprocessFailedProjectBudgets
Update a project budget version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}

Project Budgets/Planning Options

The Planning Options resource is used to view the planning options configured for the project budget version. Planning options are user-definable options, including plan settings, rate settings, currency settings, and generation options that are used to control planning scenarios. Budget versions inherit planning options that are defined for financial plan types.

Create a planning option for a project budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions
Get a planning option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}
Get all planning options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions
Update a planning option for a project budget version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}

Project Budgets/Planning Options/Amount Types

The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.

Create an amount type option for a project budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/AmountTypes
Get a amount type for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/AmountTypes/{AmountTypeId}
Get all amount types for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/AmountTypes

Project Budgets/Planning Options/Budgetary Control Settings

The Budgetary Control Setting resource is used to view and update project and top resource control levels.

Create a control budget setting for a project budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/BudgetaryControlSettings
Get a control budget setting for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/BudgetaryControlSettings/{BudgetaryControlSettingId}
Get all control budget settings for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/BudgetaryControlSettings
Update a control budget setting for a project budget version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/BudgetaryControlSettings/{BudgetaryControlSettingId}

Project Budgets/Planning Options/Export Options

The Export Option resource is used to select the planning options attributes to export.

Create an export option for a project budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions
Get a export options setting for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions/{ExportOptionId}
Get all export options settings for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions
Update an export option for a project budget version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions/{ExportOptionId}

Project Budgets/Planning Options/Planning Currencies

The Planning Currency resource is used to view, create, update, and delete project and planning currencies.

Create a planning currency for a project budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies
Delete a planning currency for a project budget version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies/{PlanningCurrencyId}
Get a planning currency for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies/{PlanningCurrencyId}
Get all planning currencies for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies

Project Budgets/Planning Options/Planning Options Descriptive Flexfields

A listing of all the descriptive flexfields available for planning options in project budget versions.

Create a descriptive flexfield for planning options: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF
Get all descriptive flexfields for planning options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF/{PlanningOptionId2}
Get all descriptive flexfields for planning options as a collection: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF
Update a descriptive flexfield for planning options: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF/{PlanningOptionId2}

Project Budgets/Planning Resources

The Planning Resources resource is used to view, create, update, and delete a project budget line.

Create a planning resource for a project budget version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources
Delete a planning resource for a project budget version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}
Get a planning resource for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}
Get all planning resources for a project budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources
Update a planning resource for a project budget version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}

Project Budgets/Planning Resources/Planning Amounts

The Planning Amounts resource is used to view, create, update, and delete periodic amounts for a budget line.

Adjust the budget line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/adjust
Create a plan line for a planning resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts
Delete a plan line for a planning resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}
Get a plan line for a planning resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}
Get all plan lines for a planning resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts
Refresh rates for the budget line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/refreshRates
Update a plan line for a planning resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}

Project Budgets/Planning Resources/Planning Amounts/Plan Lines Descriptive Flexfields

The Plan Lines Descriptive Flexfields resource is used to capture, view, and update additional information for planning amounts in project budgets.

Create a descriptive flexfield for summary planning amounts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF
Get a descriptive flexfield for summary planning amounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF/{PlanLineId2}
Get all descriptive flexfields for summary planning amounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF
Update a descriptive flexfield for summary planning amounts: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF/{PlanLineId2}

Project Budgets/Planning Resources/Planning Amounts/Planning Amount Details

The Planning Amount Details resource is used to view, create, and update periodic amounts for a budget line.

Adjust the budget line period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}/action/adjust
Create a planning amount detail for a period for a budget plan line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails
Delete a planning amount detail for a period for a budget plan line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}
Get a planning amount detail for a period for a budget plan line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}
Get all planning amount detail for all periods for a budget plan line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails
Update a planning amount detail for a period for a budget plan line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}

Project Budgets/Project Budget Attachments

The Attachment resource is used to view, create, update, and delete attachments for project budgets.

Create an attachment for a project budget: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/Attachments
Delete an attachment for a project budget: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}
Get all attachments for a project budget: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/Attachments
Get an attachment for a project budget: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}
Update an attachment for a project budget: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}

Project Budgets/Project Budget Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Budgets/Project Budget Attachments/Large Object (LOB) Attributes - File Web Image

The base64 encoded image of the file displayed in .png format if the source is a convertible image.

Get a File Web Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Budgets/Version Errors

The Version Errors resource is used to view project budget version errors.

Get all errors for a budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/VersionErrors
Get an error for a budget version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/VersionErrors/{VersionErrorsUniqID}

Project Commitments

The project commitments resource is used to view, create, and delete project commitments. This includes viewing, creating, and deleting project commitments that are imported from third-party applications and viewing commitments that are created in other Oracle Fusion applications such as supplier invoices, requisitions, purchase orders, and so on.

Create a project commitment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectCommitments
Delete a project commitment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectCommitments/{projectCommitmentsUniqID}
Get a project commitment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCommitments/{projectCommitmentsUniqID}
Get all project commitments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCommitments

Project Contract Bill Transactions

The Project Contract Bill Transactions resource can be used to create, update, delete, and get bill transactions. Bill transactions are the smallest unit of transactional detail that can appear on a customer invoice, and are a record of the project, product or service-related line items to be billed. Each bill transaction has a bill quantity, a unit of measure (which provides context to the bill quantity), a unit price and an amount to be billed. When invoicing and revenue generation are both based on the same source transaction, bill transactions record both invoice and revenue measures on a single transaction, unifying the two processes. The history of invoicing and revenue generation for a bill transaction is tracked through related invoice distribution lines and revenue distribution lines respectively.

Get a project contract bill transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractBillTransactions/{projectContractBillTransactionsUniqID}
Get many project contract bill transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractBillTransactions

Project Contract Invoices

The Project Contract Invoices resource is used to view invoices.

Approval of a single submitted invoice: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/action/approveProjectContractInvoice
Cancel a Project Contract Invoice.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/action/cancelProjectContractInvoice
Delete a standard project contract invoice in draft status: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}
Get a project contract invoice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}
Get all project contract invoices: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices
Rejection of a single submitted invoice: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/action/rejectProjectContractInvoice
Release of a single approved invoice: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/action/releaseProjectContractInvoice
Return of a single approved or approval rejected invoice to draft status: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/action/returnToDraftProjectContractInvoice
Submit of a single draft invoice: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/action/submitProjectContractInvoice
Unrelease of a single released or transfer rejected invoice: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/action/unreleaseProjectContractInvoice
Update an invoice header for a project contract invoice: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}

Project Contract Invoices/Invoice Header Descriptive Flexfields

A listing of all the descriptive flexfields available for project contract invoices.

Get a project contract invoice descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceHeaderDff/{InvoiceId2}
Get all project contract invoice descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceHeaderDff
Update an invoice header descriptive flexfield for a project contract invoice: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceHeaderDff/{InvoiceId2}

Project Contract Invoices/Invoice Lines

The Invoice Lines resource is used to view the details of the invoice lines.

Get all invoice lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines
Get an invoice line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines/{InvoiceLineId}
Update an invoice line for a project contract invoice: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines/{InvoiceLineId}

Project Contract Invoices/Invoice Lines/Invoice Line Descriptive Flexfields

A listing of all the descriptive flexfields available for invoice lines.

Get all invoice line descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines/{InvoiceLineId}/child/InvoiceLineDff
Get an invoice line descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines/{InvoiceLineId}/child/InvoiceLineDff/{InvoiceLineId2}
Update an invoice line descriptive flexfield for a project contract invoice: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines/{InvoiceLineId}/child/InvoiceLineDff/{InvoiceLineId2}

Project Contract Invoices/Invoice Lines/Invoice Line Distributions

The Invoice Line Distributions resource is used to view the details of invoice line distributions.

Get all invoice line distributions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines/{InvoiceLineId}/child/InvoiceLineDistributions
Get an invoice line distribution: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLines/{InvoiceLineId}/child/InvoiceLineDistributions/{InvoiceDistId}

Project Contract Invoices/Project Contract Invoices Attachments

The attachments resource is used to view, create, update and delete attachments for project contract invoices.

Create an attachment for a project contract invoice: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/Attachments
Delete an attachment for a project contract invoice: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/Attachments/{AttachmentsUniqID}
Get all attachments for a project contract invoice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/Attachments
Get an attachment for a project contract invoice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/Attachments/{AttachmentsUniqID}
Update an attachment for a project contract invoice: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/Attachments/{AttachmentsUniqID}

Project Contract Invoices/Project Contract Invoices Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Contract Invoices/Project Contract Invoices Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Contract Revenue

The Project Contract Revenue resource is used to view revenue transactions.

Get a project contract revenue: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractRevenue/{projectContractRevenueUniqID}
Get all project contract revenues: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectContractRevenue

Project Cost Validations

Validate project cost transactions using the project cost validations REST API. For example, ensure that the combination of project attributes are valid for a given date.

Validate Project Cost: Method: post
Path: /fscmRestApi/projectCosts/11.13.18.05/projectCostValidations/validateProjectCost

Project Costs

The Project Costs resource is used to view and update project costs. Project costs are the smallest logical units of expenditure that you can charge to a project or task. For example, a time card item or an expense report item.

Adjust project costs: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/action/adjustProjectCosts
Get a project cost: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}
Get all project costs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCosts
Update a project cost: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}

Project Costs/Adjustments

The Adjustments resource is used to view the adjustments performed on project costs.

Get all adjustments for a project cost: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/child/Adjustments
Get an adjustment for a project cost: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/child/Adjustments/{AdjustmentsUniqID}

Project Costs/Project Costs Descriptive Flexfields

The Project Costs Descriptive Flexfields resource is used to view and update additional information for project costs.

Get a descriptive flexfield for a project cost: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/child/ProjectCostsDFF/{ExpenditureItemId}
Get all descriptive flexfields for a project cost: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/child/ProjectCostsDFF
Update a descriptive flexfield for a project cost: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/child/ProjectCostsDFF/{ExpenditureItemId}

Project Costs/Project Standard Cost Collection Flexfields

The Project Standard Cost Collection Flexfields resource is used to capture, view, and update standard cost collection information for project costs.

Get all standard cost collection information for a project cost: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/child/ProjectStandardCostCollectionFlexFields
Get standard cost collection information for a project cost: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/child/ProjectStandardCostCollectionFlexFields/{ExpenditureItemId}
Update standard cost collection information for a project cost: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/child/ProjectStandardCostCollectionFlexFields/{ExpenditureItemId}

Project Enterprise Expense Resources

The Project Enterprise Expense resource is used to view and create project enterprise expense resources.

Create a project enterprise expense resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseExpenseResources
Delete a project enterprise expense resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseExpenseResources/{ResourceId}
Get a project enterprise expense resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseExpenseResources/{ResourceId}
Get all project enterprise expense resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseExpenseResources
Update a project enterprise expense resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseExpenseResources/{ResourceId}

Project Enterprise Labor Resources

The Project Enterprise Labor resource is used to view and create project enterprise labor resources.

Create a project enterprise labor resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources
Delete a project enterprise labor resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}
Get all project enterprise labor resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources
Get all project enterprise labor resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}
Get daily available capacity of a resource.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/action/getDailyAvailableCapacity
Get projected utilization of a resource.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/action/getProjectedUtilization
Get resource available capacity score: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/action/getAvailableCapacityScore
Get target utilization percentage of the resources: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/action/getTargetUtilization
Update a project enterprise labor resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}
Update person information of the resources from HCM: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/action/updatePersonInformationFromHCM

Project Enterprise Labor Resources/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments
Delete an attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments
Get an attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments/{AttachmentsUniqID}

Project Enterprise Labor Resources/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Enterprise Labor Resources/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Enterprise Labor Resources/Project Enterprise Resource Calendars

The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource.

Get a single shift resource calendar: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ResourceCalendars/{CalendarId}
Get all single shift resource calendars used to schedule or staff a resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ResourceCalendars

Project Enterprise Labor Resources/Project Enterprise Resource Calendars/Project Enterprise Resource Calendar Exceptions

The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.

Get a calendar exception: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ResourceCalendars/{CalendarId}/child/CalendarExceptions/{ExceptionId}
Get all calendar exceptions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ResourceCalendars/{CalendarId}/child/CalendarExceptions

Project Enterprise Labor Resources/Project Enterprise Resource HCM Assignment Details

The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource.

Get all HCM assignments of the project enterprise labor resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/PersonAssignmentDetails
Get an HCM assignment of the project enterprise labor resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/PersonAssignmentDetails/{PersonAssignmentDetailsUniqID}

Project Enterprise Labor Resources/Project Enterprise Resource Image

The Project Enterprise Resource Image is used to view and create project enterprise resource image.

Delete an image of the project enterprise resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ProjectEnterpriseResourceImage/{ImageId}
Get all images of the project enterprise resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ProjectEnterpriseResourceImage
Get an image of the project enterprise resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ProjectEnterpriseResourceImage/{ImageId}
Upload an image of the project enterprise resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ProjectEnterpriseResourceImage

Project Enterprise Labor Resources/Project Enterprise Resource Image/Large Object (LOB) Attributes - Image

Delete an Image: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ProjectEnterpriseResourceImage/{ImageId}/enclosure/Image
Get an Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ProjectEnterpriseResourceImage/{ImageId}/enclosure/Image
Replace an Image: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ProjectEnterpriseResourceImage/{ImageId}/enclosure/Image

Project Enterprise Labor Resources/Project Enterprise Resource Pool Membership

The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships.

Get a resource pool where project enterprise resource holds membership: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ResourcePoolMembership/{ResourcePoolMembershipId}
Get all resource pools where project enterprise resource holds membership: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ResourcePoolMembership

Project Enterprise Resources

The project enterprise resource is used to store values while creating or updating project enterprise resources. A project enterprise resource can be a labor resource or an expense resource and can be assigned to a project to complete the project work.

Get a project enterprise resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseResources/{projectEnterpriseResourcesUniqID}
Get all project enterprise resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseResources

Project Enterprise Resources/Large Object (LOB) Attributes - Resource Image URL

The URL for the image of the project enterprise resource.

Delete a Resource Image URL: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseResources/{projectEnterpriseResourcesUniqID}/enclosure/Image
Get a Resource Image URL: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseResources/{projectEnterpriseResourcesUniqID}/enclosure/Image
Replace a Resource Image URL: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectEnterpriseResources/{projectEnterpriseResourcesUniqID}/enclosure/Image

Project Events

The Project Events resource is used to view calendar events for a project.

Get a project calendar event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEvents/{ProjectEventId}
Get all project calendar events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectEvents

Project Expenditure Batches

The Project Expenditure Batches resource is used to view and update unprocessed project expenditure batches that require approval before they can be converted into project costs. If you update the status of an expenditure batch to Submitted status, then the action will initiate the project expenditure batch approval workflow and the approvers defined in the Project Expenditure Batch Approval Task workflow will be notified.

Get a project expenditure batch: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectExpenditureBatches/{BatchId}
Get all project expenditure batches: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectExpenditureBatches
Update a project expenditure batch: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectExpenditureBatches/{BatchId}

Project Expenditure Items

The smallest logical unit of an expenditure that you can charge to a project or task. For example, a time card item or an expense report item.

Get all expenditure items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectExpenditureItems
Get an expenditure item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectExpenditureItems/{ExpenditureItemId}
Update an expenditure item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectExpenditureItems/{ExpenditureItemId}

Project Expenditure Items/Project Expenditure Items Descriptive Flexfields

The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.

Get a descriptive flexfield for a project expenditure item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectExpenditureItems/{ExpenditureItemId}/child/ProjectExpenditureItemsDFF/{ExpenditureItemId2}
Get all descriptive flexfields for a project expenditure item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectExpenditureItems/{ExpenditureItemId}/child/ProjectExpenditureItemsDFF
Update a descriptive flexfield for a project expenditure item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectExpenditureItems/{ExpenditureItemId}/child/ProjectExpenditureItemsDFF/{ExpenditureItemId2}

Project Expense Resources

This resource can be used to view the expense resources or the labor resources in a project as applicable.

Create a project expense resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectExpenseResources
Delete a project expense resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectExpenseResources/{ProjResourceId}
Get a project expense resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectExpenseResources/{ProjResourceId}
Get all project expense resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectExpenseResources
Update a project expense resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectExpenseResources/{ProjResourceId}

Project Financial Tasks

The Financial Task resource is used to list financial tasks. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources.

Get a financial task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectFinancialTasks/{projectFinancialTasksUniqID}
Get all financial tasks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectFinancialTasks

Project Forecasts

The Project Forecasts resource is used to view and create project forecasts.

Adjust for range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/action/adjustForRangeOfProjects
Adjust the forecast version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/action/adjust
Create a project forecast version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts
Delete a project forecast version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}
Get a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}
Get all project forecast versions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts
Refresh rates for range of projects: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/action/refreshRatesForRangeOfProjects
Refresh rates for the forecast version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/action/refreshRates
Refreshes actual amounts for project forecast version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/action/refreshActualAmounts
Reprocess all failed project forecasts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/action/reprocessFailedProjectForecasts
Update a project forecast version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}

Project Forecasts/Errors

The Errors resource is used to view the errors in project forecasts.

Get all errors for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/VersionErrors
Get an error for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/VersionErrors/{VersionErrorsUniqID}

Project Forecasts/Planning Options

The Planning Options resource is used to view the planning options configured for the project forecast version.

Create a planning option for a project forecast version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions
Get a planning option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}
Get all planning options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions
Update a planning option for a project forecast version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}

Project Forecasts/Planning Options/Amount Types

The Amount Type resource is used to select the cost and revenue items to include in a financial plan type.

Create an amount type option for a project forecast version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/AmountTypes
Get a amount type for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/AmountTypes/{AmountTypeId}
Get all amount types for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/AmountTypes

Project Forecasts/Planning Options/Export Options

The Export Option resource is used to select the planning options attributes to export.

Create an export option for a project forecast version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions
Get a export options setting for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions/{ExportOptionId}
Get all export options settings for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions
Update an export option for a project forecast version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/ExportOptions/{ExportOptionId}

Project Forecasts/Planning Options/Planning Currencies

The Planning Currency resource is used to view, create, update, and delete project and planning currencies.

Create a planning currency for a project forecast version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies
Delete a planning currency for a project forecast version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies/{PlanningCurrencyId}
Get a planning currency for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies/{PlanningCurrencyId}
Get all planning currencies for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningCurrencies

Project Forecasts/Planning Options/Planning Options Descriptive Flexfields

The Planning Options Descriptive Flexfields resource is used to capture, view, and update additional information for planning options in project forecast versions.

Create a descriptive flexfield for planning options: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF
Get a descriptive flexfield for planning options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF/{PlanningOptionId2}
Get all descriptive flexfields for planning options: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF
Update a descriptive flexfield for planning options: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/PlanningOptionsDFF/{PlanningOptionId2}

Project Forecasts/Planning Resources

The Planning Resources resource is used to view project forecast resource assignments.

Create a planning resource for a project forecast version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources
Delete a planning resource for a project forecast version: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}
Get a planning resource for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}
Get all planning resources for a project forecast version: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources
Update a planning resource for a project forecast version: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}

Project Forecasts/Planning Resources/Planning Amounts

The Planning Amounts resource is used to view project forecast resource assignment summary amounts.

Adjust the forecast line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/adjust
Create a summary planning amount for a planning resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts
Delete a summary planning amount for a planning resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}
Get a summary planning amount for a planning resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}
Get all summary planning amounts for a planning resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts
Refresh rates for the Forecast line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/action/refreshRates
Update a summary planning amount for a planning resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}

Project Forecasts/Planning Resources/Planning Amounts/Plan Lines Descriptive Flexfields

The Plan Lines Descriptive Flexfields resource is used to capture and view additional information for planning amounts in project forecasts.

Create a descriptive flexfield for summary planning amounts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF
Get a descriptive flexfield for summary planning amounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF/{PlanLineId2}
Get all descriptive flexfields for summary planning amounts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF
Update a descriptive flexfield for summary planning amounts: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanLinesDFF/{PlanLineId2}

Project Forecasts/Planning Resources/Planning Amounts/Planning Amount Details

The Planning Amount Details resource is used to view project forecast resource assignment periodic amounts.

Adjust the forecast line period: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}/action/adjust
Create a planning amount detail for a period for a forecast plan line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails
Delete a planning amount detail for a period for a forecast plan line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}
Get a planning amount detail for a period for a forecast plan line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}
Get all planning amount detail for all periods for a forecast plan line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails
Update a planning amount detail for a period for a forecast plan line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningResources/{PlanningElementId}/child/PlanningAmounts/{PlanLineId}/child/PlanningAmountDetails/{PlanLineDetailId}

Project Forecasts/Project Forecast Attachments

The attachments resource is used to view, create, update and delete attachments for project forecasts.

Create an attachment for a project forecast: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/Attachments
Delete an attachment for a project forecast: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}
Get all attachments for a project forecast: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/Attachments
Get an attachment for a project forecast: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}
Update an attachment for a project forecast: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}

Project Forecasts/Project Forecast Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Forecasts/Project Forecast Attachments/Large Object (LOB) Attributes - File Web Image

The base64 encoded image of the file displayed in .png format if the source is a convertible image.

Get a File Web Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Insights

The Project Insights resource is used to view various metrics across the project life cycle. Metrics include team member allocation and assignment, milestone risk, task exceptions, invoices awaiting approval, missing time cards, project budget, and overall project health.

Get insights for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}
Get insights for all projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights

Project Insights/Assignments

The Assignments resource is used to view details for the assignments ending soon and reserved assignments for a project.

Get all assignments for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/Assignments
Get an assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/Assignments/{AssignmentId}

Project Insights/Missing Time Cards

The Missing Time Card resource is used to view the details of the missing or incomplete time card count for a project. It includes the resources and their expected hours for time cards that are missing or partially reported.

Get a missing time card: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/MissingTimeCards/{ResourceId}
Get all missing time cards for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/MissingTimeCards

Project Insights/Pending Invoices

The Pending Invoices resource is used to view the details of the invoices pending approval count for a project.

Get a pending invoice: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/PendingInvoices/{InvoiceId}
Get all pending invoices for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/PendingInvoices

Project Insights/Task Exceptions

The Task Exceptions resource is used to view the details of the task exceptions, milestones past due, and milestones due soon counts for a project. It includes what qualified the task or milestone as an exception.

Get a task exception: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/TaskExceptions/{TaskId}
Get all task exceptions for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/TaskExceptions

Project Insights/Team Allocations

The Team Allocations resource is used to view the over and under allocated labor resource details for a project. It includes the weekly assignment, allocation, and variance hours per team member for the twelve weeks that start with the current week.

Get all allocations for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/TeamAllocations
Get allocations for a resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/TeamAllocations/{ResourceId}

Project Issues

The Project Issues resource is used to view issues associated to the project.

Create issues: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectIssues
Delete an issue: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}
Get all issues: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectIssues
Get an issue: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}
Update an issue: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}

Project Issues/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/Attachments
Delete an attachment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/Attachments
Get an attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/Attachments/{AttachmentsUniqID}

Project Issues/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Issues/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Issues/Project Issue Action Items

The Project Issues Action Items resource is used to view action items. Action items are tasks that are defined for issues that facilitates issue resolution.

Create action items: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/IssueAction
Delete an action item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/IssueAction/{ActionItemId}
Get all action items for a project issue: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/IssueAction
Get an action item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/IssueAction/{ActionItemId}
Update an action item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectIssues/{IssueId}/child/IssueAction/{ActionItemId}

Project Labor Resources

This resource can be used to view the expense resources or the labor resources in a project as applicable.

Create a project labor resource: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectLaborResources
Delete a project labor resource: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectLaborResources/{ProjResourceId}
Get a project labor resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectLaborResources/{ProjResourceId}
Get all project labor resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectLaborResources
Resource Replacement: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectLaborResources/{ProjResourceId}/action/resourceReplacement
Resource Request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectLaborResources/{ProjResourceId}/action/resourceRequest
Update a project labor resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectLaborResources/{ProjResourceId}

Project Numbering Configurations

The Project Numbering Configurations resource is used to specify the source by which project numbering is configured.

Get a project numbering configuration: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations/{ConfigurationId}
Get all project numbering configurations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations
Update a project numbering configuration: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations/{ConfigurationId}

Project Numbering Configurations/Project Numbering Configuration Details

The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.

Create a project numbering configuration detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations/{ConfigurationId}/child/ProjectNumberingConfigurationDetails
Delete a project numbering configuration detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations/{ConfigurationId}/child/ProjectNumberingConfigurationDetails/{ConfigurationDetailId}
Get a project numbering configuration detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations/{ConfigurationId}/child/ProjectNumberingConfigurationDetails/{ConfigurationDetailId}
Get all project numbering configuration details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations/{ConfigurationId}/child/ProjectNumberingConfigurationDetails
Update a project numbering configuration detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations/{ConfigurationId}/child/ProjectNumberingConfigurationDetails/{ConfigurationDetailId}

Project Performance

The Project Performance resource is used to view summarized data including project costs, commitments, budgets, forecasts, revenue, and invoice amounts for a project or a group of projects.

Get performance data for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPerformance/{projectPerformanceUniqID}
Get performance data for all projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPerformance

Project Performance/Periodic Project Performance

The Periodic Project Performance resource is used to view summarized data including project costs, commitments, budgets, forecasts, revenue, and invoice amounts for a project or a group of projects for a specific period or all periods in the project duration.

Get periodic performance data for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPerformance/{projectPerformanceUniqID}/child/PeriodicProjectPerformance/{PeriodicProjectPerformanceUniqID}
Get periodic performance data for all projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPerformance/{projectPerformanceUniqID}/child/PeriodicProjectPerformance

Project Plan Details

The Project Plans Details resource is used to view project plans that you have access to. A project is the effort and resources required to achieve a significant business objective within a specific, usually finite, time frame. This resource is intended for view-only use cases.

Get a project that I can view: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}
Get all projects that I can view: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails

Project Plan Details/Project Calendars

The Project Calendars resource is used to view calendars used in a project which are single workday pattern and single shift. A calendar is used when scheduling a project plan. A project plan can use one project calendar as well as each labor resource can have a different calendar assigned.

Get a single shift project calendar: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/ProjectCalendars/{CalendarId}
Get all single shift project calendars used to schedule a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/ProjectCalendars

Project Plan Details/Project Calendars/Calendar Exceptions

The Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used for example to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.

Get a calendar exception: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/ProjectCalendars/{CalendarId}/child/CalendarExceptions/{ExceptionId}
Get all calendar exceptions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/ProjectCalendars/{CalendarId}/child/CalendarExceptions

Project Plan Details/Task Deliverables

The Task Deliverables resource is used to view the association of a deliverable with a project task. For example, a project task can have an association with a deliverable draft budget. You can have multiple deliverables associated with each task.

Get a deliverable for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}
Get all deliverables for all the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDeliverables

Project Plan Details/Task Deliverables/Attachments

The attachments resource is used to view, create, and update attachments.

Get all attachments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments
Get an attachment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}

Project Plan Details/Task Deliverables/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Plan Details/Task Deliverables/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Plan Details/Task Dependencies

The Task Dependency resource is used to view dependencies between two tasks in a project. For example, a task that has a Finish-to-start dependency with another task, can start only after the predecessor task is completed. You can have many dependencies for each task.

Get all dependencies between the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDependencies
Get one dependency between two tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskDependencies/{DependencyId}

Project Plan Details/Task Expense Resource Assignments

The Task Expenses resource assignment resource is used to view the assignment of an expense resource for a project task. For example, hotel expenses can be planned on a project task. You can have multiple expense resource assignments for each task.

Get all expense resource assignments for all the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskExpenseResourceAssignments
Get an expense resource assignment for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskExpenseResourceAssignments/{TaskExpenseResourceAssignmentId}

Project Plan Details/Task Labor Resource Assignments

The Task Labor resource assignments resource is used to view the assignment of a labor resource for a project task. For example, a Database Analyst can be assigned as a labor resource for a project task. You can have many labor resource assignments for each task.

Get a labor resource assignment for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskLaborResourceAssignments/{TaskLaborResourceAssignmentId}
Get all labor resource assignments for all the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskLaborResourceAssignments

Project Plan Details/Task Work Items

The Task Work Items resource is used to view and delete the association of a work item with a project task. You can also update the task completion criteria. Work items originate in Oracle Innovation Management, Oracle Product Development, and Oracle Sourcing. When the work item meets the completion criteria, your project task is automatically marked as complete.

Get a work item for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskWorkItems/{ObjectAssociationId}
Get all work items for all the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskWorkItems

Project Plan Details/Tasks

The Tasks resource is used to view project task details. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources. The resource always returns the rolled up values of all tasks as a task payload item with level 0.

Get a task of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/Tasks/{TaskId}
Get all tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/Tasks

Project Plan Details/Tasks/Gate Approvers

The Gate Approvers resource is used to view the approver details for a gate.

Get all the approvers of a gate in a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/Tasks/{TaskId}/child/GateApprovers
Get an approver of a gate in a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/Tasks/{TaskId}/child/GateApprovers/{ApprovalId}

Project Plan Details/Tasks/Task Descriptive Flexfields

The operations from the Project Plan Details/Tasks/Task Descriptive Flexfields category.

Get: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/Tasks/{TaskId}/child/TaskDFF/{ProjElementId}
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/Tasks/{TaskId}/child/TaskDFF

Project Plan Resource Requests

The Project Plan Resource Requests resource is used by a project manager to view, create, and manage project resource requests associated to his or her projects.

Approve project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/action/approveRequest
Cancel project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/action/cancelRequest
Create one or more project resource requests: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests
Delete a project resource request: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}
Get a project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}
Get all project resource requests: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests
Reject project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/action/rejectRequest
Update a project resource request: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}

Project Plan Resource Requests/Project Plan Resource Request Descriptive Flexfields

The Project Plan Resource Request Descriptive Flexfields resource is used by a project manager to view, create, and update descriptive flexfields associated to a project resource request.

Create one or more descriptive flexfields for a project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestDFF
Get a descriptive flexfield associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestDFF/{ProjectPlanResourceRequestDFFUniqID}
Get all descriptive flexfields associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestDFF
Update a descriptive flexfield for a project resource request: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestDFF/{ProjectPlanResourceRequestDFFUniqID}

Project Plan Resource Requests/Project Plan Resource Request Lines

The Project Plan Resource Request Lines resource is used by a project manager to view and update the status of nominated resources associated to the request.

Get a request line associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestLines/{RequestLineId}
Get all request lines associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestLines
Update a nominated resource on a project resource request: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestLines/{RequestLineId}

Project Plan Resource Requests/Project Plan Resource Request Qualifications

The Project Plan Resource Request Qualifications resource is used by a project manager to view, create, and manage project resource qualifications under a specific request.

Create one or more qualifications for a project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestQualifications
Delete a qualification for a project resource request: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestQualifications/{ResourceRequestDetailId}
Get a qualification associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestQualifications/{ResourceRequestDetailId}
Get all qualifications associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestQualifications

Project Plans

The Project Plans resource is used to view a project that you manage. A project is the effort and resources required to achieve a significant business objective within a specific, usually finite, time frame. For view-only or read-only access of the project plan to other users, please refer to the Project Plan Details REST service.

Get a project that I manage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}
Get all projects that I manage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans

Project Plans/Baselines

The Baselines resource is used to view, create, or update the baseline containing key planning information about tasks. Baseline information is usually compared against the current schedule of a project. You can create multiple baselines during the project lifecycle, but only one is the primary baseline. By default the first baseline created is your primary baseline.

Create a baseline: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Baselines
Delete a baseline: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Baselines/{BaselineId}
Get a baseline: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Baselines/{BaselineId}
Get all baselines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Baselines
Update a baseline: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Baselines/{BaselineId}

Project Plans/Project Calendars

Get a single shift project calendar: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectCalendars/{CalendarId}
Get all single shift project calendars used to schedule a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectCalendars

Project Plans/Project Calendars/Calendar Exceptions

Get a calendar exception: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectCalendars/{CalendarId}/child/CalendarExceptions/{ExceptionId}
Get all calendar exceptions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectCalendars/{CalendarId}/child/CalendarExceptions

Project Plans/Project Descriptive Flexfields

The Project Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a project.

Create descriptive flexfields for a project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectDFF
Get all the descriptive flexfields for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectDFF
Get all the descriptive flexfields for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectDFF/{ProjectId2}
Update the descriptive flexfields for a project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectDFF/{ProjectId2}

Project Plans/Task Deliverables

Get a deliverable for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}
Get all deliverables for all the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDeliverables

Project Plans/Task Deliverables/Attachments

The Attachments resource is used to view a deliverable attachment.

Get all attachments for a deliverable of the project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments
Get an attachment for a deliverable of the project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}

Project Plans/Task Deliverables/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Plans/Task Deliverables/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDeliverables/{TaskDeliverableAssociationId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Plans/Task Dependencies

The Task Dependency resource is used to view, create, or update dependencies between two tasks in a project. For example, a task that has a Finish-to-start dependency with another task, can start only after the predecessor task is completed. You can have many dependencies for each task.

Create a dependency between two tasks of a project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDependencies
Delete a task dependency: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDependencies/{DependencyId}
Get all dependencies between the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDependencies
Get one dependency between two tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDependencies/{DependencyId}
Update a dependency between two tasks of a project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskDependencies/{DependencyId}

Project Plans/Task Expense Resource Assignments

The Task Expenses resource assignment resource is used to view, create, or update the assignment of an expense resource for a project task. For example, hotel expenses can be planned on a project task. You can have multiple expense resource assignments for each task.

Create an expense resource assignment for a task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskExpenseResourceAssignments
Delete an expense resource assignment for a task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskExpenseResourceAssignments/{TaskExpenseResourceAssignmentId}
Get all expense resource assignments for all the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskExpenseResourceAssignments
Get an expense resource assignment for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskExpenseResourceAssignments/{TaskExpenseResourceAssignmentId}
Update an expense resource assignment for a task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskExpenseResourceAssignments/{TaskExpenseResourceAssignmentId}

Project Plans/Task Financial Actuals

The Task Financial Actuals resource is used to view the ITD actual effort and actual burdened cost for a project task.

Get all financial actual efforts and costs for all the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskFinancialActuals
Get financial actual efforts and costs for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskFinancialActuals/{TaskFinancialActualsUniqID}

Project Plans/Task Labor Resource Assignments

The Task Labor resource assignments resource is used to view, create, or update the assignment of a labor resource for a project task. For example, a Database Analyst can be assigned as a labor resource for a project task. You can have many labor resource assignments for each task.

Create a labor resource assignment for a task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskLaborResourceAssignments
Delete a labor resource assignment for a task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskLaborResourceAssignments/{TaskLaborResourceAssignmentId}
Get a labor resource assignment for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskLaborResourceAssignments/{TaskLaborResourceAssignmentId}
Get all labor resource assignments for all the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskLaborResourceAssignments
Update a labor resource assignment for a task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskLaborResourceAssignments/{TaskLaborResourceAssignmentId}

Project Plans/Task Work Items

Create a work item for a task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskWorkItems
Delete a work item for a task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskWorkItems/{ObjectAssociationId}
Get a work item for a task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskWorkItems/{ObjectAssociationId}
Get all work items for all the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskWorkItems
Update a work item for a task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskWorkItems/{ObjectAssociationId}

Project Plans/Tasks

The Tasks resource is used to create or update project tasks and view project task details. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources. The resource always returns the rolled up values of all tasks as a task payload item with level 0.

Create a task in a project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks
Delete a task of a project: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}
Get a task of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}
Get all tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks
Update a task in a project or update a project by creating tasks from a work plan template: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}

Project Plans/Tasks/Gate Approvers

The Gate Approvers resource is used to create a gate approver and to view and update approver details for a gate.

Create an approver for a gate in a project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/GateApprovers
Delete an approver of a gate in a project: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/GateApprovers/{ApprovalId}
Get all the approvers of a gate in a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/GateApprovers
Get an approver of a gate in a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/GateApprovers/{ApprovalId}
Update an approver of a gate in a project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/GateApprovers/{ApprovalId}

Project Plans/Tasks/StatusHistory

Get: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/StatusHistory/{projectPlans_Tasks_StatusHistory_Id}
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/StatusHistory

Project Plans/Tasks/Tasks Descriptive Flexfields

The Tasks Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a task.

Create descriptive flexfields for a task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/TaskDFF
Get all the descriptive flexfields for a task of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/TaskDFF/{ProjElementId}
Get all the descriptive flexfields for all of the tasks of a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/TaskDFF
Update descriptive flexfields for a task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/TaskDFF/{ProjElementId}

Project Process Configurators

The Project Process Configurators resource is used to view, create, update, and delete project process configurators.

Create a project process configurator: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators
Delete a project process configurator: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}
Get a project process configurator: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}
Get all project process configurators: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators
Update a project process configurator: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}

Project Process Configurators/Source Assignments

The Source Assignments resource is used to view, create, update a Source for a configurator.

Create sources for a configurator: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}/child/SourceAsgnmts
Get all sources for a configurator: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}/child/SourceAsgnmts
Get the source for a configurator: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}/child/SourceAsgnmts/{SourceAssignmentId}
Update the source for a configurator: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}/child/SourceAsgnmts/{SourceAssignmentId}

Project Program Communication Associations

Associations resource is used to manage the association of templates or reports to a business object like a program. A template is associated with a program to generate the corresponding report.

Get a report or template association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationAssociations/{projectProgramCommunicationAssociationsUniqID}
Get all report or template associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationAssociations
Update a report or template association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationAssociations/{projectProgramCommunicationAssociationsUniqID}

Project Program Communication Catalogs

Project Program Communication Catalogs resource is used to manage the catalog objects to create templates and reports.

Create a catalog object: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs
Delete a catalog object: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/{ObjectId}
Get a catalog object: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/{ObjectId}
Get all catalog objects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs
Update a catalog object: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationCatalogs/{ObjectId}

Project Program Communication Feedback

Project Program Communication Feedback resource is used to manage the comments on the reports.

Create comments for the reports for which the logged in user has edit access: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationFeedbacks
Delete comment for the reports for which the logged in user has edit access: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationFeedbacks/{projectProgramCommunicationFeedbacksUniqID}
Get a comment for the report for which the logged in user has access: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationFeedbacks/{projectProgramCommunicationFeedbacksUniqID}
Get all comments for the reports for which the logged in user has access: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationFeedbacks
Update comment for the reports for which the logged in user has edit access: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunicationFeedbacks/{projectProgramCommunicationFeedbacksUniqID}

Project Program Communications

Project Program Communication resource is used to manage the templates and reports header information.

Create a status report or template structure: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications
Delete a status report or template structure: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}
Download program BIP report: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/action/downloadBipReport
Get a status report or template structure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}
Get all status reports or templates structure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications
Update a status report or template structure: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}

Project Program Communications/Project Program Communication Associations

Associations resource is used to manage the association of templates or reports to a business object like a program. A template is associated with a program to generate the corresponding report.

Create a report or template association: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations
Delete a report or template association: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations/{AssociationsUniqID}
Get a report or template association: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations/{AssociationsUniqID}
Get all report or template associations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations
Update a report or template association: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations/{AssociationsUniqID}

Project Program Communications/Project Program Communication Associations/Project Program Communication Recipients

The Recipients resource is used to manage the persons with whom the report is shared.

Create a recipient of a report: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations/{AssociationsUniqID}/child/CommunicationRecipients
Delete a recipient of a report: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations/{AssociationsUniqID}/child/CommunicationRecipients/{ReportRecipientId}
Get a recipient of a report: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations/{AssociationsUniqID}/child/CommunicationRecipients/{ReportRecipientId}
Get all recipients of a report: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations/{AssociationsUniqID}/child/CommunicationRecipients
Update a recipient of a report: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Associations/{AssociationsUniqID}/child/CommunicationRecipients/{ReportRecipientId}

Project Program Communications/Project Program Communication Contents

The Contents resource is used to manage the data displayed in a generated report.

Create a status report or template content: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Contents
Delete a status report or template content: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Contents/{ObjectId}
Get a report or template content: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Contents/{ObjectId}
Get all status reports or template content: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Contents
Update a status report or template content: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Contents/{ObjectId}

Project Program Communications/Project Program Communication Feedback

Project Program Communication Feedback resource is used to manage the comments on the reports.

Create comments for the reports for which the logged in user has edit access: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Feedbacks
Delete comment for the reports for which the logged in user has edit access: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Feedbacks/{FeedbacksUniqID}
Get a comment for the report for which the logged in user has access: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Feedbacks/{FeedbacksUniqID}
Get all comments for the reports for which the logged in user has access: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Feedbacks
Update comment for the reports for which the logged in user has edit access: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Feedbacks/{FeedbacksUniqID}

Project Program Insights

The Project Program Insights resource is used to view various metrics for programs and the projects assigned to programs. A program is a collection of projects that are managed as a group to coordinate, monitor and implement a corporate strategy.

Get insights for a program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramInsights/{projectProgramInsightsUniqID}
Get insights for all programs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramInsights

Project Program Insights/Large Object (LOB) Attributes - Image

Get an Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramInsights/{projectProgramInsightsUniqID}/enclosure/Image

Project Program Insights/Large Object (LOB) Attributes - PersonImage

Get a PersonImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramInsights/{projectProgramInsightsUniqID}/enclosure/PersonImage

Project Program Insights/Program Descriptive Flexfields

The operations from the Project Program Insights/Program Descriptive Flexfields category.

Get: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramInsights/{projectProgramInsightsUniqID}/child/ProgramDFF/{ProjectProgramId}
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramInsights/{projectProgramInsightsUniqID}/child/ProgramDFF

Project Program Users

The Project Program Users resource is used to manage display preferences for users who define, coordinate, and monitor programs. Display preferences includes performance measures, watchlist, and currency. The resource is also used to retrieve the performance measures enabled for programs by your application administrator.

Get a project program user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}
Get all project program users: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramUsers
Manage views for program analysis: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/action/manageView
Reset user preferences: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/action/resetPreferences

Project Program Users/Person Name

The Program Preferences resource is used to manage your program management display preferences. Display preferences includes performance measures, watchlist, and currency. Replace the person ID in the REST API path with the value -1 to get performance measures enabled for programs by your application administrator.

Create a program preference: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/child/ProgramPreferences
Delete a program preference: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/child/ProgramPreferences/{PreferenceId}
Get a program preference: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/child/ProgramPreferences/{PreferenceId}
Get all program preferences: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/child/ProgramPreferences
Update a program preference: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/child/ProgramPreferences/{PreferenceId}

Project Programs

The Project Programs resource is used to manage project programs and the program hierarchical structure. A program is a collection of projects that are managed as a group to coordinate, monitor and implement a corporate strategy.

Create a program: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms
Delete a program: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}
Get a program: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}
Get all programs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms
Update a program: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}

Project Programs/Program Avatars

The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time.

Create an image: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatars
Delete an image: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatars/{ImageId}
Get all images: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatars
Get an image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatars/{ImageId}
Update an image: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatars/{ImageId}

Project Programs/Program Avatars/Large Object (LOB) Attributes - Image

Delete an Image: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatars/{ImageId}/enclosure/Image
Get an Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatars/{ImageId}/enclosure/Image
Replace an Image: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatars/{ImageId}/enclosure/Image

Project Programs/Program Descriptive Flexfields

The operations from the Project Programs/Program Descriptive Flexfields category.

Create: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramDFF
Get: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramDFF/{ProjectProgramId}
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramDFF
Update: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramDFF/{ProjectProgramId}

Project Programs/Program Notes

The Program Notes resource is used to manage notes for programs.

Create a program note: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes
Delete a program note: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes/{NoteId}
Get a program note: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes/{NoteId}
Get all program notes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes
Update a program note: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes/{NoteId}

Project Programs/Program Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes/{NoteId}/enclosure/NoteTxt

Project Programs/Project Assignments

The Project Assignments resource is used to manage the assignments of projects to a program.

Create a project assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects
Delete a project assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}
Get a project assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}
Get all project assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects

Project Programs/Project Assignments/Project Assignment Notes

The Project Assignment Notes resource is used to manage notes for the project assignments to a program.

Create a project assignment note: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}/child/ProgramProjectNotes
Delete a project assignment note: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}/child/ProgramProjectNotes/{NoteId}
Get a project assignment note: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}/child/ProgramProjectNotes/{NoteId}
Get all project assignment notes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}/child/ProgramProjectNotes
Update a project assignment note: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}/child/ProgramProjectNotes/{NoteId}

Project Programs/Project Assignments/Project Assignment Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}/child/ProgramProjectNotes/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}/child/ProgramProjectNotes/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects/{RelationshipId}/child/ProgramProjectNotes/{NoteId}/enclosure/NoteTxt

Project Programs/Stakeholders

The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program.

Create a stakeholder: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramStakeholders
Delete a stakeholder: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramStakeholders/{ProgramStakeholdersUniqID}
Get a stakeholder: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramStakeholders/{ProgramStakeholdersUniqID}
Get all stakeholders: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramStakeholders
Update a stakeholder: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramStakeholders/{ProgramStakeholdersUniqID}

Project Programs/Stakeholders/Large Object (LOB) Attributes - Image

Get an Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramStakeholders/{ProgramStakeholdersUniqID}/enclosure/Image

Project Progress

The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.

Capture project progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/action/captureProjectProgress
Delete the draft progress of the project: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}
Edit latest published progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/action/editLatestPublishedProgress
Edit the date associated with the draft project progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/action/reviseAsofDate
Get the progress of all projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress
Get the progress of the project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}
Publish Project Progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/action/publishProjectProgress
Refresh actual amounts on draft progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/action/refreshActualAmounts
Update the draft progress of the project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}

Project Progress/Attachments

The Attachment resource is used to view, create, update, and delete attachments for project progress.

Create an attachment for a progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Attachments
Delete an attachment for a progress: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Attachments/{AttachmentsUniqID}
Get all attachments for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Attachments
Get an attachment for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Attachments/{AttachmentsUniqID}
Update an attachment for a progress: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Attachments/{AttachmentsUniqID}

Project Progress/Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Progress/Attachments/Large Object (LOB) Attributes - File Web Image

The base64 encoded image of the file displayed in .png format if the source is a convertible image.

Get a File Web Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Progress/Notes

The Note resource is used to view, create, update, and delete notes for project progress.

Create a note for a progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Notes
Delete a note for a progress: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Notes/{NoteId}
Get a note for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Notes/{NoteId}
Get all notes for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Notes
Update a note for a progress: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Notes/{NoteId}

Project Progress/Notes/Large Object (LOB) Attributes - Note Text

The text for the progress note.

Delete a Note Text: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Notes/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Notes/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/Notes/{NoteId}/enclosure/NoteTxt

Project Progress/Project Progress Descriptive Flexfields

The Project Progress Descriptive Flexfields resource is used to view, create, and update additional information for project progress.

Create a project progress descriptive flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/ProjectProgressDFF
Get a project progress descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/ProjectProgressDFF/{ProjectProgressId}
Get all project progress descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/ProjectProgressDFF
Update a project progress descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/ProjectProgressDFF/{ProjectProgressId}

Project Progress/Task Progress

The Task Progress resource is used to capture, view, and update draft progress for the tasks of a project enabled for financial management.

Get the progress of a financial task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}
Get the progress of all financial tasks in the project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress
Update the progress of a financial task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}

Project Progress/Task Progress/Attachments

The Attachment resource is used to view, create, update, and delete attachments for task progress.

Create an attachment for a progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments
Delete an attachment for a progress: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments/{AttachmentsUniqID}
Get all attachments for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments
Get an attachment for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments/{AttachmentsUniqID}
Update an attachment for a progress: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments/{AttachmentsUniqID}

Project Progress/Task Progress/Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Progress/Task Progress/Attachments/Large Object (LOB) Attributes - File Web Image

The base64 encoded image of the file displayed in .png format if the source is a convertible image.

Get a File Web Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Progress/Task Progress/Notes

The Note resource is used to view, create, update, and delete notes for task progress.

Create a note for a progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Notes
Delete a note for a progress: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Notes/{NoteId}
Get a note for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Notes/{NoteId}
Get all notes for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Notes
Update a note for a progress: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Notes/{NoteId}

Project Progress/Task Progress/Notes/Large Object (LOB) Attributes - Note Text

The text for the progress note.

Delete a Note Text: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Notes/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Notes/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/Notes/{NoteId}/enclosure/NoteTxt

Project Progress/Task Progress/Resource Progress

The Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.

Get the progress of a resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}
Get the progress of all resources in the project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress
Update the progress of a resource: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}

Project Progress/Task Progress/Resource Progress/Attachments

The Attachment resource is used to view, create, update, and delete attachments for resource progress.

Create an attachment for a progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Attachments
Delete an attachment for a progress: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Attachments/{AttachmentsUniqID}
Get all attachments for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Attachments
Get an attachment for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Attachments/{AttachmentsUniqID}
Update an attachment for a progress: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Attachments/{AttachmentsUniqID}

Project Progress/Task Progress/Resource Progress/Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Project Progress/Task Progress/Resource Progress/Attachments/Large Object (LOB) Attributes - File Web Image

The base64 encoded image of the file displayed in .png format if the source is a convertible image.

Get a File Web Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Project Progress/Task Progress/Resource Progress/Notes

The Note resource is used to view, create, update, and delete notes for resource progress.

Create a note for a progress: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Notes
Delete a note for a progress: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Notes/{NoteId}
Get a note for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Notes/{NoteId}
Get all notes for a progress: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Notes
Update a note for a progress: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Notes/{NoteId}

Project Progress/Task Progress/Resource Progress/Notes/Large Object (LOB) Attributes - Note Text

The text for the progress note.

Delete a Note Text: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Notes/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Notes/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/Notes/{NoteId}/enclosure/NoteTxt

Project Progress/Task Progress/Resource Progress/Resource Progress Descriptive Flexfields

The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.

Create a resource progress descriptive flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/ResourceProgressDFF
Get a resource progress descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/ResourceProgressDFF/{ProjectProgressId}
Get all resource progress descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/ResourceProgressDFF
Update a resource progress descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}/child/ResourceProgressDFF/{ProjectProgressId}

Project Progress/Task Progress/Task Progress Descriptive Flexfields

The Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.

Create a task progress descriptive flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/TaskProgressDFF
Get a task progress descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/TaskProgressDFF/{ProjectProgressId}
Get all task progress descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/TaskProgressDFF
Update a task progress descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/TaskProgressDFF/{ProjectProgressId}

Project Resource Actual Hours

The Project Resource Actual Hours resource is used to view and create actual hours for a resource.

Create one or more project resource actual records.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceActualHours
Get a project resource actual hour record.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceActualHours/{TransactionId}
Get all project resource actual hour records.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceActualHours
Update a project resource actual hour record: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectResourceActualHours/{TransactionId}

Project Resource Assignment Daily Hours

The Project Resource Assignment Daily Hours resource is used to view and manage daily assignment hours for a resource.

Get a project resource assignment daily hour record.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignmentDailyHours/{AssignDailyHoursId}
Get all project resource assignment daily hour records.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignmentDailyHours
Update project resource assignment daily hours.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignmentDailyHours/action/updateAssignmentDailyHours
Validate adjusted project resource assignment daily hours schedules: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignmentDailyHours/action/validateForGanttDailyAssignmentAdjustment

Project Resource Assignments

The Project Resource Assignments resource is used to view, create, and manage project resource assignments.

Adjust project resource assignment schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/adjustAssignmentSchedule
Cancel project resource assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/cancelAssignment
Confirm a reserved project resource assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/confirmReservedAssignment
Create a project resource assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments
Get a project resource assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}
Get all project resource assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments
Replace existing resource with a different resource on a project resource assignment.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/replaceResource
Update a project resource assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}
Validate adjusted project resource assignment schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/cancelAssignmentAdjustment
Validate adjusted project resource assignment schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/validateForGanttAdjustment
Validate multiple adjusted project resource assignment schedules: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/action/validateForGanttMultiAdjustment
Validate new project resource assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/action/validateForGanttCreation

Project Resource Pools

The Project Resource Pools resource is used to view, create, and manage project resource pools.

Create one or more project resource pools.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools
Delete a project resource pool.: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}
Get a project resource pool.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}
Get all project resource pool.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools
Transfer resource pool memberships: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/action/transferResourcePoolMemberships
Update a project resource pool.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}

Project Resource Pools/Project Resource Pool Managers

The Project Resource Pool Managers resource is used to view, create, and delete project resource pool managers associated to a resource pool.

Create one or more project resource pool managers for a project resource pool.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/ProjectResourcePoolManagers
Delete a project resource pool manager for a project resource pool.: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/ProjectResourcePoolManagers/{PoolManagerId}
Get a project resource pool manager associated to a project resource pool.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/ProjectResourcePoolManagers/{PoolManagerId}
Get all project resource pool managers associated to a project resource pool.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/ProjectResourcePoolManagers

Project Resource Pools/Project Resource Pool Members

The Project Resource Pool Members resource is used to view, create, and update project resource pool members assigned to a resource pool.

Create one or more project resource pool members under a project resource pool.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/ProjectResourcePoolMembers
Get a project resource pool member assigned to a project resource pool.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/ProjectResourcePoolMembers/{ResourcePoolMembershipId}
Get all project resource pool members assigned to a project resource pool.: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/ProjectResourcePoolMembers
Update a project resource member assigned to a project resource pool.: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/ProjectResourcePoolMembers/{ResourcePoolMembershipId}

Project Resource Request Matches

The Project Resource Request Matches resource is used to search and get resources that match the specified project resource request criteria.

Get all resources that match the project resource request criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequestMatches
Not Applicable: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequestMatches/{projectResourceRequestMatchesUniqID}

Project Resource Requests

The Project Resource Requests resource is used to view, create, and manage project resource requests.

Approve project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/action/approveRequest
Cancel project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/action/cancelRequest
Create one or more project resource requests: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests
Delete a project resource request: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}
Get a project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}
Get all project resource requests: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests
Reject project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/action/rejectRequest
Update a project resource request: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}

Project Resource Requests/Project Resource Request Descriptive Flexfields

The Project Resource Request Descriptive Flexfields resource is used to view, create, and update descriptive flexfields associated to a project resource request.

Create one or more descriptive flexfields for a project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestDFF
Get a descriptive flexfield associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestDFF/{ProjectResourceRequestDFFUniqID}
Get all descriptive flexfields associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestDFF
Update a descriptive flexfield for a project resource request: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestDFF/{ProjectResourceRequestDFFUniqID}

Project Resource Requests/Project Resource Request Lines

The Project Resource Request Lines resource is used to view the status and details of all proposed or nominated resources associated to the request.

Create one or more nominated resources for a project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestLines
Get a request line associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestLines/{RequestLineId}
Get all request lines associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestLines
Update a nominated resource on a project resource request: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestLines/{RequestLineId}

Project Resource Requests/Project Resource Request Qualifications

The Project Resource Request Qualifications resource is used to view, create, and manage project resource qualifications under a specific request.

Create one or more qualifications for a project resource request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestQualifications
Delete a qualification for a project resource request: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestQualifications/{ResourceRequestDetailId}
Get a qualification associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestQualifications/{ResourceRequestDetailId}
Get all qualifications associated to the project resource request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}/child/ProjectResourceRequestQualifications

Project Templates

The Project Template resource is used to view and create a project template that is used for project creation.

Create a project template: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates
Get a project template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}
Get all project templates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates
Update a project template: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}

Project Templates/Project Classifications

The Project Classification resource is used to view and create a project classification. A project classification includes a class category and a class code, wherein the category is a broad subject within which you can classify projects, and the code is a specific value of the category.

Create a project classification: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectClassifications
Delete a project classification: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectClassifications/{ProjectClassificationId}
Get a project classification: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectClassifications/{ProjectClassificationId}
Get all classifications for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectClassifications
Update a project classification: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectClassifications/{ProjectClassificationId}

Project Templates/Project Customers

The Project Customer resource is used to view and create a project customer. This represents the name of the customer organization with whom the agreement has been made on the project.

Create a project customer: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectCustomers
Get a project customer: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectCustomers/{ProjectPartyId}
Get all customers for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectCustomers

Project Templates/Project Team Members

The Project Team Member resource is used to view and create a project team member. A project team member is a person who is assigned a role on a project.

Create a project team member: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTeamMembers
Delete a project team member: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTeamMembers/{TeamMemberId}
Get a project team member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTeamMembers/{TeamMemberId}
Get all team members for a project template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTeamMembers
Update a project team member: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTeamMembers/{TeamMemberId}

Project Templates/Project Transaction Controls

The Project Transaction Control resource is used to view and create a project transaction control. Project transaction controls are a set of criteria that control whether a transaction can be charged to a project.

Create a project transaction control: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTransactionControls
Get a project transaction control: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTransactionControls/{ProjectTransactionControlsUniqID}
Get all transaction controls for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTransactionControls

Project Templates/Provider Business Units

The project template resource is used to view, create, update, and delete provider business units. This includes viewing, creating, updating, and deleting provider business units that are from Project Portfolio Management and those imported from third-party applications. Provider Business Unit is a child of the Project Template.

Create a provider business unit for a project template: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProviderBusinessUnits
Delete a provider business unit for a project template: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProviderBusinessUnits/{BusinessUnitId}
Get a provider business unit for a project template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProviderBusinessUnits/{BusinessUnitId}
Get all provider business units for a project template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProviderBusinessUnits

Project Templates/Quick Entries

The Quick Entry resource is used to view and create a quick entry for a project template.

Create a quick entry: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/QuickEntries
Get a quick entry: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/QuickEntries/{QuickEntryId}
Get all quick entries for a project template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/QuickEntries

Project Templates/Setup Options

The Setup Option resource is used to view, create, and update a setup option for a project template.

Create a project template setup option: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/SetupOptions
Get a project template setup option: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/SetupOptions/{OptionCode}
Get all setup options for a project template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/SetupOptions
Update a project template setup option: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/SetupOptions/{OptionCode}

Project Templates/Tasks

The Task resource is used to view and create a project task. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources.

Create a project task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/Tasks
Delete a project task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/Tasks/{TaskId}
Get a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/Tasks/{TaskId}
Get all tasks for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/Tasks
Update a project task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/Tasks/{TaskId}

Project Templates/Tasks/Task Transaction Controls

The Task Transaction Control resource is used to view and create a task transaction control. Task transaction controls are a set of criteria that control whether a transaction can be charged to a task.

Create a task transaction control: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/Tasks/{TaskId}/child/TaskTransactionControls
Get a task transaction control: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/Tasks/{TaskId}/child/TaskTransactionControls/{TaskTransactionControlsUniqID}
Get all transaction controls for a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/Tasks/{TaskId}/child/TaskTransactionControls

Project and Task Cost Rate Overrides

The Project and Task Cost Rate Overrides resource is used to view, create, update, or delete the cost rate overrides defined for a project.

Create a Cost Rate Override: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides
Delete a Cost Rate Override detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides/{RateOverrideId}
Get a Cost Rate Override detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides/{RateOverrideId}
Get all Cost Rate Override details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides
Update a Cost Rate Override detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectandTaskCostRateOverrides/{RateOverrideId}

Projects

The Project resource is used to view, create, or modify a project. A project is the effort and resources required to achieve a significant business objective within a specific, usually finite, time frame.

Add tasks from work plan template to the project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/action/addTasksFromWorkplanTemplate
Create a project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects
Get a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}
Get all projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects
Update a project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}

Projects Users

The project user resource is used to retrieve attributes for a team member. A team member can have project tasks and to do tasks assigned for tracking and completion.

Create signed in project enterprise users: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers
Get a projects user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}
Get signed in projects users: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers

Projects Users/Chargeable Projects

The projects for which the projects user can report expenditures such as time.

Get a project for which the projects user can charge expenditures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ChargeableProjects/{ProjectId}
Get all the projects for which the projects user can charge expenditures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ChargeableProjects

Projects Users/Chargeable Tasks

The tasks for which the projects user can report expenditures such as time.

Get a task for which the projects user can charge expenditures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ChargeableFinancialTasks/{ChargeableFinancialTasksUniqID}
Get all the tasks for which the projects user can charge expenditures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ChargeableFinancialTasks

Projects Users/Followed Project Tasks

The followed project task resource is used to retrieve attributes for a project task that a project user follows.

Get all followed project tasks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/FollowedProjectTasks
Get project tasks followed by a user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/FollowedProjectTasks/{FollowedProjectTasksUniqID}

Projects Users/Followed To Do Tasks

The followed to do task resource is used to retrieve attributes for a to do task that a project user follows. To do Tasks may be followed by many project users.

Get all followed to do tasks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/FollowedToDoTasks
Get to do tasks followed by a user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/FollowedToDoTasks/{FollowedToDoTasksUniqID}

Projects Users/Project Tasks

The project task resource is used to store values while creating or updating project tasks. A task is a unit of project work assigned or performed as part of a resource's duties. Tasks may be a portion of project work to be performed within a defined period by a specific resource or multiple resources.

Get a project task assigned to the user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ProjectTasks/{ProjectTasksUniqID}
Get all project tasks assigned to the user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ProjectTasks
Update a project task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ProjectTasks/{ProjectTasksUniqID}

Projects Users/Project Tasks/Labor Resource Assignments

The labor resource assignment includes attributes used to store values while creating or updating labor resource assignments for a project task. For example, a DBA may be assigned as a labor resource for a project task.

Get a labor resource assignment of a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ProjectTasks/{ProjectTasksUniqID}/child/LaborResourceAssignments/{LaborResourceAssignmentsUniqID}
Get all labor resource assignments of a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ProjectTasks/{ProjectTasksUniqID}/child/LaborResourceAssignments

Projects Users/Project Tasks/Project Task Followers

The task follower resource is used to store values while adding or removing followers on project tasks. A project user can be assigned as a follower on a project task for viewing task details and tracking its completion.

Get a follower of a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ProjectTasks/{ProjectTasksUniqID}/child/TaskFollowers/{TaskFollowersUniqID}
Get all the followers of a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ProjectTasks/{ProjectTasksUniqID}/child/TaskFollowers

Projects Users/To Do Tasks

The to do task resource is used to store values while creating or updating to do tasks. A to do task is a unit of work assigned or performed as part of a resource's duties outside of any project. To do tasks may be performed within a defined period by a specific resource.

Create to do tasks for a user: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ToDoTasks
Delete a to do task of a user: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ToDoTasks/{ToDoTasksUniqID}
Get a to do task assigned to a user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ToDoTasks/{ToDoTasksUniqID}
Get all to do tasks assigned to a user: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ToDoTasks
Update a to do task of a user: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ToDoTasks/{ToDoTasksUniqID}

Projects Users/To Do Tasks/To Do Task Followers

The to do task follower resource is used to store values while adding or removing followers on to do tasks.

Get a task follower of a to do project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ToDoTasks/{ToDoTasksUniqID}/child/ToDoTaskFollowers/{ToDoTaskFollowersUniqID}
Get all the task followers of a to do project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ToDoTasks/{ToDoTasksUniqID}/child/ToDoTaskFollowers

Projects/Project Attachments

The Attachments resource is used to view, create, update and delete attachments to a project.

Create an attachment for a project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Attachments
Delete an attachment for a project: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Attachments/{AttachmentsUniqID}
Get all attachments for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Attachments
Get an attachment for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Attachments/{AttachmentsUniqID}
Update an attachment for a project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Attachments/{AttachmentsUniqID}

Projects/Project Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Projects/Project Attachments/Large Object (LOB) Attributes - File Web Image

The base64 encoded image of the file displayed in .png format if the source is a convertible image.

Get a File Web Image: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Projects/Project Classifications

The Project Classification resource is used to view, create, update, and delete a project classification. A project classification includes a class category and a class code, wherein the category is a broad subject within which you can classify projects, and the code is a specific value of the category.

Create a project classification: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectClassifications
Delete a project classification: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectClassifications/{ProjectClassificationId}
Get a project classification: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectClassifications/{ProjectClassificationId}
Get all classifications for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectClassifications
Update a project classification: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectClassifications/{ProjectClassificationId}

Projects/Project Customers

The Project Customers resource is used to view, create, and delete customers associated with those projects that are enabled for financial management. This applies only to those customers that are defined as parties as part of the project definition. This doesn't retrieve the customer information from a contract linked to the project.

Create a project customer: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectCustomers
Delete a project customer: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectCustomers/{ProjectPartyId}
Get a project customer: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectCustomers/{ProjectPartyId}
Get all customers for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectCustomers

Projects/Project Descriptive Flexfields

A listing of all the descriptive flexfields available for projects.

Create a project descriptive flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectDFF
Get a project descriptive flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectDFF/{ProjectId2}
Get all project descriptive flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectDFF
Update a project descriptive flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectDFF/{ProjectId2}

Projects/Project Opportunities

An object that includes attributes that are used to store values while creating or updating the opportunity details for a project. An opportunity is defined as a potential revenue-generating event.

Create a project opportunity: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectOpportunities
Get a project opportunity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectOpportunities/{OpportunityId}
Get all opportunities for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectOpportunities
Update a project opportunity: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectOpportunities/{OpportunityId}

Projects/Project Team Members

An object that includes attributes that are used to store values while creating or updating team members on a project. A project team member is a person who is assigned a role on a project.

Create a project team member: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTeamMembers
Delete a project team member: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTeamMembers/{TeamMemberId}
Get a project team member: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTeamMembers/{TeamMemberId}
Get all team members for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTeamMembers
Update a project team member: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTeamMembers/{TeamMemberId}

Projects/Project Transaction Controls

The Project Transaction Control resource is used to view, create, update, and delete a project transaction control. Project transaction controls are a set of criteria that control whether a transaction can be charged to a project.

Create a project transaction control: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTransactionControls
Delete a project transaction control: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTransactionControls/{ProjectTransactionControlsUniqID}
Get a project transaction control: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTransactionControls/{ProjectTransactionControlsUniqID}
Get all transaction controls for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTransactionControls
Update a project transaction control: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTransactionControls/{ProjectTransactionControlsUniqID}

Projects/ProviderBusinessUnits

This Project resource is used to view, create, update, and delete provider business units, regardless of whether they're from Project Portfolio Management or imported from third-party applications. The Provider Business Unit resource is a child of the Project resource.

Associate a provider business unit with this project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProviderBusinessUnits
Delete a provider business unit associated with this project: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProviderBusinessUnits/{BusinessUnitId}
Get a provider business unit associated with this project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProviderBusinessUnits/{BusinessUnitId}
Get all provider business units associated with this project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProviderBusinessUnits

Projects/Task Dependencies

The Task Dependencies resource is used to store values while creating or updating the schedule dependencies between tasks. For example, a task that has a finish-to-start dependency on another task can start only after the other task is completed.

Create a task dependency: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/TaskDependencies
Delete a task dependency: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/TaskDependencies/{DependencyId}
Get a task dependency: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/TaskDependencies/{DependencyId}
Get all task dependencies for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/TaskDependencies
Update a task dependency: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/TaskDependencies/{DependencyId}

Projects/Tasks

The Task resource includes the attributes that are used to store values while creating or updating project tasks. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources.

Create a project task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks
Delete a project task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}
Get a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}
Get all tasks for a project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks
Update a project task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}

Projects/Tasks/Expense Resource Assignments

An object that includes the attributes that are used to store values while creating or updating expense resource assignments for a project task. For example, hotel expenses can be planned on a project task.

Create an expense resource assignment for a project task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/ExpenseResourceAssignments
Delete an expense resource assignment for a project task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/ExpenseResourceAssignments/{ExpenseResourceAssignmentId}
Get all expense resource assignments for a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/ExpenseResourceAssignments
Get an expense resource assignment for a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/ExpenseResourceAssignments/{ExpenseResourceAssignmentId}
Update an expense resource assignment for a project task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/ExpenseResourceAssignments/{ExpenseResourceAssignmentId}

Projects/Tasks/Labor Resource Assignments

An object that includes the attributes that are used to store values while creating or updating labor resource assignments for a project task. For example, a DBA can be assigned as labor resource for a project task.

Create a labor resource assignment for a project task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/LaborResourceAssignments
Delete a labor resource assignment for a project task: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/LaborResourceAssignments/{LaborResourceAssignmentId}
Get a labor resource assignment for a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/LaborResourceAssignments/{LaborResourceAssignmentId}
Get all labor resource assignments for a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/LaborResourceAssignments
Update a labor resource assignment for a project task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/LaborResourceAssignments/{LaborResourceAssignmentId}

Projects/Tasks/Task Transaction Controls

The Task Transaction Control resource is used to view, create, update, and delete a task transaction control. Task transaction controls are a set of criteria that control whether a transaction can be charged to a task.

Create a task transaction control: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TaskTransactionControls
Delete a task transaction control: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TaskTransactionControls/{TaskTransactionControlsUniqID}
Get a task transaction control: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TaskTransactionControls/{TaskTransactionControlsUniqID}
Get all transaction controls for a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TaskTransactionControls
Update a task transaction control: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TaskTransactionControls/{TaskTransactionControlsUniqID}

Projects/Tasks/Tasks Descriptive Flexfields

The Tasks Descriptive Flexfields resource is used to view, create, and update additional information for project tasks.

Create a descriptive flexfield for a project task: Method: post
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TasksDFF
Get a descriptive flexfield for a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TasksDFF/{ProjElementId}
Get all descriptive flexfields for a project task: Method: get
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TasksDFF
Update a descriptive flexfield for a project task: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TasksDFF/{ProjElementId}

Rate Schedules

The Rate Schedules resource is used to view, create, or modify project rate schedules and schedule lines, for schedule types of Job, Person, Nonlabor and Resource Class. Use project rate schedules to calculate costs, bill, plan, budget, and forecast amounts.

Create a rate schedule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules
Delete a rate schedule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}
Get a rate schedule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}
Get all rate schedules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules
Update a Rate Schedule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}

Rate Schedules/Rate Schedule Descriptive Flexfields

The operations from the Rate Schedules/Rate Schedule Descriptive Flexfields category.

Create: Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/RateScheduleDFF
Get: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/RateScheduleDFF/{RateScheduleId2}
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/RateScheduleDFF
Update: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/RateScheduleDFF/{RateScheduleId2}

Rate Schedules/Rates

The operations from the Rate Schedules/Rates category.

Create: Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/Rates
Delete: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/Rates/{rateSchedules_Rates_Id}
Get: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/Rates/{rateSchedules_Rates_Id}
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/Rates
Update: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateSchedules/{RateScheduleId}/child/Rates/{rateSchedules_Rates_Id}

Requirements

The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.

Create requirements: Method: post
Path: /fscmRestApi/resources/11.13.18.05/requirements
Delete a requirement: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}
Get a requirement: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}
Get all requirements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements
Update a requirement: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}

Requirements/BacklogItems

The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.

Create backlog items: Method: post
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems
Delete a backlog item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems/{BacklogItemId}
Get a backlog item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems/{BacklogItemId}
Get all backlog items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems
Update a backlog item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems/{BacklogItemId}

Requirements/BacklogItems/AcceptanceCriterions

The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.

Create acceptance criteria: Method: post
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems/{BacklogItemId}/child/AcceptanceCriteria
Delete an acceptance criteria: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems/{BacklogItemId}/child/AcceptanceCriteria/{CriteriaId}
Get all acceptance criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems/{BacklogItemId}/child/AcceptanceCriteria
Get an acceptance criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems/{BacklogItemId}/child/AcceptanceCriteria/{CriteriaId}
Update an acceptance criteria: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems/{BacklogItemId}/child/AcceptanceCriteria/{CriteriaId}

Requirements/ChildRequirements

The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.

Create child requirements: Method: post
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements
Delete a child requirement: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}
Get a child requirement: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}
Get all child requirements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements
Update a child requirement: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}

Requirements/ChildRequirements/BacklogItems

The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.

Create backlog items: Method: post
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems
Delete a backlog item: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId}
Get a backlog item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId}
Get all backlog items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems
Update a backlog item: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId}

Requirements/ChildRequirements/BacklogItems/AcceptanceCriterions

The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.

Create acceptance criteria: Method: post
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId}/child/AcceptanceCriteria
Delete an acceptance criteria: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId2}/child/AcceptanceCriteria/{CriteriaId}
Get all acceptance criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId}/child/AcceptanceCriteria
Get an acceptance criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId2}/child/AcceptanceCriteria/{CriteriaId}
Update an acceptance criteria: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId2}/child/AcceptanceCriteria/{CriteriaId}

Requirements/ChildRequirements/ChildRequirements

The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.

Create child requirements: Method: post
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/ChildRequirements
Delete a child requirement: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/ChildRequirements/{RqmtId3}
Get a child requirement: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/ChildRequirements/{RqmtId3}
Get all child requirements: Method: get
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/ChildRequirements
Update a child requirement: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/ChildRequirements/{RqmtId3}

Resource Events

The Resource Events resource is used to view calendar events for a resource.

Create a resource calendar event: Method: post
Path: /fscmRestApi/resources/11.13.18.05/resourceEvents
Delete a resource calendar event: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/resourceEvents/{ResourceEventId}
Get a resource calendar event: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resourceEvents/{ResourceEventId}
Get all resource calendar events: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resourceEvents
Update a resource calendar event: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/resourceEvents/{ResourceEventId}

Resource Performance

The Resource Performance resource is used to view summarized data including costs, commitments, budgets, forecasts, revenue, and invoice amounts for a resource or resource breakdown structure that are assigned to a project or a group of projects.

Get performance data for a resource: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resourcePerformance/{resourcePerformanceUniqID}
Get performance data for all resources: Method: get
Path: /fscmRestApi/resources/11.13.18.05/resourcePerformance