Jump to

• Request
• Response
• Examples

Find by ID

get

/km/api/v1/tasks/translationTasks/{id}

This method returns the TranslationTask object having the specified translation task ID.

Example URI

The example URI for this method is as follows:

• http://<IM_REST_API_HOST>/km/api/latest/tasks/translationTasks/{id}

  The request returns a TranslationTask object having the specified ID parameter.

Response Errors

The possible error responses for this method are as follows:

• OK-GEN0020

  The error occurs when the contentState request parameter is specified in the request.

• OKDOM-GEN0001

  The error occurs when a TranslationTask does not exist for the specified ID.

Request

Path Parameters

• id: string
  The unique identifier of the object to be retrieved.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : TranslationTask

Match All

Show Source

• allOf TaskData
• object TranslationTask-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/TaskData"
        },
        {
            "properties":{
                "content":{
                    "$ref":"#/definitions/ContentKey",
                    "description":""
                }
            }
        }
    ]
}

Nested Schema : TaskData

Match All

Show Source

• allOf TaskKey
• object TaskData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/TaskKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the task was created or added.</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the task was last modified.</p>"
                },
                "comments":{
                    "type":"string",
                    "description":"<p>This field displays the comments assigned to the task.</p>"
                },
                "priority":{
                    "enum":[
                        "LOW",
                        "MEDIUM",
                        "HIGH",
                        "NONE"
                    ],
                    "description":"<p>The priority value assigned to the task. The valid values are LOW, MEDIUM, HIGH, and NONE.</p>"
                },
                "taskStatus":{
                    "enum":[
                        "NEW",
                        "OPEN",
                        "UNASSIGNED",
                        "IGNORED",
                        "CLOSED",
                        "UNKNOWN"
                    ],
                    "description":"<p>The assigned status of the task. The valid values are as follows:</p> <ul> <li>CLOSED</li> <li>IGNORED</li> <li>NEW</li> <li>OPEN</li> <li>UNASSIGNED</li> <li>UNKNOWN</li> </ul>"
                },
                "taskType":{
                    "enum":[
                        "WORKFLOW",
                        "TRANSLATION",
                        "CONTENT_EXPIRATION",
                        "WORKFLOW_CHANGED",
                        "WORKFLOW_EXPIRATIION",
                        "REVIEW_DATE",
                        "RATINGS_ANALYSIS",
                        "CONTENT_CHANGED",
                        "SURVEY_ANSWER",
                        "SUBSCRIPTION",
                        "CUSTOM",
                        "INACTIVE_ACCOUNT",
                        "CONTENT_RECOMMENDATION",
                        "CONTENT_IN_LIMBO_STATE",
                        "FORUM_MODERARTION_NOTIFICATION"
                    ],
                    "description":"<p>The type of the task. The valid values are as follows:</p>  <ul> <li>CONTENT_CHANGED</li> <li>CONTENT_EXPIRATION</li> <li>CONTENT_RECOMMENDATION</li> <li>CUSTOM</li> <li>FORUM_MODERARTION_NOTIFICATION</li> <li>INACTIVE_ACCOUNT</li> <li>RATINGS_ANALYSIS</li> <li>REVIEW_DATE</li> <li>SUBSCRIPTION</li> <li>SURVEY_ANSWER</li> <li>TRANSLATION</li> <li>WORKFLOW</li> <li>WORKFLOW_CHANGED</li> <li>WORKFLOW_EXPIRATIION</li> </ul>"
                },
                "age":{
                    "type":"string",
                    "description":"<p>The age of a task. Age is calculated from the time of its creation to the current time.</p>"
                },
                "taskTypeDisplay":{
                    "type":"string",
                    "description":"<p>The type of the task.</p>"
                },
                "taskPriorityDisplay":{
                    "type":"string",
                    "description":"<p>The priority value assigned to the task.</p><p>The valid values are LOW, MEDIUM, HIGH, and NONE.</p>"
                },
                "taskName":{
                    "type":"string",
                    "description":"<p>The name assigned to the task.</p>"
                },
                "taskId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the task.</p>"
                },
                "ownerSiteId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the repository to which the task belong to.</p>"
                },
                "userAssignedId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the user to whom the task is assigned.</p>"
                },
                "userAssignedName":{
                    "type":"string",
                    "description":"<p>The name of the user to whom the task is assigned.</p>"
                },
                "userModifiedId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the user who modified the task.</P>"
                },
                "userModifiedName":{
                    "type":"string",
                    "description":"<p>The name of the user who modified the task.</p>"
                },
                "startDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the task become active.</p>"
                },
                "sysComments":{
                    "type":"string",
                    "description":"<p>The system generated comments to the task. The valid values are: NEW, APPROVED, and REJECTED.</p>"
                },
                "resolution":{
                    "type":"string",
                    "description":"The resolution assigned to the task."
                },
                "taskIdNumber":{
                    "type":"integer",
                    "description":"<p>The number assigned to the unique identifier of the task.</p>"
                },
                "localeCode":{
                    "type":"string",
                    "description":"<p>The locale code of the task. For example, en_US is the locale for English (United States).</p>"
                }
            }
        }
    ]
}

Nested Schema : TaskKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object TaskKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the task record.</p>"
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : TaskKey-allOf[1]

Type: object

Show Source

• recordId(optional): string

  The unique identifier of the task record.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the task record.</p>"
        }
    }
}

Nested Schema : TaskData-allOf[1]

Type: object

Show Source

• age(optional): string

  The age of a task. Age is calculated from the time of its creation to the current time.

• comments(optional): string

  This field displays the comments assigned to the task.

• dateAdded(optional): string(date-time)

  The date when the task was created or added.

• dateModified(optional): string(date-time)

  The date when the task was last modified.

• localeCode(optional): string

  The locale code of the task. For example, en_US is the locale for English (United States).

• ownerSiteId(optional): string

  The unique identifier of the repository to which the task belong to.

• priority(optional):
  Allowed Values: [ "LOW", "MEDIUM", "HIGH", "NONE" ]

  The priority value assigned to the task. The valid values are LOW, MEDIUM, HIGH, and NONE.

• resolution(optional): string
  The resolution assigned to the task.
• startDate(optional): string(date-time)

  The date when the task become active.

• sysComments(optional): string

  The system generated comments to the task. The valid values are: NEW, APPROVED, and REJECTED.

• taskId(optional): string

  The unique identifier of the task.

• taskIdNumber(optional): integer

  The number assigned to the unique identifier of the task.

• taskName(optional): string

  The name assigned to the task.

• taskPriorityDisplay(optional): string

  The priority value assigned to the task.

  The valid values are LOW, MEDIUM, HIGH, and NONE.

• taskStatus(optional):
  Allowed Values: [ "NEW", "OPEN", "UNASSIGNED", "IGNORED", "CLOSED", "UNKNOWN" ]

  The assigned status of the task. The valid values are as follows:

  • CLOSED
  • IGNORED
  • NEW
  • OPEN
  • UNASSIGNED
  • UNKNOWN
• taskType(optional):
  Allowed Values: [ "WORKFLOW", "TRANSLATION", "CONTENT_EXPIRATION", "WORKFLOW_CHANGED", "WORKFLOW_EXPIRATIION", "REVIEW_DATE", "RATINGS_ANALYSIS", "CONTENT_CHANGED", "SURVEY_ANSWER", "SUBSCRIPTION", "CUSTOM", "INACTIVE_ACCOUNT", "CONTENT_RECOMMENDATION", "CONTENT_IN_LIMBO_STATE", "FORUM_MODERARTION_NOTIFICATION" ]

  The type of the task. The valid values are as follows:

  • CONTENT_CHANGED
  • CONTENT_EXPIRATION
  • CONTENT_RECOMMENDATION
  • CUSTOM
  • FORUM_MODERARTION_NOTIFICATION
  • INACTIVE_ACCOUNT
  • RATINGS_ANALYSIS
  • REVIEW_DATE
  • SUBSCRIPTION
  • SURVEY_ANSWER
  • TRANSLATION
  • WORKFLOW
  • WORKFLOW_CHANGED
  • WORKFLOW_EXPIRATIION
• taskTypeDisplay(optional): string

  The type of the task.

• userAssignedId(optional): string

  The unique identifier of the user to whom the task is assigned.

• userAssignedName(optional): string

  The name of the user to whom the task is assigned.

• userModifiedId(optional): string

  The unique identifier of the user who modified the task.

• userModifiedName(optional): string

  The name of the user who modified the task.

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the task was created or added.</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the task was last modified.</p>"
        },
        "comments":{
            "type":"string",
            "description":"<p>This field displays the comments assigned to the task.</p>"
        },
        "priority":{
            "enum":[
                "LOW",
                "MEDIUM",
                "HIGH",
                "NONE"
            ],
            "description":"<p>The priority value assigned to the task. The valid values are LOW, MEDIUM, HIGH, and NONE.</p>"
        },
        "taskStatus":{
            "enum":[
                "NEW",
                "OPEN",
                "UNASSIGNED",
                "IGNORED",
                "CLOSED",
                "UNKNOWN"
            ],
            "description":"<p>The assigned status of the task. The valid values are as follows:</p> <ul> <li>CLOSED</li> <li>IGNORED</li> <li>NEW</li> <li>OPEN</li> <li>UNASSIGNED</li> <li>UNKNOWN</li> </ul>"
        },
        "taskType":{
            "enum":[
                "WORKFLOW",
                "TRANSLATION",
                "CONTENT_EXPIRATION",
                "WORKFLOW_CHANGED",
                "WORKFLOW_EXPIRATIION",
                "REVIEW_DATE",
                "RATINGS_ANALYSIS",
                "CONTENT_CHANGED",
                "SURVEY_ANSWER",
                "SUBSCRIPTION",
                "CUSTOM",
                "INACTIVE_ACCOUNT",
                "CONTENT_RECOMMENDATION",
                "CONTENT_IN_LIMBO_STATE",
                "FORUM_MODERARTION_NOTIFICATION"
            ],
            "description":"<p>The type of the task. The valid values are as follows:</p>  <ul> <li>CONTENT_CHANGED</li> <li>CONTENT_EXPIRATION</li> <li>CONTENT_RECOMMENDATION</li> <li>CUSTOM</li> <li>FORUM_MODERARTION_NOTIFICATION</li> <li>INACTIVE_ACCOUNT</li> <li>RATINGS_ANALYSIS</li> <li>REVIEW_DATE</li> <li>SUBSCRIPTION</li> <li>SURVEY_ANSWER</li> <li>TRANSLATION</li> <li>WORKFLOW</li> <li>WORKFLOW_CHANGED</li> <li>WORKFLOW_EXPIRATIION</li> </ul>"
        },
        "age":{
            "type":"string",
            "description":"<p>The age of a task. Age is calculated from the time of its creation to the current time.</p>"
        },
        "taskTypeDisplay":{
            "type":"string",
            "description":"<p>The type of the task.</p>"
        },
        "taskPriorityDisplay":{
            "type":"string",
            "description":"<p>The priority value assigned to the task.</p><p>The valid values are LOW, MEDIUM, HIGH, and NONE.</p>"
        },
        "taskName":{
            "type":"string",
            "description":"<p>The name assigned to the task.</p>"
        },
        "taskId":{
            "type":"string",
            "description":"<p>The unique identifier of the task.</p>"
        },
        "ownerSiteId":{
            "type":"string",
            "description":"<p>The unique identifier of the repository to which the task belong to.</p>"
        },
        "userAssignedId":{
            "type":"string",
            "description":"<p>The unique identifier of the user to whom the task is assigned.</p>"
        },
        "userAssignedName":{
            "type":"string",
            "description":"<p>The name of the user to whom the task is assigned.</p>"
        },
        "userModifiedId":{
            "type":"string",
            "description":"<p>The unique identifier of the user who modified the task.</P>"
        },
        "userModifiedName":{
            "type":"string",
            "description":"<p>The name of the user who modified the task.</p>"
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the task become active.</p>"
        },
        "sysComments":{
            "type":"string",
            "description":"<p>The system generated comments to the task. The valid values are: NEW, APPROVED, and REJECTED.</p>"
        },
        "resolution":{
            "type":"string",
            "description":"The resolution assigned to the task."
        },
        "taskIdNumber":{
            "type":"integer",
            "description":"<p>The number assigned to the unique identifier of the task.</p>"
        },
        "localeCode":{
            "type":"string",
            "description":"<p>The locale code of the task. For example, en_US is the locale for English (United States).</p>"
        }
    }
}

Nested Schema : TranslationTask-allOf[1]

Type: object

Show Source

• content(optional): ContentKey

{
    "properties":{
        "content":{
            "$ref":"#/definitions/ContentKey",
            "description":""
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/instanceLink"
    }
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

• href: string
  URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
• mediaType(optional): string
  Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  HTTP method for requesting the target of the link.
• profile(optional): string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel: string
  Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
• templated(optional): boolean
  Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Nested Schema : ContentKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object ContentKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
                },
                "versionId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>"
                },
                "documentId":{
                    "type":"string",
                    "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
                },
                "title":{
                    "type":"string",
                    "description":"<p>The tittle of the document.</p>"
                },
                "version":{
                    "type":"string",
                    "description":"Version of the Content object"
                },
                "answerId":{
                    "type":"integer",
                    "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
                },
                "locale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
                },
                "allTranslations":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ContentKey"
                    },
                    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
                }
            }
        }
    ]
}

Nested Schema : ContentKey-allOf[1]

Type: object

Show Source

• allTranslations(optional): array allTranslations

  This field will return list of all translated content that the user can view

  This field will only be populated if allTranslations query parameter is passed in with value true.

• answerId(optional): integer

  The unique identifier that enables mapping between an answer and the content.

• dateModified(optional): string(date-time)

  The date when the content was last modified in the Oracle Knowledge Repository.

• documentId(optional): string

  The unique identifier of a document that indicates the content type in which the content is saved.

• locale(optional): LocaleKey
• recordId(optional): string

  The unique identifier of the document. This ID is same in all versions in all locales of the document.

• title(optional): string

  The tittle of the document.

• version(optional): string
  Version of the Content object
• versionId(optional): string

  The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>"
        },
        "versionId":{
            "type":"string",
            "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>"
        },
        "documentId":{
            "type":"string",
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>"
        },
        "title":{
            "type":"string",
            "description":"<p>The tittle of the document.</p>"
        },
        "version":{
            "type":"string",
            "description":"Version of the Content object"
        },
        "answerId":{
            "type":"integer",
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>"
        },
        "locale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>"
        },
        "allTranslations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
        }
    }
}

Nested Schema : allTranslations

Type: array

This field will return list of all translated content that the user can view

This field will only be populated if allTranslations query parameter is passed in with value true.

Show Source

• Array of: ContentKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>"
}

Nested Schema : LocaleKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object LocaleKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Locale object.</p>"
                }
            }
        }
    ]
}

Nested Schema : LocaleKey-allOf[1]

Type: object

Show Source

• recordId(optional): string

  The unique identifier of the Locale object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Locale object.</p>"
        }
    }
}

Back to Top

Examples

The following example shows how to find the Translation Task object specified by the ID parameter by submitting a get request on the REST resource using cURL.

cURL Command

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/tasks/translationTasks/{id}"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \
-H "Accept: application/json"

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "dateAdded" : "13504037-10-06T16:30:04EDT",
  "dateModified" : "116459413-10-06T12:30:21EDT",
  "comments" : "COMMENTS_VALUE",
  "priority" : "LOW",
  "taskStatus" : "UNKNOWN",
  "taskType" : "REVIEW_DATE",
  "age" : "AGE_VALUE",
  "taskTypeDisplay" : "TASKTYPEDISPLAY_VALUE",
  "taskPriorityDisplay" : "TASKPRIORITYDISPLAY_VALUE",
  "taskName" : "TASKNAME_VALUE",
  "taskId" : "TASKID_VALUE",
  "ownerSiteId" : "OWNERSITEID_VALUE",
  "userAssignedId" : "USERASSIGNEDID_VALUE",
  "userAssignedName" : "USERASSIGNEDNAME_VALUE",
  "userModifiedId" : "USERMODIFIEDID_VALUE",
  "userModifiedName" : "USERMODIFIEDNAME_VALUE",
  "startDate" : "2013-05-23T19:30:13EDT",
  "sysComments" : "SYSCOMMENTS_VALUE",
  "resolution" : "RESOLUTION_VALUE",
  "taskIdNumber" : 0,
  "localeCode" : "LOCALECODE_VALUE",
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
    "mediaType" : "application/json, application/xml",
    "templated" : true,
    "method" : "GET",
    "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
  } ]
}

Back to Top