REST API Functions

Functional Justification

see GET,POST,DELETE for function parameters and sample calls

• see API URL Structure for details on URL structures, remember to URL encode function call parameters
• • represents a '+' string as url safe space

Users

users

• GET

  • user=* -
  • show=[session|attr+YourAttribureName|]
  • Uses/Samples
    • no user lists users
    • user = yields user DynaMent report of that user
    • show= assumes current session * session yields session id+username * attr+[#YourAttributeName] yields user & session scope attributes

• POST {should be HTTPS ONLY logins and updates}

  • user=*
  • password=*
  • attr=*
  • value=*
  • op= [set|increase|decrease|add| add-list|concat|truncate|length]
  • Uses/Samples
    • POST user & password plus no active authenticated session then login
    • POST attr & value & op - will perform operation (op) on attribute using specified value * optional other query string values (value-separator, delimiters, inline-function, rule, runtime, set-readonly, set-password, set-nonpersistent, cookie)

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

projectfilter

TBD expose CoaContentFilter

• GET

  • user=* -
  • Uses/Samples
    • 1
    • 2

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

Content-Group

contentgroup

Access to CoaContentGroup and CoaContentGroup Controller from OpenAPI

• GET

  • group=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

###contentgroup-list list of content groups in this project

• GET

  • group=*
  • project=*
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

Content

content

Content Methods all following items are query string now due to parsing conflicts with rewriting

• GET

  • content=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

content-attribute

• GET

  • attr=* -
  • content=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples * *

content-constraints

• GET

  • content=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

content-comments

A convenience method. Comments attribute path is predefined in a declaration or registry global variable.

• GET

  • x=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples

###content-ratings TBD

• GET

  • content=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

content-hits

TBD

• GET

  • content=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

Connectors

search

Query DM Search

• GET

  • x=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

target

List of contents (Target DM), and query parameters

• GET

  • x=* -
  • group=, locale=, constraint=, db-structure= , project=*
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

repository

Repository DM surfacing (TBD)

• GET

  • x=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

rdb

Direct access to rdb connector

• GET

  • x=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

soap

Direct access to SOAP Webservice connector

• GET

  • x=* -
  • Uses/Samples

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

script

Direct access to Script DynaMent

• GET

  • x=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples *
    *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples *
    *

http

Direct access to HTTP Webservice connector

• GET

  • x=* -
  • Uses/Samples *
    *

• POST {should be HTTPS ONLY logins and updates} * *

  • Uses/Samples * *

• DELETE {should be HTTPS ONLY , special security token and role authenticated user} * *

  • Uses/Samples * *