Breadcrumbs

ApiSegment

A resource or document segment


    FORMAT

    XML
    <ApiSegment>
<SegmentId>2147483647</SegmentId>
<DisplayId>String content</DisplayId>
<BeeSegmentId>32767</BeeSegmentId>
<BeeSubSegmentId>255</BeeSubSegmentId>
<ParentSegmentId>2147483647</ParentSegmentId>
<BeeDocumentId>2147483647</BeeDocumentId>
<SubDocumentId>32767</SubDocumentId>
<SegmentType>255</SegmentType>
<Visibility>255</Visibility>
<IsTranslatable>255</IsTranslatable>
<Labels>String content</Labels>
<Label>String content</Label>
<SourceReferenceId>32767</SourceReferenceId>
<Delimiter>97</Delimiter>
<FormattingFlags>32767</FormattingFlags>
<HasComments>true</HasComments>
<HasConstraints>true</HasConstraints>
<InnerTags>
<SegmentInnerTag>
<Data>String content</Data>
<Description>String content</Description>
<DisplayTagDecoded>String content</DisplayTagDecoded>
<IsReplacementCode>true</IsReplacementCode>
</SegmentInnerTag>
</InnerTags>
<Texts>
<ApiText>
<BeeTextId>2147483647</BeeTextId>
<Text>String content</Text>
<Bookmark>255</Bookmark>
<Locale>String content</Locale>
<Status>255</Status>
<HasHistory>true</HasHistory>
<IndexStatus_>255</IndexStatus>
<IsValidated>true</IsValidated>
<LastEditor_>255</LastEditor>
<LastModification>1999-05-31T11:20:00</LastModification>
<Locked>true</Locked>
<UserId>2147483647</UserId>
<ValidationError>String content</ValidationError>
</ApiText>
</Texts>
<TextComments>
<ApiComment>
<CommentText>String content</CommentText>
<PostedDate>1999-05-31T11:20:00</PostedDate>
<PersonId>2147483647</PersonId>
<Locale>String content</Locale>
<CommentType>32767</CommentType>
</ApiComment>
</TextComments>
</ApiSegment>

     

    PROPERTIES

    ApiSegment

    Represents one segment in the results list

    SegmentId

    The segment id. This is the unique identifier of the segment.

    DisplayId

    A "user friendly" alternative to the segment id. If the resource is a project then this id is a sequential number of the segment inside the containing document (the first segment in the parent document gets number 1, etc.). If segments are segmented (SRX), the id is suffixed like "2-1", "2-2", "2-3" indicating that the second segment was split into 3 constituents. In case that the segment is part of a translation memory or term base, the DisplayId is the same as the SegmentId.

    BeeSegmentId

    Sequential number of the segment inside the containing document (not used for translation memories and term bases)

    BeeSubSegmentId

    Used if a segment is split by SRX segmentation (not used for translation memories and term bases)

    BeeDocumentId

    Each segment belongs to a document which belongs to a project or memory. This is the system wide unique document id. In the case of translation memories, each import is assigned a separate bee document id.

    SubDocumentId

    Used if a document is composed of "sections" such as a slide in Powerpoint. Not used with translation memories.

    SegmentType

    The segment type. Any of these values:

    /// <summary>

    /// The segment contain only texts

    /// </summary>

    Text = 0,

    /// <summary>

    /// The segment contain only tags

    /// </summary>

    Tag = 2,

    /// <summary>

    /// The segment contain only attributes

    /// </summary>

    Attribute = 3,

    /// <summary>

    /// The segment is composed of text and tag or attributes

    /// </summary>

    Mixed = 4,

    /// <summary>

    /// The segment contain a subsegment

    /// </summary>

    SubSegment = 5,

    /// <summary>

    /// The segment contain codes

    /// </summary>

    Code = 6,

    Visibility

    Visiblity of the segment. Any of these values:

    /// <summary>

    /// Not visible

    /// </summary>

    NotVisible = 0,

    /// <summary>

    /// Always visible to user

    /// </summary>

    Visible,

    /// <summary>

    /// Sometimes visible to user (messages, tool tips, etc.)

    /// </summary>

    Dynamic,

    IsTranslatable

    Status of the segment for translation. NotTranslatable = 0, Translatable = 2, Unsure = 1

    Labels

    A serialized version of the labels assigned to this segment.

    Label

    Typically contains the context of the segment. For example: "Heading 1", "Hyperlink", etc.

    SourceReferenceId

    Internal only. Ignore.

    Delimiter

    Delimiter character if the segment text appears between quotes in the original document contents. Used e.g. with HTML or XML pages and attributes where this field contains the quote (single or double) used to delimit the text of the attribute.

    FormattingFlags

    Indicates how the text is encoded inside the original document. This value can be ignored and is used by the system during reconstruction of the translated document.

    HasComments

    Boolean. Indicates whether the segment contains comments.

    HasConstraints

    Boolean. Indicates whether the segment contains width/height constraints.

    InnerTags

    List of inner tags for the segment.

    Data is the data corresponding to the tag

    Description is a description about the tag

    DisplayTagDecoded is how the tag will be represented in the text segment.

    IsReplacementCode true if this tag is used as a replacement code.

    Texts

    Information included when requesting details for a specific segment or for a list of segment with specific locales !

    List of text for the segment.

    BeeTextId is the text identifier

    Text is the value of the text

    Bookmark indicates if the text has a bookmark. Can be one of theses values:

    None = 0,

    Level1 = 1,

    Level2 = 2,

    Locale is the language of the text

    Status is the current status of the text. Can be one of theses values:

    None = 0,

    Ok = 1,

    Problem = 2,

    HasHistory indicates if the text has an history or not

    IndexStatus_ is one of theses values:

    /// The text is not indexed in the translation memory

    NotIndexed = 0,

    /// The text is indexed

    Indexed = 1,

    /// The text needs to be re-indexed (typically when the text has changed)

    RequiresReindex = 2

    IsValidated true if the text was validated by a revisor or the automatic validation.

    LastEditor_ is one of theses values:

    /// The translation is not supplied

    None = 0,

    /// The translation was provided by a user or last changed by a user

    Human = 1,

    /// Translation memory based identical translation.

    /// The translation was obtained through a pre-translation mechanism. The translation

    /// is supposed to 100% meet the original.

    RefMaterialIdentical = 2,

    /// Translation memory based fuzzy translation.

    /// The translation was obtained through a pre-translation mechanism. The translation

    /// is not 100% correct and requires human interaction.

    RefMaterialFuzzy = 3,

    /// The translation was obtained via a rule based system. E.g. by conversion of

    /// numbers into a localized form.

    RuleBased = 4,

    /// The translation was obtained via a rule based system. E.g. by conversion of

    /// numbers into a localized form.

    MachineTranslation = 5,

    /// The translation came from the previous version of the document. Used in Codyt.

    PreviousVersion = 6,

    /// The translation came from the previous version of the document and matches in-context

    PreviousVersionCtx = 7

    LastModification is not yet implemented

    Locked is the text locked or not.

    UserId is the last user who has modified the text, status or bookmark.

    ValidationError is if the last validation failed, contains a validation error message.

    TextComments

    Information included when requesting details for a specific segment or for a list of segment with specific locales !

    List of comments about the text in the segment.

    CommentText is the comment leave by the user

    PostedDate is the date when the message was submit.

    PersonId is the user who has submit the comment.

    Locale is the language of the comment

    CommentType is used to store multiple boolean flags. Can be one of theses values:

     

    ReadOnly = 1,

     

    PartOfDocument = 2