Data Plan

Query all data plans

get/

Request

Query parameters

includeDocumentboolean

Whether to include each version's version_document. When true, at most 50 versions are returned per plan, and currentPage and pageSize apply to each plan separately. If any plan has more than 50 versions and neither currentPage nor pageSize is passed, the request returns 400 naming those plans.

currentPageinteger

Page of plan versions to return, starting at 1. Only applies when includeDocument=true. Versions are returned newest first: page 1 holds the highest version numbers, and each page lists them in descending version order. Defaults to 1 when only pageSize is passed. A page past the last version returns an empty data_plan_versions list.

pageSizeinteger

Number of plan versions per page, from 1 to 50. Only applies when includeDocument=true. Defaults to 50 when only currentPage is passed. If neither currentPage nor pageSize is passed and the plan has more than 50 versions, the request returns 400.

Response

Data plan list

data_plan_idstring
data_plan_namestring
data_plan_descriptionstring
created_onstring date-time
created_bystring
last_modified_onstring date-time
last_modified_bystring

Changes

    • info

      added the new optional query request parameter currentPage

    • info

      added the new optional query request parameter includeDocument

    • info

      added the new optional query request parameter pageSize

    • info

      added the media type application/json for the response with the status