REST API for Oracle Fusion Cloud Project Management

Create a project template setup option

post

/fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/SetupOptions

Request

Path Parameters

projectTemplatesUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Project Templates resource and used to uniquely identify an instance of Project Templates. The client should not generate the hash key value. Instead, the client should query on the Project Templates collection resource in order to navigate to a specific instance of Project Templates to get the hash key.

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

DisplayFlag: boolean

Title: Display

Maximum Length: 1

Indicates whether the setup option will be displayed for the projects created using the project template. Valid values are true and false.
OptionCode: string

Title: Option Code

Maximum Length: 30

Code of the setup option. Valid values are lookup codes for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option but not both.
OptionName: string

Title: Option

Maximum Length: 80

Name of the setup option. Valid values are lookup meanings for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option Code but not both.

{
    "type":"object",
    "properties":{
        "OptionCode":{
            "title":"Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the setup option. Valid values are lookup codes for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option but not both.",
            "nullable":false
        },
        "DisplayFlag":{
            "title":"Display",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the setup option will be displayed for the projects created using the project template. Valid values are true and false.",
            "nullable":true
        },
        "OptionName":{
            "title":"Option",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the setup option. Valid values are lookup meanings for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option Code but not both.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : projectTemplates-SetupOptions-item-response

Type: object

Show Source

CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the record was created.
DisplayFlag: boolean

Title: Display

Maximum Length: 1

Indicates whether the setup option will be displayed for the projects created using the project template. Valid values are true and false.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date when the record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
OptionCode: string

Title: Option Code

Maximum Length: 30

Code of the setup option. Valid values are lookup codes for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option but not both.
OptionName: string

Title: Option

Maximum Length: 80

Name of the setup option. Valid values are lookup meanings for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option Code but not both.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OptionCode":{
            "title":"Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the setup option. Valid values are lookup codes for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option but not both.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayFlag":{
            "title":"Display",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the setup option will be displayed for the projects created using the project template. Valid values are true and false.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionName":{
            "title":"Option",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the setup option. Valid values are lookup meanings for the lookup type PJF_OPTIONS_SS. Enter a value for either this attribute or Option Code but not both.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Examples

The following example shows how to createa project template setup option by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates

Request Body Example

The following shows an example of the request body in JSON format.

{
"ProjectTemplateName" : "Demo Template Name",
"ProjectTemplateNumber" : "Demo Template Number",
"InitialProjectStatusCode" : "APPROVED",
"BusinessUnitId" : "204",
"LegalEntityId" : "204",
"OwningOrganizationId" : "204",
"ProjectTypeId" : "100000010065002",
"ProjectUnitId" : "100010023900163",
"SetupOptions" : [
{
"DisplayFlag": true,
"OptionCode": "TEAM_MEMBERS"
}
]
}

Response Body Example

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

{
    "AllowCrossChargeFlag": false,
    "BusinessUnitName": "Vision Operations",
    "BusinessUnitId": 204,
    "CrossChargeLaborFlag": false,
    "CrossChargeNonLaborFlag": false,
    "EnableBudgetaryControlFlag": false,
    "InitialProjectStatus": "Approved",
    "InitialProjectStatusCode": "APPROVED",
    "LaborTpFixedDate": null,
    "LaborTpSchedule": null,
    "LaborTpScheduleId": null,
    "LegalEntityName": "Vision Operations",
    "LegalEntityId": 204,
    "NlTransferPriceFixedDate": null,
    "NlTransferPriceSchedule": null,
    "NlTransferPriceScheduleId": null,
    "OwningOrganizationName": "Vision Operations",
    "OwningOrganizationId": 204,
    "ProjectCurrencyCode": "USD",
    "ProjectEndDate": null,
    "ProjectPriorityCode": null,
    "ProjectStartDate": "2019-03-20",
    "ProjectTemplateDescription": null,
    "ProjectTemplateEndDate": null,
    "ProjectTemplateId": 300100176473774,
    "ProjectTemplateName": "Demo Template Name",
    "ProjectTemplateNumber": "Demo Template Number",
    "ProjectTemplateStartDate": null,
    "ProjectTypeName": "Service Delivery ",
    "ProjectTypeId": 100000010065002,
    "ProjectUnitName": "Project Operations",
    "ProjectUnitId": 100010023900163,
    "ServiceType": null,
    "ServiceTypeCode": null,
    "SourceApplicationCode": "ORA_PROJECT_SERVICE",
    "SourceReference": null,
    "TransactionControlFlag": null,
    "WorkType": null,
    "WorkTypeId": null,
    "CreatedBy": "ABRAHAM.MASON",
    "CreationDate": "2019-03-20T10:27:27.001+00:00",
    "LastUpdatedBy": "ABRAHAM.MASON",
    "LastUpdateDate": "2019-03-20T10:27:27.921+00:00",
    "SetupOptions": [
        {
            "DisplayFlag": true,
            "OptionCode": "TEAM_MEMBERS",
            "OptionName": "Team Members",
            "CreatedBy": "ABRAHAM.MASON",
            "CreationDate": "2019-03-20T10:27:27.546+00:00",
            "LastUpdatedBy": "ABRAHAM.MASON",
            "LastUpdateDate": "2019-03-20T10:27:27.684+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/SetupOptions/TEAM_MEMBERS",
                    "name": "SetupOptions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/SetupOptions/TEAM_MEMBERS",
                    "name": "SetupOptions",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774",
                    "name": "projectTemplates",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/SetupOptions/TEAM_MEMBERS/lov/OptionNames",
                    "name": "OptionNames",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774",
            "name": "projectTemplates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774",
            "name": "projectTemplates",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/lov/ServiceTypes",
            "name": "ServiceTypes",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/lov/ProjectUnits",
            "name": "ProjectUnits",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/lov/LegalEntities",
            "name": "LegalEntities",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/lov/ProjectStatuses",
            "name": "ProjectStatuses",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/lov/OwningOrganizations",
            "name": "OwningOrganizations",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/lov/BusinessUnits",
            "name": "BusinessUnits",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/lov/WorkTypes",
            "name": "WorkTypes",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/lov/ProjectTypes",
            "name": "ProjectTypes",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/lov/TransferPriceSchedules",
            "name": "TransferPriceSchedules",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/SetupOptions",
            "name": "SetupOptions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/ProjectTeamMembers",
            "name": "ProjectTeamMembers",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/Tasks",
            "name": "Tasks",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/ProjectTransactionControls",
            "name": "ProjectTransactionControls",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/ProjectCustomers",
            "name": "ProjectCustomers",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/QuickEntries",
            "name": "QuickEntries",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473774/child/ProjectClassifications",
            "name": "ProjectClassifications",
            "kind": "collection"
        }
    ]
}