Hide Table of Contents
PDM Pro API Web Service
Postapi/{vaultName}/state/{transitionId}/HistoryComments
PDM Pro API Web Service > State Transition Resource Group : api/{vaultName}/state/{transitionId}/HistoryComments (Post)
Description
Get transition comment history for multiple files

 

Gets the comment histories for specified files that undergo the specified transition.

Parameters
NameDescriptionData Type
(URI parameter) Vault name (required)string
(URI parameter) Transition ID (required)integer

(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>
Remarks

This operation:

  • takes a body parameter array of integers that are file IDs.
  • returns an array of HistoryTransitionComments.

 

See Also


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   api/{vaultName}/state/{transitionId}/HistoryComments (Post)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:




x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2022 SP04

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.