SharePoint 動作

動作:取得清單

輸入欄位

屬性說明類型
ID要擷取的 SharePoint 清單專屬 ID (GUID)。這對應於清單中的 ID 欄位。string
網站網址清單所在的 SharePoint 網站絕對網址。這可以是租戶根網站 (例如:https://tenant.sharepoint.com),也可以是租戶內的特定網站集合 (例如:https://tenant.sharepoint.com/sites/sitename)。如未提供,則預設為根網站。string

輸出變數

屬性說明類型
實體與清單相關的其他使用者體驗屬性。string
AllowContentTypes指出清單是否支援內容類型。boolean
AllowDeletion指定清單是否允許刪除。boolean
BaseTemplate清單所依據的清單定義類型。代表 ListTemplateType 值。integer
BaseType清單的基本類型。代表 SP.BaseType 值:一般清單 = 0;文件庫 = 1;討論區 = 3;問卷調查 = 4;問題 = 5。integer
BrowserFileHandling指定瀏覽器處理這個清單中檔案的方式。integer
顏色與清單相關聯的顏色值。string
ContentTypesEnabled指定是否為清單啟用內容類型。boolean
CrawlNonDefaultViews指定搜尋檢索是否要納入清單的非預設檢視畫面。boolean
建立日期清單的建立日期和時間。string
DefaultContentApprovalWorkflowId清單中內容核准的預設工作流程 ID。如果沒有預設的內容核准工作流程,則會傳回空白 GUID。string
DefaultDisplayFormURL清單預設顯示表單的位置。string
DefaultEditFormURL用於清單中清單項目的編輯表單網址。用戶端會指定伺服器相對網址,伺服器則會傳回網站相對網址。string
DefaultItemOpenInBrowser指定是否預設在瀏覽器中開啟清單項目。boolean
DefaultItemOpenUseListSetting指定清單設定是否決定項目預設開啟方式。boolean
DefaultNewFormURL取得或設定值,指定清單預設新表單的位置。用戶端會指定伺服器相對網址,伺服器則會傳回網站相對網址。string
DefaultViewPath_DecodedURL清單預設檢視路徑的解碼網址。string
DefaultViewURL清單預設檢視畫面的網址。string
說明清單說明。string
方向清單的閱讀順序。傳回 NONE、LTR 或 RTL。string
DisableCommenting指定是否要停用清單中項目的留言功能。boolean
DisableGridEditing指定是否要停用清單的格線編輯功能。boolean
DocumentTemplateURL清單的文件範本伺服器相對網址。如果基本型別為 DocumentLibrary,則傳回伺服器相對網址,否則傳回空值。string
DraftVersionVisibility如要在清單中查看次要版本和草稿,最低權限如下:讀者 = 0;作者 = 1;核准者 = 2。integer
EffectiveBasePermissionsForUI_High使用者介面中顯示的清單有效基本權限高階部分。integer
EffectiveBasePermissionsForUI_Low使用者介面中顯示的清單有效基本權限的低階部分。integer
EffectiveBasePermissions_High清單中指派給目前使用者的有效權限。integer
EffectiveBasePermissions_Low清單中指派給目前使用者的有效權限。integer
EnableAssignToEmail指定在將項目指派給使用者時,是否可以傳送電子郵件通知。boolean
EnableAttachments指定是否為清單啟用清單項目附件。boolean
EnableFolderCreation指定是否可在清單中新增清單資料夾。boolean
EnableMinorVersions指定是否為清單啟用子版本。boolean
EnableModeration指定是否為清單啟用內容核准功能。boolean
EnableRequestSignOff指定是否為這份清單啟用「要求簽核」。boolean
EnableVersioning指定是否可在清單中建立清單項目和文件的歷史版本。boolean
EntityTypeName清單的實體型別名稱。string
ExcludeFromOfflineClient指定是否要從離線用戶端排除名單。boolean
ExcludeFromOfflineMode指定是否要從離線模式排除清單。boolean
ExemptFromBlockDownloadOfNonViewableFiles指定清單是否可免除禁止下載無法檢視檔案的政策。boolean
FileSavePostProcessingEnabled指定將檔案儲存至清單時,是否啟用後續處理。boolean
ForceCheckout指定是否為文件庫啟用強制簽出功能。boolean
HasContentAssemblyTemplates指定清單是否含有內容組裝範本。boolean
HasExternalDataSource指定清單是否為外部清單。boolean
HasFolderColoringFields指定清單是否含有資料夾著色欄位。boolean
HasListBoundContentAssemblyTemplates指出清單是否含有與清單相關聯的內容組合範本。boolean
HasUniqueRoleAssignments指定角色指派是針對這個可保護物件獨自定義,還是從父項可保護物件繼承。boolean
隱藏指定清單是否隱藏。如果為 true,伺服器會將 OnQuickLaunch 屬性設為 false。boolean
HighPriorityMediaProcessing指定是否為清單啟用高優先順序媒體處理。boolean
圖示與清單相關聯的圖示。string
ID資料庫中清單的 GUID。string
ImagePath_DecodedURL清單中圖片路徑的解碼網址。string
ImageURL清單圖示的網址。string
IrmEnabled指定是否為清單啟用 IRM。boolean
IrmExpire指定是否要為清單啟用 IRM 期限。boolean
IrmReject指定是否要為清單啟用 IRM 拒絕功能。boolean
IsApplicationList指定用戶端應用程式可用來判斷是否顯示清單的旗標。boolean
IsCatalog指定清單是否為圖片庫。boolean
IsContributorOwnerEnabled指定是否為清單啟用共同擁有者。boolean
IsDefaultDocumentLibrary指出清單是否為預設文件庫。boolean
IsPredictionModelApplied指出是否將預測模型套用至清單。boolean
IsPrivate指定清單是否為私人清單。boolean
IsSystemList指出清單是否為系統清單。boolean
ItemCount清單中的項目數量。integer
LastItemDeletedDate上次從清單中刪除清單項目的日期和時間。string
LastItemModifiedDate清單項目、欄位或清單屬性上次修改的日期和時間。string
LastItemUserModifiedDate使用者上次修改清單項目、欄位或清單屬性的日期和時間。string
ListExperienceOptions清單的體驗選項。integer
ListFormCustomized指出清單表單是否經過自訂。boolean
ListItemEntityTypeFullName清單項目的完整實體類型名稱。string
ListSchemaVersion清單的結構定義版本。integer
MajorVersionLimit清單中項目允許的主要版本上限。integer
MajorWithMinorVersionsLimit清單中項目允許的次要版本主要版本數量上限。integer
MultipleDataList指定會議工作區網站中的清單是否包含網站內多個會議例項的資料。boolean
NoCrawl指定檢索器不得檢索清單。boolean
OnQuickLaunch指定清單是否顯示在網站的快速啟動列。如果設為 true,伺服器會將 Hidden 屬性設為 false。boolean
PageRenderType清單的頁面算繪類型。integer
ParentWebPath_DecodedURL清單上層網頁路徑的解碼網址。string
ParentWebURL指定包含清單的網站伺服器相對網址。string
ParserDisabled指定是否要停用清單的剖析器。boolean
ReadSecurity清單的讀取安全性設定。integer
SchemaXML以 XML 表示的清單結構定義。string
ServerRelativeURL伺服器相對網址。string
ServerTemplateCanCreateFolders指定是否可在清單中建立資料夾。boolean
ShowHiddenFieldsInModernForm指定是否要在清單的新式表單中顯示隱藏欄位。boolean
TemplateFeatureId包含清單結構定義的特徵 ID。如果清單結構定義未包含在功能中,則傳回空白 GUID。string
TemplateTypeId清單的範本類型 ID。string
標題清單顯示的標題。string
ValidationFormula清單項目的資料驗證條件。string
ValidationMessage清單項目的資料驗證失敗時傳回的錯誤訊息。string
WriteSecurity清單的寫入安全性設定。integer

動作:列出清單

輸入欄位

屬性說明類型
網站網址SharePoint 網站的絕對網址。這可以是租戶根網站 (例如:https://tenant.sharepoint.com),也可以是租戶內的特定網站集合 (例如:https://tenant.sharepoint.com/sites/sitename)。如未提供,則預設為根網站,例如:https://tenant.sharepoint.com)。您可以視需要決定是否啟用。string
篩選子句要套用至 SharePoint 清單的 OData 篩選子句。您可以使用這項功能,根據清單的屬性擷取符合特定條件的清單。舉例來說,如要依標題篩選,請輸入:`Title eq 'My List'`string
頁面大小每個頁面要傳回的項目數。您可以視需要決定是否啟用。integer
頁面權杖結果下一頁的符記。您可以視需要決定是否啟用。string

輸出變數

屬性說明類型
valueSharePoint 清單清單。object
ExemptFromBlockDownloadOfNonViewableFiles指定清單是否可免除禁止下載無法檢視檔案的政策。boolean
LastItemUserModifiedDate使用者上次修改清單項目、欄位或清單屬性的日期和時間。string
ForceCheckout指定是否為文件庫啟用強制簽出功能。boolean
MultipleDataList指定會議工作區網站中的清單是否包含網站內多個會議例項的資料。boolean
建立日期清單的建立日期和時間。string
EnableVersioning指定是否可在清單中建立清單項目和文件的歷史版本。boolean
方向清單的閱讀順序。傳回 NONE、LTR 或 RTL。string
EnableRequestSignOff指定是否為這份清單啟用「要求簽核」。boolean
EntityTypeName清單的實體型別名稱。string
IrmEnabled指定是否為清單啟用 IRM。boolean
IsCatalog指定清單是否為圖片庫。boolean
ImagePath清單圖片的路徑。object
DisableGridEditing指定是否要停用清單的格線編輯功能。boolean
NoCrawl指定檢索器不得檢索清單。boolean
ListItemEntityTypeFullName清單項目的完整實體類型名稱。string
隱藏指定清單是否隱藏。boolean
DefaultItemOpenUseListSetting指定清單設定是否決定項目預設開啟方式。boolean
IrmExpire指定是否要為清單啟用 IRM 期限。boolean
FileSavePostProcessingEnabled指定將檔案儲存至清單時,是否啟用後續處理。boolean
DefaultContentApprovalWorkflowId清單中內容核准的預設工作流程 ID。string
IsApplicationList指定用戶端應用程式可用來判斷是否顯示清單的旗標。boolean
HasExternalDataSource指定清單是否為外部清單。boolean
ParentWebUrl清單所屬上層網頁的網址。string
標題清單顯示的標題。string
CurrentChangeToken清單目前的變更權杖。object
ID資料庫中清單的 GUID。string
說明清單說明。string
AllowContentTypes指出清單是否支援內容類型。boolean
IrmReject指定是否要為清單啟用 IRM 拒絕功能。boolean
SensitivityLabelToEncryptOnDownloadForLibrary下載程式庫時要加密的機密程度標籤。string
DocumentTemplateUrl清單的文件範本網址。string
ContentTypesEnabled指定是否為清單啟用內容類型。boolean
EnableMinorVersions指定是否為清單啟用子版本。boolean
TemplateFeatureId包含清單結構定義的特徵 ID。string
EnableFolderCreation指定是否可在清單中新增清單資料夾。boolean
ImageUrl清單圖示的網址。string
LastItemModifiedDate清單項目、欄位或清單屬性上次修改的日期和時間。string
MajorVersionLimit清單中項目允許的主要版本上限。integer
ParentWebPath清單上層網站的路徑。object
DraftVersionVisibility查看清單中的次要版本和草稿所需的最低權限。integer
EnableModeration指定是否為清單啟用內容核准功能。boolean
CrawlNonDefaultViews指定搜尋檢索是否要納入清單的非預設檢視畫面。boolean
LastItemDeletedDate上次從清單中刪除清單項目的日期和時間。string
BaseTemplate清單所依據的清單定義類型。integer
IsPrivate指定清單是否為私人清單。boolean
ItemCount清單中的項目數量。integer
DefaultSensitivityLabelForLibrary程式庫的預設機密程度標籤。string
ListExperienceOptions清單的體驗選項。integer
MajorWithMinorVersionsLimit清單中項目允許的次要版本主要版本數量上限。integer
ParserDisabled指定是否要停用清單的剖析器。boolean
EnableAttachments指定是否為清單啟用清單項目附件。boolean
BaseType清單的基本類型。integer
DisableCommenting指定是否要停用清單中項目的留言功能。boolean

動作:新增清單

輸入欄位

屬性說明類型
說明簡短摘要說明清單內容。string
名稱輸入新 SharePoint 清單的標題。這個名稱會顯示在 SharePoint 使用者介面中,且為必填欄位。請注意,清單名稱不得包含下列字元:*、:、<、>、?、/、\、|。例如:`My New List`string
網站網址要在其中建立清單的 SharePoint 網站絕對網址。這可以是租戶根網站 (例如:https://tenant.sharepoint.com),也可以是租戶內的特定網站集合 (例如:https://tenant.sharepoint.com/sites/sitename)。如未提供,則預設為根網站。string
範本指定用於建立清單的範本名稱或 ID,這會決定清單的結構和預設設定。如未提供,則預設值為 100。string

輸出變數

屬性說明類型
回應如果作業失敗,這個欄位會顯示對應的錯誤代碼,方便您進行偵錯。integer
ErrorMessage如果作業失敗,這個欄位會提供詳細的錯誤訊息,說明失敗原因。string
成功指出清單是否已成功建立。boolean

動作:列出清單項目

輸入欄位

屬性說明類型
列出要從中擷取項目的 SharePoint 清單 **確切標題**。舉例來說,如果清單名為「Documents」,請使用「Documents」。string
網站網址SharePoint 網站的絕對網址。這可以是租戶根網站 (例如:https://tenant.sharepoint.com),也可以是租戶內的特定網站集合 (例如:https://tenant.sharepoint.com/sites/sitename)。如未提供,則預設為根網站 (例如:https://tenant.sharepoint.com)。您可以視需要決定是否啟用。string
篩選子句要套用至清單項目的 **OData 篩選子句**。您可以使用這項功能擷取符合特定條件的項目,而不必擷取整個清單。篩選器支援各種運算子,包括 **邏輯運算子** (例如:`and`、`or`、`not`)、**比較運算子** (例如:`eq`、`ne`、`gt`、`lt`) 和 **函式** (例如:`startswith()`、`substringof()`)。string
下一個連結下一頁結果的完整網址。這個參數用於在大型清單中分頁。如果先前的呼叫傳回下一個連結,請在此提供該連結,以取得下一頁。string
頁面大小單一結果頁面中傳回的清單項目數量上限。這會用於分頁。如未指定,系統會使用預設值 20。SharePoint API 的內部限制為每個要求最多 500 個項目,因此設定高於此限制的值不會傳回更多項目。您可以視需要決定是否啟用。integer

輸出變數

屬性說明類型
valueSharePoint 清單中的項目清單。array
FileSystemObjectType清單項目的檔案系統物件類型。integer
agentspace清單項目的代理空間。string
ID清單項目的專屬 ID。integer
<GUID>清單項目的 GUID。string
已修改清單項目上次修改的日期和時間。string
OData__CopySource清單項目的 OData 複製來源。string
CheckoutUserId已結帳清單項目的使用者 ID。integer
建立日期清單項目的建立日期和時間。string
AuthorId建立清單項目的使用者 ID。integer
ContentTypeId清單項目的內容類型 ID。string
OData__UIVersionString清單項目的 OData UI 版本字串。string
標題清單項目的標題。string
ServerRedirectedEmbedUrl清單項目的伺服器重新導向嵌入網址。string
OData__ColorTag清單項目的 OData 顏色標記。string
ServerRedirectedEmbedUri清單項目的伺服器重新導向嵌入 URI。string
ID清單項目的專屬 ID。integer
ComplianceAssetId清單項目的法規遵循資產 ID。string
DateOfReview清單項目的審查日期。string
ColumnImage清單項目的欄圖片。string
EditorId上次編輯清單項目的使用者 ID。integer

動作:建立資料夾

輸入欄位

屬性說明類型
資料夾名稱這是必要旗標,例如:NewProjectFolderstring
上層資料夾路徑這是必要旗標,例如:/Shared Documents/Projectsstring
SharePoint 網站網址可搜尋 (SharePoint 網站)。例如:https://tenant.sharepoint.com/sites/Engineeringstring

輸出變數

屬性說明類型
id所建立資料夾的專屬 ID。string

動作:上傳文件

輸入欄位

屬性說明類型
目的地檔案名稱這是必要旗標,例如:Q3_Summary.txtstring
目標資料夾路徑這是必要旗標,例如:Shared Documents/Financialsstring
文字內容在這裡輸入文字內容。必要 (使用二進位檔時除外)。string
來源檔案名稱例如:summary.txtstring
SharePoint 網站網址可搜尋 (SharePoint 網站)。例如:https://tenant.sharepoint.com/sites/Financestring

輸出變數

屬性說明類型
id上傳文件的專屬 ID。string

動作:搜尋 SharePoint

輸入欄位

屬性說明類型
搜尋查詢 (query)這是必要旗標,例如:"marketing plan" author:"John Smith" filetype:pdfstring

搜尋篩選器

篩選器運算子說明
網站包含比對所選 SharePoint 網站中的項目。可搜尋 (SharePoint 網站)。
標題包含比對項目名稱中的字詞。
作者包含依據指定的作者名稱比對項目。

輸出變數

屬性說明類型
結果找到的相符項目清單。array

觸發條件:建立或更新清單項目時

觸發條件篩選器

篩選器運算子說明
網站包含比對所選 SharePoint 網站中的項目。可搜尋 (SharePoint 網站)。
標題包含比對項目名稱中的字詞。
作者包含依據指定的作者名稱比對項目。