Hide Table of Contents
PDM Pro API Web Service
Postapi/{vaultName}/state/{transitionId}/changestate?revoke={revoke}
PDM Pro API Web Service > State Transition Resource Group : api/{vaultName}/state/{transitionId}/changestate?revoke={revoke} (Post)
Description
Change state

 

Changes the state of the specified documents.

Parameters
NameDescriptionData Type
(URI parameter) Vault name (required)string
(URI parameter) Transition ID (required)integer
(URI parameter) Whether a revoke (default value is false)boolean
(Body parameter) Commentstring
(Body parameter) Notification commentstring
(Body parameter) Array of file IDsCollection of integer
(Body parameter) Array of user IDsCollection of integer
(Body parameter) Passwordstring
(Response) File IDinteger
(Response) Whether transition is successfulboolean

(Response) A BaseWarningModel object that consists of:

   Message (string)

   IsBlocking (boolean)

   IsError (boolean)

BaseWarningModel
Request (application/json, text/json)

Sample Data

{
  "Comment": "sample string 1",
  "NotificationComment": "sample string 2",
  "Documents": [
    1,
    2
  ],
  "NotifyUsers": [
    1,
    2
  ],
  "Password": "sample string 3"
}
Request (application/xml, text/xml)

Sample Data

<TransitionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <Comment>sample string 1</Comment>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Documents>
  <NotificationComment>sample string 2</NotificationComment>
  <NotifyUsers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </NotifyUsers>
  <Password>sample string 3</Password>
</TransitionModel>
Request (application/x-www-form-urlencoded)

Response (application/json, text/json)

Sample Data

[
  {
    "Id": 1,
    "IsSuccess": true,
    "Warning": null
  },
  {
    "Id": 1,
    "IsSuccess": true,
    "Warning": null
  }
]
Response (application/xml, text/xml)

Sample Data

<ArrayOfTransitionResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <TransitionResultModel>
    <Id>1</Id>
    <IsSuccess>true</IsSuccess>
    <Warning i:nil="true" />
  </TransitionResultModel>
  <TransitionResultModel>
    <Id>1</Id>
    <IsSuccess>true</IsSuccess>
    <Warning i:nil="true" />
  </TransitionResultModel>
</ArrayOfTransitionResultModel>
Remarks

This operation:

  • takes TransitionModel body parameters.
  • returns an array of TransitionResultModels.

 

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}/changestate?revoke={revoke} (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.