Compartilhar via

Trabalho do iManage

O conector do iManage Work permite que os usuários automatizem tarefas repetitivas e processos de aprovação enquanto mantêm todos os arquivos seguros no ambiente do iManage Work.

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)
Contato
Nome iManage LLC
URL https://docs.imanage.com
Email cloudsupport@imanage.com
Metadados do conector
Publicador Conector do iManage Power Platform
Site https://imanage.com
Política de privacidade https://imanage.com/about/privacy-notice/
Categorias Conteúdo e arquivos; Produtividade

Trabalho do iManage

O iManage é o provedor líder do setor de soluções de gerenciamento de documentos e emails para trabalhadores do conhecimento. A plataforma iManage organiza e protege as informações em documentos e emails, para que os profissionais possam pesquisar o que precisam, agir sobre ela e colaborar com mais eficiência. O conector do iManage Work permite que os usuários automatizem tarefas repetitivas e processos de aprovação enquanto mantêm todos os arquivos seguros no ambiente do iManage Work.

Pré-requisitos

O conector está disponível para todos os clientes do iManage Work que se conectam ao cloudimanage.com. Primeiro, o aplicativo Power Automate precisará ser habilitado por um administrador do seu ambiente de trabalho iManage. Depois de habilitado, você precisará da URL específica para seu ambiente e uma conta de logon e senha sob a qual o conector pode executar ações. Para obter mais informações, consulte as perguntas frequentes.

Como obter credenciais

Se você for um usuário existente do iManage Work, forneça suas credenciais do iManage Work para fazer logon. Caso contrário, entre em contato com o Administrador do Sistema para obter assistência.

Introdução ao conector do iManage Work

Execute as seguintes etapas para começar a usar o conector do iManage Work:

  • Crie um fluxo de nuvem instantânea e selecione + Nova etapa.
  • Pesquise o iManage Work para ver todas as ações disponíveis do iManage Work.
  • Selecione a ação iManage Work desejada.
  • Se você ainda não estiver conectado ao iManage Work, será solicitado que você entre.
    • Selecione Entrar.
    • Insira a URL que você usa para se conectar ao iManage Work, por exemplo, cloudimanage.com.
    • Insira a ID do usuário do iManage Work.
    • Insira a senha da conta escolhida e selecione Logon. Desse ponto em diante, todos os fluxos que usam ações do iManage Work se conectam usando essas credenciais de usuário. Uma conta de usuário diferente do iManage pode ser usada adicionando uma nova conexão em Minhas Conexões e alternando para ela.

Problemas e limitações conhecidos

Para obter uma lista de problemas e limitações conhecidos, visite https://docs.imanage.com/power-automate/index.html.

Erros e soluções comuns

Para obter uma lista de erros e remédios comuns, visite https://docs.imanage.com/power-automate/index.html.

perguntas frequentes

Para obter uma lista de perguntas frequentes, visite https://docs.imanage.com/power-automate/index.html.

Limitações

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

Ações

Adicionar entrada de histórico de documentos

Adiciona uma entrada como um evento no histórico do documento.
Adicionar referência de documento

Adiciona a referência de documento ou atalho de documento em outra pasta.
Atualizar a segurança padrão

Atualiza a segurança padrão de um documento, pasta ou workspace.
Atualizar a versão atual ou criar um novo documento

Atualiza a versão especificada de um documento ou cria uma nova versão. Essa ação pode atualizar o perfil e o conteúdo de um documento. Se a opção "Atualizar Versão Atual" for especificada, o documento será substituído por um novo e o perfil do documento anterior será mantido. Se 'Criar Nova Versão' for especificado, uma nova versão do documento será criada que herdará o perfil da pasta. Após a execução bem-sucedida da operação, o perfil do documento é retornado.
Atualizar o estado do fluxo de trabalho

Atualiza o estado de uma execução de fluxo de trabalho. Essa ação só pode ser usada em um fluxo de trabalho que foi criado para começar com um gatilho fornecido pelo iManage.
Atualizar o perfil do documento

Executa atualizações no perfil do documento. Um documento não deve estar em uso durante a atualização de seu perfil e o perfil de um documento que está com check-out não pode ser atualizado. Retorna um perfil de documento atualizado após a operação.
Atualizar workspace

Atualiza informações do workspace especificado. Para excluir o valor existente de um campo de cadeia de caracteres, defina o valor do campo como uma cadeia de caracteres vazia encapsulada em aspas simples ou duplas.
Baixar documento

Baixa uma versão de um documento específico, com base na ID do documento. Se o mais recente for verdadeiro, a versão mais recente deste documento será baixada. O download é um fluxo e não é salvo localmente.
Carregar documento

Carrega um arquivo como um novo documento para a pasta especificada.
Copiar documento

Copia um documento para a pasta especificada.
Criar relação de documento

Cria uma relação entre documentos especificados em uma biblioteca.
Criar workspace

Cria um novo workspace com base no modelo selecionado. Um modelo de workspace é um workspace predefinido cuja estrutura é copiada para o novo workspace. As restrições no modelo de workspace são aplicadas automaticamente ao criar o novo workspace.
Definir propriedades de metadados estendidos principais em um documento

Define as principais propriedades de metadados estendidos em um documento.
Editar pares nome-valor

Cria, atualiza ou exclui propriedades de par nome-valor de um documento, pasta ou workspace. Para excluir um par nome-valor, defina o valor da chave como uma cadeia de caracteres vazia encapsulada em aspas simples ou duplas.
Excluir documento

Exclui o documento especificado.
Excluir referência de documento

Exclui a referência de documento da pasta especificada.
Excluir relação de documento

Exclui uma relação entre documentos especificados em uma biblioteca.
Mover documento

Move um documento para a pasta especificada.
Obter administradores

Obtém uma lista de administradores com determinadas permissões para um documento, pasta ou workspace. Um administrador pode ser um usuário ou grupo.
Obter as principais propriedades de metadados estendidos de um documento

Obtém as principais propriedades de metadados estendidos de um documento.
Obter bibliotecas

Obtém uma lista de bibliotecas às quais o usuário tem acesso.
Obter classes

Obtém a lista de classes de documento disponíveis em uma biblioteca que corresponde aos critérios especificados.
Obter detalhes do usuário

Obtém informações sobre um usuário da biblioteca especificada.
Obter membros do grupo

Obtenha detalhes dos usuários que pertencem ao grupo especificado e corresponda aos critérios especificados.
Obter modelos de workspace

Obtém a lista de modelos disponíveis em uma biblioteca. Um modelo de workspace é um workspace predefinido cuja estrutura é copiada para o novo workspace.
Obter o perfil do documento

Obtém as propriedades do documento associadas a uma ID de documento específica.
Obter perfil do workspace

Obtém o perfil do workspace e, opcionalmente, a lista de operações permitidas para o workspace.
Obter permissões

Obtém propriedades de permissão de acesso de usuário ou grupo de um documento, pasta ou workspace. As propriedades de resposta podem variar com permissões de usuário ou grupo.
Obter subclasses

Obtém todas as subclasses de biblioteca que correspondem aos critérios especificados.
Obter versões do documento

Obtém perfis para todas as versões às quais o usuário atual tem acesso para um documento especificado.
Permissões de atualização

Atualiza as permissões de um objeto.
Permissões de cópia

Copia as permissões de acesso e, opcionalmente, a segurança padrão, de um objeto iManage Work para outro. 'Tipo de Cópia' oferece opções de como lidar com a combinação de permissões de origem e de destino. 'Substituir' atualiza os usuários, grupos e níveis de permissão do objeto de destino para corresponder exatamente aos do objeto de origem. 'Merge' mantém todos os usuários e grupos no objeto de destino e os combina com a origem, mas no caso de um conflito de nível de permissão em um indivíduo ou grupo: 'Merge (Pessimista)' usa a permissão inferior, enquanto 'Merge (Optimistic)' usa a permissão mais alta para o usuário ou grupo conflitante.
Pesquisar pastas

Pesquise pastas.
Pesquisar usuários

Pesquisa usuários do iManage Work que correspondem aos critérios de pesquisa especificados.
Pesquisar valores de nó de taxonomia de metadados estendidos do núcleo de pesquisa

Pesquisa valores de nó de taxonomia de metadados estendidos principais que correspondem aos critérios de pesquisa especificados.
Pesquisar workspaces

Pesquise workspaces.
Promover a versão do documento

Promove uma versão existente de um documento para a versão mais recente. Uma nova versão é criada a partir de uma ID de Diário ou versão especificada e, em seguida, promovida para a mais recente. Você deve especificar a ID do Diário ou a Versão, mas não ambas.

Adicionar entrada de histórico de documentos

ID da operação:
AddDocumentHistoryEntry

Adiciona uma entrada como um evento no histórico do documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
Activity
 activity_code True integer

Especifica o tipo de atividade executada no documento.
Comments
 comments string

Especifica qualquer informação adicional sobre a atividade.
Duração
 duration integer

Especifica o número de segundos que o usuário gastou trabalhando no documento.

Retornos

Nome Caminho Tipo Description
dados
 data object

Adicionar referência de documento

ID da operação:
AddDocumentReference

Adiciona a referência de documento ou atalho de documento em outra pasta.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
ID da pasta
 folderId True string

Especifica a ID da pasta. Por exemplo, 'ACTIVE_US!773'.

Retornos

Nome Caminho Tipo Description
ID de referência do documento
 data.id string

Indica a referência do documento e document_shortcut.
Wstype
 data.wstype string

Indica o tipo iManage Work do objeto. Os valores possíveis são 'document', 'document_shortcut', 'email'.

Atualizar a segurança padrão

ID da operação:
UpdateDefaultSecurity

Atualiza a segurança padrão de um documento, pasta ou workspace.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de objeto
 objectType True string

Especifica o tipo de objeto.
ID do objeto
 objectId True string

Especifica a ID do documento, pasta ou workspace. Um exemplo de uma ID de documento é 'ACTIVE_US!453.1'. Um exemplo de uma ID de pasta ou workspace é 'ACTIVE_US!123'.
Segurança Padrão
 default_security True string

Especifica a segurança padrão do objeto.

Retornos

Nome Caminho Tipo Description
Segurança Padrão
 data.default_security string

Indica a segurança padrão do objeto. Os valores possíveis são 'inherit', 'public', 'view' ou 'private'.
Permissões de Acesso
 data.acl AccessPermissions

Indica uma coleção de permissões de acesso para um ou mais usuários e/ou grupos.

Atualizar a versão atual ou criar um novo documento

ID da operação:
UpdateOrCreateNewDocVersion

Atualiza a versão especificada de um documento ou cria uma nova versão. Essa ação pode atualizar o perfil e o conteúdo de um documento. Se a opção "Atualizar Versão Atual" for especificada, o documento será substituído por um novo e o perfil do documento anterior será mantido. Se 'Criar Nova Versão' for especificado, uma nova versão do documento será criada que herdará o perfil da pasta. Após a execução bem-sucedida da operação, o perfil do documento é retornado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Atualizar ou criar uma nova versão
 updateOrCreate True string

Especifica a atualização da versão atual do documento ou a criação de uma nova versão.
ID do documento existente
 documentId True string

Especifica a ID do documento existente. Por exemplo, 'ACTIVE_US!556.1'.
Manter Bloqueado
 keep_locked boolean

Especifica se um bloqueio de documento é mantido após o upload.
Comment
 comment string

Especifica informações adicionais sobre a atualização.
Nome do documento
 name string

Especifica o nome do documento.
Autor
 author string

Especifica a ID do iManage Work do usuário que criou o documento.
Operator
 operator string

Especifica a ID do usuário que fez check-out do documento ou atualmente está editando o perfil do documento. Por exemplo, 'JSMITH'.
Class
 class string

Especifica a classe para identificar e diferenciar o documento. A classe de documento é categorizada por gênero, departamento, região e assim por diante.
Subclasse
 subclass string

Especifica a subclasse para identificar e diferenciar o documento. A subclasse do documento é categorizada por gênero, departamento, região e assim por diante.
Segurança Padrão
 default_security string

Especifica o nível de acesso de segurança padrão. Os valores possíveis são 'inherit', 'private', 'view', 'public'.
É HIPAA
 is_hipaa boolean

Especifica se o documento deve ser criptografado.
Dias de Retenção
 retain_days integer

Especifica o número de dias em que um documento deve estar inativo antes de marcá-lo para arquivamento.
Conteúdo do Arquivo
 file True file

Especifica o conteúdo do arquivo.
Data de criação do arquivo
 file_create_date date-time

Especifica a data e hora (no formato ISO 8601) que o arquivo foi criado. O arquivo poderia ter sido criado fora do sistema iManage Work. Essa data pode ser diferente de "create_date". O create_date é a data em que o arquivo foi criado ou importado pelo sistema iManage Work.
Data de Edição do Arquivo
 file_edit_date date-time

Especifica a data e hora (no formato ISO 8601) da alteração mais recente para o arquivo. O arquivo pode ter sido alterado antes de ser carregado no sistema iManage Work.
Custom1
 custom1 string

Especifica o valor para custom1.
Custom2
 custom2 string

Especifica o valor para custom2. Para especificar um valor para custom2, você também deve especificar um valor para custom1 na mesma solicitação, que é devido à relação pai-filho.
Personalizado3
 custom3 string

Especifica o valor para custom3.
Personalizado4
 custom4 string

Especifica o valor para custom4.
Custom5
 custom5 string

Especifica o valor para custom5.
Custom6
 custom6 string

Especifica o valor para custom6.
Custom7
 custom7 string

Especifica o valor para custom7.
Custom8
 custom8 string

Especifica o valor para custom8.
Custom9
 custom9 string

Especifica o valor para custom9.
Custom10
 custom10 string

Especifica o valor para custom10.
Custom11
 custom11 string

Especifica o valor para custom11.
Personalizado12
 custom12 string

Especifica o valor para custom12.
Personalizado13
 custom13 string

Especifica o valor para custom13.
Personalizado14
 custom14 string

Especifica o valor para custom14.
Personalizado15
 custom15 string

Especifica o valor para custom15.
Personalizado16
 custom16 string

Especifica o valor para custom16.
Personalizado17
 custom17 double

Especifica o valor para custom17.
Personalizado18
 custom18 double

Especifica o valor para custom18.
Personalizado19
 custom19 double

Especifica o valor para custom19.
Custom20
 custom20 double

Especifica o valor para custom20.
Custom21
 custom21 string

Especifica o valor para custom21 no formato de datetime ISO 8601.
Custom22
 custom22 string

Especifica o valor para custom22 no formato de datetime ISO 8601.
Personalizado23
 custom23 string

Especifica o valor para custom23 no formato de datetime ISO 8601.
Personalizado24
 custom24 string

Especifica o valor para custom24 no formato de datetime ISO 8601.
Personalizado25
 custom25 boolean

Especifica o valor para custom25.
Custom26
 custom26 boolean

Especifica o valor para custom26.
Personalizado27
 custom27 boolean

Especifica o valor para custom27.
Custom28
 custom28 boolean

Especifica o valor para custom28.
Custom29
 custom29 string

Especifica o valor para custom29.
Custom30
 custom30 string

Especifica o valor para custom30. Para especificar um valor para custom30, você também deve especificar um valor para custom29 na mesma solicitação, que é devido à relação pai-filho.

Atualizar o estado do fluxo de trabalho

ID da operação:
UpdateWorkflowState

Atualiza o estado de uma execução de fluxo de trabalho. Essa ação só pode ser usada em um fluxo de trabalho que foi criado para começar com um gatilho fornecido pelo iManage.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca para a qual o fluxo de trabalho é definido.
Estado
 state True string

Especifica o estado atual da execução do fluxo de trabalho.
Situação
 status string

Especifica o status atual da execução do fluxo de trabalho. O comprimento máximo é de 128 caracteres.
Mensagem de status
 statusMessage string

Especifica a mensagem personalizada para o status atual da execução do fluxo de trabalho. O comprimento máximo é de 256 caracteres.

Retornos

response
object

Atualizar o perfil do documento

ID da operação:
UpdateDocumentProfile

Executa atualizações no perfil do documento. Um documento não deve estar em uso durante a atualização de seu perfil e o perfil de um documento que está com check-out não pode ser atualizado. Retorna um perfil de documento atualizado após a operação.

Parâmetros

Nome Chave Obrigatório Tipo Description
Alias
 alias string

Especifica o alias deste documento.
Autor
 author string

Especifica a ID do usuário que criou o documento. Por exemplo, 'JSMITH'.
Comment
 comment string

Especifica informações adicionais sobre o documento.
Segurança padrão do documento
 default_security string

Especifica o nível de acesso de segurança padrão.
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
É Declarado
 is_declared boolean

Especifica se o documento deve ser declarado como um registro. Um documento declarado como um registro não pode ser editado ou excluído, exceto por um administrador do sistema iManage Work.
É HIPAA
 is_hipaa boolean

Especifica se o documento deve ser criptografado.
Comentário de auditoria
 audit_comment string

Especifica informações adicionais sobre a atualização do perfil do documento.
Classe de documento
 class string

Especifica a classe de documento.
Nome do documento
 name string

Especifica o nome do arquivo do documento.
Operator
 operator string

Especifica que a ID do usuário fez check-out do documento ou atualmente está editando o perfil do documento. Por exemplo, 'JSMITH'.
Dias de Retenção
 retain_days integer

Especifica o número de dias antes de o documento inativo ser qualificado para arquivamento.
Subclasse
 subclass string

Especifica a subclasse do documento.
Custom1
 custom1 string

Especifica o valor de custom1.
Custom2
 custom2 string

Especifica o valor de custom2. Para especificar um valor para custom2, você também deve especificar um valor para custom1 na mesma solicitação, que é devido à relação pai-filho.
Personalizado3
 custom3 string

Especifica o valor de custom3.
Personalizado4
 custom4 string

Especifica o valor de custom4.
Custom5
 custom5 string

Especifica o valor de custom5.
Custom6
 custom6 string

Especifica o valor do custom6.
Custom7
 custom7 string

Especifica o valor de custom7.
Custom8
 custom8 string

Especifica o valor de custom8.
Custom9
 custom9 string

Especifica o valor de custom9.
Custom10
 custom10 string

Especifica o valor de custom10.
Custom11
 custom11 string

Especifica o valor de custom11.
Personalizado12
 custom12 string

Especifica o valor de custom12.
Personalizado13
 custom13 string

Especifica o valor de custom13.
Personalizado14
 custom14 string

Especifica o valor de custom14.
Personalizado15
 custom15 string

Especifica o valor de custom15.
Personalizado16
 custom16 string

Especifica o valor de custom16.
Personalizado17
 custom17 double

Especifica o valor de custom17.
Personalizado18
 custom18 double

Especifica o valor de custom18.
Personalizado19
 custom19 double

Especifica o valor de custom19.
Custom20
 custom20 double

Especifica o valor de custom20.
Custom21
 custom21 string

Especifica o valor da propriedade custom21 no formato datetime ISO 8601.
Custom22
 custom22 string

Especifica o valor da propriedade custom22 no formato de datetime ISO 8601.
Personalizado23
 custom23 string

Especifica o valor da propriedade custom23 no formato datetime ISO 8601.
Personalizado24
 custom24 string

Especifica o valor da propriedade custom24 no formato datetime ISO 8601.
Personalizado25
 custom25 boolean

Especifica o valor de custom25.
Custom26
 custom26 boolean

Especifica o valor de custom26.
Personalizado27
 custom27 boolean

Especifica o valor de custom27.
Custom28
 custom28 boolean

Especifica o valor de custom28.
Custom29
 custom29 string

Especifica o valor de custom29.
Custom30
 custom30 string

Especifica o valor de custom30. Para especificar um valor para custom30, você também deve especificar um valor para custom29 na mesma solicitação, que é devido à relação pai-filho.

Atualizar workspace

ID da operação:
UpdateWorkspace

Atualiza informações do workspace especificado. Para excluir o valor existente de um campo de cadeia de caracteres, defina o valor do campo como uma cadeia de caracteres vazia encapsulada em aspas simples ou duplas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do workspace
 id True string

Especifica a ID do workspace a ser atualizado. Por exemplo, 'ACTIVE_US!427'.
Nome
 name string

Especifica o nome do workspace.
Proprietário do workspace
 owner string

Especifica o proprietário do workspace.
Custom1
 custom1 string

Especifica o valor de custom1.
Custom2
 custom2 string

Especifica o valor de custom2. Para especificar um valor para custom2, você também deve especificar um valor para custom1 na mesma solicitação, que é devido à relação pai-filho.
Personalizado3
 custom3 string

Especifica o valor de custom3.
Personalizado4
 custom4 string

Especifica o valor de custom4.
Custom5
 custom5 string

Especifica o valor de custom5.
Custom6
 custom6 string

Especifica o valor do custom6.
Custom7
 custom7 string

Especifica o valor de custom7.
Custom8
 custom8 string

Especifica o valor de custom8.
Custom9
 custom9 string

Especifica o valor de custom9.
Custom10
 custom10 string

Especifica o valor de custom10.
Custom11
 custom11 string

Especifica o valor de custom11.
Personalizado12
 custom12 string

Especifica o valor de custom12.
Personalizado13
 custom13 string

Especifica o valor de custom13.
Personalizado14
 custom14 string

Especifica o valor de custom14.
Personalizado15
 custom15 string

Especifica o valor de custom15.
Personalizado16
 custom16 string

Especifica o valor de custom16.
Personalizado17
 custom17 double

Especifica o valor de custom17.
Personalizado18
 custom18 double

Especifica o valor de custom18.
Personalizado19
 custom19 double

Especifica o valor de custom19.
Custom20
 custom20 double

Especifica o valor de custom20.
Custom21
 custom21 string

Especifica o valor de custom21, no formato datetime ISO 8601.
Custom22
 custom22 string

Especifica o valor de custom22, no formato datetime ISO 8601.
Personalizado23
 custom23 string

Especifica o valor de custom23, no formato datetime ISO 8601.
Personalizado24
 custom24 string

Especifica o valor de custom24, no formato datetime ISO 8601.
Personalizado25
 custom25 boolean

Especifica o valor de custom25.
Custom26
 custom26 boolean

Especifica o valor de custom26.
Personalizado27
 custom27 boolean

Especifica o valor de custom27.
Custom28
 custom28 boolean

Especifica o valor de custom28.
Custom29
 custom29 string

Especifica o valor de custom29.
Custom30
 custom30 string

Especifica o valor de custom30. Para especificar um valor para custom30, você também deve especificar um valor para custom29 na mesma solicitação, que é devido à relação pai-filho.
Segurança Padrão
 default_security string

Especifica o nível de acesso de segurança padrão.
Description
 description string

Especifica informações adicionais sobre o workspace.
É externo como normal
 is_external_as_normal boolean

Especifica se o workspace pode ser tratado como um workspace público. Se definido como 'true' e 'default_security' não for 'privado', 'is_external' será definido como 'true'.
Projeto Personalizado1
 project_custom1 string

Especifica informações adicionais sobre o workspace. Esse campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, workspaces ou pastas. Esse é um texto descritivo que não precisa ser formatado e não é validado.
Projeto Personalizado2
 project_custom2 string

Especifica informações adicionais sobre o workspace. Esse campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, workspaces ou pastas. Esse é um texto descritivo que não precisa ser formatado e não é validado.
Projeto Personalizado3
 project_custom3 string

Especifica informações adicionais sobre o workspace. Esse campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, workspaces ou pastas. Esse é um texto descritivo que não precisa ser formatado e não é validado.
Subclasse do workspace
 subclass string

Especifica a subclasse do workspace com base na subclasse do documento que ele contém.

Baixar documento

ID da operação:
DownloadDocument

Baixa uma versão de um documento específico, com base na ID do documento. Se o mais recente for verdadeiro, a versão mais recente deste documento será baixada. O download é um fluxo e não é salvo localmente.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_USE!453.1'.
Obter a versão mais recente
 latest boolean

Especifica para baixar a versão mais recente do documento.

Retornos

Indica o conteúdo do arquivo.

Conteúdo do arquivo
binary

Carregar documento

ID da operação:
UploadDocument

Carrega um arquivo como um novo documento para a pasta especificada.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca de destino.
ID da pasta
 folderId True string

Especifica a ID da pasta de destino. Por exemplo, 'ACTIVE_US!987'.
Herdar perfil de pasta
 inherit_profile_from_folder True boolean

Especifica se os dados do perfil são herdados da pasta pai.
Manter Bloqueado
 keep_locked boolean

Especifica se um bloqueio de documento é mantido após o upload.
Comment
 comment string

Especifica informações adicionais sobre a atualização.
Autor
 author string

Especifica a ID do iManage Work do usuário que criou o documento.
Operator
 operator string

Especifica a ID do usuário que fez check-out do documento ou atualmente está editando o perfil do documento. Por exemplo, 'JSMITH'.
Class
 class string

Especifica a classe para identificar e diferenciar o documento. A classe de documento é categorizada por gênero, departamento, região e assim por diante.
Subclasse
 subclass string

Especifica a subclasse para identificar e diferenciar o documento. A subclasse do documento é categorizada por gênero, departamento, região e assim por diante.
Segurança Padrão
 default_security string

Especifica o nível de acesso de segurança padrão. Os valores possíveis são 'inherit', 'private', 'view', 'public'.
É HIPAA
 is_hipaa boolean

Especifica se o documento deve ser criptografado.
Dias de Retenção
 retain_days integer

Especifica o número de dias em que um documento deve estar inativo antes de marcá-lo para arquivamento.
Conteúdo do Arquivo
 file True file

Especifica o conteúdo do arquivo.
Data de criação do arquivo
 file_create_date date-time

Especifica a data e hora (no formato ISO 8601) que o arquivo foi criado. O arquivo poderia ter sido criado fora do sistema iManage Work. Essa data pode ser diferente de "create_date". O create_date é a data em que o arquivo foi criado ou importado pelo sistema iManage Work.
Data de Edição do Arquivo
 file_edit_date date-time

Especifica a data e hora (no formato ISO 8601) da alteração mais recente para o arquivo. O arquivo pode ter sido alterado antes de ser carregado no sistema iManage Work.
Custom1
 custom1 string

Especifica o valor para custom1.
Custom2
 custom2 string

Especifica o valor para custom2. Para especificar um valor para custom2, você também deve especificar um valor para custom1 na mesma solicitação, que é devido à relação pai-filho.
Personalizado3
 custom3 string

Especifica o valor para custom3.
Personalizado4
 custom4 string

Especifica o valor para custom4.
Custom5
 custom5 string

Especifica o valor para custom5.
Custom6
 custom6 string

Especifica o valor para custom6.
Custom7
 custom7 string

Especifica o valor para custom7.
Custom8
 custom8 string

Especifica o valor para custom8.
Custom9
 custom9 string

Especifica o valor para custom9.
Custom10
 custom10 string

Especifica o valor para custom10.
Custom11
 custom11 string

Especifica o valor para custom11.
Personalizado12
 custom12 string

Especifica o valor para custom12.
Personalizado13
 custom13 string

Especifica o valor para custom13.
Personalizado14
 custom14 string

Especifica o valor para custom14.
Personalizado15
 custom15 string

Especifica o valor para custom15.
Personalizado16
 custom16 string

Especifica o valor para custom16.
Personalizado17
 custom17 double

Especifica o valor para custom17.
Personalizado18
 custom18 double

Especifica o valor para custom18.
Personalizado19
 custom19 double

Especifica o valor para custom19.
Custom20
 custom20 double

Especifica o valor para custom20.
Custom21
 custom21 string

Especifica o valor para custom21 no formato de datetime ISO 8601.
Custom22
 custom22 string

Especifica o valor para custom22 no formato de datetime ISO 8601.
Personalizado23
 custom23 string

Especifica o valor para custom23 no formato de datetime ISO 8601.
Personalizado24
 custom24 string

Especifica o valor para custom24 no formato de datetime ISO 8601.
Personalizado25
 custom25 boolean

Especifica o valor para custom25.
Custom26
 custom26 boolean

Especifica o valor para custom26.
Personalizado27
 custom27 boolean

Especifica o valor para custom27.
Custom28
 custom28 boolean

Especifica o valor para custom28.
Custom29
 custom29 string

Especifica o valor para custom29.
Custom30
 custom30 string

Especifica o valor para custom30. Para especificar um valor para custom30, você também deve especificar um valor para custom29 na mesma solicitação, que é devido à relação pai-filho.

Copiar documento

ID da operação:
CopyDocument

Copia um documento para a pasta especificada.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
ID da pasta de destino
 folderId True string

Especifica a ID da pasta de destino para a qual o documento deve ser copiado. Por exemplo, 'ACTIVE_US!987'.

Retornos

Nome Caminho Tipo Description
Acesso a documentos
 data.access string

Indica o conjunto de permissões de nível de acesso para um documento ou contêiner. O nível de acesso é definido pelo autor ou por um usuário com acesso total ao item. Os valores possíveis são 'no_access', 'read', 'read_write', 'full_access'.
Alias
 data.alias string

Indica o alias deste documento.
Autor
 data.author string

Indica a ID do usuário que criou o documento. Por exemplo, 'JSMITH'.
Descrição do autor
 data.author_description string

Indica informações adicionais sobre o autor do documento.
Cc
 data.cc string

Indica destinatários para os quais o email é copiado em carbono. Aplicável somente a emails.
Classe de documento
 data.class string

Indica a classe do documento.
Descrição da classe de documento
 data.class_description string

Indica informações adicionais sobre a classe de documento.
Tipo de conteúdo
 data.content_type string

Indica o tipo de conteúdo do documento.
Data de criação do documento
 data.create_date string

Indica a data e hora (no formato ISO 8601) em que o documento foi importado para o sistema iManage Work. Essa data pode ser diferente de "file_create_date".
Base de dados
 data.database string

Indica a biblioteca em que o documento é armazenado.
Segurança padrão do documento
 data.default_security string

Indica o nível de acesso de segurança padrão. Os valores possíveis são 'inherit', 'private', 'view', 'public'.
Número do documento
 data.document_number integer

Indica o número do documento de um documento.
URL do documento
 data.document_url string

Indica o link compartilhável para o documento.
Data de Edição do Documento
 data.edit_date string

Indica a data e hora (no formato ISO 8601) da alteração mais recente para o documento.
Data de Edição do Perfil
 data.edit_profile_date string

Indica a data e hora (no formato ISO 8601) da alteração mais recente para o perfil do documento.
Extensão do documento
 data.extension string

Indica a extensão de nome de arquivo, também chamada de extensão do aplicativo, do documento.
Data de criação do arquivo
 data.file_create_date string

Indica a data e hora (no formato ISO 8601) que o arquivo foi criado. O arquivo pode ter sido criado fora do sistema iManage Work. Essa data pode ser diferente de "create_date".
Data de Edição de Arquivo
 data.file_edit_date string

Indica a data e hora (no formato ISO 8601) da alteração mais recente para o arquivo. O arquivo pode ter sido alterado antes de ser carregado no sistema iManage Work.
De
 data.from string

Indica o remetente do email. Aplicável somente a emails.
Nome completo do arquivo
 data.full_file_name string

Indica o nome completo do arquivo do documento. Inclui a extensão de nome de arquivo.
Tem Anexo
 data.has_attachment boolean

Indica se o email tem anexos. Aplicável somente a emails.
Propriedades básicas do documento
 data.basic_properties string

Indica um elemento '' inserível que contém propriedades básicas do documento.
ID do documento
 data.id string

Indica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
É indexável
 data.indexable boolean

Indica se o documento é indexado pelo sistema.
Está com check-out
 data.is_checked_out boolean

Indica se o documento está com check-out.
É Declarado
 data.is_declared boolean

Indica se o documento é declarado como um registro. Um documento declarado como um registro não pode ser editado ou excluído, exceto por um administrador do sistema iManage Work.
É Externo
 data.is_external boolean

Indica se o documento é compartilhado com usuários externos.
É externo como normal
 data.is_external_as_normal boolean

Indica se o documento é externo como normal.
É HIPAA
 data.is_hipaa boolean

Indica se o documento está criptografado.
Está em uso
 data.is_in_use boolean

Indica se o documento está em uso.
Link do documento
 data.iwl string

Indica o iWL (iManage Work Link) para o documento. O iWL é usado para abrir o documento no Modo de Exibição Protegido pelo usuário que tem 'read_write' ou 'full_access'.
Último Usuário
 data.last_user string

Indica a ID do usuário que editou o documento mais recentemente. Por exemplo, 'JSMITH'.
Descrição do último usuário
 data.last_user_description string

Indica informações adicionais sobre o último usuário que editou o documento mais recentemente.
Nome do documento
 data.name string

Indica o nome do arquivo do documento.
Operator
 data.operator string

Indica a ID do usuário que fez check-out do documento ou atualmente está editando seu perfil. Por exemplo, 'JSMITH'.
Descrição do operador
 data.operator_description string

Indica informações adicionais sobre o operador.
Data de Recebimento
 data.received_date string

Indica a data e hora (no formato ISO 8601) que o email foi recebido. Aplicável somente a emails.
Dias de Retenção
 data.retain_days integer

Indica o número de dias antes de o documento ser qualificado para arquivamento. Aplicável somente a documentos inativos.
Data de envio
 data.sent_date string

Indica a data e hora (no formato ISO 8601) que o email foi enviado. Aplicável somente a emails.
Tamanho do documento
 data.size integer

Indica o tamanho do documento em bytes.
Subclasse
 data.subclass string

Indica a subclasse do documento.
Descrição da subclasse
 data.subclass_description string

Indica informações adicionais sobre a subclasse do documento.
Para
 data.to string

Indica o destinatário do email. Aplicável somente a emails.
Tipo
 data.type string

Indica o tipo de documento. Por exemplo, WORD para Microsoft Word. Para obter uma lista atual de tipos, entre em contato com o administrador do sistema do iManage Work.
Descrição do tipo
 data.type_description string

Indica informações adicionais sobre o tipo do documento.
Versão do documento
 data.version integer

Indica o número de versão do documento.
ID do workspace
 data.workspace_id string

Indica a ID do workspace do documento. Por exemplo, 'ACTIVE_US!427'.
Nome do workspace
 data.workspace_name string

Indica o nome do workspace do documento.
Wstype
 data.wstype string

Indica o tipo iManage Work do objeto. Os valores possíveis são 'document', 'folder', 'workspace', 'email', 'document_shortcut', 'folder_shortcut', 'workspace_shortcut', 'user'.
Personalizado13
 data.custom13 string

Indica o valor de custom13.
Personalizado14
 data.custom14 string

Indica o valor de custom14.
Personalizado15
 data.custom15 string

Indica o valor de custom15.
Personalizado16
 data.custom16 string

Indica o valor de custom16.
Custom21
 data.custom21 string

Indica o valor da propriedade custom21 no formato datetime ISO 8601.
Custom22
 data.custom22 string

Indica o valor da propriedade custom22 no formato datetime ISO 8601.

Criar relação de documento

ID da operação:
CreateDocumentRelation

Cria uma relação entre documentos especificados em uma biblioteca.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento primário
 primaryDocumentId True string

Especifica a ID do documento primário a ser relacionado. Por exemplo, 'ACTIVE_US!453.1'.
ID do documento relacionado
 relatedDocumentId True string

Especifica a ID do documento a ser relacionado. Por exemplo, 'ACTIVE_US!453.1'.

Retornos

response
object

Criar workspace

ID da operação:
CreateWorkspace

Cria um novo workspace com base no modelo selecionado. Um modelo de workspace é um workspace predefinido cuja estrutura é copiada para o novo workspace. As restrições no modelo de workspace são aplicadas automaticamente ao criar o novo workspace.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca do workspace de destino.
Template
 templateId True string

Especifica o modelo de workspace a ser usado para criar o workspace e seus filhos.
Nome
 name True string

Especifica o nome do workspace.
Criar filhos
 createChildren True string

Especifica para criar todas as pastas (opcionais e necessárias) ou apenas as pastas necessárias.
Proprietário do workspace
 owner string

Especifica o proprietário do workspace. Você deve ser um administrador do sistema iManage Work para definir o proprietário de um workspace.
Segurança Padrão
 default_security string

Especifica o nível de acesso padrão. Se não for especificado, o nível de acesso padrão do modelo selecionado será usado.
Description
 description string

Especifica informações adicionais sobre o workspace.
Custom1
 custom1 string

Especifica o valor de custom1 a ser associado ao workspace recém-criado. Esse valor substitui o valor personalizado1 do workspace de modelo selecionado, se presente. Se as pastas filho tiverem um conjunto de valores personalizado1, o valor personalizado1 dessas pastas filho não será substituído.
Custom2
 custom2 string

Especifica o valor de custom2 a ser associado ao workspace recém-criado. Para especificar um valor para custom2, você também deve especificar um valor para custom1 na mesma solicitação, que é devido à relação pai-filho. Esse valor substitui o valor personalizado2 do workspace de modelo selecionado, se presente. Se as pastas filho tiverem um conjunto de valores personalizado2, o valor personalizado2 dessas pastas filho não será substituído.
Personalizado3
 custom3 string

Especifica o valor de custom3.
Personalizado4
 custom4 string

Especifica o valor de custom4.
Custom5
 custom5 string

Especifica o valor de custom5.
Custom6
 custom6 string

Especifica o valor do custom6.
Custom7
 custom7 string

Especifica o valor de custom7.
Custom8
 custom8 string

Especifica o valor de custom8.
Custom9
 custom9 string

Especifica o valor de custom9.
Custom10
 custom10 string

Especifica o valor de custom10.
Custom11
 custom11 string

Especifica o valor de custom11.
Personalizado12
 custom12 string

Especifica o valor de custom12.
Personalizado13
 custom13 string

Especifica o valor de custom13.
Personalizado14
 custom14 string

Especifica o valor de custom14.
Personalizado15
 custom15 string

Especifica o valor de custom15.
Personalizado16
 custom16 string

Especifica o valor de custom16.
Personalizado17
 custom17 double

Especifica o valor de custom17.
Personalizado18
 custom18 double

Especifica o valor de custom18.
Personalizado19
 custom19 double

Especifica o valor de custom19.
Custom20
 custom20 double

Especifica o valor de custom20.
Custom21
 custom21 string

Especifica o valor de custom21 no formato de datetime ISO 8601.
Custom22
 custom22 string

Especifica o valor de custom22 no formato de datetime ISO 8601.
Personalizado23
 custom23 string

Especifica o valor de custom23 no formato de datetime ISO 8601.
Personalizado24
 custom24 string

Especifica o valor de custom24 no formato de datetime ISO 8601.
Personalizado25
 custom25 boolean

Especifica o valor de custom25.
Custom26
 custom26 boolean

Especifica o valor de custom26.
Personalizado27
 custom27 boolean

Especifica o valor de custom27.
Custom28
 custom28 boolean

Especifica o valor de custom28.
Custom29
 custom29 string

Especifica o valor de custom29.
Custom30
 custom30 string

Especifica o valor de custom30. Para especificar um valor para custom30, você também deve especificar um valor para custom29 na mesma solicitação, que é devido à relação pai-filho.
É externo como normal
 is_external_as_normal boolean

Especifica que o workspace pode ser tratado como um workspace público. Se definido como 'true' e 'default_security' não for 'privado', definirá 'is_external' como 'true'.
Projeto Personalizado1
 project_custom1 string

Especifica informações adicionais sobre o workspace. Esse campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, workspaces ou pastas. Esse é um texto descritivo que não precisa ser formatado e não é validado.
Projeto Personalizado2
 project_custom2 string

Especifica informações adicionais sobre o workspace. Esse campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, workspaces ou pastas. Esse é um texto descritivo que não precisa ser formatado e não é validado.
Projeto Personalizado3
 project_custom3 string

Especifica informações adicionais sobre o workspace. Esse campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, workspaces ou pastas. Esse é um texto descritivo que não precisa ser formatado e não é validado.
Subclasse do workspace
 subclass string

Especifica a subclasse do workspace com base na subclasse do documento que ele contém.

Definir propriedades de metadados estendidos principais em um documento

ID da operação:
SetCoreEMPropertiesForDocument

Define as principais propriedades de metadados estendidos em um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
Nome
 key True string

Especifica o nome da propriedade de metadados estendidos principal.
Value
 value True string

Especifica um ou mais valores a serem definidos para a propriedade de metadados estendidos principal, separada por ponto-e-vírgula. Para desafinar o valor, defina o valor da chave como uma cadeia de caracteres vazia encapsulada em aspas simples ou duplas.

Editar pares nome-valor

ID da operação:
EditNVP

Cria, atualiza ou exclui propriedades de par nome-valor de um documento, pasta ou workspace. Para excluir um par nome-valor, defina o valor da chave como uma cadeia de caracteres vazia encapsulada em aspas simples ou duplas.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de objeto
 objectType True string

Especifica o tipo de objeto. Os valores possíveis são 'document', 'folder', 'workspace'.
ID do objeto
 objectId True string

Especifica a ID do documento, pasta ou workspace. Um exemplo de uma ID de documento é 'ACTIVE_US!453.1'. Um exemplo de uma ID de pasta ou workspace é 'ACTIVE_US!123'.
Pares nome-valor
 nameValuePairs object

Especifica os pares de nome e valor de formulário livre para este documento.

Excluir documento

ID da operação:
DeleteDocument

Exclui o documento especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
Excluir todas as versões
 deleteAllVersions True boolean

Especifica a exclusão de todas as versões do documento.

Excluir referência de documento

ID da operação:
DeleteDocumentReference

Exclui a referência de documento da pasta especificada.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
ID da pasta
 folderId True string

Especifica a ID da pasta. Por exemplo, 'ACTIVE_US!773'.

Retornos

response
object

Excluir relação de documento

ID da operação:
DeleteDocumentRelation

Exclui uma relação entre documentos especificados em uma biblioteca.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento primário
 primaryDocumentId True string

Especifica a ID do documento primário. Por exemplo, 'ACTIVE_US!453.1'.
ID do documento relacionado
 relatedDocumentId True string

Especifica a ID do documento relacionado. Por exemplo, 'ACTIVE_US!453.1'.

Retornos

response
object

Mover documento

ID da operação:
MoveDocument

Move um documento para a pasta especificada.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da pasta pai
 folderId True string

Especifica a ID da pasta pai. Por exemplo, 'ACTIVE_US!987'.
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
ID da pasta de destino
 destination_folder_id True string

Especifica a ID da pasta de destino para a qual o documento deve ser movido. Por exemplo, 'ACTIVE_US!987'.
Aplicar perfil de destino
 update_profile boolean

Especifica se o perfil do documento deve ser atualizado com o perfil da pasta de destino.
Aplicar segurança de destino
 update_security boolean

Especifica se a segurança do documento deve ser atualizada com a segurança da pasta de destino. Esse parâmetro é aplicável somente quando o Perfil de Atualização é definido como true.
Comentários da linha do tempo
 comments string

Especifica informações adicionais sobre a operação. Esses comentários são visíveis na linha do tempo do documento.

Obter administradores

ID da operação:
GetTrustees

Obtém uma lista de administradores com determinadas permissões para um documento, pasta ou workspace. Um administrador pode ser um usuário ou grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de objeto
 objectType True string

Especifica o tipo de objeto.
ID do objeto
 objectId True string

Especifica a ID do documento, pasta ou workspace. Um exemplo de uma ID de documento é 'ACTIVE_US!453.1'. Um exemplo de uma ID de pasta ou workspace é 'ACTIVE_US!123'.

Retornos

Nome Caminho Tipo Description
dados
 data array of object

Indica a lista de administradores com determinadas permissões para um documento, pasta ou workspace. Um administrador pode ser um usuário ou grupo.
Nome Completo
 data.full_name string

Indica o nome completo do administrador.
ID
 data.id string

Indica a ID do administrador. Pode ser uma ID de grupo ou uma ID de usuário. Por exemplo, 'JSMITH' ou 'MARKETING'.
SSID
 data.ssid string

Indica a ID exclusiva gerada pelo sistema do administrador.
Tipo
 data.type string

Indica o tipo de entidade retornado. Os valores possíveis são 'user' ou 'group'.

Obter as principais propriedades de metadados estendidos de um documento

ID da operação:
GetCoreEMPropertiesForDocument

Obtém as principais propriedades de metadados estendidos de um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
Mais recente
 latest boolean

Especifica para obter a versão mais recente do documento.

Obter bibliotecas

ID da operação:
GetLibraries

Obtém uma lista de bibliotecas às quais o usuário tem acesso.

Retornos

Nome Caminho Tipo Description
dados
 data array of object

Indica a lista de bibliotecas às quais o usuário tem acesso.
ID
 data.id string

Indica o nome da biblioteca.
Nome
 data.display_name string

Indica o nome de exibição da biblioteca.
Tipo
 data.type string

Indica o tipo da biblioteca. Os valores possíveis são 'worksite' ou 'linksite'.
Está oculto
 data.is_hidden boolean

Indica se a biblioteca está oculta.

Obter classes

ID da operação:
GetClasses

Obtém a lista de classes de documento disponíveis em uma biblioteca que corresponde aos critérios especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca da classe de destino.
ID da Classe
 alias string

Especifica a ID de uma classe ou classes a serem pesquisadas. Pode ser uma lista separada por vírgulas. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para o caractere curinga (*) e as correspondências parciais.
Segurança Padrão
 default_security string

Especifica o nível de acesso de segurança padrão.
Description
 description string

Especifica o texto a ser correspondido no campo de descrição. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para o caractere curinga (*). Não há suporte para correspondências parciais.
Eco
 echo boolean

Especifica se documentos dessa classe podem ecoar documentos.
HIPAA
 hipaa boolean

Especifica se os documentos dessa classe usam criptografia compatível com HIPAA.
Indexável
 indexable boolean

Especifica se os documentos dessa classe são indexados pelo indexador de texto completo do sistema.
Query
 query string

Especifica o texto a ser correspondido com os campos de ID ou descrição. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para o caractere curinga (*) e as correspondências parciais.
Subclasse necessária
 subclass_required boolean

Especifica se a classe tem uma subclasse necessária.

Retornos

Nome Caminho Tipo Description
ID da classe de correspondência superior
 data.topMatchingId string

Indica a ID da classe de correspondência superior. Por exemplo, 'PETITION'.
Descrição da classe de correspondência superior
 data.topMatchingDescription string

Indica a descrição da classe de correspondência superior.
results
 data.results array of object

Indica a lista de classes disponíveis em uma biblioteca que correspondem aos critérios especificados.
Description
 data.results.description string

Indica informações adicionais sobre a classe.
É HIPAA
 data.results.hipaa boolean

Indica se o documento está criptografado.
ID
 data.results.id string

Indica a ID da classe. Por exemplo, 'PETITION'.
É indexável
 data.results.indexable boolean

Indica se o documento é indexado pelo sistema.
Segurança Padrão
 data.results.default_security string

Indica o nível de acesso de segurança padrão. Os valores possíveis são 'public', 'view', 'private'.
Retain
 data.results.retain integer

Indica o número de dias antes de marcar documentos inativos dessa classe como expirados.
Campos necessários
 data.results.required_fields array of string

Indica as propriedades personalizadas obrigatórias a serem inseridas ao criar ou atualizar um documento dessa classe.
É Sombreado
 data.results.shadow boolean

Indica se um documento dessa classe é sombreado (retido) no computador local de um usuário depois de fazer check-in.
É necessária subclasse
 data.results.subclass_required boolean

Indica se uma subclasse é necessária para essa classe.

Obter detalhes do usuário

ID da operação:
GetUserDetails

Obtém informações sobre um usuário da biblioteca especificada.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca do usuário de destino.
ID do Usuário
 userId True string

Especifica a ID do usuário para o qual obter informações detalhadas do perfil. Por exemplo, 'JSMITH'.

Retornos

Nome Caminho Tipo Description
dados
 data UserProfile

Indica informações sobre um usuário.

Obter membros do grupo

ID da operação:
GetGroupMembers

Obtenha detalhes dos usuários que pertencem ao grupo especificado e corresponda aos critérios especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca do grupo de destino.
ID do grupo
 groupId True string

Especifica o ID do grupo. Por exemplo, 'MARKETING'.
Logon Status
 logon_status string

Especifica um filtro para usuários com base no valor da propriedade "allow_logon" atual para cada usuário.
Limit
 limit integer

Especifica o número máximo de membros a serem retornados independentemente do número total de membros no grupo.
Biblioteca preferencial
 preferred_library string

Especifica que somente os usuários cuja biblioteca preferencial corresponde ao valor fornecido sejam retornados.
Localização
 location string

Especifica o local a ser usado para localizar usuários com base em sua localização geográfica. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*).

Retornos

Nome Caminho Tipo Description
dados
 data array of UserProfileInArray

Indica a lista de usuários que pertencem ao grupo especificado e correspondem aos critérios especificados.

Obter modelos de workspace

ID da operação:
GetWorkspaceTemplates

Obtém a lista de modelos disponíveis em uma biblioteca. Um modelo de workspace é um workspace predefinido cuja estrutura é copiada para o novo workspace.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca do workspace de destino.
Custom1
 custom1 string

Especifica um valor a ser correspondido com o valor personalizado1 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom2
 custom2 string

Especifica um valor a ser correspondido com o valor personalizado2 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado3
 custom3 string

Especifica um valor a ser correspondido com o valor personalizado3 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado4
 custom4 string

Especifica um valor a ser correspondido com o valor personalizado4 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom5
 custom5 string

Especifica um valor a ser correspondido com o valor personalizado5 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom6
 custom6 string

Especifica um valor a ser correspondido com o valor custom6 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom7
 custom7 string

Especifica um valor a ser correspondido com o valor personalizado7 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom8
 custom8 string

Especifica um valor a ser correspondido com o valor personalizado8 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom9
 custom9 string

Especifica um valor a ser correspondido com o valor custom9 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom10
 custom10 string

Especifica um valor a ser correspondido com o valor personalizado10 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom11
 custom11 string

Especifica um valor a ser correspondido com o valor personalizado11 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado12
 custom12 string

Especifica um valor a ser correspondido com o valor personalizado12 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado17
 custom17 double

Especifica o valor para custom17.
Personalizado18
 custom18 double

Especifica o valor para custom18.
Personalizado19
 custom19 double

Especifica o valor para custom19.
Custom20
 custom20 double

Especifica o valor para custom20.
Custom21
 custom21 string

Especifica o valor (no formato de datetime ISO 8601) a ser pesquisado em custom21 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Custom22
 custom22 string

Especifica o valor (no formato de datetime ISO 8601) a ser pesquisado em custom22 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Personalizado23
 custom23 string

Especifica o valor (no formato de datetime ISO 8601) a ser pesquisado em custom23 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Personalizado24
 custom24 string

Especifica o valor (no formato de datetime ISO 8601) a ser pesquisado em personalizado24 associado ao modelo de workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Custom21 (Limite Inferior)
 custom21_from string

Especifica o limite inferior de custom21 (no formato datetime ISO 8601) a ser pesquisado. Essa propriedade não é reservada pelo iManage Work e não é um valor validado. Ele se destina a ser personalizado para os requisitos da sua empresa.
Custom21 (Limite Superior)
 custom21_to string

Especifica o limite superior de custom21 (no formato datetime ISO 8601) a ser pesquisado. Essa propriedade não é reservada pelo iManage Work e não é um valor validado. Ele se destina a ser personalizado para os requisitos da sua empresa.
Custom21 (Relativo)
 custom21_relative string

Especifica um intervalo de datas a ser pesquisado em relação à data atual. Esse parâmetro tem um formato de [begin]:[end][time units (d, m ou y)]. Por exemplo, -15:1d especifica um intervalo de datas de 15 dias antes da data atual até um dia após a data atual (um dia no futuro).
Custom22 (Limite Inferior)
 custom22_from string

Especifica o limite inferior de custom22 (no formato datetime ISO 8601) a ser pesquisado. Essa propriedade não é reservada pelo iManage Work e não é um valor validado. Ele se destina a ser personalizado para os requisitos da sua empresa.
Custom22 (Limite Superior)
 custom22_to string

Especifica o limite superior de custom22 (no formato datetime ISO 8601) a ser pesquisado. Essa propriedade não é reservada pelo iManage Work e não é um valor validado. Ele se destina a ser personalizado para os requisitos da sua empresa.
Custom22 (Relativo)
 custom22_relative string

Especifica um intervalo de datas a ser pesquisado em relação à data atual. Esse parâmetro tem um formato de [begin]:[end][time units (d, m ou y)]. Por exemplo, -15:1d especifica um intervalo de datas de 15 dias antes da data atual até um dia após a data atual (um dia no futuro).
Personalizado23 (Limite Inferior)
 custom23_from string

Especifica o limite inferior de custom23 (no formato datetime ISO 8601) a ser pesquisado. Essa propriedade não é reservada pelo iManage Work e não é um valor validado. Ele se destina a ser personalizado para os requisitos da sua empresa.
Personalizado23 (Limite Superior)
 custom23_to string

Especifica o limite superior de custom23 (no formato datetime ISO 8601) a ser pesquisado. Essa propriedade não é reservada pelo iManage Work e não é um valor validado. Ele se destina a ser personalizado para os requisitos da sua empresa.
Custom23 (Relative)
 custom23_relative string

Especifica um intervalo de datas a ser pesquisado em relação à data atual. Esse parâmetro tem um formato de [begin]:[end][time units (d, m ou y)]. Por exemplo, -15:1d especifica um intervalo de datas de 15 dias antes da data atual até um dia após a data atual (um dia no futuro).
Custom24 (Limite Inferior)
 custom24_from string

Especifica o limite inferior de custom24 (no formato datetime ISO 8601) a ser pesquisado. Essa propriedade não é reservada pelo iManage Work e não é um valor validado. Ele se destina a ser personalizado para os requisitos da sua empresa.
Custom24 (Limite Superior)
 custom24_to string

Especifica o limite superior de custom24 (no formato datetime ISO 8601) a ser pesquisado. Essa propriedade não é reservada pelo iManage Work e não é um valor validado. Ele se destina a ser personalizado para os requisitos da sua empresa.
Personalizado24 (Relativo)
 custom24_relative string

Especifica um intervalo de datas a ser pesquisado em relação à data atual. Esse parâmetro tem um formato de [begin]:[end][time units (d, m ou y)]. Por exemplo, -15:1d especifica um intervalo de datas de 15 dias antes da data atual até um dia após a data atual (um dia no futuro).
Personalizado25
 custom25 boolean

Especifica o valor personalizado25 a ser pesquisado.
Custom26
 custom26 boolean

Especifica o valor personalizado26 a ser pesquisado.
Personalizado27
 custom27 boolean

Especifica o valor personalizado27 a ser pesquisado.
Custom28
 custom28 boolean

Especifica o valor personalizado28 a ser pesquisado.
Custom29
 custom29 string

Especifica um valor a ser correspondido com custom29. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom30
 custom30 string

Especifica um valor a ser correspondido com custom30. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.

Obter o perfil do documento

ID da operação:
GetDocumentProfile

Obtém as propriedades do documento associadas a uma ID de documento específica.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
Obter a versão mais recente
 latest boolean

Especifica para obter a versão mais recente do documento.

Obter perfil do workspace

ID da operação:
GetWorkspaceProfile

Obtém o perfil do workspace e, opcionalmente, a lista de operações permitidas para o workspace.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do workspace
 workspaceId True string

Especifica a ID do workspace. Por exemplo, 'ACTIVE_US!427'.

Obter permissões

ID da operação:
GetPermissions

Obtém propriedades de permissão de acesso de usuário ou grupo de um documento, pasta ou workspace. As propriedades de resposta podem variar com permissões de usuário ou grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de objeto
 objectType True string

Especifica o tipo de objeto.
ID do objeto
 objectId True string

Especifica a ID do documento, pasta ou workspace. Um exemplo de uma ID de documento é 'ACTIVE_US!453.1'. Um exemplo de uma ID de pasta ou workspace é 'ACTIVE_US!123'.

Retornos

Nome Caminho Tipo Description
Segurança Padrão
 data.default_security string

Indica a segurança padrão do objeto. Os valores possíveis são 'inherit', 'public', 'view' ou 'private'.
Segurança padrão herdada
 data.inherited_default_security string

Indica a segurança padrão herdada de uma pasta quando a segurança padrão é definida como "herdar". Os valores possíveis são 'public', 'view' ou 'private'.
Permissões de Acesso
 data.acl AccessPermissions

Indica uma coleção de permissões de acesso para um ou mais usuários e/ou grupos.
Todas as IDs de usuário
 data.all_user_ids string

Indica uma lista de todas as IDs de usuário, concatenadas como uma cadeia de caracteres e separadas por ponto-e-vírgula.
Todas as IDs de Grupo
 data.all_group_ids string

Indica uma lista de todas as IDs de grupo, concatenadas como uma cadeia de caracteres e separadas por ponto-e-vírgula.

Obter subclasses

ID da operação:
GetSubclasses

Obtém todas as subclasses de biblioteca que correspondem aos critérios especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca da subclasse de destino.
ID da Classe
 classId True string

Especifica a ID da Classe que é o pai dessa subclasse. Por exemplo, 'PETITION'.
ID da subclasse
 alias string

Especifica a ID das subclasses a serem pesquisadas. Pode ser uma lista separada por vírgulas. Há suporte para o caractere curinga (*). Há suporte para correspondências parciais quando o caractere curinga é usado.
Segurança Padrão
 default_security string

Especifica o nível de acesso de segurança padrão.
Description
 description string

Especifica o texto a ser correspondido no campo de descrição. Há suporte para o caractere curinga (*). Há suporte para correspondências parciais quando o caractere curinga é usado.
Eco
 echo boolean

Especifica se as subclasses podem ser ecoadas no disco rígido local de um usuário. Isso é para facilitar o trabalho offline.
HIPAA
 hipaa boolean

Especifica se as subclasses compatíveis com HIPAA devem ser retornadas.
Query
 query string

Especifica o texto a ser correspondido com os campos de ID ou descrição da Subclasse. Há suporte para o caractere curinga (*). Há suporte para correspondências parciais.

Retornos

Nome Caminho Tipo Description
ID da subclasse de correspondência superior
 data.topMatchingId string

Indica a ID da subclasse de correspondência superior.
Descrição da subclasse de correspondência superior
 data.topMatchingDescription string

Indica a descrição da subclasse de correspondência superior.
results
 data.results array of object
Segurança Padrão
 data.results.default_security string

Indica o nível de acesso de segurança padrão. Os valores possíveis são 'public', 'view', 'private'.
Description
 data.results.description string

Indica informações adicionais sobre a subclasse. O comprimento máximo é de 255 caracteres.
É HIPAA
 data.results.hipaa boolean

Indica se o documento está criptografado.
ID
 data.results.id string

Indica a ID de uma subclasse usada para criar ou modificar as informações do perfil do documento. Por exemplo, 'GUARDIANSHIP'.
ID Principal
 data.results.parent.id string

Indica a ID da classe pai da subclasse.
Campos necessários
 data.results.required_fields array of string

Indica as propriedades personalizadas obrigatórias a serem inseridas ao criar ou atualizar um documento dessa subclasse.
Retain
 data.results.retain integer

Indica o número de dias antes de marcar documentos inativos dessa subclasse como expirado.
É Sombreado
 data.results.shadow boolean

Indica se um documento dessa subclasse é sombreado (retido) no computador local de um usuário depois de fazer check-in.

Obter versões do documento

ID da operação:
GetDocumentVersions

Obtém perfis para todas as versões às quais o usuário atual tem acesso para um documento especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.

Retornos

Nome Caminho Tipo Description
Perfis de documento
 data array of MinimalDocumentProfileInArray

Permissões de atualização

ID da operação:
UpdatePermissions

Atualiza as permissões de um objeto.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de objeto
 objectType True string

Especifica o tipo de objeto.
ID do objeto
 objectId True string

Especifica a ID do documento, pasta ou workspace. Um exemplo de uma ID de documento é 'ACTIVE_US!453.1'. Um exemplo de uma ID de pasta ou workspace é 'ACTIVE_US!123'.
Nível de Acesso
 access_level True string

Especifica o nível de acesso.
Usuários
 users string

Especifica um ou mais usuários para definir o nível de acesso, separado por um ponto-e-vírgula.
Groups
 groups string

Especifica um ou mais grupos para definir o nível de acesso, separado por um ponto-e-vírgula.

Retornos

Corpo
UpdatePermissionsResponse

Permissões de cópia

ID da operação:
CopyPermissions

Copia as permissões de acesso e, opcionalmente, a segurança padrão, de um objeto iManage Work para outro. 'Tipo de Cópia' oferece opções de como lidar com a combinação de permissões de origem e de destino. 'Substituir' atualiza os usuários, grupos e níveis de permissão do objeto de destino para corresponder exatamente aos do objeto de origem. 'Merge' mantém todos os usuários e grupos no objeto de destino e os combina com a origem, mas no caso de um conflito de nível de permissão em um indivíduo ou grupo: 'Merge (Pessimista)' usa a permissão inferior, enquanto 'Merge (Optimistic)' usa a permissão mais alta para o usuário ou grupo conflitante.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de objeto de origem
 sourceObjectType True string

Especifica o tipo do objeto de origem.
ID do objeto de origem
 sourceObjectId True string

Especifica a ID do objeto do qual as permissões são copiadas. Um exemplo de uma ID de documento é 'ACTIVE_US!453.1'. Um exemplo de uma ID de pasta ou workspace é 'ACTIVE_US!123'.
Tipo de objeto de destino
 targetObjectType True string

Especifica o tipo do objeto de destino.
ID do objeto de destino
 targetObjectId True string

Especifica a ID do objeto para o qual as permissões são copiadas. Um exemplo de uma ID de documento é 'ACTIVE_US!453.1'. Um exemplo de uma ID de pasta ou workspace é 'ACTIVE_US!123'.
Tipo de Cópia
 copyType True string

Especifica para mesclar as permissões de objeto de origem com permissões de objeto de destino ou substituir permissões de objeto de destino com permissões de origem. Para obter detalhes, consulte a descrição da ação.
Copiar segurança padrão
 copyDefaultSecurity True boolean

Especifica para copiar a segurança padrão do objeto de origem para o objeto de destino. Se a segurança padrão do objeto de origem for 'herdar', a segurança padrão herdada será copiada da origem para o objeto de destino.

Retornos

Corpo
UpdatePermissionsResponse

Pesquisar pastas

ID da operação:
SearchFolders

Pesquise pastas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca da pasta de destino.
ID do contêiner
 container_id string

Especifica a ID do workspace ou pasta da qual as pastas devem ser retornadas. Por exemplo, 'ACTIVE_US!987'. Se esse parâmetro for fornecido, ele retornará pastas somente do workspace ou pasta especificado.
Descrição da pasta
 description string

Especifica um valor a ser encontrado na propriedade de descrição da pasta. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para correspondências parciais.
Endereço de email da pasta
 email string

Especifica o endereço de email a ser correspondido com o endereço de email da pasta. Por exemplo, 'email1234@ajubalaw.com'.
Nome da pasta
 name string

Especifica um valor a ser encontrado na propriedade name da pasta. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para correspondências parciais.
Proprietário da pasta
 owner string

Especifica a cadeia de caracteres a ser correspondida com o proprietário associado à pasta. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para correspondências parciais.
Nome do workspace
 workspace_name string

Especifica o nome do workspace pai ao qual a pasta pertence. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para correspondências parciais.

Pesquisar usuários

ID da operação:
SearchUsers

Pesquisa usuários do iManage Work que correspondem aos critérios de pesquisa especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Email
 email string

Especifica a ID de email a ser pesquisada. Por exemplo, 'JSMITH@XYZ.COM'.

Retornos

Nome Caminho Tipo Description
Permitir Logon
 data.topMatchingUser.allow_logon boolean

Indica se o usuário tem permissão para fazer logon.
Custom1
 data.topMatchingUser.custom1 string

Indica informações adicionais sobre o usuário.
Custom2
 data.topMatchingUser.custom2 string

Indica informações adicionais sobre o usuário.
Personalizado3
 data.topMatchingUser.custom3 string

Indica informações adicionais sobre o usuário.
ID de diretório
 data.topMatchingUser.directory_id string

Indica a ID de um diretório externo (como o ADFS), que é usado para sincronização de perfil de usuário.
Nome Distinto
 data.topMatchingUser.distinguished_name string

Indica o nome do objeto que representa o caminho totalmente qualificado de nomes que rastreiam a entrada de volta para a raiz da árvore LDAP.
Editar Data
 data.topMatchingUser.edit_date string

Indica a data e hora (no formato ISO 8601) da alteração mais recente para o perfil do usuário.
Email
 data.topMatchingUser.email string

Indica a ID de email do usuário.
URL de descoberta automática do Exchange
 data.topMatchingUser.exch_autodiscover string

Indica os detalhes do exchange server do usuário.
Extension
 data.topMatchingUser.extension string

Indica a extensão de número de telefone do usuário.
Tentativas de logon com falha
 data.topMatchingUser.failed_logins integer

Indica o número atual de tentativas de entrada com falha do usuário.
Fac-símile
 data.topMatchingUser.fax string

Indica o número de fax do usuário.
Forçar alteração de senha
 data.topMatchingUser.force_password_change boolean

Indica que o usuário deve alterar sua senha na próxima entrada. Aplicável somente a usuários virtuais, indicado pelo valor 'user_nos' '2'.
Nome Completo
 data.topMatchingUser.full_name string

Indica o nome completo do usuário.
Geral
 data.topMatchingUser.general string

Indica informações gerais sobre o usuário.
ID
 data.topMatchingUser.id string

Indica a ID do usuário. Por exemplo, 'JSMITH'.
É Externo
 data.topMatchingUser.is_external boolean

Indica um usuário externo. Um usuário externo tem acesso limitado e geralmente é usado para membros temporários da equipe, consultores ou externos à organização.
Hora da Última Sincronização
 data.topMatchingUser.last_sync_ts string

Indica a hora da última sincronização (no formato datetime ISO 8601) do perfil do usuário com um diretório externo, como LDAP ou Microsoft Active Directory (ADFS).
Localização
 data.topMatchingUser.location string

Indica a localização geográfica do usuário.
A senha nunca expira
 data.topMatchingUser.password_never_expire boolean

Indica se a senha do usuário nunca expira.
Número de Telefone
 data.topMatchingUser.phone string

Indica o número de telefone do usuário.
Biblioteca preferencial
 data.topMatchingUser.preferred_library string

Indica a biblioteca preferencial. Uma biblioteca preferencial é a biblioteca padrão do usuário. Cada usuário deve ter uma biblioteca preferencial.
Hora da alteração da senha
 data.topMatchingUser.pwd_changed_ts string

Indica a hora (no formato de datetime ISO 8601) em que a senha do usuário foi alterada pela última vez. Isso é aplicável somente a usuários virtuais (cujo USUÁRIO NOS é 2).
SSID
 data.topMatchingUser.ssid string

Indica a ID exclusiva gerada pelo sistema para o usuário.
Domínio
 data.topMatchingUser.user_domain string

Indica o nome de domínio totalmente qualificado para o serviço de diretório do usuário.
ID estendida
 data.topMatchingUser.user_id_ex string

Indica o valor original da ID de usuário recebida de um diretório externo, como o Microsoft Active Directory (ADFS).
NOS
 data.topMatchingUser.user_nos integer

Indica o tipo de sistema operacional do qual o usuário está sincronizado. Os valores possíveis são 2 (usuário virtual) e 6 (usuário enterprise). Para obter mais informações, entre em contato com o administrador do sistema do iManage Work.
Número
 data.topMatchingUser.user_num integer

Indica a ID do sistema numérico do usuário.
results
 data.results array of UserProfileInArray

Pesquisar valores de nó de taxonomia de metadados estendidos do núcleo de pesquisa

ID da operação:
SearchCoreEMTaxonomyNodeValues

Pesquisa valores de nó de taxonomia de metadados estendidos principais que correspondem aos critérios de pesquisa especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca na qual executar a pesquisa.
Propriedade Taxonomy
 taxonomyProperty True string

Especifica a propriedade taxonomia para a qual pesquisar valores de nó.
ID
 id string

Especifica o identificador de exibição do valor do nó de taxonomia. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para correspondências parciais.
Query
 query string

Especifica uma consulta para valores de nó de taxonomia correspondentes usando uma pesquisa curinga (*), fornecendo correspondências parciais para o identificador de exibição ou descrição.
Estado do nó
 enabled_state string

Especifica a devolução apenas de valores de nó de taxonomia habilitados ou desabilitados ou ambos.
Incluir Caminho
 include_path boolean

Especifica para retornar o caminho completo para o valor do nó correspondente. Um caminho é uma lista ordenada começando com o nó de nível superior na taxonomia e, em seguida, todos os nós até o pai imediato do nó correspondente.
SSID do nó ancestral
 children_of_ssid string

Especifica a ID exclusiva gerada pelo sistema do nó de taxonomia ancestral para o qual limitar a pesquisa.
Somente filhos imediatos
 immediate_children_only boolean

Especifica para limitar os resultados da pesquisa a descendentes diretos do nó de taxonomia especificado por 'SSID do nó ancestral'. A pesquisa pode ser limitada ao nível raiz da taxonomia especificando uma cadeia de caracteres vazia para 'SSID do Nó Ancestral' encapsulada em aspas simples ou duplas.

Retornos

Nome Caminho Tipo Description
SSID
 data.topMatchingResult.created_by.ssid string

Indica a ID exclusiva gerada pelo sistema para o usuário que criou o valor do nó correspondente superior.
Criar Data
 data.topMatchingResult.create_date string

Indica a data e hora (no formato ISO 8601) que o valor do nó correspondente superior foi criado.
Description
 data.topMatchingResult.description string

Indica a descrição do valor do nó correspondente superior.
SSID
 data.topMatchingResult.edited_by.ssid string

Indica a ID exclusiva gerada pelo sistema para o usuário que editou pela última vez o valor do nó de correspondência superior.
Editar Data
 data.topMatchingResult.edit_date string

Indica a data e hora (no formato ISO 8601) que o valor do nó correspondente superior foi editado pela última vez.
Está habilitado
 data.topMatchingResult.enabled boolean

Indica se o valor do nó de correspondência superior está habilitado.
ID
 data.topMatchingResult.id string

Indica o identificador de exibição para o valor do nó de correspondência superior.
SSID
 data.topMatchingResult.parent.ssid string

Indica a ID exclusiva gerada pelo sistema para o nó pai imediato do valor do nó de correspondência superior.
SSID
 data.topMatchingResult.ssid string

Indica a ID exclusiva gerada pelo sistema para o valor do nó correspondente superior.
Caminho
 data.topMatchingResult.path array of object

Indica o caminho completo para o valor do nó correspondente superior. Um caminho é uma lista ordenada começando com o nó de nível superior na taxonomia e, em seguida, todos os nós até o pai imediato do nó correspondente.
Cada ID
 data.topMatchingResult.path.id string

Indica o identificador de exibição para um valor de nó no caminho do nó de correspondência superior.
Cada SSID
 data.topMatchingResult.path.ssid string

Indica a ID exclusiva gerada pelo sistema para um valor de nó no caminho do nó de correspondência superior.
Principais resultados da pesquisa de taxonomia de metadados estendidos
 data.results array of TaxonomyNodeValue

Indica um ou mais valores de nó de taxonomia de metadados estendidos principais que correspondem à pesquisa.
Todos os SSIDs de Nó de Taxonomia
 data.all_taxonomy_ssids string

Indica uma lista de todos os SSIDs de nó de taxonomia, concatenados como uma cadeia de caracteres e separados por ponto-e-vírgula.

Pesquisar workspaces

ID da operação:
SearchWorkspaces

Pesquise workspaces.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca do workspace de destino.
Title
 name string

Especifica a cadeia de caracteres a ser pesquisada na propriedade name do workspace. Essa pesquisa não diferencia maiúsculas de minúsculas.
Proprietário
 owner string

Especifica a cadeia de caracteres a ser correspondida com o proprietário associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas.
Keyword
 anywhere string

Especifica o texto a ser pesquisado em qualquer lugar no perfil do workspace. Essa pesquisa não diferencia maiúsculas de minúsculas.
Description
 description string

Especifica o texto a ser pesquisado na propriedade de descrição do workspace. Essa pesquisa não diferencia maiúsculas de minúsculas.
Subclasse
 subclass string

Especifica um valor a ser correspondido com o valor de subclasse associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas.
Custom1
 custom1 string

Especifica um valor a ser correspondido com o valor personalizado1 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom2
 custom2 string

Especifica um valor a ser correspondido com o valor personalizado2 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado3
 custom3 string

Especifica um valor a ser correspondido com o valor personalizado3 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado4
 custom4 string

Especifica um valor a ser correspondido com o valor personalizado4 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom5
 custom5 string

Especifica um valor a ser correspondido com o valor personalizado5 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom6
 custom6 string

Especifica um valor a ser correspondido com o valor custom6 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom7
 custom7 string

Especifica um valor a ser correspondido com o valor personalizado7 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom8
 custom8 string

Especifica um valor a ser correspondido com o valor personalizado8 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom9
 custom9 string

Especifica um valor a ser correspondido com o valor custom9 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom10
 custom10 string

Especifica um valor a ser correspondido com o valor personalizado10 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom11
 custom11 string

Especifica um valor a ser correspondido com o valor personalizado11 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado12
 custom12 string

Especifica um valor a ser correspondido com o valor personalizado12 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado13
 custom13 string

Especifica um valor a ser correspondido com o valor personalizado13 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado14
 custom14 string

Especifica um valor a ser correspondido com o valor personalizado14 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado15
 custom15 string

Especifica um valor a ser correspondido com o valor personalizado15 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado16
 custom16 string

Especifica um valor a ser correspondido com o valor personalizado16 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado17
 custom17 string

Especifica um valor a ser correspondido com o valor personalizado17 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado18
 custom18 string

Especifica um valor a ser correspondido com o valor personalizado18 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Personalizado19
 custom19 string

Especifica um valor a ser correspondido com o valor personalizado19 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom20
 custom20 string

Especifica um valor a ser correspondido com o valor personalizado20 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom21 (Limite Inferior)
 custom21_from string

Especifica o limite inferior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom21 associada ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Custom21 (Limite Superior)
 custom21_to string

Especifica o limite superior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom21 associada ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Custom22 (Limite Inferior)
 custom22_from string

Especifica o limite inferior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom22 associada ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Custom22 (Limite Superior)
 custom22_to string

Especifica o limite superior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom22 associada ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Personalizado23 (Limite Inferior)
 custom23_from string

Especifica o limite inferior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom23 associada ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Personalizado23 (Limite Superior)
 custom23_to string

Especifica o limite superior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom23 associada ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Custom24 (Limite Inferior)
 custom24_from string

Especifica o limite inferior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom24 associada ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Custom24 (Limite Superior)
 custom24_to string

Especifica o limite superior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom24 associada ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Para workspaces, o uso dessa propriedade é personalizado para sua instalação do iManage Work.
Personalizado25
 custom25 boolean

Especifica um valor a ser correspondido com o valor personalizado25 associado ao workspace.
Custom26
 custom26 boolean

Especifica um valor a ser correspondido com o valor personalizado26 associado ao workspace.
Personalizado27
 custom27 boolean

Especifica um valor a ser correspondido com o valor personalizado27 associado ao workspace.
Custom28
 custom28 boolean

Especifica um valor a ser correspondido com o valor personalizado28 associado ao workspace.
Custom29
 custom29 string

Especifica um valor a ser correspondido com o valor personalizado29 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais.
Custom30
 custom30 string

Especifica um valor a ser correspondido com o valor personalizado30 associado ao workspace. Essa pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para o caractere curinga (*) e as correspondências parciais. Para especificar um valor para custom30, você também deve especificar um valor para custom29 na mesma solicitação, que é devido à relação pai-filho.

Promover a versão do documento

ID da operação:
PromoteDocumentVersion

Promove uma versão existente de um documento para a versão mais recente. Uma nova versão é criada a partir de uma ID de Diário ou versão especificada e, em seguida, promovida para a mais recente. Você deve especificar a ID do Diário ou a Versão, mas não ambas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
 documentId True string

Especifica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
Versão
 version integer

Especifica o número de versão a ser usado como base para a nova versão promovida.
ID do Diário
 journalId string

Especifica a ID do diário a ser usada como base para a nova versão promovida.
Comment
 comment string

Especifica informações adicionais sobre o documento.
Alias
 alias string

Especifica o alias deste documento.
Autor
 author string

Especifica a ID do usuário que criou o documento. Por exemplo, 'JSMITH'.
Classe de documento
 class string

Especifica a classe de documento.
Segurança padrão do documento
 default_security string

Especifica o nível de acesso de segurança padrão.
É Declarado
 is_declared boolean

Especifica se a nova versão do documento deve ser declarada como um registro. Um documento declarado como um registro não pode ser editado ou excluído, exceto por um administrador do sistema iManage Work.
É HIPAA
 is_hipaa boolean

Especifica se a nova versão do documento deve ser criptografada.
Nome do documento
 name string

Especifica o nome do arquivo do documento.
Operator
 operator string

Especifica a ID do usuário que fez check-out do documento ou atualmente está editando o perfil do documento. Por exemplo, 'JSMITH'.
Dias de Retenção
 retain_days integer

Especifica o número de dias antes de o documento inativo ser qualificado para arquivamento.
Subclasse
 subclass string

Especifica a subclasse do documento.
Custom1
 custom1 string

Especifica o valor de custom1.
Custom2
 custom2 string

Especifica o valor de custom2. Para especificar um valor para custom2, você também deve especificar um valor para custom1 na mesma solicitação, que é devido à relação pai-filho.
Personalizado3
 custom3 string

Especifica o valor de custom3.
Personalizado4
 custom4 string

Especifica o valor de custom4.
Custom5
 custom5 string

Especifica o valor de custom5.
Custom6
 custom6 string

Especifica o valor do custom6.
Custom7
 custom7 string

Especifica o valor de custom7.
Custom8
 custom8 string

Especifica o valor de custom8.
Custom9
 custom9 string

Especifica o valor de custom9.
Custom10
 custom10 string

Especifica o valor de custom10.
Custom11
 custom11 string

Especifica o valor de custom11.
Personalizado12
 custom12 string

Especifica o valor de custom12.
Personalizado13
 custom13 string

Especifica o valor de custom13.
Personalizado14
 custom14 string

Especifica o valor de custom14.
Personalizado15
 custom15 string

Especifica o valor de custom15.
Personalizado16
 custom16 string

Especifica o valor de custom16.
Personalizado17
 custom17 double

Especifica o valor de custom17.
Personalizado18
 custom18 double

Especifica o valor de custom18.
Personalizado19
 custom19 double

Especifica o valor de custom19.
Custom20
 custom20 double

Especifica o valor de custom20.
Custom21
 custom21 string

Especifica o valor da propriedade custom21 no formato datetime ISO 8601.
Custom22
 custom22 string

Especifica o valor da propriedade custom22 no formato de datetime ISO 8601.
Personalizado23
 custom23 string

Especifica o valor da propriedade custom23 no formato datetime ISO 8601.
Personalizado24
 custom24 string

Especifica o valor da propriedade custom24 no formato datetime ISO 8601.
Personalizado25
 custom25 boolean

Especifica o valor de custom25.
Custom26
 custom26 boolean

Especifica o valor de custom26.
Personalizado27
 custom27 boolean

Especifica o valor de custom27.
Custom28
 custom28 boolean

Especifica o valor de custom28.
Custom29
 custom29 string

Especifica o valor de custom29.
Custom30
 custom30 string

Especifica o valor de custom30. Para especificar um valor para custom30, você também deve especificar um valor para custom29 na mesma solicitação, que é devido à relação pai-filho.

Gatilhos

Para um documento selecionado

Esse gatilho permite que você inicie um fluxo de trabalho para um documento selecionado em uma biblioteca do iManage Work. Forneça um nome de exibição que será mostrado aos usuários em aplicativos iManage Work. Se 'Wait For Completion' estiver definido como 'Sim', você deverá usar a ação 'Atualizar estado do fluxo de trabalho' em seu fluxo de trabalho, caso contrário, os aplicativos acabarão atingindo o tempo limite sem indicar o estado de conclusão para o usuário.
Para um workspace selecionado

Esse gatilho permite que você inicie um fluxo de trabalho para um workspace selecionado em uma biblioteca do iManage Work. Forneça um nome de exibição que será mostrado aos usuários em aplicativos iManage Work. Se 'Wait For Completion' estiver definido como 'Sim', você deverá usar a ação 'Atualizar estado do fluxo de trabalho' em seu fluxo de trabalho, caso contrário, os aplicativos acabarão atingindo o tempo limite sem indicar o estado de conclusão para o usuário.
Para vários documentos selecionados

Esse gatilho permite que você inicie um fluxo de trabalho para um ou mais documentos selecionados no iManage Work. Forneça um nome de exibição que será mostrado aos usuários em aplicativos iManage Work. Se 'Wait For Completion' estiver definido como 'Sim', você deverá usar a ação 'Atualizar estado do fluxo de trabalho' em seu fluxo de trabalho, caso contrário, os aplicativos acabarão atingindo o tempo limite sem indicar o estado de conclusão para o usuário.
Para vários workspaces selecionados

Esse gatilho permite que você inicie um fluxo de trabalho para um ou mais workspaces selecionados no iManage Work. Forneça um nome de exibição que será mostrado aos usuários em aplicativos iManage Work. Se 'Wait For Completion' estiver definido como 'Sim', você deverá usar a ação 'Atualizar estado do fluxo de trabalho' em seu fluxo de trabalho, caso contrário, os aplicativos acabarão atingindo o tempo limite sem indicar o estado de conclusão para o usuário.

Para um documento selecionado

ID da operação:
SingleSelectedDocument

Esse gatilho permite que você inicie um fluxo de trabalho para um documento selecionado em uma biblioteca do iManage Work. Forneça um nome de exibição que será mostrado aos usuários em aplicativos iManage Work. Se 'Wait For Completion' estiver definido como 'Sim', você deverá usar a ação 'Atualizar estado do fluxo de trabalho' em seu fluxo de trabalho, caso contrário, os aplicativos acabarão atingindo o tempo limite sem indicar o estado de conclusão para o usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome de exibição do fluxo de trabalho
 workflowName True string

Especifica o nome de exibição do fluxo de trabalho que ficará visível para os usuários do iManage Work.
Description
 description True string

Especifica a descrição do fluxo de trabalho.
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca em que o fluxo de trabalho está disponível.
ID do formulário
 formId True string

Especifica a ID do formulário apresentado ao usuário para coletar entradas usadas pelo fluxo de trabalho.
ID da Pasta de Retorno
 inferFolderId True boolean

Especifica se a ID da pasta do documento é exigida pelo fluxo de trabalho.
Disponível para usuários
 users string

Especifica uma ou mais IDs de usuário, separadas por ponto-e-vírgula, para as quais o fluxo de trabalho está disponível.
Disponível para grupos
 groups string

Especifica uma ou mais IDs de grupo, separadas por ponto-e-vírgula, às quais o fluxo de trabalho está disponível.
Disponível em workspaces
 workspaces string

Especifica uma ou mais IDs de workspace, separadas por ponto-e-vírgula, nas quais o fluxo de trabalho está disponível.
Classes de documento
 classes string

Especifica uma ou mais IDs de classe de documento, separadas por ponto-e-vírgula, para as quais o fluxo de trabalho está disponível.
Aguardar conclusão
 waitForCompletion boolean

Especifica se os aplicativos esperam até que o fluxo de trabalho conclua a execução. Se definido como "Sim", você deve usar a ação "Atualizar estado do fluxo de trabalho".

Retornos

As saídas desta operação são dinâmicas.

Para um workspace selecionado

ID da operação:
SingleSelectedWorkspace

Esse gatilho permite que você inicie um fluxo de trabalho para um workspace selecionado em uma biblioteca do iManage Work. Forneça um nome de exibição que será mostrado aos usuários em aplicativos iManage Work. Se 'Wait For Completion' estiver definido como 'Sim', você deverá usar a ação 'Atualizar estado do fluxo de trabalho' em seu fluxo de trabalho, caso contrário, os aplicativos acabarão atingindo o tempo limite sem indicar o estado de conclusão para o usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome de exibição do fluxo de trabalho
 workflowName True string

Especifica o nome de exibição do fluxo de trabalho que ficará visível para os usuários do iManage Work.
Description
 description True string

Especifica a descrição do fluxo de trabalho.
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca em que o fluxo de trabalho está disponível.
ID do formulário
 formId True string

Especifica a ID do formulário apresentado ao usuário para coletar entradas usadas pelo fluxo de trabalho.
Disponível para usuários
 users string

Especifica uma ou mais IDs de usuário, separadas por ponto-e-vírgula, para as quais o fluxo de trabalho está disponível.
Disponível para grupos
 groups string

Especifica uma ou mais IDs de grupo, separadas por ponto-e-vírgula, às quais o fluxo de trabalho está disponível.
Aguardar conclusão
 waitForCompletion boolean

Especifica se os aplicativos esperam até que o fluxo de trabalho conclua a execução. Se definido como "Sim", você deve usar a ação "Atualizar estado do fluxo de trabalho".

Retornos

As saídas desta operação são dinâmicas.

Para vários documentos selecionados

ID da operação:
MultipleSelectedDocuments

Esse gatilho permite que você inicie um fluxo de trabalho para um ou mais documentos selecionados no iManage Work. Forneça um nome de exibição que será mostrado aos usuários em aplicativos iManage Work. Se 'Wait For Completion' estiver definido como 'Sim', você deverá usar a ação 'Atualizar estado do fluxo de trabalho' em seu fluxo de trabalho, caso contrário, os aplicativos acabarão atingindo o tempo limite sem indicar o estado de conclusão para o usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome de exibição do fluxo de trabalho
 workflowName True string

Especifica o nome de exibição do fluxo de trabalho que ficará visível para os usuários do iManage Work.
Description
 description True string

Especifica a descrição do fluxo de trabalho.
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca em que o fluxo de trabalho está disponível.
ID do formulário
 formId True string

Especifica a ID do formulário apresentado ao usuário para coletar entradas usadas pelo fluxo de trabalho.
ID da Pasta de Retorno
 inferFolderId True boolean

Especifica se a ID da pasta do documento é exigida pelo fluxo de trabalho.
Disponível para usuários
 users string

Especifica uma ou mais IDs de usuário, separadas por ponto-e-vírgula, para as quais o fluxo de trabalho está disponível.
Disponível para grupos
 groups string

Especifica uma ou mais IDs de grupo, separadas por ponto-e-vírgula, às quais o fluxo de trabalho está disponível.
Mostrar formulário para cada documento
 showFormPerObject boolean

Especifica se o formulário é apresentado individualmente para cada objeto selecionado ou apenas uma vez para todos os objetos selecionados.
Aguardar conclusão
 waitForCompletion boolean

Especifica se os aplicativos esperam até que o fluxo de trabalho conclua a execução. Se definido como "Sim", você deve usar a ação "Atualizar estado do fluxo de trabalho".

Retornos

As saídas desta operação são dinâmicas.

Para vários workspaces selecionados

ID da operação:
MultipleSelectedWorkspaces

Esse gatilho permite que você inicie um fluxo de trabalho para um ou mais workspaces selecionados no iManage Work. Forneça um nome de exibição que será mostrado aos usuários em aplicativos iManage Work. Se 'Wait For Completion' estiver definido como 'Sim', você deverá usar a ação 'Atualizar estado do fluxo de trabalho' em seu fluxo de trabalho, caso contrário, os aplicativos acabarão atingindo o tempo limite sem indicar o estado de conclusão para o usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome de exibição do fluxo de trabalho
 workflowName True string

Especifica o nome de exibição do fluxo de trabalho que ficará visível para os usuários do iManage Work.
Description
 description True string

Especifica a descrição do fluxo de trabalho.
ID da biblioteca
 libraryId True string

Especifica a ID da biblioteca em que o fluxo de trabalho está disponível.
ID do formulário
 formId True string

Especifica a ID do formulário apresentado ao usuário para coletar entradas usadas pelo fluxo de trabalho.
Disponível para usuários
 users string

Especifica uma ou mais IDs de usuário, separadas por ponto-e-vírgula, para as quais o fluxo de trabalho está disponível.
Disponível para grupos
 groups string

Especifica uma ou mais IDs de grupo, separadas por ponto-e-vírgula, às quais o fluxo de trabalho está disponível.
Aguardar conclusão
 waitForCompletion boolean

Especifica se os aplicativos esperam até que o fluxo de trabalho conclua a execução. Se definido como "Sim", você deve usar a ação "Atualizar estado do fluxo de trabalho".

Retornos

As saídas desta operação são dinâmicas.

Definições

MinimalDocumentProfileInArray

Indica o perfil de cada versão do documento.

Nome Caminho Tipo Description
Autor
 author string

Indica a ID do usuário que criou o documento. Por exemplo, 'JSMITH'.
Descrição do autor
 author_description string

Indica informações adicionais sobre o autor do documento.
Propriedades básicas do documento
 basic_properties string

Indica um elemento '' inserível que contém propriedades básicas do documento.
Classe de documento
 class string

Indica a classe do documento.
Comment
 comment string

Indica informações adicionais sobre o documento.
Tipo de conteúdo
 content_type string

Indica o tipo de conteúdo do documento.
Data de criação do documento
 create_date string

Indica a data e hora (no formato ISO 8601) em que o documento foi importado para o sistema iManage Work. Essa data pode ser diferente de "file_create_date".
Custom1
 custom1 string

Indica o valor de custom1.
Descrição personalizada1
 custom1_description string

Indica informações adicionais sobre a propriedade custom1.
Custom2
 custom2 string

Indica o valor de custom2.
Descrição personalizada2
 custom2_description string

Indica informações adicionais sobre a propriedade custom2.
Personalizado3
 custom3 string

Indica o valor de custom3.
Descrição personalizada3
 custom3_description string

Indica informações adicionais sobre a propriedade custom3.
Personalizado4
 custom4 string

Indica o valor de custom4.
Descrição custom4
 custom4_description string

Indica informações adicionais sobre a propriedade custom4.
Custom5
 custom5 string

Indica o valor de custom5.
Descrição personalizada5
 custom5_description string

Indica informações adicionais sobre a propriedade custom5.
Custom6
 custom6 string

Indica o valor de custom6.
Descrição custom6
 custom6_description string

Indica informações adicionais sobre a propriedade custom6.
Custom7
 custom7 string

Indica o valor de custom7.
Descrição custom7
 custom7_description string

Indica informações adicionais sobre a propriedade custom7.
Custom8
 custom8 string

Indica o valor de custom8.
Descrição custom8
 custom8_description string

Indica informações adicionais sobre a propriedade custom8.
Custom9
 custom9 string

Indica o valor de custom9.
Descrição custom9
 custom9_description string

Indica informações adicionais sobre a propriedade custom9.
Custom10
 custom10 string

Indica o valor de custom10.
Descrição personalizada10
 custom10_description string

Indica informações adicionais sobre a propriedade custom10.
Custom11
 custom11 string

Indica o valor de custom11.
Descrição personalizada11
 custom11_description string

Indica informações adicionais sobre a propriedade custom11.
Personalizado12
 custom12 string

Indica o valor de custom12.
Descrição personalizada12
 custom12_description string

Indica informações adicionais sobre a propriedade custom12.
Personalizado13
 custom13 string

Indica o valor de custom13.
Personalizado14
 custom14 string

Indica o valor de custom14.
Personalizado15
 custom15 string

Indica o valor de custom15.
Personalizado16
 custom16 string

Indica o valor de custom16.
Personalizado17
 custom17 double

Indica o valor de custom17.
Personalizado18
 custom18 double

Indica o valor de custom18.
Personalizado19
 custom19 double

Indica o valor de custom19.
Custom20
 custom20 double

Indica o valor de custom20.
Custom21
 custom21 string

Indica o valor da propriedade custom21 no formato datetime ISO 8601.
Custom22
 custom22 string

Indica o valor da propriedade custom22 no formato datetime ISO 8601.
Personalizado23
 custom23 string

Indica o valor da propriedade custom23 no formato datetime ISO 8601.
Personalizado24
 custom24 string

Indica o valor da propriedade custom24 no formato datetime ISO 8601.
Personalizado25
 custom25 boolean

Indica o valor de custom25.
Custom26
 custom26 boolean

Indica o valor de custom26.
Personalizado27
 custom27 boolean

Indica o valor de custom27.
Custom28
 custom28 boolean

Indica o valor de custom28.
Custom29
 custom29 string

Indica o valor de custom29.
Descrição personalizada29
 custom29_description string

Indica informações adicionais sobre a propriedade custom29.
Custom30
 custom30 string

Indica o valor de custom30.
Descrição personalizada30
 custom30_description string

Indica informações adicionais sobre a propriedade custom30.
Base de dados
 database string

Indica a biblioteca em que o documento é armazenado.
Segurança padrão do documento
 default_security string

Indica o nível de acesso de segurança padrão. Os valores possíveis são 'inherit', 'private', 'view', 'public'.
Número do documento
 document_number integer

Indica o número do documento de um documento.
URL do documento
 document_url string

Indica o link compartilhável para o documento.
Data de Edição do Documento
 edit_date string

Indica a data e hora (no formato ISO 8601) da alteração mais recente para o documento.
Data de Edição do Perfil
 edit_profile_date string

Indica a data e hora (no formato ISO 8601) da alteração mais recente para o perfil do documento.
Extensão do documento
 extension string

Indica a extensão de nome de arquivo, também chamada de extensão do aplicativo, do documento.
Nome completo do arquivo
 full_file_name string

Indica o nome completo do arquivo do documento. Inclui a extensão de nome de arquivo.
ID do documento
 id string

Indica a ID do documento. Por exemplo, 'ACTIVE_US!453.1'.
É indexável
 indexable boolean

Indica se o documento é indexado pelo sistema.
Está com check-out
 is_checked_out boolean

Indica se o documento está com check-out.
É Declarado
 is_declared boolean

Indica se o documento é declarado como um registro. Um documento declarado como um registro não pode ser editado ou excluído, exceto por um administrador do sistema iManage Work.
É Externo
 is_external boolean

Indica se o documento é compartilhado com usuários externos.
É HIPAA
 is_hipaa boolean

Indica se o documento está criptografado.
Está em uso
 is_in_use boolean

Indica se o documento está em uso.
Link do documento
 iwl string

Indica o iWL (iManage Work Link) para o documento. O iWL é usado para abrir o documento no Modo de Exibição Protegido pelo usuário que tem 'read_write' ou 'full_access'.
Último Usuário
 last_user string

Indica a ID do usuário que editou o documento mais recentemente. Por exemplo, 'JSMITH'.
Descrição do último usuário
 last_user_description string

Indica informações adicionais sobre o último usuário que editou o documento mais recentemente.
Nome do documento
 name string

Indica o nome do arquivo do documento.
Operator
 operator string

Indica a ID do usuário que fez check-out do documento ou atualmente está editando seu perfil. Por exemplo, 'JSMITH'.
Descrição do operador
 operator_description string

Indica informações adicionais sobre o operador.
Está relacionado
 is_related boolean

Indica se o documento está relacionado a outro documento.
Tamanho do documento
 size integer

Indica o tamanho do documento em bytes.
Tipo
 type string

Indica o tipo de documento. Por exemplo, WORD para Microsoft Word. Para obter uma lista atual de tipos, entre em contato com o administrador do sistema do iManage Work.
Versão do documento
 version integer

Indica o número de versão do documento.
Wstype
 wstype string

Indica o tipo iManage Work do objeto. Os valores possíveis são 'document', 'folder', 'workspace', 'email', 'document_shortcut', 'folder_shortcut', 'workspace_shortcut', 'user'.

Perfil de Usuário

Indica informações sobre um usuário.

Nome Caminho Tipo Description
Permitir Logon
 allow_logon boolean

Indica se o usuário tem permissão para fazer logon.
Custom1
 custom1 string

Indica informações adicionais sobre o usuário.
Custom2
 custom2 string

Indica informações adicionais sobre o usuário.
Personalizado3
 custom3 string

Indica informações adicionais sobre o usuário.
ID de diretório
 directory_id string

Indica a ID de um diretório externo (como o ADFS), que é usado para sincronização de perfil de usuário.
Nome Distinto
 distinguished_name string

Indica o nome do objeto que representa o caminho totalmente qualificado de nomes que rastreiam a entrada de volta para a raiz da árvore LDAP.
Editar Data
 edit_date string

Indica a data e hora (no formato ISO 8601) da alteração mais recente para o perfil do usuário.
Email
 email string

Indica a ID de email do usuário.
URL de descoberta automática do Exchange
 exch_autodiscover string

Indica os detalhes do exchange server do usuário.
Extension
 extension string

Indica a extensão de número de telefone do usuário.
Tentativas de logon com falha
 failed_logins integer

Indica o número atual de tentativas de entrada com falha do usuário.
Fac-símile
 fax string

Indica o número de fax do usuário.
Forçar alteração de senha
 force_password_change boolean

Indica que o usuário deve alterar sua senha na próxima entrada. Aplicável somente a usuários virtuais, indicado pelo valor 'user_nos' '2'.
Nome Completo
 full_name string

Indica o nome completo do usuário.
Geral
 general string

Indica informações gerais sobre o usuário.
ID do Usuário
 id string

Indica a ID do usuário. Por exemplo, 'JSMITH'.
É usuário externo
 is_external boolean

Indica um usuário externo. Um usuário externo tem acesso limitado e geralmente é usado para membros temporários da equipe, consultores ou externos à organização.
Hora da Última Sincronização
 last_sync_ts string

Indica a hora da última sincronização (no formato datetime ISO 8601) do perfil do usuário com um diretório externo, como LDAP ou Microsoft Active Directory (ADFS).
Localização
 location string

Indica a localização geográfica do usuário.
A senha nunca expira
 password_never_expire boolean

Indica se a senha do usuário nunca expira.
Número de Telefone
 phone string

Indica o número de telefone do usuário.
Biblioteca preferencial
 preferred_library string

Indica a biblioteca preferencial. Uma biblioteca preferencial é a biblioteca padrão do usuário. Cada usuário deve ter uma biblioteca preferencial.
Hora da alteração da senha
 pwd_changed_ts string

Indica a hora (no formato de datetime ISO 8601) em que a senha do usuário foi alterada pela última vez. Isso é aplicável somente a usuários virtuais (cujo USUÁRIO NOS é 2).
SSID
 ssid string

Indica a ID exclusiva gerada pelo sistema para o usuário.
Domínio do Usuário
 user_domain string

Indica o nome de domínio totalmente qualificado para o serviço de diretório do usuário.
ID de usuário estendida
 user_id_ex string

Indica o valor original da ID de usuário recebida de um diretório externo, como o Microsoft Active Directory (ADFS).
NOS do usuário
 user_nos integer

Indica o tipo de sistema operacional do qual o usuário está sincronizado. Os valores possíveis são 2 (usuário virtual) e 6 (usuário enterprise). Para obter mais informações, entre em contato com o administrador do sistema do iManage Work.
Número de Usuário
 user_num integer

Indica a ID do sistema numérico do usuário.

UserProfileInArray

Nome Caminho Tipo Description
Permitir Logon
 allow_logon boolean

Indica se o usuário tem permissão para fazer logon.
Custom1
 custom1 string

Indica informações adicionais sobre o usuário.
Custom2
 custom2 string

Indica informações adicionais sobre o usuário.
Personalizado3
 custom3 string

Indica informações adicionais sobre o usuário.
ID de diretório
 directory_id string

Indica a ID de um diretório externo (como o ADFS), que é usado para sincronização de perfil de usuário.
Nome Distinto
 distinguished_name string

Indica o nome do objeto que representa o caminho totalmente qualificado de nomes que rastreiam a entrada de volta para a raiz da árvore LDAP.
Editar Data
 edit_date string

Indica a data e hora (no formato ISO 8601) da alteração mais recente para o perfil do usuário.
Email
 email string

Indica a ID de email do usuário.
URL de descoberta automática do Exchange
 exch_autodiscover string

Indica os detalhes do exchange server do usuário.
Extension
 extension string

Indica a extensão de número de telefone do usuário.
Tentativas de logon com falha
 failed_logins integer

Indica o número atual de tentativas de entrada com falha do usuário.
Fac-símile
 fax string

Indica o número de fax do usuário.
Forçar alteração de senha
 force_password_change boolean

Indica que o usuário deve alterar sua senha na próxima entrada. Aplicável somente a usuários virtuais, indicado pelo valor 'user_nos' '2'.
Nome Completo
 full_name string

Indica o nome completo do usuário.
Geral
 general string

Indica informações gerais sobre o usuário.
ID
 id string

Indica a ID do usuário. Por exemplo, 'JSMITH'.
É usuário externo
 is_external boolean

Indica um usuário externo. Um usuário externo tem acesso limitado e geralmente é usado para membros temporários da equipe, consultores ou externos à organização.
Hora da Última Sincronização
 last_sync_ts string

Indica a hora da última sincronização (no formato datetime ISO 8601) do perfil do usuário com um diretório externo, como LDAP ou Microsoft Active Directory (ADFS).
Localização
 location string

Indica a localização geográfica do usuário.
A senha nunca expira
 password_never_expire boolean

Indica se a senha do usuário nunca expira.
Número de Telefone
 phone string

Indica o número de telefone do usuário.
Biblioteca preferencial
 preferred_library string

Indica a biblioteca preferencial. Uma biblioteca preferencial é a biblioteca padrão do usuário. Cada usuário deve ter uma biblioteca preferencial.
Hora da alteração da senha
 pwd_changed_ts string

Indica a hora (no formato de datetime ISO 8601) em que a senha do usuário foi alterada pela última vez. Isso é aplicável somente a usuários virtuais (cujo USUÁRIO NOS é 2).
SSID
 ssid string

Indica a ID exclusiva gerada pelo sistema para o usuário.
Domínio
 user_domain string

Indica o nome de domínio totalmente qualificado para o serviço de diretório do usuário.
ID de usuário estendida
 user_id_ex string

Indica o valor original da ID de usuário recebida de um diretório externo, como o Microsoft Active Directory (ADFS).
NOS
 user_nos integer

Indica o tipo de sistema operacional do qual o usuário está sincronizado. Os valores possíveis são 2 (usuário virtual) e 6 (usuário enterprise). Para obter mais informações, entre em contato com o administrador do sistema do iManage Work.
Número
 user_num integer

Indica a ID do sistema numérico do usuário.

TaxonomyNodeValue

Indica cada valor do nó de taxonomia.

Nome Caminho Tipo Description
SSID
 created_by.ssid string

Indica a ID exclusiva gerada pelo sistema para o usuário que criou o valor do nó.
Criar Data
 create_date date-time

Indica a data e hora (no formato ISO 8601) que o valor do nó foi criado.
Description
 description string

Indica a descrição do valor do nó.
SSID
 edited_by.ssid string

Indica a ID exclusiva gerada pelo sistema para o usuário que editou o valor do nó pela última vez.
Editar Data
 edit_date date-time

Indica a data e hora (no formato ISO 8601) que o valor do nó foi editado pela última vez.
Está habilitado
 enabled boolean

Indica se o valor do nó está habilitado.
ID
 id string

Indica o identificador de exibição para o valor do nó.
SSID
 parent.ssid string

Indica a ID exclusiva gerada pelo sistema para o nó pai imediato.
SSID
 ssid string

Indica a ID exclusiva gerada pelo sistema para o valor do nó.
Caminho
 path array of object

Indica o caminho completo para o valor do nó. Um caminho é uma lista ordenada começando com o nó de nível superior na taxonomia e, em seguida, todos os nós até o pai imediato do nó correspondente.
Cada ID
 path.id string

Indica o identificador de exibição para um valor de nó no caminho.
Cada SSID
 path.ssid string

Indica a ID exclusiva gerada pelo sistema para um valor de nó no caminho.

UpdatePermissionsResponse

Nome Caminho Tipo Description
Segurança Padrão
 data.default_security string

Indica a segurança padrão do objeto. Os valores possíveis são 'inherit', 'public', 'view' ou 'private'.
Permissões de Acesso
 data.acl AccessPermissions

Indica uma coleção de permissões de acesso para um ou mais usuários e/ou grupos.
Todas as IDs de usuário
 data.all_user_ids string

Indica uma lista de todas as IDs de usuário, concatenadas como uma cadeia de caracteres e separadas por ponto-e-vírgula.
Todas as IDs de Grupo
 data.all_group_ids string

Indica uma lista de todas as IDs de grupo, concatenadas como uma cadeia de caracteres e separadas por ponto-e-vírgula.

AccessPermissions

Indica uma coleção de permissões de acesso para um ou mais usuários e/ou grupos.

Nome Caminho Tipo Description
Nome do administrador
 name string

Indica o nome do administrador.
ID do administrador
 id string

Indica a ID do administrador. Pode ser uma ID de usuário ou uma ID de grupo.
SID do Administrador
 sid string

Indica o identificador de segurança do usuário ou grupo.
Tipo de administrador
 type string

Indica o tipo de administrador retornado. Os valores possíveis são 'user' ou 'group'.
Nível de Acesso
 access_level string

Indica a permissão de acesso que o usuário ou grupo tem no objeto. Os valores possíveis são 'no_access', 'read', 'read_write' ou 'full_access'.
Nome de exibição no nível de acesso
 access_level_display_name string

Indica o nome de exibição no nível de acesso legível por humanos atribuído ao usuário ou grupo deste objeto. Os valores possíveis são 'Sem Acesso', 'Somente Leitura', 'Leitura/Gravação' ou 'Acesso Completo'.
Acesso
 access integer

Indica o valor numérico da permissão de acesso que o usuário ou grupo tem no objeto. Os valores possíveis são 0 (no_access), 1 (leitura), 2 (read_write) ou 3 (full_access).
É Externo
 is_external boolean

Indica se o usuário é um usuário externo ou se o grupo está restrito a usuários externos.
Permitir Logon
 allow_logon boolean

Indica se o usuário tem permissão para fazer logon. Não aplicável a grupos.
Está habilitado
 enabled boolean

Indica se o grupo está habilitado. Não aplicável aos usuários.
Tem Membro Restrito
 has_restricted_member boolean

Indica se o grupo tem pelo menos um usuário com acesso a esse objeto negado pelo iManage Security Policy Manager.

objeto

Esse é o tipo 'object'.

binário

Esse é o tipo de dados básico 'binary'.