Get all the approvers of a gate in a project
get
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/GateApprovers
Request
Path Parameters
- 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.
Query Parameters
- dependency: string This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> - expand: string When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
- fields: string This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 - finder: string Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the gate approvers for a gate with a specific task ID.
Finder Variables:- ApprovalId; integer; Unique identifier of the Gate Approver. Value is auto-generated when using POST and mandatory when using PATCH.
- PrimaryKey: Finds the gate approvers for a gate with a specific task ID.
- limit: integer This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
- links: string This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical - offset: integer Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
- onlyData: boolean The resource item payload will be filtered in order to contain only data (no links section, for example).
- orderBy: string This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
- q: string This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ApprovalId; integer; Unique identifier of the Gate Approver. Value is auto-generated when using POST and mandatory when using PATCH.
- GateApproverComments; string; Optional text for comments by the approver.
- GateApproverEmail; string; Email address of the gate approver.
- GateApproverName; string; Name of the user who is to approve the gate.
- GateApproverStatus; string; Status set for a gate by the approver.
- GateApproverUpdatedBy; string; 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.
- totalResults: boolean The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : projectPlans-Tasks-GateApprovers
Type:
Show Source object
- count(required): integer The number of resource instances returned in the current range.
- hasMore(required): boolean Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
- items: array Items Title:
Items
The items in the collection. - limit(required): integer The actual paging size used by the server.
- links(required): array Links Title:
Links
The link relations associated with the resource instance. - offset(required): integer The offset value used in the current page.
- totalResults: integer The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested 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 get an attachment for a deliverable of the project task by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802603/child/GateApprovers
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "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" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802603/child/GateApprovers", "name": "GateApprovers", "kind": "collection" } ] }