Jump to

• Request
• Response

Update a project team member

patch

/fscmRestApi/resources/11.13.18.05/projectTemplates/{projectTemplatesUniqID}/child/ProjectTeamMembers/{TeamMemberId}

Request

Path Parameters

• TeamMemberId(required): integer(int64)
  Unique identifier of the team member assigned to the project.
• 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

Request Body - 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

  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.
• 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.

{
    "type":"object",
    "properties":{
        "TrackTimeFlag":{
            "maxLength":"1",
            "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
        },
        "ResourcePlanningBillRate":{
            "title":"Resource Planning Bill Rate",
            "type":"number",
            "description":"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.",
            "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
        },
        "FinishDate":{
            "type":"string",
            "description":"Date on which the assignment of the project team member to the project is scheduled to end.",
            "format":"date",
            "nullable":true
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type Code",
            "maxLength":"30",
            "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
        },
        "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
        },
        "StartDate":{
            "type":"string",
            "description":"Date from which the assignment of the team member to the project is scheduled to begin.",
            "format":"date",
            "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
        },
        "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
        },
        "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
        },
        "BillablePercent":{
            "title":"Billable Percent",
            "type":"integer",
            "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
        },
        "BillablePercentReasonCode":{
            "title":"Billable Percent Reason Code",
            "maxLength":"30",
            "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
        }
    }
}

Back to Top

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.

Body ()

Root Schema : projectTemplates-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

  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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrackTimeFlag":{
            "maxLength":"1",
            "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":true,
            "readOnly":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, then the bill rate of the resource defined in the 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
        },
        "ProjectRoleId":{
            "title":"Project Role ID",
            "type":"integer",
            "description":"Unique identifier of the project role.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FinishDate":{
            "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
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type Code",
            "maxLength":"30",
            "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
        },
        "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
        },
        "ProjectRoleName":{
            "title":"Project Role Name",
            "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-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDate":{
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "BillablePercent":{
            "title":"Billable Percent",
            "type":"integer",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillablePercentReasonCode":{
            "title":"Billable Percent Reason Code",
            "maxLength":"30",
            "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
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":true,
            "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."
        }
    }
}

Back to Top