Reporting REST API Documentation

ReportingDefinitionResource

Returns a list of existing reporting definitions.

GET

URI /services/apexrest/ffr/v1.0/definitions/*
Description
  • HTTP GET request: /services/apexrest/ffr/v1.0/definitions
    Returns a list of existing reporting definitions.
  • HTTP GET request: /services/apexrest/ffr/v1.0/definitions/{id}
    Retrieves the details of an existing reporting definition. Returns an error if an invalid identifier is used.

Sample Code


HTTP GET request: /services/apexrest/ffr/v1.0/definitions

Raw Response
HTTP/1.1 200 OK
Date: Tue, 15 Mar 2016 10:38:25 GMT
Set-Cookie: BrowserId=eUHlNJG0RDiTptfoAigmsw;Path=/;Domain=.salesforce.com;Expires=Sat, 14-May-2016 10:38:25 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Content-Type: application/json
Content-Encoding: gzip
Transfer-Encoding: chunked


[ {
  "Url" : "/v1.0/definitions/a0A36000001ee0IEAQ",
  "Title" : "FinancialForce Support Report",
  "Queries" : "/v1.0/definitions/a0A36000001ee0IEAQ/queries",
  "Prompts" : [ {
    "Value" : "TFA",
    "Name" : "Which report do you wish to review?",
    "Id" : "a0H36000001VkrGEAS"
  } ],
  "Name" : "TFSA0100000000001",
  "Id" : "a0A36000001ee0IEAQ",
  "Description" : "FinancialForce Support Report. Used to validate how a report has been defined."
} ]


HTTP GET request: /services/apexrest/ffr/v1.0/definitions/a0A36000001ee0IEAQ

Raw Response
HTTP/1.1 200 OK
Date: Tue, 15 Mar 2016 10:41:31 GMT
Set-Cookie: BrowserId=8o-Z5pjcQYaCXqH4OKxlwQ;Path=/;Domain=.salesforce.com;Expires=Sat, 14-May-2016 10:41:31 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Content-Type: application/json
Content-Encoding: gzip
Transfer-Encoding: chunked


{
  "Url" : "/v1.0/definitions/a0A36000001ee0IEAQ",
  "Title" : "FinancialForce Support Report",
  "Queries" : "/v1.0/definitions/a0A36000001ee0IEAQ/queries",
  "Prompts" : [ {
    "Value" : "TFA",
    "Name" : "Which report do you wish to review?",
    "Id" : "a0H36000001VkrGEAS"
  } ],
  "Name" : "TFSA0100000000001",
  "Id" : "a0A36000001ee0IEAQ",
  "Description" : "FinancialForce Support Report. Used to validate how a report has been defined."
}
© Copyright 2009–2019 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.