Difference between revisions of "Integration/Content source"

From TempusServa wiki
Jump to navigation Jump to search
old>Admin
old>Admin
Line 42: Line 42:
   .../cmsinterface?q=mylist&v=2
   .../cmsinterface?q=mylist&v=2


Will fetch a list of data and display page 2.
Will fetch a list of data and display page 2, because '''2''' is injected into '''PageNr'''.  


Parameters and values are injected directly into the http request.
Parameters and values are injected directly into the http request.

Revision as of 11:12, 30 December 2017

THIS ARTICLE IS UNDER DEVELOPMENT

Setting up a content source

THIS ARTICLE IS UNDER DEVELOPMENT

It is obvious how many parameters work

  • Related solution
  • Max cache age
  • Is active

Unique NAME

This is the calling name of the interface, that must be provided accessing the content service.

Example for calling the view myview

  ... /cmsservice?q=myview& ...

Query command

Relevant commands include

  • General records
    • list: List of records
    • show: Single record
  • HTML formatted views
    • heat: Heatmaps
    • gant: Gant charts
    • xtab: Pivot tables
    • calm: Calendar

Query parameters

THIS ARTICLE IS UNDER DEVELOPMENT

Dynamic parameter

This specifies a parameter that will be set by the value provided in the v parameter.

Example: Using this interface

 Unique NAME: mylist
 Query command: list
 Dynamic parameter: PageNr

Making a call to

 .../cmsinterface?q=mylist&v=2

Will fetch a list of data and display page 2, because 2 is injected into PageNr.

Parameters and values are injected directly into the http request.

Using a content source

THIS ARTICLE IS UNDER DEVELOPMENT

Calling the cmsinterface servlet will provide you with an overview on how to use it.

Example:

  https://www.acme.com/TempusServa/cmsinterface

The interface requires just the name of the source, but additional parameters can be provided.

Parameters

  • q: Name of the interface (required)
    • This name must match "Unique NAME"
  • f: Format of the result (optional)
    • Valid values: html json xml
  • v: Parameter for dynamic values (optional)
    • The value will be substituted to the parameter in "Dynamic parameter"

Example:

  https://www.acme.com/TempusServa/cmsinterface?q=mysource&f=json