REST API for Oracle Fusion Cloud Project Management

Create a project descriptive flexfield

post

/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectDFF

Request

Path Parameters

ProjectId(required): integer(int64)

Unique identifier of the project.

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Upsert-Mode:

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

__FLEX_Context: string

Title: Context Prompt

Maximum Length: 30

Context of the descriptive flexfield.
__FLEX_Context_DisplayValue: string

Title: Context Prompt

Context display value of the descriptive flexfield.
ProjectId: integer (int64)

Title: Project ID

Unique identifier of the project.

{
    "type":"object",
    "properties":{
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context display value of the descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":"30",
            "type":"string",
            "description":"Context of the descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : projects-ProjectDFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Prompt

Maximum Length: 30

Context of the descriptive flexfield.
__FLEX_Context_DisplayValue: string

Title: Context Prompt

Context display value of the descriptive flexfield.
links: array Links

Title: Links

The link relations associated with the resource instance.
ProjectId: integer (int64)

Title: Project ID

Unique identifier of the project.

{
    "type":"object",
    "properties":{
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context display value of the descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":"30",
            "type":"string",
            "description":"Context of the descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

LVVO_V___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

finder: ValidValuesFinder%3BBind_ApplicationId%3D10037%2CBind_DescriptiveFlexfieldCode%3DPJF_PROJECTS_DESC_FLEX

The following properties are defined on the LOV link relation:

Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
Display Attribute: Name, Description

LVVO___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

finder: ValidValuesFinder%3BBind_ApplicationId%3D10037%2CBind_DescriptiveFlexfieldCode%3DPJF_PROJECTS_DESC_FLEX

The list of valid descriptive flexfield contexts allowed for the selected descriptive flexfield.

The following properties are defined on the LOV link relation:

Source Attribute: __FLEX_Context; Target Attribute: ContextCode
Display Attribute: Name

Examples

The following example shows how to create a project descriptive flexfield by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json https://your_organization.com:port/fscmRestApi/resources/11.13.0.0/projects/300100180728436/child/ProjectDFF

Example of Request Body

The following example shows the request body to create a unified project along with global project descriptive flexfield segments.

{
"ProjectName": "sk_DFF_test_6",
"SourceTemplateName" : "T, Time and Materials",
"ProjectDFF":[{
"textBox":"sk_global_segment3",
"yesNo":"YES",
"__FLEX_Context":"Project Context1"
}]
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "AllowCrossChargeFlag": false,
  "AssetAllocationMethodCode": "N",
  "BurdenScheduleId": null,
  "BurdenScheduleFixedDate": null,
  "BurdenScheduleName": null,
  "BusinessUnitId": 204,
  "BusinessUnitName": null,
  "CapitalEventProcessingMethodCode": "N",
  "CIntRateSchName": null,
  "CIntStopDate": null,
  "CIntRateSchId": null,
  "CrossChargeLaborFlag": false,
  "CrossChargeNonLaborFlag": false,
  "CurrencyConvRateType": null,
  "CurrencyConvDateTypeCode": null,
  "CurrencyConvDate": null,
  "EnableBudgetaryControlFlag": false,
  "ExternalProjectId": null,
  "HoursPerDay": null,
  "IncludeNotesInKPINotificationsFlag": null,
  "KPINotificationEnabledFlag": null,
  "LaborTpFixedDate": null,
  "LaborTpSchedule": null,
  "LaborTpScheduleId": null,
  "LegalEntityId": 204,
  "LegalEntityName": "Vision Operations",
  "NlTransferPriceFixedDate": null,
  "NlTransferPriceSchedule": null,
  "NlTransferPriceScheduleId": null,
  "NumberAttr01": null,
  "NumberAttr02": null,
  "NumberAttr03": null,
  "NumberAttr04": null,
  "NumberAttr05": null,
  "NumberAttr06": null,
  "NumberAttr07": null,
  "NumberAttr08": null,
  "NumberAttr09": null,
  "NumberAttr10": null,
  "OwningOrganizationId": 204,
  "OwningOrganizationName": "Vision Operations",
  "PlanningProjectFlag": true,
  "ProjectCalendarId": 300100010293735,
  "ProjectCalendarName": null,
  "ProjectCode01": null,
  "ProjectCode02": null,
  "ProjectCode03": null,
  "ProjectCode04": null,
  "ProjectCode05": null,
  "ProjectCode06": null,
  "ProjectCode07": null,
  "ProjectCode08": null,
  "ProjectCode09": null,
  "ProjectCode10": null,
  "ProjectCode11": null,
  "ProjectCode12": null,
  "ProjectCode13": null,
  "ProjectCode14": null,
  "ProjectCode15": null,
  "ProjectCode16": null,
  "ProjectCode17": null,
  "ProjectCode18": null,
  "ProjectCode19": null,
  "ProjectCode20": null,
  "ProjectCode21": null,
  "ProjectCode22": null,
  "ProjectCode23": null,
  "ProjectCode24": null,
  "ProjectCode25": null,
  "ProjectCode26": null,
  "ProjectCode27": null,
  "ProjectCode28": null,
  "ProjectCode29": null,
  "ProjectCode30": null,
  "ProjectCode31": null,
  "ProjectCode32": null,
  "ProjectCode33": null,
  "ProjectCode34": null,
  "ProjectCode35": null,
  "ProjectCode36": null,
  "ProjectCode37": null,
  "ProjectCode38": null,
  "ProjectCode39": null,
  "ProjectCode40": null,
  "ProjectCurrencyCode": "USD",
  "ProjectDescription": "Template for billable time and materials projects",
  "ProjectEndDate": "2020-08-12",
  "ProjectId": 300100180728436,
  "ProjectManagerEmail": null,
  "ProjectManagerName": null,
  "ProjectManagerResourceId": null,
  "ProjectName": "sk_DFF_test_6",
  "ProjectNumber": "53020121254472",
  "ProjectPlanViewAccessCode": "ORA_PJT_PRJ_PLAN_VIEW_TEAM",
  "ProjectPriorityCode": "HIGH",
  "ProjectStartDate": "2019-08-14",
  "ProjectStatus": "Approved",
  "ProjectStatusCode": "APPROVED",
  "ProjectTypeId": 100000010065002,
  "ProjectTypeName": null,
  "ProjectUnitId": 100010023900163,
  "ProjectUnitName": null,
  "ScheduleTypeCode": "FIXED_EFFORT",
  "ServiceType": "Project Execution",
  "ServiceTypeCode": "EXECUTION",
  "SourceApplicationCode": "ORA_PROJECT_SERVICE",
  "SourceProjectReference": null,
  "SourceTemplateId": 100000010074004,
  "SourceTemplateName": "T, Time and Materials",
  "TextAttr01": null,
  "TextAttr02": null,
  "TextAttr03": null,
  "TextAttr04": null,
  "TextAttr05": null,
  "TextAttr06": null,
  "TextAttr07": null,
  "TextAttr08": null,
  "TextAttr09": null,
  "TextAttr10": null,
  "TextAttr11": null,
  "TextAttr12": null,
  "TextAttr13": null,
  "TextAttr14": null,
  "TextAttr15": null,
  "TextAttr16": null,
  "TextAttr17": null,
  "TextAttr18": null,
  "TextAttr19": null,
  "TextAttr20": null,
  "TransactionControlFlag": null,
  "WorkplanTemplateId": null,
  "WorkplanTemplateName": null,
  "WorkType": "Commercial Customer-billable",
  "WorkTypeId": 10020,
  "ProjectDFF": [
    {
      "ProjectId": 300100180728436,
      "textBox": "sk_global_segment3",
      "yesNo": "YES",
      "globalSegmentForProjectDffs": null,
      "mstrCntrctNbr": null,
      "__FLEX_Context": "Project Context1",
      "__FLEX_Context_DisplayValue": "Project Context1",
      "contextSensitiveSegment1": null,
      "links": [
        {
          "rel": "self",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectDFF/300100180728436",
          "name": "ProjectDFF",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
          }
        },
        {
          "rel": "canonical",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectDFF/300100180728436",
          "name": "ProjectDFF",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436",
          "name": "projects",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectDFF/300100180728436/lov/LVVO_yesNo",
          "name": "LVVO_yesNo",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectDFF/300100180728436/lov/LVVO___FLEX_Context",
          "name": "LVVO___FLEX_Context",
          "kind": "collection"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436",
      "name": "projects",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000067372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
      }
    },
    {
      "rel": "canonical",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436",
      "name": "projects",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/lov/ServiceTypes",
      "name": "ServiceTypes",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/lov/BurdenScheduleValidationVO1",
      "name": "BurdenScheduleValidationVO1",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/lov/WorkTypes",
      "name": "WorkTypes",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/lov/CapitalizedInterestRateSchedulePVO1",
      "name": "CapitalizedInterestRateSchedulePVO1",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/lov/ProjectOrganizationBuPuPVO1",
      "name": "ProjectOrganizationBuPuPVO1",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/lov/TransferPriceSchedules",
      "name": "TransferPriceSchedules",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectClassifications",
      "name": "ProjectClassifications",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectCustomers",
      "name": "ProjectCustomers",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectDFF",
      "name": "ProjectDFF",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectOpportunities",
      "name": "ProjectOpportunities",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectTeamMembers",
      "name": "ProjectTeamMembers",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/ProjectTransactionControls",
      "name": "ProjectTransactionControls",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/TaskDependencies",
      "name": "TaskDependencies",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/child/Tasks",
      "name": "Tasks",
      "kind": "collection"
    },
    {
      "rel": "action",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100180728436/action/addTasksFromWorkplanTemplate",
      "name": "addTasksFromWorkplanTemplate",
      "kind": "other"
    }
  ]
}