Gerenciamento de Conteúdo Power Connect
O Gerenciador de Conteúdo é um sistema de gerenciamento de conteúdo corporativo baseado em governança projetado para ajudar agências governamentais, setores regulamentados e organizações globais a gerenciar seu conteúdo de negócios da criação ao descarte. Conecte-se ao Gerenciador de Conteúdo para executar ações, incluindo criar ou atualizar registros ou locais, carregar ou baixar arquivos eletrônicos, pesquisar e muito mais. (1.0.4.757)
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Kapish Services Pty Ltd |
| URL | https://kapish.com.au/products/power_connect/ |
| sales@kapish.com.au |
| Metadados do conector | |
|---|---|
| Publicador | Kapish Services Pty Ltd |
| Site | https://kapish.com.au/products/power_connect/ |
| Política de privacidade | https://kapish.com.au/products/privacy-policy/ |
| Categorias | Dados; Conteúdo e arquivos |
O Content Manager Power Connect by Kapish é um conector que fornece funções de automação e integração ao Content Manager para simplificar a capacidade da sua organização de atender aos seus requisitos de gerenciamento de informações e governança.
Pré-requisitos
- Um ServiceAPI do Gerenciador de Conteúdo acessível externamente
- Uma chave de assinatura fornecida pela Kapish Services Pty Ltd
Para obter uma lista detalhada de especificações e requisitos ou para obter mais informações sobre como o conector pode ajudar sua organização, entre em contato com a Kapish Services Pty Ltd
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| OAuth (fluxo de cliente confidencial) | Usar o OAuth para se conectar ao Content Manager | Todas as regiões | Não compartilhável |
| Gerenciado pelo sistema | Usar um nome de usuário e senha para se conectar ao Gerenciador de Conteúdo | Todas as regiões | Não compartilhável |
| Padrão [PRETERIDO] | Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores. | Todas as regiões | Não compartilhável |
OAuth (fluxo de cliente confidencial)
ID de autenticação: OAuth
Aplicável: todas as regiões
Usar o OAuth para se conectar ao Content Manager
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de assinatura do KPC | secureString | A chave de API para acessar o Kapish Power Connect | Verdade |
| URL do CM ServiceAPI (por exemplo, https://myserver/CMServiceAPI/) | cadeia | A URL em que seu CM ServiceAPI pode ser acessado | Verdade |
| URL do Servidor de Autorização (por exemplo, https://myserver/adfs/oauth2/token) | cadeia | A URL para obter o token de acesso | Verdade |
| ID do cliente | cadeia | A ID do cliente para autenticação | Verdade |
| Segredo de Cliente | secureString | O segredo do cliente para autenticação | Verdade |
Gerenciado pelo sistema
ID de autenticação: Básico
Aplicável: todas as regiões
Usar um nome de usuário e senha para se conectar ao Gerenciador de Conteúdo
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de assinatura do KPC | secureString | A chave de API para acessar o Kapish Power Connect | Verdade |
| URL do CM ServiceAPI (por exemplo, https://myserver/CMServiceAPI/) | cadeia | A URL em que seu CM ServiceAPI pode ser acessado | Verdade |
| Nome do usuário | cadeia | O nome de usuário para autenticação | Verdade |
| Senha | secureString | A senha para autenticação | Verdade |
Padrão [PRETERIDO]
Aplicável: todas as regiões
Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de assinatura do KPC | secureString | A chave de API para acessar o Kapish Power Connect | Verdade |
| URL do CM ServiceAPI (por exemplo, https://myserver/CMServiceAPI/) | cadeia | A URL em que seu CM ServiceAPI pode ser acessado | Verdade |
| URL do Servidor de Autorização (por exemplo, https://myserver/adfs/oauth2/token) | cadeia | A URL para obter o token de acesso | Verdade |
| ID do cliente | cadeia | A ID do cliente para autenticação | Verdade |
| Segredo de Cliente | secureString | O segredo do cliente para autenticação | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar registro (adicionar controles de acesso) |
AddAccessControl |
| Atualizar registro (anexar ação ou procedimento) |
Anexar uma ação ou procedimento a um registro |
| Atualizar registro (anexar contato) |
Anexar um contato a um registro |
| Atualizar registro (ações completas) |
Concluir uma ou todas as ações devidas em um registro específico |
| Atualizar registro (check-out) |
Definir o status do registro como check-out |
| Atualizar Registro (Definir Atribuído) |
Defina o Atribuídor como um local específico, volte para Casa ou registre-se como Ausente |
| Atualizar registro (definir rótulo de usuário) |
Permite a configuração de um rótulo de usuário em um registro |
| Atualizar Registro (Descartar) |
Descartar um registro |
| Atualizar registro (desfazer check-out) |
Desfazer um check-out anterior do documento eletrônico para este Registro, desconsiderando todas as alterações feitas desde que ele foi feito check-out |
| Atualizar registro (fechar) |
Use a função CloseRecord para fechar um contêiner – deixe a data em branco se desejar que a data de fechamento seja 'now'. Como fechar um registro pode exigir a atualização de muitos registros independentes, essa função confirma as alterações automaticamente |
| Atualizar registro (finalizar) |
Atualizar um registro de rascunho |
| Atualizar registro (propriedades) |
Atualizar um registro |
| Atualizar registro (reabrir) |
Use a função ReopenRecord para reabrir um contêiner fechado. Como a reabrindo um registro pode exigir a atualização de muitos registros independentes, essa função confirma as alterações automaticamente |
| Atualizar registro (reagendar ações) |
Reagenda todas as ações anexadas a este registro |
| Atualizar registro (remover todas as ações) |
Remove todas as ações anexadas ao registro especificado |
| Atualizar registro (substituir controles de acesso) |
SetAccessControl |
| Baixar arquivo eletrônico |
Baixar um arquivo eletrônico de um registro |
| Carregar arquivo eletrônico |
Carregar um arquivo eletrônico que pode ser anexado posteriormente a um registro |
| Criar Local (Outro) |
Criar um local de qualquer tipo |
| Criar Local (Pessoa) |
Criar um local de pessoa |
| Criar registro (avançado) |
Criar um registro com campos avançados |
| Criar registro (documento) |
Criar um registro |
| Criar registro (pasta) |
Criar um registro |
| Excluir Registro |
Excluir um registro |
| Ler dados de evento |
Transformar dados de evento do Kapish Dispatch para consumo de fluxo |
| Local da atualização (campos adicionais) |
Atualizar campos adicionais em um local |
| Local da atualização (endereço) |
Criar/atualizar o endereço de um local usando a ID exclusiva do endereço |
| Local da Atualização (Pessoa) |
Atualizar um local de pessoa usando seu identificador exclusivo |
| Local de atualização (outro) |
Atualizar um local |
| Localizar iD exclusiva do endereço de localização |
Obter a ID exclusiva do endereço filho de um local |
| Localizar Locais |
Pesquisar locais (buscar uma coleção de locais usando uma cadeia de caracteres de pesquisa) |
| Localizar Local por ID |
Buscar um único local por ID exclusiva ou nome |
| Localizar objetos CM |
Pesquisar objetos CM |
| Localizar registro por ID |
Buscar um único registro por ID exclusiva ou nome |
| Localizar registros |
Pesquisar registros (buscar uma coleção de registros usando uma cadeia de caracteres de pesquisa) |
| Localizar registros (avançado) |
Pesquisar registros (buscar uma coleção de registros usando uma cadeia de caracteres de pesquisa). Retorna uma resposta de ServiceAPI bruta do Gerenciador de Conteúdo. |
| Obter arquivo da URL |
Baixar um arquivo da URL para uma área de preparo usando o plug-in da API de Serviço cm 'GetFileFromUrl' |
| Registro de atualização (anexar arquivo eletrônico) |
Anexar um arquivo eletrônico a um registro |
| Registro de atualização (anexar termo dicionário de sinônimos) |
Anexar um termo dicionário de sinônimos a um registro |
| Registro de Atualização (Avançado) |
Atualizar um registro com propriedades avançadas |
| Registro de atualização (campos adicionais) |
Atualizar campos adicionais em um registro |
| Registro de atualização (classificação) |
Atualizar a classificação de um registro |
| Registro de atualização (definir acesso irrestrito ou baseado em contêiner) |
InheritAccessControl |
| Registro de atualização (não especificado) |
Reverte o estado do registro (e qualquer um de seus conteúdos) para que ele não seja mais descartado |
| Registro de atualização (reatribuir ação) |
Reatribui a ação nomeada para um local especificado |
| Registro de atualização (remover local dos controles de acesso) |
RemoveAccessControl |
| Registro de atualização (representação de solicitação) |
Permite que você crie uma solicitação para que o mecanismo de renderização automática faça uma representação de um registro |
| Registro de atualização (unfinalise - Set As Draft) |
Atualizar um registro finalizado para rascunho |
Atualizar registro (adicionar controles de acesso)
AddAccessControl
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Identificação Única
|
Uri | integer |
Identificador Exclusivo de Localização |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (anexar ação ou procedimento)
Anexar uma ação ou procedimento a um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Ação a ser anexada
|
ActionToAttach | True | integer | |
|
ID exclusiva do atribuídor
|
NewAssignee | integer | ||
|
Opção Assignee
|
AssigneeOption | string | ||
|
Agendar Data de Início
|
ScheduleStartDate | date | ||
|
Ação existente
|
RecordAction | integer | ||
|
Inserir Posição
|
InsertPos | string | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (anexar contato)
Anexar um contato a um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Tipo de contato
|
ContactType | True | string | |
|
Local de contato
|
ContactLocation | True | string |
ID exclusiva ou endereço de email do Local |
|
Definido como contato primário?
|
IsPrimary | True | boolean | |
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (ações completas)
Concluir uma ou todas as ações devidas em um registro específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Concluir
|
Complete | True | string |
Especificar quais Ações de Registro serão concluídas |
|
Concluir ações anteriores
|
CompletePrevious | boolean |
Concluir todas as Ações de Registro antes da especificada |
|
|
Data de conclusão
|
CompletionDate | date |
A data a ser definida como a data de conclusão |
|
|
ID exclusiva da ação de registro
|
RecordActionUri | integer |
A ID exclusiva da ação de registro a ser concluída se 'For Unique Identifier' estiver selecionado |
|
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (check-out)
Definir o status do registro como check-out
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Comments
|
Comments | string | ||
|
Salvar caminho de check-out como
|
SaveCheckoutPathAs | string | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar Registro (Definir Atribuído)
Defina o Atribuídor como um local específico, volte para Casa ou registre-se como Ausente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Novo Atribuídor
|
NewAssignee | string |
ID exclusiva ou endereço de email do novo Atribuídor |
|
|
Tipo de Atribuídor
|
AssigneeType | string | ||
|
Conclusão do retorno por data
|
DueForReturnByDate | date | ||
|
Ocorreu uma alteração de tempo real
|
ActualTimeChangeOccurred | date-time | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (definir rótulo de usuário)
Permite a configuração de um rótulo de usuário em um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Registro
|
Uri | True | integer |
A ID exclusiva do registro ao qual anexar o Rótulo de Usuário |
|
Rótulo do Usuário
|
UserLabel | True | string |
A ID exclusiva ou o nome do rótulo de usuário a ser aplicado |
|
Tipo favorito
|
FavouriteType | string | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar Registro (Descartar)
Descartar um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Continuar com o erro?
|
ContinueOnError | boolean | ||
|
Método de descarte
|
MethodOfDisposal | string | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (desfazer check-out)
Desfazer um check-out anterior do documento eletrônico para este Registro, desconsiderando todas as alterações feitas desde que ele foi feito check-out
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Comments
|
Comments | string | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (fechar)
Use a função CloseRecord para fechar um contêiner – deixe a data em branco se desejar que a data de fechamento seja 'now'. Como fechar um registro pode exigir a atualização de muitos registros independentes, essa função confirma as alterações automaticamente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Continuar com o Erro?
|
ContinueOnError | boolean | ||
|
Incluir Conteúdo?
|
EncloseContents | boolean | ||
|
Finalizar Conteúdo?
|
FinalizeContents | boolean | ||
|
Somente erros de log?
|
LogErrorsOnly | boolean | ||
|
Resultados do log?
|
LogResults | boolean |
Retornar um log de texto dos Registros fechados na propriedade Mensagem de Log? |
|
|
Limpar revisões de conteúdo?
|
PurgeContentRevisions | boolean | ||
|
Data de fechamento específica?
|
SpecificCloseDate | date | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMLogResponse
Atualizar registro (finalizar)
Atualizar um registro de rascunho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Remover revisões antigas
|
SetAsFinalRemoveOldRevisions | boolean | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (propriedades)
Atualizar um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | integer | ||
|
Query
|
q | string |
Especifique uma consulta aqui para aplicar a atualização a um conjunto de registros em vez de apenas um (conforme especificado pela ID Exclusiva) |
|
|
Título (Parte de Texto Livre)
|
RecordTypedTitle | string | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
|
|
Autor
|
RecordAuthor | string |
ID exclusiva ou endereço de email do Local |
|
|
Contêiner
|
RecordContainer | string | ||
|
Classification
|
RecordClassification | string |
Fornecer o identificador exclusivo da classificação |
|
|
Destinatário
|
RecordAddressee | string |
ID exclusiva ou endereço de email do Local |
|
|
Contêiner alternativo
|
RecordAlternativeContainer | string | ||
|
Assignee
|
RecordAssignee | string |
ID exclusiva ou endereço de email do Local |
|
|
Renderizar automaticamente em PDF ao salvar
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Ignorar controles de acesso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Fazer check-in como
|
CheckinAs | string |
Defina a propriedade Source do documento eletrônico. |
|
|
Cliente
|
RecordClient | string |
ID exclusiva ou endereço de email do Local |
|
|
Registro do cliente
|
RecordClientRecord | string | ||
|
Copiar documento do registro
|
CopyDocumentFromRecord | string |
Especifique uma ID exclusiva para o registro do qual copiar o documento eletrônico para este registro., |
|
|
Criador
|
RecordCreator | string |
ID exclusiva ou endereço de email do Local |
|
|
Data criada
|
RecordDateCreated | string | ||
|
Data de conclusão
|
RecordDateDue | string | ||
|
Data publicada
|
RecordDatePublished | string | ||
|
Data recebida
|
RecordDateReceived | string | ||
|
Referência externa
|
RecordExternalReference | string | ||
|
Falha nos avisos?
|
FailOnWarnings | boolean |
True para não criar/salvar um objeto se houver avisos. |
|
|
Nome do arquivo na pasta Uploads
|
RecordFilePath | string |
O nome do arquivo como ele aparece na pasta Uploads. |
|
|
Finalizar em Salvar
|
RecordFinalizeOnSave | boolean | ||
|
Código de barras estrangeiro
|
RecordForeignBarcode | string | ||
|
Local do GPS
|
RecordGpsLocation | string | ||
|
Local da Página Inicial
|
RecordHomeLocation | string |
ID exclusiva do local |
|
|
Espaço Inicial
|
RecordHomeSpace | string | ||
|
Está entre assoa
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Manter check-out
|
keepBookedOut | boolean |
True para deixar o registro em check-out depois que o documento eletrônico é carregado. |
|
|
Número Longo
|
RecordLongNumber | string | ||
|
Tipo de mídia
|
RecordMediaType | string | ||
|
Anotações
|
RecordNotes | string | ||
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string | ||
|
Outro Contato
|
RecordOtherContact | string |
ID exclusiva ou endereço de email do Local |
|
|
Local do proprietário
|
RecordOwnerLocation | string |
ID exclusiva ou endereço de email do Local |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string | ||
|
Data de Revisão
|
RecordReviewDate | string | ||
|
Examinar a data de conclusão
|
RecordReviewDueDate | string | ||
|
Estado de revisão
|
RecordReviewState | string | ||
|
Segurança
|
RecordSecurity | string |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (reabrir)
Use a função ReopenRecord para reabrir um contêiner fechado. Como a reabrindo um registro pode exigir a atualização de muitos registros independentes, essa função confirma as alterações automaticamente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Continuar com o Erro?
|
ContinueOnError | boolean | ||
|
Resultados do log?
|
LogResults | boolean |
Retornar um log de texto dos Registros reabertos na propriedade Mensagem de Log? |
|
|
Cancelar a finalização do conteúdo?
|
UnfinalizeContents | boolean | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMLogResponse
Atualizar registro (reagendar ações)
Reagenda todas as ações anexadas a este registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Da Data Base
|
FromBaseDate | date | ||
|
Usar durações reais
|
UseActualDurations | boolean | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (remover todas as ações)
Remove todas as ações anexadas ao registro especificado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Atualizar registro (substituir controles de acesso)
SetAccessControl
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Identificação Única
|
Uri | integer |
Identificador Exclusivo de Localização |
Retornos
- Corpo
- CMRecordsResponse
Baixar arquivo eletrônico
Baixar um arquivo eletrônico de um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador Exclusivo
|
uri | True | string |
ID exclusiva ou número de registro |
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
Retornos
- response
- binary
Carregar arquivo eletrônico
Carregar um arquivo eletrônico que pode ser anexado posteriormente a um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Nome do Arquivo
|
RecordFilePath | True | string | |
|
Identificador Exclusivo
|
Uri | True | string |
Criar Local (Outro)
Criar um local de qualquer tipo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Tipo de local
|
LocationTypeOfLocation | string | ||
|
Nome
|
LocationSortName | True | string | |
|
Nome Exclusivo
|
LocationNickName | string | ||
|
Número de ID
|
LocationIdNumber | string | ||
|
Interna
|
LocationIsWithin | boolean | ||
|
Telefone Comercial
|
LocationPhoneNumber | string | ||
|
Celular
|
LocationMobileNumber | string | ||
|
Fac-símile
|
LocationFaxNumber | string | ||
|
Telefone Residencial
|
LocationAfterHoursPhoneNumber | string | ||
|
Mesmo que o endereço
|
LocationUseAddressOf | integer |
ID exclusiva do local |
|
|
Tipo de Endereço
|
LocationAddressAddressType | string |
Selecione o tipo de endereço. Limite de um por tipo. |
|
|
Rua
|
LocationAddressAddressLines | string | ||
|
Subúrbio/Cidade
|
LocationAddressCity | string | ||
|
Estado
|
LocationAddressState | string | ||
|
Cp
|
LocationAddressPostcode | string | ||
|
País
|
LocationAddressCountry | string | ||
|
Tornar Padrão
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
ID exclusiva relacionada
|
AddRelationshipRelatedLocation | integer | ||
|
Tipo
|
AddRelationshipRelationshipType | string | ||
|
Endereço de Email
|
LocationEmailAddress | string | ||
|
De
|
SetActiveDateRangeValidFromDate | string |
dd/mm/yyyyy |
|
|
Para
|
SetActiveDateRangeValidToDate | string |
dd/mm/yyyyy |
|
|
Anotações
|
LocationNotes | string | ||
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string |
Retornos
- Corpo
- CMLocationsResponse
Criar Local (Pessoa)
Criar um local de pessoa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Title
|
LocationHonorific | string | ||
|
Apelido
|
LocationSurname | string | ||
|
Primeiro Nome
|
LocationGivenNames | string | ||
|
Interna
|
LocationIsWithin | boolean | ||
|
Cargo
|
LocationJobDescription | string | ||
|
Data de nascimento
|
LocationDateOfBirth | string | ||
|
Saudação
|
LocationSalutation | string | ||
|
Nome Exclusivo
|
LocationNickName | string | ||
|
Número de ID
|
LocationIdNumber | string | ||
|
Telefone Comercial
|
LocationPhoneNumber | string | ||
|
Celular
|
LocationMobileNumber | string | ||
|
Fac-símile
|
LocationFaxNumber | string | ||
|
Telefone Residencial
|
LocationAfterHoursPhoneNumber | string | ||
|
Mesmo que o endereço
|
LocationUseAddressOf | integer |
ID exclusiva do local |
|
|
Tipo de Endereço
|
LocationAddressAddressType | string |
Selecione o tipo de endereço. Limite de um por tipo. |
|
|
Rua
|
LocationAddressAddressLines | string | ||
|
Subúrbio/Cidade
|
LocationAddressCity | string | ||
|
Estado
|
LocationAddressState | string | ||
|
Cp
|
LocationAddressPostcode | string | ||
|
País
|
LocationAddressCountry | string | ||
|
Tornar Padrão
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
ID exclusiva relacionada
|
AddRelationshipRelatedLocation | integer | ||
|
Tipo
|
AddRelationshipRelationshipType | string | ||
|
Endereço de Email
|
LocationEmailAddress | string | ||
|
Gênero
|
LocationGenderValue | string | ||
|
Aceitando logons
|
LocationCanLogin | boolean | ||
|
Logon de Rede
|
LocationLogsInAs | string | ||
|
Logon de Rede Adicional
|
LocationAdditionalLogin | string | ||
|
O logon expira em
|
LocationLoginExpires | string | ||
|
Perfil do Usuário de
|
LocationUseProfileOf | integer |
ID exclusiva do local |
|
|
Tipo de usuário
|
LocationUserType | string | ||
|
Cadeia de caracteres de segurança
|
LocationSecurityString | string | ||
|
De
|
SetActiveDateRangeValidFromDate | string |
dd/mm/yyyyy |
|
|
Para
|
SetActiveDateRangeValidToDate | string |
dd/mm/yyyyy |
|
|
Anotações
|
LocationNotes | string | ||
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string |
Retornos
- Corpo
- CMLocationsResponse
Criar registro (avançado)
Criar um registro com campos avançados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Tipo de registro
|
RecordRecordType | True | string | |
|
Título (Parte de Texto Livre)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Fornecer o identificador exclusivo da classificação |
|
|
Autor
|
RecordAuthor | string |
ID exclusiva ou endereço de email do Local |
|
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
|
|
Número de acessão
|
RecordAccessionNumber | string | ||
|
Destinatário
|
RecordAddressee | string |
ID exclusiva ou endereço de email do Local |
|
|
Contêiner alternativo
|
RecordAlternativeContainer | string | ||
|
Assignee
|
RecordAssignee | string |
ID exclusiva ou endereço de email do Local |
|
|
Nível de confiança de classificação automática
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Renderizar automaticamente em PDF ao salvar
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Ignorar controles de acesso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Ignorar Salvar?
|
ByPassSave | boolean |
True para não salvar o objeto. Um uso disso é definir uma ou mais propriedades em uma postagem de registro e retornar o formulário de entrada de dados. O formulário de entrada de dados refletirá as várias propriedades definidas no registro original. |
|
|
Alterar posição dentro de favoritos
|
ChangePositionWithinFavorites | string |
Ao pesquisar favoritos, eles serão retornados nesta ordem, a menos que outra classificação seja usada. |
|
|
Alterar posição dentro do rótulo do usuário
|
ChangePositionWithinUserLabel | string |
Ao pesquisar por UserLabel, eles serão retornados nesta ordem, a menos que outra classificação seja usada., |
|
|
Fazer check-in como
|
CheckinAs | string |
Defina a propriedade Source do documento eletrônico. |
|
|
Classe de registro
|
RecordClassOfRecord | string | ||
|
Cliente
|
RecordClient | string |
ID exclusiva ou endereço de email do Local |
|
|
Registro do cliente
|
RecordClientRecord | string | ||
|
Comments
|
comments | string |
Comentários a serem enviados nas Anotações de Registro quando o documento for carregado. |
|
|
Consignação
|
RecordConsignment | string | ||
|
Objeto Consignment
|
RecordConsignmentObject | string | ||
|
Contêiner
|
RecordContainer | string | ||
|
Copiar documento do registro
|
CopyDocumentFromRecord | string |
Especifique uma ID exclusiva para o registro do qual copiar o documento eletrônico para este registro., |
|
|
Criador
|
RecordCreator | string |
ID exclusiva ou endereço de email do Local |
|
|
Data criada
|
RecordDateCreated | string | ||
|
Data de conclusão
|
RecordDateDue | string | ||
|
Data publicada
|
RecordDatePublished | string | ||
|
Data recebida
|
RecordDateReceived | string | ||
|
Editor
|
RecordEditor | string |
ID exclusiva ou endereço de email do Local |
|
|
Referência externa
|
RecordExternalReference | string | ||
|
Falha nos avisos?
|
FailOnWarnings | boolean |
True para não criar/salvar um objeto se houver avisos. |
|
|
Nome do arquivo na pasta Uploads
|
RecordFilePath | string |
O nome do arquivo como ele aparece na pasta Uploads. |
|
|
Finalizar em Salvar
|
RecordFinalizeOnSave | boolean | ||
|
Código de barras estrangeiro
|
RecordForeignBarcode | string | ||
|
Local do GPS
|
RecordGpsLocation | string | ||
|
Local da Página Inicial
|
RecordHomeLocation | string |
ID exclusiva do local |
|
|
Espaço Inicial
|
RecordHomeSpace | string | ||
|
Iniciar Modelo
|
RecordInitiateTemplate | string | ||
|
Está entre assoa
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Manter check-out
|
keepBookedOut | boolean |
True para deixar o registro em check-out depois que o documento eletrônico é carregado. |
|
|
Data da última ação
|
RecordLastActionDate | string | ||
|
Número Longo
|
RecordLongNumber | string | ||
|
Tornar ativo
|
MakeActive | string |
Reverte o estado do registro (e qualquer um de seus conteúdos) para que ele não fique mais inativo. Ao processar conteúdo, você pode especificar se a tarefa deve ser interrompida se ocorrerem falhas. |
|
|
Tornar Inativo
|
MakeInactive | string |
Define a dateInactive para esse registro e qualquer um de seus conteúdos. Ao processar conteúdo, você pode especificar se a tarefa deve ser interrompida se ocorrerem falhas. |
|
|
Fazer Nova Revisão
|
makeNewRevision | boolean |
True para criar uma nova revisão com este documento eletrônico false para substituir a Revisão atual. |
|
|
Data de destruição manual
|
RecordManualDestructionDate | string | ||
|
Registro de matéria
|
RecordMatterRecord | string | ||
|
Tipo de mídia
|
RecordMediaType | string | ||
|
Meus Comentários de Autorização
|
RecordMyAuthorizationComments | string | ||
|
Minha Autorização Concluída
|
RecordMyAuthorizationComplete | boolean | ||
|
Meus Comentários de Revisão
|
RecordMyReviewComments | string | ||
|
Minha revisão concluída
|
RecordMyReviewComplete | boolean | ||
|
Precisa de autorização?
|
RecordNeedsAuthorization | boolean | ||
|
Precisa de revisão?
|
RecordNeedsReview | boolean | ||
|
Regra de criação de nova parte
|
RecordNewPartCreationRule | string |
ID exclusiva da regra de criação de parte automática |
|
|
Anotações
|
RecordNotes | string | ||
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string | ||
|
Outro Contato
|
RecordOtherContact | string |
ID exclusiva ou endereço de email do Local |
|
|
Local do proprietário
|
RecordOwnerLocation | string |
ID exclusiva ou endereço de email do Local |
|
|
Hierarquia do Preserver na entrada de dados?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Registro de Parte Anterior
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Registrar novo tipo
|
RecordNewType | string |
Deixe como padrão, a menos que crie uma versão ou cópia de nova parte. |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string | ||
|
Agendamento de retenção
|
RecordRetentionSchedule | string | ||
|
Data de Revisão
|
RecordReviewDate | string | ||
|
Examinar a data de conclusão
|
RecordReviewDueDate | string | ||
|
Estado de revisão
|
RecordReviewState | string | ||
|
Segurança
|
RecordSecurity | string | ||
|
Registro de Série
|
RecordSeriesRecord | string | ||
|
Conjuntos de propriedades
|
propertySets | string |
Especifique conjuntos de propriedades além daqueles postados a serem retornados pela solicitação. |
|
|
Cadeia de Consulta
|
q | string |
Especifique uma consulta aqui para aplicar a atualização a um conjunto de registros em vez de apenas um (conforme especificado pela ID Exclusiva). |
Retornos
- Corpo
- CMRecordsResponse
Criar registro (documento)
Criar um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Tipo de registro
|
RecordRecordType | True | string | |
|
Título (Parte de Texto Livre)
|
RecordTypedTitle | True | string | |
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
|
|
Autor
|
RecordAuthor | string |
ID exclusiva ou endereço de email do Local |
|
|
Destinatário
|
RecordAddressee | string |
ID exclusiva ou endereço de email do Local |
|
|
Contêiner alternativo
|
RecordAlternativeContainer | string | ||
|
Assignee
|
RecordAssignee | string |
ID exclusiva ou endereço de email do Local |
|
|
Renderizar automaticamente em PDF ao salvar
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Ignorar controles de acesso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Fazer check-in como
|
CheckinAs | string |
Defina a propriedade Source do documento eletrônico. |
|
|
Classification
|
RecordClassification | string |
Fornecer o identificador exclusivo da classificação |
|
|
Cliente
|
RecordClient | string |
ID exclusiva ou endereço de email do Local |
|
|
Registro do cliente
|
RecordClientRecord | string | ||
|
Contêiner
|
RecordContainer | string | ||
|
Copiar documento do registro
|
CopyDocumentFromRecord | string |
Especifique uma ID exclusiva para o registro do qual copiar o documento eletrônico para este registro., |
|
|
Criador
|
RecordCreator | string |
ID exclusiva ou endereço de email do Local |
|
|
Data criada
|
RecordDateCreated | string | ||
|
Data de conclusão
|
RecordDateDue | string | ||
|
Data publicada
|
RecordDatePublished | string | ||
|
Data recebida
|
RecordDateReceived | string | ||
|
Referência externa
|
RecordExternalReference | string | ||
|
Falha nos avisos?
|
FailOnWarnings | boolean |
True para não criar/salvar um objeto se houver avisos. |
|
|
Nome do arquivo na pasta Uploads
|
RecordFilePath | string |
O nome do arquivo como ele aparece na pasta Uploads. |
|
|
Finalizar em Salvar
|
RecordFinalizeOnSave | boolean | ||
|
Código de barras estrangeiro
|
RecordForeignBarcode | string | ||
|
Local do GPS
|
RecordGpsLocation | string | ||
|
Local da Página Inicial
|
RecordHomeLocation | string |
ID exclusiva do local |
|
|
Espaço Inicial
|
RecordHomeSpace | string | ||
|
Está entre assoa
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Manter check-out
|
keepBookedOut | boolean |
True para deixar o registro em check-out depois que o documento eletrônico é carregado. |
|
|
Data da última ação
|
RecordLastActionDate | string | ||
|
Número Longo
|
RecordLongNumber | string | ||
|
Tipo de mídia
|
RecordMediaType | string | ||
|
Anotações
|
RecordNotes | string | ||
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string | ||
|
Outro Contato
|
RecordOtherContact | string |
ID exclusiva ou endereço de email do Local |
|
|
Local do proprietário
|
RecordOwnerLocation | string |
ID exclusiva ou endereço de email do Local |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string |
ID exclusiva ou endereço de email do Local |
|
|
Data de Revisão
|
RecordReviewDate | string | ||
|
Examinar a data de conclusão
|
RecordReviewDueDate | string | ||
|
Estado de revisão
|
RecordReviewState | string | ||
|
Segurança
|
RecordSecurity | string |
Retornos
- Corpo
- CMRecordsResponse
Criar registro (pasta)
Criar um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Tipo de registro
|
RecordRecordType | True | string | |
|
Título (Parte de Texto Livre)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Fornecer o identificador exclusivo da classificação |
|
|
Contêiner
|
RecordContainer | string | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
|
|
Autor
|
RecordAuthor | string |
ID exclusiva ou endereço de email do Local |
|
|
Destinatário
|
RecordAddressee | string |
ID exclusiva ou endereço de email do Local |
|
|
Contêiner alternativo
|
RecordAlternativeContainer | string | ||
|
Assignee
|
RecordAssignee | string |
ID exclusiva ou endereço de email do Local |
|
|
Ignorar controles de acesso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Cliente
|
RecordClient | string |
ID exclusiva ou endereço de email do Local |
|
|
Criador
|
RecordCreator | string |
ID exclusiva ou endereço de email do Local |
|
|
Data criada
|
RecordDateCreated | string | ||
|
Data de conclusão
|
RecordDateDue | string | ||
|
Data publicada
|
RecordDatePublished | string | ||
|
Referência externa
|
RecordExternalReference | string | ||
|
Falha nos avisos?
|
FailOnWarnings | boolean |
True para não criar/salvar um objeto se houver avisos. |
|
|
Nome do arquivo na pasta Uploads
|
RecordFilePath | string |
O nome do arquivo como ele aparece na pasta Uploads. |
|
|
Código de barras estrangeiro
|
RecordForeignBarcode | string | ||
|
Local do GPS
|
RecordGpsLocation | string | ||
|
Local da Página Inicial
|
RecordHomeLocation | string |
ID exclusiva do local |
|
|
Espaço Inicial
|
RecordHomeSpace | string | ||
|
Está entre assoa
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Data da última ação
|
RecordLastActionDate | string | ||
|
Número Longo
|
RecordLongNumber | string | ||
|
Anotações
|
RecordNotes | string | ||
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string | ||
|
Outro Contato
|
RecordOtherContact | string |
ID exclusiva ou endereço de email do Local |
|
|
Local do proprietário
|
RecordOwnerLocation | string |
ID exclusiva ou endereço de email do Local |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string |
ID exclusiva ou endereço de email do Local |
|
|
Data de Revisão
|
RecordReviewDate | string | ||
|
Examinar a data de conclusão
|
RecordReviewDueDate | string | ||
|
Estado de revisão
|
RecordReviewState | string | ||
|
Segurança
|
RecordSecurity | string |
Retornos
- Corpo
- CMRecordsResponse
Excluir Registro
Excluir um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer |
A ID exclusiva do registro a ser excluído |
|
Excluir Conteúdo?
|
DeleteContents | True | boolean | |
|
Nova Página Inicial para Conteúdo
|
NewHomeForContents | string |
A ID exclusiva ou o endereço de email da nova Localização Inicial para o conteúdo |
Retornos
- Corpo
- CMRecordsResponse
Ler dados de evento
Transformar dados de evento do Kapish Dispatch para consumo de fluxo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Content
|
Content | string |
O conteúdo da ação do Barramento de Serviço que recuperou os dados de evento do CM |
Retornos
- Corpo
- CMEventData
Local da atualização (campos adicionais)
Atualizar campos adicionais em um local
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | integer | ||
|
Nome
|
SearchClause | string | ||
|
Value
|
Value | string |
Retornos
- Corpo
- CMLocationsResponse
Local da atualização (endereço)
Criar/atualizar o endereço de um local usando a ID exclusiva do endereço
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer |
O uri do local existente a ser atualizado |
|
Identificação Única
|
Uri | integer |
O uri do endereço de endereçamento ou rua existente a ser atualizado |
|
|
Tipo
|
LocationAddressAddressType | string |
Selecione o tipo de endereço. Limite de um por tipo. |
|
|
Rua
|
LocationAddressAddressLines | string | ||
|
Subúrbio/Cidade
|
LocationAddressCity | string | ||
|
Estado
|
LocationAddressState | string | ||
|
Cp
|
LocationAddressPostcode | string | ||
|
País
|
LocationAddressCountry | string |
Retornos
- Corpo
- CMLocationsResponse
Local da Atualização (Pessoa)
Atualizar um local de pessoa usando seu identificador exclusivo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | integer | ||
|
Cadeia de Consulta
|
q | string |
Especifique uma consulta aqui para aplicar a atualização a um conjunto de Locais em vez de apenas uma (conforme especificado pela ID Exclusiva). |
|
|
Title
|
LocationHonorific | string | ||
|
Apelido
|
LocationSurname | string | ||
|
Primeiro Nome
|
LocationGivenNames | string | ||
|
Interna
|
LocationIsWithin | boolean | ||
|
Cargo
|
LocationJobDescription | string | ||
|
Data de nascimento
|
LocationDateOfBirth | string | ||
|
Saudação
|
LocationSalutation | string | ||
|
Nome Exclusivo
|
LocationNickName | string | ||
|
Número de ID
|
LocationIdNumber | string | ||
|
Telefone Comercial
|
LocationPhoneNumber | string | ||
|
Celular
|
LocationMobileNumber | string | ||
|
Fac-símile
|
LocationFaxNumber | string | ||
|
Telefone Residencial
|
LocationAfterHoursPhoneNumber | string | ||
|
Mesmo que o endereço
|
LocationUseAddressOf | integer |
ID exclusiva do local |
|
|
Tornar Padrão
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
ID exclusiva relacionada
|
AddRelationshipRelatedLocation | integer | ||
|
Tipo
|
AddRelationshipRelationshipType | string | ||
|
Endereço de Email
|
LocationEmailAddress | string | ||
|
Gênero
|
LocationGenderValue | string | ||
|
Aceitando logons
|
LocationCanLogin | boolean | ||
|
Logon de Rede
|
LocationLogsInAs | string | ||
|
Logon de Rede Adicional
|
LocationAdditionalLogin | string | ||
|
O logon expira em
|
LocationLoginExpires | string | ||
|
Perfil do Usuário de
|
LocationUseProfileOf | integer |
ID exclusiva do local |
|
|
Tipo de usuário
|
LocationUserType | string | ||
|
Cadeia de caracteres de segurança
|
LocationSecurityString | string | ||
|
De
|
SetActiveDateRangeValidFromDate | string |
dd/mm/yyyyy |
|
|
Para
|
SetActiveDateRangeValidToDate | string |
dd/mm/yyyyy |
|
|
Anotações
|
LocationNotes | string | ||
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string | ||
|
ID exclusiva relacionada
|
RemoveRelationshipRelatedLocation | integer |
Retornos
- Corpo
- CMLocationsResponse
Local de atualização (outro)
Atualizar um local
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | integer | ||
|
Cadeia de Consulta
|
q | string |
Especifique uma consulta aqui para aplicar a atualização a um conjunto de Locais em vez de apenas uma (conforme especificado pela ID Exclusiva). |
|
|
Nome
|
LocationSortName | string | ||
|
Nome Exclusivo
|
LocationNickName | string | ||
|
Número de ID
|
LocationIdNumber | string | ||
|
Telefone Comercial
|
LocationPhoneNumber | string | ||
|
Celular
|
LocationMobileNumber | string | ||
|
Fac-símile
|
LocationFaxNumber | string | ||
|
Telefone Residencial
|
LocationAfterHoursPhoneNumber | string | ||
|
Mesmo que o endereço
|
LocationUseAddressOf | integer |
ID exclusiva do local |
|
|
Tornar Padrão
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
ID exclusiva relacionada
|
AddRelationshipRelatedLocation | integer | ||
|
Tipo
|
AddRelationshipRelationshipType | string | ||
|
Endereço de Email
|
LocationEmailAddress | string | ||
|
De
|
SetActiveDateRangeValidFromDate | string |
dd/mm/yyyyy |
|
|
Para
|
SetActiveDateRangeValidToDate | string |
dd/mm/yyyyy |
|
|
Anotações
|
LocationNotes | string | ||
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string | ||
|
ID exclusiva relacionada
|
RemoveRelationshipRelatedLocation | integer |
Retornos
- Corpo
- CMLocationsResponse
Localizar iD exclusiva do endereço de localização
Obter a ID exclusiva do endereço filho de um local
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo
|
type | string |
Selecionar tipo de endereço |
|
|
Identificador Exclusivo
|
LocationUri | True | string |
ID exclusiva do local |
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
Retornos
- Endereço filho
- CMLocationAddressUri
Localizar Locais
Pesquisar locais (buscar uma coleção de locais usando uma cadeia de caracteres de pesquisa)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Query
|
q | True | string |
Insira uma consulta de pesquisa, por exemplo, "todos" para obter todos os objetos. |
|
Aplicar Padrões
|
ApplyDefaults | boolean |
True para aplicar o filtro padrão do usuário e classificar a esta pesquisa |
|
|
Contagem de resultados
|
CountResults | boolean |
True para incluir uma contagem dos resultados |
|
|
Excluir Contagem
|
ExcludeCount | boolean |
True para excluir uma contagem dos resultados |
|
|
Filter
|
filter | string |
Uma lista separada por espaço de cláusulas de pesquisa a serem aplicadas como um filtro. |
|
|
Da Pesquisa
|
fromSearch | string |
A ID exclusiva de uma pesquisa salva da qual construir essa pesquisa |
|
|
Propriedades descendentes
|
descendantProperties | string |
Uma lista separada por vírgulas de propriedades de objeto aplica-se somente às propriedades de objeto desta e de nível inferior, por exemplo, RecordNumber, RecordTitle |
|
|
Incluir definições de propriedade
|
IncludePropertyDefs | boolean |
True para retornar uma matriz das definições de propriedade usadas pelas propriedades nesta resposta |
|
|
Opções
|
Options | string |
Defina uma ou mais das opções normalmente definidas apenas nas Opções de Usuário para essa pesquisa. Usar ids do /PropertyDef? Serviço Get=SearchOptions, acrescente um sinal de subtração para definir como false, caso contrário, true será assumido. |
|
|
Propriedades
|
properties | string |
Uma lista separada por vírgulas de propriedades do objeto, por exemplo, RecordNumber, RecordTitle |
|
|
Conjuntos de propriedades
|
propertySets | string |
Um ou mais conjuntos de propriedades predefinidos, selecione entre DataGridVisible, Detailed, FromSearch, All ou uma propriedade personalizada definida como definido na configuração do serviço |
|
|
Valor da propriedade
|
PropertyValue | string |
Incluir o valor bruto, o valor da cadeia de caracteres ou ambos nos resultados |
|
|
Tamanho da Página
|
pageSize | string |
O número de itens a serem retornados em cada página de resultados |
|
|
Propósito
|
purpose | string |
Uma propriedade especial para filtrar os resultados da pesquisa com base nos valores de enumeração de finalidade do objeto |
|
|
Finalidade Extra
|
purposeExtra | string |
Necessário como um suplemento para algumas finalidades. O serviço ObjectDef fornece informações sobre o tipo enum ou TrimMainObject para especificar, em particular ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes e HaveExtraPurposeParameter. |
|
|
Classificar Por
|
sortBy | string |
Uma lista separada por vírgulas de IDs de cláusula de pesquisa |
|
|
Start
|
start | string |
A posição no conjunto de resultados para iniciar, vazia (ou 1) para iniciar no início, 2 para iniciar no segundo objeto, 3 no terceiro, etc. |
|
|
Tipo de exibição de cadeia de caracteres
|
stringDisplayType | string |
Se retornar o valor da cadeia de caracteres que o formato usar |
Retornos
- Corpo
- CMLocationsResponse
Localizar Local por ID
Buscar um único local por ID exclusiva ou nome
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Id | True | string |
A ID exclusiva ou o nome do objeto |
|
Propriedades descendentes
|
descendantProperties | string |
Uma lista separada por vírgulas de propriedades de objeto aplica-se somente às propriedades de objeto desta e de nível inferior, por exemplo, Sobrenome, GivenNames |
|
|
Incluir definições de propriedade
|
IncludePropertyDefs | boolean |
True para retornar uma matriz das definições de propriedade usadas pelas propriedades nesta resposta |
|
|
Propriedades
|
properties | string |
Uma lista separada por vírgulas de propriedades do objeto, por exemplo, Sobrenome, GivenNames |
|
|
Conjuntos de propriedades
|
propertySets | string |
Um ou mais conjuntos de propriedades predefinidos, selecione entre DataGridVisible, Detailed, FromSearch, All ou uma propriedade personalizada definida como definido na configuração do serviço |
|
|
Valor da propriedade
|
PropertyValue | string |
Incluir o valor bruto, o valor da cadeia de caracteres ou ambos nos resultados |
|
|
Tipo de exibição de cadeia de caracteres
|
stringDisplayType | string |
Retorna o valor da cadeia de caracteres que o formato usar |
Retornos
- Corpo
- CMLocationsResponse
Localizar objetos CM
Pesquisar objetos CM
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Procurar
|
TrimType | True | string | |
|
Cadeia de Consulta
|
q | True | string |
Insira uma consulta de pesquisa, por exemplo, "todos" para obter todos os objetos. |
|
Aplicar Padrões
|
ApplyDefaults | boolean |
True para aplicar o filtro padrão do usuário e classificar a essa pesquisa. |
|
|
Contagem de resultados
|
CountResults | boolean |
CountResults retorna a contagem mais confiável e mais lenta do total de resultados da pesquisa. A contagem resultante está na propriedade Contagem de respostas. |
|
|
Propriedades descendentes
|
DescendantProperties | string |
Uma lista separada por vírgulas de propriedades de objeto aplica-se somente às propriedades de objeto desta e de nível inferior, por exemplo, RecordNumber, RecordTitle. |
|
|
Excluir Contagem
|
ExcludeCount | boolean |
O retorno de TotalResults e SearchTitle pode prejudicar o desempenho. Defina como true se TotalResults e SearchTitle não forem necessários. |
|
|
Filter
|
Filter | string |
Uma lista separada por espaço de cláusulas de pesquisa a serem aplicadas como um filtro. |
|
|
Da Pesquisa
|
FromSearch | integer |
A ID exclusiva de uma pesquisa salva da qual construir essa pesquisa. |
|
|
Incluir defs de propriedade
|
IncludePropertyDefs | boolean |
True para retornar uma matriz das Definições de Propriedade usadas pelas propriedades nesta resposta. |
|
|
Opções
|
Options | string |
Defina uma ou mais das opções normalmente definidas apenas nas Opções de Usuário para essa pesquisa. Usar ids do /PropertyDef? Serviço Get=SearchOptions, acrescente um sinal de subtração para definir como false, caso contrário, true será assumido. |
|
|
Tamanho da Página
|
pageSize | integer |
O número de itens a serem retornados em cada página de resultados. Se estiver vazio, o padrão será o valor padrão definido na configuração. |
|
|
Valor da propriedade
|
PropertyValue | string |
Inclua o valor bruto, o valor da cadeia de caracteres ou ambos nos resultados. |
|
|
Conjuntos de propriedades
|
PropertySets | string |
Um ou mais conjuntos de propriedades predefinidos, selecione entre DataGridVisible, Detailed, FromSearch, All ou uma propriedade personalizada definida como definido na configuração do serviço. |
|
|
Propósito
|
purpose | integer |
Uma propriedade especial para filtrar os resultados da pesquisa com base nos valores de enumeração de finalidade do objeto. |
|
|
Finalidade Extra
|
purposeExtra | integer |
Necessário como um suplemento para algumas finalidades. O serviço ObjectDef fornece informações sobre o tipo enum ou TrimMainObject para especificar, em particular ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes e HaveExtraPurposeParameter. |
|
|
Classificar Por
|
sortBy | string |
Uma lista separada por vírgulas de IDs de cláusula de pesquisa. Use – para especificar decrescente. Por exemplo, |
|
|
Start
|
start | integer |
A posição no conjunto de resultados a ser iniciada, vazia (ou 1) para iniciar no início, 2 para iniciar no segundo objeto, 3 no terceiro, etc. |
|
|
StringDisplayType
|
StringDisplayType | string |
Se retornar o valor da cadeia de caracteres que o formato usar. |
|
|
Propriedades
|
properties | string |
Uma lista separada por vírgulas de propriedades do objeto, por exemplo, Uri, NameString |
Retornos
- Corpo
- CMBobResponse
Localizar registro por ID
Buscar um único registro por ID exclusiva ou nome
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
ID
|
Id | True | string |
A ID exclusiva ou o nome do objeto |
|
Incluir definições de propriedade
|
IncludePropertyDefs | boolean |
True para retornar uma matriz das definições de propriedade usadas pelas propriedades nesta resposta |
|
|
Propriedades descendentes
|
descendantProperties | string |
Uma lista separada por vírgulas de propriedades de objeto aplica-se somente às propriedades de objeto desta e de nível inferior, por exemplo, RecordNumber, RecordTitle. |
|
|
Propriedades
|
properties | string |
Uma lista separada por vírgulas de propriedades de objeto, por exemplo, RecordNumber, RecordTitle. |
|
|
Conjuntos de propriedades
|
propertySets | string |
Um ou mais conjuntos de propriedades predefinidos, selecione entre DataGridVisible, Detailed, FromSearch, All ou uma propriedade personalizada definida como definido na configuração do serviço. |
|
|
Valor da propriedade
|
PropertyValue | string |
Incluir o valor bruto, o valor da cadeia de caracteres ou ambos nos resultados |
|
|
Tipo de exibição de cadeia de caracteres
|
stringDisplayType | string |
Se retornar o valor da cadeia de caracteres que o formato usar |
Retornos
- Corpo
- CMRecordsResponse
Localizar registros
Pesquisar registros (buscar uma coleção de registros usando uma cadeia de caracteres de pesquisa)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Query
|
q | True | string |
Consulta de pesquisa |
|
Propriedades
|
properties | True | string |
Uma lista separada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Localizar registros (avançado)
Pesquisar registros (buscar uma coleção de registros usando uma cadeia de caracteres de pesquisa). Retorna uma resposta de ServiceAPI bruta do Gerenciador de Conteúdo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Query
|
q | True | string |
Consulta de pesquisa |
|
Propriedades
|
properties | True | string |
Uma lista separada por vírgulas de propriedades a serem retornadas |
Retornos
- response
- object
Obter arquivo da URL
Baixar um arquivo da URL para uma área de preparo usando o plug-in da API de Serviço cm 'GetFileFromUrl'
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL do Arquivo
|
url | True | string |
URL não codificada do arquivo a ser baixado |
|
Nome do arquivo para salvar como
|
filename | string |
Nome do arquivo para salvar a URL baixada como (apenas o nome do arquivo com sufixo, não inclua o diretório completo) |
|
|
Tipo de conteúdo
|
contentType | string |
Cadeia de caracteres típica encontrada na maioria dos cabeçalhos Tipo de Conteúdo (por exemplo, imagem/png, texto/simples, aplicativo/pdf). |
Retornos
Resposta do plug-in da API de Serviço cm 'GetFileFromUrl'.
Registro de atualização (anexar arquivo eletrônico)
Anexar um arquivo eletrônico a um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
File
|
File | True | file |
O conteúdo/corpo do arquivo eletrônico a ser anexado |
|
Identificador Exclusivo
|
Uri | True | string |
ID exclusiva do registro |
Retornos
- Corpo
- CMRecordsResponse
Registro de atualização (anexar termo dicionário de sinônimos)
Anexar um termo dicionário de sinônimos a um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Registro
|
Uri | True | integer |
A ID exclusiva do registro para anexar o Termo do Dicionário de Sinônimos a |
|
Termo de dicionário de sinônimos
|
Keyword | True | string |
A ID exclusiva ou o nome do termo dicionário de sinônimos a ser anexado |
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Registro de Atualização (Avançado)
Atualizar um registro com propriedades avançadas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Tipo de registro
|
RecordRecordType | string | ||
|
Classification
|
RecordClassification | string |
Fornecer o identificador exclusivo da classificação |
|
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
|
|
Autor
|
RecordAuthor | string |
ID exclusiva ou endereço de email do Local |
|
|
Número de acessão
|
RecordAccessionNumber | string | ||
|
Destinatário
|
RecordAddressee | string |
ID exclusiva ou endereço de email do Local |
|
|
Contêiner alternativo
|
RecordAlternativeContainer | string | ||
|
Assignee
|
RecordAssignee | string |
ID exclusiva ou endereço de email do Local |
|
|
Nível de confiança de classificação automática
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Renderizar automaticamente em PDF ao salvar
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Ignorar controles de acesso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Ignorar Salvar?
|
ByPassSave | boolean |
True para não salvar o objeto. Um uso disso é definir uma ou mais propriedades em uma postagem de registro e retornar o formulário de entrada de dados. O formulário de entrada de dados refletirá as várias propriedades definidas no registro original. |
|
|
Alterar posição dentro de favoritos
|
ChangePositionWithinFavorites | string |
Ao pesquisar favoritos, eles serão retornados nesta ordem, a menos que outra classificação seja usada. |
|
|
Alterar posição dentro do rótulo do usuário
|
ChangePositionWithinUserLabel | string |
Ao pesquisar por UserLabel, eles serão retornados nesta ordem, a menos que outra classificação seja usada., |
|
|
Fazer check-in como
|
CheckinAs | string |
Defina a propriedade Source do documento eletrônico. |
|
|
Classe de registro
|
RecordClassOfRecord | string | ||
|
Cliente
|
RecordClient | string |
ID exclusiva ou endereço de email do Local |
|
|
Registro do cliente
|
RecordClientRecord | string | ||
|
Comments
|
comments | string |
Comentários a serem enviados nas Anotações de Registro quando o documento for carregado. |
|
|
Consignação
|
RecordConsignment | string | ||
|
Objeto Consignment
|
RecordConsignmentObject | string | ||
|
Contêiner
|
RecordContainer | string | ||
|
Copiar documento do registro
|
CopyDocumentFromRecord | string |
Especifique uma ID exclusiva para o registro do qual copiar o documento eletrônico para este registro., |
|
|
Criador
|
RecordCreator | string |
ID exclusiva ou endereço de email do Local |
|
|
Data criada
|
RecordDateCreated | string | ||
|
Data de conclusão
|
RecordDateDue | string | ||
|
Data publicada
|
RecordDatePublished | string | ||
|
Data recebida
|
RecordDateReceived | string | ||
|
Editor
|
RecordEditor | string |
ID exclusiva ou endereço de email do Local |
|
|
Repositório de Documentos Eletrônicos
|
RecordEStore | string | ||
|
Referência externa
|
RecordExternalReference | string | ||
|
Falha nos avisos?
|
FailOnWarnings | boolean |
True para não criar/salvar um objeto se houver avisos. |
|
|
Nome do arquivo na pasta Uploads
|
RecordFilePath | string |
O nome do arquivo como ele aparece na pasta Uploads. |
|
|
Finalizar em Salvar
|
RecordFinalizeOnSave | boolean | ||
|
Código de barras estrangeiro
|
RecordForeignBarcode | string | ||
|
Local do GPS
|
RecordGpsLocation | string | ||
|
Local da Página Inicial
|
RecordHomeLocation | string |
ID exclusiva do local |
|
|
Espaço Inicial
|
RecordHomeSpace | string | ||
|
Está entre assoa
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Manter check-out
|
keepBookedOut | boolean |
True para deixar o registro em check-out depois que o documento eletrônico é carregado. |
|
|
Data da última ação
|
RecordLastActionDate | string | ||
|
Número Longo
|
RecordLongNumber | string | ||
|
Tornar ativo
|
MakeActive | string |
Reverte o estado do registro (e qualquer um de seus conteúdos) para que ele não fique mais inativo. Ao processar conteúdo, você pode especificar se a tarefa deve ser interrompida se ocorrerem falhas. |
|
|
Tornar Inativo
|
MakeInactive | string |
Define a dateInactive para esse registro e qualquer um de seus conteúdos. Ao processar conteúdo, você pode especificar se a tarefa deve ser interrompida se ocorrerem falhas. |
|
|
Fazer Nova Revisão
|
makeNewRevision | boolean |
True para criar uma nova revisão com este documento eletrônico false para substituir a Revisão atual. |
|
|
Data de destruição manual
|
RecordManualDestructionDate | string | ||
|
Registro de matéria
|
RecordMatterRecord | string | ||
|
Tipo de mídia
|
RecordMediaType | string | ||
|
Meus Comentários de Autorização
|
RecordMyAuthorizationComments | string | ||
|
Minha Autorização Concluída
|
RecordMyAuthorizationComplete | boolean | ||
|
Meus Comentários de Revisão
|
RecordMyReviewComments | string | ||
|
Minha revisão concluída
|
RecordMyReviewComplete | boolean | ||
|
Precisa de autorização?
|
RecordNeedsAuthorization | boolean | ||
|
Precisa de revisão?
|
RecordNeedsReview | boolean | ||
|
Regra de criação de nova parte
|
RecordNewPartCreationRule | string |
ID exclusiva da regra de criação de parte automática |
|
|
Anotações
|
RecordNotes | string | ||
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string | ||
|
Outro Contato
|
RecordOtherContact | string |
ID exclusiva ou endereço de email do Local |
|
|
Local do proprietário
|
RecordOwnerLocation | string |
ID exclusiva ou endereço de email do Local |
|
|
Hierarquia do Preserver na entrada de dados?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Registro de Parte Anterior
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Registrar novo tipo
|
RecordNewType | string |
Deixe como padrão, a menos que crie uma versão ou cópia de nova parte. |
|
|
Registro relacionado
|
RecordRelatedRecord | string | ||
|
Representante
|
RecordRepresentative | string | ||
|
Agendamento de retenção
|
RecordRetentionSchedule | string | ||
|
Data de Revisão
|
RecordReviewDate | string | ||
|
Examinar a data de conclusão
|
RecordReviewDueDate | string | ||
|
Estado de revisão
|
RecordReviewState | string | ||
|
Segurança
|
RecordSecurity | string | ||
|
Registro de Série
|
RecordSeriesRecord | string | ||
|
Título (Parte de Texto Livre)
|
RecordTypedTitle | string | ||
|
Cadeia de Consulta
|
q | string |
Especifique uma consulta aqui para aplicar a atualização a um conjunto de registros em vez de apenas um (conforme especificado pela ID Exclusiva). |
Retornos
- Corpo
- CMRecordsResponse
Registro de atualização (campos adicionais)
Atualizar campos adicionais em um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | integer | ||
|
Nome
|
SearchClause | string | ||
|
Value
|
Value | string | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Registro de atualização (classificação)
Atualizar a classificação de um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Classification
|
RecordClassification | True | string |
Fornecer o identificador exclusivo da classificação |
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Registro de atualização (definir acesso irrestrito ou baseado em contêiner)
InheritAccessControl
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Identificação Única
|
Uri | integer |
Identificador Exclusivo de Localização |
Retornos
- Corpo
- CMRecordsResponse
Registro de atualização (não especificado)
Reverte o estado do registro (e qualquer um de seus conteúdos) para que ele não seja mais descartado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Continuar com o erro?
|
ContinueOnError | boolean | ||
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Registro de atualização (reatribuir ação)
Reatribui a ação nomeada para um local especificado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Novo Atribuídor
|
NewAssignee | True | string |
ID exclusiva ou endereço de email do novo Atribuídor |
|
Ação para Reatribuir
|
RecordActionUri | True | integer | |
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Registro de atualização (remover local dos controles de acesso)
RemoveAccessControl
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Identificação Única
|
Uri | integer |
Identificador Exclusivo de Localização |
Retornos
- Corpo
- CMRecordsResponse
Registro de atualização (representação de solicitação)
Permite que você crie uma solicitação para que o mecanismo de renderização automática faça uma representação de um registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer | |
|
Tipo de representação
|
RenditionType | True | string | |
|
Propriedades
|
Properties | string |
Uma lista delimitada por vírgulas de propriedades a serem retornadas |
Retornos
- Corpo
- CMRecordsResponse
Registro de atualização (unfinalise - Set As Draft)
Atualizar um registro finalizado para rascunho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para representar
|
userToImpersonate | string |
O logon de rede ou logon alternativo do local no CM a ser representado |
|
|
Identificador Exclusivo
|
Uri | True | integer |
Retornos
- Corpo
- CMRecordsResponse
Definições
CMRecord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Caminho do Arquivo
|
RecordFilePath | string |
O nome do arquivo como ele aparece na pasta Uploads |
|
Número de acessão
|
RecordAccessionNumber | integer | |
|
Destinatário
|
RecordAddressee | integer | |
|
Contêiner alternativo
|
RecordAlternativeContainer | integer | |
|
Assignee
|
RecordAssignee | integer | |
|
Autor
|
RecordAuthor | integer | |
|
Método de autorização
|
RecordAuthorizationMethod | string | |
|
Nível de confiança de classificação automática
|
RecordAutoClassificationConfidenceLevel | integer | |
|
Renderizar automaticamente em PDF ao salvar
|
RecordAutoRenderToPDFOnSave | boolean | |
|
Título de Impressão Azul
|
RecordBlueprintTitle | string | |
|
Ignorar controles de acesso de tipo de registro
|
RecordBypassRecordTypeAccessControls | boolean | |
|
Check-in por
|
RecordCheckedInBy | integer | |
|
Check-out para
|
RecordCheckedOutTo | integer | |
|
Classification
|
RecordClassification | integer | |
|
Classe de registro
|
RecordClassOfRecord | string | |
|
Cliente
|
RecordClient | integer | |
|
Registro do cliente
|
RecordClientRecord | integer | |
|
Consignação
|
RecordConsignment | string | |
|
Objeto Consignment
|
RecordConsignmentObject | string | |
|
Contêiner
|
RecordContainer | integer | |
|
Criador
|
RecordCreator | integer | |
|
Versão atual
|
RecordCurrentVersion | string | |
|
Data Fechada
|
RecordDateClosed | date-time | |
|
Data criada
|
RecordDateCreated | date-time | |
|
Data de conclusão
|
RecordDateDue | date-time | |
|
Data finalizada
|
RecordDateFinalized | date-time | |
|
Data importada
|
RecordDateImported | date-time | |
|
Data Inativa
|
RecordDateInactive | date-time | |
|
Data modificada
|
RecordDateModified | date-time | |
|
Data publicada
|
RecordDatePublished | date-time | |
|
Data recebida
|
RecordDateReceived | date-time | |
|
Data registrada
|
RecordDateRegistered | date-time | |
|
Anexação de documento pendente
|
RecordDocumentAttachPending | boolean | |
|
Tamanho do documento
|
RecordDocumentSize | integer | |
|
Tipo de documento
|
RecordDocumentType | string | |
|
Editor
|
RecordEditor | integer | |
|
Repositório de Documentos Eletrônicos
|
RecordEStore | integer | |
|
Extensão do documento
|
RecordExtension | string | |
|
Referência externa
|
RecordExternalReference | string | |
|
Finalizar em Salvar
|
RecordFinalizeOnSave | boolean | |
|
Origem da pasta
|
RecordFolderOrigin | integer | |
|
Código de barras estrangeiro
|
RecordForeignBarcode | string | |
|
Título Gerado
|
RecordGeneratedTitle | string | |
|
Local do GPS
|
RecordGpsLocation | string | |
|
Local da Página Inicial
|
RecordHomeLocation | integer | |
|
Espaço Inicial
|
RecordHomeSpace | integer | |
|
Iniciar Modelo
|
RecordInitiateTemplate | string |
ID exclusiva do modelo de fluxo de trabalho |
|
Está entre assoa
|
RecordIsEnclosed | boolean | |
|
Jurisdiction
|
RecordJurisdictions | string | |
|
Data da última ação
|
RecordLastActionDate | date-time | |
|
Registro da Última Parte
|
RecordLastPartRecord | integer | |
|
Última versão
|
RecordLatestVersion | integer | |
|
Número expandido
|
RecordLongNumber | string | |
|
Número do Registro
|
RecordNumber | string | |
|
Data de destruição manual
|
RecordManualDestructionDate | date-time | |
|
Registro de matéria
|
RecordMatterRecord | integer | |
|
Tipo de mídia
|
RecordMediaType | string | |
|
Reunião
|
RecordMeeting | integer | |
|
Tipo mime
|
RecordMimeType | string | |
|
Meus Comentários de Autorização
|
RecordMyAuthorizationComments | string | |
|
Minha Autorização Concluída
|
RecordMyAuthorizationComplete | boolean | |
|
Meus Comentários de Revisão
|
RecordMyReviewComments | string | |
|
Minha revisão concluída
|
RecordMyReviewComplete | boolean | |
|
Páginas numéricas?
|
RecordNbrPages | integer | |
|
Precisa de autorização?
|
RecordNeedsAuthorization | boolean | |
|
Precisa de revisão?
|
RecordNeedsReview | boolean | |
|
Regra de criação de nova parte
|
RecordNewPartCreationRule | string |
ID exclusiva da regra de criação de parte automática |
|
Registro da Próxima Parte
|
RecordNextPartRecord | integer | |
|
Tipo de Atualização de Anotações
|
NotesUpdateType | string | |
|
Anotações
|
RecordNotes | string | |
|
Originário de
|
RecordOriginatedFrom | string | |
|
Originado da execução
|
RecordOriginatedFromRun | string | |
|
Outro Contato
|
RecordOtherContact | integer | |
|
Local do proprietário
|
RecordOwnerLocation | integer | |
|
Hierarquia do Preserver na entrada de dados?
|
RecordPreserveHierarchyOnDataEntry | boolean | |
|
Registro de Parte Anterior
|
RecordPrevPartRecord | integer | |
|
Contato Principal
|
RecordPrimaryContact | integer | |
|
Priority
|
RecordPriority | string | |
|
Tipo de registro
|
RecordRecordType | integer | |
|
Registro relacionado
|
RecordRelatedRecord | integer | |
|
Representante
|
RecordRepresentative | integer | |
|
Agendamento de retenção
|
RecordRetentionSchedule | integer | |
|
Data de Revisão
|
RecordReviewDate | date-time | |
|
Examinar a data de conclusão
|
RecordReviewDueDate | date-time | |
|
Estado de revisão
|
RecordReviewState | string | |
|
Registro de Parte Raiz
|
RecordRootPartRecord | integer | |
|
Segurança
|
RecordSecurity | string | |
|
Registro de Série
|
RecordSeriesRecord | integer | |
|
Title
|
RecordTitle | string | |
|
Título (Parte de Texto Livre)
|
RecordTypedTitle | string | |
|
Identificador Exclusivo
|
Uri | integer | |
|
Campos adicionais
|
Fields | object |
CMEventData
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Identificador Exclusivo do Evento
|
OnlineEventUri | integer | |
|
ID do tipo de evento
|
EventType | integer | |
|
Tipo de evento
|
EventTypeString | string | |
|
Data do Evento
|
EventDate | date-time | |
|
ID do tipo de objeto
|
ObjectType | integer | |
|
Tipo de objeto
|
ObjectTypeString | string | |
|
ID exclusiva do objeto
|
ObjectUri | integer | |
|
ID do tipo de objeto relacionado
|
RelatedObjectType | integer | |
|
Tipo de objeto relacionado
|
RelatedObjectTypeString | string | |
|
ID exclusiva do objeto relacionado
|
RelatedObjectUri | integer | |
|
Do Computador
|
FromMachine | string | |
|
Endereço IP de conexão
|
ConnectionIPAddress | string | |
|
Endereço IP do Cliente
|
ClientIPAddress | string | |
|
Do fuso horário
|
FromTimeZone | integer | |
|
Nome do logon
|
LoginName | string | |
|
ID exclusiva de logon
|
LoginUri | integer | |
|
Detalhes extras
|
ExtraDetails | string |
CMLogMessage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Mensagem de log
|
LogMessage | string | |
|
Procurar
|
TrimType | CMTrimType | |
|
Identificador Exclusivo
|
Uri | integer |
CMRecordsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
Results | array of CMRecord | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Total de resultados
|
TotalResults | integer | |
|
Contar Cadeia de Caracteres Ex
|
CountStringEx | string | |
|
Contagem mínima
|
MinimumCount | integer | |
|
Contagem
|
Count | integer | |
|
Tem mais itens
|
HasMoreItems | boolean | |
|
Título da Pesquisa
|
SearchTitle | string | |
|
Cadeia de caracteres de realce de clique
|
HitHighlightString | string | |
|
Procurar
|
TrimType | CMTrimType | |
|
Status da resposta
|
ResponseStatus | CMResponseStatus |
Status da resposta |
CMLogResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
Results | array of CMLogMessage | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Total de resultados
|
TotalResults | integer | |
|
Contar Cadeia de Caracteres Ex
|
CountStringEx | string | |
|
Contagem mínima
|
MinimumCount | integer | |
|
Contagem
|
Count | integer | |
|
Tem mais itens
|
HasMoreItems | boolean | |
|
Título da Pesquisa
|
SearchTitle | string | |
|
Cadeia de caracteres de realce de clique
|
HitHighlightString | string | |
|
Procurar
|
TrimType | CMTrimType | |
|
Status da resposta
|
ResponseStatus | CMResponseStatus |
Status da resposta |
CMUpdateErrorResponse
Atualizar resposta de erro
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de erro
|
ErrorCode | string | |
|
Identificador Exclusivo
|
Uri | integer | |
|
Message
|
Message | string | |
|
Nome
|
Name | string | |
|
Nome (Extra)
|
NameExtra | string |
CMResponseStatus
Status da resposta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de erro
|
ErrorCode | string | |
|
Message
|
Message | string | |
|
StackTrace
|
StackTrace | string | |
|
Errors
|
Errors | array of CMResponseError | |
|
Meta
|
Meta | object |
Cadeia de caracteres de dicionário<, cadeia de caracteres> |
CMResponseError
Erro de resposta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de erro
|
ErrorCode | string | |
|
Nome do campo
|
FieldName | string | |
|
Message
|
Message | string | |
|
Meta
|
Meta | object |
Cadeia de caracteres de dicionário<, cadeia de caracteres> |
CMTrimType
- Procurar
- string
CMLocation
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Identificador Exclusivo
|
Uri | integer | |
|
Nome
|
NameString | string | |
|
Nome formatado completo do local
|
LocationFullFormattedName | string | |
|
Nome da Classificação de Local
|
LocationSortName | string |
CMBob
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Identificador Exclusivo
|
Uri | integer | |
|
Nome
|
NameString | string |
CMLocationsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
Results | array of CMLocation |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Total de resultados
|
TotalResults | integer | |
|
Contar Cadeia de Caracteres Ex
|
CountStringEx | string | |
|
Contagem mínima
|
MinimumCount | integer | |
|
Contagem
|
Count | integer | |
|
Tem mais itens
|
HasMoreItems | boolean | |
|
Título da Pesquisa
|
SearchTitle | string | |
|
Cadeia de caracteres de realce de clique
|
HitHighlightString | string | |
|
Procurar
|
TrimType | CMTrimType | |
|
Status da resposta
|
ResponseStatus | CMResponseStatus |
Status da resposta |
CMBobResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
Results | array of CMBob |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Total de resultados
|
TotalResults | integer | |
|
Contar Cadeia de Caracteres Ex
|
CountStringEx | string | |
|
Contagem mínima
|
MinimumCount | integer | |
|
Contagem
|
Count | integer | |
|
Tem mais itens
|
HasMoreItems | boolean | |
|
Título da Pesquisa
|
SearchTitle | string | |
|
Cadeia de caracteres de realce de clique
|
HitHighlightString | string | |
|
Procurar
|
TrimType | CMTrimType | |
|
Status da resposta
|
ResponseStatus | CMResponseStatus |
Status da resposta |
GetFileFromUrlResponse
Resposta do plug-in da API de Serviço cm 'GetFileFromUrl'.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Filepath
|
Filepath | string |
Caminho do arquivo local para o arquivo baixado da URL. |
|
Message
|
Message | string |
CMLocationAddressUri
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Identificação Única
|
Uri | integer |
binário
Esse é o tipo de dados básico 'binary'.
objeto
Esse é o tipo 'object'.