do Reference

Build 1501 on 14/Nov/2017  This topic last edited on: 13/Nov/2014, at 08:38

This chapter describes commands available in do.ashx in the browser interface.

Note

To execute a listed command, you need to have a valid ticket. The typical manual method to get a valid ticket is to connect first and sign in with your credentials, e.g. on http://servername/gn4/int/Page.aspx?config=home. Now you can duplicate the tab if you want, or use the same tab and type http://servername/gn4/int/do.ashx?Cmd=commandname

To get a list of all available commands,  type http://servername/gn4/int/do.ashx?Cmd=Help&x=docbook

To get a short description of a command, e.g. Print command, type http://servername/gn4/do.ashx?Cmd=Help&Name=Audit&X=docbook

In this chapter

AcquireClientSpecLoads a clientSpec and associate it with this login (GET)
AddToUserDictAdds the specified word to the adequate user dictionary (GET)
AlertSends the POSTed alert messages to a logged-in user or system. (POST)
AppEditUIReturns xml for the ui on the mobile device. ObjectUI can be posted. (GET/POST)
AuditExtracts audit trail information (GET)
AuditActionSaves the audit data of an action (GET)
AuditModifiedDateReturns audit modified date (GET)
AuditNavReturns the 'navigation' XML of the audit trail entries matching the specified criteria (GET)
Back4StatusGets the status of a Back4 server (GET)
CacheSearchGetGeneric command to search/get cache informations and data (GET/POST)
CaptchaReturns binary content of a CAPTCHA image. CAPTCHA stays for: completely automated public Turing test to tell computers and humans apart (GET)
CheckLicenseChecks out objects (GET)        
CheckProxyChecks out objects (GET)
ClientGetGets the data of an object to be edited on the client (GET)
ClientGetObjsRetrieves the description of one or more objects to be edited on the client (GET)
ClientPutPuts the data of an object that has been edited on the client, updating it (POST)
ComputeInitObjectComputes the object to be used to initialize attributes based on the context (POST)
ConfigReturns XML configuration data (GET) or create/modify XML configuration data (POST)
CountersExtracts counters information (GET)
CreateObjsCreates new objects (POST)
DataReturns binary data content (GET)
DeleteResultsCacheDeletes result cache. (GET)
ExaleadSuggestionsGets the list of the Exalead tags for the current objectId (GET)
ExePublishCmdExecutes a list of publishing commands. (GET)        
ExportExports all the objects matching the specified searching parameters (POST)
ExportSchemaExports the database Schema (GET)
FeedGenerates a syndication feed, converting one or more objects to XML and returning it (GET/POST)

Get

GetAggregates

GetCombinedObj

GetDataContents

GetDataDesc

GetFromRefs

GetFullTextOpCodes

GetIdsFromRefs

GetMimes

GetObjectInfos

GetObjIdFromKey

GetObjsTypeStr

GetSearch

GetTreePath

Help

HighlightMisspeltWords

Html

Icon

Image

Import

IncCounter

Index

IndexCommit

IndexConfigure

KeywordExists

KeywordsDelete

KeywordSetsClear

KeywordsGet

KeywordsImport

KeywordSuggestions

ListingData

ListTreeObjs

LoadExtraParams

LoadPubModes

LoadTreeNode

Login

LoginAlive

LoginData

Logout

MarkAsRead

MergeWorkflow

ObjCountByType

Objs

ObjsList

ObjsNav

Parse

ParseCoordinate

Partitons

Permissions

PersistentCheck

PlugInDoc

PlugInList

PostCompleteObject

PrepareObject

Publish

Purge

PurgeTasks

Recompute

RemoveLogin

Report

ResolveMultiReference

ResultsCacheLen

RetryTasks

SaveMapParams

SchedPublish

SchedWF

Search

SetSpellCheckerLang

Spike

Strings

StringsDelete

StringsPut

SuggestLanguages

Tasks

TasksLog

TempFile

TempFileAddUpload

TempFileGetUploadInfo

TempFileRemoveUpload

Transform

Tree

TriggerAlert

Triggers

TriggerWF

Uncheck

UncheckForce

Unpublish

Unspike

UpdateDatabase

UpdateObjs

Upload

Version

VersionObj

VersionsRemove

WF

WFCancel

WFCont

WFData

WFInter

Who

See also

edo Reference