How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
- Application Reference:
com.hornbill.docmanager - Scope:
Global - Class:
Application - Required Privilege Level:
user - Required Rights: none
Description
Set a new renew date for the document
Request Parameters
The reviewDocument API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.
| Name | Type | Required | Description |
|---|---|---|---|
documentId |
xs:string |
Yes | Id of the document |
reviewDate |
xs:string |
Yes | New Review date for the document |
comment |
xs:string |
Yes | Outcome of the review |
title |
xs:string |
Yes | Document Title |
taskDetails |
xs:string |
No | JSON string containing task data |
Response Parameters
| Name | Type | Description |
|---|---|---|
taskDeleted |
xs:string |
Is false if the old task |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.docmanager' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.docmanager","@method":"reviewDocument","params":{"documentId":"xs:string","reviewDate":"xs:string","comment":"xs:string","title":"xs:string","taskDetails":"xs:string"}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("documentId", "xs:string")
hornbillAPI.SetParam("reviewDate", "xs:string")
hornbillAPI.SetParam("comment", "xs:string")
hornbillAPI.SetParam("title", "xs:string")
hornbillAPI.SetParam("taskDetails", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.docmanager", "reviewDocument")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.docmanager";
const payload = {
"@service": "apps/com.hornbill.docmanager",
"@method": "reviewDocument",
"params": {
"documentId": "xs:string",
"reviewDate": "xs:string",
"comment": "xs:string",
"title": "xs:string",
"taskDetails": "xs:string"
}
};
fetch(endpoint, {
method: 'POST',
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
},
body: JSON.stringify(payload)
}).then(res => res.json())
.then(res => console.log(res));
const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.docmanager";
const payload = {
"@service": "apps/com.hornbill.docmanager",
"@method": "reviewDocument",
"params": {
"documentId": "xs:string",
"reviewDate": "xs:string",
"comment": "xs:string",
"title": "xs:string",
"taskDetails": "xs:string"
}
};
const axiosConfig = {
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
console.log("AXIOS ERROR: ", err);
})
$endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.docmanager";
$payload = (object) [
'@service' => 'apps/com.hornbill.docmanager',
'@method' => 'reviewDocument',
'params' => (object) [
'documentId' => 'xs:string',
'reviewDate' => 'xs:string',
'comment' => 'xs:string',
'title' => 'xs:string',
'taskDetails' => 'xs:string',
]
];
$headers = [
'Authorization: ESP-APIKEY yourHornbillAPIKey',
'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;
$Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.docmanager"
$Body = @{
"@service" = "apps/com.hornbill.docmanager"
"@method" = "reviewDocument"
params = @{
documentId = "xs:string"
reviewDate = "xs:string"
comment = "xs:string"
title = "xs:string"
taskDetails = "xs:string"
}
}
$Header = @{
"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
Method = "POST"
Uri = $Endpoint
Headers = $Header
Body = ($Body | ConvertTo-Json)
ContentType = "application/json"
}
Invoke-RestMethod @Parameters
import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.docmanager"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.docmanager",
"@method":"reviewDocument",
"params":{
"documentId":"xs:string",
"reviewDate":"xs:string",
"comment":"xs:string",
"title":"xs:string",
"taskDetails":"xs:string",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document