Project Detail Retrieval

This guide outlines the process for retrieving detailed information about your projects, including segments and other key metrics, using TextUnited's API

Retrieving detailed information about your projects is crucial for effective project management. Whether you're looking to review the current state of a project, analyze past performance, or prepare for upcoming tasks, having access to comprehensive project details is essential. This guide will walk you through how to retrieve detailed information about your projects, including segments and other key metrics, using TextUnited's API.

Understanding the Importance of Project Details

Access to detailed project information enables you to:

  • Monitor project progress in real-time.
  • Analyze translation quality and efficiency.
  • Plan future projects based on historical data.
  • Make informed decisions regarding project adjustments.

Working with Segments in TextUnited

Segments represent discrete units of text within a document that are translated individually. Managing these segments effectively is crucial for maintaining the integrity and quality of translations. This guide will walk you through how to retrieve segments for a project and work with them using TextUnited's API.

Understanding the Get Segments Endpoint

The "Get Segments" endpoint allows you to fetch segments associated with a specific project. You can filter segments by either the project ID or a custom ID, providing flexibility in how you access segment data.

Project ID

The Project ID refers to the unique identifier assigned to each segment within a project by the TextUnited platform. When you create or import documents into TextUnited for translation, each segment of text is automatically assigned a unique Project ID. This ID is generated by TextUnited and is consistent across all projects and users within the system. Using the Project ID allows you to precisely target and retrieve specific segments from a project, regardless of the project's size or the number of segments it contains.

Custom ID

A Custom ID, on the other hand, is a user-defined identifier that can be assigned to segments during the document setup or import process. Unlike the Project ID, which is automatically generated, Custom IDs must be manually set by the user. This feature offers flexibility in segment management, enabling translators or project managers to categorize or tag segments in ways that best suit their workflow or project requirements. For example, you might assign Custom IDs to segments based on their topic, priority, or any other criteria relevant to your project.

Filtering Segments

When using the "Get Segments" endpoint, you have the option to filter segments by either the Project ID or a Custom ID. This flexibility allows you to tailor your API calls to meet specific needs:

  • Filtering by Project ID: This method is straightforward and efficient for accessing segments based on their unique identifiers assigned by TextUnited. It's ideal for situations where you need to retrieve specific segments without additional categorization.
  • Filtering by Custom ID: Choosing to filter by Custom ID is beneficial when you've organized your segments using user-defined tags or categories. This approach enables you to retrieve segments based on your own classification system, enhancing the precision and relevance of the data you access.

Example Usage

Suppose you have a project with numerous segments, and you're interested in retrieving only those segments related to a specific topic. Instead of searching through all segments, you can use the "Get Segments" endpoint with a Custom ID that represents that topic. This targeted approach saves time and resources, ensuring that you only work with the segments that are most relevant to your current task.

Prerequisites

Before proceeding, ensure you have:

  • API Credentials: If you're using Basic Authentication, get your Company ID and API Key. For Bearer JWT Authentication, you'll need your JWT Access Token. Refer to our guides on Obtaining Your API Key and Company ID and Obtaining JWT Token for details.
  • Understanding of API Basics: Familiarity with RESTful APIs, HTTP methods (GET), and JSON format.

Step-by-Step Guide to Retrieve Project Details

Getting Segments by Project ID

When you need to retrieve specific segments associated with a project, you'll use the "Get Segments by Project ID" endpoint of the TextUnited API. This endpoint allows you to fetch segments based on the project's Project ID, which is automatically generated by TextUnited upon creating a multilingual project using the "Create Multilingual Project" endpoint.

ℹ️

Note

For detailed guides on creating a multilingual project, refer to this guide on Project Initialization.

Step 1: Obtain the Project ID

To obtain the Project ID of your project programmatically, you can use the "Get Projects" endpoint. This endpoint returns a list of your projects, including their IDs. Here's how you can use it:

  • Endpoint: /segments/projects
  • Method: GET
  • Authentication: Include your API credentials in the request headers for authentication.

An example response from the "Get Projects" endpoint might look like this:

[
    {
        "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    },
    {
         "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    },
    {
         "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    }
]

From this response, identify the "id" field corresponding to the project you're interested in retrieving segments for.

Step 2: Construct the API Request

Once you have identified the Project ID of your project, you can construct the GET request to the "Get Segments" endpoint as follows:

GET /segments/projects/{id}/segments

Replace {id} with the actual Project ID of the project you wish to retrieve segments for. For example, if your Project ID is <your_id> (this is a placeholder), the constructed endpoint URL for retrieving segments would be:

GET /segments/projects/<your_id>/segments

This URL instructs the TextUnited API to return all segments associated with the project that has the Project ID .

❗️

Note

Include your API credentials in the request headers for authentication. Here's an example using curl:

curl --request GET \
     --url https://api.textunited.com/segments/projects/<your_id>/segments \
     --header 'Authorization: Bearer <your_api_token>' \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json'

Replace "<your_api_token>" with your actual JWT Access token that can be obtained from calling the Obtain JWT endpoint and replace <your_id>with your Project ID.

ℹ️

Try your Request

You can call the endpoint to retrieve segments associated with the Project ID directly on our documentation platform. Refer to our API Reference for the Get Segments by Project ID endpoint.

👍

Success

Once the request is successful, you'll receive a status code of 200 OK along with your project list.

Example Response

[
    {
        "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    },
    {
         "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    },
    {
         "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    }
]

Optional Query Parameters

The "Get Segments by Project ID" endpoint supports several optional query parameters that can be used to filter the segments returned by the API. Two commonly used parameters are status and taskId.

Status

The status parameter filters segments based on their current translation status. This is particularly useful when you want to focus on segments that are in a specific phase of the translation process, such as completed, in progress, pending, or even failed.

  • Usage: Append status followed by the desired status value to the endpoint URL. For example, to retrieve only the segments that have been completed, you would use:
GET /segments/projects/{id}/segments?status=completed
  • Values: Common status values include completed, InProgress, pending, and failed. The exact set of possible values may vary based on the implementation of the TextUnited API.
TaskId

The taskId parameter allows you to filter segments based on the task they are associated with. Tasks in TextUnited often correspond to specific translation jobs or batches, making this parameter useful for targeting segments related to a particular task.

  • Usage: Append taskId followed by the task ID to the endpoint URL. For example, to retrieve segments associated with a task with the ID <your_task_id> (a placeholder), you would use:
GET /segments/projects/{id}/segments?taskId=<your_task_id>
  • Values: The taskId value corresponds to the unique identifier of a task within the TextUnited system. This ID is typically provided when the task is created or can be obtained from the API response when querying tasks.
Practical Example

If you have a project with the Project ID <project_id>, and you're interested in retrieving only the segments that are currently being translated (InProgress). You could construct the API request as follows:

GET /segments/projects/{<project_id}/segments?status=InProgress

Replace the placeholder {<project_id>} with your project ID. This request would return all segments associated with that specific project ID that are currently in the InProgress status, helping you track the translation progress more closely.

Example Response
[
    {
        "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    },
    {
         "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    },
    {
         "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    }
]

Get Segments by Project ID Parameters

The table below contains detailed descriptions of the parameters used in the 'Get Segments by Project ID' API call, designed to help you understand their roles and how they influence the retrieval of segment data.

Parameter NameData TypeRequired/OptionalDescription
idIntegerRequiredThe primary identifier for a project within the TextUnited system. This integer value uniquely identifies each project and is essential for specifying which project's segments you wish to retrieve.

When you create a project in TextUnited, either through the web interface or via the API, the system automatically assigns this ID.

Data Type: integer($int32), indicating that the ID is a 32-bit signed integer. This range ensures compatibility across various systems and platforms.

Required: Yes, this parameter is mandatory because it specifies the project from which you want to retrieve segments. Without it, the API cannot determine which project's data to return.
statusStringOptionalAn optional query parameter that allows you to filter the segments returned by the API based on their current translation status.

This parameter is useful for narrowing down the results to segments that match specific stages of the translation process, such as those that are completed, InProgress, pending, or failed.

Data Type: string, meaning the value passed for this parameter should be a string that matches one of the predefined status values.

Required: No, this parameter is optional. If not provided, the API will return all segments for the specified project regardless of their status.
taskIdStringOptionalAnother optional query parameter that lets you filter segments based on the task they are associated with.

Tasks in TextUnited often correspond to specific translation jobs or batches, making this parameter useful for targeting segments related to a particular task.

This is particularly helpful when you're interested in segments that belong to a specific translation job but don't necessarily want to filter them by their status.

Data Type: string, indicating that the value for this parameter should be a string representing the task's unique identifier.

Required: No, this parameter is optional. If not provided, the API will return all segments for the specified project, regardless of their association with any specific task.

Get Segments by Project ID Response Fields

This table below contains detailed descriptions of the response fields for 'Get Segments by Project ID', aiding in understanding the structure and data types used to represent segment information in TextUnited.

Field NameData TypeDescription
idinteger($int64)Represents the unique identifier of a segment within a TextUnited project.

This integer value is a 64-bit signed integer, ensuring a wide range of unique values that can accommodate the scale of segments across various projects.

The uniqueness of this ID is crucial for identifying and referencing specific segments within the TextUnited system, facilitating operations such as retrieval, update, or deletion of segment data.
customIdstringRepresents the unique identifier of a segment within an external system.

This field is used to associate segments that were originally created or managed outside of TextUnited with their counterparts within the TextUnited platform.

When a project is imported into TextUnited or when segments are referenced from another translation management system, the customId serves as a bridge between the internal TextUnited segment ID and the external system's segment ID.

This allows for seamless integration and management of translation projects that span multiple platforms or systems.
contentstringRepresents the original text or HTML markup of the segment that requires translation.

This field is crucial as it specifies the exact text that translators will work on.

The presence of HTML markup indicates that the segment may contain formatting elements such as tags, which translators need to preserve in their translations to maintain the original layout and design.
notesstringRepresents additional notes or instructions provided for translators regarding a specific segment within a project.

These notes can include specific guidelines, context, or any other information deemed important for accurately translating the segment.

The inclusion of such notes helps ensure that translators have all the necessary details to produce high-quality translations.
taskIdstringRepresents a custom task ID that was specified during the project creation or update process in TextUnited.

This ID is used to uniquely identify a specific task within a project, which can encompass various translation activities, such as translating documents, editing, proofreading, or post-editing.

The presence of a taskId allows for targeted actions or inquiries regarding a subset of work within a larger project, facilitating more granular project management and tracking capabilities.
languageSpecificNotesArray of SegmentNoteLanguageSpecific objectsRepresents an array of language-specific notes for the segment.

Each note in the array is designed to accommodate different languages, potentially overwriting general notes provided at the segment level.

This feature is particularly useful for projects involving multiple languages, where nuances or specific instructions might differ from one language to another.
languageIdinteger($int64)Represents the unique identifier of the target language for which a language-specific note is provided.

This field is marked as nullable, indicating that it may not be present for every segment, especially if the segment does not require language-specific notes or if the notes apply universally across all languages.
languageCodestringRepresents the ISO 639-1 or ISO 639-2 code of the target language for a segment. This code is used to denote the language in which the segment is translated or needs to be translated.

It is an optional field, meaning it may not be present for every segment, especially if the segment does not require language-specific handling or if the default language of the project is assumed.
notestringWithin each SegmentNoteLanguageSpecific object, the note field contains the content of the language-specific note.

This is a plain text string that can include any specific instructions, cultural considerations, or domain-specific terminology that translators should be aware of when translating the segment into the target language.

The presence of this field allows for highly customized translation instructions that can significantly improve the quality of the translated output.
translationsArray of objects (SegmentProjectSegmentTarget[])Represents an array of translated versions of the source segment.

Each element in the array corresponds to a translation of the original text in a different language.

This collection is designed to accommodate multiple translations per segment, allowing for a comprehensive view of how the text has been translated across various languages.
languageIdinteger($int64)Represents the unique identifier of the language for a translated segment.

In the context of the "Get Segments by Project ID Response Fields", this field is part of the SegmentProjectSegmentTarget object, which describes the translations of the source segment.

Each translated segment is associated with a specific target language, identified by its languageId.
languageCodestringRepresents the language code of the target language for a translated segment.

Language codes are standardized abbreviations that denote a specific language variant.

They are commonly used in internationalization and localization processes to ensure accurate and culturally appropriate translations.

Examples include EN-US for American English, DE-AT for Austrian German, and ES-MX for Mexican Spanish.
contentstringRepresents the original text or HTML markup of the segment that requires translation.

This field is crucial as it specifies the exact text that translators will work on.

In the context of "Translated segment", it refers to the translated version of the original content, presented as plain text or HTML markup, depending on the requirements of the project and the capabilities of the TextUnited platform.
statusstringRepresents the current translation status of a segment.

It provides insights into the processing stage of the segment within the translation workflow.

This field is crucial for tracking the progress of translations and identifying segments that require attention or have been completed.

Getting Segments by Custom ID

When working with TextUnited's API, you might encounter scenarios where you need to retrieve segments associated with a project using a Custom ID instead of the standard Project ID. This can be particularly useful when dealing with projects that have been imported or managed outside of the standard workflow.

Step 1: Construct the API Request

To retrieve segments by Custom ID, you'll construct a GET request to the following endpoint:

GET /segments/projects/custom/{customId}/segments

In this URL, {customId} is a placeholder for the actual Custom ID of the project whose segments you wish to retrieve. Unlike the Project ID, the Custom ID is a string value that you define when creating or importing a project into TextUnited.

How to Replace {customId}
  • Determine the Custom ID of your project. This ID is typically set during the creation or import process of the project within the TextUnited platform. (Refer to this API Reference on "Get Projects" to retrieve the custom ID you defined when creating your project with the "Create Multilingual Project" endpoint.)
  • Copy the Custom ID.
  • Paste the copied Custom ID in place of {customId} in the endpoint URL.

For example, if your project's Custom ID is <your_custom_id> (a placeholder), the constructed endpoint URL for retrieving segments would be:

GET /segments/projects/custom/<your_custom_id>/segments

This URL instructs the TextUnited API to return all segments associated with the project that has the Custom ID <your_custom_id>.

Step 2: Provide Optional Query Parameters

The endpoint supports additional query parameters like status and taskId to further filter the segments returned by the API. These parameters allow you to refine your request based on the current translation status of the segments or their association with specific tasks.

  • status: Filters segments based on their current translation status. Possible values might include completed, inProgress, pending, or failed.

Example usage:

GET /segments/projects/custom/<your_custom_id>/segments?status=InProgress
  • taskId: Allows you to filter segments based on the task they are associated with. This is useful for targeting segments related to a particular translation job or batch.

Example usage:

GET /segments/projects/custom/<your_custom_id>/segments?taskId=<your_task_id

Step 3: Send the Request

With the endpoint URL constructed and any optional query parameters added, you're ready to send the GET request to the TextUnited API. Ensure you include your API credentials in the request headers for authentication.

curl --request GET \
     --url https://api.textunited.com/segments/projects/custom/new-seg-project-customId/segments \
     --header 'Authorization: Bearer <your_api_token>' \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json'

Replace "<your_api_token>" with your actual JWT Access token that can be obtained from calling the Obtain JWT endpoint, and replace <your_custom_id>with your Custom ID.

ℹ️

Try your Request

You can call the endpoint to retrieve segments associated with the Project ID directly on our documentation platform. Refer to our API Reference for the Get Segments by Custom ID endpoint.

Step 4: Handle the Response

Upon successful execution, the API will return a JSON response containing the segments associated with the project, filtered according to the criteria specified in your request.

Example Response

[
   [
    {
        "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    },
    {
         "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    },
    {
         "source": {
            "id": <identifier_of_the_segment>,
            "customId": "<custom_identifier_of_the_segment>",
            "content": "<content_of_the_segment>",
            "notes": "<note_for_the_segment>",
            "taskId": "<identifier_for_the_specific_task>",
            "languageSpecificNotes": "<specific_tasks_for_the_language>"
        },
        "translations": [
            {
                "id": <identifier_for_the_translator>,
                "languageId": <language_identifier>,
                "languageCode": "<language_code>",
                "content": "<translated_content>",
                "status": "<status_of_the_translation>",
                "comments": <comments_added>
            }
        ]
    }
]

Get Segments by Custom ID Parameters

The table below contains detailed descriptions of the parameters used in the 'Get Segments by Custom ID' API call, designed to help you understand their roles and how they influence the retrieval of segment data.

Parameter NameData TypeRequired/OptionalDescription
customIdStringRequiredThe Custom ID of the project. This is a unique identifier assigned to the project when it was created or imported into TextUnited.

It distinguishes the project from others, especially when dealing with multiple projects or when integrating with external systems.
statusStringOptionalFilters segments by their translation status.

This parameter allows you to specify the current state of the segments you wish to retrieve, such as whether they are untranslated, in draft form, automatically translated, pretranslated, fully translated, or proofread.

Possible values include "untranslated", "draft", "automatic", "pretranslated", "translated", "proofread".
taskIdStringOptionalSpecifies a task ID to narrow down the segments. This parameter is useful when you want to retrieve segments associated with a specific translation task. It helps in filtering segments based on the task they belong to, allowing for more targeted retrieval of segment data.

Get Segments by Custom ID Response Fields

This table below contains detailed descriptions of the response fields for 'Get Segments by Custom ID', aiding in understanding the structure and data types used to represent segment information in TextUnited.

Field NameData TypeDescription
idinteger($int64)Represents the unique identifier assigned to a segment within TextUnited.

This integer value is a 64-bit signed integer, ensuring a wide range of unique numbers can be allocated to segments, even as the volume of data grows over time.
customIdstringRepresents the ID of the segment in an external system. This is particularly useful for projects that integrate with or originate from systems outside of TextUnited.

By providing a customId, you can uniquely identify segments that were initially created or managed in another system, facilitating seamless integration and data synchronization between platforms.
contentstringRepresents the original text or HTML markup of a segment within a project operation in TextUnited.

This field contains the actual text that needs to be translated, which could be in plain text format or formatted as HTML, depending on the requirements of the project.
notesstringContains additional notes or instructions provided for translators.

These notes can offer guidance, context, or specific requirements related to the translation of the segment.

They are intended to assist translators in producing accurate and culturally appropriate translations.
taskIdstringRepresents a custom task ID that was specified during the project creation or update process in TextUnited.

This ID is unique to the task and can be used to associate specific segments with particular translation tasks, facilitating easier management and tracking of translation work.
languageIdinteger($int64)Represents the unique identifier of the target language for a segment.

This ID is crucial for specifying which language version of a segment note or content should be considered when uploading or processing translations.

The presence of this field allows for precise control over language-specific operations, ensuring that notes or content are handled appropriately for each language variant.
languageCodestringRepresents the language code of the target language for a segment.

Language codes are standardized abbreviations that denote a specific language variant, such as dialects or regional variations.

This field is essential for specifying the target language for translations and for applying language-specific operations or rules.
notestringContains additional information or guidance for translators regarding a specific segment of text within a project operation.

This can include special instructions, context, or any other relevant details that might aid in the translation process.

The presence of this field suggests that there is room for customization and specificity in how segments are handled, potentially leading to higher quality translations.
translationsArray of objects (SegmentProjectSegmentTarget\[])Represents an array of translated versions of the source segment.

Each item in the array corresponds to a different target language, providing a collection of language codes mapped to their respective translated contents.

This field is crucial for projects involving multiple languages, allowing for the comparison and selection of translations across various languages.
languageIdinteger($int64)Represents the unique identifier of the target language for a translated segment.

This integer value is used to specify the language in which the segment has been translated or is intended to be translated.

The use of a numerical identifier allows for precise and consistent referencing of languages across the system, facilitating efficient data processing and retrieval.
langaugeCodestringRepresents the language code of the target language for a translated segment.

Language codes are standardized abbreviations that denote a specific language variant, facilitating international communication and software localization.

This field is crucial for accurately identifying the language of the translated content, especially in multilingual projects.
contentstringRepresents the translated text or HTML markup for a segment.

This field contains the actual translated output of the segment, which could be plain text or formatted HTML, depending on the original content and the requirements of the translation project.
statusstringRepresents the current translation status of a segment. It provides insights into the processing stage of the segment within the translation workflow.

This field is crucial for tracking the progress of translations and identifying segments that require attention or have been completed.