Hide Table of Contents
PDM Pro API Web Service
Putapi/{vaultName}/checkin/addfiles/{changesetId}
PDM Pro API Web Service > Stage Resource Group : api/{vaultName}/checkin/addfiles/{changesetId} (Put)
Description
PUT: api/{vaultname}/checkin/addfiles/{changesetId=0} Upload files or document ids to changeset to the check in operation

 

Adds files to a changeset for checkin. (See Remarks)

Parameters
NameDescriptionData Type
(URI parameter) Vault name (required)string
(URI and Response parameter) Changeset ID = 0 (URI required)integer

(Response) Array of FileInfo objects; each FileInfo consists of:

   File (File object that consists of:

      FileId (integer)

      FileName (string)

   )

   Folder (Folder object that consist of:

      FolderId (integer)

      FolderPath (string)

   )

   Version (integer)

   Config (Config object that consists of:

      ConfigurationName (string)

      ConfigurationId (integer)

   )

Collection of FileInfo
Response (application/json, text/json)

This request returns a new changeset ID and file references.

Sample Data

{
  "ChangesetId": 1,
  "References": [
    {
      "File": {
        "FileId": 1,
        "FileName": "sample string 2"
      },
      "Folder": {
        "FolderId": 1,
        "FolderPath": "sample string 2"
      },
      "Version": 1,
      "Config": {
        "ConfigurationName": "sample string 1",
        "ConfigurationId": 2
      }
    },
    {
      "File": {
        "FileId": 1,
        "FileName": "sample string 2"
      },
      "Folder": {
        "FolderId": 1,
        "FolderPath": "sample string 2"
      },
      "Version": 1,
      "Config": {
        "ConfigurationName": "sample string 1",
        "ConfigurationId": 2
      }
    }
  ]
}
Response (application/xml, text/xml)

This request returns a new changeset ID and file references.

Sample Data

<UploadModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <ChangesetId>1</ChangesetId>
  <References>
    <FileInfo>
      <Config>
        <ConfigurationId>2</ConfigurationId>
        <ConfigurationName>sample string 1</ConfigurationName>
      </Config>
      <File>
        <FileId>1</FileId>
        <FileName>sample string 2</FileName>
      </File>
      <Folder>
        <FolderId>1</FolderId>
        <FolderPath>sample string 2</FolderPath>
      </Folder>
      <Version>1</Version>
    </FileInfo>
    <FileInfo>
      <Config>
        <ConfigurationId>2</ConfigurationId>
        <ConfigurationName>sample string 1</ConfigurationName>
      </Config>
      <File>
        <FileId>1</FileId>
        <FileName>sample string 2</FileName>
      </File>
      <Folder>
        <FolderId>1</FolderId>
        <FolderPath>sample string 2</FolderPath>
      </Folder>
      <Version>1</Version>
    </FileInfo>
  </References>
</UploadModel>
Example
Remarks

This request also requires a binary Body that consists of the binary files to add to the changeset. Drag/drop the JSON example to Postman and inspect the Body of the HTTP request. The Program.cs example creates the binary file that you can upload using this request.

 

Send this HTTP request with a changeset ID of 0. If successful, it will return a new changeset ID which you will use in further requests: api/{vaultName}/checkin/buildtree/{changesetId} (Get) and api/{vaultName}/checkin/{changesetId}/{overrideVersion} (Put)

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}/checkin/addfiles/{changesetId} (Put)
*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) 2024 SP03

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.