Create an opportunity
post
/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseOpportunities
Request
Path Parameters
-
CaseNumber(required): string
The alternate key identifier of the case.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the case opportunity. -
OptyName: string
Title:
Opportunity Name
Maximum Length:275
The opportunity name of the case opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The alternate unique identifier of the case opportunity.
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.
Root Schema : cases-caseOpportunities-item-response
Type:
Show Source
object
-
CaseId: integer
(int64)
Title:
Case ID
The unique identifier of the case. -
CaseNumber: string
Title:
Case Number
Read Only:true
Maximum Length:30
The alternate unique identifier of the case. -
CaseOpportunityId: integer
(int64)
Title:
Case Opportunity ID
Read Only:true
The unique identifier of the opportunity associated with the case. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the record can be deleted by the current user. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the case opportunity. -
OptyName: string
Title:
Opportunity Name
Maximum Length:275
The opportunity name of the case opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The alternate unique identifier of the case opportunity. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the record can be updated by the current user.
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.
Links
- OpportunityPVO
-
An opportunity is used by a sales organization to track information about a potential sale such as the sales account, key contacts, product interests, and potential revenues.