Create a project team member
post
/fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTeamMembers
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:
Show Source
object
-
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
Maximum Length:30
Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. -
BillablePercent: integer
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
Maximum Length:30
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)
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. -
ProjectRoleId: integer
(int64)
Title:
Project Role ID
Unique identifier of the project role. -
ProjectRoleName: string
Title:
Project Role Name
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, then the bill rate of the resource defined in the 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)
Date from which the assignment of the team member to the project is scheduled to begin.
-
TrackTimeFlag: boolean
Maximum Length:
1
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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-ProjectTeamMembers-item-response
Type:
Show Source
object
-
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
Maximum Length:30
Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank. -
BillablePercent: integer
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
Maximum Length:30
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. -
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. -
FinishDate: string
(date)
Date on which the assignment of the project team member to the project is scheduled to end.
-
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. -
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. -
ProjectRoleId: integer
(int64)
Title:
Project Role ID
Unique identifier of the project role. -
ProjectRoleName: string
Title:
Project Role Name
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, then the bill rate of the resource defined in the 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)
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
Maximum Length:
1
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
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.18.05/projectTemplates
Request Body Example
The following shows an example of the request body in JSON format.
{ "ProjectTemplateName" : "PrjTemplate_2055", "ProjectTemplateNumber" : "PrjTemplate_2055", "ProjectTemplateStartDate" : "2018-07-04", "InitialProjectStatusCode" : "APPROVED", "BusinessUnitId" : "204", "LegalEntityId" : "204", "OwningOrganizationId" : "204", "ProjectTypeId" : "100000010065002", "ProjectUnitId" : "100010023900163", "WorkTypeId" : "10020", "ProjectTeamMembers": [ { "PersonId":"53", "ProjectRoleId":1, "StartDate" :"2018-01-01", "FinishDate":"2019-01-01", "TrackTimeFlag":true } ] }
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": 300100176473683, "ProjectTemplateName": "PrjTemplate_2055", "ProjectTemplateNumber": "PrjTemplate_2055", "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:54:14.002+00:00", "LastUpdatedBy": "ABRAHAM.MASON", "LastUpdateDate": "2019-03-20T09:54:14.788+00:00", "ProjectTeamMembers": [ { "FinishDate": "2019-01-01", "PersonEmail": null, "PersonId": 53, "PersonName": "Marlin, Amy", "ProjectRoleId": 1, "ProjectRoleName": "Project Manager", "StartDate": "2018-01-01", "TeamMemberId": 300100176473689, "TrackTimeFlag": true, "CreatedBy": "ABRAHAM.MASON", "CreationDate": "2019-03-20T09:54:14.466+00:00", "LastUpdateDate": "2019-03-20T09:54:14.852+00:00", "LastUpdatedBy": "ABRAHAM.MASON", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/ProjectTeamMembers/300100176473689", "name": "ProjectTeamMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/ProjectTeamMembers/300100176473689", "name": "ProjectTeamMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683", "name": "projectTemplates", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/ProjectTeamMembers/300100176473689/lov/ProjectRoles", "name": "ProjectRoles", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/ProjectTeamMembers/300100176473689/lov/ProjectPersons", "name": "ProjectPersons", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683", "name": "projectTemplates", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683", "name": "projectTemplates", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/lov/ServiceTypes", "name": "ServiceTypes", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/lov/ProjectUnits", "name": "ProjectUnits", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/lov/LegalEntities", "name": "LegalEntities", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/lov/ProjectStatuses", "name": "ProjectStatuses", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/lov/OwningOrganizations", "name": "OwningOrganizations", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/lov/BusinessUnits", "name": "BusinessUnits", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/lov/WorkTypes", "name": "WorkTypes", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/lov/ProjectTypes", "name": "ProjectTypes", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/lov/TransferPriceSchedules", "name": "TransferPriceSchedules", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/SetupOptions", "name": "SetupOptions", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/ProjectTeamMembers", "name": "ProjectTeamMembers", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/Tasks", "name": "Tasks", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/ProjectTransactionControls", "name": "ProjectTransactionControls", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/ProjectCustomers", "name": "ProjectCustomers", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/QuickEntries", "name": "QuickEntries", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/300100176473683/child/ProjectClassifications", "name": "ProjectClassifications", "kind": "collection" } ] }