getContentBoardWithHttpInfo method

Future<Response> getContentBoardWithHttpInfo({
  1. String? status,
  2. String? project,
  3. String? doctype,
  4. int? limit,
})

Aggregates the caller org's marketing content across every publishable content type into ONE queue board — the cross-type read the framework's per-DocType list cannot give.

Aggregates the caller org's marketing content across every publishable content type into ONE queue board — the cross-type read the framework's per-DocType list cannot give. It never fails on a partial outage: a content type the org has not installed, or one whose search errors, is skipped and logged rather than failing the whole board.

Note: This method returns the HTTP Response.

Parameters:

  • String status: Status keeps only items in one lifecycle state (draft, in_review, approved, queued, published, archived). An undefined state is refused.

  • String project: Project keeps only items in one brand/site sub-scope.

  • String doctype: DocType keeps only one content type; omitted, the board spans every publishable type. An unknown type is refused.

  • int limit: Limit caps the rows returned, clamped to 1000. Defaults to 200, which is also what a non-positive or unparseable value takes.

Implementation

Future<Response> getContentBoardWithHttpInfo({ String? status, String? project, String? doctype, int? limit, }) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/content/board';

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (status != null) {
    queryParams.addAll(_queryParams('', 'status', status));
  }
  if (project != null) {
    queryParams.addAll(_queryParams('', 'project', project));
  }
  if (doctype != null) {
    queryParams.addAll(_queryParams('', 'doctype', doctype));
  }
  if (limit != null) {
    queryParams.addAll(_queryParams('', 'limit', limit));
  }

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}