Differences

This shows you the differences between two versions of the page.

Link to this comparison view

72:scripting_artifact_class [2018/07/24 16:36]
bkkr created
72:scripting_artifact_class [2018/07/25 16:21] (current)
bkkr [ArtifactInstanceClass]
Line 2: Line 2:
  
 ====== ArtifactInstanceClass ====== ====== ArtifactInstanceClass ======
 +
 +It corresponds to a file (artifact instance) in Stages.
 +
 +**ID**
 +
 +   * Type: String
 +  * Documentation:​ Database ID of the artifact instance. Can be used to create a URL
 +
 +**LogicalName**
 +
 +  * Type: String
 +  * Documentation:​ Name of the artifact instance as shown in Stages
 +
 +**PhysicalPrefix**
 +
 +  * Type: String
 +  * Documentation:​ Physical prefix of the file
 +
 +**PhysicalName**
 +
 +  * Type: String
 +  * Documentation:​ Physical name of the file (as stored in the CM system)
 +
 +**FileURL**
 +
 +  * Type: String
 +  * Documentation:​ URL of the artifact in case no CM system is used. URL path in the artifact instance properties.
 +
 +**InstanceContentType**
 +
 +  * Type: String
 +  * Documentation:​ Mime-type of the content
 +      * e.g.
 +        * application/​msword
 +        * application/​vnd.ms-excel
 +
 +**LockedVersion**
 +
 +  * Type: String
 +  * Documentation:​ Version number which is locked for editing
 +
 +**LockerID**
 +
 +  * Type: String
 +  * Documentation:​ ID of the user who locked the artifact instance
 +
 +**Timestamp**
 +
 +  * Type: Date
 +  * Documentation:​ Timestamp of the last modification
 +
 +**WebdavName**
 +
 +  * Type: String
 +  * Documentation:​ Name of the WebDav File found in folder .\tomcat\webapps\pkit\WEB-INF\conf\data\webdav
 +
 +**OpenEditorCount**
 +
 +  * Type: Integer
 +  * Documentation:​ Number of editors which opened the document with WebDav
 +
 +**LocallyModified**
 +
 +  * Type: Boolean
 +  * Documentation:​ Exist local changed in the WebDav storage
 +
 +**ProjectState**
 +
 +  * Type: Integer
 +  * Documentation:​ Returns 1 if the file is marked with "Show in management overview"​ in the properties
 +
 +**SecurityLevelNumber Labels**
 +
 +  * Type: Integer
 +  * Documentation:​ Security level 0-5
 +      * Returns the label of the file
 +
 +**BranchHead**
 +
 +  * Type: Boolean
 +  * Documentation:​ N/A
 +
 +**BranchName**
 +
 +  * Type: String
 +  * Documentation:​ N/A
 +
 +**FileStream**
 +
 +  * Type:  InputSteam
 +  * Documentation:​ Returns an input filestream of the file. Used for birt reports
 +
 +**RevisionIdentifier**
 +
 +  * Type: String
 +  * Documentation:​ Returns the version (revision) of the file
 +
 +**Date**
 +
 +  * Type: Date
 +  * Documentation:​ Returns the last modification date of the file
 +
 +**User**
 +
 +  * Type: String
 +  * Documentation:​ Return the username of the user who checked the file
 +
 +**LogMessage**
 +
 +  * Type: String
 +  * Documentation:​ Check in comment
 +
 +**State**
 +
 +  * Type: String
 +  * Documentation:​ State of the file
 +
 +**Local**
 +
 +  * Type: Boolean
 +  * Documentation:​ N/A
 +
 +**Labels**
 +
 +  * Type: String
 +  * Documentation:​ CMs labels attached to the file
 +
 +**ComponentName**
 +
 +  * Type: String
 +  * Documentation:​ Only for CMSynergy
 +
 +**ComponentReleaseName**
 +
 +  * Type: String
 +  * Documentation:​ Only for CMSynergy
 +
 +**DownloadLink**
 +
 +  * Type: LinkClass
 +  * Documentation:​ Returns a link class with a download link
 +
 +**CheckinLink**
 +
 +  * Type: LinkClass
 +  * Documentation:​ Returns a link class with a checkin link
 +
 +**CheckoutLink**
 +
 +  * Type: LinkClass
 +  * Documentation:​ Returns a link class with a checkout link
 +
 +**RevertLink**
 +
 +  * Type: LinkClass
 +  * Documentation:​ Returns a link class with a revert link
 +
 +**RefreshLink**
 +
 +  * Type: LinkClass
 +  * Documentation:​ Returns a link class with a refresh link
 +
 +**VersionHistoryLink**
 +
 +  * Type: LinkClass
 +  * Documentation:​ Returns a link class with a version history link
 +
 +**ChangeStateLink**
 +
 +  * Type: LinkClass
 +  * Documentation:​ Returns a link class with a change state link
 +
 +**FrozenRevision**
 +
 +  * Type: String
 +  * Documentation:​ Returns the frozen revision of an artifact instance