Functions

Gets information about functions of a context. The response contains the list of functions. You can use an optional parameter to include input and output information in the response.

Request

GET /v1/contexts/{contextPath}/functions

Replace {contextPath} with a full context path.

For the Root Context, use server as {contextPath}.

Request Header Fields

  • Authorization — Authentication token. For more information about authentication, see Authenticating.

Request Parameters

  • includeFormat — Optional parameter. Include format information in the response. This information is provided in the inputFormat and outputFormat fields. Possible values: true, false.

Response Body

List of functions of a context. Each record contains information about a function.

Response Body Fields

  • name — Function name.

  • group — Function group.

  • concurrent — Whether multiple calls of this function can work concurrently.

  • inputFormat — Input format of the function.

  • outputFormat — Output format of the function.

Example Request

Request:

   GET https://localhost:8443/rest/v1/contexts/users.admin.devices.virtual/functions?includeFormat=false

Example response body JSON:

    [
        {
            "name": "updateVariable",
            "group": "system",
            "concurrent": true,
            "inputFormat": null,
            "outputFormat": null
        },
        {
            "name": "initAction",
            "group": null,
            "concurrent": true,
            "inputFormat": null,
            "outputFormat": null
        }
    ]

Was this page helpful?