Partilhar via

Gestor de Conteúdos Power Connect

O Content Manager é um sistema de gerenciamento de conteúdo corporativo baseado em governança projetado para ajudar agências governamentais, indústrias regulamentadas e organizações globais a gerenciar seu conteúdo de negócios desde a criação até a eliminação. Conecte-se ao Content Manager 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)

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 Kapish Serviços Pty Ltd
URL https://kapish.com.au/products/power_connect/
Email sales@kapish.com.au
Metadados do conector
Editora Kapish Serviços Pty Ltd
Sítio Web https://kapish.com.au/products/power_connect/
Política de privacidade https://kapish.com.au/products/privacy-policy/
Categorias Dados; Conteúdo e Ficheiros

O Content Manager Power Connect by Kapish é um conector que fornece funções de automação e integração no Content Manager para simplificar a capacidade da sua organização de atender aos requisitos de gerenciamento e governança de informações.

Pre-requisites

  • Uma API de serviço do Content Manager acessível externamente
  • Uma chave de subscrição 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

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
OAuth (Fluxo de Cliente Confidencial) Use o OAuth para se conectar ao Content Manager Todas as regiões Não compartilhável
Sistema Gerenciado Use um nome de usuário e senha para se conectar ao Content Manager Todas as regiões Não compartilhável
Padrão [DEPRECATED] Esta 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

Use o OAuth para se conectar ao Content Manager

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

Nome Tipo Description Obrigatório
Chave de Subscrição KPC securestring A chave da API para acessar o Kapish Power Connect Verdade
URL do CM ServiceAPI (por exemplo, https://myserver/CMServiceAPI/) cadeia (de caracteres) O URL onde sua CM ServiceAPI pode ser acessada Verdade
URL do servidor de autorização (por exemplo, https://myserver/adfs/oauth2/token) cadeia (de caracteres) A URL para obter o token de acesso Verdade
ID do Cliente cadeia (de caracteres) A ID do Cliente para autenticação Verdade
Segredo do Cliente securestring O segredo do cliente para autenticação Verdade

Sistema Gerenciado

Auth ID: Básico

Aplicável: Todas as regiões

Use um nome de usuário e senha para se conectar ao Content Manager

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

Nome Tipo Description Obrigatório
Chave de Subscrição KPC securestring A chave da API para acessar o Kapish Power Connect Verdade
URL do CM ServiceAPI (por exemplo, https://myserver/CMServiceAPI/) cadeia (de caracteres) O URL onde sua CM ServiceAPI pode ser acessada Verdade
Nome de Utilizador cadeia (de caracteres) O nome de usuário para autenticação Verdade
Palavra-passe securestring A senha para autenticação Verdade

Padrão [DEPRECATED]

Aplicável: Todas as regiões

Esta 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.

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

Nome Tipo Description Obrigatório
Chave de Subscrição KPC securestring A chave da API para acessar o Kapish Power Connect Verdade
URL do CM ServiceAPI (por exemplo, https://myserver/CMServiceAPI/) cadeia (de caracteres) O URL onde sua CM ServiceAPI pode ser acessada Verdade
URL do servidor de autorização (por exemplo, https://myserver/adfs/oauth2/token) cadeia (de caracteres) A URL para obter o token de acesso Verdade
ID do Cliente cadeia (de caracteres) A ID do Cliente para autenticação Verdade
Segredo do Cliente securestring O segredo do cliente para autenticação Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Atualizar local (endereço)

Criar / Atualizar o Endereço de um Local usando o ID Exclusivo do endereço
Atualizar Localização (Pessoa)

Atualizar a localização de uma pessoa usando seu identificador exclusivo
Atualizar Registo (Anexar Contacto)

Anexar um contacto a um registo
Atualizar Registo (Anexar Ficheiro Eletrónico)

Anexar um ficheiro eletrónico a um registo
Atualizar Registo (Anexar Termo do Dicionário de Sinónimos)

Anexar um termo do dicionário de sinônimos a um registro
Atualizar Registo (Avançado)

Atualizar um registro com propriedades avançadas
Atualizar Registo (Campos Adicionais)

Atualizar campos adicionais em um registro
Atualizar registro (Adicionar controles de acesso)

AddAccessControl
Atualizar Registro (Anexar Ação ou Procedimento)

Anexar uma ação ou procedimento a um registo
Atualizar registro (Ação de reatribuição)

Reatribui a ação nomeada a um local especificado
Atualizar registro (ações concluídas)

Concluir uma ou todas as ações devidas em um Registro específico
Atualizar registro (Checkout)

Definir o status do Registro para check-out
Atualizar registro (classificação)

Atualizar a classificação de um registro
Atualizar registro (definir acesso irrestrito ou com base no contêiner)

InheritAccessControl
Atualizar registro (definir cessionário)

Defina o Cessionário para um Local específico, volte para a Página Inicial ou registe-se como Ausente
Atualizar registro (definir rótulo do usuário)

Permite a configuração de um rótulo de usuário em um registro
Atualizar registro (descartar)

Eliminar um registo
Atualizar registro (descartar)

Reverte o estado do registro (e qualquer um de seus conteúdos) para que ele não seja mais descartado
Atualizar registro (desfazer check-out)

Desfazer um check-out anterior do documento eletrônico para este Registro, desconsiderando quaisquer alterações feitas desde que foi feito check-out
Atualizar registro (fechar)

Use a função CloseRecord para fechar um contêiner - deixe a data em branco se quiser que a data de fechamento seja 'agora'. Como fechar um registro pode exigir a atualização de muitos registros contidos, essa função confirma as alterações automaticamente
Atualizar registro (finalizar)

Atualizar um registro de rascunho
Atualizar registro (Propriedades)

Atualizar um registo
Atualizar registro (reabrir)

Use a função ReopenRecord para reabrir um contêiner fechado. Como a reabertura de um registro pode exigir a atualização de muitos registros contidos, 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 Localização dos Controles de Acesso)

RemoveAccessControl
Atualizar registro (remover todas as ações)

Remove todas as ações anexadas ao registro especificado
Atualizar registro (solicitar representação)

Permite criar uma solicitação para que o mecanismo de renderização automática faça uma representação de um registro
Atualizar registro (substituir controles de acesso)

SetAccessControl
Atualizar registro (Unfinalise - set as Draft)

Atualizar um registro finalizado para rascunho
Carregar Ficheiro Eletrónico

Carregar um ficheiro eletrónico que poderá mais tarde ser anexado a um registo
Criar Localização (Outros)

Criar um local de qualquer tipo
Criar Localização (Pessoa)

Criar uma localização de pessoa
Criar Registo (Documento)

Criar um registo
Criar registro (Avançado)

Criar um registro com campos avançados
Criar registro (pasta)

Criar um registo
Download de Arquivo Eletrônico

Descarregar um ficheiro eletrónico de um registo
Encontrar ID Exclusivo do Endereço de Localização

Obter o ID exclusivo do endereço de criança de um local
Encontrar localização por ID

Buscar um único local por ID ou nome exclusivo
Encontrar Localizações

Pesquisar locais (buscar uma coleção de locais usando uma cadeia de caracteres de pesquisa)
Encontrar objetos CM

Procurar objetos CM
Encontrar registos

Pesquisar registros (buscar uma coleção de registros usando uma cadeia de caracteres de pesquisa)
Excluir registro

Excluir um registro
Ler dados do evento

Transforme dados de eventos do Kapish Dispatch para consumo de fluxo
Local de Atualização (Campos Adicionais)

Atualizar campos adicionais em um local
Local de atualização (Outros)

Atualizar um local
Localizar registo por ID

Buscar um único registro por ID ou nome exclusivo
Localizar registos (Avançado)

Pesquisar registros (buscar uma coleção de registros usando uma cadeia de caracteres de pesquisa). Retorna uma resposta bruta da API ServiceAPI do Content Manager.
Obter arquivo do URL

Baixe um arquivo do URL para uma área de preparo usando o plug-in 'GetFileFromUrl' CM Service API

Atualizar local (endereço)

ID da Operação:
UpdateLocationAddress

Criar / Atualizar o Endereço de um Local usando o ID Exclusivo do endereço

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer

O uri do local existente a ser atualizado
ID Único
 Uri integer

O uri da rua ou endereço postal 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
Código postal
 LocationAddressPostcode string
Country
 LocationAddressCountry string

Devoluções

Body
CMLocationsResponse

Atualizar Localização (Pessoa)

ID da Operação:
LocationUpdatePerson

Atualizar a localização de uma pessoa usando seu identificador exclusivo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
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 um (conforme especificado pela ID Exclusiva).
Title
 LocationHonorific string
Apelido
 LocationSurname string
Nome Próprio
 LocationGivenNames string
Interno
 LocationIsWithin boolean
Cargo
 LocationJobDescription string
Data de Nascimento
 LocationDateOfBirth string
Saudação
 LocationSalutation string
Nome Exclusivo
 LocationNickName string
Número de identificação
 LocationIdNumber string
Telefone comercial
 LocationPhoneNumber string
Telemóvel
 LocationMobileNumber string
Fax
 LocationFaxNumber string
Telefone residencial
 LocationAfterHoursPhoneNumber string
O mesmo que o endereço
 LocationUseAddressOf integer

ID Único da Localização
Tornar padrão
 AddRelationshipMakeThisTheDefaultRelationship boolean
ID exclusivo relacionado
 AddRelationshipRelatedLocation integer
Tipo
 AddRelationshipRelationshipType string
Endereço de E-mail
 LocationEmailAddress string
Sexo
 LocationGenderValue string
Aceitar logins
 LocationCanLogin boolean
Login de rede
 LocationLogsInAs string
Login de rede adicional
 LocationAdditionalLogin string
O login expira em
 LocationLoginExpires string
Perfil de utilizador de
 LocationUseProfileOf integer

ID Único da Localização
Tipo de Utilizador
 LocationUserType string
Cadeia de segurança
 LocationSecurityString string
De
 SetActiveDateRangeValidFromDate string

dd/mm/aaaa
Para
 SetActiveDateRangeValidToDate string

dd/mm/aaaa
Observações
 LocationNotes string
Tipo de atualização do Notes
 NotesUpdateType string
ID exclusivo relacionado
 RemoveRelationshipRelatedLocation integer

Devoluções

Body
CMLocationsResponse

Atualizar Registo (Anexar Contacto)

ID da Operação:
RecordAttachContact

Anexar um contacto a um registo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Tipo de Contacto
 ContactType True string
Localização de contato
 ContactLocation True string

ID exclusivo ou endereço de e-mail da Localização
Definir como contato principal?
 IsPrimary True boolean
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar Registo (Anexar Ficheiro Eletrónico)

ID da Operação:
RecordElecAttach

Anexar um ficheiro eletrónico a um registo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Ficheiro
 File True file

O conteúdo/corpo do ficheiro do documento eletrónico a anexar
Identificador Exclusivo
 Uri True string

ID exclusivo do registo

Devoluções

Body
CMRecordsResponse

Atualizar Registo (Anexar Termo do Dicionário de Sinónimos)

ID da Operação:
RecordAttachKeyword

Anexar um termo do dicionário de sinônimos a um registro

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Gravar / Registo
 Uri True integer

A ID Única do Registo a que anexa o Termo do Dicionário de Sinónimos
Termo do Thesaurus
 Keyword True string

O ID único ou nome do termo do dicionário de sinônimos a anexar
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar Registo (Avançado)

ID da Operação:
RecordUpdateAdvanced

Atualizar um registro com propriedades avançadas

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Tipo de registo
 RecordRecordType string
Classification
 RecordClassification string

Fornecer o identificador único da classificação
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas
Author
 RecordAuthor string

ID exclusivo ou endereço de e-mail da Localização
Número de adesão
 RecordAccessionNumber string
Destinatário
 RecordAddressee string

ID exclusivo ou endereço de e-mail da Localização
Contentor Alternativo
 RecordAlternativeContainer string
Cessionário
 RecordAssignee string

ID exclusivo ou endereço de e-mail da Localização
Nível de Confiança de Classificação Automática
 RecordAutoClassificationConfidenceLevel string
Renderização automática para 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.
Mudar de posição dentro dos favoritos
 ChangePositionWithinFavorites string

Ao procurar favoritos, eles serão retornados nesta ordem, a menos que outra classificação seja usada.
Alterar posição no rótulo do usuário
 ChangePositionWithinUserLabel string

Ao pesquisar por UserLabel, eles serão retornados nesta ordem, a menos que outro tipo seja usado.,
Check-in como
 CheckinAs string

Defina a propriedade Source do documento eletrônico.
Classe de registo
 RecordClassOfRecord string
Client
 RecordClient string

ID exclusivo ou endereço de e-mail da Localização
Registo do Cliente
 RecordClientRecord string
Comments
 comments string

Comentários a serem enviados nas Notas de Registro quando o documento for carregado.
Remessa
 RecordConsignment string
Objeto da remessa
 RecordConsignmentObject string
Container
 RecordContainer string
Copiar documento do registo
 CopyDocumentFromRecord string

Especifique um ID exclusivo para o registro do qual copiar o documento eletrônico para este registro.,
Criador
 RecordCreator string

ID exclusivo ou endereço de e-mail da Localização
Data de Criação
 RecordDateCreated string
Data de vencimento
 RecordDateDue string
Data de Publicação
 RecordDatePublished string
Data de Receção
 RecordDateReceived string
Editor
 RecordEditor string

ID exclusivo ou endereço de e-mail da Localização
Armazenamento de Documentos Eletrônicos
 RecordEStore string
Referência externa
 RecordExternalReference string
Falhar nos avisos?
 FailOnWarnings boolean

True para não criar/salvar um objeto se houver algum aviso.
Nome do arquivo na pasta Uploads
 RecordFilePath string

O nome do arquivo como aparece na pasta Uploads.
Finalizar em Salvar
 RecordFinalizeOnSave boolean
Código de barras estrangeiro
 RecordForeignBarcode string
Localização GPS
 RecordGpsLocation string
Localização inicial
 RecordHomeLocation string

ID Único da Localização
Espaço Casa
 RecordHomeSpace string
Está em anexo
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
Manter check-out
 keepBookedOut boolean

True para deixar o Registro com check-out após o upload do documento eletrônico.
Data da última ação
 RecordLastActionDate string
Número longo
 RecordLongNumber string
Torne-se 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 ocorrer alguma falha.
Tornar inativo
 MakeInactive string

Define a dataInativa para este registro e qualquer um de seus conteúdos. Ao processar conteúdo, você pode especificar se a tarefa deve ser interrompida se ocorrer alguma falha.
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
Registo 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
Os meus comentários
 RecordMyReviewComments string
Minha avaliação concluída
 RecordMyReviewComplete boolean
Precisa de autorização?
 RecordNeedsAuthorization boolean
Precisa de revisão?
 RecordNeedsReview boolean
Nova Regra de Criação de Peças
 RecordNewPartCreationRule string

ID exclusivo da regra de criação de peças automáticas
Observações
 RecordNotes string
Tipo de atualização do Notes
 NotesUpdateType string
Outros Contactos
 RecordOtherContact string

ID exclusivo ou endereço de e-mail da Localização
Localização do Proprietário
 RecordOwnerLocation string

ID exclusivo ou endereço de e-mail da Localização
Hierarquia do servidor na entrada de dados?
 RecordPreserveHierarchyOnDataEntry boolean
Registo da Parte Anterior
 RecordPrevPartRecord string
Priority
 RecordPriority string
Gravar Novo Tipo
 RecordNewType string

Deixe como padrão, a menos que crie uma nova versão de peça ou cópia.
Registo relacionado
 RecordRelatedRecord string
Representante
 RecordRepresentative string
Cronograma de retenção
 RecordRetentionSchedule string
Data de revisão
 RecordReviewDate string
Data de vencimento da revisão
 RecordReviewDueDate string
Estado da revisão
 RecordReviewState string
Segurança
 RecordSecurity string
Série Record
 RecordSeriesRecord string
Título (Parte 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).

Devoluções

Body
CMRecordsResponse

Atualizar Registo (Campos Adicionais)

ID da Operação:
RecordUpdateAdditionalFields

Atualizar campos adicionais em um registro

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri integer
Nome
 SearchClause string
Valor
 Value string
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar registro (Adicionar controles de acesso)

ID da Operação:
AddAccessControl

AddAccessControl

Parâmetros

Name Chave Necessário Tipo Description
Identificador Exclusivo
 Uri True integer
FunctionEnum
 FunctionEnum string
ID Único
 Uri integer

Identificador Único de Localização

Devoluções

Body
CMRecordsResponse

Atualizar Registro (Anexar Ação ou Procedimento)

ID da Operação:
RecordAttachAction

Anexar uma ação ou procedimento a um registo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Ação a anexar
 ActionToAttach True integer
ID Único do Cessionário
 NewAssignee integer
Opção do cessionário
 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

Devoluções

Body
CMRecordsResponse

Atualizar registro (Ação de reatribuição)

ID da Operação:
RecordReassignAction

Reatribui a ação nomeada a um local especificado

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Novo cessionário
 NewAssignee True string

ID exclusivo ou endereço de e-mail do novo cessionário
Ação para reatribuir
 RecordActionUri True integer
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar registro (ações concluídas)

ID da Operação:
RecordCompleteActions

Concluir uma ou todas as ações devidas em um Registro específico

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Complete
 Complete True string

Especificar quais ações de registro devem ser concluídas
Concluir Ações Anteriores
 CompletePrevious boolean

Conclua todas as Ações de Registro antes da especificada
Data de conclusão
 CompletionDate date

A data a definir como data de conclusão
ID Exclusivo da Ação de Registro
 RecordActionUri integer

A ID Exclusiva da Ação de Registro a ser concluída se a opção 'Para Identificador Exclusivo' estiver selecionada
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar registro (Checkout)

ID da Operação:
RecordCheckout

Definir o status do Registro para check-out

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
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

Devoluções

Body
CMRecordsResponse

Atualizar registro (classificação)

ID da Operação:
RecordUpdateClassification

Atualizar a classificação de um registro

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Classification
 RecordClassification True string

Fornecer o identificador único da classificação
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar registro (definir acesso irrestrito ou com base no contêiner)

ID da Operação:
InheritAccessControl

InheritAccessControl

Parâmetros

Name Chave Necessário Tipo Description
Identificador Exclusivo
 Uri True integer
FunctionEnum
 FunctionEnum string
ID Único
 Uri integer

Identificador Único de Localização

Devoluções

Body
CMRecordsResponse

Atualizar registro (definir cessionário)

ID da Operação:
RecordSetAssignee

Defina o Cessionário para um Local específico, volte para a Página Inicial ou registe-se como Ausente

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Novo cessionário
 NewAssignee string

ID exclusivo ou endereço de e-mail do novo cessionário
Tipo de cessionário
 AssigneeType string
Prazo de devolução por data
 DueForReturnByDate date
Ocorreu uma alteração de hora real
 ActualTimeChangeOccurred date-time
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar registro (definir rótulo do usuário)

ID da Operação:
RecordSetUserLabel

Permite a configuração de um rótulo de usuário em um registro

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Gravar / Registo
 Uri True integer

A ID exclusiva do registro para anexar o rótulo do usuário
Etiqueta do usuário
 UserLabel True string

A ID Exclusiva ou o Nome da Etiqueta de Utilizador a aplicar
Tipo favorito
 FavouriteType string
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar registro (descartar)

ID da Operação:
RecordDispose

Eliminar um registo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Continuar com o erro?
 ContinueOnError boolean
Método de eliminação
 MethodOfDisposal string
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar registro (descartar)

ID da Operação:
RecordUndispose

Reverte o estado do registro (e qualquer um de seus conteúdos) para que ele não seja mais descartado

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
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

Devoluções

Body
CMRecordsResponse

Atualizar registro (desfazer check-out)

ID da Operação:
RecordUndoCheckout

Desfazer um check-out anterior do documento eletrônico para este Registro, desconsiderando quaisquer alterações feitas desde que foi feito check-out

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Comments
 Comments string
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar registro (fechar)

ID da Operação:
RecordClose

Use a função CloseRecord para fechar um contêiner - deixe a data em branco se quiser que a data de fechamento seja 'agora'. Como fechar um registro pode exigir a atualização de muitos registros contidos, essa função confirma as alterações automaticamente

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Continuar com o erro?
 ContinueOnError boolean
Anexar conteúdos?
 EncloseContents boolean
Finalizar conteúdo?
 FinalizeContents boolean
Somente erros de log?
 LogErrorsOnly boolean
Registrar resultados?
 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 encerramento específica?
 SpecificCloseDate date
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMLogResponse

Atualizar registro (finalizar)

ID da Operação:
RecordUpdateFinalise

Atualizar um registro de rascunho

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
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

Devoluções

Body
CMRecordsResponse

Atualizar registro (Propriedades)

ID da Operação:
RecordUpdate

Atualizar um registo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
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 Texto Livre)
 RecordTypedTitle string
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas
Author
 RecordAuthor string

ID exclusivo ou endereço de e-mail da Localização
Container
 RecordContainer string
Classification
 RecordClassification string

Fornecer o identificador único da classificação
Destinatário
 RecordAddressee string

ID exclusivo ou endereço de e-mail da Localização
Contentor Alternativo
 RecordAlternativeContainer string
Cessionário
 RecordAssignee string

ID exclusivo ou endereço de e-mail da Localização
Renderização automática para PDF ao salvar
 RecordAutoRenderToPDFOnSave boolean
Ignorar controles de acesso de tipo de registro
 RecordBypassRecordTypeAccessControls boolean
Check-in como
 CheckinAs string

Defina a propriedade Source do documento eletrônico.
Client
 RecordClient string

ID exclusivo ou endereço de e-mail da Localização
Registo do Cliente
 RecordClientRecord string
Copiar documento do registo
 CopyDocumentFromRecord string

Especifique um ID exclusivo para o registro do qual copiar o documento eletrônico para este registro.,
Criador
 RecordCreator string

ID exclusivo ou endereço de e-mail da Localização
Data de Criação
 RecordDateCreated string
Data de vencimento
 RecordDateDue string
Data de Publicação
 RecordDatePublished string
Data de Receção
 RecordDateReceived string
Referência externa
 RecordExternalReference string
Falhar nos avisos?
 FailOnWarnings boolean

True para não criar/salvar um objeto se houver algum aviso.
Nome do arquivo na pasta Uploads
 RecordFilePath string

O nome do arquivo como aparece na pasta Uploads.
Finalizar em Salvar
 RecordFinalizeOnSave boolean
Código de barras estrangeiro
 RecordForeignBarcode string
Localização GPS
 RecordGpsLocation string
Localização inicial
 RecordHomeLocation string

ID Único da Localização
Espaço Casa
 RecordHomeSpace string
Está em anexo
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
Manter check-out
 keepBookedOut boolean

True para deixar o Registro com check-out após o upload do documento eletrônico.
Número longo
 RecordLongNumber string
Tipo de mídia
 RecordMediaType string
Observações
 RecordNotes string
Tipo de atualização do Notes
 NotesUpdateType string
Outros Contactos
 RecordOtherContact string

ID exclusivo ou endereço de e-mail da Localização
Localização do Proprietário
 RecordOwnerLocation string

ID exclusivo ou endereço de e-mail da Localização
Registo relacionado
 RecordRelatedRecord string
Representante
 RecordRepresentative string
Data de revisão
 RecordReviewDate string
Data de vencimento da revisão
 RecordReviewDueDate string
Estado da revisão
 RecordReviewState string
Segurança
 RecordSecurity string

Devoluções

Body
CMRecordsResponse

Atualizar registro (reabrir)

ID da Operação:
RecordReopen

Use a função ReopenRecord para reabrir um contêiner fechado. Como a reabertura de um registro pode exigir a atualização de muitos registros contidos, essa função confirma as alterações automaticamente

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Continuar com o erro?
 ContinueOnError boolean
Registrar resultados?
 LogResults boolean

Retornar um log de texto dos Registros reabertos na propriedade Mensagem de Log?
Conteúdo não finalizado?
 UnfinalizeContents boolean
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMLogResponse

Atualizar registro (reagendar ações)

ID da Operação:
RecordRescheduleActions

Reagenda todas as ações anexadas a este registro

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
A partir 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

Devoluções

Body
CMRecordsResponse

Atualizar Registro (Remover Localização dos Controles de Acesso)

ID da Operação:
RemoveAccessControl

RemoveAccessControl

Parâmetros

Name Chave Necessário Tipo Description
Identificador Exclusivo
 Uri True integer
FunctionEnum
 FunctionEnum string
ID Único
 Uri integer

Identificador Único de Localização

Devoluções

Body
CMRecordsResponse

Atualizar registro (remover todas as ações)

ID da Operação:
RecordRemoveAllActions

Remove todas as ações anexadas ao registro especificado

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Atualizar registro (solicitar representação)

ID da Operação:
RecordRequestRendition

Permite criar uma solicitação para que o mecanismo de renderização automática faça uma representação de um registro

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
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

Devoluções

Body
CMRecordsResponse

Atualizar registro (substituir controles de acesso)

ID da Operação:
SetAccessControl

SetAccessControl

Parâmetros

Name Chave Necessário Tipo Description
Identificador Exclusivo
 Uri True integer
FunctionEnum
 FunctionEnum string
ID Único
 Uri integer

Identificador Único de Localização

Devoluções

Body
CMRecordsResponse

Atualizar registro (Unfinalise - set as Draft)

ID da Operação:
RecordUpdateUnfinalise

Atualizar um registro finalizado para rascunho

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer

Devoluções

Body
CMRecordsResponse

Carregar Ficheiro Eletrónico

ID da Operação:
RecordElecUpload

Carregar um ficheiro eletrónico que poderá mais tarde ser anexado a um registo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Nome do arquivo
 RecordFilePath True string
Identificador Exclusivo
 Uri True string

Criar Localização (Outros)

ID da Operação:
LocationCreate

Criar um local de qualquer tipo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Tipo de localização
 LocationTypeOfLocation string
Nome
 LocationSortName True string
Nome Exclusivo
 LocationNickName string
Número de identificação
 LocationIdNumber string
Interno
 LocationIsWithin boolean
Telefone comercial
 LocationPhoneNumber string
Telemóvel
 LocationMobileNumber string
Fax
 LocationFaxNumber string
Telefone residencial
 LocationAfterHoursPhoneNumber string
O mesmo que o endereço
 LocationUseAddressOf integer

ID Único da Localização
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
Código postal
 LocationAddressPostcode string
Country
 LocationAddressCountry string
Tornar padrão
 AddRelationshipMakeThisTheDefaultRelationship boolean
ID exclusivo relacionado
 AddRelationshipRelatedLocation integer
Tipo
 AddRelationshipRelationshipType string
Endereço de E-mail
 LocationEmailAddress string
De
 SetActiveDateRangeValidFromDate string

dd/mm/aaaa
Para
 SetActiveDateRangeValidToDate string

dd/mm/aaaa
Observações
 LocationNotes string
Tipo de atualização do Notes
 NotesUpdateType string

Devoluções

Body
CMLocationsResponse

Criar Localização (Pessoa)

ID da Operação:
LocationCreatePerson

Criar uma localização de pessoa

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Title
 LocationHonorific string
Apelido
 LocationSurname string
Nome Próprio
 LocationGivenNames string
Interno
 LocationIsWithin boolean
Cargo
 LocationJobDescription string
Data de Nascimento
 LocationDateOfBirth string
Saudação
 LocationSalutation string
Nome Exclusivo
 LocationNickName string
Número de identificação
 LocationIdNumber string
Telefone comercial
 LocationPhoneNumber string
Telemóvel
 LocationMobileNumber string
Fax
 LocationFaxNumber string
Telefone residencial
 LocationAfterHoursPhoneNumber string
O mesmo que o endereço
 LocationUseAddressOf integer

ID Único da Localização
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
Código postal
 LocationAddressPostcode string
Country
 LocationAddressCountry string
Tornar padrão
 AddRelationshipMakeThisTheDefaultRelationship boolean
ID exclusivo relacionado
 AddRelationshipRelatedLocation integer
Tipo
 AddRelationshipRelationshipType string
Endereço de E-mail
 LocationEmailAddress string
Sexo
 LocationGenderValue string
Aceitar logins
 LocationCanLogin boolean
Login de rede
 LocationLogsInAs string
Login de rede adicional
 LocationAdditionalLogin string
O login expira em
 LocationLoginExpires string
Perfil de utilizador de
 LocationUseProfileOf integer

ID Único da Localização
Tipo de Utilizador
 LocationUserType string
Cadeia de segurança
 LocationSecurityString string
De
 SetActiveDateRangeValidFromDate string

dd/mm/aaaa
Para
 SetActiveDateRangeValidToDate string

dd/mm/aaaa
Observações
 LocationNotes string
Tipo de atualização do Notes
 NotesUpdateType string

Devoluções

Body
CMLocationsResponse

Criar Registo (Documento)

ID da Operação:
RecordCreate

Criar um registo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Tipo de registo
 RecordRecordType True string
Título (Parte Texto Livre)
 RecordTypedTitle True string
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas
Author
 RecordAuthor string

ID exclusivo ou endereço de e-mail da Localização
Destinatário
 RecordAddressee string

ID exclusivo ou endereço de e-mail da Localização
Contentor Alternativo
 RecordAlternativeContainer string
Cessionário
 RecordAssignee string

ID exclusivo ou endereço de e-mail da Localização
Renderização automática para PDF ao salvar
 RecordAutoRenderToPDFOnSave boolean
Ignorar controles de acesso de tipo de registro
 RecordBypassRecordTypeAccessControls boolean
Check-in como
 CheckinAs string

Defina a propriedade Source do documento eletrônico.
Classification
 RecordClassification string

Fornecer o identificador único da classificação
Client
 RecordClient string

ID exclusivo ou endereço de e-mail da Localização
Registo do Cliente
 RecordClientRecord string
Container
 RecordContainer string
Copiar documento do registo
 CopyDocumentFromRecord string

Especifique um ID exclusivo para o registro do qual copiar o documento eletrônico para este registro.,
Criador
 RecordCreator string

ID exclusivo ou endereço de e-mail da Localização
Data de Criação
 RecordDateCreated string
Data de vencimento
 RecordDateDue string
Data de Publicação
 RecordDatePublished string
Data de Receção
 RecordDateReceived string
Referência externa
 RecordExternalReference string
Falhar nos avisos?
 FailOnWarnings boolean

True para não criar/salvar um objeto se houver algum aviso.
Nome do arquivo na pasta Uploads
 RecordFilePath string

O nome do arquivo como aparece na pasta Uploads.
Finalizar em Salvar
 RecordFinalizeOnSave boolean
Código de barras estrangeiro
 RecordForeignBarcode string
Localização GPS
 RecordGpsLocation string
Localização inicial
 RecordHomeLocation string

ID Único da Localização
Espaço Casa
 RecordHomeSpace string
Está em anexo
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
Manter check-out
 keepBookedOut boolean

True para deixar o Registro com check-out após o upload do documento eletrônico.
Data da última ação
 RecordLastActionDate string
Número longo
 RecordLongNumber string
Tipo de mídia
 RecordMediaType string
Observações
 RecordNotes string
Tipo de atualização do Notes
 NotesUpdateType string
Outros Contactos
 RecordOtherContact string

ID exclusivo ou endereço de e-mail da Localização
Localização do Proprietário
 RecordOwnerLocation string

ID exclusivo ou endereço de e-mail da Localização
Registo relacionado
 RecordRelatedRecord string
Representante
 RecordRepresentative string

ID exclusivo ou endereço de e-mail da Localização
Data de revisão
 RecordReviewDate string
Data de vencimento da revisão
 RecordReviewDueDate string
Estado da revisão
 RecordReviewState string
Segurança
 RecordSecurity string

Devoluções

Body
CMRecordsResponse

Criar registro (Avançado)

ID da Operação:
RecordCreateAdvanced

Criar um registro com campos avançados

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Tipo de registo
 RecordRecordType True string
Título (Parte Texto Livre)
 RecordTypedTitle True string
Classification
 RecordClassification string

Fornecer o identificador único da classificação
Author
 RecordAuthor string

ID exclusivo ou endereço de e-mail da Localização
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas
Número de adesão
 RecordAccessionNumber string
Destinatário
 RecordAddressee string

ID exclusivo ou endereço de e-mail da Localização
Contentor Alternativo
 RecordAlternativeContainer string
Cessionário
 RecordAssignee string

ID exclusivo ou endereço de e-mail da Localização
Nível de Confiança de Classificação Automática
 RecordAutoClassificationConfidenceLevel string
Renderização automática para 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.
Mudar de posição dentro dos favoritos
 ChangePositionWithinFavorites string

Ao procurar favoritos, eles serão retornados nesta ordem, a menos que outra classificação seja usada.
Alterar posição no rótulo do usuário
 ChangePositionWithinUserLabel string

Ao pesquisar por UserLabel, eles serão retornados nesta ordem, a menos que outro tipo seja usado.,
Check-in como
 CheckinAs string

Defina a propriedade Source do documento eletrônico.
Classe de registo
 RecordClassOfRecord string
Client
 RecordClient string

ID exclusivo ou endereço de e-mail da Localização
Registo do Cliente
 RecordClientRecord string
Comments
 comments string

Comentários a serem enviados nas Notas de Registro quando o documento for carregado.
Remessa
 RecordConsignment string
Objeto da remessa
 RecordConsignmentObject string
Container
 RecordContainer string
Copiar documento do registo
 CopyDocumentFromRecord string

Especifique um ID exclusivo para o registro do qual copiar o documento eletrônico para este registro.,
Criador
 RecordCreator string

ID exclusivo ou endereço de e-mail da Localização
Data de Criação
 RecordDateCreated string
Data de vencimento
 RecordDateDue string
Data de Publicação
 RecordDatePublished string
Data de Receção
 RecordDateReceived string
Editor
 RecordEditor string

ID exclusivo ou endereço de e-mail da Localização
Referência externa
 RecordExternalReference string
Falhar nos avisos?
 FailOnWarnings boolean

True para não criar/salvar um objeto se houver algum aviso.
Nome do arquivo na pasta Uploads
 RecordFilePath string

O nome do arquivo como aparece na pasta Uploads.
Finalizar em Salvar
 RecordFinalizeOnSave boolean
Código de barras estrangeiro
 RecordForeignBarcode string
Localização GPS
 RecordGpsLocation string
Localização inicial
 RecordHomeLocation string

ID Único da Localização
Espaço Casa
 RecordHomeSpace string
Iniciar modelo
 RecordInitiateTemplate string
Está em anexo
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
Manter check-out
 keepBookedOut boolean

True para deixar o Registro com check-out após o upload do documento eletrônico.
Data da última ação
 RecordLastActionDate string
Número longo
 RecordLongNumber string
Torne-se 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 ocorrer alguma falha.
Tornar inativo
 MakeInactive string

Define a dataInativa para este registro e qualquer um de seus conteúdos. Ao processar conteúdo, você pode especificar se a tarefa deve ser interrompida se ocorrer alguma falha.
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
Registo 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
Os meus comentários
 RecordMyReviewComments string
Minha avaliação concluída
 RecordMyReviewComplete boolean
Precisa de autorização?
 RecordNeedsAuthorization boolean
Precisa de revisão?
 RecordNeedsReview boolean
Nova Regra de Criação de Peças
 RecordNewPartCreationRule string

ID exclusivo da regra de criação de peças automáticas
Observações
 RecordNotes string
Tipo de atualização do Notes
 NotesUpdateType string
Outros Contactos
 RecordOtherContact string

ID exclusivo ou endereço de e-mail da Localização
Localização do Proprietário
 RecordOwnerLocation string

ID exclusivo ou endereço de e-mail da Localização
Hierarquia do servidor na entrada de dados?
 RecordPreserveHierarchyOnDataEntry boolean
Registo da Parte Anterior
 RecordPrevPartRecord string
Priority
 RecordPriority string
Gravar Novo Tipo
 RecordNewType string

Deixe como padrão, a menos que crie uma nova versão de peça ou cópia.
Registo relacionado
 RecordRelatedRecord string
Representante
 RecordRepresentative string
Cronograma de retenção
 RecordRetentionSchedule string
Data de revisão
 RecordReviewDate string
Data de vencimento da revisão
 RecordReviewDueDate string
Estado da revisão
 RecordReviewState string
Segurança
 RecordSecurity string
Série Record
 RecordSeriesRecord string
Conjuntos de propriedades
 propertySets string

Especifique Conjuntos de Propriedades além daqueles lançados para 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).

Devoluções

Body
CMRecordsResponse

Criar registro (pasta)

ID da Operação:
RecordCreateContainer

Criar um registo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Tipo de registo
 RecordRecordType True string
Título (Parte Texto Livre)
 RecordTypedTitle True string
Classification
 RecordClassification string

Fornecer o identificador único da classificação
Container
 RecordContainer string
Propriedades
 Properties string

Uma lista delimitada por vírgulas de propriedades a serem retornadas
Author
 RecordAuthor string

ID exclusivo ou endereço de e-mail da Localização
Destinatário
 RecordAddressee string

ID exclusivo ou endereço de e-mail da Localização
Contentor Alternativo
 RecordAlternativeContainer string
Cessionário
 RecordAssignee string

ID exclusivo ou endereço de e-mail da Localização
Ignorar controles de acesso de tipo de registro
 RecordBypassRecordTypeAccessControls boolean
Client
 RecordClient string

ID exclusivo ou endereço de e-mail da Localização
Criador
 RecordCreator string

ID exclusivo ou endereço de e-mail da Localização
Data de Criação
 RecordDateCreated string
Data de vencimento
 RecordDateDue string
Data de Publicação
 RecordDatePublished string
Referência externa
 RecordExternalReference string
Falhar nos avisos?
 FailOnWarnings boolean

True para não criar/salvar um objeto se houver algum aviso.
Nome do arquivo na pasta Uploads
 RecordFilePath string

O nome do arquivo como aparece na pasta Uploads.
Código de barras estrangeiro
 RecordForeignBarcode string
Localização GPS
 RecordGpsLocation string
Localização inicial
 RecordHomeLocation string

ID Único da Localização
Espaço Casa
 RecordHomeSpace string
Está em anexo
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
Data da última ação
 RecordLastActionDate string
Número longo
 RecordLongNumber string
Observações
 RecordNotes string
Tipo de atualização do Notes
 NotesUpdateType string
Outros Contactos
 RecordOtherContact string

ID exclusivo ou endereço de e-mail da Localização
Localização do Proprietário
 RecordOwnerLocation string

ID exclusivo ou endereço de e-mail da Localização
Registo relacionado
 RecordRelatedRecord string
Representante
 RecordRepresentative string

ID exclusivo ou endereço de e-mail da Localização
Data de revisão
 RecordReviewDate string
Data de vencimento da revisão
 RecordReviewDueDate string
Estado da revisão
 RecordReviewState string
Segurança
 RecordSecurity string

Devoluções

Body
CMRecordsResponse

Download de Arquivo Eletrônico

ID da Operação:
RecordElecDownload

Descarregar um ficheiro eletrónico de um registo

Parâmetros

Name Chave Necessário Tipo Description
Identificador Exclusivo
 uri True string

ID ou número de registo único
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar

Devoluções

response
binary

Encontrar ID Exclusivo do Endereço de Localização

ID da Operação:
FindLocationChildAddressUri

Obter o ID exclusivo do endereço de criança de um local

Parâmetros

Name Chave Necessário Tipo Description
Tipo
 type string

Selecione o tipo de endereço
Identificador Exclusivo
 LocationUri True string

ID Único da Localização
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar

Devoluções

Endereço da criança
CMLocationAddressUri

Encontrar localização por ID

ID da Operação:
LocationSearchByID

Buscar um único local por ID ou nome exclusivo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Id True string

O objeto ID exclusivo ou Nome
Propriedades descendentes
 descendantProperties string

Uma lista separada por vírgulas de propriedades de objeto, aplica-se apenas à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 de objeto, por exemplo, Sobrenome, GivenNames
Conjuntos de propriedades
 propertySets string

Um ou mais conjuntos de propriedades predefinidas, selecione DataGridVisible, Detailed, FromSearch, All ou um conjunto de propriedades personalizadas, conforme definido em sua configuração de serviço
Valor de Propriedade
 PropertyValue string

Inclua 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 qual formato usar

Devoluções

Body
CMLocationsResponse

Encontrar Localizações

ID da Operação:
LocationSearch

Pesquisar locais (buscar uma coleção de locais usando uma cadeia de caracteres de pesquisa)

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
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
Resultados da contagem
 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ços de cláusulas de pesquisa a serem aplicadas como filtro.
Pesquisa de Origem
 fromSearch string

A ID Exclusiva de uma Pesquisa Guardada a partir da qual construir esta pesquisa
Propriedades descendentes
 descendantProperties string

Uma lista separada por vírgulas de propriedades de objeto aplica-se apenas à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 em Opções do Utilizador apenas para esta pesquisa. Usar ids do /PropertyDef? Get=SearchOptions serviço, anexar um sinal de menos para definir como false, caso contrário, true é assumido.
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 predefinidas, selecione DataGridVisible, Detailed, FromSearch, All ou um conjunto de propriedades personalizadas, conforme definido em sua configuração de serviço
Valor de Propriedade
 PropertyValue string

Inclua 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 resultados de pesquisa com base em valores de enum de finalidade de objeto
Finalidade Extra
 purposeExtra string

Necessário como um suplemento para alguns fins. O serviço ObjectDef fornece informações sobre o tipo enum ou TrimMainObject para especificar, em particular ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes e HaveExtraPurposeParameter.
Ordenar Por
 sortBy string

Uma lista separada por vírgulas da cláusula de pesquisa Ids
Start
 start string

A posição no resultado definido para começar, vazio (ou 1) para começar no início, 2 para começar 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 qual formato usar

Devoluções

Body
CMLocationsResponse

Encontrar objetos CM

ID da Operação:
CMObjectSearch

Procurar objetos CM

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Pesquisar por
 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.
Resultados da contagem
 CountResults boolean

CountResults devolve a contagem mais fiável e a mais lenta do total de resultados da pesquisa. A contagem resultante está na propriedade Count de resposta.
Propriedades descendentes
 DescendantProperties string

Uma lista separada por vírgulas de propriedades de objeto aplica-se apenas às propriedades de objeto desta e de nível inferior, por exemplo, RecordNumber,RecordTitle.
Excluir contagem
 ExcludeCount boolean

Retornar o TotalResults e o SearchTitle pode degradar o desempenho. Defina como true se TotalResults e SearchTitle não forem necessários.
Filter
 Filter string

Uma lista separada por espaços de cláusulas de pesquisa a serem aplicadas como filtro.
Pesquisa de Origem
 FromSearch integer

O ID exclusivo de uma pesquisa salva a partir do qual construir essa pesquisa.
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 em Opções do Utilizador apenas para esta pesquisa. Usar ids do /PropertyDef? Get=SearchOptions serviço, anexar um sinal de menos para definir como false, caso contrário, true é 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 de 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 predefinidas, selecione DataGridVisible, Detailed, FromSearch, All ou um conjunto de propriedades personalizadas, conforme definido em sua configuração de serviço.
Propósito
 purpose integer

Uma propriedade especial para filtrar resultados de pesquisa com base em valores de enum de finalidade do objeto.
Finalidade Extra
 purposeExtra integer

Necessário como um suplemento para alguns fins. O serviço ObjectDef fornece informações sobre o tipo enum ou TrimMainObject para especificar, em particular ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes e HaveExtraPurposeParameter.
Ordenar Por
 sortBy string

Uma lista separada por vírgulas da cláusula de pesquisa Ids. Use - para especificar decrescente. Por exemplo, Number- para ordenar os Registos por número decrescente.
Start
 start integer

A posição no resultado definida para começar, vazio (ou 1) para começar no início, 2 para começar no segundo objeto, 3 no terceiro, etc.
StringDisplayType
 StringDisplayType string

Se retornar o valor da cadeia de caracteres qual formato usar.
Propriedades
 properties string

Uma lista separada por vírgulas de propriedades de objeto, por exemplo, Uri,NameString

Devoluções

Body
CMBobResponse

Encontrar registos

ID da Operação:
RecordSearch

Pesquisar registros (buscar uma coleção de registros usando uma cadeia de caracteres de pesquisa)

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Query
 q True string

Consulta de pesquisa
Propriedades
 properties True string

Uma lista separada por vírgulas de propriedades a serem retornadas

Devoluções

Body
CMRecordsResponse

Excluir registro

ID da Operação:
DeleteRecord

Excluir um registro

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri True integer

O ID exclusivo do registro a ser excluído
Excluir conteúdo?
 DeleteContents True boolean
Nova Casa para Conteúdos
 NewHomeForContents string

O ID exclusivo ou endereço de e-mail do novo Home Location para o conteúdo

Devoluções

Body
CMRecordsResponse

Ler dados do evento

ID da Operação:
ReadEventData

Transforme dados de eventos do Kapish Dispatch para consumo de fluxo

Parâmetros

Name Chave Necessário Tipo Description
Content
 Content string

O conteúdo da ação do Service Bus que recuperou os dados de evento do CM

Devoluções

Body
CMEventData

Local de Atualização (Campos Adicionais)

ID da Operação:
LocationUpdateAdditionalFields

Atualizar campos adicionais em um local

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Identificador Exclusivo
 Uri integer
Nome
 SearchClause string
Valor
 Value string

Devoluções

Body
CMLocationsResponse

Local de atualização (Outros)

ID da Operação:
LocationUpdate

Atualizar um local

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
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 um (conforme especificado pela ID Exclusiva).
Nome
 LocationSortName string
Nome Exclusivo
 LocationNickName string
Número de identificação
 LocationIdNumber string
Telefone comercial
 LocationPhoneNumber string
Telemóvel
 LocationMobileNumber string
Fax
 LocationFaxNumber string
Telefone residencial
 LocationAfterHoursPhoneNumber string
O mesmo que o endereço
 LocationUseAddressOf integer

ID Único da Localização
Tornar padrão
 AddRelationshipMakeThisTheDefaultRelationship boolean
ID exclusivo relacionado
 AddRelationshipRelatedLocation integer
Tipo
 AddRelationshipRelationshipType string
Endereço de E-mail
 LocationEmailAddress string
De
 SetActiveDateRangeValidFromDate string

dd/mm/aaaa
Para
 SetActiveDateRangeValidToDate string

dd/mm/aaaa
Observações
 LocationNotes string
Tipo de atualização do Notes
 NotesUpdateType string
ID exclusivo relacionado
 RemoveRelationshipRelatedLocation integer

Devoluções

Body
CMLocationsResponse

Localizar registo por ID

ID da Operação:
RecordSearchByID

Buscar um único registro por ID ou nome exclusivo

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
ID
 Id True string

O objeto ID exclusivo ou Nome
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 apenas à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 predefinidas, selecione DataGridVisible, Detailed, FromSearch, All ou um conjunto de propriedades personalizadas, conforme definido em sua configuração de serviço.
Valor de Propriedade
 PropertyValue string

Inclua 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 qual formato usar

Devoluções

Body
CMRecordsResponse

Localizar registos (Avançado)

ID da Operação:
RecordSearchAdvanced

Pesquisar registros (buscar uma coleção de registros usando uma cadeia de caracteres de pesquisa). Retorna uma resposta bruta da API ServiceAPI do Content Manager.

Parâmetros

Name Chave Necessário Tipo Description
Usuário para personificar
 userToImpersonate string

O Login de Rede ou Login Alternativo da Localização no CM para se passar
Query
 q True string

Consulta de pesquisa
Propriedades
 properties True string

Uma lista separada por vírgulas de propriedades a serem retornadas

Devoluções

response
object

Obter arquivo do URL

ID da Operação:
GetFileFromUrl

Baixe um arquivo do URL para uma área de preparo usando o plug-in 'GetFileFromUrl' CM Service API

Parâmetros

Name Chave Necessário Tipo Description
URL do ficheiro
 url True string

URL não codificado do ficheiro a transferir
Nome do arquivo para salvar como
 filename string

Nome do arquivo para salvar o URL baixado como (apenas o nome do arquivo com sufixo, não inclua o diretório completo)
Tipo de conteúdo
 contentType string

String típica encontrada na maioria dos cabeçalhos Content-Type (por exemplo, image/png, text/plain, application/pdf).

Devoluções

Resposta do plug-in 'GetFileFromUrl' CM Service API.

Ficheiro
GetFileFromUrlResponse

Definições

CMRecord

Name Caminho Tipo Description
Caminho do arquivo
 RecordFilePath string

O nome do arquivo como aparece na pasta Uploads
Número de adesão
 RecordAccessionNumber integer
Destinatário
 RecordAddressee integer
Contentor Alternativo
 RecordAlternativeContainer integer
Cessionário
 RecordAssignee integer
Author
 RecordAuthor integer
Método de autorização
 RecordAuthorizationMethod string
Nível de Confiança de Classificação Automática
 RecordAutoClassificationConfidenceLevel integer
Renderização automática para PDF ao salvar
 RecordAutoRenderToPDFOnSave boolean
Título do Blue Print
 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 registo
 RecordClassOfRecord string
Client
 RecordClient integer
Registo do Cliente
 RecordClientRecord integer
Remessa
 RecordConsignment string
Objeto da remessa
 RecordConsignmentObject string
Container
 RecordContainer integer
Criador
 RecordCreator integer
Versão Atual
 RecordCurrentVersion string
Data de Encerramento
 RecordDateClosed date-time
Data de Criação
 RecordDateCreated date-time
Data de vencimento
 RecordDateDue date-time
Data de Finalização
 RecordDateFinalized date-time
Data de importação
 RecordDateImported date-time
Data Inativa
 RecordDateInactive date-time
Data de Modificação
 RecordDateModified date-time
Data de Publicação
 RecordDatePublished date-time
Data de Receção
 RecordDateReceived date-time
Data de Registo
 RecordDateRegistered date-time
Anexar Documento Pendente
 RecordDocumentAttachPending boolean
Tamanho do documento
 RecordDocumentSize integer
Tipo de Documento
 RecordDocumentType string
Editor
 RecordEditor integer
Armazenamento 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
Localização GPS
 RecordGpsLocation string
Localização inicial
 RecordHomeLocation integer
Espaço Casa
 RecordHomeSpace integer
Iniciar modelo
 RecordInitiateTemplate string

ID exclusivo do modelo de fluxo de trabalho
Está em anexo
 RecordIsEnclosed boolean
Jurisdiction
 RecordJurisdictions string
Data da última ação
 RecordLastActionDate date-time
Registo da Última Parte
 RecordLastPartRecord integer
Versão mais recente
 RecordLatestVersion integer
Número expandido
 RecordLongNumber string
Número de registo
 RecordNumber string
Data de destruição manual
 RecordManualDestructionDate date-time
Registo de Matéria
 RecordMatterRecord integer
Tipo de mídia
 RecordMediaType string
Reunião
 RecordMeeting integer
Tipo de mímica
 RecordMimeType string
Meus comentários de autorização
 RecordMyAuthorizationComments string
Minha Autorização Concluída
 RecordMyAuthorizationComplete boolean
Os meus comentários
 RecordMyReviewComments string
Minha avaliação concluída
 RecordMyReviewComplete boolean
Número de páginas?
 RecordNbrPages integer
Precisa de autorização?
 RecordNeedsAuthorization boolean
Precisa de revisão?
 RecordNeedsReview boolean
Nova Regra de Criação de Peças
 RecordNewPartCreationRule string

ID exclusivo da regra de criação de peças automáticas
Gravação da próxima parte
 RecordNextPartRecord integer
Tipo de atualização do Notes
 NotesUpdateType string
Observações
 RecordNotes string
Originário de
 RecordOriginatedFrom string
Originado de Run
 RecordOriginatedFromRun string
Outros Contactos
 RecordOtherContact integer
Localização do Proprietário
 RecordOwnerLocation integer
Hierarquia do servidor na entrada de dados?
 RecordPreserveHierarchyOnDataEntry boolean
Registo da Parte Anterior
 RecordPrevPartRecord integer
Contacto Primário
 RecordPrimaryContact integer
Priority
 RecordPriority string
Tipo de registo
 RecordRecordType integer
Registo relacionado
 RecordRelatedRecord integer
Representante
 RecordRepresentative integer
Cronograma de retenção
 RecordRetentionSchedule integer
Data de revisão
 RecordReviewDate date-time
Data de vencimento da revisão
 RecordReviewDueDate date-time
Estado da revisão
 RecordReviewState string
Registro de peça raiz
 RecordRootPartRecord integer
Segurança
 RecordSecurity string
Série Record
 RecordSeriesRecord integer
Title
 RecordTitle string
Título (Parte Texto Livre)
 RecordTypedTitle string
Identificador Exclusivo
 Uri integer
Campos Adicionais
 Fields object

CMEventData

Name 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 exclusivo do objeto
 ObjectUri integer
ID do tipo de objeto relacionado
 RelatedObjectType integer
Tipo de objeto relacionado
 RelatedObjectTypeString string
ID exclusivo do objeto relacionado
 RelatedObjectUri integer
Da máquina
 FromMachine string
Endereço IP de conexão
 ConnectionIPAddress string
Endereço IP do Cliente
 ClientIPAddress string
Do Fuso Horário
 FromTimeZone integer
Nome de login
 LoginName string
ID Único de Login
 LoginUri integer
Detalhes Adicionais
 ExtraDetails string

CMLogMessage

Name Caminho Tipo Description
Mensagem de registo
 LogMessage string
Pesquisar por
 TrimType CMTrimType
Identificador Exclusivo
 Uri integer

CMRecordsResponse

Name Caminho Tipo Description
Results
 Results array of CMRecord
UpdateErrorResults
 UpdateErrorResults array of CMUpdateErrorResponse
Resultados totais
 TotalResults integer
Contar String Ex
 CountStringEx string
Contagem mínima
 MinimumCount integer
Contar
 Count integer
Tem mais itens
 HasMoreItems boolean
Pesquisar Título
 SearchTitle string
Hit Realçar String
 HitHighlightString string
Pesquisar por
 TrimType CMTrimType
Estado da resposta
 ResponseStatus CMResponseStatus

Estado da resposta

CMLogResponse

Name Caminho Tipo Description
Results
 Results array of CMLogMessage
UpdateErrorResults
 UpdateErrorResults array of CMUpdateErrorResponse
Resultados totais
 TotalResults integer
Contar String Ex
 CountStringEx string
Contagem mínima
 MinimumCount integer
Contar
 Count integer
Tem mais itens
 HasMoreItems boolean
Pesquisar Título
 SearchTitle string
Hit Realçar String
 HitHighlightString string
Pesquisar por
 TrimType CMTrimType
Estado da resposta
 ResponseStatus CMResponseStatus

Estado da resposta

CMUpdateErrorResponse

Resposta de erro de atualização

Name Caminho Tipo Description
Código de Erro
 ErrorCode string
Identificador Exclusivo
 Uri integer
Message
 Message string
Nome
 Name string
Nome (Extra)
 NameExtra string

CMResponseStatus

Estado da resposta

Name 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 dicionário,String<>

CMResponseError

Erro de resposta

Name Caminho Tipo Description
Código de Erro
 ErrorCode string
Nome do campo
 FieldName string
Message
 Message string
Meta
 Meta object

Cadeia de dicionário,String<>

CMTrimType

Pesquisar por
string

CMLocação

Name Caminho Tipo Description
Identificador Exclusivo
 Uri integer
Nome
 NameString string
Localização Nome Formatado Completo
 LocationFullFormattedName string
Nome da classificação de local
 LocationSortName string

CMBob

Name Caminho Tipo Description
Identificador Exclusivo
 Uri integer
Nome
 NameString string

CMLocationsResponse

Name Caminho Tipo Description
Results
 Results array of CMLocation

Results
UpdateErrorResults
 UpdateErrorResults array of CMUpdateErrorResponse
Resultados totais
 TotalResults integer
Contar String Ex
 CountStringEx string
Contagem mínima
 MinimumCount integer
Contar
 Count integer
Tem mais itens
 HasMoreItems boolean
Pesquisar Título
 SearchTitle string
Hit Realçar String
 HitHighlightString string
Pesquisar por
 TrimType CMTrimType
Estado da resposta
 ResponseStatus CMResponseStatus

Estado da resposta

CMBobResponse

Name Caminho Tipo Description
Results
 Results array of CMBob

Results
UpdateErrorResults
 UpdateErrorResults array of CMUpdateErrorResponse
Resultados totais
 TotalResults integer
Contar String Ex
 CountStringEx string
Contagem mínima
 MinimumCount integer
Contar
 Count integer
Tem mais itens
 HasMoreItems boolean
Pesquisar Título
 SearchTitle string
Hit Realçar String
 HitHighlightString string
Pesquisar por
 TrimType CMTrimType
Estado da resposta
 ResponseStatus CMResponseStatus

Estado da resposta

GetFileFromUrlResponse

Resposta do plug-in 'GetFileFromUrl' CM Service API.

Name Caminho Tipo Description
Caminho do arquivo
 Filepath string

Caminho do arquivo local para o arquivo baixado da URL.
Message
 Message string

CMLocationAddressUri

Name Caminho Tipo Description
ID Único
 Uri integer

binário

Este é o tipo de dados básico 'binário'.

objecto

Este é o tipo 'objeto'.