Jump to

• Request
• Response
• Examples

Close task

post

/km/api/v1/tasks/closeTask

This method closes the specified task and updates the task status as closed.

You must provide a request payload and the URI of the task that you need to close along with this method. The payload for this request contains the TaskToClose object which is enclosed in the TaskKey object.

Request

Supported Media Types

• application/json
• application/xml

Body ()

The tasks object which you need to close. You must pass this entity in a TaskKey object to close a task.

Root 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 : 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"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root 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 : 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"
    ]
}

Back to Top

Examples

The following example shows how to close a task and update the task status by submitting a post request on the REST resource using cURL.

cURL Command

Command: curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/tasks/closeTask"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"UoyWTKRG4RpyJCH4Wqjzht2iYUrsDdk5ir+3IpwEkxcwajJkGR9OGSQBTANQVGW0iVT9MFeDzqL+RYdgfzGSK+h5QzDFIDM+rDLgdKeEE19ljWFm3zMCF+kgYp/dJ/Yq5V7Re+aDXqHg6YkHfvprFA==\"}" \
-H "Accept: application/json"

Example of Request Body

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

{
  	"recordId": "RECORDID_VALUE"
}

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