Update an approver of a gate in a project
patch
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/GateApprovers/{ApprovalId}
Request
Path Parameters
-
ApprovalId(required): integer(int64)
Unique identifier of the Gate Approver. Value is auto-generated when using POST and mandatory when using PATCH.
-
ProjectId(required): integer(int64)
Unique identifier of the project.
-
TaskId(required): integer(int64)
Unique identifier of the project task. Value is auto-generated when using POST and mandatory when using PATCH.
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
Root Schema : schema
Type:
Show Source
object
-
GateApproverComments: string
Title:
Gate Approver Comments
Maximum Length:1000
Optional text for comments by the approver. -
GateApproverEmail: string
Title:
Gate Approver Email
Maximum Length:240
Email address of the gate approver. -
GateApproverStatus: string
Title:
Gate Approver Status
Maximum Length:16
Status set for a gate by the approver. -
GateApproverUpdatedDate: string
(date)
Title:
Gate Approver Updated Date
Date when the Approval Status was last changed.
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 : projectPlans-Tasks-GateApprovers-item-response
Type:
Show Source
object
-
ApprovalId: integer
(int64)
Title:
Approval ID
Read Only:true
Unique identifier of the Gate Approver. Value is auto-generated when using POST and mandatory when using PATCH. -
GateApproverComments: string
Title:
Gate Approver Comments
Maximum Length:1000
Optional text for comments by the approver. -
GateApproverEmail: string
Title:
Gate Approver Email
Maximum Length:240
Email address of the gate approver. -
GateApproverName: string
Title:
Gate Approver Name
Read Only:true
Maximum Length:240
Name of the user who is to approve the gate. -
GateApproverStatus: string
Title:
Gate Approver Status
Maximum Length:16
Status set for a gate by the approver. -
GateApproverUpdatedBy: string
Title:
Gate Approver Updated By
Read Only:true
Maximum Length:240
The name of the user who updated the gate approval status. Nearly always the approver identified in the row, but could be the project manager. -
GateApproverUpdatedDate: string
(date)
Title:
Gate Approver Updated Date
Date when the Approval Status was last changed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Examples
The following example shows how to update an approver of a gate in a project 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/projectPlans/300100184801843/child/Tasks/300100184802603/child/GateApprovers/300100184838546
Request Body Example
The following shows an example of the request body in JSON format.
{ "GateApproverComments":"test comment2" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ApprovalId": 300100184838546, "GateApproverName": "Abraham Mason", "GateApproverEmail": "prj_wf_in_grp@oracle.com", "GateApproverStatus": "APPROVED", "GateApproverUpdatedBy": "Abraham Mason", "GateApproverUpdatedDate": "2019-12-09", "GateApproverComments": "test comment2", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802603/child/GateApprovers/300100184838546", "name": "GateApprovers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802603/child/GateApprovers/300100184838546", "name": "GateApprovers", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802603", "name": "Tasks", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802603/child/GateApprovers/300100184838546/lov/EnterpriseLaborResourceVA", "name": "EnterpriseLaborResourceVA", "kind": "collection" } ] }