Jump to

• Request
• Response
• Examples

Update a nominated resource on a project resource request

patch

/fscmRestApi/resources/11.13.18.05/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestLines/{RequestLineId}

Request

Path Parameters

• RequestLineId(required): integer(int64)
  Unique identifier of the request line under the project resource request.
• ResourceRequestId(required): integer(int64)
  Identifier of the project resource 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssignmentFinishDate: string (date)
  Title: Assignment Finish Date

  Assignment finish date for the resource.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  Assignment start date for the resource.
• ProjectRole: string
  Title: Project Role

  Resource role for the project assignment.
• RejectionReason: string
  Maximum Length: 80

  Reason the nominated resource is rejected for the project resource assignment.
• RejectionReasonCode: string
  Title: Rejection Reason Code

  Maximum Length: 30

  Code to indicate the reason the nominated resource is rejected for the project resource assigment.
• ResourceStatus: string
  Title: Resource Staffing Status

  Maximum Length: 80

  Status of the resource associated to the project resource request.
• ResourceStatusCode: string
  Title: Resource Status Code

  Maximum Length: 20

  Default Value: NEW_LINE

  Status code for the resource associated to the project resource request.

{
    "type":"object",
    "properties":{
        "ResourceStatusCode":{
            "title":"Resource Status Code",
            "maxLength":"20",
            "type":"string",
            "description":"Status code for the resource associated to the project resource request.",
            "nullable":true,
            "default":"NEW_LINE"
        },
        "ResourceStatus":{
            "title":"Resource Staffing Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the resource associated to the project resource request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RejectionReasonCode":{
            "title":"Rejection Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the reason the nominated resource is rejected for the project resource assigment.",
            "nullable":true
        },
        "ProjectRole":{
            "title":"Project Role",
            "type":"string",
            "description":"Resource role for the project assignment.",
            "nullable":true
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"Assignment start date for the resource.",
            "format":"date",
            "nullable":true
        },
        "RejectionReason":{
            "maxLength":"80",
            "type":"string",
            "description":"Reason the nominated resource is rejected for the project resource assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignmentFinishDate":{
            "title":"Assignment Finish Date",
            "type":"string",
            "description":"Assignment finish date for the resource.",
            "format":"date",
            "nullable":true
        }
    }
}

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 : projectPlanResourceRequests-ProjectPlanResourceRequestLines-item-response

Type: object

Show Source

• AssignedHours: number
  Title: Assigned Hours

  Read Only: true

  Assigned hours per day when the specify hours per day is selected for use project calendar flag.
• AssignmentFinishDate: string (date)
  Title: Assignment Finish Date

  Assignment finish date for the resource.
• AssignmentId: integer
  Title: Assignment ID

  Identifier of the assignment created for the resource, if an assignment is created for the resource on the request line.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  Assignment start date for the resource.
• AssignmentStatus: string
  Title: Resource Staffing Status

  Read Only: true

  Maximum Length: 80

  Status of the assignment created for the resource to fulfill the request.
• AssignmentStatusCode: string
  Title: Assignment Status Code

  Maximum Length: 30

  Code of the assignment created for the resource to fulfill the request.
• CurrentFlag: boolean
  Title: Current Indicator

  Read Only: true

  Maximum Length: 1

  Indicates whether the project resource request is the most recent request for the assignment. Valid values are Y and N.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectRole: string
  Title: Project Role

  Resource role for the project assignment.
• RejectionReason: string
  Maximum Length: 80

  Reason the nominated resource is rejected for the project resource assignment.
• RejectionReasonCode: string
  Title: Rejection Reason Code

  Maximum Length: 30

  Code to indicate the reason the nominated resource is rejected for the project resource assigment.
• RequestLineId: integer (int64)
  Title: Request Line ID

  Unique identifier of the request line under the project resource request.
• ReservationExpirationDate: string (date)
  Title: Reservation Expiration Date

  Read Only: true

  Reservation expiration date for the resource if the assignment status is reserved.
• ReservationReason: string
  Title: Reservation Reason

  Read Only: true

  Reservation reason for the resource if the assignment status is reserved.
• ResourceEmail: string
  Title: Resource Email

  Maximum Length: 240

  Name of the project enterprise resource associated to the project resource request.
• ResourceFulfilledDate: string (date)
  Title: Request Fulfilled Date

  The date the resource on the request line is approved to fulfill the project resource request.
• ResourceId: integer (int64)
  Title: Resource ID

  Identifier of the project enterprise resource associated to the project resource request.
• ResourceName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 240

  Email of the project enterprise resource associated to the project resource request.
• ResourcePersonId: integer (int64)
  Title: Resource HCM Person ID

  Read Only: true

  HCM person identifier of the project enterprise resource associated to the project resource request.
• ResourceProposedDate: string (date)
  Title: Resource Proposed Date

  The date when the resource is proposed or nominated to fulfill the project resource request.
• ResourceStatus: string
  Title: Resource Staffing Status

  Maximum Length: 80

  Status of the resource associated to the project resource request.
• ResourceStatusCode: string
  Title: Resource Status Code

  Maximum Length: 20

  Default Value: NEW_LINE

  Status code for the resource associated to the project resource request.
• ResourceSystemStatus: string
  Title: Resource System Status

  Read Only: true

  Resource system status based on the seeded values.
• UseProjectCalendarFlag: boolean
  Title: Use Project Calendar Indicator

  Read Only: true

  Indicates whether to use project calendar hours or specific hours per day.

{
    "type":"object",
    "properties":{
        "ResourceProposedDate":{
            "title":"Resource Proposed Date",
            "type":"string",
            "description":"The date when the resource is proposed or nominated to fulfill the project resource request.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Email of the project enterprise resource associated to the project resource request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestLineId":{
            "title":"Request Line ID",
            "type":"integer",
            "description":"Unique identifier of the request line under the project resource request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReservationReason":{
            "title":"Reservation Reason",
            "type":"string",
            "description":"Reservation reason for the resource if the assignment status is reserved.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectRole":{
            "title":"Project Role",
            "type":"string",
            "description":"Resource role for the project assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"Assignment start date for the resource.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RejectionReason":{
            "maxLength":"80",
            "type":"string",
            "description":"Reason the nominated resource is rejected for the project resource assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourcePersonId":{
            "title":"Resource HCM Person ID",
            "type":"integer",
            "description":"HCM person identifier of the project enterprise resource associated to the project resource request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UseProjectCalendarFlag":{
            "title":"Use Project Calendar Indicator",
            "type":"boolean",
            "description":"Indicates whether to use project calendar hours or specific hours per day.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceStatusCode":{
            "title":"Resource Status Code",
            "maxLength":"20",
            "type":"string",
            "description":"Status code for the resource associated to the project resource request.",
            "nullable":true,
            "default":"NEW_LINE",
            "x-queryable":true
        },
        "ReservationExpirationDate":{
            "title":"Reservation Expiration Date",
            "type":"string",
            "description":"Reservation expiration date for the resource if the assignment status is reserved.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Identifier of the project enterprise resource associated to the project resource request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceSystemStatus":{
            "title":"Resource System Status",
            "type":"string",
            "description":"Resource system status based on the seeded values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Identifier of the assignment created for the resource, if an assignment is created for the resource on the request line.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceStatus":{
            "title":"Resource Staffing Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the resource associated to the project resource request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RejectionReasonCode":{
            "title":"Rejection Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the reason the nominated resource is rejected for the project resource assigment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssignmentStatusCode":{
            "title":"Assignment Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the assignment created for the resource to fulfill the request.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceFulfilledDate":{
            "title":"Request Fulfilled Date",
            "type":"string",
            "description":"The date the resource on the request line is approved to fulfill the project resource request.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentStatus":{
            "title":"Resource Staffing Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the assignment created for the resource to fulfill the request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentFlag":{
            "title":"Current Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the project resource request is the most recent request for the assignment. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedHours":{
            "title":"Assigned Hours",
            "type":"number",
            "description":"Assigned hours per day when the specify hours per day is selected for use project calendar flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceEmail":{
            "title":"Resource Email",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project enterprise resource associated to the project resource request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AssignmentFinishDate":{
            "title":"Assignment Finish Date",
            "type":"string",
            "description":"Assignment finish date for the resource.",
            "format":"date",
            "nullable":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 : 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 nominated resource on a project resource request 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/projectPlanResourceRequests/{ResourceRequestId}/child/ProjectPlanResourceRequestLines/{RequestLineId}

Request Body Example

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

{
	"ResourceStatusCode": "REQUESTED_CONFIRM"
	}

Response Body Example

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

{
		"RequestLineId": 300100180715440,
		"ResourceId": 300100151966221,
		"ResourceName": "PJR-P1-Resource1",
		"ResourceEmail": "[e-mail]",
		"ResourcePersonId": null,
		"ResourceStatusCode": "REQUESTED_CONFIRM",
		"ResourceStatus": "Requested for Confirmed Assignment",
		"AssignmentId": 300100180715441,
		"AssignmentStatusCode": "CONFIRMED",
		"AssignmentStatus": "Confirmed",
		"ResourceProposedDate": "2019-06-19",
		"ResourceFulfilledDate": null,
		"RejectionReasonCode": null,
		"RejectionReason": null
	}

Back to Top