Jump to

• Request
• Response
• Examples

Update a project opportunity

patch

/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.

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

• 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.

{
    "type":"object",
    "properties":{
        "OpportunityDescription":{
            "title":"Opportunity Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the opportunity that the project is associated with.",
            "nullable":true
        },
        "OpportunityNumber":{
            "title":"Opportunity Number",
            "maxLength":"240",
            "type":"string",
            "description":"The public unique identifier for an opportunity in the opportunity management application.",
            "nullable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "OpportunityCustomerId":{
            "title":"Opportunity Customer ID",
            "type":"integer",
            "description":"Unique identifier of the customer with whom the deal is made for the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OpportunityCustomerNumber":{
            "title":"Opportunity Project Customer Number",
            "maxLength":"240",
            "type":"string",
            "description":"Customer number in the opportunity management application.",
            "nullable":true
        },
        "OpportunityName":{
            "title":"Opportunity Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the opportunity that the project is associated with.",
            "nullable":false
        },
        "OpportunityCustomerName":{
            "title":"Opportunity Project Customer Name",
            "maxLength":"900",
            "type":"string",
            "description":"Name of the customer with whom the deal is made for the project.",
            "nullable":true
        },
        "OpportunityStatus":{
            "title":"Opportunity Status",
            "maxLength":"240",
            "type":"string",
            "description":"Status of an opportunity in the opportunity management application.",
            "nullable":true
        },
        "OpportunityId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"Unique identifier of the opportunity associated with the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "OpportunityAmount":{
            "title":"Opportunity Deal Amount",
            "type":"number",
            "description":"Total amount of a customer deal in the opportunity management application.",
            "nullable":true
        },
        "OpportunityAltNumber":{
            "title":"External Opportunity ID",
            "maxLength":"240",
            "type":"string",
            "description":"Unique identifier of the opportunity that is created in third-party application.",
            "nullable":true
        },
        "OpportunityWinConfPercent":{
            "title":"Opportunity Win Probability Percentage",
            "type":"number",
            "description":"Percentage probability of winning an opportunity in the opportunity management application.",
            "nullable":true
        },
        "OpportunityCurrencyCode":{
            "title":"Opportunity Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code of the deal amount for the opportunity.",
            "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 : projects-ProjectOpportunities-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "OpportunityDescription":{
            "title":"Opportunity Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the opportunity that the project is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityNumber":{
            "title":"Opportunity Number",
            "maxLength":"240",
            "type":"string",
            "description":"The public unique identifier for an opportunity in the opportunity management application.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OpportunityCustomerId":{
            "title":"Opportunity Customer ID",
            "type":"integer",
            "description":"Unique identifier of the customer with whom the deal is made for the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OpportunityCustomerNumber":{
            "title":"Opportunity Project Customer Number",
            "maxLength":"240",
            "type":"string",
            "description":"Customer number in the opportunity management application.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityName":{
            "title":"Opportunity Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the opportunity that the project is associated with.",
            "nullable":false,
            "x-queryable":true
        },
        "OpportunityCustomerName":{
            "title":"Opportunity Project Customer Name",
            "maxLength":"900",
            "type":"string",
            "description":"Name of the customer with whom the deal is made for the project.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityStatus":{
            "title":"Opportunity Status",
            "maxLength":"240",
            "type":"string",
            "description":"Status of an opportunity in the opportunity management application.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"Unique identifier of the opportunity associated with the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OpportunityAmount":{
            "title":"Opportunity Deal Amount",
            "type":"number",
            "description":"Total amount of a customer deal in the opportunity management application.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OpportunityAltNumber":{
            "title":"External Opportunity ID",
            "maxLength":"240",
            "type":"string",
            "description":"Unique identifier of the opportunity that is created in third-party application.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityWinConfPercent":{
            "title":"Opportunity Win Probability Percentage",
            "type":"number",
            "description":"Percentage probability of winning an opportunity in the opportunity management application.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityCurrencyCode":{
            "title":"Opportunity Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code of the deal amount for the opportunity.",
            "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 project opportunity 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.0.0projects/300100093207556/child/ProjectOpportunities/999997817603769

Example of Request Body

The following example shows the request body to update the amount, status, and win probability percentage of the project opportunity with opportunity ID 999997817603769 that is associated to the project with project ID 300100093207556.

{
  "OpportunityAmount" : 40000,
  "OpportunityStatus" : "SUCCESS",
  "OpportunityWinConfPercent" : 100
}

Example of Response Body

The following example shows the contents of the response body in JSON format, including the updated amount, status, and win probability percentage of the project opportunity.

{
  "OpportunityAltNumber" : null,
  "OpportunityAmount" : 40000,
  "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" : "SUCCESS",
  "OpportunityWinConfPercent" : 100,
  "OpportunityId" : 999997817603769,
  "ProjectId" : 300100093207556,
  "links" : [{
    "rel" : "self",
    ...  
            }]
  ...
}

Back to Top