Get a project resource pool.
get
/fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}
Request
Path Parameters
-
projectResourcePoolsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Project Resource Pools resource and used to uniquely identify an instance of Project Resource Pools. The client should not generate the hash key value. Instead, the client should query on the Project Resource Pools collection resource in order to navigate to a specific instance of Project Resource Pools to get the hash key.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : projectResourcePools-item-response
Type:
Show Source
object
-
Description: string
Title:
Resource Pool Description
Maximum Length:2000
Description of the project resource pool. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentResourcePoolId: integer
(int64)
Title:
Parent Resource Pool ID
Default Value:0
Unique identifier of the parent resource pool. -
ParentResourcePoolName: string
Title:
Parent Resource Pool Name
Maximum Length:240
Name of the parent resource pool. -
PoolOwnerEmail: string
Title:
Pool Owner Email
Maximum Length:240
Email of the project resource pool owner. -
PoolOwnerName: string
Title:
Pool Owner Name
Read Only:true
Maximum Length:240
Name of the project resource pool owner. -
PoolOwnerPersonId: integer
(int64)
Title:
Pool Owner Person ID
Read Only:true
Identifier of the HCM person associated to the project resource pool owner. -
PoolOwnerResourceId: integer
(int64)
Title:
Pool Owner Resource ID
Identifier of the project enterprise resource who's the project resource pool owner. -
ProjectResourcePoolManagers: array
Project Resource Pool Managers
Title:
Project Resource Pool Managers
The Project Resource Pool Managers resource is used to view, create, and delete project resource pool managers associated to a resource pool. -
ProjectResourcePoolMembers: array
Project Resource Pool Members
Title:
Project Resource Pool Members
The Project Resource Pool Members resource is used to view, create, and update project resource pool members assigned to a resource pool. -
ResourcePoolId: integer
(int64)
Title:
Resource Pool ID
Unique identifier of the project resource pool. -
ResourcePoolName: string
Title:
Resource Pool Name
Maximum Length:240
Name of the project resource pool.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Resource Pool Managers
Type:
array
Title:
Project Resource Pool Managers
The Project Resource Pool Managers resource is used to view, create, and delete project resource pool managers associated to a resource pool.
Show Source
Nested Schema : Project Resource Pool Members
Type:
array
Title:
Project Resource Pool Members
The Project Resource Pool Members resource is used to view, create, and update project resource pool members assigned to a resource pool.
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.
Nested Schema : projectResourcePools-ProjectResourcePoolManagers-item-response
Type:
Show Source
object
-
InheritedFlag: boolean
Title:
Inherited from Parent Indicator
Maximum Length:1
Indicator if the resource pool manager is inherited from a parent resource pool. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoolManagerEmail: string
Title:
Resource Pool Manager Email
Maximum Length:240
Email of the project resource pool manager. -
PoolManagerId: integer
(int64)
Title:
Resource Pool Manager ID
Unique identifier of the project resource pool manager. -
PoolManagerName: string
Title:
Resource Pool Manager Name
Maximum Length:240
Name of the project resource pool manager. -
PoolManagerPersonId: integer
(int64)
Title:
Resource Pool Manager Person ID
Read Only:true
Identifier of the HCM person who's assigned as the project resource pool manager. -
PoolManagerResourceId: integer
(int64)
Title:
Resource Pool Manager Resource ID
Identifier of the project enterprise resource who's assigned as the resource pool manager.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectResourcePools-ProjectResourcePoolMembers-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoolMembershipFromDate: string
(date)
Title:
Pool Membership from Date
Start date of the resource pool membership. -
PoolMembershipToDate: string
(date)
Title:
Pool Membership to Date
Last date of the resource pool membership. -
ResourceEmail: string
Title:
Resource Email
Maximum Length:240
Email of the project resource pool member. -
ResourceId: integer
(int64)
Title:
Resource ID
Identifier of project enterprise resource who's the project resource pool member. -
ResourceName: string
Title:
Resource Name
Read Only:true
Maximum Length:240
Name of the project enterprise resource who's the project resource pool member. -
ResourcePersonId: integer
(int64)
Title:
Resource Person ID
Read Only:true
Unique identifier of the HCM person who's the project resource pool member. -
ResourcePoolMembershipId: integer
(int64)
Title:
Resource Pool Membership ID
Unique identifier of the project resource pool membership.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ProjectResourcePoolManagers
-
Parameters:
- projectResourcePoolsUniqID:
$request.path.projectResourcePoolsUniqID
The Project Resource Pool Managers resource is used to view, create, and delete project resource pool managers associated to a resource pool. - projectResourcePoolsUniqID:
- ProjectResourcePoolMembers
-
Parameters:
- projectResourcePoolsUniqID:
$request.path.projectResourcePoolsUniqID
The Project Resource Pool Members resource is used to view, create, and update project resource pool members assigned to a resource pool. - projectResourcePoolsUniqID:
Examples
The following example shows how to get a project resource pool by submitting a GET request on the REST resource using cURL. Keep in mind that the path parameter is a hash key.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourcePools/00020000000EACED00057708000110F07B58DA170000000EACED0005770800000000000000CA
Response Body Example
The following shows an example of the response body in JSON format of all project templates.
{ "ResourcePoolId": 300100024326679, "ResourcePoolName": "zBIQA_Rel8_Pool1_1", "PoolOwnerResourceId": 300100024326426, "PoolOwnerName": "William Crawford", "PoolOwnerEmail": "William.Crawford@oracle.com", "PoolOwnerPersonId": 100010032550926, "Description": "Pool 1_1 in Hierarchy", "ParentResourcePoolId": 300100024326678, "ParentResourcePoolName": "zBIQA_Rel8_Pool1", "links": [ .... ] }