abn.GetRevisits

This job returns the revisit entries for the logged-in user in DMS Content format.

Folders are currently not considered.

Additionally, the following parameters can be set to format the returned XML document: RequestType, OutputFormat, Baseparams, Offset, Pagesize, MaxHits, Rights, DateFormat, Variants, FileInfo. The description of these parameters can be found in dms.GetResultList.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

4096 = XML document is UTF-8 encoded; without this flag: UTF-16

[StartTime]

STRING

No

Timestamp for the point in time until which the revisits should be returned. Format: DD.MM.YYYY HH:MM:SS (time specification can be omitted).
Special value 0 (default): all currently existing, not checked-off revisits.

2. Output Parameters

Name Type Dependency Description

[Count]

INT

Optional

Number of revisits

[XML]

BASE64

Optional

Revisits in DMSContent XML format. The following fields are returned:

Object status fields: Number of links; Main type (documents only); Number of pages (documents only); Archiving status (documents only); Checkout status (documents only)

Revisit properties: Time of creation (dbname="set_time"); Time from which the revisit is presented (dbname="firstvisit"); Time of awareness (dbname="lastvisit", see also abn.SetObjRevisitClosed, abn.SetObjRevisitOpen); Note (dbname="infotext"); Confirmation (dbname="osconfirm": 0 = no password expected; 1 = confirmation only by password); User who set up the revisit (dbname="set_user_id")

Index data of the object

3. Return Value

(INT): 0 = Job successful, otherwise error code.

Example: returned XML
<Rowset>
  <Columns>
    <Column object="Grayscale image" type="DOCUMENT" name="links" system="1"
            datatype="INTEGER" dbname="links" ostype="9" size="10">OBJECT_LINKS</Column>
    <Column object="Grayscale image" type="DOCUMENT" name="count" system="1"
            datatype="INTEGER" dbname="anzahl" ostype="9" size="10">OBJECT_COUNT</Column>
    <Column object="Grayscale image" type="DOCUMENT" name="flags" system="1"
            datatype="INTEGER" dbname="flags" ostype="9" size="10">OBJECT_FLAGS</Column>
    <Column object="Grayscale image" type="DOCUMENT" name="lockuser" system="1"
            datatype="INTEGER" dbname="lockuser" ostype="9" size="10">OBJECT_LOCKUSER</Column>
    <Column object="Grayscale image" type="DOCUMENT" name="main_type" system="1"
            datatype="INTEGER" dbname="haupttyp" ostype="9" size="10">OBJECT_MAIN</Column>
    <Column object="Revisit" type="REVISIT" name="set_time" system="1"
            datatype="DATETIME" dbname="set_time" ostype="9" size="10">REV_SET_TIME</Column>
    <Column object="Revisit" type="REVISIT" name="lastvisit" system="1"
            datatype="DATETIME" dbname="lastvisit" ostype="9" size="10">REV_LASTVISIT</Column>
    <Column object="Revisit" type="REVISIT" name="firstvisit" system="1"
            datatype="DATETIME" dbname="firstvisit" ostype="9" size="10">REV_FIRSTVISIT</Column>
    <Column object="Revisit" type="REVISIT" name="osconfirm" system="1"
            datatype="INTEGER" dbname="osconfirm" ostype="9" size="10">REV_OSCONFIRM</Column>
    <Column object="Revisit" type="REVISIT" name="set_user_id" system="1"
            datatype="INTEGER" dbname="set_user_id" ostype="9" size="10">REV_SET_USER_ID</Column>
    <Column object="Revisit" type="REVISIT" name="infotext" system="1"
            datatype="TEXT" dbname="infotext" ostype="X" size="225">REV_INFOTEXT</Column>
    <Column object="Grayscale image" type="DOCUMENT" name="Document type"
            datatype="TEXT" dbname="feld1" ostype="X" size="30">Document type</Column>
    <Column object="Grayscale image" type="DOCUMENT" name="Date"
            datatype="DATE" dbname="datum1" ostype="D" size="10">Date</Column>
    <Column object="Grayscale image" type="DOCUMENT" name="Author"
            datatype="TEXT" dbname="feld2" ostype="X" size="50">Author</Column>
    <Column object="Grayscale image" type="DOCUMENT" name="Source"
            datatype="TEXT" dbname="feld3" ostype="X" size="150">Source</Column>
    <Column object="Grayscale image" type="DOCUMENT" name="Content"
            datatype="TEXT" dbname="feld4" ostype="X" size="150">Content</Column>
  </Columns>
  <Rows>
    <Row id="415">
      <Value>0</Value>
      <Value>1</Value>
      <Value value="2">NOT_ARCHIVABLE</Value>
      <Value value="">UNLOCKED</Value>
      <Value value="1">GRAYSCALE</Value>
      <Value value="1089723507">13.07.2004 14:58:27</Value>
      <Value value="0"/>
      <Value value="1089723600">13.07.2004 15:00:00</Value>
      <Value/>
      <Value value="53">LIEBE</Value>
      <Value>Please review</Value>
      <Value>Drawing</Value>
      <Value>04.09.2002</Value>
      <Value>Liebe</Value>
      <Value>Cave</Value>
      <Value>Bull</Value>
    </Row>
    <Row id="416">
      <Value>0</Value>
      <Value>0</Value>
      <Value value="8">NO_PAGES</Value>
      <Value value="">UNLOCKED</Value>
      <Value value="1">GRAYSCALE</Value>
      <Value value="1089727995">13.07.2004 16:13:15</Value>
      <Value value="0"/>
      <Value value="1089728100">13.07.2004 16:15:00</Value>
      <Value/>
      <Value value="53">LIEBE</Value>
      <Value>Send picture</Value>
      <Value>Anger</Value>
      <Value>05.09.2002</Value>
      <Value>Admin</Value>
      <Value>unknown</Value>
      <Value>Bat</Value>
    </Row>
  </Rows>
</Rowset>