Get all team members for a project template

get

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

Request

Path Parameters
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the project team member with the specified team member ID.
      Finder Variables:
      • TeamMemberId; integer; Unique identifier of the project team member.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AssignmentType; string; Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.
    • AssignmentTypeCode; string; Code to indicate if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.
    • BillablePercent; integer; 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; 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; 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; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • FinishDate; string; Date on which the assignment of the project team member to the project is scheduled to end.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the record.
    • PersonEmail; string; Email of the person assigned as a team member to the project.
    • PersonId; integer; Unique identifier of the person assigned as a team member to the project.
    • PersonName; string; Name of the person assigned as a team member to the project.
    • ProjectRoleId; integer; Unique identifier of the project role.
    • ProjectRoleName; string; 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; Percentage of time for which a resource is assigned to the project. The default value is 100.
    • ResourceAssignmentEffortInHours; number; Number of hours for which a resource is assigned to the project.
    • ResourcePlanningBillRate; number; 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; 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 from which the assignment of the team member to the project is scheduled to begin.
    • TeamMemberId; integer; Unique identifier of the team member assigned to the project.
    • TrackTimeFlag; boolean; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectTemplates-ProjectTeamMembers-item-response
Type: object
Show Source
  • Title: Assignment Type
    Indicates if a request is for a billable or a nonbillable assignment. Examples are BILLABLE, NON-BILLABLE, or leave blank.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Date on which the assignment of the project team member to the project is scheduled to end.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Team Member Email
    Maximum Length: 240
    Email of the person assigned as a team member to the project.
  • Title: Person ID
    Unique identifier of the person assigned as a team member to the project.
  • Title: Team Member Name
    Maximum Length: 240
    Name of the person assigned as a team member to the project.
  • Title: Project Role ID
    Unique identifier of the project role.
  • 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.
  • Title: Resource Allocation Percentage
    Percentage of time for which a resource is assigned to the project. The default value is 100.
  • Title: Resource Assignment Effort in Hours
    Number of hours for which a resource is assigned to the project.
  • 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.
  • 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.
  • Date from which the assignment of the team member to the project is scheduled to begin.
  • Title: Team Member ID
    Read Only: true
    Unique identifier of the team member assigned to the project.
  • 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.
Back to Top

Examples

The following example shows how to get all team members for a project template by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers

Response Body Example

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

{
    "items": [
        {
            "FinishDate": null,
            "PersonEmail": "sendmail-test-discard@oracle.com",
            "PersonId": 53,
            "PersonName": "Marlin, Amy",
            "ProjectRoleId": 1,
            "ProjectRoleName": "Project Manager",
            "StartDate": "2009-07-01",
            "TeamMemberId": 100000011985131,
            "TrackTimeFlag": false,
            "CreatedBy": "SERVICES",
            "CreationDate": "2009-08-16T04:04:42.674+00:00",
            "LastUpdateDate": "2009-08-16T04:06:00.721+00:00",
            "LastUpdatedBy": "SERVICES",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985131",
                    "name": "ProjectTeamMembers",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985131",
                    "name": "ProjectTeamMembers",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120",
                    "name": "projectTemplates",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985131/lov/ProjectRoles",
                    "name": "ProjectRoles",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985131/lov/ProjectPersons",
                    "name": "ProjectPersons",
                    "kind": "collection"
                }
            ]
        },
        {
            "FinishDate": null,
            "PersonEmail": "sendmail-test-discard@oracle.com",
            "PersonId": 4384,
            "PersonName": "Gray, Donald",
            "ProjectRoleId": 10,
            "ProjectRoleName": "Project Participant",
            "StartDate": "2009-07-01",
            "TeamMemberId": 100000011985132,
            "TrackTimeFlag": false,
            "CreatedBy": "SERVICES",
            "CreationDate": "2009-08-16T04:06:00.786+00:00",
            "LastUpdateDate": "2009-08-16T04:08:22.169+00:00",
            "LastUpdatedBy": "SERVICES",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985132",
                    "name": "ProjectTeamMembers",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985132",
                    "name": "ProjectTeamMembers",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120",
                    "name": "projectTemplates",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985132/lov/ProjectRoles",
                    "name": "ProjectRoles",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985132/lov/ProjectPersons",
                    "name": "ProjectPersons",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers",
            "name": "ProjectTeamMembers",
            "kind": "collection"
        }
    ]
}{
    "items": [
        {
            "FinishDate": null,
            "PersonEmail": "sendmail-test-discard@oracle.com",
            "PersonId": 53,
            "PersonName": "Marlin, Amy",
            "ProjectRoleId": 1,
            "ProjectRoleName": "Project Manager",
            "StartDate": "2009-07-01",
            "TeamMemberId": 100000011985131,
            "TrackTimeFlag": false,
            "CreatedBy": "SERVICES",
            "CreationDate": "2009-08-16T04:04:42.674+00:00",
            "LastUpdateDate": "2009-08-16T04:06:00.721+00:00",
            "LastUpdatedBy": "SERVICES",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985131",
                    "name": "ProjectTeamMembers",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985131",
                    "name": "ProjectTeamMembers",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120",
                    "name": "projectTemplates",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985131/lov/ProjectRoles",
                    "name": "ProjectRoles",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985131/lov/ProjectPersons",
                    "name": "ProjectPersons",
                    "kind": "collection"
                }
            ]
        },
        {
            "FinishDate": null,
            "PersonEmail": "sendmail-test-discard@oracle.com",
            "PersonId": 4384,
            "PersonName": "Gray, Donald",
            "ProjectRoleId": 10,
            "ProjectRoleName": "Project Participant",
            "StartDate": "2009-07-01",
            "TeamMemberId": 100000011985132,
            "TrackTimeFlag": false,
            "CreatedBy": "SERVICES",
            "CreationDate": "2009-08-16T04:06:00.786+00:00",
            "LastUpdateDate": "2009-08-16T04:08:22.169+00:00",
            "LastUpdatedBy": "SERVICES",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985132",
                    "name": "ProjectTeamMembers",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985132",
                    "name": "ProjectTeamMembers",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120",
                    "name": "projectTemplates",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985132/lov/ProjectRoles",
                    "name": "ProjectRoles",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers/100000011985132/lov/ProjectPersons",
                    "name": "ProjectPersons",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectTemplates/100000011985120/child/ProjectTeamMembers",
            "name": "ProjectTeamMembers",
            "kind": "collection"
        }
    ]
}
Back to Top