Shared Properties

The following properties are found in most entities: 

 

 

 

 

 

 

 ID 

 

 

 Contains the unique identifier for the entity. This property is used to index all entities. 

 

 

 

 

 name 

 

 

 Contains the readable name of the entity. 

 

 

 

 

 description 

 

 

 Contains a textual description of the entity. 

 

 

 

 

 type 

 

 

 Contains a type identifier for the entity. These are the types currently supported: 

 

 “PROJECT” 

 “REGION” 

 “FILE” 

 

 

 

 

 

 project 

 

 

 Contains the unique identifier for the project that contains the entity. For project entities, this property must have the same value as the “ID” property. 

 

 

 

 

 state 

 

 

 Defines the current state of the entity. It can be one of these values: “COMPLETE”, “PARTIAL” and “ERROR”. 

 

 

 

 

 partial_progress 

 

 

 If the “state” property is set to “PARTIAL”, this property may contain a percentage indicator for the current stage of processing. 

 

 

 

 

 partial_status 

 

 

 If the “state” property is set to “PARTIAL”, this property may contain a readable sentence that describes the current stage of processing. 

 

 

 

 

 error_info 

 

 

 If the “state” property is set to “ERROR”, this property may contain additional information about the error. This property contains a Base64 string. 

 

 

 

 

 file_type 

 

 

 If the “type” property is set to “FILE”, this property contains a more specific type for the entity. The following subsections are dedicated to these types. 

 

 

 

 

 file_size 

 

 

 If the “type” property is set to “FILE”, this property contains the size of the entity’s data in bytes. 

 

 

 

 

 file_folder 

 

 

 If the “type” property is set to “FILE”, this property contains the ID of the folder that contains the entity. The special value “0” means the entity is in the root folder of the project. 

 

 

 

 

 virtual 

 

 

 Can be set to "1" or "0". If set to "1", this signals the application that this entity should be hidden in the User Interface. This property is used in entities that are building blocks for a larger entity.