Documentation Center

Fetch Publications Configuration

Fetches a list of Publication Configurations.

Configurations for hidden publications and languages will not appear if the user does not have a permission to access hidden publications. You can specify the combination of query parameters to receive a filtered list of publication configurations.

Request

URI: /v2/content/config?prepared={prepared}&visible={visible}&versioninfo={versioninfo}

HTTP Method: GET

Header params:
  • Accept: [application/json] OR [application/xml]
Query Parameter(s):
  • prepared: could be "true" or "false"(by default). Specifies whether to return a list of Publication Configurations filtered only for prepared publications.
  • visible: could be "true" or "false"(by default). Specifies whether to return a list of Publication Configurations filtered only for visible publications.
  • versioninfo: could be "true" or "false"(by default). Specifies whether to provide timestamp and version information in a return list of Publication Configurations.

Response

Success
  • XML: <configuration> <pub id="LiveContentDoc"> <lang code="en"> <configitem name="title" value="Content Delivery Documentation"></configitem> <configitem name="toc" value="GUID-FEC8FA08-E122-46F2-81CC-2B839CCFEE6C"></configitem> <configitem name="visible" value="visible"></configitem> </lang> <configitem name="standard" value="DITA"></configitem> <configitem name="visible" value="visible"></configitem> <configitem name="default_language" value="en"></configitem> </pub> </configuration>
  • JSON: {"pub":[{"id":"LiveContentDoc", "visible":true, "lang":[{"code":"en", "visible":true, "configitem":[{"name":"title", "value":"Content Delivery Documentation"}, {"name":"toc", "value":"GUID-FEC8FA08-E122-46F2-81CC-2B839CCFEE6C"}, {"name":"visible", "value":"visible"},{"name":"test", "value":"post test"}, {"name":"shortdesc", "value":""},{"name":"prepared", "value":"prepared"}, {"name":"working_status", "value":"unlocked"},{"name":"filter.file", "value":""}, {"name":"filter.file.empty", "value":"1"}]}], "configitem":[{"name":"standard", "value":"DITA"}, {"name":"visible", "value":"visible"}, {"name":"default_language", "value":"en"}]}]}
Failed
  • XML: <result message="Your account does not have the required permission to perform this action." messageKey="unauthorized.noauth" status="FAIL" statusCode="5000"/>
  • JSON: {"statusCode":5000, "messageKey":"unauthorized.noauth", "message":"Your account does not have the required permission to perform this action.", "status":"FAIL", "info":[]}

Permissions

"Use application"

Example

Request:

GET http://example.corp:8080/LiveContent/v2/content/config

Accept: application/xml

Response:

<configuration> <pub id="LiveContentDoc"> <lang code="en"> <configitem name="title" value="Content Delivery Documentation"></configitem> <configitem name="toc" value="GUID-FEC8FA08-E122-46F2-81CC-2B839CCFEE6C"></configitem> <configitem name="visible" value="visible"></configitem> <configitem name="test" value="post test"></configitem> <configitem name="shortdesc" value=""></configitem> <configitem name="prepared" value="prepared"></configitem> <configitem name="working_status" value="unlocked"></configitem> <configitem name="filter.file" value=""></configitem> <configitem name="filter.file.empty" value="1"></configitem> </lang> <configitem name="standard" value="DITA"></configitem> <configitem name="visible" value="visible"></configitem> <configitem name="default_language" value="en"></configitem> </pub> <pub id="DITA_Sample"> <lang code="en-US"> <configitem name="draft" value="no"></configitem> <configitem name="title" value="Knowledge Center Sample Publication"></configitem> <configitem name="toc" value="sample.ditamap"></configitem> <configitem name="visible" value="visible"></configitem> <configitem name="shortdesc" value="This sample illustrates many of the features of Knowledge Center."></configitem> <configitem name="prepared" value="prepared"></configitem> <configitem name="working_status" value="unlocked"></configitem> <configitem name="filter.file" value=""></configitem> <configitem name="filter.file.empty" value="1"></configitem> </lang> <configitem name="standard" value="DITA"></configitem> <configitem name="visible" value="visible"></configitem> <configitem name="default_language" value="en-US"></configitem> </pub> </configuration>