Scan

Description of Object

A Scan to be added, modified, or deleted.

Required Input

string DisplayName

Optional Input

String[] AdditionalDomains

String BaseUrl

String[] CheckpointGroupIds

String ExcludeURLsMatching

boolean ExecuteAllClientScripts

boolean FollowDynamicLinks

String ID

boolean IncludeMSOfficeDocs

boolean IncludeOtherDocs

String IncludeURLsMatching

boolean RetestAllPages

StartPage[] StartPages

String UserAgent

 

Code Examples

C#

List<StartPage> startPages = new List<StartPage>();
startPages.Add(new StartPage()
{
    Levels = 1,
    Path = @"/",
    PageLimit = 10
});

List<string> checkpointGroups = new List<string>();
checkpointGroups.Add("CHECKPOINTGROUP_ID");

Scan scan = new Scan()
{
    BaseUrl = "http://www.hisoftware.com/",
    DisplayName = "Scan DisplayName",
    CheckpointGroupIds = checkpointGroups,
    FollowDynamicLinks = true,
    StartPages = startPages,
    AdditionalDomains = new List<string>(),
    RetestAllPages = true,
    UserAgent = "",
    IncludeMSOfficeDocs = true,
    IncludeOtherDocs = true,
    IncludeURLsMatching = "",
    ExcludeURLsMatching = "",
    ExecuteAllClientScripts = true
};

 

Java

Scan myScan = new Scan();
ArrayOfstring additionalDomains = new ArrayOfstring();
additionalDomains.addString("www.example2.com");
myScan.setAdditionalDomains(additionalDomains);
myScan.setDisplayName("Scan DisplayName");
myScan.setBaseUrl("http://www.hisoftware.com/");
ArrayOfstring chkpointGroupIds = new ArrayOfstring();
chkpointGroupIds.addString("CHECKPOINTGROUP_ID");
myScan.setCheckpointGroupIds(chkpointGroupIds);
myScan.setFollowDynamicLinks(true);
ArrayOfStartPage startPages = new ArrayOfStartPage();
StartPage page1= new StartPage();
page1.setPath("/");
startPages.addStartPage(page1);
myScan.setStartPages(startPages);
myScan.setRetestAllPages(true);
myScan.setUserAgent("");
myScan.setIncludeMSOfficeDocs(true);
myScan.setIncludeOtherDocs(true);
myScan.setIncludeURLsMatching("");
myScan.setExcludeURLsMatching("");
myScan.setExecuteAllClientScripts(true);