Qodex.ai

The LiveSite Content Services (LSCS) REST API Documentation

Number of APIs: 11

LiveSite Content Services provides a rich set of application programming interfaces (APIs) for developing dynamic and interactive Web sites. The primary programming interface for LSCS is a network-based interface that follows the Representational State Transfer (REST) model of client-server interaction using the HTTP or HTTPS protocols. This REST API is neutral with respect to both programming languages and display technologies. This neutrality allows solution developers to use and mix languages and technologies such as Java, C#, PHP, AJAX, Flash, Silverlight, Ruby, JSP, ASP and any other technology that supports HTTP. In addition to the REST API, the product includes a Java client library that builds on the REST API and provides an easy-to-use Java object model for interacting with an LSCS server. This document provides details on the resources, objects and methods provided by both API's.

Authentication

  1. Gets the list of all deployed projects. GET {{baseUrl}}/projects?format=XML

  2. Clients can retrieve the list of all deployed extended attributes, including their type and whether they are faceted or multi-valued, using the metadata-info resource. GET {{baseUrl}}/metadata-info?format=XML

  3. document - Gets document content by using the alphanumeric assetId. GET {{baseUrl}}/document/id/:assetId?project=exercitation id&inlineLoad=true

  4. document - Performs document searches. GET {{baseUrl}}/document?q=exercitation id&fields=exercitation id&lscsText=exercitation id&lscsField=exercitation id&max=33927043.5654576&start=33927043.5654576&sort=exercitation id&showFacet=exercitation id&traverse=exercitation id&streamUnique=false&maxFacet=33927043.5654576&expandMVF=true&project=exercitation id&includeDCRContent=true&format=XML

  5. document - Gets document content by using the area-relative path of a document in TeamSite. GET {{baseUrl}}/document/path/:path?project=exercitation id&inlineLoad=true

  6. contexts-{order} - Gets all deployment contexts for a default project. GET {{baseUrl}}/contexts/:order?format=XML

  7. contexts - Gets all deployment contexts for a default project. GET {{baseUrl}}/contexts

  8. contexts - Use the following resource to get all deployment contexts for a default project by given order (asc or desc) based upon the deployment time. GET {{baseUrl}}/contexts/project/:projectName?format=XML

  9. admin - XML response only. Clients can retrieve the operational status of the LSCS service asset content from LSCS using the admin/status resource. GET {{baseUrl}}/admin/status

  10. admin - XML Response only. Clients can retrieve more detailed diagnostic information using the admin/diags resource. GET {{baseUrl}}/admin/diags