Jump to

• Request
• Response
• Examples

Update a project resource member assigned to a project resource pool.

patch

/fscmRestApi/resources/11.13.18.05/projectResourcePools/{projectResourcePoolsUniqID}/child/ProjectResourcePoolMembers/{ResourcePoolMembershipId}

Request

Path Parameters

• ResourcePoolMembershipId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• 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:
  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

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

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

Examples

The following example shows how to update a project resource member assigned to 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}/child/ProjectResourcePoolMembers/ResourcePoolMembershipId

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.

{
"PoolMembershipFromDate": "2019-10-23"
}

Response Body Example

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

	  {
   	   "ResourcePoolMembershipId": 300100180767168,
    	   "ResourceId": 300100023180808,
   	   "ResourceEmail": "[e-mail]",
   	   "ResourcePersonId": 100100004278132,
   	   "ResourceName": "Maria Lee",
   	   "PoolMembershipFromDate": "2019-10-23",
   	   "PoolMembershipToDate": null
 	  }

Back to Top