Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Performs a status check of the component in Aspire, the output depends on the type of check.

...

Rest_endpoint
MethodGET
URLaspire?cmd=check
  • Headers
    • Parameter
      summaryOnly if security is enabled
      default
    • aspire-session-id=

...

    • SESSION_COOKIE
      nameSet-Cookie

...

  • Parameters:

    ...

      • Parameter
        nametype
        requiredtrue
        • Parameter
          summary
        • Checks connection to

    ...

        • NonSQL database
          namenonSQL
        • Parameter
          summaryChecks connection to Aspire

    ...

        • nameconnection
        • Parameter
          summaryChecks the Aspire version
          nameserverVersion
      • Parameter
        summary
      • if 1, the response will be JSON instead of XML.
        default0
        namejson

    Output:

    • If security is enabled, a new aspire-session-id cookie will be returned along the regular response.

    Code Block
    languagexml
    firstline1
    titlenonSQL
    collapsetrue
    <result application="/aspire" outcome="ok" server="http://localhost:50505">
       <params>
          <param name="servlet_scheme">http</param>
          <param name="cmd">check</param>
          <param name="type">nonSQL</param>
       </params>
       <check>true</check>
    </result>

    ...

    Code Block
    languagegroovy
    firstline1
    titleJson Output
    linenumberstrue
    collapsetrue
    {
      "result": {
        "params": {
          "param": [
            {
              "@name":"servlet_scheme",
              "$": "http"
            },
            {
              "@name":"json",
              "$": "1"
            },
            {
              "@name":"cmd",
              "$":"check"
            },
            {
              "@name":"type",
              "$":"connection"
            }
          ]
        },
        "check": true,
        "@outcome": "ok",
        "@server":"http://localhost:50505",
        "@application":"/aspire"
      }
    }


    Application Requests

    getAvailableApplications 

    Retrieves information related to the available applications.

    Rest_endpoint
    URLaspire?cmd=getAvailableApplications
    • Headers
      • Parameter
        defaultapplication/x-www-form-urlencoded;charset=UTF-8
        nameContent-Type
        requiredtrue
      • Parameter
        summaryOnly if security is enabled
        defaultaspire-session-id=SESSION_COOKIE
        nameSet-Cookie
    • Parameters:
      • Parameter
        summarytype of the application
        nametype
        requiredtrue
        • Parameter
          summaryGet a list of the available connectors
          nameconnector
        • Parameter
          summaryGet a list of the available publishers
          namepublisher
        • Parameter
          summaryGet a list of the available applications
          nameapplication
        • Parameter
          summaryGet a list of the available big data applications
          namebig_data
        • Parameter
          summaryGet a list of the available services
          nameservice
      • Parameter
        summaryIf true Aspire will force a download the list, otherwise will use the local list
        defaulttrue|false
        namerefresh
        requiredtrue
      • Parameter
        summaryif 1, the response will be JSON instead of XML.
        default0
        namejson


    ·        
    Headers:

    o   'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8'

    o   'Set-Cookie': 'aspire-session-id=<SESSION_COOKIE>'

    §  Only if security is enabled.

    ·         Parameters:

    o   cmd: 'getAvailableApplications'

    o   type: Type of application.

    §  connector: Get a list of the available connectors.

    §  publisher: Get a list of the available publishers.

    §  application: Get a list of the available applications.

    §  big_data: Get a list of the available big data applications.

    §  service: Get a list of the available services.

    o   refresh: true|false. If true Aspire will force a download the list, otherwise will use the local list.

    o   json: 1|0, optional, if 1, the response will be JSON instead of XML.