Skip to main content

 

Planview Customer Success Center

Reporting Service

POST reports/{reportBn}

Description:

Generate a snapshot (asset) of the report's data in either CSV, JSON or XML file formats. During generation, you will not be able to generate another snapshot using this specific reportBn until the process is complete. 

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/json;charset=UTF-8
  • Content-Type: (Choose one of the following)
    • text/csv;charset=UTF-8
    • application/json;charset=UTF-8
    • application/xml;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/reports/042400000695
Authorization: Basic {your basic auth}
Content-Type: application/json;charset=UTF-8
Accept: application/json;charset=UTF-8

Response:

{
    "assetBn": "040U0000003C",
    "fileFormat": "JSON"
}

 

 

GET reports/{assetBn}

Description:

Get the snapshot data.

Parameters:

  • deleteAsset: A boolean value that will delete the Document Snapshot after you retrieve the data. Default is false

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: */*

Example:

Request:

https://[tenant-end-point]/api/c/reports/040U0000003C
Authorization: Basic {your basic auth}
Accept: */*

Response (CSV):

BAROMETER_NO,NAME,DESCRIPTION,DOMAIN,CONTENT_STATUS,CONTACTS,FIELD_10
ZZ0G00000000,Strategy 1,This is the first test strategy.,Corporate Strategy,Identified,Homer Simpson-Primary,\"This is text from a custom field\"
ZZ0G00000003,Strategy 4,This is the fourth test strategy.,Corporate Strategy,Identified,,

Response (JSON):

[
    {
        "barometerNo": "ZZ0G00000000",
        "name": "Strategy 1",
        "description": "This is the first test strategy.",
        "domain": "Corporate Strategy",
        "contentStatus": "Identified",
        "contacts": [
            {
                "name": "Homer Simpson",
                "qualifier": "Primary"
            }
        ],
        "field10": "\"This is text from a custom field\""
    },
    {
        "barometerNo": "ZZ0G00000003",
        "name": "Strategy 4",
        "description": "This is the fourth test strategy.",
        "domain": "Corporate Strategy",
        "contentStatus": "Identified",
        "contacts": [],
        "field10": null
    }
]

Response (XML):

<?xml version="1.0" encoding="UTF-8"?>
<export>
    <row index="0">
        <field name="Barometer No">
            <value>ZZ0G00000000</value>
        </field>
        <field name="Name">
            <value>Strategy 1</value>
        </field>
        <field name="Description">
            <value>This is the first test strategy.</value>
        </field>
        <field name="Domain">
            <value>Corporate Strategy</value>
        </field>
        <field name="Content Status">
            <value>Identified</value>
        </field>
        <fields name="Contacts">
            <field index="0" name="Homer Simpson" qualifier="Primary"></field>
        </fields>
        <field name="Field 10">
            <value>"This is text from a custom field"</value>
        </field>
    </row>
    <row index="1">
        <field name="Barometer No">
            <value>ZZ0G00000003</value>
        </field>
        <field name="Name">
            <value>Strategy 4</value>
        </field>
        <field name="Description">
            <value>This is the fourth test strategy.</value>
        </field>
        <field name="Domain">
            <value>Corporate Strategy</value>
        </field>
        <field name="Content Status">
            <value>Identified</value>
        </field>
    </row>
</export>

 

 

GET reports/{assetBn}/size

Description:

Get the snapshot's size in bytes.

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: text/plain;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/reports/040U0000003C/size
Authorization: Basic {your basic auth}
Accept: text/plain;charset=UTF-8

Response:

209