Partilhar via

Objetive Connect (Pré-visualização)

O Objetive Connect é a plataforma confiável de compartilhamento de arquivos que permite que a organização compartilhe documentos confidenciais com terceiros. Os usuários podem criar espaços de trabalho privados e convidar participantes na nuvem em questão de segundos. Os recursos de colaboração, relatórios, segurança e conformidade permitem que governos e setores regulamentados trabalhem externamente enquanto têm tranquilidade.

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Metadados do conector
Editora Corporação Objetiva

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Palavra-passe securestring A senha para esta api Verdade
Região do servidor. (Reino Unido - secure.objectiveconnect.co.uk, ANZ - secure.objectiveconnect.com) cadeia (de caracteres) Especifique o servidor Objetive Connect. Verdade
Nome de utilizador securestring O nome de usuário para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de 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 Request for application:hal+json, ele criará apenas metadados. Se Request for multipart:form-data, ele criará um documento com conteúdo em uma única chamada.
Criar espaço de trabalho

Criar espaço de trabalho
Excluir participante

Remove o participante do espaço de trabalho
Listar documentos compartilhados

Obter uma lista de ativos por UUID de espaço de trabalho
Listar espaços de trabalho

Obter uma lista de Compartilhamentos que o usuário solicitante tem privilégio de ver
Listar versões de documentos

Obter uma lista de versões do Asset
Obter conteúdo da versão do documento

Devolve o conteúdo de uma versão do documento
Obter conteúdo do documento

Devolve o conteúdo de um documento
Obter espaço de trabalho

Obter espaço de trabalho por ID
Obter participantes

Obter participantes no espaço de trabalho
Obter utilizador

Obter utilizadores
Obter versão do documento

Obter uma versão de ativo

Adicionar ou atualizar participante

ID da Operação:
AddParticipant

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

Parâmetros

Name Chave Necessário Tipo Description
E-mails
 emails True array of string

E-mails
Message
 message string

Mensagem de convite
roles
 roles array of string

roles
UUID do espaço de trabalho
 shareUuid True string

Identificador Único Universal (UUID)
Visibilidade dos participantes
 type string

STANDARD - visível para outros participantes. BCC - participante será escondido dos outros

Devoluções

Name Caminho Tipo Description
array of object
accepted
 accepted boolean

accepted
e-mail
 email string

e-mail
isProprietário
 isOwner boolean

isProprietário
modelo
 model string

modelo
roles
 roles array of string

roles
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

Name Chave Necessário Tipo Description
Documento
 assetUuid True string

Documento UUID
Espaço de trabalho
 shareUuid True string

UUID do espaço de trabalho
Conteúdo do ficheiro
 file True file

O conteúdo do ficheiro a carregar

Criar documento

ID da Operação:
CreateDocument

Se Request for application:hal+json, ele criará apenas metadados. Se Request for multipart:form-data, ele criará um documento com conteúdo em uma única chamada.

Parâmetros

Name Chave Necessário Tipo Description
UUID do espaço de trabalho
 shareUuid True string

O compartilhamento uuid do caminho
Conteúdo do ficheiro
 file True file

O conteúdo do ficheiro a carregar
Nome do ficheiro
 name True string

O nome do arquivo
UUID pai
 parentUuid string

(Opcional)
Resumo
 summary string

(Opcional)

Devoluções

Body
AssetReturnDocumentResponse

Criar espaço de trabalho

ID da Operação:
CreateWorkspace

Criar espaço de trabalho

Parâmetros

Name Chave Necessário Tipo Description
UUID do usuário
 userUuid True string

UUID do usuário
Access
 access string
Agente
 agentShareToken string

Token do agente
Nome
 name True string

Nome
Organização
 organisationUuid string

Organização UUID
Proprietário
 ownerUuid string

Proprietário UUID
Resumo
 summary string

Resumo
Identificador Único Universal (UUID)
 uuid string

Identificador Único Universal (UUID)

Devoluções

Body
ShareResponse

Excluir participante

ID da Operação:
DeleteParticipant

Remove o participante do espaço de trabalho

Parâmetros

Name Chave Necessário Tipo Description
User
 uuid True string

UUID do usuário

Listar documentos compartilhados

ID da Operação:
ListDocuments

Obter uma lista de ativos por UUID de espaço de trabalho

Parâmetros

Name Chave Necessário Tipo Description
Espaço de trabalho
 shareUuid True string

UUID do espaço de trabalho
Length
 length integer

Número máximo de resultados a recuperar
Compensação
 offset integer

Resultado no qual os valores retornados começam (o padrão é 0)
UUID pai
 parentUuid string

O UUID da ação ou do ativo-mãe. Se fornecido, os resultados serão restritos aos filhos imediatos da ação ou ativo. Se inválido, a resposta será 200 com uma lista vazia.
Query
 query string

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

Cadeia de caracteres de critérios de ordem de classificação. Os valores aceitáveis são

  • nome
  • createdDate (Data de criação)
  • modifiedDate
  • tamanho Os critérios de classificação podem, opcionalmente, ser seguidos 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 por Nome do ativo ascendente

Devoluções

Name Caminho Tipo Description
array of object
anotaçõesCount
 annotationsCount integer

anotaçõesCount
commentCount
 commentCount integer

commentCount
versão do conteúdo
 contentVersion integer

versão do conteúdo
createdDate (Data de criação)
 createdDate string

createdDate (Data de criação)
extensão
 extension string

extensão
tamanho do ficheiro
 fileSize integer

tamanho do ficheiro
bloqueado
 locked boolean

bloqueado
modelo
 model string

modelo
modificadoByUuid
 modifiedByUuid string

modificadoByUuid
modifiedDate
 modifiedDate string

modifiedDate
nome
 name string

nome
pdfPreviewstatus
 pdfPreviewstatus string

pdfPreviewstatus
pré-visualizaçãoPageCount
 previewPageCount integer

pré-visualizaçãoPageCount
previewstatus
 previewstatus string

previewstatus
estado
 status string

estado
tipo
 type string

tipo
Identificador Único Universal (UUID)
 uuid string

Identificador Único Universal (UUID)
wopiRestrito
 wopiRestricted boolean

wopiRestrito

Listar espaços de trabalho

ID da Operação:
ListWorkspaces

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

Parâmetros

Name Chave Necessário Tipo Description
Length
 length integer

Número máximo de resultados a recuperar
Compensação
 offset integer

Resultado no qual os valores retornados começam (o padrão é 0)
Proprietário
 ownerUuid string

UUID do usuário do proprietário. Se fornecidos, os resultados serão restritos a ações que são de propriedade deste usuário
Participante
 participantUuid string

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

Cadeia de caracteres de consulta de pesquisa. Se fornecido, os resultados serão restritos a compartilhamentos com nome contendo o valor de consulta fornecido
Ordenar
 sort string

Cadeia de caracteres de critérios de ordem de classificação. Os valores aceitáveis são

  • nome
  • createdDate (Data de criação)
  • modifiedDate
  • juntou-se
  • shareOrder
  • organização Os critérios de classificação podem, opcionalmente, ser seguidos 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 por nome de compartilhamento ascendente.
Grupo de trabalho
 workgroupUuid string

Grupo de trabalho UUID. Se fornecidos, os resultados serão restritos a ações que pertencem ao grupo de trabalho

Devoluções

response
array of ShareResponse

Listar versões de documentos

ID da Operação:
ListDocumentVersions

Obter uma lista de versões do Asset

Parâmetros

Name Chave Necessário Tipo Description
Documento
 assetUuid True string

Documento UUID
Espaço de trabalho
 shareUuid True string

UUID do espaço de trabalho
Length
 length integer

O número máximo de resultados a recuperar
Compensação
 offset integer

O resultado no qual começar (o padrão é 0).

Devoluções

response
array of DocumentVersion

Obter conteúdo da versão do documento

ID da Operação:
GetDocumentVersionContent

Devolve o conteúdo de uma versão do documento

Parâmetros

Name Chave Necessário Tipo Description
Documento
 assetUuid True string

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

O número da versão do documento
Espaço de trabalho
 shareUuid True string

Identificador Único Universal (UUID)

Obter conteúdo do documento

ID da Operação:
GetDocumentContent

Devolve o conteúdo de um documento

Parâmetros

Name Chave Necessário Tipo Description
Documento
 assetUuid True string

Identificador Único Universal (UUID)
Espaço de trabalho
 shareUuid True string

Identificador Único Universal (UUID)

Obter espaço de trabalho

ID da Operação:
GetWorkspace

Obter espaço de trabalho por ID

Parâmetros

Name Chave Necessário Tipo Description
Espaço de trabalho
 shareUuid True string

O uuid do espaço de trabalho para recuperar

Devoluções

Body
ShareResponse

Obter participantes

ID da Operação:
GetParticipants

Obter participantes no espaço de trabalho

Parâmetros

Name Chave Necessário Tipo Description
User
 userUuid string

UUID do usuário

Devoluções

Name Caminho Tipo Description
array of object
accepted
 accepted boolean

accepted
e-mail
 email string

e-mail
isProprietário
 isOwner boolean

isProprietário
juntou-seData
 joinedDate string

juntou-seData
modelo
 model string

modelo
nome
 name string

nome
roles
 roles array of string

roles
shareUuid
 shareUuid string

shareUuid
tipo
 type string

tipo
Identificador Único Universal (UUID)
 uuid string

Identificador Único Universal (UUID)

Obter utilizador

ID da Operação:
GetUser

Obter utilizadores

Parâmetros

Name Chave Necessário Tipo Description
Email
 emailAddress string

O endereço de e-mail para procurar
Length
 length integer

O número de resultados a retornar. Usado apenas se o deslocamento for usado.
Compensação
 offset integer

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

O UUID da organização a procurar
Ordenar
 sort string

O param - sort deve ser do formato uma palavra indicando o campo de classificação uma tag opcional ":d esc", se não presente ascendente é assumida. Solicitações incorretas ou vazias usam como padrão o nome ascendente. As classificações disponíveis são - firstName, lastName, email
UUIDs de usuário
 uuids array

A lista de uuids de usuário

Devoluções

response
array of UserResponse

Obter versão do documento

ID da Operação:
GetDocumentVersion

Obter uma versão de ativo

Parâmetros

Name Chave Necessário Tipo Description
Documento
 assetUuid True string

Identificador Único Universal (UUID)
Espaço de trabalho
 shareUuid True string

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

O número da versão do documento

Devoluções

Body
DocumentVersion

Definições

Access

Access
string

AssetReturnDocumentResponse

Name Caminho Tipo Description
commentCount
 commentCount integer
versão do conteúdo
 contentVersion integer
createdDate (Data de criação)
 createdDate string
extensão
 extension string
tamanho do ficheiro
 fileSize integer
bloqueado
 locked boolean
modelo
 model string
modificadoByUuid
 modifiedByUuid string
modifiedDate
 modifiedDate string
nome
 name string
parentUuid
 parentUuid string
pré-visualizaçãoPageCount
 previewPageCount integer
previewstatus
 previewstatus PreviewStatus
estado
 status AssetStatus
resumo
 summary string
tipo
 type AssetType
Identificador Único Universal (UUID)
 uuid string
wopiRestrito
 wopiRestricted boolean

Status do Ativo

string

AssetType

string

DocumentVersion

Name Caminho Tipo Description
createdDate (Data de criação)
 createdDate string
extensão
 extension string
tamanho do ficheiro
 fileSize integer
modelo
 model string
estado
 status AssetStatus
Identificador Único Universal (UUID)
 uuid string
versão
 version integer

EndOnDateOptionalValue

Name Caminho Tipo Description
Atualidade
 present boolean
valor
 value string

NotificationPreference

NotificationPreference
string

PreviewStatus

string

ShareResponse

Name Caminho Tipo Description
Access
 access Access
connections
 connections integer
createdDate (Data de criação)
 createdDate string
EndOnDateOptionalValue
 endOnDateOptionalValue EndOnDateOptionalValue
modelo
 model string
modifiedDate
 modifiedDate string
nome
 name string
organizaçãoUuid
 organisationUuid string
proprietárioUuid
 ownerUuid string
seguro
 secure boolean
ShareStatus
 shareStatus ShareStatus
estado
 status AssetStatus
SynchStatus
 synchStatus SynchStatus
Identificador Único Universal (UUID)
 uuid string

ShareStatus

ShareStatus
string

SynchStatus

SynchStatus
string

Resposta do usuário

Name Caminho Tipo Description
desactivado
 disabled boolean
e-mail
 email string
primeiroNome
 firstName string
hideEndereço de e-mail
 hideEmailAddress boolean
sobrenome
 lastName string
modelo
 model string
notificationPreferences
 notificationPreferences array of NotificationPreference
organizaçãoUuid
 organisationUuid string
roles
 roles array of string
Status do Usuário
 status UserStatus
timezone
 timezone string
Identificador Único Universal (UUID)
 uuid string

Status do Usuário

Status do Usuário
string