MENU
    In Practice: Workiva API Sample
    • 1 Minute to read
    • Dark
    • PDF

    In Practice: Workiva API Sample

    • Dark
    • PDF

    Article summary

    Method

    POST

    Endpoint Url Syntax

    <Provide Application Url>/WkReportDataProvider/GetReportData

    Headers

    Key : APIKey

    Value : Authorization Key

    Request Example:

    {
    "ReportCode" : "page filters report1",
    "Lineage" : "File Cabinet\\Planful Training",
    "CubeName" : "RepCube",
    "PageFilters" :
      [
    	{ "DimensionName": "Scenario" , "MemberIds" : [100]},
    	{ "DimensionName": "Reporting" , "MemberIds" : [20]}
      	],
    "ApplyPageFilters" : "true"
    }
    Shell

    Request Example for Workforce:

    {
    "ReportCode" : "WFP Actuals1",
    "Lineage" : "File Cabinet",
    "CubeName" : "Workforce",
    "PageFilters" : [ {
    "DimensionName" : "Employee",
    "MemberIds" : [ 763799,763801,763803,763805]
    } ],
    "ApplyPageFilters" : "true"
    }
    Shell

    Response Example:

    {
      "RowHeaders": [
      [
       {
    "Label": "Balance Sheet",
    "DimensionName": "Account",
    "MemberId": "2"
       }
      ]
      ],
    "ColumnHeaders": [
      [
       {
    "Label": "2018",
    "DimensionName": "Time",
    "MemberId": "2018"
       }
      	]
     	],
    "Data": [
    	[
    "-1217991.666666"
    	]
    	],
    "Status": "Success",
    "StatusMessage": ""
    }
    Shell

    Was this article helpful?