REST API for Oracle Fusion Cloud Project Management

Create a project team member

post

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

Request

Path Parameters

ProjectId(required): integer(int64)

Unique identifier of the project.

Header Parameters

Metadata-Context: string

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: string

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: string

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

AssignmentType: string

Title: Assignment Type

Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.
AssignmentTypeCode: string

Title: Assignment Type Code

Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.
BillablePercent: string

Title: Billable Percent

Indicates the percentage of assignment time that is billable for an assignment that is defined as billable assignment. For a non-billable assignment, the value is ignored. Valid values are positive integers between 0 and 100.
BillablePercentReason: string

Title: Billable Percent Reason

Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored.
BillablePercentReasonCode: string

Title: Billable Percent Reason Code

Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored.
FinishDate: string (date)

Title: Team Member End Date

Date on which the assignment of the project team member to the project is scheduled to end.
PersonEmail: string

Title: Team Member Email

Maximum Length: 240

Email of the person assigned as a team member to the project.
PersonId: integer (int64)

Title: Person ID

Unique identifier of the person assigned as a team member to the project.
PersonName: string

Title: Team Member Name

Maximum Length: 240

Name of the person assigned as a team member to the project.
ProjectId: integer (int64)

Title: Project ID

Unique identifier of the project.
ProjectRole: string

Title: Project Role

Maximum Length: 240

A classification of the relationship that an employee has to a project. You use project roles to define an employee's level of access to project information. Examples are Project Manager, Project Accountant, and Technical Lead.
ResourceAllocationPercentage: number

Title: Resource Allocation Percentage

Percentage of time for which a resource is assigned to the project. The default value is 100.
ResourceAssignmentEffortInHours: number

Title: Resource Assignment Effort in Hours

Number of hours for which a resource is assigned to the project.
ResourcePlanningBillRate: number

Title: Resource Planning Bill Rate

Bill Rate of the resource assignment for the planning purpose. If no value is specified, Bill Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency.
ResourcePlanningCostRate: number

Title: Resource Planning Cost Rate

Cost Rate of the resource assignment for the planning purpose. If no value is specified, Cost Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency.
StartDate: string (date)

Title: Team Member Start Date

Date from which the assignment of the team member to the project is scheduled to begin.
TrackTimeFlag: boolean

Title: Track Time

Maximum Length: 255

Indicates whether time cards are expected from internal team members. Valid values are true and false. The default value is false. Information about missing time cards is displayed on the project manager dashboard.

{
    "type":"object",
    "properties":{
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.",
            "nullable":true
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type Code",
            "type":"string",
            "description":"Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.",
            "nullable":true
        },
        "BillablePercent":{
            "title":"Billable Percent",
            "type":"string",
            "description":"Indicates the percentage of assignment time that is billable for an assignment that is defined as billable assignment. For a non-billable assignment, the value is ignored. Valid values are positive integers between 0 and 100.",
            "nullable":true
        },
        "BillablePercentReason":{
            "title":"Billable Percent Reason",
            "type":"string",
            "description":"Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored.",
            "nullable":true
        },
        "BillablePercentReasonCode":{
            "title":"Billable Percent Reason Code",
            "type":"string",
            "description":"Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored.",
            "nullable":true
        },
        "FinishDate":{
            "title":"Team Member End Date",
            "type":"string",
            "description":"Date on which the assignment of the project team member to the project is scheduled to end.",
            "format":"date",
            "nullable":true
        },
        "PersonEmail":{
            "title":"Team Member Email",
            "maxLength":240,
            "type":"string",
            "description":"Email of the person assigned as a team member to the project.",
            "nullable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person assigned as a team member to the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PersonName":{
            "title":"Team Member Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the person assigned as a team member to the project.",
            "nullable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProjectRole":{
            "title":"Project Role",
            "maxLength":240,
            "type":"string",
            "description":"A classification of the relationship that an employee has to a project. You use project roles to define an employee's level of access to project information. Examples are Project Manager, Project Accountant, and Technical Lead.",
            "nullable":true
        },
        "ResourceAllocationPercentage":{
            "title":"Resource Allocation Percentage",
            "type":"number",
            "description":"Percentage of time for which a resource is assigned to the project. The default value is 100.",
            "nullable":true
        },
        "ResourceAssignmentEffortInHours":{
            "title":"Resource Assignment Effort in Hours",
            "type":"number",
            "description":"Number of hours for which a resource is assigned to the project.",
            "nullable":true
        },
        "ResourcePlanningBillRate":{
            "title":"Resource Planning Bill Rate",
            "type":"number",
            "description":"Bill Rate of the resource assignment for the planning purpose. If no value is specified, Bill Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency.",
            "nullable":true
        },
        "ResourcePlanningCostRate":{
            "title":"Resource Planning Cost Rate",
            "type":"number",
            "description":"Cost Rate of the resource assignment for the planning purpose. If no value is specified, Cost Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency.",
            "nullable":true
        },
        "StartDate":{
            "title":"Team Member Start Date",
            "type":"string",
            "description":"Date from which the assignment of the team member to the project is scheduled to begin.",
            "format":"date",
            "nullable":true
        },
        "TrackTimeFlag":{
            "title":"Track Time",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether time cards are expected from internal team members. Valid values are true and false. The default value is false. Information about missing time cards is displayed on the project manager dashboard.",
            "nullable":true
        }
    }
}

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-ProjectTeamMembers-item-response

Type: object

Show Source

AssignmentType: string

Title: Assignment Type

Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.
AssignmentTypeCode: string

Title: Assignment Type Code

Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.
BillablePercent: string

Title: Billable Percent

Indicates the percentage of assignment time that is billable for an assignment that is defined as billable assignment. For a non-billable assignment, the value is ignored. Valid values are positive integers between 0 and 100.
BillablePercentReason: string

Title: Billable Percent Reason

Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored.
BillablePercentReasonCode: string

Title: Billable Percent Reason Code

Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored.
FinishDate: string (date)

Title: Team Member End Date

Date on which the assignment of the project team member to the project is scheduled to end.
links: array Links

Title: Links

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

Title: Team Member Email

Maximum Length: 240

Email of the person assigned as a team member to the project.
PersonId: integer (int64)

Title: Person ID

Unique identifier of the person assigned as a team member to the project.
PersonName: string

Title: Team Member Name

Maximum Length: 240

Name of the person assigned as a team member to the project.
ProjectId: integer (int64)

Title: Project ID

Unique identifier of the project.
ProjectRole: string

Title: Project Role

Maximum Length: 240

A classification of the relationship that an employee has to a project. You use project roles to define an employee's level of access to project information. Examples are Project Manager, Project Accountant, and Technical Lead.
ResourceAllocationPercentage: number

Title: Resource Allocation Percentage

Percentage of time for which a resource is assigned to the project. The default value is 100.
ResourceAssignmentEffortInHours: number

Title: Resource Assignment Effort in Hours

Number of hours for which a resource is assigned to the project.
ResourcePlanningBillRate: number

Title: Resource Planning Bill Rate

Bill Rate of the resource assignment for the planning purpose. If no value is specified, Bill Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency.
ResourcePlanningCostRate: number

Title: Resource Planning Cost Rate

Cost Rate of the resource assignment for the planning purpose. If no value is specified, Cost Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency.
StartDate: string (date)

Title: Team Member Start Date

Date from which the assignment of the team member to the project is scheduled to begin.
TeamMemberId: integer (int64)

Title: Team Member ID

Read Only: true

Unique identifier of the team member assigned to the project.
TrackTimeFlag: boolean

Title: Track Time

Maximum Length: 255

Indicates whether time cards are expected from internal team members. Valid values are true and false. The default value is false. Information about missing time cards is displayed on the project manager dashboard.

{
    "type":"object",
    "properties":{
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type Code",
            "type":"string",
            "description":"Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.",
            "nullable":true,
            "x-queryable":true
        },
        "BillablePercent":{
            "title":"Billable Percent",
            "type":"string",
            "description":"Indicates the percentage of assignment time that is billable for an assignment that is defined as billable assignment. For a non-billable assignment, the value is ignored. Valid values are positive integers between 0 and 100.",
            "nullable":true,
            "x-queryable":true
        },
        "BillablePercentReason":{
            "title":"Billable Percent Reason",
            "type":"string",
            "description":"Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored.",
            "nullable":true,
            "x-queryable":true
        },
        "BillablePercentReasonCode":{
            "title":"Billable Percent Reason Code",
            "type":"string",
            "description":"Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a non-billable assignment, the value is ignored.",
            "nullable":true,
            "x-queryable":true
        },
        "FinishDate":{
            "title":"Team Member End Date",
            "type":"string",
            "description":"Date on which the assignment of the project team member to the project is scheduled to end.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PersonEmail":{
            "title":"Team Member Email",
            "maxLength":240,
            "type":"string",
            "description":"Email of the person assigned as a team member to the project.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person assigned as a team member to the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Team Member Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the person assigned as a team member to the project.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectRole":{
            "title":"Project Role",
            "maxLength":240,
            "type":"string",
            "description":"A classification of the relationship that an employee has to a project. You use project roles to define an employee's level of access to project information. Examples are Project Manager, Project Accountant, and Technical Lead.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceAllocationPercentage":{
            "title":"Resource Allocation Percentage",
            "type":"number",
            "description":"Percentage of time for which a resource is assigned to the project. The default value is 100.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceAssignmentEffortInHours":{
            "title":"Resource Assignment Effort in Hours",
            "type":"number",
            "description":"Number of hours for which a resource is assigned to the project.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourcePlanningBillRate":{
            "title":"Resource Planning Bill Rate",
            "type":"number",
            "description":"Bill Rate of the resource assignment for the planning purpose. If no value is specified, Bill Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourcePlanningCostRate":{
            "title":"Resource Planning Cost Rate",
            "type":"number",
            "description":"Cost Rate of the resource assignment for the planning purpose. If no value is specified, Cost Rate of the resource defined in Project Enterprise Resource is used if it is available in the project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Team Member Start Date",
            "type":"string",
            "description":"Date from which the assignment of the team member to the project is scheduled to begin.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TeamMemberId":{
            "title":"Team Member ID",
            "type":"integer",
            "description":"Unique identifier of the team member assigned to the project.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TrackTimeFlag":{
            "title":"Track Time",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether time cards are expected from internal team members. Valid values are true and false. The default value is false. Information about missing time cards is displayed on the project manager dashboard.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Example 1

The following example shows how to create a project team member 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.0.0/projects/300100072576989/child/ProjectTeamMembers

Example 1 Request Body

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

{
  "PersonEmail" : "prj_wf_notifications_in_grp@oracle.com",
  "ProjectRole" : "Project Team Member",
  "StartDate" : "2015-02-11"
}

Example 1 Response Body

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

{
  "FinishDate": null
  "PersonEmail": " prj_wf_notifications_in_grp@oracle.com"
  "PersonName": "Charles Smith"
  "ProjectId": 300100072576989
  "ProjectRole": "Project Team Member"
  "StartDate": "2015-02-11"
  "TeamMemberId": 300100072711289
  -"links": [3]
  -0:  {
    "rel": "self"
    ...
       }
}

Example 2

The following example shows how to create project team members by submitting a BATCH operation on the REST resource using cURL.

curl --user ppm_cloud_user -X  POST -d @sample_batch_prjtm_payload.json --header "Content-Type: application/vnd.oracle.adf.batch+json" https://your_organization.com:port/fscmRestApi/resources/

Example 2 Request Body

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

{
 "parts": [{
  "id": "part1",
  "path": "/11.13.18.05/projects/300100186320487/child/ProjectTeamMembers",
  "operation": "create",
  "payload":
{
"PersonName":"Abraham Mason",
"ProjectRole":"Project Manager",
"StartDate" :"2020-08-08",
"TrackTimeFlag":true
}
 }, {
  "id": "part2",
  "path": "/11.13.18.05/projects/300100186320505/child/ProjectTeamMembers",
  "operation": "create",
  "payload":
{
"PersonId":"53",
"ProjectRole":"Project Manager",
"StartDate" :"2020-08-08",
"TrackTimeFlag":true
}
 }
 ]
}

Example 2 Response Body

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

{"parts":[{"id":"part1","path":"https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100186320487/child/ProjectTeamMembers","operation":"create","payload" : {
  "FinishDate" : null,
  "PersonEmail" : "prj_wf_in_grp@oracle.com",
  "PersonName" : "Abraham Mason",
  "ProjectId" : 300100186320487,
  "ProjectRole" : "Project Manager",
  "StartDate" : "2020-08-08",
  "TeamMemberId" : 300100186320529,
  "PersonId" : 100010032550827,
  "TrackTimeFlag" : true,
  "ResourcePlanningCostRate" : null,
  "ResourceAllocationPercentage" : null,
  "ResourceAssignmentEffortInHours" : null,
  "ResourcePlanningBillRate" : null,
  "AssignmentType" : null,
  "BillablePercentReason" : null,
  "AssignmentTypeCode" : null,
  "BillablePercentReasonCode" : null,
  "BillablePercent" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100186320487/child/ProjectTeamMembers/300100186320529",
    "name" : "ProjectTeamMembers",
    "kind" : "item"
  }, {
    "rel" : "canonical",
    "href" : "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100186320487/child/ProjectTeamMembers/300100186320529",
    "name" : "ProjectTeamMembers",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100186320487",
    "name" : "projects",
    "kind" : "item"
  } ]
}
}, {
"id" : "part2",
"path" : "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100186320505/child/ProjectTeamMembers",
"operation" : "create",
"payload" : {
  "FinishDate" : null,
  "PersonEmail" : "sendmail-test-discard@oracle.com",
  "PersonName" : "Amy Marlin",
  "ProjectId" : 300100186320505,
  "ProjectRole" : "Project Manager",
  "StartDate" : "2020-08-08",
  "TeamMemberId" : 300100186320531,
  "PersonId" : 53,
  "TrackTimeFlag" : true,
  "ResourcePlanningCostRate" : null,
  "ResourceAllocationPercentage" : null,
  "ResourceAssignmentEffortInHours" : null,
  "ResourcePlanningBillRate" : null,
  "AssignmentType" : null,
  "BillablePercentReason" : null,
  "AssignmentTypeCode" : null,
  "BillablePercentReasonCode" : null,
  "BillablePercent" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100186320505/child/ProjectTeamMembers/300100186320531",
    "name" : "ProjectTeamMembers",
    "kind" : "item"
  }, {
    "rel" : "canonical",
    "href" : "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100186320505/child/ProjectTeamMembers/300100186320531",
    "name" : "ProjectTeamMembers",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projects/300100186320505",
    "name" : "projects",
    "kind" : "item"
  } ]
}
}
]}