Services

GetDocumentVersionFileList

GetDocumentVersionFileList
Main
History-Relevant
Rückgabewert
File[]
RET
File (Struct) Array
  
Parameterliste
DocumentId
IN
LONG_NUMERIC_IDENTIFIER
>VERSION.DOCUMENTID
VersionId
IN
LONG_NUMERIC_IDENTIFIER
>FILE.VERSIONID
NamedValueArray
INo
NamedValue[]
  
RealFileName
INo
REALFILENAME_STRING
>FILE.REALFILENAME
FileTypeId
INo
LONG_NUMERIC_IDENTIFIER
>FILE.FILETYPEID
MasterFileFlag
INo
BOOLEAN
>FILE.MASTERFILEFLAG
ViewerFileFlag
INo
BOOLEAN
>FILE.VIEWERFILEFLAG
MediaSubTypeId
INo
LONG_NUMERIC_IDENTIFIER
>FILE.MEDIASUBTYPEID
SortedBy
INo
LONG_STRING (Opt. Multi Content)
Kurzbeschreibung:
Dieser Service retourniert alle Einträge der Tabelle FILE welche zur Dokumentversion gehören.
Einschränkungen über RealFileName sind möglich
Einschränkungen über FileTypeId sind möglich
Einschränkungen über MasterFileFlag ist möglich
Einschränkungen über ViewerFileFlag ist möglich
Einschränkungen über MediaSubTypeId sind möglich
(Sortiert nach FileId, es sei denn, die Sortierung wird mittels SortedBy übersteuert.)
Fehlerhandling/Plausibilisierung:
Generell gelten die Regeln (PK, AK, FK, Unique, NotNull) der Datenbank. Die zusätzlichen Fehler sind:
  • Aufgrund von Validator-Prüfungen (VD)
  • Wenn das Dokument über die DocumentId nicht gefunden wird (1)
  • Wenn keine relevante Version vorliegt (keine Angabe der VersionId) (2)
Bemerkungen:
VD: siehe Validator-Fehler
(1): GetDocNEx
(2): GetDocVrsFileListRvtVrsNEx
Die relevante Version ist:
  • über die VersionId identifiziert (ungleich 0) und wenn die VersionId 0 ist:
    • bei einem ausgecheckten Dokument die CheckoutVersion (sofern CheckoutUserId = Checkout)
    • die Current- oder wenn diese nicht sichtbar ist, die Released-Version des Dokuments
SortedBy
Beim sortedBy-Parameter können mehrere Resultat-Spalten (z.B. Attr1 ascending, Attr2 descending, Attr3 descending) angegeben werden. Die Resultat-Spalten sind dabei durch Komma getrennt.
Die gültigen Sortierungen sind: asc, ascending und desc, descending.