Ações do SharePoint

Ação: receber lista

Campos de entrada

PropriedadeDescriçãoTipo
IDO identificador exclusivo (GUID) da lista do SharePoint a ser recuperada. Isso corresponde ao campo "Id" nas listas.string
URL do siteO URL absoluto do site do SharePoint em que a lista está localizada. Pode ser o site raiz do locatário (por exemplo: https://tenant.sharepoint.com) ou um conjunto de sites específico dentro do locatário (por exemplo: https://tenant.sharepoint.com/sites/sitename). Se não for fornecido, o padrão será o site raiz.string

Variáveis de saída

PropriedadeDescriçãoTipo
entidadesOutras propriedades de experiência do usuário associadas à lista.string
AllowContentTypesEspecifica se a lista é compatível com tipos de conteúdo.boolean
AllowDeletionEspecifica se a exclusão é permitida na lista.boolean
BaseTemplateO tipo de definição de lista em que a lista se baseia. Representa um valor ListTemplateType.integer
BaseTypeO tipo de base da lista. Representa um valor SP.BaseType: Generic List = 0; Document Library = 1; Discussion Board = 3; Survey = 4; Issue = 5.integer
BrowserFileHandlingEspecifica como os arquivos nesta lista são processados no navegador.integer
CorO valor da cor associado à lista.string
ContentTypesEnabledEspecifica se os tipos de conteúdo estão ativados para a lista.boolean
CrawlNonDefaultViewsEspecifica se as visualizações não padrão da lista estão incluídas nas rastreamentos de pesquisa.boolean
Criado emData e hora em que a lista foi criada.string
DefaultContentApprovalWorkflowIdO identificador de fluxo de trabalho padrão para aprovação de conteúdo na lista. Retorna um GUID vazio se não houver um fluxo de trabalho de aprovação de conteúdo padrão.string
DefaultDisplayFormURLO local do formulário de exibição padrão para a lista.string
DefaultEditFormURLO URL do formulário de edição a ser usado para itens da lista. Os clientes especificam um URL relativo ao servidor, e o servidor retorna um URL relativo ao site.string
DefaultItemOpenInBrowserEspecifica se os itens da lista são abertos no navegador por padrão.boolean
DefaultItemOpenUseListSettingEspecifica se a configuração de lista determina como os itens são abertos por padrão.boolean
DefaultNewFormURLRecebe ou define um valor que especifica o local do novo formulário padrão para a lista. Os clientes especificam um URL relativo ao servidor, e o servidor retorna um URL relativo ao site.string
DefaultViewPath_DecodedURLO URL decodificado do caminho de visualização padrão da lista.string
DefaultViewURLO URL da visualização padrão da lista.string
DescriçãoA descrição da lista.string
DireçãoA ordem de leitura da lista. Retorna NONE, LTR ou RTL.string
DisableCommentingEspecifica se os comentários estão desativados para os itens na lista.boolean
DisableGridEditingEspecifica se a edição em grade está desativada para a lista.boolean
DocumentTemplateURLO URL relativo ao servidor do modelo de documento para a lista. Retorna um URL relativo ao servidor se o tipo base for DocumentLibrary. Caso contrário, retorna nulo.string
DraftVersionVisibilityA permissão mínima necessária para ver versões secundárias e rascunhos na lista: leitor = 0; autor = 1; aprovador = 2.integer
EffectiveBasePermissionsForUI_HighA parte de ordem superior das permissões de base efetivas para a lista, conforme mostrado na interface do usuário.integer
EffectiveBasePermissionsForUI_LowA parte de baixa ordem das permissões de base efetivas para a lista, conforme exibida na interface do usuário.integer
EffectiveBasePermissions_HighAs permissões efetivas na lista atribuídas ao usuário atual.integer
EffectiveBasePermissions_LowAs permissões efetivas na lista atribuídas ao usuário atual.integer
EnableAssignToEmailEspecifica se uma notificação por e-mail pode ser enviada quando um item é atribuído a um usuário.boolean
EnableAttachmentsEspecifica se os anexos de itens da lista estão ativados para a lista.boolean
EnableFolderCreationEspecifica se novas pastas de lista podem ser adicionadas à lista.boolean
EnableMinorVersionsEspecifica se as versões secundárias estão ativadas para a lista.boolean
EnableModerationEspecifica se a aprovação de conteúdo está ativada para a lista.boolean
EnableRequestSignOffEspecifica se a aprovação de solicitação está ativada para esta lista.boolean
EnableVersioningEspecifica se versões históricas de itens de lista e documentos podem ser criadas na lista.boolean
EntityTypeNameO nome do tipo de entidade da lista.string
ExcludeFromOfflineClientEspecifica se a lista é excluída de clientes off-line.boolean
ExcludeFromOfflineModeEspecifica se a lista é excluída do modo off-line.boolean
ExemptFromBlockDownloadOfNonViewableFilesEspecifica se a lista está isenta da política de bloqueio de download para arquivos não visualizáveis.boolean
FileSavePostProcessingEnabledEspecifica se o pós-processamento está ativado ao salvar arquivos na lista.boolean
ForceCheckoutEspecifica se o check-out forçado está ativado para a biblioteca de documentos.boolean
HasContentAssemblyTemplatesEspecifica se a lista tem modelos de montagem de conteúdo.boolean
HasExternalDataSourceEspecifica se a lista é externa.boolean
HasFolderColoringFieldsEspecifica se a lista tem campos de coloração de pastas.boolean
HasListBoundContentAssemblyTemplatesEspecifica se a lista tem modelos de montagem de conteúdo vinculados a ela.boolean
HasUniqueRoleAssignmentsEspecifica se as atribuições de função são definidas exclusivamente para esse objeto protegível ou herdadas de um objeto protegível pai.boolean
OcultosEspecifica se a lista está oculta. Se for "true", o servidor definirá a propriedade "OnQuickLaunch" como "false".boolean
HighPriorityMediaProcessingEspecifica se o processamento de mídia de alta prioridade está ativado para a lista.boolean
ÍconeO ícone associado à lista.string
IDO GUID que identifica a lista no banco de dados.string
ImagePath_DecodedURLO URL decodificado do caminho da imagem para a lista.string
ImageURLO URL do ícone da lista.string
IrmEnabledEspecifica se o IRM está ativado para a lista.boolean
IrmExpireEspecifica se a expiração do IRM está ativada para a lista.boolean
IrmRejectEspecifica se a rejeição de IRM está ativada para a lista.boolean
IsApplicationListEspecifica uma flag que um aplicativo cliente pode usar para determinar se a lista deve ser mostrada.boolean
IsCatalogEspecifica se a lista é uma galeria.boolean
IsContributorOwnerEnabledEspecifica se o proprietário do colaborador está ativado para a lista.boolean
IsDefaultDocumentLibraryEspecifica se a lista é a biblioteca de documentos padrão.boolean
IsPredictionModelAppliedEspecifica se um modelo de previsão é aplicado à lista.boolean
IsPrivateEspecifica se a lista é particular.boolean
IsSystemListEspecifica se a lista é do sistema.boolean
ItemCountO número de itens na lista.integer
LastItemDeletedDateA última data e hora em que um item foi excluído da lista.string
LastItemModifiedDateA data e a hora em que um item, campo ou propriedade da lista foi modificado pela última vez.string
LastItemUserModifiedDateA última data e hora em que um item, campo ou propriedade de uma lista foi modificado por um usuário.string
ListExperienceOptionsAs opções de experiência para a lista.integer
ListFormCustomizedEspecifica se o formulário de lista é personalizado.boolean
ListItemEntityTypeFullNameO nome completo do tipo de entidade para os itens da lista.string
ListSchemaVersionA versão do esquema da lista.integer
MajorVersionLimitO limite de versões principais permitidas para itens na lista.integer
MajorWithMinorVersionsLimitO limite de versões principais com versões secundárias permitidas para itens na lista.integer
MultipleDataListEspecifica se a lista em um site do espaço de trabalho de reunião contém dados de várias instâncias de reunião no site.boolean
NoCrawlEspecifica que o rastreador não pode rastrear a lista.boolean
OnQuickLaunchEspecifica se a lista aparece na inicialização rápida do site. Se for "true", o servidor definirá a propriedade "Hidden" como "false".boolean
PageRenderTypeO tipo de renderização da página para a lista.integer
ParentWebPath_DecodedURLO URL decodificado do caminho da Web principal da lista.string
ParentWebURLEspecifica o URL relativo ao servidor do site que contém a lista.string
ParserDisabledEspecifica se o analisador está desativado para a lista.boolean
ReadSecurityA configuração de segurança de leitura para a lista.integer
SchemaXMLO esquema da lista representado como um XML.string
ServerRelativeURLO URL relativo ao servidor.string
ServerTemplateCanCreateFoldersEspecifica se é possível criar pastas na lista.boolean
ShowHiddenFieldsInModernFormEspecifica se os campos ocultos são mostrados no formulário moderno da lista.boolean
TemplateFeatureIdO identificador do recurso que contém o esquema da lista. Retorna um GUID vazio se o esquema de lista não estiver contido em um recurso.string
TemplateTypeIdO identificador do tipo de modelo da lista.string
TítuloO título mostrado para a lista.string
ValidationFormulaOs critérios de validação de dados para um item de lista.string
ValidationMessageA mensagem de erro retornada quando a validação de dados falha para um item de lista.string
WriteSecurityA configuração de segurança de gravação para a lista.integer

Ação: listar listas

Campos de entrada

PropriedadeDescriçãoTipo
URL do siteO URL absoluto do site do SharePoint. Pode ser o site raiz do locatário (por exemplo: https://tenant.sharepoint.com) ou um conjunto de sites específico dentro do locatário (por exemplo: https://tenant.sharepoint.com/sites/sitename). Se não for fornecido, o padrão será o site raiz, por exemplo: https://tenant.sharepoint.com. Isso é opcional.string
Cláusula de filtroUma cláusula de filtro OData a ser aplicada às listas do SharePoint. Use isso para recuperar listas que correspondem a critérios específicos com base nas propriedades delas. Por exemplo, para filtrar por título: `Title eq 'My List'`string
Tamanho da páginaO número de itens a serem retornados por página. Isso é opcional.integer
Token de páginaToken para a próxima página de resultados. Isso é opcional.string

Variáveis de saída

PropriedadeDescriçãoTipo
valueA lista de listas do SharePoint.object
ExemptFromBlockDownloadOfNonViewableFilesEspecifica se a lista está isenta da política de bloqueio de download para arquivos não visualizáveis.boolean
LastItemUserModifiedDateA última data e hora em que um item, campo ou propriedade de uma lista foi modificado por um usuário.string
ForceCheckoutEspecifica se o check-out forçado está ativado para a biblioteca de documentos.boolean
MultipleDataListEspecifica se a lista em um site do espaço de trabalho de reunião contém dados de várias instâncias de reunião no site.boolean
Criado emData e hora em que a lista foi criada.string
EnableVersioningEspecifica se versões históricas de itens de lista e documentos podem ser criadas na lista.boolean
DireçãoA ordem de leitura da lista. Retorna NONE, LTR ou RTL.string
EnableRequestSignOffEspecifica se a aprovação de solicitação está ativada para esta lista.boolean
EntityTypeNameO nome do tipo de entidade da lista.string
IrmEnabledEspecifica se o IRM está ativado para a lista.boolean
IsCatalogEspecifica se a lista é uma galeria.boolean
ImagePathO caminho para a imagem da lista.object
DisableGridEditingEspecifica se a edição em grade está desativada para a lista.boolean
NoCrawlEspecifica que o rastreador não pode rastrear a lista.boolean
ListItemEntityTypeFullNameO nome completo do tipo de entidade para os itens da lista.string
OcultosEspecifica se a lista está oculta.boolean
DefaultItemOpenUseListSettingEspecifica se a configuração de lista determina como os itens são abertos por padrão.boolean
IrmExpireEspecifica se a expiração do IRM está ativada para a lista.boolean
FileSavePostProcessingEnabledEspecifica se o pós-processamento está ativado ao salvar arquivos na lista.boolean
DefaultContentApprovalWorkflowIdO identificador de fluxo de trabalho padrão para aprovação de conteúdo na lista.string
IsApplicationListEspecifica uma flag que um aplicativo cliente pode usar para determinar se a lista deve ser mostrada.boolean
HasExternalDataSourceEspecifica se a lista é externa.boolean
ParentWebUrlO URL da Web principal da lista.string
TítuloO título mostrado para a lista.string
CurrentChangeTokenO token de mudança atual da lista.object
IDO GUID que identifica a lista no banco de dados.string
DescriçãoA descrição da lista.string
AllowContentTypesEspecifica se a lista é compatível com tipos de conteúdo.boolean
IrmRejectEspecifica se a rejeição de IRM está ativada para a lista.boolean
SensitivityLabelToEncryptOnDownloadForLibraryO rótulo de sensibilidade para criptografar no download da biblioteca.string
DocumentTemplateUrlO URL do modelo de documento para a lista.string
ContentTypesEnabledEspecifica se os tipos de conteúdo estão ativados para a lista.boolean
EnableMinorVersionsEspecifica se as versões secundárias estão ativadas para a lista.boolean
TemplateFeatureIdO identificador do recurso que contém o esquema da lista.string
EnableFolderCreationEspecifica se novas pastas de lista podem ser adicionadas à lista.boolean
ImageUrlO URL do ícone da lista.string
LastItemModifiedDateA data e a hora em que um item, campo ou propriedade da lista foi modificado pela última vez.string
MajorVersionLimitO limite de versões principais permitidas para itens na lista.integer
ParentWebPathO caminho para a Web principal da lista.object
DraftVersionVisibilityA permissão mínima necessária para ver versões secundárias e rascunhos na lista.integer
EnableModerationEspecifica se a aprovação de conteúdo está ativada para a lista.boolean
CrawlNonDefaultViewsEspecifica se as visualizações não padrão da lista estão incluídas nas rastreamentos de pesquisa.boolean
LastItemDeletedDateA última data e hora em que um item foi excluído da lista.string
BaseTemplateO tipo de definição de lista em que a lista se baseia.integer
IsPrivateEspecifica se a lista é particular.boolean
ItemCountO número de itens na lista.integer
DefaultSensitivityLabelForLibraryO rótulo de sensibilidade padrão da biblioteca.string
ListExperienceOptionsAs opções de experiência para a lista.integer
MajorWithMinorVersionsLimitO limite de versões principais com versões secundárias permitidas para itens na lista.integer
ParserDisabledEspecifica se o analisador está desativado para a lista.boolean
EnableAttachmentsEspecifica se os anexos de itens da lista estão ativados para a lista.boolean
BaseTypeO tipo de base da lista.integer
DisableCommentingEspecifica se os comentários estão desativados para os itens na lista.boolean

Ação: adicionar lista

Campos de entrada

PropriedadeDescriçãoTipo
DescriçãoFaça um breve resumo da lista.string
NomeInsira o título da nova lista do SharePoint. Esse nome é exibido na interface do SharePoint e é obrigatório. Os nomes de listas não podem conter os seguintes caracteres: *, :, <, >, ?, /, \, |. Exemplo: `Minha nova lista`string
URL do siteO URL absoluto do site do SharePoint em que a lista será criada. Pode ser o site raiz do locatário (por exemplo: https://tenant.sharepoint.com) ou um conjunto de sites específico dentro do locatário (por exemplo: https://tenant.sharepoint.com/sites/sitename). Se não for fornecido, o padrão será o site raiz.string
ModeloEspecifique o nome ou ID do modelo a ser usado para criar a lista, que determina a estrutura e as configurações padrão dela. Se não for fornecido, o padrão será 100.string

Variáveis de saída

PropriedadeDescriçãoTipo
respostaSe a operação falhar, esse campo vai mostrar o código de erro correspondente, o que é útil para depuração.integer
ErrorMessageSe a operação falhar, esse campo vai fornecer uma mensagem de erro detalhada explicando o motivo da falha.string
SucessoIndica se a lista foi criada.boolean

Ação: Listar listitems

Campos de entrada

PropriedadeDescriçãoTipo
ListaO **título exato** da lista do SharePoint de que você quer recuperar itens. Por exemplo, se a lista se chamar "Documentos", use "Documentos".string
URL do siteO URL absoluto do site do SharePoint. Pode ser o site raiz do locatário (por exemplo: https://tenant.sharepoint.com) ou um conjunto de sites específico dentro do locatário (por exemplo: https://tenant.sharepoint.com/sites/sitename). Se não for fornecido, o padrão será o site raiz (por exemplo: https://tenant.sharepoint.com). Isso é opcional.string
Cláusula de filtroUma **cláusula de filtro OData** a ser aplicada aos itens da lista. Use isso para extrair itens que correspondem a critérios específicos sem buscar a lista inteira. O filtro oferece suporte a uma ampla variedade de operadores, incluindo **operadores lógicos** (por exemplo, `and`, `or`, `not`), **operadores de comparação** (por exemplo, `eq`, `ne`, `gt`, `lt`) e **funções** (por exemplo, `startswith()`, `substringof()`).string
Próximo linkUm URL completo para a próxima página de resultados. Esse parâmetro é usado para paginar listas grandes. Se uma chamada anterior retornou um link "Próxima", forneça-o aqui para acessar a próxima página.string
Tamanho da páginaO número máximo de itens de lista a serem retornados em uma única página de resultados. Usado para paginação. Se não for especificado, o valor padrão 20 será usado. A API do SharePoint tem um limite interno máximo de 500 itens por solicitação. Portanto, definir um valor maior não vai retornar mais itens. Isso é opcional.integer

Variáveis de saída

PropriedadeDescriçãoTipo
valueA lista de itens na lista do SharePoint.array
FileSystemObjectTypeO tipo de objeto do sistema de arquivos do item da lista.integer
agentspaceO espaço do agente do item da lista.string
IDO identificador exclusivo do item da lista.integer
GUIDO GUID do item da lista.string
ModificadoA data e a hora em que o item da lista foi modificado pela última vez.string
OData__CopySourceA origem da cópia OData do item da lista.string
CheckoutUserIdO ID do usuário que fez o check-out do item da lista.integer
Criado emA data e a hora em que o item da lista foi criado.string
AuthorIdO ID do usuário que criou o item da lista.integer
ContentTypeIdO ID do tipo de conteúdo do item da lista.string
OData__UIVersionStringA string da versão da interface do OData do item da lista.string
TítuloO título do item da lista.string
ServerRedirectedEmbedUrlO URL de incorporação redirecionado pelo servidor do item da lista.string
OData__ColorTagA tag de cor OData do item da lista.string
ServerRedirectedEmbedUriO URI de incorporação redirecionado pelo servidor do item da lista.string
IDO identificador exclusivo do item da lista.integer
ComplianceAssetIdO código do recurso de compliance do item da lista.string
DateOfReviewA data da revisão do item da lista.string
ColumnImageA imagem da coluna do item da lista.string
EditorIdO ID do usuário que editou o item da lista pela última vez.integer

Ação: criar pasta

Campos de entrada

PropriedadeDescriçãoTipo
Nome da pastaObrigatório. Por exemplo: NewProjectFolderstring
Caminho da pasta mãeObrigatório. Por exemplo: /Shared Documents/Projectsstring
URL do site do SharePointPesquisável (sites do SharePoint). Por exemplo: https://tenant.sharepoint.com/sites/Engineeringstring

Variáveis de saída

PropriedadeDescriçãoTipo
idO identificador exclusivo da pasta criada.string

Ação: fazer upload do documento

Campos de entrada

PropriedadeDescriçãoTipo
Nome do arquivo de destinoObrigatório. Por exemplo: Q3_Summary.txtstring
Caminho da pasta de destinoObrigatório. Por exemplo: Shared Documents/Financialsstring
Conteúdo de textoInsira o conteúdo do texto aqui. Obrigatório, a menos que você esteja usando binário.string
Nome do arquivo de origemPor exemplo: summary.txtstring
URL do site do SharePointPesquisável (sites do SharePoint). Por exemplo: https://tenant.sharepoint.com/sites/Financestring

Variáveis de saída

PropriedadeDescriçãoTipo
idO identificador exclusivo do documento enviado.string

Ação: pesquisar no SharePoint

Campos de entrada

PropriedadeDescriçãoTipo
Consulta de pesquisa (consulta)Obrigatório. Por exemplo: "marketing plan" author:"John Smith" filetype:pdfstring

Filtros de pesquisa

FiltroOperadoresDescrição
SitecontémCorresponder itens no site do SharePoint selecionado. Pesquisável (sites do SharePoint).
TítulocontémCorresponda palavras no título do item.
AutorcontémCorresponde a itens pelo nome do autor especificado.

Variáveis de saída

PropriedadeDescriçãoTipo
resultsA lista de itens correspondentes encontrados.array

Gatilho: quando um item de lista é criado ou atualizado

Filtros de acionador

FiltroOperadoresDescrição
SitecontémCorresponder itens no site do SharePoint selecionado. Pesquisável (sites do SharePoint).
TítulocontémCorresponda palavras no título do item.
AutorcontémCorresponde a itens pelo nome do autor especificado.