Hide Table of Contents
PDM Pro API Web Service
PDM Pro API Web Service > Stage Resource Group : api/{vaultName}/checkin/{changesetId}/{overrideVersion} (Put)
Check in files from the changeset


Checks in the specified changeset.

NameDescriptionData Type
(URI parameter) Vault name (required)string
(URI parameter) Changeset ID (required)integer
(URI parameter) Whether to override the current versions of files (required)boolean

(Body parameter) Array of document IDs


Member of CheckInModel model

Collection of integer

(Body parameter) Checkin comment


Member of CheckInModel model



(Response) A Version model that consists of:

  • Major (integer)
  • Minor (integer)
  • Build (integer)
  • Revision (integer)
  • MajorRevision (integer)
  • MinorRevision (integer)

Member of HttpResponseMessage model


(Response) GUID of the check-in operation; use the GUID to query for the status of the operation (see api/{vaultName}/progress/{guid}/status)


Member of HttpResponseMessage model


(Response) Status code; see https://en.wikipedia.org/wiki/List_of_HTTP_status_codes


Member of HttpResponseMessage model


(Response) Reason


Member of HttpResponseMessage model


(Response) Collection of objects


Member of HttpResponseMessage model

Collection of Object

(Response) An HttpRequestMessage object that consists of:

   Version (Version model)

   Content (HttpContent object consisting of Headers array)

   Method (HttpMethod object consisting of Method string)

   RequestUri (URI)

   Headers (Array of objects)

   Properties (Dictionary of string [key] and Object [value]


Member of HttpResponseMessage model


(Response) True if successful, false if not


Member of HttpResponseMessage model

Request (application/json, text/json)

The body parameter includes an array of document IDs and comments.

Sample Data

  "DocumentIds": [
  "Comments": "sample string 1"
Request (application/xml, text/xml)

The body parameter includes an array of document IDs and comments.

Sample Data

<CheckInModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <Comments>sample string 1</Comments>
  <DocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
Request (application/x-www-form-urlencoded)

The body parameter includes an array of document IDs and comments.
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

Subject:   Feedback on Help Topics
Page:   api/{vaultName}/checkin/{changesetId}/{overrideVersion} (Put)
*   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:


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

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

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.