Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetReportDefinition

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetReportDefinition

 

Gets the report definition by report definition number.

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetReportDefinition

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  ReportDefNo

xs:int

 

Sets number of the report definition.

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetReportDefinitionResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  CategoryNo

xs:int

 

Gets the category number.

â–  FolderNo

xs:int

 

Gets the folder number.

â–  HasChangeableParameters

xs:boolean

 

Returns true if the report definition has changeable parameters.

â–  HasParametersWithoutDefault

xs:boolean

 

Returns true if the report definition has parameters without defaults.

â–¡ Name

xs:string

nillable

Gets the name.

â–  ReportDefNo

xs:int

 

Gets the report definition number.

â–¡ ReportParameters

 

nillable

Gets a list of the report parameters.

≡ WSReportParameterDefinition

 

list nillable


â–  AllowBlank

xs:boolean

 

Allow blank

â–¡ DefaultValue

xs:string

nillable

Default value

â–  IsHidden

xs:boolean

 

Is hidden

â–  IsNullable

xs:boolean

 

Is nullable

â–¡ Label

xs:string

nillable

Label

â–¡ Name

xs:string

nillable

Name

â–¡ ValidParamValues

 

nillable

Valid param values

≡ WSValidParamValue

 

list nillable


â–¡ Label

xs:string

nillable

Gets or sets Label.

â–¡ Value

xs:string

nillable

Gets or sets value.

â–  ReportType

 

 

restriction enum (xs:string)

- ReportTypeNoTemplate (0)

- ReportTypeCategory (1)

- ReportTypeWorkflow (2)

- ReportTypeSystem (3)

Gets report type.

â–  WorkflowProcessNo

xs:int

 

Gets workflow process number.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.