@salesforce/lds-adapters-industries-recordaggregation 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,824 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '61.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  RADFieldFilterOutputRepresentation:
+    description: Represents output for a single filter condition applied on a field.
+    type: object
+    properties:
+      fieldApiName:
+        description: API name of the field used in the filter condition.
+        type: string
+      fieldLabel:
+        description: Display label of the field used in the filter condition.
+        type: string
+      operator:
+        description: Logical operator used in the filter condition.
+        type: string
+      operatorLabel:
+        description: Display name of the logical operator used in the filter condition.
+        type: string
+      recordId:
+        description: ID of the filter condition.
+        type: string
+      sequence:
+        description: Indicates the order in which the filter conditions are applied to filter records of the specified object.
+        type: integer
+      value:
+        description: Filter criteria value used in the filter condition.
+        type: string
+  RADJoinFieldOutputRepresentation:
+    description: Represents join field info on a record aggregation associated object.
+    type: object
+    properties:
+      fieldApiName:
+        description: API name of the field.
+        type: string
+      fieldLabel:
+        description: Label of the field..
+        type: string
+  RADNodeFilterOutputRepresentation:
+    description: Represents all filter logic applied on the record aggregation associated object
+    type: object
+    properties:
+      filterConditions:
+        description: List of filter conditions containing details such as fields, operators, and filtering values.
+        type: array
+        required: false
+        items:
+          type: RADFieldFilterOutputRepresentation
+      filterCriteria:
+        description: A logical expression containing filter conditions, which is used to filter records of the specified object.
+        type: string
+        required: false
+      filterCriteriaDescription:
+        description: Brief summary that explains the filter criteria.
+        type: string
+        required: false
+  RADNodeObjectOutputRepresentation:
+    description: Represents information about the associated object on the Node.
+    type: object
+    properties:
+      apiName:
+        description: API name of the rollup object specified in the record aggregation definition.
+        type: string
+      label:
+        description: Label of the rollup object specified in the record aggregation definition.
+        type: string
+      objectId:
+        description: ID of the rollup object specified in the record aggregation definition.
+        type: string
+  RADNodeOutputRepresentation:
+    description: Represents output for a single Record Aggregation Definition
+    type: object
+    properties:
+      filterDetails:
+        description: List of filter conditions and the filter criteria that are used to filter records of the specified object.
+        type: RADNodeFilterOutputRepresentation
+        required: false
+      nextObjectJoinDetails:
+        description: Name and API name of the join field in the current object that is used to join with the next object.
+        type: RADJoinFieldOutputRepresentation
+        required: false
+      objectDetails:
+        description: Name and API name of the object used in the record aggregation definition.
+        type: RADNodeObjectOutputRepresentation
+      previousObjectJoinDetails:
+        description: Name and API name of the join field in the current object that is used to join with the preceding object.
+        type: RADJoinFieldOutputRepresentation
+        required: false
+      sequence:
+        description: Indicates the order in which the objects are specified sequentially in the record aggregation definition.
+        type: integer
+  RADOutputRepresentation:
+    description: Represents output for a single Record Aggregation Definition
+    type: object
+    properties:
+      aggregationObjects:
+        description: List of objects included in the record aggregation definition. Each item in this collection represents object details, join field details, and filters.
+        type: array
+        items:
+          type: RADNodeOutputRepresentation
+      canEditDefinition:
+        description: Indicates whether the record aggregation definition can be edited (true) or not (false).
+        type: boolean
+      description:
+        description: Description of the record aggregation definition.
+        type: string
+        required: false
+      displayName:
+        description: Display name of the record aggregation definition.
+        type: string
+      message:
+        description: The message returned in the response.
+        type: string
+      status:
+        description: Status of the record aggregation definition.
+        type: string
+      statusCode:
+        description: The HTTP Status Code for this response.
+        type: string
+      recordAggregationDefinitionId:
+        description: The Id of the definition.
+        type: string
+      canDeleteDefinition:
+        description: Indicates whether the record aggregation definition can be deleted (true) or not (false).
+        type: boolean
+      canManageOnDemand:
+        description: Indicates whether on demand record rollup can be managed for the specified record aggregation definition ID (true) or not (false).
+        type: boolean
+        required: false
+      isOnDemandEnabled:
+        description: Indicates whether on demand record rollup is enabled for the specified record aggregation definition ID (true) or not (false).
+        type: boolean
+        required: false
+  RecordAggregationApplicableFieldOutputRepresentation:
+    description: Output representation for applicable field
+    type: object
+    properties:
+      apiName:
+        description: API name of the field.
+        type: string
+      dataType:
+        description: Datatype of the field.
+        type: string
+      label:
+        description: The field label.
+        type: string
+      isCompound:
+        description: Indicates if the specified field is a compound field (true) or not (false).
+        type: boolean
+      isCustom:
+        description: Indicates if the specified field is a custom field (true) or not (false).
+        type: boolean
+        required: false
+  RecordAggregationApplicableObjectOutputRepresentation:
+    description: Output representation for applicable object in record rollups.
+    type: object
+    properties:
+      apiName:
+        description: API name of the object.
+        type: string
+      label:
+        description: Label of the object.
+        type: string
+  RecordAggregationApplicableObjectsOutputRepresentation:
+    description: Output representation for applicable objects in record rollups.
+    type: object
+    properties:
+      message:
+        description: Message associated with the response status code.
+        type: string
+      objects:
+        description: List of objects that can be used in a rollup definition, including
+          the apiName and label attributes.
+        type: array
+        items:
+          type: RecordAggregationApplicableObjectOutputRepresentation
+      statusCode:
+        description: The HTTP Status Code for this response.
+        type: string
+  RecordAggregationAssociatedObjectInputRepresentation:
+    description: Input representation of associated object of a node in record aggregation
+      definition
+    type: object
+    properties:
+      apiName:
+        description: Represents API name of the object used in the record aggregation definition.
+        type: string
+  RecordAggregationCreationInputRepresentation:
+    description: Input representation of record aggregation definition creation api
+    type: object
+    properties:
+      aggregationObjects:
+        description: List of objects included in the record aggregation definition.
+          Each item in this collection represents object details, join field details,
+          and filter conditions.
+        type: array
+        items:
+          type: RecordAggregationNodeInputRepresentation
+      definitionDescription:
+        description: The description of the record aggregation definition.
+        type: string
+        required: false
+      definitionDisplayName:
+        description: The display name of the record aggregation definition.
+        type: string
+  RecordAggregationCreationOutputRepresentation:
+    description: Represents the output for creating Record Aggregation Definition
+    type: object
+    properties:
+      message:
+        description: The message accompanying the HTTP response code.
+        type: string
+      recordAggregationDefinitionId:
+        description: Record aggregation definition ID.
+        type: string
+      statusCode:
+        description: HTTP response code.
+        type: string
+  RecordAggregationDefinitionInputRepresentation:
+    description: Input representation for Generate DPE Input Class
+    type: object
+    properties:
+      definitionId:
+        description: Record Aggregation Definition record id if nothing provided default
+          to ALL
+        type: string
+  RecordAggregationDefinitionPartialUpdateInputRepresentation:
+    description: Input representation for partial update of a Record Aggregation Definition
+    type: object
+    properties:
+      status:
+        description: Status of record aggregation definition.
+        type: string
+        required: false
+      definitionDisplayName:
+        description: The display name of the record aggregation definition.
+        type: string
+        required: false
+      definitionDescription:
+        description: The description of the record aggregation definition.
+        type: string
+        required: false
+      enableOnDemand:
+        description: Indicates whether on demand record rollup must be enabled (true) for the specified record aggregation definition ID, or not (false).
+        type: boolean
+        required: false
+  RecordAggregationDefinitionPartialUpdateOutputRepresentation:
+    description: Output representation for partial update of Record Aggregation Definition
+    type: object
+    properties:
+      message:
+        description: The message accompanying the HTTP response code.
+        type: string
+      statusCode:
+        description: HTTP response code.
+        type: string
+  RecordAggregationEntityApplicableFieldsOutputRepresentation:
+    description: Output representation for Entity Applicable Fields
+    type: object
+    properties:
+      fields:
+        description: List of applicable join fields with the apiName and label attributes.
+          The list of fields is sorted by the apiName.
+        type: array
+        items:
+          type: RecordAggregationApplicableFieldOutputRepresentation
+      message:
+        description: Message returned in response.
+        type: string
+      statusCode:
+        description: The HTTP Status Code for this response.
+        type: string
+      validOperators:
+        description: List of supported operators for the specified field data type.
+        type: object
+        properties:
+          //:
+            type: any
+  RecordAggregationFilterInputRepresentation:
+    description: Input representation of filters of a node in record aggregation definition
+    type: object
+    properties:
+      filterConditions:
+        description: List of filter conditions containing details such as fields,
+          operators, and filtering values.
+        type: array
+        required: false
+        items:
+          type: RecordAggregationFilterRowInputRepresentation
+      filterCriteria:
+        description: A logical expression containing filter conditions, which is used to filter records of the specified object.
+        type: string
+        required: false
+  RecordAggregationFilterRowInputRepresentation:
+    description: Input representation of filter row in filters of record aggregation
+      definition
+    type: object
+    properties:
+      fieldApiName:
+        description: API name of the field used in the filter condition.
+        type: string
+      operator:
+        description: Logical operator used in the filter condition.
+        type: string
+      sequence:
+        description: Indicates the order in which the filter conditions are applied to filter records of the specified object.
+        type: integer
+      value:
+        description: Value compared for the filter
+        type: string
+  RecordAggregationJoinInputRepresentation:
+    description: Input representation of join of a node in record aggregation definition
+    type: object
+    properties:
+      fieldApiName:
+        description: The API name of the field.
+        type: string
+  RecordAggregationNodeInputRepresentation:
+    description: Input representation of a node in record aggregation definition
+    type: object
+    properties:
+      filterDetails:
+        description: List of filter conditions and the filter criteria that are used to filter records of the specified object.
+        type: RecordAggregationFilterInputRepresentation
+        required: false
+      nextObjectJoinDetails:
+        description:
+          Represents the name and API name of the join field in the current object that is used to join with the next object.
+          is used to join with the next object.
+        type: RecordAggregationJoinInputRepresentation
+        required: false
+      objectDetails:
+        description:
+          Represents the name and API name of the object used in the record aggregation definition.
+          definition.
+        type: RecordAggregationAssociatedObjectInputRepresentation
+      previousObjectJoinDetails:
+        description:
+          Represents the API name of the join field in the current object that is used to join with the preceding object.
+          used to join with the preceding object.
+        type: RecordAggregationJoinInputRepresentation
+        required: false
+      sequence:
+        description: The position of the current object in the record aggregation definition.
+          definition.
+        type: integer
+  RecordAggregationUpdationInputRepresentation:
+    description: Input representation of record aggregation definition updation api
+    type: object
+    properties:
+      aggregationObjects:
+        description: List of objects included in the record aggregation definition.
+          Each item in this collection represents object details, join field details,
+          and filters.
+        type: array
+        items:
+          type: RecordAggregationNodeInputRepresentation
+      definitionDescription:
+        description: The description of the record aggregation definition.
+        type: string
+        required: false
+      definitionDisplayName:
+        description: The display name of the record aggregation definition.
+        type: string
+      status:
+        description: Status of the record aggregation definition.
+        type: string
+        required: false
+  RecordAggregationUpdationOutputRepresentation:
+    description: Represents the output for updating Record Aggregation Definition
+    type: object
+    properties:
+      message:
+        description: Message associated with the response status code.
+        type: string
+      statusCode:
+        description: The HTTP Status Code for this response.
+        type: string
+  RecordRollupResultColumnOutputRepresentation:
+    description: Represents the output for fetching Record Rollup Results
+    type: object
+    properties:
+      displayFormatType:
+        description: The data type of the field representing this column. This data
+          type corresponds to the type which the lightning data table understands.
+        type: string
+      fieldApiName:
+        description: Api Name of the field representing the column.
+        type: string
+      fieldLabel:
+        description: Label of the field representing the column.
+        type: string
+      sequence:
+        description: The sequence in which the column should appear in the data table.
+        type: integer
+      isRedirectionEnabled:
+        description: Indicates whether clicking on the column label redirects to the relevant record details page (true) or not (false). This field is applicable only to the Name field.
+        type: boolean
+      isTypeName:
+        description: Indicates whether the field is of type Name (true) or not (false).
+        type: boolean
+      isSortable:
+        description: Indicates whether the column is sortable (true) or not (false).
+        type: boolean
+      sortByField:
+        description: Represents the field using which the column is sorted.
+        type: string
+  RecordRollupResultInputRepresentation:
+    description: Input representation for fetching record aggregation result
+    type: object
+    properties:
+      isSortOrderAscending:
+        description: Indicates whether the sort order is set as ascending (true) or
+          not (false).The default value is set as descending when sortBy is not assigned
+          any value.
+        type: boolean
+        required: false
+      sortBy:
+        description: Criteria to sort the record rollup results. The default value
+          is CreatedDate.
+        type: string
+        required: false
+  RecordRollupResultOutputRepresentation:
+    description: Represents the output for fetching Record Rollup Results
+    type: object
+    properties:
+      columns:
+        description: List of fields that are represented as columns of a table.
+        type: array
+        items:
+          type: RecordRollupResultColumnOutputRepresentation
+      definitionDisplayName:
+        description: The display name of the record aggregation definition.
+        type: string
+      message:
+        description: The message accompanying the HTTP response code.
+        type: string
+      rows:
+        description: List of rolled up records that are represented as rows of a table.
+        type: array
+        items:
+          type: RecordRollupResultRowOutputRepresentation
+      statusCode:
+        description: The HTTP response code.
+        type: string
+      totalResultCount:
+        description: The total number of record rollup results.
+        type: integer
+      lastUpdatedDetails:
+        description: The information about the last time the record rollup results were updated for the specified definition and anchor record ID.
+        type: RecordRollupResultLastUpdatedDetailsOutputRepresentation
+        required: false
+  RecordRollupResultLastUpdatedDetailsOutputRepresentation:
+    description: Represents the last updated information of the record rollup results.
+    type: object
+    properties:
+      errorType:
+        description: The type of error encountered while fetching the last updated record rollup definition details.
+        type: string
+        required: false
+      epochTime:
+        description: The epoch timestamp in milliseconds when the record rollup results were last updated for the specified definition and anchor record ID.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+        required: false
+      processingMode:
+        description: The record rollup mode which generated the last updated details - Batch or On-Demand.
+        type: string
+        required: false
+  RecordRollupDefinitionLastUpdatedDetailsOutputRepresentation:
+    description: Represents the last updated information of the record rollup results.
+    type: object
+    properties:
+      errorType:
+        description: The type of error encountered while fetching the last updated record rollup definition details.
+        type: string
+        required: false
+      epochTime:
+        description: The epoch timestamp in milliseconds when the record rollup results were last updated for the specified definition and anchor record ID.
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+        required: false
+      processingMode:
+        description: The record rollup mode which generated the last updated details - Batch or On-Demand.
+        type: string
+        required: false
+  RecordRollupResultRowOutputRepresentation:
+    description: Represents the output for fetching Record Rollup Results
+    type: object
+    properties:
+      rowData:
+        description: A map of key value, where key is the column api name, and value
+          is the object’s raw value.
+        type: object
+        properties:
+          //:
+            type: any
+  BulkRecordRollupDefinitionDetailsInputRepresentation:
+    description: Input representation of bulk record rollup definition details api
+    type: object
+    properties:
+      anchorRecordId:
+        description: ID of the record to which the aggregated records are rolled up.
+        type: string
+      recordAggregationDefinitionIds:
+        description: List of unique record aggregation definitions for which the details
+          must be fetched.
+        type: array
+        required: false
+        items:
+          type: string
+      recordAggrDefDeveloperNames:
+        description:
+          List of unique record aggregation definition developer names for which the details must be fetched.
+          must be fetched.
+        type: array
+        required: false
+        items:
+          type: string
+  BulkRecordRollupDefinitionDetailsOutputRepresentation:
+    description: Represents the output for Bulk Record Rollup Definition Details
+    type: object
+    properties:
+      definitions:
+        description: Details of the definitions that were processed during bulk request.
+        type: array
+        items:
+          type: RecordRollupDefinitionDetailsOutputRepresentation
+      errors:
+        description: If true, one or more of the operations in the bulk request didn't
+          complete successfully.
+        type: boolean
+      message:
+        description: The message associated with the HTTP response.
+        type: string
+      statusCode:
+        description: Code that indicates the success, client errors, server errors,
+          or other outcomes of the request.
+        type: string
+  BulkRecordRollupSyncExecutionInputRepresentation:
+    description: Input representation of each part in the bulk record rollup sync execution request.
+    type: object
+    properties:
+      definitions:
+        description: List of definition details for which record rollup must be refreshed.
+        type: array
+        items:
+          type: RecordRollupSyncExecutionInputRepresentation
+  RecordRollupSyncExecutionInputRepresentation:
+    description: Input representation of record rollup sync execution request in bulk record rollup sync execution request
+    type: object
+    properties:
+      id:
+        description: The record aggregation definition ID for which rollup results must be refreshed.
+        type: string
+      anchorRecordId:
+        description: ID of the record to which the aggregated records are rolled up.
+        type: string
+  BulkRecordRollupSyncExecutionOutputRepresentation:
+    description: Represents the output for Bulk Record Rollup Sync Execution
+    type: object
+    properties:
+      definitions:
+        description: Details of the definitions that were processed in the bulk request.
+        type: array
+        items:
+          type: RecordRollupSyncExecutionOutputRepresentation
+      errors:
+        description: If true, one or more of the operations in the bulk request didn't
+          complete successfully.
+        type: boolean
+      message:
+        description: The message associated with the HTTP response.
+        type: string
+      statusCode:
+        description: Code that indicates the success, client errors, server errors,
+          or other outcomes of the request.
+        type: string
+  RecordRollupDefinitionDetailsOutputRepresentation:
+    description: Represents the output for Single Record Rollup Definition Details
+    type: object
+    properties:
+      error:
+        description: Additional information about the failure while fetching definition
+          details.
+        type: RecordRollupDefinitionDetailsErrorOutputRepresentation
+        required: false
+      id:
+        description: The id of the record aggregation definition.
+        type: string
+        required: false
+      isOnDemandEnabled:
+        description: Indicates whether on demand capability is enabled for the definition
+          (true) or not (false).
+        type: boolean
+        required: false
+      lastUpdatedDetails:
+        description: The information about the last time the record rollup results were updated for the specified definition and anchor record ID.
+        type: RecordRollupDefinitionLastUpdatedDetailsOutputRepresentation
+        required: false
+      name:
+        description: The display name of the definition.
+        type: string
+        required: false
+      resolvedAnchorId:
+        description: The resolved anchor record ID will always be the anchorRecordId
+          passed in the request except the case where the anchorRecordId is of Account
+          and the Rollup definition has PartyRelationshipGroup as the target object.
+        type: string
+        required: false
+      status:
+        description: The HTTP status code to get the definition’s details.
+        type: string
+      developerName:
+        description: The developer name of the record aggregation definition.
+        type: string
+        required: false
+  RecordRollupDefinitionDetailsErrorOutputRepresentation:
+    description: Represents the errors while fetching record aggregation definition
+      details
+    type: object
+    properties:
+      message:
+        description: The message associated with the error type.
+        type: string
+      type:
+        description: The type of error, such as VALIDATION_ERROR, SUPPRESS_ERROR,
+          and so on.
+        type: string
+  RecordRollupSyncExecutionOutputRepresentation:
+    description: Represents the output of Record Rollup Sync Execution of Single Definition
+    type: object
+    properties:
+      error:
+        description: Additional information about the failed sync execution of the
+          record rollup definition, such as error type and message.
+        type: RecordRollupSyncExecutionErrorOutputRepresentation
+        required: false
+      id:
+        description: The ID of the record aggregation definition.
+        type: string
+      status:
+        description: The HTTP status code for the definition’s sync execution.
+        type: string
+  RecordRollupSyncExecutionErrorOutputRepresentation:
+    description: Represents the errors during record rollup sync execution
+    type: object
+    properties:
+      message:
+        description: The message associated with the error type.
+        type: string
+      type:
+        description: The type of error, such as VALIDATION_ERROR, DML_GUARDRAIL_ERROR,
+          and so on.
+        type: string
+
+/connect:
+  /record-aggregation:
+    post:
+      displayName: postRecordAggregationCreation
+      description: API to create a Record Rollup Definition
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecordAggregationCreationOutputRepresentation
+      body:
+        application/json:
+          type: RecordAggregationCreationInputRepresentation
+          (oas-body-name): recordAggregationPostInput
+    /bulk-record-rollup:
+      /details:
+        post:
+          displayName: postBulkRecordRollupDefinitionDetails
+          description: Get the details for a list of record aggregation definitions that are rolled up to the specified anchor record ID.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: BulkRecordRollupDefinitionDetailsOutputRepresentation
+          body:
+            application/json:
+              type: BulkRecordRollupDefinitionDetailsInputRepresentation
+              (oas-body-name): bulkRecordRollupDefinitionDetailsInput
+      /sync-execution:
+        post:
+          displayName: postBulkRecordRollupSyncExecution
+          description: Process record rollup definitions in bulk immediately upon request.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: BulkRecordRollupSyncExecutionOutputRepresentation
+          body:
+            application/json:
+              type: BulkRecordRollupSyncExecutionInputRepresentation
+              (oas-body-name): bulkRecordRollupSyncExecutionInput
+    /utilities/applicable-objects:
+      get:
+        displayName: getRecordAggregationApplicableObjects
+        description: Get a List of Applicable Objects for Record Rollups
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecordAggregationApplicableObjectsOutputRepresentation
+    /utilities/applicable-objects/{objectName}/applicable-fields:
+      get:
+        displayName: getRecordAggregationEntityApplicableFields
+        description: API to list all applicable fields of an object in RA framework
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecordAggregationEntityApplicableFieldsOutputRepresentation
+      uriParameters:
+        objectName:
+          description: Name of the object from which the applicable fields are retrieved.
+          type: string
+          required: true
+    /{recordAggregationDefinitionId}:
+      get:
+        displayName: getRecordAggregationDefinition
+        description: Get Record Aggregation Definition detail
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RADOutputRepresentation
+      patch:
+        displayName: patchRecordAggregationDefinition
+        description: Patch Resource method to partially update Record Aggregation
+          Definition
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecordAggregationDefinitionPartialUpdateOutputRepresentation
+        body:
+          application/json:
+            type: RecordAggregationDefinitionPartialUpdateInputRepresentation
+            (oas-body-name): recordAggregationPatchInput
+      put:
+        displayName: putRecordAggregationDefinition
+        description: API to update data in Record Aggregation framework entities
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecordAggregationUpdationOutputRepresentation
+        body:
+          application/json:
+            type: RecordAggregationUpdationInputRepresentation
+            (oas-body-name): recordAggregationPutInput
+      delete:
+        displayName: deleteRecordAggregationDefinition
+        description: Delete Record Aggregation Definition
+        responses:
+          '200':
+            description: Success
+      uriParameters:
+        recordAggregationDefinitionId:
+          description: ID of the Record Aggregation Definition
+          type: string
+          required: true
+    /{recordAggregationDefinitionId}/record-rollup-results:
+      post:
+        displayName: postGenerateRecordRollupResult
+        description: Get Record Aggregation Results API
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecordRollupResultOutputRepresentation
+        queryParameters:
+          anchorRecordId:
+            description: ID of the record to which the grouped records are rolled
+              up to.
+            type: string
+            required: false
+        body:
+          application/json:
+            type: RecordRollupResultInputRepresentation
+            (oas-body-name): recordAggregationResultInput
+      uriParameters:
+        recordAggregationDefinitionId:
+          description: ID of the record aggregation definition.
+          type: string
+          required: true