Method for Getting Resource Description

To get a resources scheme, execute the request using the "schema" API method (before executing the request determine user token):

curl -X GET --header 'Accept: application/json' '<IP address or DNS name of server>/api/v1/schema/'

Example of response:

{

  "AllSimpleTypesInOut": {

    "name": "AllSimpleTypesInOut",

    "type": "tabular",

    "input": {

      "scalar": [

        {

          "name": "p1",

          "type": "TEXT",

          "source": {

            "name": "SOAP",

            "type": "string"

          }

        },

        {

          "name": "p2",

          "type": "BIGINT",

          "source": {

            "name": "SOAP",

            "type": "boolean"

          }

        },

        {

          "name": "p3",

          "type": "DOUBLE",

          "source": {

            "name": "SOAP",

            "type": "decimal"

          }

        },

        ...

}

The response contains structure of the resources available to API user. Access to resources is set on adding a group of users.

See also:

Server API | Method for Working with Table Resources