Get a project opportunity
get
/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectOpportunities/{OpportunityId}
Request
Path Parameters
-
OpportunityId(required): integer(int64)
Unique identifier of the opportunity associated with the project.
-
ProjectId(required): integer(int64)
Unique identifier of the project.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
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(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 : projects-ProjectOpportunities-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OpportunityAltNumber: string
Title:
External Opportunity ID
Maximum Length:240
Unique identifier of the opportunity that is created in third-party application. -
OpportunityAmount: number
Title:
Opportunity Deal Amount
Total amount of a customer deal in the opportunity management application. -
OpportunityCurrencyCode: string
Title:
Opportunity Currency Code
Maximum Length:15
Currency code of the deal amount for the opportunity. -
OpportunityCustomerId: integer
(int64)
Title:
Opportunity Customer ID
Unique identifier of the customer with whom the deal is made for the project. -
OpportunityCustomerName: string
Title:
Opportunity Project Customer Name
Maximum Length:900
Name of the customer with whom the deal is made for the project. -
OpportunityCustomerNumber: string
Title:
Opportunity Project Customer Number
Maximum Length:240
Customer number in the opportunity management application. -
OpportunityDescription: string
Title:
Opportunity Description
Maximum Length:1000
Description of the opportunity that the project is associated with. -
OpportunityId: integer
(int64)
Title:
Opportunity ID
Unique identifier of the opportunity associated with the project. -
OpportunityName: string
Title:
Opportunity Name
Maximum Length:240
Name of the opportunity that the project is associated with. -
OpportunityNumber: string
Title:
Opportunity Number
Maximum Length:240
The public unique identifier for an opportunity in the opportunity management application. -
OpportunityStatus: string
Title:
Opportunity Status
Maximum Length:240
Status of an opportunity in the opportunity management application. -
OpportunityWinConfPercent: number
Title:
Opportunity Win Probability Percentage
Percentage probability of winning an opportunity in the opportunity management application. -
ProjectId: integer
(int64)
Title:
Project ID
Unique identifier of the project.
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 a project opportunity 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.0.0/projects/300100093207556/child/ProjectOpportunities/999997817603769
Example of Response Body
The following example shows the contents of the response body in JSON format, including the details of the project opportunity with opportunity ID 999997817603769 that is associated to the project with project ID 300100093207556.
{ "OpportunityAltNumber" : null, "OpportunityAmount" : 100000, "OpportunityCurrencyCode" : null, "OpportunityCustomerId" : null, "OpportunityCustomerName" : "Professional Services_101408870", "OpportunityCustomerNumber" : "999997569489397", "OpportunityDescription" : null, "OpportunityName" : "TM BDO PeopleSoft Upgrade HCM 8.3 to 9.0", "OpportunityNumber" : "3-5R7RY1", "OpportunityStatus" : "WON", "OpportunityWinConfPercent" : 90, "OpportunityId" : 999997817603769, "ProjectId" : 300100093207556, "links" : [{ "rel" : "self", ... }] ... }