;

Skip to main content

 

  • arrow icon
Language Selector

  1. Other Languages

    (machine translation)

 

Planview Customer Success Center

Getting the List of Snapshots in a Portfolio

  1. Last updated
  2. Save as PDF

Example Request URL

PORTID is the portfolio Id of the portfolio for which snapshots are requested. Use detail=full to include the snapshot attributes in the response.

  https://<URL>/HibernateTableService/snapshots/all/ ?codeduser=<user_querystring_token>&portid=<PORTID>&detail=full

Example Response

The response is a JSON with the following structure:

name: "snapshots" - a constant name for the call
totalRows: integer - number of fetched snapshots records
rowData: array of snapshot records.

The snapshot record structure has the following JSON structure:

id: a string of the integer snapshot ID
name: a string of the snapshot name
data: an object with snapshot record data    creator_id: a string of the user id of the snapshot creator
    project_id: a string of the integer project ID
    proj_temp_id: a string of the integer project template ID
    approved: a string if the snapshot is an approved label. "True"/"False" (capitalized!)
    default_data: a string if the snapshot contains default data. "True"/"False" (capitalized!)
    publish_data: a string if the snapshot contains published data. "True"/"False" (capitalized!)
    workspace_data: a string if the snapshot contains data from private changes. "True"/"False" (capitalized!)
    populated: a string if the snapshot is populated or pending refresh. "True"/"False" (capitalized!)
    latest: a string if the snapshot is LPD. "True"/"False" (capitalized!)
    is_public: a string if the snapshot is public. "True"/"False" (capitalized!)
    is_dynamic: a string if the snapshot is dynamic. "True"/"False" (capitalized!)
    locked: a string if the snapshot is locked. "True"/"False" (capitalized!)
    create_time: a string of the creation time. M/D/YYYY hh:mm:ss period
    label_id: a string of the label id. empty if not a label
    latest_label:"0" if not. "1" if latest label snapshot.
    refresh_time: a string of the last refresh end time. M/D/YYYY hh:mm:ss period
    refresh_start: a string of the last refresh start time. M/D/YYYY hh:mm:ss period
    failed: a string if the snapshot has permanently failed refresh. "True"/"False" (capitalized!)
    lnk_cnt: a string of the integer number of N-level links this snapshot participates in (i.e. pointed to as a source of a link).
    proj_temp_version: "0"