Services

GetDocumentVersionFileMetaDataList

GetDocumentVersionFileMetaDataList
Main
History-Relevant
Rückgabewert
FileMetaData[]
RET
FileMetaData (Struct) Array
  
Parameterliste
DocumentId
IN
LONG_NUMERIC_IDENTIFIER
>VERSION.DOCUMENTID
VersionId
IN
LONG_NUMERIC_IDENTIFIER
>FILE.VERSIONID
Field
IN
LONG_NUMERIC_IDENTIFIER
>FILESMETADATA.FILEID
NamedValueArray
INo
NamedValue[]
  
SequenceNo
INo
REGULAR_NUMERIC_IDENTIFIER
>FILE.REALFILENAME
MetaDataTypeCd
INo
SHORT_NUMERIC_IDENTIFIER
>FILE.FILETYPEID
MetaDataSubType
INo
SHORT_STRING
>FILE.MASTERFILEFLAG
SupressRedundancies
INo
BOOLEAN
SortedBy
INo
LONG_STRING (Opt. Multi Content)
Kurzbeschreibung:
Dieser Service retourniert alle Einträge der Tabelle FILESMETADATA welche zum File gehören.
Einschränkungen über SequenceNo sind möglich.
Einschränkungen über MetaDataTypeCd sind möglich.
Einschränkungen über MetaDataSubType sind möglich.
(Sortiert nach FileId, MetaDataFileId 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
Wird die FileId ungleich 0 mitgegeben, so wird zusätzlich nach dieser FileId eingeschränkt!
SuppressRedundancies bewirkt, dass "doppelte" FileMetaData-Contents unterdrückt werden!
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.