ReportAdd

Top  Previous  Next

SOAP

ReportAdd( aHandle, 

           aUserGroupName, aUserName,         

           aProjectName, aStudyName, 

           &aName, aDescription, aObjType, aTemplate, aParameters, 

           aUseExisting, &aErrorMsg );

 

REST

/ReportAdd?Handle=<value>&UserGroup=<value>&UserLogin=<value>

           &Project=<value>&Study=<value>&Report=<value>&Description

           &ObjType=<value>&Template=<value>&Parameters=<value>&UseExisting=<value>

returns Report, ErrorMsg

 

Description: Creates a new report in the CrashMagic system under the current account and within the current project and study.  If Name already exists for this type of report, a unique name will be created and returned in the Name parameter.

 

aHandle The value created in the call to Login().

aUserGroupName, aUserName - required

aProjectName Is the name of the project that this report will be placed into.

aStudyName Is the name of the study that this report will be placed into.

&aName Is the name for the new report.  This parameter may be changed by the call depending on the value of UseExisting.

aDescription A text description for this report.

aObjType Type of report.  (diagram | chart | list | hcllist | map )

aTemplate The name of a template to base this new report on.  If blank, the Default template will be used.

aParameters A list of parameters to modify the current settings.  If blank, no settings are modified.

aUseExisting If UseExisting is true and a report with the same name and ObjType already exists, with the same parameters and settings, a new study will not be created, and no error will be returned.  If UseExisting is false and a report with the same name already exists, then a unique report name will be created and returned in the Name parameter.

ErrorMsg is populated only if an error occurred that prevented the function from succeeding.  Otherwise, this parameter is empty.

 

Example: ReportAdd( lHandle, "NY@DOT", "Rob", "Project1", "My first study", "A new report", "A report description", "diagram", "Default", "", true,  lErrorMsg );

Example: StudyAdd( lHandle, "NY@DOT", "Rob", "Project1", "Study1", lReport, "Another report", "diagram", "Favorite1", "", false,  lErrorMsg );