Get an opportunity rollup
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityRollup/{OptyId}
Request
Path Parameters
-
OptyId(required): integer
The unique identifier of the opportunity.
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
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:
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 : opportunities-OpportunityRollup-item-response
Type:
Show Source
object
-
CallsMade: number
Title:
Total Calls Made
Read Only:true
The total number of outbound calls made in context of the opportunity. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Read Only:true
Maximum Length:15
The corporate currency code of the note associated with the rollup. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EmailsSent: number
Title:
Total Emails Sent
Read Only:true
The total number of emails sent in context of the opportunity. -
LastCallMadeDate: string
(date-time)
Title:
Last Call Made
Read Only:true
The date when last outbound call was made in context of the opportunity. -
LastCompletedActivity: string
(date-time)
Title:
Last Completed Activity
Read Only:true
The date of last completed activity for an opportunity. Activity includes task, appointment, and call report. -
LastEmailSentDate: string
(date-time)
Title:
Last Email Sent
Read Only:true
The date when last email was sent in context of the opportunity. -
LastTouchDate: string
(date-time)
Title:
Last Touch Date
Read Only:true
The date of last touch in context of the opportunity. A touch refers to an outbound communication such as email sent or phone call made and so on. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row 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. -
NextTaskDue: string
(date)
Title:
Next Task Due
Read Only:true
The date when a task is due for an opportunity. -
NumberOfOpenActivities: number
Title:
Total Open Activities
Read Only:true
The total number of activities that are open for the opportunity. -
NumberOfTouches: number
Title:
Total Touches
Read Only:true
The total number of touches in context of the opportunity. A touch refers to an outbound communication such as email sent or phone call made and so on. -
OptyId: integer
(int64)
Title:
Opportunity Identifier
Read Only:true
The unique identifier of the opportunity. -
TotalCompletedActivities: number
Title:
Total Completed Activities
Read Only:true
The total number of completed activities for an opportunity. -
TotalNotes: number
Title:
Total Notes
Read Only:true
The total number of public notes associated with an opportunity. -
TotalQuotes: number
Title:
Total Quotes
Read Only:true
The total number of quotes for an opportunity.
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.