Platform API

<back to all web services

GetCustomContentViews

Request a list of Custom Content Views for the current licensee of the specified type.

Requires Authentication
The following routes are available for this service:
All Verbs/api/customcontentviews
"use strict";
export class CustomContentViewModel {
    /** @param {{ContentViewId?:string,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of the Custom Content View. */
    ContentViewId;
    /**
     * @type {string}
     * @description Name of the Custom Content View. */
    Name;
}
export class GetCustomContentViewsResponse {
    /** @param {{Views?:CustomContentViewModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CustomContentViewModel[]} */
    Views;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetCustomContentViews {
    /** @param {{RmsTableCtxId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The RmsTableCtxId representing the type of views we are retrieving. */
    RmsTableCtxId;
}

JavaScript GetCustomContentViews DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/customcontentviews HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RmsTableCtxId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Views":[{"ContentViewId":"00000000-0000-0000-0000-000000000000","Name":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}