「checkOut」操作(非推奨)

この API を使用して、特定のファイルを編集用にロックします。特定のノードからファイルをチェックアウトする場合、ノードにはロック可能なアスペクトが配置され、ノードの作業用コピーが宛先パスまたは特定のノードに作成されます。これにより、作業用コピーを更新できるようになります。

既にチェックアウト済みのファイルをチェックアウトすることはできません。そのようなチェックアウト操作を実行した場合、例外が発生します。

チェックアウト操作は自動で行われます。指定したノードのすべてがチェックアウトされるか、または操作が中断されて例外が発生するかのどちらかになります。

Input プロパティ

ストア、ファイル、およびチェックアウトのオプションを指定するパラメーター。

ストア名

コンテンツをチェックアウトするストアの名前を表す string 値。このパラメーターは必須であり、デフォルト値は SpacesStore になります。

nodeIDsOrPaths

チェックアウトするノードの ID またはパスの list。ファイルのみをチェックインできます。フォルダのチェックアウトは許可されていないので、nodeIDsOrPaths のリストはファイルに対応している必要があります。この値は必須パラメーターです。

スペースからすべてのコンテンツをチェックアウトするには、getSpaceContents API を使用してスペース内のすべてのファイルのリストを取得する必要があります。これにより checkOut API を使用してファイルをチェックアウトし、結果から取得したノード ID を受け渡すことができます。

ノードを選択してチェックアウトするには、searchRepository API を使用して必要条件に合ったノードの ID のリストを取得し、その後これらのノード ID をチェックアウト API に受け渡すことができます。

destinationNodeOrPath

(オプション)ファイルのチェックアウト先のフォルダを指定する string 値。チェックアウト先のフォルダが指定されていない場合にファイルがチェックアウトされると、チェックアウトされたファイルの作業用コピーはオリジナルファイルが存在するスペースに作成されます。

Output プロパティ

チェックアウトされた各ファイルの ID に対応する作業用コピーの ID のリストを含む map 値。

Exceptions

この操作によって、CSAuthenticationExceptionCSAccessDeniedExceptionCSInvalidParameterExceptionCSCommunicationExceptionCSTransformationException、および ContentServicesException 例外が発生する場合があります。