iGerir Trabalho
O conector iManage Work permite aos utilizadores automatizar tarefas repetitivas e processos de aprovação enquanto mantêm todos os seus ficheiros seguros no ambiente de trabalho iManage.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | iGerir LLC |
| URL | https://docs.imanage.com |
| cloudsupport@imanage.com |
| Metadados do conector | |
|---|---|
| Editora | Conector iManage Power Platform |
| Sítio Web | https://imanage.com |
| Política de privacidade | https://imanage.com/about/privacy-notice/ |
| Categorias | Conteúdos e Ficheiros; Produtividade |
iGerir Trabalho
O iManage é o fornecedor líder do setor de soluções de gestão de documentos e e-mail para trabalhadores do conhecimento. A plataforma iManage organiza e protege as informações em documentos e e-mails, para que os profissionais possam pesquisar o que precisam, agir sobre isso e colaborar de forma mais eficaz. O conector iManage Work permite aos utilizadores automatizar tarefas repetitivas e processos de aprovação enquanto mantêm todos os seus ficheiros seguros no ambiente de trabalho iManage.
Pré-requisitos
O conector está disponível para todos os clientes do iManage Work que se conectam ao cloudimanage.com. Primeiro, a aplicação Power Automate terá de ser ativada por um administrador do seu ambiente de trabalho iManage. Uma vez ativado, você precisará da URL específica para o seu ambiente e de uma conta de login e senha sob a qual o conector pode executar ações. Para obter mais informações, consulte as Perguntas frequentes.
Como obter credenciais
Se já é um utilizador do iManage Work, forneça as suas credenciais do iManage Work para iniciar sessão. Caso contrário, contacte o administrador do sistema para obter assistência.
Introdução ao conector de trabalho iManage
Execute as seguintes etapas para começar a usar o conector de trabalho do iManage:
- Crie um fluxo de nuvem instantâneo e selecione + Nova etapa.
- Pesquise iManage Work para ver todas as ações disponíveis do iManage Work.
- Selecione a ação desejada do iManage Work.
- Se ainda não tiver iniciado sessão no iManage Work, ser-lhe-á pedido para iniciar sessão.
- Selecione Entrar.
- Introduza o URL que utiliza para ligar ao iManage Work, por exemplo cloudimanage.com.
- Introduza o seu ID de utilizador do iManage Work.
- Digite a senha da conta escolhida e selecione Login. A partir deste ponto, todos os fluxos que usam as ações do iManage Work se conectam usando essas credenciais de usuário. Uma conta de usuário iManage diferente pode ser usada adicionando uma nova conexão em Minhas conexões e alternando para ela.
Problemas conhecidos e limitações
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 soluções comuns, visite https://docs.imanage.com/power-automate/index.html.
FAQ
Para obter uma lista de Perguntas Frequentes, visite https://docs.imanage.com/power-automate/index.html.
Limites de Limitação
| Nome | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar entrada do histórico do documento |
Adiciona uma entrada como um evento no histórico do documento. |
| Adicionar referência do documento |
Adiciona 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 espaço de trabalho. |
| Atualizar atual ou criar nova versão do documento |
Atualiza a versão especificada de um documento ou cria uma nova versão. Esta 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 é substituído por um novo e o perfil do documento anterior é mantido. Se 'Criar nova versão' for especificado, uma nova versão do documento será criada que herda o perfil da pasta. Após a execução bem-sucedida da operação, o perfil do documento é retornado. |
| Atualizar espaço de trabalho |
Atualiza as informações do espaço de trabalho especificado. Para excluir o valor existente de um campo de cadeia de caracteres, defina o valor do campo como uma cadeia de caracteres vazia entre aspas simples ou duplas. |
| 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 tenha sido criado para iniciar com um gatilho fornecido pelo iManage. |
| Atualizar 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 com check-out não pode ser atualizado. Retorna um perfil de documento atualizado após a operação. |
| Carregar documento |
Carrega um arquivo como um novo documento para a pasta especificada. |
| Copiar documento |
Copia um documento para a pasta especificada. |
| Copiar permissões |
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 sobre como lidar com a combinação de permissões de origem e destino. 'Overwrite' atualiza os usuários, grupos e níveis de permissão do objeto de destino para corresponder exatamente aos do objeto de origem. 'Mesclar' mantém todos os usuários e grupos no objeto de destino e os combina com a fonte, mas em caso de conflito de nível de permissão em um indivíduo ou grupo: 'Mesclar (Pessimista)' obtém a permissão inferior, enquanto 'Mesclar (Otimista)' obtém a permissão mais alta para o usuário ou grupo em conflito. |
| Criar espaço de trabalho |
Cria um novo espaço de trabalho com base no modelo selecionado. Um modelo de espaço de trabalho é um espaço de trabalho predefinido cuja estrutura é copiada para o novo espaço de trabalho. As restrições no modelo de espaço de trabalho são aplicadas automaticamente ao criar o novo espaço de trabalho. |
| Criar relação de documento |
Cria uma relação entre documentos especificados em uma biblioteca. |
| Definir as principais propriedades de metadados estendidos em um documento |
Define as principais propriedades de metadados estendidos em um documento. |
| Descarregar documento |
Transfere uma versão de um documento específico, com base no ID do documento. Se a última for verdadeira, a versão mais recente deste documento será baixada. O download é um fluxo e não é salvo localmente. |
| Editar pares nome-valor |
Cria, atualiza ou exclui propriedades do par nome-valor de um documento, pasta ou espaço de trabalho. Para excluir um par nome-valor, defina o valor da chave como uma cadeia de caracteres vazia entre aspas simples ou duplas. |
| Eliminar documento |
Exclui o documento especificado. |
| Eliminar referência do documento |
Exclui a referência do 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 espaço de trabalho. Um administrador fiduciário pode ser um utilizador ou grupo. |
| Obter as principais propriedades de metadados estendidos de um documento |
Obtém as principais propriedades de metadados estendidos de um documento. |
| Obter aulas |
Obtém a lista de classes de documento disponíveis em uma biblioteca que correspondem aos critérios especificados. |
| Obter bibliotecas |
Obtém uma lista de bibliotecas às quais o usuário tem acesso. |
| Obter detalhes do utilizador |
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 correspondem aos critérios especificados. |
| Obter modelos de espaço de trabalho |
Obtém a lista de modelos disponíveis em uma biblioteca. Um modelo de espaço de trabalho é um espaço de trabalho predefinido cuja estrutura é copiada para o novo espaço de trabalho. |
| Obter perfil do documento |
Obtém as propriedades do documento associadas a uma ID de documento específica. |
| Obter perfil do espaço de trabalho |
Obtém o perfil do espaço de trabalho e, opcionalmente, a lista de operações permitidas para o espaço de trabalho. |
| Obter permissões |
Obtém propriedades de permissão de acesso de usuário ou grupo de um documento, pasta ou espaço de trabalho. As propriedades de resposta podem variar de acordo com as permissões de usuário ou grupo. |
| Obter subclasses |
Obtém todas as subclasses da biblioteca que correspondem aos critérios especificados. |
| Obter versões de documentos |
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. |
| Pesquisar espaços de trabalho |
Pesquise espaços de trabalho. |
| Pesquisar utilizadores |
Procura utilizadores do iManage Work que correspondam aos critérios de pesquisa especificados. |
| Pesquisar valores de nó de taxonomia de metadados estendidos principais |
Procura valores de nó de taxonomia de metadados estendidos principais que correspondam aos critérios de pesquisa especificados. |
| Procurar pastas |
Procure pastas. |
| 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 um ID ou Versão de Diário especificado e, em seguida, promovida para a mais recente. Você deve especificar ID do Diário ou Versão, mas não ambos. |
Adicionar entrada do histórico do documento
Adiciona uma entrada como um evento no histórico do documento.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
Activity
|
activity_code | True | integer |
Especifica o tipo de atividade realizada no documento. |
|
Comments
|
comments | string |
Especifica quaisquer informações adicionais sobre a atividade. |
|
|
Duração
|
duration | integer |
Especifica o número de segundos que o usuário gastou trabalhando no documento. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
dados
|
data | object |
Adicionar referência do documento
Adiciona referência de documento ou atalho de documento em outra pasta.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
ID da pasta
|
folderId | True | string |
Especifica a ID da pasta. Por exemplo, 'ATIVE_US!773'. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ID de referência do documento
|
data.id | string |
Indica referência e document_shortcut do documento. |
|
Wstype
|
data.wstype | string |
Indica o tipo iManage Work do objeto. Os valores possíveis são 'documento', 'document_shortcut', 'email'. |
Atualizar a segurança padrão
Atualiza a segurança padrão de um documento, pasta ou espaço de trabalho.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica o tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
Especifica a ID do documento, pasta ou espaço de trabalho. Um exemplo de ID de documento é 'ATIVE_US!453.1'. Um exemplo de uma pasta ou ID de espaço de trabalho é 'ATIVE_US!123'. |
|
Segurança padrão
|
default_security | True | string |
Especifica a segurança padrão para o objeto. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
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 atual ou criar nova versão do documento
Atualiza a versão especificada de um documento ou cria uma nova versão. Esta 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 é substituído por um novo e o perfil do documento anterior é mantido. Se 'Criar nova versão' for especificado, uma nova versão do documento será criada que herda o perfil da pasta. Após a execução bem-sucedida da operação, o perfil do documento é retornado.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Atualizar ou criar nova versão
|
updateOrCreate | True | string |
Especifica para atualizar a versão atual do documento ou para criar uma nova versão. |
|
ID do documento existente
|
documentId | True | string |
Especifica a ID do documento existente. Por exemplo, 'ATIVE_US!556.1'. |
|
Mantenha-se bloqueado
|
keep_locked | boolean |
Especifica se um bloqueio de documento é mantido após o carregamento. |
|
|
Comment
|
comment | string |
Especifica informações adicionais sobre a atualização. |
|
|
Nome do documento
|
name | string |
Especifica o nome do documento. |
|
|
Author
|
author | string |
Especifica a ID de Trabalho do iManage do usuário que criou o documento. |
|
|
Operator
|
operator | string |
Especifica a ID do usuário que fez check-out do documento ou que 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 de 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. |
|
|
Reter Dias
|
retain_days | integer |
Especifica o número de dias que um documento deve ficar 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 a hora (no formato ISO 8601) em que o arquivo foi criado. O ficheiro poderia ter sido criado fora do sistema iManage Work. Esta data pode ser diferente de «create_date». A create_date é a data em que o ficheiro foi criado ou importado pelo sistema iManage Work. |
|
|
Data de edição do arquivo
|
file_edit_date | date-time |
Especifica a data e a hora (no formato ISO 8601) da alteração mais recente no arquivo. O ficheiro poderia ter sido alterado antes de ser carregado para o sistema iManage Work. |
|
|
Personalizado1
|
custom1 | string |
Especifica o valor para custom1. |
|
|
Personalizado2
|
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. |
|
|
Personalizado5
|
custom5 | string |
Especifica o valor para custom5. |
|
|
Personalizado6
|
custom6 | string |
Especifica o valor para custom6. |
|
|
Personalizado7
|
custom7 | string |
Especifica o valor para custom7. |
|
|
Personalizado8
|
custom8 | string |
Especifica o valor para custom8. |
|
|
Personalizado9
|
custom9 | string |
Especifica o valor para custom9. |
|
|
Personalizado10
|
custom10 | string |
Especifica o valor para custom10. |
|
|
Personalizado11
|
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. |
|
|
Personalizado20
|
custom20 | double |
Especifica o valor para custom20. |
|
|
Personalizado21
|
custom21 | string |
Especifica o valor para custom21 no formato datetime ISO 8601. |
|
|
Personalizado22
|
custom22 | string |
Especifica o valor para custom22 no formato datetime ISO 8601. |
|
|
Personalizado23
|
custom23 | string |
Especifica o valor para custom23 no formato datetime ISO 8601. |
|
|
Personalizado24
|
custom24 | string |
Especifica o valor para custom24 no formato datetime ISO 8601. |
|
|
Personalizado25
|
custom25 | boolean |
Especifica o valor para custom25. |
|
|
Personalizado26
|
custom26 | boolean |
Especifica o valor para custom26. |
|
|
Personalizado27
|
custom27 | boolean |
Especifica o valor para custom27. |
|
|
Personalizado28
|
custom28 | boolean |
Especifica o valor para custom28. |
|
|
Personalizado29
|
custom29 | string |
Especifica o valor para custom29. |
|
|
Personalizado30
|
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 espaço de trabalho
Atualiza as informações do espaço de trabalho especificado. Para excluir o valor existente de um campo de cadeia de caracteres, defina o valor do campo como uma cadeia de caracteres vazia entre aspas simples ou duplas.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
id | True | string |
Especifica a ID do espaço de trabalho a ser atualizado. Por exemplo, 'ATIVE_US!427'. |
|
Nome
|
name | string |
Especifica o nome do espaço de trabalho. |
|
|
Proprietário do espaço de trabalho
|
owner | string |
Especifica o proprietário do espaço de trabalho. |
|
|
Personalizado1
|
custom1 | string |
Especifica o valor de custom1. |
|
|
Personalizado2
|
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. |
|
|
Personalizado5
|
custom5 | string |
Especifica o valor de custom5. |
|
|
Personalizado6
|
custom6 | string |
Especifica o valor de custom6. |
|
|
Personalizado7
|
custom7 | string |
Especifica o valor de custom7. |
|
|
Personalizado8
|
custom8 | string |
Especifica o valor de custom8. |
|
|
Personalizado9
|
custom9 | string |
Especifica o valor de custom9. |
|
|
Personalizado10
|
custom10 | string |
Especifica o valor de custom10. |
|
|
Personalizado11
|
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. |
|
|
Personalizado20
|
custom20 | double |
Especifica o valor de custom20. |
|
|
Personalizado21
|
custom21 | string |
Especifica o valor de custom21, no formato datetime ISO 8601. |
|
|
Personalizado22
|
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. |
|
|
Personalizado26
|
custom26 | boolean |
Especifica o valor de custom26. |
|
|
Personalizado27
|
custom27 | boolean |
Especifica o valor de custom27. |
|
|
Personalizado28
|
custom28 | boolean |
Especifica o valor de custom28. |
|
|
Personalizado29
|
custom29 | string |
Especifica o valor de custom29. |
|
|
Personalizado30
|
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 espaço de trabalho. |
|
|
É externo como normal
|
is_external_as_normal | boolean |
Especifica se o espaço de trabalho pode ser tratado como um espaço de trabalho público. Se definido como 'true' e 'default_security' não for 'private', 'is_external' será definido como 'true'. |
|
|
Projeto personalizado1
|
project_custom1 | string |
Especifica informações adicionais sobre o espaço de trabalho. Este campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, espaços de trabalho ou pastas. Este é um texto descritivo que não precisa ser formatado e não é validado. |
|
|
Projeto personalizado2
|
project_custom2 | string |
Especifica informações adicionais sobre o espaço de trabalho. Este campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, espaços de trabalho ou pastas. Este é um texto descritivo que não precisa ser formatado e não é validado. |
|
|
Projeto personalizado3
|
project_custom3 | string |
Especifica informações adicionais sobre o espaço de trabalho. Este campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, espaços de trabalho ou pastas. Este é um texto descritivo que não precisa ser formatado e não é validado. |
|
|
Subclasse do espaço de trabalho
|
subclass | string |
Especifica a subclasse do espaço de trabalho com base na subclasse do documento que ele contém. |
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 tenha sido criado para iniciar com um gatilho fornecido pelo iManage.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica a ID da biblioteca para a qual o fluxo de trabalho está 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. |
Regressos
- response
- object
Atualizar 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 com check-out não pode ser atualizado. Retorna um perfil de documento atualizado após a operação.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Alias
|
alias | string |
Especifica o alias deste documento. |
|
|
Author
|
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, 'ATIVE_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 de sistema do 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 do documento. |
|
|
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 está editando o perfil do documento. Por exemplo, 'JSMITH'. |
|
|
Reter Dias
|
retain_days | integer |
Especifica o número de dias antes de o documento inativo ser elegível para arquivamento. |
|
|
Subclasse
|
subclass | string |
Especifica a subclasse do documento. |
|
|
Personalizado1
|
custom1 | string |
Especifica o valor de custom1. |
|
|
Personalizado2
|
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. |
|
|
Personalizado5
|
custom5 | string |
Especifica o valor de custom5. |
|
|
Personalizado6
|
custom6 | string |
Especifica o valor de custom6. |
|
|
Personalizado7
|
custom7 | string |
Especifica o valor de custom7. |
|
|
Personalizado8
|
custom8 | string |
Especifica o valor de custom8. |
|
|
Personalizado9
|
custom9 | string |
Especifica o valor de custom9. |
|
|
Personalizado10
|
custom10 | string |
Especifica o valor de custom10. |
|
|
Personalizado11
|
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. |
|
|
Personalizado20
|
custom20 | double |
Especifica o valor de custom20. |
|
|
Personalizado21
|
custom21 | string |
Especifica o valor da propriedade custom21 no formato datetime ISO 8601. |
|
|
Personalizado22
|
custom22 | string |
Especifica o valor da propriedade custom22 no formato 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. |
|
|
Personalizado26
|
custom26 | boolean |
Especifica o valor de custom26. |
|
|
Personalizado27
|
custom27 | boolean |
Especifica o valor de custom27. |
|
|
Personalizado28
|
custom28 | boolean |
Especifica o valor de custom28. |
|
|
Personalizado29
|
custom29 | string |
Especifica o valor de custom29. |
|
|
Personalizado30
|
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. |
Carregar documento
Carrega um arquivo como um novo documento para a pasta especificada.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica a ID da biblioteca de destino. |
|
ID da pasta
|
folderId | True | string |
Especifica o ID da pasta de destino. Por exemplo, 'ATIVE_US!987'. |
|
Herdar perfil de pasta
|
inherit_profile_from_folder | True | boolean |
Especifica se os dados de perfil são herdados da pasta pai. |
|
Mantenha-se bloqueado
|
keep_locked | boolean |
Especifica se um bloqueio de documento é mantido após o carregamento. |
|
|
Comment
|
comment | string |
Especifica informações adicionais sobre a atualização. |
|
|
Author
|
author | string |
Especifica a ID de Trabalho do iManage do usuário que criou o documento. |
|
|
Operator
|
operator | string |
Especifica a ID do usuário que fez check-out do documento ou que 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 de 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. |
|
|
Reter Dias
|
retain_days | integer |
Especifica o número de dias que um documento deve ficar 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 a hora (no formato ISO 8601) em que o arquivo foi criado. O ficheiro poderia ter sido criado fora do sistema iManage Work. Esta data pode ser diferente de «create_date». A create_date é a data em que o ficheiro foi criado ou importado pelo sistema iManage Work. |
|
|
Data de edição do arquivo
|
file_edit_date | date-time |
Especifica a data e a hora (no formato ISO 8601) da alteração mais recente no arquivo. O ficheiro poderia ter sido alterado antes de ser carregado para o sistema iManage Work. |
|
|
Personalizado1
|
custom1 | string |
Especifica o valor para custom1. |
|
|
Personalizado2
|
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. |
|
|
Personalizado5
|
custom5 | string |
Especifica o valor para custom5. |
|
|
Personalizado6
|
custom6 | string |
Especifica o valor para custom6. |
|
|
Personalizado7
|
custom7 | string |
Especifica o valor para custom7. |
|
|
Personalizado8
|
custom8 | string |
Especifica o valor para custom8. |
|
|
Personalizado9
|
custom9 | string |
Especifica o valor para custom9. |
|
|
Personalizado10
|
custom10 | string |
Especifica o valor para custom10. |
|
|
Personalizado11
|
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. |
|
|
Personalizado20
|
custom20 | double |
Especifica o valor para custom20. |
|
|
Personalizado21
|
custom21 | string |
Especifica o valor para custom21 no formato datetime ISO 8601. |
|
|
Personalizado22
|
custom22 | string |
Especifica o valor para custom22 no formato datetime ISO 8601. |
|
|
Personalizado23
|
custom23 | string |
Especifica o valor para custom23 no formato datetime ISO 8601. |
|
|
Personalizado24
|
custom24 | string |
Especifica o valor para custom24 no formato datetime ISO 8601. |
|
|
Personalizado25
|
custom25 | boolean |
Especifica o valor para custom25. |
|
|
Personalizado26
|
custom26 | boolean |
Especifica o valor para custom26. |
|
|
Personalizado27
|
custom27 | boolean |
Especifica o valor para custom27. |
|
|
Personalizado28
|
custom28 | boolean |
Especifica o valor para custom28. |
|
|
Personalizado29
|
custom29 | string |
Especifica o valor para custom29. |
|
|
Personalizado30
|
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
Copia um documento para a pasta especificada.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
ID da pasta de destino
|
folderId | True | string |
Especifica o ID da pasta de destino para a qual o documento deve ser copiado. Por exemplo, 'ATIVE_US!987'. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Acesso aos 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. |
|
Author
|
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 os destinatários para os quais o e-mail é copiado. Aplicável apenas a e-mails. |
|
Classe de documento
|
data.class | string |
Indica a classe do documento. |
|
Descrição da classe do 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 a hora (no formato ISO 8601) em que o documento foi importado para o sistema iManage Work. Esta data pode ser diferente de «file_create_date». |
|
Base de dados
|
data.database | string |
Indica a biblioteca onde o documento está 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 a hora (no formato ISO 8601) da alteração mais recente no documento. |
|
Data de edição do perfil
|
data.edit_profile_date | string |
Indica a data e a hora (no formato ISO 8601) da alteração mais recente no perfil do documento. |
|
Extensão do documento
|
data.extension | string |
Indica a extensão de nome de arquivo, também chamada de extensão de aplicativo, do documento. |
|
Data de criação do arquivo
|
data.file_create_date | string |
Indica a data e a hora (no formato ISO 8601) em que o arquivo foi criado. O ficheiro pode ter sido criado fora do sistema iManage Work. Esta data pode ser diferente de «create_date». |
|
Data de edição do arquivo
|
data.file_edit_date | string |
Indica a data e a hora (no formato ISO 8601) da alteração mais recente no arquivo. O ficheiro pode ter sido alterado antes de ser carregado para o sistema iManage Work. |
|
De
|
data.from | string |
Indica o remetente do e-mail. Aplicável apenas a e-mails. |
|
Nome completo do ficheiro
|
data.full_file_name | string |
Indica o nome completo do arquivo do documento. Inclui a extensão de nome de arquivo. |
|
Tem Acessório
|
data.has_attachment | boolean |
Indica se o e-mail tem anexos. Aplicável apenas a e-mails. |
|
Propriedades básicas do documento
|
data.basic_properties | string |
Indica um elemento '' incorporável que contém propriedades básicas do documento. |
|
ID do documento
|
data.id | string |
Indica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
É indexável
|
data.indexable | boolean |
Indica se o documento está indexado pelo sistema. |
|
Está com check-out
|
data.is_checked_out | boolean |
Indica se foi feito check-out do documento. |
|
é 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 de sistema do 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 normalmente. |
|
É 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 iManage Work Link (iWL) 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 Utilizador
|
data.last_user | string |
Indica a ID do usuário que editou o documento mais recentemente. Por exemplo, 'JSMITH'. |
|
Última Descrição do Utilizador
|
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 está editando seu perfil no momento. Por exemplo, 'JSMITH'. |
|
Descrição do Operador
|
data.operator_description | string |
Indica informações adicionais sobre o operador. |
|
Data de Receção
|
data.received_date | string |
Indica a data e a hora (no formato ISO 8601) em que o e-mail foi recebido. Aplicável apenas a e-mails. |
|
Reter Dias
|
data.retain_days | integer |
Indica o número de dias antes de o documento ser elegível para arquivamento. Aplicável apenas a documentos inativos. |
|
Data de envio
|
data.sent_date | string |
Indica a data e a hora (no formato ISO 8601) em que o e-mail foi enviado. Aplicável apenas a e-mails. |
|
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 e-mail. Aplicável apenas a e-mails. |
|
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 iManage Work. |
|
Descrição do tipo
|
data.type_description | string |
Indica informações adicionais sobre o tipo de documento. |
|
Versão do documento
|
data.version | integer |
Indica o número da versão do documento. |
|
ID do espaço de trabalho
|
data.workspace_id | string |
Indica a ID do espaço de trabalho do documento. Por exemplo, 'ATIVE_US!427'. |
|
Nome do espaço de trabalho
|
data.workspace_name | string |
Indica o nome do espaço de trabalho do documento. |
|
Wstype
|
data.wstype | string |
Indica o tipo iManage Work do objeto. Os valores possíveis são 'documento', 'pasta', 'espaço de trabalho', 'email', 'document_shortcut', 'folder_shortcut', 'workspace_shortcut', 'usuário'. |
|
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. |
|
Personalizado21
|
data.custom21 | string |
Indica o valor da propriedade custom21 no formato datetime ISO 8601. |
|
Personalizado22
|
data.custom22 | string |
Indica o valor da propriedade custom22 no formato datetime ISO 8601. |
Copiar permissões
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 sobre como lidar com a combinação de permissões de origem e destino. 'Overwrite' atualiza os usuários, grupos e níveis de permissão do objeto de destino para corresponder exatamente aos do objeto de origem. 'Mesclar' mantém todos os usuários e grupos no objeto de destino e os combina com a fonte, mas em caso de conflito de nível de permissão em um indivíduo ou grupo: 'Mesclar (Pessimista)' obtém a permissão inferior, enquanto 'Mesclar (Otimista)' obtém a permissão mais alta para o usuário ou grupo em conflito.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
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 ID de documento é 'ATIVE_US!453.1'. Um exemplo de uma pasta ou ID de espaço de trabalho é 'ATIVE_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 ID de documento é 'ATIVE_US!453.1'. Um exemplo de uma pasta ou ID de espaço de trabalho é 'ATIVE_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 para substituir permissões de objeto de destino por 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. |
Regressos
Criar espaço de trabalho
Cria um novo espaço de trabalho com base no modelo selecionado. Um modelo de espaço de trabalho é um espaço de trabalho predefinido cuja estrutura é copiada para o novo espaço de trabalho. As restrições no modelo de espaço de trabalho são aplicadas automaticamente ao criar o novo espaço de trabalho.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica a ID da biblioteca do espaço de trabalho de destino. |
|
Template
|
templateId | True | string |
Especifica o modelo de espaço de trabalho a ser usado para criar o espaço de trabalho e seus filhos. |
|
Nome
|
name | True | string |
Especifica o nome do espaço de trabalho. |
|
Criar filhos
|
createChildren | True | string |
Especifica para criar todas as pastas (opcionais e obrigatórias) ou apenas as pastas necessárias. |
|
Proprietário do espaço de trabalho
|
owner | string |
Especifica o proprietário do espaço de trabalho. Tem de ser um administrador de sistema do iManage Work para definir o proprietário de uma área de trabalho. |
|
|
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 espaço de trabalho. |
|
|
Personalizado1
|
custom1 | string |
Especifica o valor de custom1 a ser associado ao espaço de trabalho recém-criado. Esse valor substitui o valor custom1 do espaço de trabalho de modelo selecionado, se presente. Se as pastas filho tiverem um valor custom1 definido, o valor custom1 dessas pastas filho não será substituído. |
|
|
Personalizado2
|
custom2 | string |
Especifica o valor de custom2 a ser associado ao espaço de trabalho 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 custom2 do espaço de trabalho de modelo selecionado, se presente. Se as pastas filho tiverem um valor custom2 definido, o valor custom2 dessas pastas filho não será substituído. |
|
|
Personalizado3
|
custom3 | string |
Especifica o valor de custom3. |
|
|
Personalizado4
|
custom4 | string |
Especifica o valor de custom4. |
|
|
Personalizado5
|
custom5 | string |
Especifica o valor de custom5. |
|
|
Personalizado6
|
custom6 | string |
Especifica o valor de custom6. |
|
|
Personalizado7
|
custom7 | string |
Especifica o valor de custom7. |
|
|
Personalizado8
|
custom8 | string |
Especifica o valor de custom8. |
|
|
Personalizado9
|
custom9 | string |
Especifica o valor de custom9. |
|
|
Personalizado10
|
custom10 | string |
Especifica o valor de custom10. |
|
|
Personalizado11
|
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. |
|
|
Personalizado20
|
custom20 | double |
Especifica o valor de custom20. |
|
|
Personalizado21
|
custom21 | string |
Especifica o valor de custom21 no formato datetime ISO 8601. |
|
|
Personalizado22
|
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. |
|
|
Personalizado26
|
custom26 | boolean |
Especifica o valor de custom26. |
|
|
Personalizado27
|
custom27 | boolean |
Especifica o valor de custom27. |
|
|
Personalizado28
|
custom28 | boolean |
Especifica o valor de custom28. |
|
|
Personalizado29
|
custom29 | string |
Especifica o valor de custom29. |
|
|
Personalizado30
|
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 espaço de trabalho pode ser tratado como um espaço de trabalho público. Se definido como 'true' e 'default_security' não for 'private', define 'is_external' como 'true'. |
|
|
Projeto personalizado1
|
project_custom1 | string |
Especifica informações adicionais sobre o espaço de trabalho. Este campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, espaços de trabalho ou pastas. Este é um texto descritivo que não precisa ser formatado e não é validado. |
|
|
Projeto personalizado2
|
project_custom2 | string |
Especifica informações adicionais sobre o espaço de trabalho. Este campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, espaços de trabalho ou pastas. Este é um texto descritivo que não precisa ser formatado e não é validado. |
|
|
Projeto personalizado3
|
project_custom3 | string |
Especifica informações adicionais sobre o espaço de trabalho. Este campo é diferente do campo personalizado de metadados associado a itens de conteúdo, como documentos, espaços de trabalho ou pastas. Este é um texto descritivo que não precisa ser formatado e não é validado. |
|
|
Subclasse do espaço de trabalho
|
subclass | string |
Especifica a subclasse do espaço de trabalho com base na subclasse do documento que ele contém. |
Criar relação de documento
Cria uma relação entre documentos especificados em uma biblioteca.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento principal
|
primaryDocumentId | True | string |
Especifica a ID do documento principal a ser relacionado. Por exemplo, 'ATIVE_US!453.1'. |
|
ID do documento relacionado
|
relatedDocumentId | True | string |
Especifica a ID do documento a ser relacionado. Por exemplo, 'ATIVE_US!453.1'. |
Regressos
- response
- object
Definir as principais propriedades de metadados estendidos em um documento
Define as principais propriedades de metadados estendidos em um documento.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
Nome
|
key | True | string |
Especifica o nome da propriedade principal de metadados estendidos. |
|
Valor
|
value | True | string |
Especifica um ou mais valores a serem definidos para a propriedade principal de metadados estendidos, separados por ponto-e-vírgula. Para desdefinir o valor, defina o valor da chave como uma cadeia de caracteres vazia entre aspas simples ou duplas. |
Descarregar documento
Transfere uma versão de um documento específico, com base no ID do documento. Se a última for verdadeira, a versão mais recente deste documento será baixada. O download é um fluxo e não é salvo localmente.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_USE!453.1'. |
|
Obter a versão mais recente
|
latest | boolean |
Especifica para baixar a versão mais recente do documento. |
Regressos
Indica o conteúdo do arquivo.
- Conteúdo do Ficheiro
- binary
Editar pares nome-valor
Cria, atualiza ou exclui propriedades do par nome-valor de um documento, pasta ou espaço de trabalho. Para excluir um par nome-valor, defina o valor da chave como uma cadeia de caracteres vazia entre aspas simples ou duplas.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica o tipo de objeto. Os valores possíveis são 'documento', 'pasta', 'espaço de trabalho'. |
|
ID do objeto
|
objectId | True | string |
Especifica a ID do documento, pasta ou espaço de trabalho. Um exemplo de ID de documento é 'ATIVE_US!453.1'. Um exemplo de uma pasta ou ID de espaço de trabalho é 'ATIVE_US!123'. |
|
Pares nome-valor
|
nameValuePairs | object |
Especifica os pares de nome e valor de forma livre para este documento. |
Eliminar documento
Exclui o documento especificado.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
Excluir todas as versões
|
deleteAllVersions | True | boolean |
Especifica para excluir todas as versões do documento. |
Eliminar referência do documento
Exclui a referência do documento da pasta especificada.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
ID da pasta
|
folderId | True | string |
Especifica a ID da pasta. Por exemplo, 'ATIVE_US!773'. |
Regressos
- response
- object
Excluir relação de documento
Exclui uma relação entre documentos especificados em uma biblioteca.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento principal
|
primaryDocumentId | True | string |
Especifica a ID do documento principal. Por exemplo, 'ATIVE_US!453.1'. |
|
ID do documento relacionado
|
relatedDocumentId | True | string |
Especifica a ID do documento relacionado. Por exemplo, 'ATIVE_US!453.1'. |
Regressos
- response
- object
Mover documento
Move um documento para a pasta especificada.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da pasta principal
|
folderId | True | string |
Especifica a ID da pasta pai. Por exemplo, 'ATIVE_US!987'. |
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
ID da pasta de destino
|
destination_folder_id | True | string |
Especifica o ID da pasta de destino para a qual o documento deve ser movido. Por exemplo, 'ATIVE_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. Este parâmetro é aplicável somente quando Update Profile é 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
Obtém uma lista de administradores com determinadas permissões para um documento, pasta ou espaço de trabalho. Um administrador fiduciário pode ser um utilizador ou grupo.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica o tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
Especifica a ID do documento, pasta ou espaço de trabalho. Um exemplo de ID de documento é 'ATIVE_US!453.1'. Um exemplo de uma pasta ou ID de espaço de trabalho é 'ATIVE_US!123'. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
dados
|
data | array of object |
Indica a lista de administradores com determinadas permissões para um documento, pasta ou espaço de trabalho. Um administrador fiduciário pode ser um utilizador ou grupo. |
|
Nome Completo
|
data.full_name | string |
Indica o nome completo do administrador fiduciário. |
|
ID
|
data.id | string |
Indica o ID do administrador fiduciário. Pode ser um ID de grupo ou um ID de utilizador. Por exemplo, 'JSMITH' ou 'MARKETING'. |
|
SSID
|
data.ssid | string |
Indica a ID exclusiva gerada pelo sistema do administrador fiduciário. |
|
Tipo
|
data.type | string |
Indica o tipo de entidade retornada. Os valores possíveis são 'utilizador' ou 'grupo'. |
Obter as principais propriedades de metadados estendidos de um documento
Obtém as principais propriedades de metadados estendidos de um documento.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
Latest
|
latest | boolean |
Especifica para obter a versão mais recente do documento. |
Obter aulas
Obtém a lista de classes de documento disponíveis em uma biblioteca que correspondem aos critérios especificados.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica o 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írgula. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais são suportados. |
|
|
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. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) é suportado. Não há suporte para correspondências parciais. |
|
|
Eco
|
echo | boolean |
Especifica se os 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 ID ou descrição. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais são suportados. |
|
|
Subclasse necessária
|
subclass_required | boolean |
Especifica se a classe tem uma subclasse necessária. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ID da Classe Top Matching
|
data.topMatchingId | string |
Indica o ID da classe correspondente superior. Por exemplo, "PETIÇÃO". |
|
Descrição da Classe Top Matching
|
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, "PETIÇÃO". |
|
É indexável
|
data.results.indexable | boolean |
Indica se o documento está 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 desta classe como expirados. |
|
Campos obrigató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. |
|
Está sombreado
|
data.results.shadow | boolean |
Indica se um documento dessa classe é sombreado (retido) no computador local de um usuário após fazer check-in. |
|
É Subclasse Obrigatória
|
data.results.subclass_required | boolean |
Indica se uma subclasse é necessária para essa classe. |
Obter bibliotecas
Obtém uma lista de bibliotecas às quais o usuário tem acesso.
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
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 para exibição da biblioteca. |
|
Tipo
|
data.type | string |
Indica o tipo da biblioteca. Os valores possíveis são 'worksite' ou 'linksite'. |
|
Está escondido
|
data.is_hidden | boolean |
Indica se a biblioteca está oculta. |
Obter detalhes do utilizador
Obtém informações sobre um usuário da biblioteca especificada.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica o ID da biblioteca do usuário de destino. |
|
ID de utilizador
|
userId | True | string |
Especifica a ID do usuário para o qual obter informações detalhadas do perfil. Por exemplo, 'JSMITH'. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
dados
|
data | UserProfile |
Indica informações sobre um usuário. |
Obter membros do grupo
Obtenha detalhes dos usuários que pertencem ao grupo especificado e correspondem aos critérios especificados.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica o ID da biblioteca do grupo-alvo. |
|
ID do grupo
|
groupId | True | string |
Especifica a ID do grupo. Por exemplo, 'MARKETING'. |
|
Estado de início de sessão
|
logon_status | string |
Especifica um filtro para usuários com base no valor atual da propriedade 'allow_logon' para cada usuário. |
|
|
Limite
|
limit | integer |
Especifica o número máximo de membros a serem retornados, independentemente do número total de membros no grupo. |
|
|
Biblioteca preferida
|
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. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) não é suportado. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
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 espaço de trabalho
Obtém a lista de modelos disponíveis em uma biblioteca. Um modelo de espaço de trabalho é um espaço de trabalho predefinido cuja estrutura é copiada para o novo espaço de trabalho.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica a ID da biblioteca do espaço de trabalho de destino. |
|
Personalizado1
|
custom1 | string |
Especifica um valor a ser correspondido ao valor custom1 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado2
|
custom2 | string |
Especifica um valor a ser correspondido ao valor custom2 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado3
|
custom3 | string |
Especifica um valor a ser correspondido ao valor custom3 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado4
|
custom4 | string |
Especifica um valor a ser correspondido ao valor custom4 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado5
|
custom5 | string |
Especifica um valor a ser correspondido com o valor custom5 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado6
|
custom6 | string |
Especifica um valor a ser correspondido ao valor custom6 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado7
|
custom7 | string |
Especifica um valor a ser correspondido ao valor custom7 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado8
|
custom8 | string |
Especifica um valor a ser correspondido ao valor custom8 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado9
|
custom9 | string |
Especifica um valor a ser correspondido ao valor custom9 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado10
|
custom10 | string |
Especifica um valor a ser correspondido ao valor custom10 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado11
|
custom11 | string |
Especifica um valor a ser correspondido ao valor custom11 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado12
|
custom12 | string |
Especifica um valor a ser correspondido ao valor custom12 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado17
|
custom17 | double |
Especifica o valor para custom17. |
|
|
Personalizado18
|
custom18 | double |
Especifica o valor para custom18. |
|
|
Personalizado19
|
custom19 | double |
Especifica o valor para custom19. |
|
|
Personalizado20
|
custom20 | double |
Especifica o valor para custom20. |
|
|
Personalizado21
|
custom21 | string |
Especifica o valor (no formato datetime ISO 8601) a ser pesquisado em custom21 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, o uso dessa propriedade é personalizado para sua instalação do iManage Work. |
|
|
Personalizado22
|
custom22 | string |
Especifica o valor (no formato datetime ISO 8601) a ser pesquisado em custom22 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, o uso dessa propriedade é personalizado para sua instalação do iManage Work. |
|
|
Personalizado23
|
custom23 | string |
Especifica o valor (no formato datetime ISO 8601) a ser pesquisado no custom23 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, o uso dessa propriedade é personalizado para sua instalação do iManage Work. |
|
|
Personalizado24
|
custom24 | string |
Especifica o valor (no formato datetime ISO 8601) a ser pesquisado em custom24 associado ao modelo de espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, 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) para pesquisar. Esta propriedade não é reservada pelo iManage Work e não é um valor validado. Destina-se a ser personalizado de acordo com os requisitos da sua empresa. |
|
|
Custom21 (limite superior)
|
custom21_to | string |
Especifica o limite superior de custom21 (no formato datetime ISO 8601) para pesquisar. Esta propriedade não é reservada pelo iManage Work e não é um valor validado. Destina-se a ser personalizado de acordo com os requisitos da sua empresa. |
|
|
Costume21 (Relativo)
|
custom21_relative | string |
Especifica um intervalo de datas a ser pesquisado, relativo à data atual. Este 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) para pesquisar. Esta propriedade não é reservada pelo iManage Work e não é um valor validado. Destina-se a ser personalizado de acordo com os requisitos da sua empresa. |
|
|
Custom22 (limite superior)
|
custom22_to | string |
Especifica o limite superior de custom22 (no formato datetime ISO 8601) para pesquisar. Esta propriedade não é reservada pelo iManage Work e não é um valor validado. Destina-se a ser personalizado de acordo com os requisitos da sua empresa. |
|
|
Costume22 (Relativo)
|
custom22_relative | string |
Especifica um intervalo de datas a ser pesquisado, relativo à data atual. Este 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). |
|
|
Custom23 (limite inferior)
|
custom23_from | string |
Especifica o limite inferior de custom23 (no formato datetime ISO 8601) para pesquisar. Esta propriedade não é reservada pelo iManage Work e não é um valor validado. Destina-se a ser personalizado de acordo com os requisitos da sua empresa. |
|
|
Custom23 (limite superior)
|
custom23_to | string |
Especifica o limite superior de custom23 (no formato datetime ISO 8601) para pesquisar. Esta propriedade não é reservada pelo iManage Work e não é um valor validado. Destina-se a ser personalizado de acordo com os requisitos da sua empresa. |
|
|
Costume23 (Relativo)
|
custom23_relative | string |
Especifica um intervalo de datas a ser pesquisado, relativo à data atual. Este 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) para pesquisar. Esta propriedade não é reservada pelo iManage Work e não é um valor validado. Destina-se a ser personalizado de acordo com os requisitos da sua empresa. |
|
|
Custom24 (limite superior)
|
custom24_to | string |
Especifica o limite superior de custom24 (no formato datetime ISO 8601) para pesquisar. Esta propriedade não é reservada pelo iManage Work e não é um valor validado. Destina-se a ser personalizado de acordo com os requisitos da sua empresa. |
|
|
Costume24 (Relativo)
|
custom24_relative | string |
Especifica um intervalo de datas a ser pesquisado, relativo à data atual. Este 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 custom25 a ser pesquisado. |
|
|
Personalizado26
|
custom26 | boolean |
Especifica o valor custom26 a ser pesquisado. |
|
|
Personalizado27
|
custom27 | boolean |
Especifica o valor custom27 a ser pesquisado. |
|
|
Personalizado28
|
custom28 | boolean |
Especifica o valor custom28 a ser pesquisado. |
|
|
Personalizado29
|
custom29 | string |
Especifica um valor a ser correspondido com custom29. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado30
|
custom30 | string |
Especifica um valor a ser correspondido com custom30. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
Obter perfil do documento
Obtém as propriedades do documento associadas a uma ID de documento específica.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
Obter a versão mais recente
|
latest | boolean |
Especifica para obter a versão mais recente do documento. |
Obter perfil do espaço de trabalho
Obtém o perfil do espaço de trabalho e, opcionalmente, a lista de operações permitidas para o espaço de trabalho.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do espaço de trabalho
|
workspaceId | True | string |
Especifica a ID do espaço de trabalho. Por exemplo, 'ATIVE_US!427'. |
Obter permissões
Obtém propriedades de permissão de acesso de usuário ou grupo de um documento, pasta ou espaço de trabalho. As propriedades de resposta podem variar de acordo com as permissões de usuário ou grupo.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica o tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
Especifica a ID do documento, pasta ou espaço de trabalho. Um exemplo de ID de documento é 'ATIVE_US!453.1'. Um exemplo de uma pasta ou ID de espaço de trabalho é 'ATIVE_US!123'. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
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. |
|
Todos os IDs de usuário
|
data.all_user_ids | string |
Indica uma lista de todos os IDs de usuário, concatenados como uma cadeia de caracteres e separados por ponto-e-vírgula. |
|
Todos os 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
Obtém todas as subclasses da biblioteca que correspondem aos critérios especificados.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica o 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, "PETIÇÃO". |
|
ID da subclasse
|
alias | string |
Especifica a ID das subclasses a serem pesquisadas. Pode ser uma lista separada por vírgula. O caractere curinga (*) é suportado. Correspondências parciais são suportadas 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. O caractere curinga (*) é suportado. Correspondências parciais são suportadas quando o caractere curinga é usado. |
|
|
Eco
|
echo | boolean |
Especifica se as subclasses podem ser ecoadas para o disco rígido local de um usuário. Isso é para facilitar o trabalho off-line. |
|
|
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 ID da subclasse ou descrição. O caractere curinga (*) é suportado. Correspondências parciais são suportadas. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ID da subclasse correspondente superior
|
data.topMatchingId | string |
Indica a ID da subclasse correspondente superior. |
|
Descrição da subclasse de correspondência superior
|
data.topMatchingDescription | string |
Indica a descrição da subclasse correspondente 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 de perfil do documento. Por exemplo, 'TUTELA'. |
|
ID do pai
|
data.results.parent.id | string |
Indica o ID da classe pai da subclasse. |
|
Campos obrigató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 desta subclasse como expirados. |
|
Está sombreado
|
data.results.shadow | boolean |
Indica se um documento dessa subclasse é sombreado (retido) no computador local de um usuário após fazer check-in. |
Obter versões de documentos
Obtém perfis para todas as versões às quais o usuário atual tem acesso para um documento especificado.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Perfis de documentos
|
data | array of MinimalDocumentProfileInArray |
Permissões de atualização
Atualiza as permissões de um objeto.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Especifica o tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
Especifica a ID do documento, pasta ou espaço de trabalho. Um exemplo de ID de documento é 'ATIVE_US!453.1'. Um exemplo de uma pasta ou ID de espaço de trabalho é 'ATIVE_US!123'. |
|
Nível de Acesso
|
access_level | True | string |
Especifica o nível de acesso. |
|
Utilizadores
|
users | string |
Especifica um ou mais usuários para definir o nível de acesso, separados por ponto-e-vírgula. |
|
|
Groups
|
groups | string |
Especifica um ou mais grupos para definir o nível de acesso, separados por ponto-e-vírgula. |
Regressos
Pesquisar espaços de trabalho
Pesquise espaços de trabalho.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica a ID da biblioteca do espaço de trabalho de destino. |
|
Title
|
name | string |
Especifica a cadeia de caracteres a ser pesquisada na propriedade name do espaço de trabalho. Esta 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 espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. |
|
|
Keyword
|
anywhere | string |
Especifica o texto a ser pesquisado em qualquer lugar no perfil do espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. |
|
|
Description
|
description | string |
Especifica o texto a ser pesquisado na propriedade description do espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. |
|
|
Subclasse
|
subclass | string |
Especifica um valor a ser correspondido ao valor da subclasse associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. |
|
|
Personalizado1
|
custom1 | string |
Especifica um valor a ser correspondido ao valor custom1 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado2
|
custom2 | string |
Especifica um valor a ser correspondido ao valor custom2 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado3
|
custom3 | string |
Especifica um valor a ser correspondido ao valor custom3 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado4
|
custom4 | string |
Especifica um valor a ser correspondido ao valor custom4 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado5
|
custom5 | string |
Especifica um valor a ser correspondido ao valor custom5 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado6
|
custom6 | string |
Especifica um valor a ser correspondido ao valor custom6 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado7
|
custom7 | string |
Especifica um valor a ser correspondido ao valor custom7 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado8
|
custom8 | string |
Especifica um valor a ser correspondido ao valor custom8 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado9
|
custom9 | string |
Especifica um valor a ser correspondido ao valor custom9 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado10
|
custom10 | string |
Especifica um valor a ser correspondido ao valor custom10 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado11
|
custom11 | string |
Especifica um valor a ser correspondido ao valor custom11 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado12
|
custom12 | string |
Especifica um valor a ser correspondido ao valor custom12 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado13
|
custom13 | string |
Especifica um valor a ser correspondido ao valor custom13 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais são suportados. |
|
|
Personalizado14
|
custom14 | string |
Especifica um valor a ser correspondido ao valor custom14 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais são suportados. |
|
|
Personalizado15
|
custom15 | string |
Especifica um valor a ser correspondido ao valor custom15 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais são suportados. |
|
|
Personalizado16
|
custom16 | string |
Especifica um valor a ser correspondido ao valor custom16 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais são suportados. |
|
|
Personalizado17
|
custom17 | string |
Especifica um valor a ser correspondido ao valor custom17 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado18
|
custom18 | string |
Especifica um valor a ser correspondido ao valor custom18 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado19
|
custom19 | string |
Especifica um valor a ser correspondido ao valor custom19 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado20
|
custom20 | string |
Especifica um valor a ser correspondido ao valor custom20 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Custom21 (limite inferior)
|
custom21_from | string |
Especifica o limite inferior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom21 associada ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, 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 espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, 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 espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, 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 espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, o uso dessa propriedade é personalizado para sua instalação do iManage Work. |
|
|
Custom23 (limite inferior)
|
custom23_from | string |
Especifica o limite inferior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom23 associada ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, o uso dessa propriedade é personalizado para sua instalação do iManage Work. |
|
|
Custom23 (limite superior)
|
custom23_to | string |
Especifica o limite superior (no formato datetime ISO 8601) a ser pesquisado na propriedade custom23 associada ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, 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 espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, 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 espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. Para espaços de trabalho, o uso dessa propriedade é personalizado para sua instalação do iManage Work. |
|
|
Personalizado25
|
custom25 | boolean |
Especifica um valor a ser correspondido ao valor custom25 associado ao espaço de trabalho. |
|
|
Personalizado26
|
custom26 | boolean |
Especifica um valor a ser correspondido ao valor custom26 associado ao espaço de trabalho. |
|
|
Personalizado27
|
custom27 | boolean |
Especifica um valor a ser correspondido ao valor custom27 associado ao espaço de trabalho. |
|
|
Personalizado28
|
custom28 | boolean |
Especifica um valor a ser correspondido ao valor custom28 associado ao espaço de trabalho. |
|
|
Personalizado29
|
custom29 | string |
Especifica um valor a ser correspondido ao valor custom29 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. |
|
|
Personalizado30
|
custom30 | string |
Especifica um valor a ser correspondido ao valor custom30 associado ao espaço de trabalho. Esta pesquisa não diferencia maiúsculas de minúsculas. O caractere curinga (*) e as correspondências parciais não são suportados. 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. |
Pesquisar utilizadores
Procura utilizadores do iManage Work que correspondam aos critérios de pesquisa especificados.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID de E-mail
|
string |
Especifica o ID de e-mail a ser pesquisado. Por exemplo, 'JSMITH@XYZ.COM'. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Permitir Logon
|
data.topMatchingUser.allow_logon | boolean |
Indica se o usuário tem permissão para fazer logon. |
|
Personalizado1
|
data.topMatchingUser.custom1 | string |
Indica informações adicionais sobre o usuário. |
|
Personalizado2
|
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 do diretório
|
data.topMatchingUser.directory_id | string |
Indica a ID de um diretório externo (como 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 até a raiz da árvore LDAP. |
|
Editar data
|
data.topMatchingUser.edit_date | string |
Indica a data e a hora (no formato ISO 8601) da alteração mais recente no perfil do usuário. |
|
Email
|
data.topMatchingUser.email | string |
Indica o ID de e-mail do usuário. |
|
URL de descoberta automática do Exchange
|
data.topMatchingUser.exch_autodiscover | string |
Indica os detalhes do servidor de câmbio do usuário. |
|
Extension
|
data.topMatchingUser.extension | string |
Indica a extensão do 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. |
|
Fax
|
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 no próximo login. Aplicável apenas a utilizadores virtuais, indicado pelo valor «user_nos» «2». |
|
Nome Completo
|
data.topMatchingUser.full_name | string |
Indica o nome completo do usuário. |
|
General
|
data.topMatchingUser.general | string |
Indica informações gerais sobre o usuário. |
|
ID
|
data.topMatchingUser.id | string |
Indica o 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 é comumente usado para membros temporários da equipe, consultores ou pessoas externas à organização. |
|
Hora da última sincronização
|
data.topMatchingUser.last_sync_ts | string |
Indica a última hora de sincronização (no formato datetime ISO 8601) do perfil do usuário com um diretório externo, como LDAP ou Microsoft Ative Directory (ADFS). |
|
Localização
|
data.topMatchingUser.location | string |
Indica a localização geográfica do usuário. |
|
A palavra-passe 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 preferida
|
data.topMatchingUser.preferred_library | string |
Indica a biblioteca preferida. Uma biblioteca preferencial é a biblioteca padrão do usuário. Cada usuário deve ter uma biblioteca preferida. |
|
Hora alterada da palavra-passe
|
data.topMatchingUser.pwd_changed_ts | string |
Indica a hora (no formato datetime ISO 8601) em que a senha do usuário foi alterada pela última vez. Isto aplica-se apenas a utilizadores virtuais (cujo User NOS é 2). |
|
SSID
|
data.topMatchingUser.ssid | string |
Indica o ID exclusivo gerado 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 do ID de usuário recebido de um diretório externo, como o Microsoft Ative 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 corporativo). Para obter mais informações, entre em contato com o administrador do sistema iManage Work. |
|
Número
|
data.topMatchingUser.user_num | integer |
Indica o ID numérico do sistema do usuário. |
|
results
|
data.results | array of UserProfileInArray |
Pesquisar valores de nó de taxonomia de metadados estendidos principais
Procura valores de nó de taxonomia de metadados estendidos principais que correspondam aos critérios de pesquisa especificados.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica a ID da biblioteca na qual a pesquisa será realizada. |
|
Propriedade de taxonomia
|
taxonomyProperty | True | string |
Especifica a propriedade de taxonomia para a qual pesquisar valores de nó. |
|
ID
|
id | string |
Especifica o identificador de exibição do valor do nó de taxonomia. Esta pesquisa não diferencia maiúsculas de minúsculas. Não há suporte para correspondências parciais. |
|
|
Query
|
query | string |
Especifica uma consulta para correspondência de valores de nó de taxonomia usando uma pesquisa curinga (*), fornecendo correspondências parciais para o identificador de exibição ou descrição. |
|
|
Estado do nó
|
enabled_state | string |
Especifica para retornar somente 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 que começa 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 limitar a pesquisa. |
|
|
Apenas crianças imediatas
|
immediate_children_only | boolean |
Especifica para limitar os resultados da pesquisa aos 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' entre aspas simples ou duplas. |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
SSID
|
data.topMatchingResult.created_by.ssid | string |
Indica a ID exclusiva gerada pelo sistema para o usuário que criou o valor superior do nó correspondente. |
|
Data de Criação
|
data.topMatchingResult.create_date | string |
Indica a data e a hora (no formato ISO 8601) em 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ó correspondente superior. |
|
Editar data
|
data.topMatchingResult.edit_date | string |
Indica a data e a hora (no formato ISO 8601) em que o valor do nó correspondente superior foi editado pela última vez. |
|
Está ativado
|
data.topMatchingResult.enabled | boolean |
Indica se o valor do nó correspondente superior está habilitado. |
|
ID
|
data.topMatchingResult.id | string |
Indica o identificador de exibição para o valor do nó correspondente superior. |
|
SSID
|
data.topMatchingResult.parent.ssid | string |
Indica a ID exclusiva gerada pelo sistema para o nó pai imediato do valor do nó correspondente superior. |
|
SSID
|
data.topMatchingResult.ssid | string |
Indica a ID exclusiva gerada pelo sistema para o valor superior do nó correspondente. |
|
Caminho
|
data.topMatchingResult.path | array of object |
Indica o caminho completo para o valor do nó correspondente superior. Um caminho é uma lista ordenada que começa 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ó correspondente superior. |
|
Cada SSID
|
data.topMatchingResult.path.ssid | string |
Indica a ID exclusiva gerada pelo sistema para um valor de nó no caminho do nó correspondente 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 correspondentes à pesquisa. |
|
Todos os SSIDs do 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. |
Procurar pastas
Procure pastas.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da biblioteca
|
libraryId | True | string |
Especifica o ID da biblioteca da pasta de destino. |
|
ID do contêiner
|
container_id | string |
Especifica a ID do espaço de trabalho ou pasta do qual retornar pastas. Por exemplo, 'ATIVE_US!987'. Se esse parâmetro for fornecido, ele retornará pastas somente do espaço de trabalho ou pasta especificado. |
|
|
Descrição da pasta
|
description | string |
Especifica um valor a ser encontrado na propriedade description da pasta. Esta pesquisa não diferencia maiúsculas de minúsculas. Correspondências parciais são suportadas. |
|
|
Endereço de e-mail da pasta
|
string |
Especifica o endereço de e-mail a ser correspondido ao endereço de e-mail da pasta. Por exemplo, 'email1234@ajubalaw.com'. |
||
|
Nome da pasta
|
name | string |
Especifica um valor a ser encontrado na propriedade name da pasta. Esta pesquisa não diferencia maiúsculas de minúsculas. Correspondências parciais são suportadas. |
|
|
Proprietário da pasta
|
owner | string |
Especifica a cadeia de caracteres a ser correspondida com o proprietário associado à pasta. Esta pesquisa não diferencia maiúsculas de minúsculas. Correspondências parciais são suportadas. |
|
|
Nome do espaço de trabalho
|
workspace_name | string |
Especifica o nome do espaço de trabalho pai ao qual a pasta pertence. Esta pesquisa não diferencia maiúsculas de minúsculas. Correspondências parciais são suportadas. |
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 um ID ou Versão de Diário especificado e, em seguida, promovida para a mais recente. Você deve especificar ID do Diário ou Versão, mas não ambos.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
Especifica a ID do documento. Por exemplo, 'ATIVE_US!453.1'. |
|
Versão
|
version | integer |
Especifica o número da versão a ser usado como base para a nova versão promovida. |
|
|
ID do diário
|
journalId | string |
Especifica o ID do diário a ser usado 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. |
|
|
Author
|
author | string |
Especifica a ID do usuário que criou o documento. Por exemplo, 'JSMITH'. |
|
|
Classe de documento
|
class | string |
Especifica a classe do 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 de sistema do 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 que está editando o perfil do documento. Por exemplo, 'JSMITH'. |
|
|
Reter Dias
|
retain_days | integer |
Especifica o número de dias antes de o documento inativo ser elegível para arquivamento. |
|
|
Subclasse
|
subclass | string |
Especifica a subclasse do documento. |
|
|
Personalizado1
|
custom1 | string |
Especifica o valor de custom1. |
|
|
Personalizado2
|
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. |
|
|
Personalizado5
|
custom5 | string |
Especifica o valor de custom5. |
|
|
Personalizado6
|
custom6 | string |
Especifica o valor de custom6. |
|
|
Personalizado7
|
custom7 | string |
Especifica o valor de custom7. |
|
|
Personalizado8
|
custom8 | string |
Especifica o valor de custom8. |
|
|
Personalizado9
|
custom9 | string |
Especifica o valor de custom9. |
|
|
Personalizado10
|
custom10 | string |
Especifica o valor de custom10. |
|
|
Personalizado11
|
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. |
|
|
Personalizado20
|
custom20 | double |
Especifica o valor de custom20. |
|
|
Personalizado21
|
custom21 | string |
Especifica o valor da propriedade custom21 no formato datetime ISO 8601. |
|
|
Personalizado22
|
custom22 | string |
Especifica o valor da propriedade custom22 no formato 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. |
|
|
Personalizado26
|
custom26 | boolean |
Especifica o valor de custom26. |
|
|
Personalizado27
|
custom27 | boolean |
Especifica o valor de custom27. |
|
|
Personalizado28
|
custom28 | boolean |
Especifica o valor de custom28. |
|
|
Personalizado29
|
custom29 | string |
Especifica o valor de custom29. |
|
|
Personalizado30
|
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 múltiplos espaços de trabalho selecionados |
Este gatilho permite-lhe iniciar um fluxo de trabalho para um ou mais espaços de trabalho selecionados no iManage Work. Forneça um nome de exibição que será mostrado aos usuários nos 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 expirando sem indicar o estado de conclusão para o usuário. |
| Para um documento selecionado |
Este gatilho permite-lhe iniciar um fluxo de trabalho para um documento selecionado numa biblioteca de Trabalho do iManage. Forneça um nome de exibição que será mostrado aos usuários nos 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 expirando sem indicar o estado de conclusão para o usuário. |
| Para um espaço de trabalho selecionado |
Esse gatilho permite iniciar um fluxo de trabalho para um espaço de trabalho selecionado em uma biblioteca de trabalho do iManage. Forneça um nome de exibição que será mostrado aos usuários nos 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 expirando sem indicar o estado de conclusão para o usuário. |
| Para vários documentos selecionados |
Este gatilho permite-lhe iniciar 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 nos 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 expirando sem indicar o estado de conclusão para o usuário. |
Para múltiplos espaços de trabalho selecionados
Este gatilho permite-lhe iniciar um fluxo de trabalho para um ou mais espaços de trabalho selecionados no iManage Work. Forneça um nome de exibição que será mostrado aos usuários nos 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 expirando sem indicar o estado de conclusão para o usuário.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Nome de exibição do fluxo de trabalho
|
workflowName | True | string |
Especifica o nome para exibição do fluxo de trabalho que será 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 onde o fluxo de trabalho está disponível. |
|
ID do formulário
|
formId | True | string |
Especifica a ID do formulário que é apresentado ao usuário para coletar entradas usadas pelo fluxo de trabalho. |
|
Disponível para usuários
|
users | string |
Especifica um ou mais IDs de usuário, separados por ponto-e-vírgula, para os 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, para as quais o fluxo de trabalho está disponível. |
|
|
Aguarde a conclusão
|
waitForCompletion | boolean |
Especifica se os aplicativos aguardam 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'. |
Regressos
Para um documento selecionado
Este gatilho permite-lhe iniciar um fluxo de trabalho para um documento selecionado numa biblioteca de Trabalho do iManage. Forneça um nome de exibição que será mostrado aos usuários nos 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 expirando sem indicar o estado de conclusão para o usuário.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Nome de exibição do fluxo de trabalho
|
workflowName | True | string |
Especifica o nome para exibição do fluxo de trabalho que será 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 onde o fluxo de trabalho está disponível. |
|
ID do formulário
|
formId | True | string |
Especifica a ID do formulário que é 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 um ou mais IDs de usuário, separados por ponto-e-vírgula, para os 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, para as quais o fluxo de trabalho está disponível. |
|
|
Disponível em espaços de trabalho
|
workspaces | string |
Especifica uma ou mais IDs de espaço de trabalho, separadas por ponto-e-vírgula, nas quais o fluxo de trabalho está disponível. |
|
|
Classes de documentos
|
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. |
|
|
Aguarde a conclusão
|
waitForCompletion | boolean |
Especifica se os aplicativos aguardam 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'. |
Regressos
Para um espaço de trabalho selecionado
Esse gatilho permite iniciar um fluxo de trabalho para um espaço de trabalho selecionado em uma biblioteca de trabalho do iManage. Forneça um nome de exibição que será mostrado aos usuários nos 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 expirando sem indicar o estado de conclusão para o usuário.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Nome de exibição do fluxo de trabalho
|
workflowName | True | string |
Especifica o nome para exibição do fluxo de trabalho que será 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 onde o fluxo de trabalho está disponível. |
|
ID do formulário
|
formId | True | string |
Especifica a ID do formulário que é apresentado ao usuário para coletar entradas usadas pelo fluxo de trabalho. |
|
Disponível para usuários
|
users | string |
Especifica um ou mais IDs de usuário, separados por ponto-e-vírgula, para os 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, para as quais o fluxo de trabalho está disponível. |
|
|
Aguarde a conclusão
|
waitForCompletion | boolean |
Especifica se os aplicativos aguardam 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'. |
Regressos
Para vários documentos selecionados
Este gatilho permite-lhe iniciar 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 nos 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 expirando sem indicar o estado de conclusão para o usuário.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Nome de exibição do fluxo de trabalho
|
workflowName | True | string |
Especifica o nome para exibição do fluxo de trabalho que será 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 onde o fluxo de trabalho está disponível. |
|
ID do formulário
|
formId | True | string |
Especifica a ID do formulário que é 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 um ou mais IDs de usuário, separados por ponto-e-vírgula, para os 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, para as 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. |
|
|
Aguarde a conclusão
|
waitForCompletion | boolean |
Especifica se os aplicativos aguardam 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'. |
Regressos
Definições
MinimalDocumentProfileInArray
Indica o perfil de cada versão do documento.
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Author
|
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 '' incorporá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 a hora (no formato ISO 8601) em que o documento foi importado para o sistema iManage Work. Esta data pode ser diferente de «file_create_date». |
|
Personalizado1
|
custom1 | string |
Indica o valor de custom1. |
|
Descrição personalizada1
|
custom1_description | string |
Indica informações adicionais sobre a propriedade custom1. |
|
Personalizado2
|
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 personalizada4
|
custom4_description | string |
Indica informações adicionais sobre a propriedade custom4. |
|
Personalizado5
|
custom5 | string |
Indica o valor de custom5. |
|
Descrição personalizada5
|
custom5_description | string |
Indica informações adicionais sobre a propriedade custom5. |
|
Personalizado6
|
custom6 | string |
Indica o valor de custom6. |
|
Descrição personalizada6
|
custom6_description | string |
Indica informações adicionais sobre a propriedade custom6. |
|
Personalizado7
|
custom7 | string |
Indica o valor de custom7. |
|
Descrição personalizada7
|
custom7_description | string |
Indica informações adicionais sobre a propriedade custom7. |
|
Personalizado8
|
custom8 | string |
Indica o valor de custom8. |
|
Descrição personalizada8
|
custom8_description | string |
Indica informações adicionais sobre a propriedade custom8. |
|
Personalizado9
|
custom9 | string |
Indica o valor de custom9. |
|
Descrição personalizada9
|
custom9_description | string |
Indica informações adicionais sobre a propriedade custom9. |
|
Personalizado10
|
custom10 | string |
Indica o valor de custom10. |
|
Descrição personalizada10
|
custom10_description | string |
Indica informações adicionais sobre a propriedade custom10. |
|
Personalizado11
|
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. |
|
Personalizado20
|
custom20 | double |
Indica o valor de custom20. |
|
Personalizado21
|
custom21 | string |
Indica o valor da propriedade custom21 no formato datetime ISO 8601. |
|
Personalizado22
|
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. |
|
Personalizado26
|
custom26 | boolean |
Indica o valor de custom26. |
|
Personalizado27
|
custom27 | boolean |
Indica o valor de custom27. |
|
Personalizado28
|
custom28 | boolean |
Indica o valor de custom28. |
|
Personalizado29
|
custom29 | string |
Indica o valor de custom29. |
|
Descrição Custom29
|
custom29_description | string |
Indica informações adicionais sobre a propriedade custom29. |
|
Personalizado30
|
custom30 | string |
Indica o valor de custom30. |
|
Descrição Custom30
|
custom30_description | string |
Indica informações adicionais sobre a propriedade custom30. |
|
Base de dados
|
database | string |
Indica a biblioteca onde o documento está 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 a hora (no formato ISO 8601) da alteração mais recente no documento. |
|
Data de edição do perfil
|
edit_profile_date | string |
Indica a data e a hora (no formato ISO 8601) da alteração mais recente no perfil do documento. |
|
Extensão do documento
|
extension | string |
Indica a extensão de nome de arquivo, também chamada de extensão de aplicativo, do documento. |
|
Nome completo do ficheiro
|
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, 'ATIVE_US!453.1'. |
|
É indexável
|
indexable | boolean |
Indica se o documento está indexado pelo sistema. |
|
Está com check-out
|
is_checked_out | boolean |
Indica se foi feito check-out do documento. |
|
é 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 de sistema do 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 iManage Work Link (iWL) 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 Utilizador
|
last_user | string |
Indica a ID do usuário que editou o documento mais recentemente. Por exemplo, 'JSMITH'. |
|
Última Descrição do Utilizador
|
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 está editando seu perfil no momento. 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 iManage Work. |
|
Versão do documento
|
version | integer |
Indica o número da versão do documento. |
|
Wstype
|
wstype | string |
Indica o tipo iManage Work do objeto. Os valores possíveis são 'documento', 'pasta', 'espaço de trabalho', 'email', 'document_shortcut', 'folder_shortcut', 'workspace_shortcut', 'usuário'. |
Perfil de usuário
Indica informações sobre um usuário.
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Permitir Logon
|
allow_logon | boolean |
Indica se o usuário tem permissão para fazer logon. |
|
Personalizado1
|
custom1 | string |
Indica informações adicionais sobre o usuário. |
|
Personalizado2
|
custom2 | string |
Indica informações adicionais sobre o usuário. |
|
Personalizado3
|
custom3 | string |
Indica informações adicionais sobre o usuário. |
|
ID do diretório
|
directory_id | string |
Indica a ID de um diretório externo (como 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 até a raiz da árvore LDAP. |
|
Editar data
|
edit_date | string |
Indica a data e a hora (no formato ISO 8601) da alteração mais recente no perfil do usuário. |
|
Email
|
string |
Indica o ID de e-mail do usuário. |
|
|
URL de descoberta automática do Exchange
|
exch_autodiscover | string |
Indica os detalhes do servidor de câmbio do usuário. |
|
Extension
|
extension | string |
Indica a extensão do 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. |
|
Fax
|
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 no próximo login. Aplicável apenas a utilizadores virtuais, indicado pelo valor «user_nos» «2». |
|
Nome Completo
|
full_name | string |
Indica o nome completo do usuário. |
|
General
|
general | string |
Indica informações gerais sobre o usuário. |
|
ID de utilizador
|
id | string |
Indica o ID do usuário. Por exemplo, 'JSMITH'. |
|
É utilizador externo
|
is_external | boolean |
Indica um usuário externo. Um usuário externo tem acesso limitado e é comumente usado para membros temporários da equipe, consultores ou pessoas externas à organização. |
|
Hora da última sincronização
|
last_sync_ts | string |
Indica a última hora de sincronização (no formato datetime ISO 8601) do perfil do usuário com um diretório externo, como LDAP ou Microsoft Ative Directory (ADFS). |
|
Localização
|
location | string |
Indica a localização geográfica do usuário. |
|
A palavra-passe 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 preferida
|
preferred_library | string |
Indica a biblioteca preferida. Uma biblioteca preferencial é a biblioteca padrão do usuário. Cada usuário deve ter uma biblioteca preferida. |
|
Hora alterada da palavra-passe
|
pwd_changed_ts | string |
Indica a hora (no formato datetime ISO 8601) em que a senha do usuário foi alterada pela última vez. Isto aplica-se apenas a utilizadores virtuais (cujo User NOS é 2). |
|
SSID
|
ssid | string |
Indica o ID exclusivo gerado pelo sistema para o usuário. |
|
Domínio do Utilizador
|
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 estendido
|
user_id_ex | string |
Indica o valor original do ID de usuário recebido de um diretório externo, como o Microsoft Ative Directory (ADFS). |
|
Usuário 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 corporativo). Para obter mais informações, entre em contato com o administrador do sistema iManage Work. |
|
Número de Utilizador
|
user_num | integer |
Indica o ID numérico do sistema do usuário. |
UserProfileInArray
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Permitir Logon
|
allow_logon | boolean |
Indica se o usuário tem permissão para fazer logon. |
|
Personalizado1
|
custom1 | string |
Indica informações adicionais sobre o usuário. |
|
Personalizado2
|
custom2 | string |
Indica informações adicionais sobre o usuário. |
|
Personalizado3
|
custom3 | string |
Indica informações adicionais sobre o usuário. |
|
ID do diretório
|
directory_id | string |
Indica a ID de um diretório externo (como 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 até a raiz da árvore LDAP. |
|
Editar data
|
edit_date | string |
Indica a data e a hora (no formato ISO 8601) da alteração mais recente no perfil do usuário. |
|
Email
|
string |
Indica o ID de e-mail do usuário. |
|
|
URL de descoberta automática do Exchange
|
exch_autodiscover | string |
Indica os detalhes do servidor de câmbio do usuário. |
|
Extension
|
extension | string |
Indica a extensão do 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. |
|
Fax
|
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 no próximo login. Aplicável apenas a utilizadores virtuais, indicado pelo valor «user_nos» «2». |
|
Nome Completo
|
full_name | string |
Indica o nome completo do usuário. |
|
General
|
general | string |
Indica informações gerais sobre o usuário. |
|
ID
|
id | string |
Indica o ID do usuário. Por exemplo, 'JSMITH'. |
|
É utilizador externo
|
is_external | boolean |
Indica um usuário externo. Um usuário externo tem acesso limitado e é comumente usado para membros temporários da equipe, consultores ou pessoas externas à organização. |
|
Hora da última sincronização
|
last_sync_ts | string |
Indica a última hora de sincronização (no formato datetime ISO 8601) do perfil do usuário com um diretório externo, como LDAP ou Microsoft Ative Directory (ADFS). |
|
Localização
|
location | string |
Indica a localização geográfica do usuário. |
|
A palavra-passe 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 preferida
|
preferred_library | string |
Indica a biblioteca preferida. Uma biblioteca preferencial é a biblioteca padrão do usuário. Cada usuário deve ter uma biblioteca preferida. |
|
Hora alterada da palavra-passe
|
pwd_changed_ts | string |
Indica a hora (no formato datetime ISO 8601) em que a senha do usuário foi alterada pela última vez. Isto aplica-se apenas a utilizadores virtuais (cujo User NOS é 2). |
|
SSID
|
ssid | string |
Indica o ID exclusivo gerado 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 estendido
|
user_id_ex | string |
Indica o valor original do ID de usuário recebido de um diretório externo, como o Microsoft Ative 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 corporativo). Para obter mais informações, entre em contato com o administrador do sistema iManage Work. |
|
Número
|
user_num | integer |
Indica o ID numérico do sistema do usuário. |
TaxonomiaNodeValue
Indica cada valor de nó de taxonomia.
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
SSID
|
created_by.ssid | string |
Indica a ID exclusiva gerada pelo sistema para o usuário que criou o valor do nó. |
|
Data de Criação
|
create_date | date-time |
Indica a data e a hora (no formato ISO 8601) em 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 a hora (no formato ISO 8601) em que o valor do nó foi editado pela última vez. |
|
Está ativado
|
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 que começa 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 | Percurso | Tipo | Descrição |
|---|---|---|---|
|
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. |
|
Todos os IDs de usuário
|
data.all_user_ids | string |
Indica uma lista de todos os IDs de usuário, concatenados como uma cadeia de caracteres e separados por ponto-e-vírgula. |
|
Todos os 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 | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Nome do Administrador
|
name | string |
Indica o nome do administrador fiduciário. |
|
ID do Administrador
|
id | string |
Indica o ID do administrador fiduciário. Pode ser um ID de utilizador ou um ID de grupo. |
|
Administrador SID
|
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 'utilizador' ou 'grupo'. |
|
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 de nível de acesso legível por humanos atribuído ao usuário ou grupo para este objeto. Os valores possíveis são 'No Access', 'Read Only', 'Read/Write' ou 'Full Access'. |
|
Access
|
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á ativado
|
enabled | boolean |
Indica se o grupo está habilitado. Não aplicável a utilizadores. |
|
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. |
objecto
Este é o tipo 'objeto'.
binário
Este é o tipo de dados básico 'binário'.