The xAssets API - Method : SpecialReportCreate

Summary

Run any report into a PDF file, and return the path of the PDF file to the caller

Parameters

Parameter : sXML

Parameter : sArguments

Passing Argument 0 as a query ID or query name is sufficient to run a query that does not expect parameters

0
Action_Or_QueryID

"NEW" to return the XML template needed to create a new asset record

"EDIT" All asset fields

SavedSelectID Run the query with this ID

SavedSelectName Run the query with this name

When argument 0 = NEW or EDIT

1
AssetID
2
FieldList
3
ValueList

When argument 0 implies a query

1
FilterType - "FIXEDLIST", "SINGLEASSET" , "DIRECT", sSqlQuery, sXMLQuery, sQueryName, sTableName, or an AssetID if editing a record
2
RecordIDArray - a CSV array of record IDs
3
Not used
4
Parameters XML
5
Drilldown Level - an integer specifying the level of drilldown to start at
6
Orderby - a CSV list of fields to sort by, optionally with " desc" appended to fields to be sorted descending
7
Page size - the number of rows to display on each page
8
Page wanted - the page number required
9
Tree name - the name of the tree to be displayed at the left of the query. See topic:treenames for more information
10
Tree level - the level of the tree to be displayed at the left of the query
11
Tree current key + ^ + Tree top key - determine the selected node in the tree
12
SubjectID - the subject of this query
13
SpecificationID or Specification XML Name "installedsoftware" etc - only used for queries with a set SpecificationID
14
Editmode - for future use
15
Transform id to run before running the query - not currently supported
16
Tree Options
17
Additional Tree Nodes. Use for HTMLTree function options
18
TreeFilter - the stored procedure to use when filtering records on tree click
19
QueryVariantIndex - specify which query variant to run
20
QueryFilterType
21
QueryFilterName
22
QueryFilterText
23
Filter xml
24
DisplayContext
25
DrillDownMode - 0 (default) - return the whole tree, 1 - return just the children of the level below the key given, 2 - return all children
26
DrillDownKey - 0 return all nodes at the level specified. 1 - return just the children of this key
27
Presentation - TABLE, GROUPEDTABLE, PIE, SOLIDPIE, RING, BAR, BARHORIZONTAL or MAP
28
IncludeFlags - Include the a and b xml tags used by version 6. Default is true

Returns

The relative web path of the newly created PDF file

Syntax and Examples

Restful syntax with Microsoft Visual Basic

Example 1 - Get a PDF file of the All Assets query

There is no restful call for this API operation - use a SOAP method instead

SOAP Syntax with Microsoft Visual Basic

Example 1 - Get a PDF file of the All Assets query


    Try

        ErrorMessage = ""

        Return w.WebSaveSpecial(_hash, _username, _db, _ip, "", "SpecialReportCreate", {"10269"}, False, _dns, _port, _scheme, _nonce, _noncedate)

    Catch ex As Exception
        ErrorMessage = ex.Message
        Return "
    End Try

                            

AMSX Syntax

Example 1 - Get a PDF file of the All Assets query


    SaveSpecial "SpecialReportCreate","", "10269"
                        

XCS Syntax

Example 1 - Get a PDF file of the All Assets query


    Dim ret as String = Server.SaveSpecial("SpecialReportCreate","", "10269")
    If ret = " Or ret.Substring(0, 8) = "special=" Then
        MsgBox("Save operation completed.", vbInformation, "Save Data")
    Else
        MsgBox("Save operation failed:" & ret, vbExclamation, "Save Data")
    End If
                        

Download the Visual Studio API Samples Project

Return to the API Index Page