Description
POST: api/{vaultName}/state/{transitionId}/HistoryComments Get transition comment history for multiple files
Gets the comment histories for specified files that undergo the specified transition.
Parameters
| Name | Description | Data Type |
|---|
| vaultName | (URI parameter) Vault name (required) | string |
| transitionId | (URI parameter) Transition ID (required) | integer |
| Comments | (Response) Array of history comments
Member of HistoryTransitionComment model | Collection of string |
Request (application/json, text/json)
Array of file IDs passed in the body parameter
Sample Data
[
1,
2
]
Request (application/xml, text/xml)
Array of file IDs passed in a body parameter
Sample Data
<ArrayOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<int>1</int>
<int>2</int>
</ArrayOfint>
Request (application/x-www-form-urlencoded)
Response (application/json, text/json)
Sample Data
{
"Comments": [
"sample string 1",
"sample string 2"
]
}Response (application/xml, text/xml)
Sample Data
<HistoryTransitionComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
<Comments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Comments>
</HistoryTransitionComment>See Also