REST API for Oracle Fusion Cloud Project Management

Create a project customer

post

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

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

PartyId: integer (int64)

Title: Customer Party ID

Unique identifier of the project customer party. You must enter a value for this attribute, Customer Party Name or Customer Party Number but not more than one of these three attributes.
PartyName: string

Title: Customer Party Name

Maximum Length: 360

Unique number of a person or group of persons who constitute the project customer. You must enter a value for this attribute, Customer Party ID or Customer Party Name but not more than one of these three attributes.
PartyNumber: string

Title: Customer Party Number

Maximum Length: 30

Name of a person or group of persons who constitute the project customer. You must enter a value for this attribute, Customer Party ID or Customer Party Number but not more than one of these three attributes.

{
    "type":"object",
    "properties":{
        "PartyNumber":{
            "title":"Customer Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"Name of a person or group of persons who constitute the project customer. You must enter a value for this attribute, Customer Party ID or Customer Party Number but not more than one of these three attributes.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            }
        },
        "PartyName":{
            "title":"Customer Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"Unique number of a person or group of persons who constitute the project customer. You must enter a value for this attribute, Customer Party ID or Customer Party Name but not more than one of these three attributes.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            }
        },
        "PartyId":{
            "title":"Customer Party ID",
            "type":"integer",
            "description":"Unique identifier of the project customer party. You must enter a value for this attribute, Customer Party Name or Customer Party Number but not more than one of these three attributes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ProjectTemplateId",
                    "ProjectPartyId",
                    "ProjectPartyType"
                ]
            }
        }
    }
}

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-ProjectCustomers-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.
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.
PartyId: integer (int64)

Title: Customer Party ID

Unique identifier of the project customer party. You must enter a value for this attribute, Customer Party Name or Customer Party Number but not more than one of these three attributes.
PartyName: string

Title: Customer Party Name

Maximum Length: 360

Unique number of a person or group of persons who constitute the project customer. You must enter a value for this attribute, Customer Party ID or Customer Party Name but not more than one of these three attributes.
PartyNumber: string

Title: Customer Party Number

Maximum Length: 30

Name of a person or group of persons who constitute the project customer. You must enter a value for this attribute, Customer Party ID or Customer Party Number but not more than one of these three attributes.
ProjectPartyId: integer (int64)

Title: Project Party ID

Read Only: true

Unique identifier of the party assignment to the project.

{
    "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
        },
        "PartyNumber":{
            "title":"Customer Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"Name of a person or group of persons who constitute the project customer. You must enter a value for this attribute, Customer Party ID or Customer Party Number but not more than one of these three attributes.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            },
            "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
        },
        "PartyId":{
            "title":"Customer Party ID",
            "type":"integer",
            "description":"Unique identifier of the project customer party. You must enter a value for this attribute, Customer Party Name or Customer Party Number but not more than one of these three attributes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ProjectTemplateId",
                    "ProjectPartyId",
                    "ProjectPartyType"
                ]
            },
            "x-queryable":true
        },
        "ProjectPartyId":{
            "title":"Project Party ID",
            "type":"integer",
            "description":"Unique identifier of the party assignment to the project.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyName":{
            "title":"Customer Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"Unique number of a person or group of persons who constitute the project customer. You must enter a value for this attribute, Customer Party ID or Customer Party Name but not more than one of these three attributes.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            },
            "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 create a project customer 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": "AT99 Tower Construction at Santiago",
"ProjectTemplateNumber": "AT99 PROJ99",
"ProjectTemplateStartDate" : "2018-07-04",
"InitialProjectStatusCode" : "APPROVED",
"BusinessUnitId" : "204",
"LegalEntityId" : "204",
"OwningOrganizationId" : "204",
"ProjectTypeId" : "100000010065002",
"ProjectUnitId" : "100010023900163",
"WorkTypeId" : "10020",
"ProjectCustomers": [
{
"PartyName": "JENDOCO CONSTRUCTION CORP"
},
{
"PartyName": "Hilman and Associates"
}
]
}

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": "2018-07-04",
    "ProjectTemplateDescription": null,
    "ProjectTemplateEndDate": null,
    "ProjectTemplateId": 300100176473671,
    "ProjectTemplateName": "AT99 Tower Construction at Santiago",
    "ProjectTemplateNumber": "AT99 PROJ99",
    "ProjectTemplateStartDate": "2018-07-04",
    "ProjectTypeName": "Service Delivery ",
    "ProjectTypeId": 100000010065002,
    "ProjectUnitName": "Project Operations",
    "ProjectUnitId": 100010023900163,
    "ServiceType": null,
    "ServiceTypeCode": null,
    "SourceApplicationCode": "ORA_PROJECT_SERVICE",
    "SourceReference": null,
    "TransactionControlFlag": null,
    "WorkType": "Commercial Customer-billable",
    "WorkTypeId": 10020,
    "CreatedBy": "ABRAHAM.MASON",
    "CreationDate": "2019-03-20T09:48:09.001+00:00",
    "LastUpdatedBy": "ABRAHAM.MASON",
    "LastUpdateDate": "2019-03-20T09:48:11.800+00:00",
    "ProjectCustomers": [
        {
            "PartyId": 1604800,
            "PartyName": "JENDOCO CONSTRUCTION CORP",
            "PartyNumber": "1404723",
            "ProjectPartyId": 300100176473677,
            "CreatedBy": "ABRAHAM.MASON",
            "CreationDate": "2019-03-20T09:48:10.505+00:00",
            "LastUpdatedBy": "ABRAHAM.MASON",
            "LastUpdateDate": "2019-03-20T09:48:11.916+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectCustomers/300100176473677",
                    "name": "ProjectCustomers",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectCustomers/300100176473677",
                    "name": "ProjectCustomers",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671",
                    "name": "projectTemplates",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectCustomers/300100176473677/lov/Parties",
                    "name": "Parties",
                    "kind": "collection"
                }
            ]
        },
        {
            "PartyId": 1004,
            "PartyName": "Hilman and Associates",
            "PartyNumber": "1004",
            "ProjectPartyId": 300100176473678,
            "CreatedBy": "ABRAHAM.MASON",
            "CreationDate": "2019-03-20T09:48:11.011+00:00",
            "LastUpdatedBy": "ABRAHAM.MASON",
            "LastUpdateDate": "2019-03-20T09:48:12.245+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectCustomers/300100176473678",
                    "name": "ProjectCustomers",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectCustomers/300100176473678",
                    "name": "ProjectCustomers",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671",
                    "name": "projectTemplates",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectCustomers/300100176473678/lov/Parties",
                    "name": "Parties",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671",
            "name": "projectTemplates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671",
            "name": "projectTemplates",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/lov/ServiceTypes",
            "name": "ServiceTypes",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/lov/ProjectUnits",
            "name": "ProjectUnits",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/lov/LegalEntities",
            "name": "LegalEntities",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/lov/ProjectStatuses",
            "name": "ProjectStatuses",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/lov/OwningOrganizations",
            "name": "OwningOrganizations",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/lov/BusinessUnits",
            "name": "BusinessUnits",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/lov/WorkTypes",
            "name": "WorkTypes",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/lov/ProjectTypes",
            "name": "ProjectTypes",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/lov/TransferPriceSchedules",
            "name": "TransferPriceSchedules",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/SetupOptions",
            "name": "SetupOptions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectTeamMembers",
            "name": "ProjectTeamMembers",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/Tasks",
            "name": "Tasks",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectTransactionControls",
            "name": "ProjectTransactionControls",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectCustomers",
            "name": "ProjectCustomers",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/QuickEntries",
            "name": "QuickEntries",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473671/child/ProjectClassifications",
            "name": "ProjectClassifications",
            "kind": "collection"
        }
    ]
}