Jump to

• Request
• Response
• Examples

Update a project resource pool.

patch

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

Header Parameters

• Metadata-Context: string
  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: string
  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

• 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.
• ResourcePoolName: string
  Title: Resource Pool Name

  Maximum Length: 240

  Name of the project resource pool.

{ "type":"object", "properties":{ "ParentResourcePoolName":{ "title":"Parent Resource Pool Name", "maxLength":240, "type":"string", "description":"Name of the parent resource pool.", "nullable":true, "x-hints":{ "controlType":"combo_lov" } }, "Description":{ "title":"Resource Pool Description", "maxLength":2000, "type":"string", "description":"Description of the project resource pool.", "nullable":true }, "PoolOwnerResourceId":{ "title":"Pool Owner Resource ID", "type":"integer", "description":"Identifier of the project enterprise resource who's the project resource pool owner.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 } }, "ProjectResourcePoolMembers":{ "title":"Project Resource Pool Members", "type":"array", "description":"The Project Resource Pool Members resource is used to view, create, and update project resource pool members assigned to a resource pool.", "items":{ "$ref":"#/components/schemas/projectResourcePools-ProjectResourcePoolMembers-item-patch-request" } }, "ResourcePoolName":{ "title":"Resource Pool Name", "maxLength":240, "type":"string", "description":"Name of the project resource pool.", "nullable":false }, "PoolOwnerEmail":{ "title":"Pool Owner Email", "maxLength":240, "type":"string", "description":"Email of the project resource pool owner.", "nullable":true, "x-hints":{ "controlType":"combo_lov" } }, "ParentResourcePoolId":{ "title":"Parent Resource Pool ID", "type":"integer", "description":"Unique identifier of the parent resource pool.", "format":"int64", "nullable":true, "default":0, "x-hints":{ "precision":18 } }, "ProjectResourcePoolManagers":{ "title":"Project Resource Pool Managers", "type":"array", "description":"The Project Resource Pool Managers resource is used to view, create, and delete project resource pool managers associated to a resource pool.", "items":{ "$ref":"#/components/schemas/projectResourcePools-ProjectResourcePoolManagers-item-patch-request" } } } }

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

• Array of: object projectResourcePools-ProjectResourcePoolManagers-item-patch-request

{ "title":"Project Resource Pool Managers", "type":"array", "description":"The Project Resource Pool Managers resource is used to view, create, and delete project resource pool managers associated to a resource pool.", "items":{ "$ref":"#/components/schemas/projectResourcePools-ProjectResourcePoolManagers-item-patch-request" } }

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

• Array of: object schema

{ "title":"Project Resource Pool Members", "type":"array", "description":"The Project Resource Pool Members resource is used to view, create, and update project resource pool members assigned to a resource pool.", "items":{ "$ref":"#/components/schemas/projectResourcePools-ProjectResourcePoolMembers-item-patch-request" } }

Nested Schema : projectResourcePools-ProjectResourcePoolManagers-item-patch-request

Type: object

Show Source

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

{ "type":"object", "properties":{ "InheritedFlag":{ "title":"Inherited from Parent Indicator", "maxLength":1, "type":"boolean", "description":"Indicator if the resource pool manager is inherited from a parent resource pool.", "nullable":false }, "PoolManagerEmail":{ "title":"Resource Pool Manager Email", "maxLength":240, "type":"string", "description":"Email of the project resource pool manager.", "nullable":true, "x-hints":{ "controlType":"combo_lov" } }, "PoolManagerResourceId":{ "title":"Resource Pool Manager Resource ID", "type":"integer", "description":"Identifier of the project enterprise resource who's assigned as the resource pool manager.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 } }, "PoolManagerName":{ "title":"Resource Pool Manager Name", "maxLength":240, "type":"string", "description":"Name of the project resource pool manager.", "nullable":false, "x-hints":{ "controlType":"combo_lov" } } } }

Nested Schema : schema

Type: object

Show Source

• PoolMembershipFromDate: string (date)
  Title: Pool Membership from Date

  Start date of the resource pool membership.

{ "type":"object", "properties":{ "PoolMembershipFromDate":{ "title":"Pool Membership from Date", "type":"string", "description":"Start date of the resource pool membership.", "format":"date", "nullable":false } } }

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 : projectResourcePools-item-response

Type: object

Show Source

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

{ "type":"object", "properties":{ "PoolOwnerPersonId":{ "title":"Pool Owner Person ID", "type":"integer", "description":"Identifier of the HCM person associated to the project resource pool owner.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ParentResourcePoolName":{ "title":"Parent Resource Pool Name", "maxLength":240, "type":"string", "description":"Name of the parent resource pool.", "nullable":true, "x-hints":{ "controlType":"combo_lov" }, "x-queryable":true }, "Description":{ "title":"Resource Pool Description", "maxLength":2000, "type":"string", "description":"Description of the project resource pool.", "nullable":true, "x-queryable":true }, "PoolOwnerResourceId":{ "title":"Pool Owner Resource ID", "type":"integer", "description":"Identifier of the project enterprise resource who's the project resource pool owner.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ProjectResourcePoolMembers":{ "title":"Project Resource Pool Members", "type":"array", "description":"The Project Resource Pool Members resource is used to view, create, and update project resource pool members assigned to a resource pool.", "items":{ "$ref":"#/components/schemas/projectResourcePools-ProjectResourcePoolMembers-item-response" } }, "PoolOwnerName":{ "title":"Pool Owner Name", "maxLength":240, "type":"string", "description":"Name of the project resource pool owner.", "nullable":false, "readOnly":true, "x-queryable":true }, "ResourcePoolName":{ "title":"Resource Pool Name", "maxLength":240, "type":"string", "description":"Name of the project resource pool.", "nullable":false, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "PoolOwnerEmail":{ "title":"Pool Owner Email", "maxLength":240, "type":"string", "description":"Email of the project resource pool owner.", "nullable":true, "x-hints":{ "controlType":"combo_lov" }, "x-queryable":true }, "ParentResourcePoolId":{ "title":"Parent Resource Pool ID", "type":"integer", "description":"Unique identifier of the parent resource pool.", "format":"int64", "nullable":true, "default":0, "x-hints":{ "precision":18 }, "x-queryable":true }, "ProjectResourcePoolManagers":{ "title":"Project Resource Pool Managers", "type":"array", "description":"The Project Resource Pool Managers resource is used to view, create, and delete project resource pool managers associated to a resource pool.", "items":{ "$ref":"#/components/schemas/projectResourcePools-ProjectResourcePoolManagers-item-response" } }, "ResourcePoolId":{ "title":"Resource Pool ID", "type":"integer", "description":"Unique identifier of the project resource pool.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"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 : 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

• Array of: object projectResourcePools-ProjectResourcePoolManagers-item-response

{ "title":"Project Resource Pool Managers", "type":"array", "description":"The Project Resource Pool Managers resource is used to view, create, and delete project resource pool managers associated to a resource pool.", "items":{ "$ref":"#/components/schemas/projectResourcePools-ProjectResourcePoolManagers-item-response" } }

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

• Array of: object projectResourcePools-ProjectResourcePoolMembers-item-response

{ "title":"Project Resource Pool Members", "type":"array", "description":"The Project Resource Pool Members resource is used to view, create, and update project resource pool members assigned to a resource pool.", "items":{ "$ref":"#/components/schemas/projectResourcePools-ProjectResourcePoolMembers-item-response" } }

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." } } }

Nested Schema : projectResourcePools-ProjectResourcePoolManagers-item-response

Type: object

Show Source

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

{ "type":"object", "properties":{ "PoolManagerPersonId":{ "title":"Resource Pool Manager Person ID", "type":"integer", "description":"Identifier of the HCM person who's assigned as the project resource pool manager.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "InheritedFlag":{ "title":"Inherited from Parent Indicator", "maxLength":1, "type":"boolean", "description":"Indicator if the resource pool manager is inherited from a parent resource pool.", "nullable":false, "x-queryable":true }, "PoolManagerName":{ "title":"Resource Pool Manager Name", "maxLength":240, "type":"string", "description":"Name of the project resource pool manager.", "nullable":false, "x-hints":{ "controlType":"combo_lov" }, "x-queryable":true }, "PoolManagerEmail":{ "title":"Resource Pool Manager Email", "maxLength":240, "type":"string", "description":"Email of the project resource pool manager.", "nullable":true, "x-hints":{ "controlType":"combo_lov" }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "PoolManagerResourceId":{ "title":"Resource Pool Manager Resource ID", "type":"integer", "description":"Identifier of the project enterprise resource who's assigned as the resource pool manager.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "PoolManagerId":{ "title":"Resource Pool Manager ID", "type":"integer", "description":"Unique identifier of the project resource pool manager.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"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 : projectResourcePools-ProjectResourcePoolMembers-item-response

Type: object

Show Source

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

{ "type":"object", "properties":{ "ResourcePersonId":{ "title":"Resource Person ID", "type":"integer", "description":"Unique identifier of the HCM person who's the project resource pool member.", "format":"int64", "nullable":true, "readOnly":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "ResourcePoolMembershipId":{ "title":"Resource Pool Membership ID", "type":"integer", "description":"Unique identifier of the project resource pool membership.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "PoolMembershipFromDate":{ "title":"Pool Membership from Date", "type":"string", "description":"Start date of the resource pool membership.", "format":"date", "nullable":false, "x-queryable":true }, "ResourceId":{ "title":"Resource ID", "type":"integer", "description":"Identifier of project enterprise resource who's the project resource pool member.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "ResourceName":{ "title":"Resource Name", "maxLength":240, "type":"string", "description":"Name of the project enterprise resource who's the project resource pool member.", "nullable":false, "readOnly":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "PoolMembershipToDate":{ "title":"Pool Membership to Date", "type":"string", "description":"Last date of the resource pool membership.", "format":"date", "nullable":true, "x-queryable":true }, "ResourceEmail":{ "title":"Resource Email", "maxLength":240, "type":"string", "description":"Email of the project resource pool member.", "nullable":true, "x-hints":{ "controlType":"combo_lov" }, "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" } }

Links

ProjectResourcePoolManagers

Operation: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/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.

ProjectResourcePoolMembers

Operation: /fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/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.

Back to Top

Examples

The following example shows how to update a project resource pool by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourcePools/{ResourcePoolIdEnterpriseidKey}

Request Body Example

The following shows an example of the request body in JSON format. Keep in mind that the path parameter is a hash key.

{ "ResourcePoolName": "Sample Pool Update", "PoolOwnerResourceId": 300100023180814, "PoolOwnerEmail": "[e-mail]", "Description": "Sample Pool Update Test", "ParentResourcePoolId": 100, "ParentResourcePoolName": "All Resources" }

Response Body Example

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

{ "ResourcePoolId": 300100180767149, "ResourcePoolName": "Sample Pool Update", "PoolOwnerResourceId": 300100023180814, "PoolOwnerName": "Mary Smith", "PoolOwnerEmail": "[e-mail]", "PoolOwnerPersonId": 100100004278152, "Description": "Sample Pool Update Test", "ParentResourcePoolId": 100, "ParentResourcePoolName": "All Resources", }

Back to Top