Compartilhar via

Objective Connect (versão prévia)

Objective Connect é a plataforma de compartilhamento de arquivos confiável que permite que a organização compartilhe documentos confidenciais com partes externas. Os usuários podem criar workspaces privados e convidar participantes na nuvem em questão de segundos. Os recursos de colaboração, relatórios, segurança e conformidade permitem aos governos e setores regulamentados a capacidade de trabalhar externamente enquanto têm paz de espírito.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Metadados do conector
Publicador Objective Corporation

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Senha secureString A senha dessa api Verdade
Região do servidor. (Reino Unido - secure.objectiveconnect.co.uk, ANZ - secure.objectiveconnect.com) cadeia Especifique o servidor objective connect. Verdade
Nome de usuário secureString O nome de usuário para esta api Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Adicionar ou atualizar participante

Convidar novo participante ou editar funções atribuídas
Carregar conteúdo do documento

Carregar conteúdo para um documento
Criar documento

Se a Solicitação for application:hal+json, ela criará apenas metadados. Se a Solicitação for multipart:form-data, ela criará um documento com conteúdo em uma única chamada.
Criar workspace

Criar workspace
Eliminar participante

Remove o participante do workspace
Listar documentos compartilhados

Obter uma lista de Ativos por UUID do Workspace
Listar versões do documento

Obter uma lista de versões do Ativo
Listar workspaces

Obter uma lista de Compartilhamentos que o usuário solicitante tem privilégio de ver
Obter a versão do documento

Obter uma versão do ativo
Obter conteúdo da versão do documento

Retorna o conteúdo de uma versão do Documento
Obter conteúdo do documento

Retorna o conteúdo de um documento
Obter participantes

Obter participantes do workspace
Obter usuário

Obter usuários
Obter workspace

Obter workspace por ID

Adicionar ou atualizar participante

ID da operação:
AddParticipant

Convidar novo participante ou editar funções atribuídas

Parâmetros

Nome Chave Obrigatório Tipo Description
e-mails
 emails True array of string

e-mails
Message
 message string

Mensagem de convite
funções
 roles array of string

funções
Workspace UUID
 shareUuid True string

Identificador Único Universal (UUID)
Visibilidade do participante
 type string

STANDARD – visível para outros participantes. CCO – o participante ficará oculto de outras pessoas

Retornos

Nome Caminho Tipo Description
array of object
aceito
 accepted boolean

aceito
email
 email string

email
isOwner
 isOwner boolean

isOwner
modelo
 model string

modelo
funções
 roles array of string

funções
shareUuid
 shareUuid string

shareUuid
tipo
 type string

tipo
identificador único universal (UUID)
 uuid string

identificador único universal (UUID)

Carregar conteúdo do documento

ID da operação:
UploadDocumentContent

Carregar conteúdo para um documento

Parâmetros

Nome Chave Obrigatório Tipo Description
Documento
 assetUuid True string

UUID do documento
Workspace
 shareUuid True string

Workspace UUID
Conteúdo do ficheiro
 file True file

O conteúdo do arquivo a ser carregado

Criar documento

ID da operação:
CreateDocument

Se a Solicitação for application:hal+json, ela criará apenas metadados. Se a Solicitação for multipart:form-data, ela criará um documento com conteúdo em uma única chamada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Workspace UUID
 shareUuid True string

A uuid de compartilhamento do caminho
Conteúdo do ficheiro
 file True file

O conteúdo do arquivo a ser carregado
Nome do arquivo
 name True string

O nome do arquivo
UUID pai
 parentUuid string

(Opcional)
Resumo
 summary string

(Opcional)

Retornos

Corpo
AssetReturnDocumentResponse

Criar workspace

ID da operação:
CreateWorkspace

Criar workspace

Parâmetros

Nome Chave Obrigatório Tipo Description
UUID do usuário
 userUuid True string

UUID do usuário
Acesso
 access string
Agente
 agentShareToken string

Token do agente
Nome
 name True string

Nome
Organização
 organisationUuid string

UUID da organização
Proprietário
 ownerUuid string

UUID do proprietário
Resumo
 summary string

Resumo
Identificador Único Universal (UUID)
 uuid string

Identificador Único Universal (UUID)

Retornos

Corpo
ShareResponse

Eliminar participante

ID da operação:
DeleteParticipant

Remove o participante do workspace

Parâmetros

Nome Chave Obrigatório Tipo Description
Utilizador
 uuid True string

UUID do usuário

Listar documentos compartilhados

ID da operação:
ListDocuments

Obter uma lista de Ativos por UUID do Workspace

Parâmetros

Nome Chave Obrigatório Tipo Description
Workspace
 shareUuid True string

Workspace UUID
Length
 length integer

Número máximo de resultados a serem recuperados
Offset
 offset integer

Resultado no qual os valores retornados são iniciados (padrões para 0)
UUID pai
 parentUuid string

A UUID do ativo pai ou de compartilhamento. Se fornecidos os resultados serão restritos a filhos imediatos do compartilhamento ou ativo. Se inválida, a resposta será 200 com uma lista vazia.
Query
 query string

A cadeia de caracteres de consulta de pesquisa. Se fornecido, os resultados serão restritos a ativos com o nome começando com o valor de consulta fornecido.
Classificar
 sort string

Classificar cadeia de caracteres de critérios de ordem. Valores aceitáveis são

  • nome
  • createdDate
  • modifiedDate
  • tamanho Os critérios de classificação podem ser seguidos opcionalmente por ":d esc" para indicar que a classificação deve estar em ordem decrescente. Se nenhum sortInfo for fornecido ou contiver valores inválidos, a lista será classificada pelo nome crescente do ativo

Retornos

Nome Caminho Tipo Description
array of object
annotationsCount
 annotationsCount integer

annotationsCount
commentCount
 commentCount integer

commentCount
versãoDoConteúdo
 contentVersion integer

versãoDoConteúdo
createdDate
 createdDate string

createdDate
extensão
 extension string

extensão
tamanho do arquivo
 fileSize integer

tamanho do arquivo
bloqueado
 locked boolean

bloqueado
modelo
 model string

modelo
modifiedByUuid
 modifiedByUuid string

modifiedByUuid
modifiedDate
 modifiedDate string

modifiedDate
nome
 name string

nome
pdfPreviewstatus
 pdfPreviewstatus string

pdfPreviewstatus
previewPageCount
 previewPageCount integer

previewPageCount
previewstatus
 previewstatus string

previewstatus
status
 status string

status
tipo
 type string

tipo
identificador único universal (UUID)
 uuid string

identificador único universal (UUID)
wopiRestricted
 wopiRestricted boolean

wopiRestricted

Listar versões do documento

ID da operação:
ListDocumentVersions

Obter uma lista de versões do Ativo

Parâmetros

Nome Chave Obrigatório Tipo Description
Documento
 assetUuid True string

UUID do documento
Workspace
 shareUuid True string

Workspace UUID
Length
 length integer

O número máximo de resultados a serem recuperados
Offset
 offset integer

O resultado no qual iniciar (o padrão é 0).

Retornos

response
array of DocumentVersion

Listar workspaces

ID da operação:
ListWorkspaces

Obter uma lista de Compartilhamentos que o usuário solicitante tem privilégio de ver

Parâmetros

Nome Chave Obrigatório Tipo Description
Length
 length integer

Número máximo de resultados a serem recuperados
Offset
 offset integer

Resultado no qual os valores retornados são iniciados (padrões para 0)
Proprietário
 ownerUuid string

UUID do usuário do proprietário. Se fornecidos os resultados serão restritos a compartilhamentos que pertencem a esse usuário
Participante
 participantUuid string

UUID do usuário do participante. Se fornecidos os resultados serão restritos a compartilhamentos em que esse usuário é um participante
Query
 query string

Cadeia de caracteres de consulta de pesquisa. Se fornecido, os resultados serão restritos a compartilhamentos com o nome que contém o valor de consulta fornecido
Classificar
 sort string

Classificar cadeia de caracteres de critérios de ordem. Valores aceitáveis são

  • nome
  • createdDate
  • modifiedDate
  • unido
  • shareOrder
  • organização Os critérios de classificação podem ser seguidos opcionalmente por ":d esc" para indicar que a classificação deve estar em ordem decrescente. Se nenhum sortInfo for fornecido ou contiver valores inválidos, a lista será classificada pelo nome crescente do Compartilhamento.
Grupo de trabalho
 workgroupUuid string

UUID do grupo de trabalho. Se fornecidos os resultados serão restritos a compartilhamentos que pertencem ao grupo de trabalho

Retornos

response
array of ShareResponse

Obter a versão do documento

ID da operação:
GetDocumentVersion

Obter uma versão do ativo

Parâmetros

Nome Chave Obrigatório Tipo Description
Documento
 assetUuid True string

Identificador Único Universal (UUID)
Workspace
 shareUuid True string

Identificador Único Universal (UUID)
Versão
 version True integer

O número de versão do documento

Retornos

Corpo
DocumentVersion

Obter conteúdo da versão do documento

ID da operação:
GetDocumentVersionContent

Retorna o conteúdo de uma versão do Documento

Parâmetros

Nome Chave Obrigatório Tipo Description
Documento
 assetUuid True string

Identificador Único Universal (UUID)
Versão do conteúdo
 contentVersion True integer

O número de versão do documento
Workspace
 shareUuid True string

Identificador Único Universal (UUID)

Obter conteúdo do documento

ID da operação:
GetDocumentContent

Retorna o conteúdo de um documento

Parâmetros

Nome Chave Obrigatório Tipo Description
Documento
 assetUuid True string

Identificador Único Universal (UUID)
Workspace
 shareUuid True string

Identificador Único Universal (UUID)

Obter participantes

ID da operação:
GetParticipants

Obter participantes do workspace

Parâmetros

Nome Chave Obrigatório Tipo Description
Utilizador
 userUuid string

UUID do usuário

Retornos

Nome Caminho Tipo Description
array of object
aceito
 accepted boolean

aceito
email
 email string

email
isOwner
 isOwner boolean

isOwner
joinedDate
 joinedDate string

joinedDate
modelo
 model string

modelo
nome
 name string

nome
funções
 roles array of string

funções
shareUuid
 shareUuid string

shareUuid
tipo
 type string

tipo
identificador único universal (UUID)
 uuid string

identificador único universal (UUID)

Obter usuário

ID da operação:
GetUser

Obter usuários

Parâmetros

Nome Chave Obrigatório Tipo Description
Email
 emailAddress string

O endereço de email a ser pesquisado
Length
 length integer

O número de resultados a serem retornados. Usado somente se o deslocamento for usado.
Offset
 offset integer

Retornar os resultados após essa posição
Organização
 orgUuid string

A UUID da organização para procurar
Classificar
 sort string

O parâmetro - classificação deve ser do formato uma palavra que indica o campo de classificação como uma marca opcional ":d esc", se não estiver presente em ordem crescente. Solicitações incorretas ou vazias padrão para o nome crescente. As classificações disponíveis são : firstName, lastName, email
UUIDs de usuário
 uuids array

A lista de uuids de usuário

Retornos

response
array of UserResponse

Obter workspace

ID da operação:
GetWorkspace

Obter workspace por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
Workspace
 shareUuid True string

A uuid do workspace a ser recuperado

Retornos

Corpo
ShareResponse

Definições

Acesso

Acesso
string

AssetReturnDocumentResponse

Nome Caminho Tipo Description
commentCount
 commentCount integer
versãoDoConteúdo
 contentVersion integer
createdDate
 createdDate string
extensão
 extension string
tamanho do arquivo
 fileSize integer
bloqueado
 locked boolean
modelo
 model string
modifiedByUuid
 modifiedByUuid string
modifiedDate
 modifiedDate string
nome
 name string
parentUuid
 parentUuid string
previewPageCount
 previewPageCount integer
previewstatus
 previewstatus PreviewStatus
status
 status AssetStatus
resumo
 summary string
tipo
 type AssetType
identificador único universal (UUID)
 uuid string
wopiRestricted
 wopiRestricted boolean

AssetStatus

string

AssetType

string

DocumentVersion

Nome Caminho Tipo Description
createdDate
 createdDate string
extensão
 extension string
tamanho do arquivo
 fileSize integer
modelo
 model string
status
 status AssetStatus
identificador único universal (UUID)
 uuid string
versão
 version integer

EndOnDateOptionalValue

Nome Caminho Tipo Description
presente
 present boolean
value
 value string

NotificationPreference

NotificationPreference
string

PreviewStatus

string

ShareResponse

Nome Caminho Tipo Description
Acesso
 access Access
connections
 connections integer
createdDate
 createdDate string
EndOnDateOptionalValue
 endOnDateOptionalValue EndOnDateOptionalValue
modelo
 model string
modifiedDate
 modifiedDate string
nome
 name string
organizationUuid
 organisationUuid string
ownerUuid
 ownerUuid string
seguro
 secure boolean
ShareStatus
 shareStatus ShareStatus
status
 status AssetStatus
SynchStatus
 synchStatus SynchStatus
identificador único universal (UUID)
 uuid string

ShareStatus

ShareStatus
string

SynchStatus

SynchStatus
string

UserResponse

Nome Caminho Tipo Description
desabilitado
 disabled boolean
email
 email string
primeiro nome
 firstName string
hideEmailAddress
 hideEmailAddress boolean
sobrenome
 lastName string
modelo
 model string
notificationPreferences
 notificationPreferences array of NotificationPreference
organizationUuid
 organisationUuid string
funções
 roles array of string
UserStatus
 status UserStatus
timezone
 timezone string
identificador único universal (UUID)
 uuid string

UserStatus

UserStatus
string