Jump to

• Request
• Response

Get all rollups

get

/crmRestApi/resources/11.13.18.05/rollups

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a rollup using the primary key.
    Finder Variables
    • RollupId; string; The rollup identifier bind variable for the rollup primary key finder.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreatedBy; string; The user who created the rollup.
  • CreationDate; string; The date and time when the rollup was created.
  • Frequency; integer; The refresh frequency of the rollup in units provided by the frequency unit code.
  • FrequencyUnitCode; string; The units used for the refresh frequency.
  • FunctionCode; string; The operator used on the rollup calculation.
  • HierarchyAttribute; string; The attribute used to store the hierarchy value from the rollup.
  • HierarchyFlag; boolean; Indicates whether the rollup has a hierarchy attribute.
  • LastProcessedDate; string; The date and time when the rollup value was last refreshed.
  • LastProcessedStatusCode; string; The status code from the last refresh process.
  • LastSuccessfulRun; string; The date and time that the rollup was last successfully refreshed.
  • LastUpdateDate; string; The date and time when the rollup configuration was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the rollup.
  • LastUpdatedBy; string; The user that last updated the rollup configuration.
  • Name; string; The name given for the rollup.
  • NrtFlag; boolean; Indicates whether the rollup is enabled for Near Real Time Calculation.
  • PublishedDate; string; The date and time when the rollup was published.
  • PublishedFlag; boolean; Indicates whether the rollup is published.
  • RelatedObjectAttribute; string; The attribute from the related object that's used for the rollup calculation.
  • RelatedObjectCode; string; The object type selected as the related object for the rollup.
  • RelationshipCode; string; The relationship between the target and related object.
  • RollupId; string; The unique identifier for the rollup.
  • RollupTypeCode; string; Indicates whether the rollup type is regular or aging.
  • SourceObjectAttribute; string; The attribute used to store the value from the rollup.
  • SourceObjectCode; string; The object type selected as the target object for the rollup.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 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 : rollups

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/rollups-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object rollups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/rollups-item-response"
    }
}

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 : rollups-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the rollup.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the rollup was created.
• Description: string
  Title: Description

  Maximum Length: 400

  The description provided for the rollup.
• ErrorMessage: string
  Title: Error Message

  Read Only: true

  Maximum Length: 4000

  The error message defined for the rollup.
• ExplainabilityEnabledFlag: boolean
  Title: Drill-Down Enabled

  Read Only: true

  Indicates whether rollup drill down is enabled. If a finder is present, then the API returns True for the drill down enabled attribute, and this prompts the client to display the link. If a finder isn't present, then the API returns False for the drill down enabled attribute, and the client won't display the link.
• ExplainabilityMetadata: string
  Title: Drill-Down Metadata

  Read Only: true

  Maximum Length: 2000

  The metadata of all published rollups of a given source object.
• Frequency: integer (int32)
  Title: Calculation Frequency

  Default Value: 1

  The refresh frequency of the rollup in units provided by the frequency unit code.
• FrequencyUnitCode: string
  Title: Calculation Frequency Unit

  Maximum Length: 30

  Default Value: ORA_HOUR

  The units used for the refresh frequency.
• FunctionCode: string
  Title: Aggregation Function

  Maximum Length: 30

  The operator used on the rollup calculation.
• HierarchyAttribute: string
  Title: Hierarchy Rollup Attribute

  Maximum Length: 100

  The attribute used to store the hierarchy value from the rollup.
• HierarchyFlag: boolean
  Title: Hierarchy Rollup

  Maximum Length: 1

  Indicates whether the rollup has a hierarchy attribute.
• LastProcessedDate: string (date-time)
  Title: Last Refreshed Date

  Read Only: true

  The date and time when the rollup value was last refreshed.
• LastProcessedStatusCode: string
  Title: Refresh Status

  Read Only: true

  Maximum Length: 30

  The status code from the last refresh process.
• LastSuccessfulRun: string (date-time)
  Title: Last Successful Refresh

  Read Only: true

  The date and time that the rollup was last successfully refreshed.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the rollup configuration was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the rollup configuration.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the rollup.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 128

  The name given for the rollup.
• NrtFlag: boolean
  Title: Real Time Update

  Maximum Length: 1

  Default Value: false

  Indicates whether the rollup is enabled for Near Real Time Calculation.
• PublishedBy: string
  Title: Published By

  Read Only: true

  Maximum Length: 64

  The user that published the rollup.
• PublishedDate: string (date-time)
  Title: Published Date

  Read Only: true

  The date and time when the rollup was published.
• PublishedFlag: boolean
  Title: Published

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the rollup is published.
• RefreshThreshold: integer (int32)
  Title: Maximum Number of Days for Data Selection

  The maximum number of days in the rolling data selection for activity and interactions rollups.
• RelatedObjectAttribute: string
  Title: Attribute

  Maximum Length: 100

  The attribute from the related object that's used for the rollup calculation.
• RelatedObjectCode: string
  Title: Related Object

  Maximum Length: 128

  The object type selected as the related object for the rollup.
• RelatedObjectFilter: string
  Title: Related Object Filter

  Maximum Length: 1000

  The filter expressions for the related object used in the rollup.
• RelationshipCode: string
  Title: Relationship

  Maximum Length: 100

  The relationship between the target and related object.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 255

  The relationship type based on the relationship between source and related objects.
• RollupId: string
  Title: Rollup ID

  Read Only: true

  Maximum Length: 64

  The unique identifier for the rollup.
• RollupTypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: ORA_REGULAR

  Indicates whether the rollup type is regular or aging.
• SourceObjectAttribute: string
  Title: Rollup Attribute

  Maximum Length: 100

  The attribute used to store the value from the rollup.
• SourceObjectCode: string
  Title: Source Object

  Maximum Length: 128

  Default Value: Account

  The object type selected as the target object for the rollup.

{
    "type":"object",
    "properties":{
        "ExplainabilityEnabledFlag":{
            "title":"Drill-Down Enabled",
            "type":"boolean",
            "description":"Indicates whether rollup drill down is enabled. If a finder is present, then the API returns True for the drill down enabled attribute, and this prompts the client to display the link. If a finder isn't present, then the API returns False for the drill down enabled attribute, and the client won't display the link.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the rollup was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"400",
            "type":"string",
            "description":"The description provided for the rollup.",
            "nullable":true,
            "x-queryable":false
        },
        "HierarchyFlag":{
            "title":"Hierarchy Rollup",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the rollup has a hierarchy attribute.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "RelatedObjectFilter":{
            "title":"Related Object Filter",
            "maxLength":"1000",
            "type":"string",
            "description":"The filter expressions for the related object used in the rollup.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RelatedObjectCode"
                ]
            }
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"255",
            "type":"string",
            "description":"The relationship type based on the relationship between source and related objects.",
            "nullable":true,
            "x-queryable":false
        },
        "PublishedBy":{
            "title":"Published By",
            "maxLength":"64",
            "type":"string",
            "description":"The user that published the rollup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelatedObjectCode":{
            "title":"Related Object",
            "maxLength":"128",
            "type":"string",
            "description":"The object type selected as the related object for the rollup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RefreshThreshold":{
            "title":"Maximum Number of Days for Data Selection",
            "type":"integer",
            "description":"The maximum number of days in the rolling data selection for activity and interactions rollups.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3",
                "dependencies":[
                    "RelatedObjectCode"
                ]
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"128",
            "type":"string",
            "description":"The name given for the rollup.",
            "nullable":false,
            "x-queryable":true
        },
        "RelatedObjectAttribute":{
            "title":"Attribute",
            "maxLength":"100",
            "type":"string",
            "description":"The attribute from the related object that's used for the rollup calculation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RelatedObjectCode"
                ]
            },
            "x-queryable":true
        },
        "RollupTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the rollup type is regular or aging.",
            "nullable":false,
            "default":"ORA_REGULAR",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastProcessedStatusCode":{
            "title":"Refresh Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code from the last refresh process.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object",
            "maxLength":"128",
            "type":"string",
            "description":"The object type selected as the target object for the rollup.",
            "nullable":false,
            "default":"Account",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship",
            "maxLength":"100",
            "type":"string",
            "description":"The relationship between the target and related object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RelatedObjectCode"
                ]
            },
            "x-queryable":true
        },
        "FrequencyUnitCode":{
            "title":"Calculation Frequency Unit",
            "maxLength":"30",
            "type":"string",
            "description":"The units used for the refresh frequency.",
            "nullable":false,
            "default":"ORA_HOUR",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RollupId":{
            "title":"Rollup ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier for the rollup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectAttribute":{
            "title":"Rollup Attribute",
            "maxLength":"100",
            "type":"string",
            "description":"The attribute used to store the value from the rollup.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjAttrLovSwitcher"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the rollup configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the rollup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyAttribute":{
            "title":"Hierarchy Rollup Attribute",
            "maxLength":"100",
            "type":"string",
            "description":"The attribute used to store the hierarchy value from the rollup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "HierarchyFlag"
                ]
            },
            "x-queryable":true
        },
        "FunctionCode":{
            "title":"Aggregation Function",
            "maxLength":"30",
            "type":"string",
            "description":"The operator used on the rollup calculation.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastProcessedDate":{
            "title":"Last Refreshed Date",
            "type":"string",
            "description":"The date and time when the rollup value was last refreshed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NrtFlag":{
            "title":"Real Time Update",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the rollup is enabled for Near Real Time Calculation.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LastSuccessfulRun":{
            "title":"Last Successful Refresh",
            "type":"string",
            "description":"The date and time that the rollup was last successfully refreshed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Frequency":{
            "title":"Calculation Frequency",
            "type":"integer",
            "description":"The refresh frequency of the rollup in units provided by the frequency unit code.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "PublishedDate":{
            "title":"Published Date",
            "type":"string",
            "description":"The date and time when the rollup was published.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "title":"Error Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The error message defined for the rollup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PublishedFlag":{
            "title":"Published",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the rollup is published.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "ExplainabilityMetadata":{
            "title":"Drill-Down Metadata",
            "maxLength":"2000",
            "type":"string",
            "description":"The metadata of all published rollups of a given source object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the rollup configuration was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the rollup.",
            "nullable":true,
            "readOnly":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