[]
        
(Showing Draft Content)

Reporting-UserFunctions

Reporting-UserFunctions

[GET] /api/v2/reporting/user-functions

Gets user functions.

Responses

[200] Success

UserFunctionsResponse

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

[PUT] /api/v2/reporting/user-functions

Updates user functions.

Request Body

Description: User functions update request model. For example: { "CSharp": "", "VisualBasic": "" }

Type: application/json

Responses

[204] No Content

[400] Bad Request

ReportingPluginError

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

[POST] /api/v2/reporting/user-functions/build

Builds user functions.

Request Body

Description: User functions build request model.

Type: application/json

UserFunctionsBuildRequest

Responses

[200] Success

UserFunctionsBuildResponse

Type: [text/plain], [application/json], [text/json]

[400] Bad Request

ReportingPluginError

Type: [application/json]

[403] Forbidden

ReportingPluginError

Type: [application/json]

Models

Ƭ UserFunctionsResponse

Response model for UserFunctions.

Name Type Description
language Language
sourceCodeNullable string User functions code.

Ƭ Language

Enum:

  • CSharp
  • VisualBasic

Ƭ ReportingPluginError

Reporting plugin error

Name Type Description
codeNullable string error code
messageNullable string error message
contextNullable string error context

Ƭ UserFunctionsBuildResponse

Response model for building UserFunctions.

Name Type Description
succeeded Boolean Whether a compilation was successful.
compilationInfosNullable Array<CompilationResult> Compilation info.

Ƭ CompilationResult

Name Type
severity Severity
messageNullable string
lineNumber int32
characterNumber int32

Ƭ Severity

Enum:

  • Info
  • Warning
  • Error

Ƭ UserFunctionsBuildRequest

Request model for building UserFunctions.

Name Type Description
languageRequired Language
codeRequired string User functions code.