Create one or more project resource pools.
post
/fscmRestApi/resources/11.13.18.05/projectResourcePools
Request
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
-
Description: string
Title:
Resource Pool Description
Maximum Length:2000
Description of the project resource pool. -
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. -
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(required): string
Title:
Resource Pool Name
Maximum Length:240
Name of the project resource pool.
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 : projectResourcePools-ProjectResourcePoolManagers-item-post-request
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. -
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. -
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 : projectResourcePools-ProjectResourcePoolMembers-item-post-request
Type:
Show Source
object
-
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. -
ResourcePoolMembershipId: integer
(int64)
Title:
Resource Pool Membership ID
Unique identifier of the project resource pool membership.
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 : 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 create one or more project resource pools 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/projectResourcePools
Request Body Example
The following shows an example of the request body in JSON format.
{ "ResourcePoolName": "Sample Pool Creation", "PoolOwnerResourceId": 300100023180808, "PoolOwnerEmail": "prj_maria_lee_in_grp@oracle.com", "Description": "Sample Pool Creation Test", "ParentResourcePoolId": 300100024326678, "ParentResourcePoolName": "zBIQA_Rel8_Pool1" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ResourcePoolId" : 300100180767149, "ResourcePoolName" : "Sample Pool Creation", "PoolOwnerResourceId" : 300100023180808, "PoolOwnerName" : "Maria Lee", "PoolOwnerEmail" : "prj_maria_lee_in_grp@oracle.com", "PoolOwnerPersonId" : 100100004278132, "Description" : "Sample Pool Creation Test", "ParentResourcePoolId" : 300100024326678, "ParentResourcePoolName" : "zBIQA_Rel8_Pool1" }