Reporting REST API Documentation

ActionViewsDataResource

Returns report data from running an action views template. The result contains a list of column names, column types, and column values.

GET

URI /services/apexrest/ffr/v1.0/actionviews/templates/*/result
Description HTTP GET request: /services/apexrest/ffr/v1.0/actionviews/templates/{id}/result?filters=<filters_json>
Retrieves the data from the execution of an action views template. Returns an error if an invalid identifier is used.

Sample Code


HTTP GET: /services/apexrest/ffr/v1.0/actionviews/templates/a0a7F000000sg8rQAA/result

Raw Response

HTTP/1.1 200 OK
Date: Wed, 31 May 2017 14:07:07 GMT
Content-Type: application/json

{
  "Rows" : [ {
    "Values" : [ "0057F000000xpwdQAA", "2017-05-31T14:01:55.000Z", "USD", false, "0057F000000xpwdQAA", "2017-05-31T14:01:55.000Z", "2017-05-31T14:01:57.000Z", "2017-05-31T14:01:57.000Z", "0057F000000xpwdQAA", "a0r7F000000kL5nQAE", "Account", "2017-05-31T14:01:55.000Z" ]
  } ],
  "Inaccessible" : ["ReportingObject__c.SalesforceObjectName__c"],
  "Header" : {
    "Fields" : [ {
      "Type" : "ID",
      "Name" : "ReportingObject__c.Created By ID"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.Created Date"
    }, {
      "Type" : "STRING",
      "Name" : "ReportingObject__c.Currency ISO Code"
    }, {
      "Type" : "BOOLEAN",
      "Name" : "ReportingObject__c.Deleted"
    }, {
      "Type" : "ID",
      "Name" : "ReportingObject__c.Last Modified By ID"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.Last Modified Date"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.Last Referenced Date"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.Last Viewed Date"
    }, {
      "Type" : "ID",
      "Name" : "ReportingObject__c.Owner ID"
    }, {
      "Type" : "ID",
      "Name" : "ReportingObject__c.Record ID"
    }, {
      "Type" : "STRING",
      "Name" : "ReportingObject__c.Name"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.System Modstamp"
    } ]
  }
}


Request example with custom filters
-----------------------------------

Having a filter with a custom value in JSON format:

[
   {
      "FilterId":"a0V7F0000004uMXUAY",
      "FromValue":"EUR"
   }
]

The filters JSON data has to be encoded for the request:

HTTP GET: /services/apexrest/ffr/v1.0/actionviews/templates/a0a7F000000sg8rQAA/result?filters=%5B%7B%22FilterId%22%3A%22a0V7F0000004uMXUAY%22%2C%22FromValue%22%3A%22EUR%22%7D%5D

Raw Response

HTTP/1.1 200 OK
Date: Fri, 04 Aug 2017 09:38:18 GMT
Content-Type: application/json

{
  "Rows" : [ {
    "Values" : [ "0057F000000xpwdQAA", "2017-08-04T14:01:55.000Z", "EUR", false, "0057F000000xpwdQAA", "2017-08-04T14:01:55.000Z", "2017-08-04T14:01:57.000Z", "2017-08-04T14:01:57.000Z", "0057F000000xpwdQAA", "a0r7F000000kL5nQAE", "Account", "2017-08-04T14:01:55.000Z" ]
  } ],
  "Inaccessible" : ["ReportingObject__c.SalesforceObjectName__c"],
  "Header" : {
    "Fields" : [ {
      "Type" : "ID",
      "Name" : "ReportingObject__c.Created By ID"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.Created Date"
    }, {
      "Type" : "STRING",
      "Name" : "ReportingObject__c.Currency ISO Code"
    }, {
      "Type" : "BOOLEAN",
      "Name" : "ReportingObject__c.Deleted"
    }, {
      "Type" : "ID",
      "Name" : "ReportingObject__c.Last Modified By ID"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.Last Modified Date"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.Last Referenced Date"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.Last Viewed Date"
    }, {
      "Type" : "ID",
      "Name" : "ReportingObject__c.Owner ID"
    }, {
      "Type" : "ID",
      "Name" : "ReportingObject__c.Record ID"
    }, {
      "Type" : "STRING",
      "Name" : "ReportingObject__c.Name"
    }, {
      "Type" : "DATETIME",
      "Name" : "ReportingObject__c.System Modstamp"
    } ]
  }
}
© Copyright 2009–2019 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.