1968272

「東雲忠太郎」の平凡な日常のできごと

2024.01.19

SharpointRestAPIでファイルをチェックアウトして、編集後にチェックインする方法

カテゴリ： REST API

SharePoint REST APIを使用してファイルをチェックアウトして編集し、最後にチェックインする手順は以下の通りです。

認証:

SharePoint サイトへの認証を行います。通常は OAuth 2.0 を使用してアクセストークンを取得します。

ファイルのチェックアウト:

指定したファイルをチェックアウトします。以下の REST API エンドポイントを使用します。

エンドポイント: https://<site-url>/_api/web/GetFileByServerRelativeUrl('<file-relative-url>')/checkout

メソッド: POST

ヘッダー: Authorization ヘッダにアクセストークンを含める。

ファイルの編集:

チェックアウトしたファイルを編集します。通常は、このステップはクライアントアプリケーションやエディタを使用して行います。

ファイルのチェックイン:

編集が完了したら、ファイルをチェックインします。以下の REST API エンドポイントを使用します。

エンドポイント: https://<site-url>/_api/web/GetFileByServerRelativeUrl('<file-relative-url>')/checkin(comment='Check-in comment', checkintype=0)

メソッド: POST

ヘッダー: Authorization ヘッダにアクセストークンを含める。

以下は、JavaScriptを使用した例です。<site-url> と <file-relative-url> は実際の環境に合わせて変更してください。

javascript

// SharePointサイトのURL

var siteUrl = "https://<site-url>";

// ファイルの相対パス

var fileRelativeUrl = "/sites/<site-name>/Shared Documents/FolderA/File.txt";

// アクセストークンの取得（実際の取得方法は環境により異なります）

var accessToken = "YOUR_ACCESS_TOKEN";

// ファイルのチェックアウトREST APIエンドポイント

var checkoutFileEndpoint = siteUrl + `/_api/web/GetFileByServerRelativeUrl('${fileRelativeUrl}')/checkout`;

// ファイルのチェックアウト

$.ajax({

url: checkoutFileEndpoint,

type: "POST",

headers: {

"Authorization": "Bearer " + accessToken,

"Accept": "application/json;odata=verbose",

"X-RequestDigest": $("#__REQUESTDIGEST").val(), // SharePoint Onlineの場合、このヘッダーが必要なことがあります

success: function (checkoutData) {

console.log("File checked out successfully.");

// チェックアウト後にファイルを編集

// ファイルのチェックインREST APIエンドポイント

var checkinFileEndpoint = siteUrl + `/_api/web/GetFileByServerRelativeUrl('${fileRelativeUrl}')/checkin(comment='Check-in comment', checkintype=0)`;

// ファイルのチェックイン

$.ajax({

url: checkinFileEndpoint,

type: "POST",

headers: {

"Authorization": "Bearer " + accessToken,

"Accept": "application/json;odata=verbose",

success: function (checkinData) {

console.log("File checked in successfully.");

error: function (checkinError) {

console.log("Error checking in file:", checkinError);

}

});

error: function (checkoutError) {

console.log("Error checking out file:", checkoutError);

});

この例では、ファイルのチェックアウト、編集、チェックインのステップが順番に実行されます。必要に応じて、実際の環境に合わせてエンドポイントやデータを変更してください。また、SharePoint Onlineの場合は、X-RequestDigestヘッダーを含める必要があるかもしれません。

お気に入りの記事を「いいね！」で応援しよう

Last updated 2024.01.19 01:30:16

[REST API] カテゴリの最新記事

【毎日開催】

15記事にいいね！で1ポイント

10秒滞在

いいね! -- / --

次の日記を探す

おめでとうございます！
ミッションを達成しました。

※「ポイントを獲得する」ボタンを押すと広告が表示されます。

Design a Mobile Site

スマートフォン版を閲覧 | PC版を閲覧

「東雲 忠太郎」の平凡な日常のできごと

SharpointRestAPIでファイルをチェックアウトして、編集後にチェックインする方法

「東雲忠太郎」の平凡な日常のできごと