GoFileRoom
O GoFileRoom é uma solução de fluxo de trabalho e gerenciamento de documentos baseado em nuvem. Com o conector GoFileRoom, você pode executar ações de documento, gerenciamento de usuário e FirmFlow.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | 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 | Standard | 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 | Standard | 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 | Suporte ao GoFileRoom |
| URL | https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact |
| CS.Support@ThomsonReuters.com |
| Metadados do conector | |
|---|---|
| Publicador | Thomson Reuters |
| Site | https://www.gofileroom.com/ |
| Política de privacidade | https://www.thomsonreuters.com/en/privacy-statement.html |
| Categorias | Dados; Gestão de empresas |
O GoFileRoom Connector fornece uma maneira fácil para os clientes da Thomson Reuters utilizarem as API's para GoFileRoom e FirmFlow. Os usuários podem criar automação e integração relacionadas ao Gerenciamento de Usuários, Documentos ou FirmFlow.
Pré-requisitos
Os usuários devem ter uma chave de API GoFileRoom para usar o conector.
Como obter credenciais?
A chave de API pode ser obtida registrando-se para uma conta em https://developerportal.thomsonreuters.com/. Além disso, você precisará ter uma conta ativa do GoFileRoom. Se você estiver interessado no GoFileRoom, entre em contato conosco aqui: https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
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 |
|---|---|---|---|
| X-TR-API-APP-ID | secureString | O X-TR-API-APP-ID para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Acompanhamento de relatório por entrega V2 |
Acompanhamento de relatório por DeliverableV2 |
| Acompanhamento de relatório por fluxo de trabalho |
Acompanhamento de relatório por fluxo de trabalho |
| Adicionar Entrega Mestra |
Adicionar Entrega Mestra |
| Copiar Documento |
Copia os documentos |
| Criar Documento |
Cria um registro de documento com índices |
| Criar fluxo de trabalho |
Criar fluxo de trabalho |
| Criar Grupo |
Cria um grupo de permissões |
| Criar Usuários |
Cria usuários do GoFileRoom e clientFlow no sistema |
| Definir permissões de grupo |
Atribui permissão ao grupo |
| Definir permissões de usuário |
Atribui permissão ao usuário |
| Definir segurança de documento de grupo |
Atribui segurança de documento a um grupo |
| Definir segurança do documento de usuário |
Atribui permissões de segurança de documento do usuário |
| Documento taxsort |
Documento PDF do Taxsort |
| Editar Entrega Mestra |
Editar Entrega Mestra |
| Editar Fluxo de Trabalho |
Editar Fluxo de Trabalho |
| Entrar |
Registra um usuário no aplicativo |
| Excluir Documento |
Exclui um documento |
| Excluir Entrega Mestra |
Excluir Entrega Mestra |
| Excluir fluxos de trabalho |
Excluir fluxos de trabalho |
| Excluir usuário |
Excluir usuários de GoFileRoom e ClientFlow do Sistema |
| Fluxo de Trabalho de Rota V2 |
Fluxo de Trabalho de Rota V2 |
| Localização da Lista de Pesquisa de Índice |
Esse método foi projetado para uso com campos de preenchimento automático. |
| Logout |
Logoff do aplicativo |
| Mesclar PDF's |
Mesclar arquivos PDF em conjunto |
| Modificar Grupo |
Modificar permissões de grupo |
| Modificar Usuário |
Modificar permissões de usuário |
|
Obter dados do Firm |
Obtém o relatório de acompanhamento por dados que podem ser entregues |
| Obter Documento |
Baixa o documento |
| Obter Entrega Mestra |
Obter Entrega Mestra |
| Obter gavetas |
Busca as gavetas acessíveis para o usuário conectado |
| Obter grupos |
Busca os grupos disponíveis para gerenciamento de usuários e grupos |
| Obter histórico de documentos |
Obtém o histórico do documento |
| Obter informações do usuário |
Busca as informações do usuário do GFR |
| Obter informações do usuário V2 |
Obtém a inserção do usuário |
| Obter licenças |
Recupera contagens de licenciamento |
| Obter lista de relatórios |
Busca os relatórios disponíveis para o gerenciamento de usuários |
| Obter lista de valores de índice |
Obtém todas as entradas de um índice de tipo de lista |
| Obter locais de carregamento |
Busca os locais de upload para o usuário |
| Obter permissões de grupo |
Obtém permissões de grupos |
| Obter permissões de usuário |
Obtém permissões de usuário |
| Obter política de senha |
Busca a política de senha para a empresa |
| Obter regras dinâmicas para índice |
Obtém a lista de regras dinâmicas configuradas para o índice especificado |
| Obter segurança do documento de grupo |
Recuperar a segurança do documento de grupo |
| Obter segurança do documento do usuário |
Busca a segurança do documento do usuário por logon |
| Obter status do documento |
Obter o status dos documentos |
| Obter usuários |
Busca os usuários GFR para o usuário conectado |
|
Obter valores de Lookup |
Busca os valores da LookupList |
| Obter índices de documento |
Recupera os índices do documento |
| Obter índices de gaveta |
Recupera uma lista de índices de documentos configurados para a gaveta |
| Obter índices filho |
Obtém uma lista de valores de índice filho com base na ID da lista, que é fornecida quando o valor da lista pai é selecionado. |
| Pesquisa de Documentos |
Carrega todos os documentos aos quais o usuário tem acesso na gaveta especificada. |
| Publicar Status do Documento |
Publicar ou cancelar a publicação de documentos do ClientFlow. |
| Reindex do documento |
Reindexa os documentos |
| Validar Token |
Validar o status do token |
| Validar índices |
Verifica se os índices fornecidos são válidos. |
Acompanhamento de relatório por entrega V2
Acompanhamento de relatório por DeliverableV2
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
ID da gaveta
|
DrawerId | string |
ID da gaveta |
|
|
Tipo de Serviço
|
ServiceType | string |
Tipo de Serviço |
|
|
Tipo de participação
|
EngagementType | string |
Tipo de participação |
|
|
Workflow
|
Workflow | string |
Workflow |
|
|
Etapa Atual
|
CurrentStep | string |
Etapa Atual |
|
|
PIC
|
PIC | string |
PIC |
|
|
Atribuído a
|
AssignedTo | string |
Atribuído a |
|
|
Atribuído em
|
AssignedOn | string |
Atribuído em |
|
|
Descrição do fluxo de trabalho
|
WorkflowDescription | string |
Descrição do fluxo de trabalho |
|
|
Somente em processo
|
InProcessOnly | string |
Somente em processo |
|
|
Situação
|
Status | string |
Situação |
|
|
Priority
|
Priority | string |
Priority |
|
|
Recebido em
|
ReceivedOn | string |
Recebido em |
|
|
Data de conclusão
|
CompletedOn | string |
Data de conclusão |
|
|
Enviado em
|
SentOn | string |
Enviado em |
|
|
Responsável
|
Responsible | string |
Responsável |
|
|
Histórico de atribuições
|
AssignmentHistory | string |
Histórico de atribuições |
|
|
Recebido de
|
ReceivedFrom | string |
Recebido de |
|
|
Enviado a
|
SentTo | string |
Enviado a |
|
|
Concluído por
|
CompletedBy | string |
Concluído por |
|
|
Responsável
|
Accountable | string |
Responsável |
|
|
Data de conclusão atual
|
CurrentDueDate | string |
Data de conclusão atual |
|
|
Data de conclusão original
|
OriginalDueDate | string |
Data de conclusão original |
|
|
Data Estendida
|
DateExtended | string |
Data Estendida |
|
|
Dias em etapa
|
DaysAtStep | string |
Dias em etapa |
|
|
Total de dias em etapa
|
TotalDaysAtStep | string |
Total de dias em etapa |
|
|
Dias entre roteamentos
|
DaysBetweenRoutings | string |
Dias entre roteamentos |
|
|
Total de dias em processo
|
TotalDaysInProcess | string |
Total de dias em processo |
|
|
Detalhes de roteamento
|
RoutingDetails | string |
Detalhes de roteamento |
|
|
Última Atualização
|
LastUpdated | string |
Última Atualização |
|
|
Campos de Informações
|
InformationFields | array of string |
Campos de Informações |
|
|
Indexes
|
Indexes | array of string |
Indexes |
|
|
Número da Página
|
PageNumber | string |
Número da Página |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Total de registros
|
totalRecords | integer |
Total de registros |
|
Número da Página
|
pageNumber | string |
Número da Página |
|
Tamanho da Página
|
pageSize | integer |
Tamanho da Página |
|
Total de Páginas
|
totalPages | integer |
Total de Páginas |
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
Nome do cliente
|
firmFlowReportResponse.clientName | string |
Nome do cliente |
|
Número do cliente
|
firmFlowReportResponse.clientNumber | string |
Número do cliente |
|
ID da gaveta
|
firmFlowReportResponse.drawerId | string |
ID da gaveta |
|
Tipo de Serviço
|
firmFlowReportResponse.serviceType | string |
Tipo de Serviço |
|
Tipo de participação
|
firmFlowReportResponse.engagementType | string |
Tipo de participação |
|
Workflow
|
firmFlowReportResponse.workflow | string |
Workflow |
|
Etapa Atual
|
firmFlowReportResponse.currentStep | string |
Etapa Atual |
|
PIC
|
firmFlowReportResponse.pic | string |
PIC |
|
Atribuído a
|
firmFlowReportResponse.assignedTo | string |
Atribuído a |
|
Atribuído em
|
firmFlowReportResponse.assignedOn | string |
Atribuído em |
|
Ano
|
firmFlowReportResponse.year | string |
Ano |
|
Término do Período
|
firmFlowReportResponse.periodEnd | string |
Término do Período |
|
Descrição do fluxo de trabalho
|
firmFlowReportResponse.workflowDescription | string |
Descrição do fluxo de trabalho |
|
Progress
|
firmFlowReportResponse.progress | string |
Progress |
|
Situação
|
firmFlowReportResponse.status | string |
Situação |
|
Priority
|
firmFlowReportResponse.priority | string |
Priority |
|
eFile Sim ou Não
|
firmFlowReportResponse.eFileYesOrNo | string |
eFile Sim ou Não |
|
Estendido sim ou não
|
firmFlowReportResponse.extendedYesOrNo | string |
Estendido sim ou não |
|
Recebido em
|
firmFlowReportResponse.receivedOn | string |
Recebido em |
|
Data de conclusão
|
firmFlowReportResponse.completedOn | string |
Data de conclusão |
|
Enviado em
|
firmFlowReportResponse.sentOn | string |
Enviado em |
|
Entregáveis
|
firmFlowReportResponse.deliverables | string |
Entregáveis |
|
Responsável
|
firmFlowReportResponse.responsible | string |
Responsável |
|
Histórico de atribuições
|
firmFlowReportResponse.assignmentHistory | string |
Histórico de atribuições |
|
Recebido de
|
firmFlowReportResponse.receivedFrom | string |
Recebido de |
|
Enviado a
|
firmFlowReportResponse.sentTo | string |
Enviado a |
|
Concluído por
|
firmFlowReportResponse.completedBy | string |
Concluído por |
|
Responsável
|
firmFlowReportResponse.accountable | string |
Responsável |
|
Data de conclusão atual
|
firmFlowReportResponse.currentDueDate | string |
Data de conclusão atual |
|
Data de conclusão original
|
firmFlowReportResponse.originalDueDate | string |
Data de conclusão original |
|
Notas de roteamento
|
firmFlowReportResponse.routingNotes | string |
Notas de roteamento |
|
PIC Sim ou Não
|
firmFlowReportResponse.picYesOrNo | string |
PIC Sim ou Não |
|
Atribuído a sim ou não
|
firmFlowReportResponse.assignedToYesOrNo | string |
Atribuído a sim ou não |
|
Data Estendida
|
firmFlowReportResponse.dateExtended | string |
Data Estendida |
|
Dias em etapa
|
firmFlowReportResponse.daysAtStep | string |
Dias em etapa |
|
Total de dias em etapa
|
firmFlowReportResponse.totalDaysAtStep | string |
Total de dias em etapa |
|
Dias entre roteamentos
|
firmFlowReportResponse.daysBetweenRoutings | string |
Dias entre roteamentos |
|
Total de dias em processo
|
firmFlowReportResponse.totalDaysInProcess | string |
Total de dias em processo |
|
ID da pasta
|
firmFlowReportResponse.folderID | string |
ID da pasta |
|
ID de arquivamento
|
firmFlowReportResponse.filingID | string |
ID de arquivamento |
|
ID de arquivamento anterior
|
firmFlowReportResponse.priorFilingID | string |
ID de arquivamento anterior |
|
Última Atualização
|
firmFlowReportResponse.lastUpdated | string |
Última Atualização |
|
informationFields
|
firmFlowReportResponse.informationFields | array of object |
informationFields |
|
nome
|
firmFlowReportResponse.informationFields.name | string |
nome |
|
value
|
firmFlowReportResponse.informationFields.value | string |
value |
|
routingSummary
|
firmFlowReportResponse.routingSummary | array of |
routingSummary |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
Obter exceção de FirmFlow
|
getFirmFlowException | string |
Obter exceção de FirmFlow |
Acompanhamento de relatório por fluxo de trabalho
Acompanhamento de relatório por fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
ID da gaveta
|
DrawerId | string |
ID da gaveta |
|
|
Tipo de Serviço
|
ServiceType | string |
Tipo de Serviço |
|
|
Tipo de participação
|
EngagementType | string |
Tipo de participação |
|
|
Workflow
|
Workflow | string |
Workflow |
|
|
Etapa Atual
|
CurrentStep | string |
Etapa Atual |
|
|
PIC
|
PIC | string |
PIC |
|
|
Atribuído a
|
AssignedTo | string |
Atribuído a |
|
|
Atribuído em
|
AssignedOn | string |
Atribuído em |
|
|
Descrição do fluxo de trabalho
|
WorkflowDescription | string |
Descrição do fluxo de trabalho |
|
|
Somente em processo
|
InProcessOnly | string |
Somente em processo |
|
|
Situação
|
Status | string |
Situação |
|
|
Priority
|
Priority | string |
Priority |
|
|
Responsável
|
Responsible | string |
Responsável |
|
|
Histórico de atribuições
|
AssignmentHistory | string |
Histórico de atribuições |
|
|
Recebido de
|
ReceivedFrom | string |
Recebido de |
|
|
Recebido em
|
ReceivedOn | string |
Recebido em |
|
|
Enviado a
|
SentTo | string |
Enviado a |
|
|
Enviado em
|
SentOn | string |
Enviado em |
|
|
Concluído por
|
CompletedBy | string |
Concluído por |
|
|
Data de conclusão
|
CompletedOn | string |
Data de conclusão |
|
|
Data de conclusão atual
|
CurrentDueDate | string |
Data de conclusão atual |
|
|
Dias em etapa
|
DaysAtStep | string |
Dias em etapa |
|
|
Total de dias em etapa
|
TotalDaysAtStep | string |
Total de dias em etapa |
|
|
Dias entre roteamentos
|
DaysBetweenRoutings | string |
Dias entre roteamentos |
|
|
Total de dias em processo
|
TotalDaysInProcess | string |
Total de dias em processo |
|
|
Responsável
|
Accountable | string |
Responsável |
|
|
Detalhes de roteamento
|
RoutingDetails | string |
Detalhes de roteamento |
|
|
Última Atualização
|
LastUpdated | string |
Última Atualização |
|
|
Campos de Informações
|
InformationFields | array of string |
Campos de Informações |
|
|
Indexes
|
Indexes | array of string |
Indexes |
|
|
Número da Página
|
PageNumber | string |
Número da Página |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Total de registros
|
totalRecords | integer |
Total de registros |
|
Número da Página
|
pageNumber | string |
Número da Página |
|
Tamanho da Página
|
pageSize | integer |
Tamanho da Página |
|
Total de Páginas
|
totalPages | integer |
Total de Páginas |
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
Nome do cliente
|
firmFlowReportResponse.clientName | string |
Nome do cliente |
|
Número do cliente
|
firmFlowReportResponse.clientNumber | string |
Número do cliente |
|
ID da gaveta
|
firmFlowReportResponse.drawerId | string |
ID da gaveta |
|
Tipo de Serviço
|
firmFlowReportResponse.serviceType | string |
Tipo de Serviço |
|
Tipo de participação
|
firmFlowReportResponse.engagementType | string |
Tipo de participação |
|
Workflow
|
firmFlowReportResponse.workflow | string |
Workflow |
|
Etapa Atual
|
firmFlowReportResponse.currentStep | string |
Etapa Atual |
|
PIC
|
firmFlowReportResponse.pic | string |
PIC |
|
Atribuído a
|
firmFlowReportResponse.assignedTo | string |
Atribuído a |
|
Atribuído em
|
firmFlowReportResponse.assignedOn | string |
Atribuído em |
|
Ano
|
firmFlowReportResponse.year | string |
Ano |
|
Término do Período
|
firmFlowReportResponse.periodEnd | string |
Término do Período |
|
Descrição do fluxo de trabalho
|
firmFlowReportResponse.workflowDescription | string |
Descrição do fluxo de trabalho |
|
Progress
|
firmFlowReportResponse.progress | string |
Progress |
|
Situação
|
firmFlowReportResponse.status | string |
Situação |
|
Priority
|
firmFlowReportResponse.priority | string |
Priority |
|
eFile Sim ou Não
|
firmFlowReportResponse.eFileYesOrNo | string |
eFile Sim ou Não |
|
Estendido sim ou não
|
firmFlowReportResponse.extendedYesOrNo | string |
Estendido sim ou não |
|
Recebido em
|
firmFlowReportResponse.receivedOn | string |
Recebido em |
|
Data de conclusão
|
firmFlowReportResponse.completedOn | string |
Data de conclusão |
|
Enviado em
|
firmFlowReportResponse.sentOn | string |
Enviado em |
|
Entregáveis
|
firmFlowReportResponse.deliverables | string |
Entregáveis |
|
Responsável
|
firmFlowReportResponse.responsible | string |
Responsável |
|
Histórico de atribuições
|
firmFlowReportResponse.assignmentHistory | string |
Histórico de atribuições |
|
Recebido de
|
firmFlowReportResponse.receivedFrom | string |
Recebido de |
|
Enviado a
|
firmFlowReportResponse.sentTo | string |
Enviado a |
|
Concluído por
|
firmFlowReportResponse.completedBy | string |
Concluído por |
|
Responsável
|
firmFlowReportResponse.accountable | string |
Responsável |
|
Data de conclusão atual
|
firmFlowReportResponse.currentDueDate | string |
Data de conclusão atual |
|
Data de conclusão original
|
firmFlowReportResponse.originalDueDate | string |
Data de conclusão original |
|
Notas de roteamento
|
firmFlowReportResponse.routingNotes | string |
Notas de roteamento |
|
PIC Sim ou Não
|
firmFlowReportResponse.picYesOrNo | string |
PIC Sim ou Não |
|
Atribuído a sim ou não
|
firmFlowReportResponse.assignedToYesOrNo | string |
Atribuído a sim ou não |
|
Data Estendida
|
firmFlowReportResponse.dateExtended | string |
Data Estendida |
|
Dias em etapa
|
firmFlowReportResponse.daysAtStep | string |
Dias em etapa |
|
Total de dias em etapa
|
firmFlowReportResponse.totalDaysAtStep | string |
Total de dias em etapa |
|
Dias entre roteamentos
|
firmFlowReportResponse.daysBetweenRoutings | string |
Dias entre roteamentos |
|
Total de dias em processo
|
firmFlowReportResponse.totalDaysInProcess | string |
Total de dias em processo |
|
ID da pasta
|
firmFlowReportResponse.folderID | string |
ID da pasta |
|
ID de arquivamento
|
firmFlowReportResponse.filingID | string |
ID de arquivamento |
|
Fluxo de trabalho última atualização
|
firmFlowReportResponse.workflowLastUpdated | string |
Fluxo de trabalho última atualização |
|
informationFields
|
firmFlowReportResponse.informationFields | array of object |
informationFields |
|
nome
|
firmFlowReportResponse.informationFields.name | string |
nome |
|
value
|
firmFlowReportResponse.informationFields.value | string |
value |
|
routingSummary
|
firmFlowReportResponse.routingSummary | array of |
routingSummary |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
Obter exceção de FirmFlow
|
getFirmFlowException | string |
Obter exceção de FirmFlow |
Adicionar Entrega Mestra
Adicionar Entrega Mestra
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome de entrega
|
deliverableName | string |
Nome de entrega |
|
|
Data de vencimento
|
dueDate | string |
Data de vencimento |
|
|
Primeira extensão
|
firstExtension | string |
Primeira extensão |
|
|
Segunda extensão
|
secondExtension | string |
Segunda extensão |
|
|
Terceira extensão
|
thirdExtension | string |
Terceira extensão |
|
|
Calendário ou fiscal
|
calenderOrFiscal | string |
Calendário ou fiscal |
|
|
Extension
|
extension | integer |
Extension |
|
|
Tipo de Serviço
|
ServiceType | string |
Tipo de Serviço |
|
|
Nome da Gaveta
|
DrawerName | string |
Nome da Gaveta |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
É salvo
|
isSaved | boolean |
É salvo |
|
Mensagem de resposta
|
responseMessage | string |
Mensagem de resposta |
Copiar Documento
Copia os documentos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
DocumentIds
|
DocumentIds | array of string |
DocumentIds |
|
|
IndexId
|
IndexId | string |
Inserir ID de Índice |
|
|
IndexValue
|
IndexValue | string |
Insira o valor do índice |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
copyDocumentException
|
copyDocumentException | string |
copiar exceção de documento |
|
documentId
|
documentId | string |
valor da ID do documento |
|
isCopied
|
isCopied | boolean |
O documento foi copiado |
|
newDocumentId
|
newDocumentId | string |
nova ID do documento |
Criar Documento
Cria um registro de documento com índices
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
DrawerId
|
DrawerId | string |
Inserir ID da Gaveta |
|
|
IndexId
|
IndexId | string |
Inserir ID de Índice |
|
|
IndexValue
|
IndexValue | string |
Insira o valor do índice |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
documentId
|
documentCreate.documentId | string |
valor da ID do documento |
|
errorMessage
|
documentCreate.errorMessage | string |
mensagem de erro |
|
errorMessage
|
indexValidation.errorMessage | string |
mensagem de erro |
|
Erros
|
indexValidation.errors | array of |
Erros |
|
isValid
|
indexValidation.isValid | boolean |
é um documento válido |
Criar fluxo de trabalho
Criar fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome da Gaveta
|
Drawer | string |
Nome da Gaveta |
|
|
Tipo de Serviço
|
ServiceType | string |
Tipo de Serviço |
|
|
ID da pasta
|
folderId | string |
ID da pasta |
|
|
Nome do cliente
|
ClientName | string |
Nome do cliente |
|
|
Número do cliente
|
ClientNumber | string |
Número do cliente |
|
|
Tipo de participação
|
EngagementType | string |
Tipo de participação |
|
|
PIC
|
PIC | string |
PIC |
|
|
Ano
|
Year | string |
Ano |
|
|
Término do Período
|
PeriodEnd | string |
Término do Período |
|
|
Nome do fluxo de trabalho
|
workflowName | string |
Nome do fluxo de trabalho |
|
|
Description
|
description | True | string |
Description |
|
Nome do Status
|
statusName | string |
Nome do Status |
|
|
Ação de entrega
|
action | string |
Ação de entrega |
|
|
Data de conclusão atual
|
currentduedate | string |
Data de conclusão atual |
|
|
Data de conclusão original
|
originalduedate | string |
Data de conclusão original |
|
|
Formulário de entrega
|
form | string |
Formulário de entrega |
|
|
Método de entrega
|
Delivery | string |
Método de entrega |
|
|
Destino
|
Destination | string |
Destino |
|
|
Documento de origem
|
sourceDocument | string |
Documento de origem |
|
|
Ação de Observação
|
action | string |
Ação de Observação |
|
|
Tipo de Observação
|
noteType | string |
Tipo de Observação |
|
|
Mensagem de Observação
|
note | string |
Mensagem de Observação |
|
|
Nome do campo de informações
|
name | string |
Nome do campo de informações |
|
|
Valor do campo de informações
|
value | string |
Valor do campo de informações |
|
|
Campo Responsável
|
ResponsibleField | string |
Campo Responsável |
|
|
Valor do campo responsável
|
value | string |
Valor do campo responsável |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de arquivamento
|
filingId | integer |
ID de arquivamento |
|
Comentário de erro
|
errorComment | string |
Comentário de erro |
|
Situação
|
status | boolean |
Situação |
|
errorMessage
|
errorMessage | array of string |
errorMessage |
Criar Grupo
Cria um grupo de permissões
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
AccessToApproveDocsOnly
|
AccessToApproveDocsOnly | string |
Especificar true ou false |
|
|
AllowAccessToReports
|
AllowAccessToReports | string |
Especificar true ou false |
|
|
Comments
|
Comments | string |
Inserir Comentários |
|
|
EnableMfa
|
EnableMfa | string |
Especificar true ou false |
|
|
EnforceMfaForUsers
|
EnforceMfaForUsers | string |
Especificar true ou false |
|
|
FirmFlowRoutingNotification
|
FirmFlowRoutingNotification | string |
Especificar true ou false |
|
|
FullAccessToDocTracking
|
FullAccessToDocTracking | string |
Especificar true ou false |
|
|
GroupName
|
GroupName | string |
Inserir Nome do Grupo |
|
|
MfaRequired
|
MfaRequired | string |
Especificar true ou false |
|
|
PermissonToApproveDocs
|
PermissonToApproveDocs | string |
Especificar true ou false |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Especificar true ou false |
|
|
IsDenyAll
|
IsDenyAll | string |
Especificar true ou false |
|
|
ReportType
|
ReportType | string |
Especificar true ou false |
|
|
UploadLocation
|
UploadLocation | string |
Insira o local de carregamento |
|
|
Usuários
|
Users | array of string |
Usuários |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
createGroupException
|
createGroupException | string |
criar exceção de grupo |
|
groupId
|
groupId | string |
valor da ID do grupo |
|
isCreated
|
isCreated | boolean |
O grupo foi criado |
|
mfaException
|
mfaException | string |
status mfa |
Criar Usuários
Cria usuários do GoFileRoom e clientFlow no sistema
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de Usuário
|
userType | string |
Inserir Tipo de Usuário |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
AccountExpiresDate
|
AccountExpiresDate | string |
Data de expiração da conta de inserção |
|
|
DisabledComments
|
DisabledComments | string |
Inserir comentários desabilitados |
|
|
Nome Completo
|
FullName | string |
Nome completo do usuário |
|
|
Groups
|
Groups | array of string |
Groups |
|
|
IsAccountExpires
|
IsAccountExpires | string |
Especificar true ou false |
|
|
IsAdvanceFlow
|
IsAdvanceFlow | string |
Especificar true ou false |
|
|
IsAllowAccessToReports
|
IsAllowAccessToReports | string |
Especificar true ou false |
|
|
IsAllowOffline
|
IsAllowOffline | string |
Especificar true ou false |
|
|
Desabilitado
|
IsDisabled | string |
Especificar true ou false |
|
|
IsFirmFlow
|
IsFirmFlow | string |
Especificar true ou false |
|
|
IsFirmFlowNotificationGroup
|
IsFirmFlowNotificationGroup | string |
Especificar true ou false |
|
|
IsFirmFlowNotificationUser
|
IsFirmFlowNotificationUser | string |
Especificar true ou false |
|
|
IsMfa
|
IsMfa | string |
Especificar true ou false |
|
|
IsUserAdministration
|
IsUserAdministration | string |
Especificar true ou false |
|
|
IsWorkflowManagerUser
|
IsWorkflowManagerUser | string |
Especificar true ou false |
|
|
LicenseType
|
LicenseType | string |
Inserir tipo de licença |
|
|
Nome de Usuário
|
LoginName | string |
Inserir Nome de Logon |
|
|
ManagerEmail
|
ManagerEmail | string |
Inserir Email do Gerenciador |
|
|
Senha
|
Password | string |
Inserir Senha |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Especificar true ou false |
|
|
IsDenyAll
|
IsDenyAll | string |
Especificar true ou false |
|
|
ReportType
|
ReportType | string |
Especificar true ou false |
|
|
UploadLocation
|
UploadLocation | string |
Insira o local de carregamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
createUserException
|
createUserException | string |
criar exceção de usuário |
|
isCreated
|
isCreated | boolean |
O usuário foi criado |
|
mfaException
|
mfaException | string |
Exceção mfa |
|
userId
|
userId | string |
valor da ID do usuário |
Definir permissões de grupo
Atribui permissão ao grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Armário
|
Cabinet | string |
Inserir Nome do Gabinete |
|
|
Adicionar
|
Add | string |
Especificar true ou false |
|
|
Delete
|
Delete | string |
Especificar true ou false |
|
|
Deny
|
Deny | string |
Especificar true ou false |
|
|
Edit
|
Edit | string |
Especificar true ou false |
|
|
LookUp
|
LookUp | string |
Especificar true ou false |
|
|
Leitura
|
Read | string |
Especificar true ou false |
|
|
Gaveta
|
Drawer | string |
Inserir Nome da Gaveta |
|
|
Adicionar
|
Add | string |
Especificar true ou false |
|
|
Delete
|
Delete | string |
Especificar true ou false |
|
|
Deny
|
Deny | string |
Especificar true ou false |
|
|
Edit
|
Edit | string |
Especificar true ou false |
|
|
LookUp
|
LookUp | string |
Especificar true ou false |
|
|
Leitura
|
Read | string |
Especificar true ou false |
|
|
GroupName
|
GroupName | string |
Inserir Nome do Grupo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
groupId
|
groupId | string |
valor da ID do grupo |
|
groupPermissionException
|
groupPermissionException | string |
Exceção de permissão de grupo |
|
isSet
|
isSet | boolean |
As permissões foram aplicadas |
Definir permissões de usuário
Atribui permissão ao usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Armário
|
Cabinet | string |
Inserir Nome do Gabinete |
|
|
Adicionar
|
Add | string |
Especificar true ou false |
|
|
Delete
|
Delete | string |
Especificar true ou false |
|
|
Deny
|
Deny | string |
Especificar true ou false |
|
|
Edit
|
Edit | string |
Especificar true ou false |
|
|
LookUp
|
LookUp | string |
Especificar true ou false |
|
|
Leitura
|
Read | string |
Especificar true ou false |
|
|
Gaveta
|
Drawer | string |
Inserir Nome da Gaveta |
|
|
Adicionar
|
Add | string |
Especificar true ou false |
|
|
Delete
|
Delete | string |
Especificar true ou false |
|
|
Deny
|
Deny | string |
Especificar true ou false |
|
|
Edit
|
Edit | string |
Especificar true ou false |
|
|
LookUp
|
LookUp | string |
Especificar true ou false |
|
|
Leitura
|
Read | string |
Especificar true ou false |
|
|
LoginId
|
LoginId | string |
Inserir ID de Logon |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
isSetUserPermission
|
isSetUserPermission | boolean |
Atualização da Permissão do Usuário |
|
loginId
|
loginId | string |
Valor da ID de logon |
|
setUserPermissionException
|
setUserPermissionException | string |
definir exceção de permissão de usuário |
Definir segurança de documento de grupo
Atribui segurança de documento a um grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
CabinetName
|
CabinetName | string |
Insira o nome do gabinete |
|
|
DocSecurityType
|
DocSecurityType | string |
Inserir tipo de segurança de documento |
|
|
IndexName
|
IndexName | string |
Insira o nome do índice |
|
|
Operation
|
Operation | string |
Inserir o tipo de operação |
|
|
Valores
|
Values | array of string |
Valores |
|
|
DrawerName
|
DrawerName | string |
Insira o nome da gaveta |
|
|
GroupName
|
GroupName | string |
Inserir o Nome do Grupo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
groupName
|
groupName | string |
Valor do Nome do Grupo |
|
isSetGroupDocSecurity
|
isSetGroupDocSecurity | boolean |
A Segurança do Documento foi definida |
|
setGroupDocSecurityException
|
setGroupDocSecurityException | string |
Exceção de segurança do documento de grupo |
Definir segurança do documento de usuário
Atribui permissões de segurança de documento do usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
CabinetName
|
CabinetName | string |
Inserir Nome do Gabinete |
|
|
DocSecurityType
|
DocSecurityType | string |
Inserir tipo de segurança de documento |
|
|
IndexName
|
IndexName | string |
Insira o nome do índice |
|
|
Operation
|
Operation | string |
Inserir Operação |
|
|
Valores
|
Values | array of string |
Valores |
|
|
DrawerName
|
DrawerName | string |
Inserir Nome da Gaveta |
|
|
LoginId
|
LoginId | string |
Inserir ID de Logon |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
isSetUserDocSecurity
|
isSetUserDocSecurity | boolean |
A Segurança do Documento de Usuário foi aplicada |
|
loginId
|
loginId | string |
Valor da ID de logon |
|
setUserDocSecurityException
|
setUserDocSecurityException | string |
definir exceção de segurança do User Doc |
Documento taxsort
Documento PDF do Taxsort
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
body
|
body | array of string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
valor da ID do documento |
|
isTaxSorted
|
isTaxSorted | boolean |
É o documento TaxSorted |
|
taxsortDocumentException
|
taxsortDocumentException | string |
Exceção de documento taxsort |
Editar Entrega Mestra
Editar Entrega Mestra
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome atual da entrega
|
currentdeliverableName | string |
Nome atual da entrega |
|
|
Atualizar o nome do resultado da entrega
|
updatedeliverableName | string |
Atualizar o nome do resultado da entrega |
|
|
Data de vencimento
|
dueDate | string |
Data de vencimento |
|
|
Primeira extensão
|
firstExtension | string |
Primeira extensão |
|
|
Segunda extensão
|
secondExtension | string |
Segunda extensão |
|
|
Terceira extensão
|
thirdExtension | string |
Terceira extensão |
|
|
Calendário ou fiscal
|
calenderOrFiscal | string |
Calendário ou fiscal |
|
|
Extension
|
extension | integer |
Extension |
|
|
Tipo de Serviço
|
serviceType | string |
Tipo de Serviço |
|
|
Nome da Gaveta
|
drawerName | string |
Nome da Gaveta |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status da atualização
|
isUpdated | boolean |
Status da atualização |
|
Mensagem de resposta
|
responseMessage | string |
Mensagem de resposta |
Editar Fluxo de Trabalho
Editar Fluxo de Trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
ID de arquivamento
|
filingId | integer |
ID de arquivamento |
|
|
Nome do cliente
|
ClientName | string |
Nome do cliente |
|
|
Número do cliente
|
ClientNumber | string |
Número do cliente |
|
|
Tipo de participação
|
EngagementType | string |
Tipo de participação |
|
|
PIC
|
PIC | string |
PIC |
|
|
Ano
|
Year | string |
Ano |
|
|
Término do Período
|
PeriodEnd | string |
Término do Período |
|
|
Nome de entrega
|
action | string |
Nome de entrega |
|
|
Data de conclusão atual
|
currentduedate | string |
Data de conclusão atual |
|
|
Data de conclusão original
|
originalduedate | string |
Data de conclusão original |
|
|
Anexo
|
form | string |
Anexo |
|
|
Ação de Observação
|
action | string |
Ação de Observação |
|
|
Tipo de Observação
|
noteType | string |
Tipo de Observação |
|
|
noteid
|
noteid | array of string |
noteid |
|
|
Mensagem de Observação
|
note | string |
Mensagem de Observação |
|
|
Nome do campo de informações
|
name | string |
Nome do campo de informações |
|
|
Valor do campo de informações
|
value | string |
Valor do campo de informações |
|
|
Método de entrega
|
Delivery | string |
Método de entrega |
|
|
Destino
|
Destination | string |
Destino |
|
|
Documento de origem
|
sourceDocument | string |
Documento de origem |
|
|
Campo Responsável
|
responsibleField | string |
Campo Responsável |
|
|
Atribuído a
|
value | string |
Atribuído a |
|
|
Documentos reindex
|
reindexDocs | boolean |
Documentos reindex |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de arquivamento
|
filingId | integer |
ID de arquivamento |
|
Comentário de erro
|
errorComment | string |
Comentário de erro |
|
Situação
|
status | boolean |
Situação |
|
errorMessage
|
errorMessage | array of object |
errorMessage |
|
Nome
|
errorMessage.name | string |
Nome |
|
Situação
|
errorMessage.status | boolean |
Situação |
|
Comentário de erro
|
errorMessage.errorComment | string |
Comentário de erro |
Entrar
Registra um usuário no aplicativo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome de Usuário
|
LoginName | True | string |
Inserir Nome de Logon |
|
Senha
|
Password | True | password |
Inserir Senha |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
authSuccess
|
authSuccess | boolean |
foi autenticação bem-sucedida |
|
authenticationResponse
|
authenticationResponse | string |
valor da resposta de autenticação |
|
customerId
|
customerId | string |
valor da ID do cliente |
|
código de erro
|
errorCode | string |
valor do código de erro |
|
idleSessionTimeoutMinutes
|
idleSessionTimeoutMinutes | integer |
Minutos de tempo limite da sessão ociosa |
|
loneStarFirmId
|
loneStarFirmId | string |
ID da empresa lone Star |
|
loneStarValidated
|
loneStarValidated | boolean |
Estrela solitária Validada |
|
símbolo
|
token | string |
valor do token |
|
userId
|
userId | string |
valor da ID do usuário |
|
userName
|
userName | string |
valor do nome de usuário |
Excluir Documento
Exclui um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Inserir ID do Documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
deleteDocumentException
|
deleteDocumentException | string |
excluir exceção de documento |
|
documentId
|
documentId | string |
valor da ID do documento |
|
isDeleted
|
isDeleted | boolean |
é o documento excluído |
Excluir Entrega Mestra
Excluir Entrega Mestra
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Tipo de Serviço
|
ServiceType | string |
Tipo de Serviço |
|
|
Nome da Gaveta
|
DrawerName | string |
Nome da Gaveta |
|
|
DeliverableNames
|
DeliverableNames | array of string |
DeliverableNames |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Excluir Status
|
isDeleted | boolean |
Excluir Status |
|
Mensagem de resposta
|
responseMessage | string |
Mensagem de resposta |
Excluir fluxos de trabalho
Excluir fluxos de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
filingId
|
filingId | array of integer |
filingId |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status Excluído
|
isDeleted | boolean |
Status Excluído |
|
ID de arquivamento
|
filingId | string |
ID de arquivamento |
Excluir usuário
Excluir usuários de GoFileRoom e ClientFlow do Sistema
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
LoginId
|
LoginId | string |
Insira a ID de logon do usuário |
|
|
Tipo de Usuário
|
UserType | string |
Insira o tipo de usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
deleteUserException
|
deleteUserException | string |
excluir exceção de usuário |
|
isDeleted
|
isDeleted | boolean |
O logon foi excluído |
|
loginId
|
loginId | string |
Valor da ID de logon |
Fluxo de Trabalho de Rota V2
Fluxo de Trabalho de Rota V2
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
filingId
|
filingId | array of integer |
filingId |
|
|
CurrentStep
|
CurrentStep | array of string |
CurrentStep |
|
|
Concluir
|
Complete | boolean |
Concluir |
|
|
Data concluída
|
CompletedDate | string |
Data concluída |
|
|
Próxima Etapa
|
NextStep | string |
Próxima Etapa |
|
|
Atribuído a
|
AssignedTo | string |
Atribuído a |
|
|
Data Atribuída
|
AssignedDate | string |
Data Atribuída |
|
|
Priority
|
Priority | string |
Priority |
|
|
Situação
|
Status | string |
Situação |
|
|
Anotação de roteamento
|
RoutingNote | string |
Anotação de roteamento |
|
|
Notificação por email
|
emailNotify | boolean |
Notificação por email |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de arquivamento
|
filingId | string |
ID de arquivamento |
|
É roteado
|
isRouted | boolean |
É roteado |
Localização da Lista de Pesquisa de Índice
Esse método foi projetado para uso com campos de preenchimento automático.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IndexID
|
indexId | True | string |
Insira a ID do índice |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Tipo de Ação
|
ActionType | integer |
Inserir tipo de ação |
|
|
Contagem
|
Count | integer |
Inserir Contagem |
|
|
IndexValue
|
IndexValue | string |
Insira o valor do índice |
|
|
Tipo de pesquisa
|
SearchType | integer |
Inserir Tipo de Pesquisa |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
indexId
|
index.indexId | string |
valor da ID do índice |
|
indexValue
|
index.indexValue | string |
Valor do índice |
|
linkedIndexes
|
linkedIndexes | array of object |
linkedIndexes |
|
indexId
|
linkedIndexes.indexId | string |
indexId |
|
indexValue
|
linkedIndexes.indexValue | string |
indexValue |
Logout
Logoff do aplicativo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
isLogoutSuccess
|
isLogoutSuccess | boolean |
O logoff foi bem-sucedido |
Mesclar PDF's
Mesclar arquivos PDF em conjunto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
body
|
body | array of string |
Retornos
- response
- string
Modificar Grupo
Modificar permissões de grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
AccessToApproveDocsOnly
|
AccessToApproveDocsOnly | string |
Especificar true ou false |
|
|
AllowAccessToReports
|
AllowAccessToReports | string |
Especificar true ou false |
|
|
Comments
|
Comments | string |
Inserir Comentários |
|
|
EnableMfa
|
EnableMfa | string |
Especificar true ou false |
|
|
EnforceMfaForUsers
|
EnforceMfaForUsers | string |
Especificar true ou false |
|
|
FirmFlowRoutingNotification
|
FirmFlowRoutingNotification | string |
Especificar true ou false |
|
|
FullAccessToDocTracking
|
FullAccessToDocTracking | string |
Especificar true ou false |
|
|
GroupName
|
GroupName | string |
Inserir Nome do Grupo |
|
|
MfaRequired
|
MfaRequired | string |
Especificar true ou false |
|
|
PermissonToApproveDocs
|
PermissonToApproveDocs | string |
Especificar true ou false |
|
|
RenameGroup
|
RenameGroup | string |
Inserir novo nome de grupo |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Especificar true ou false |
|
|
IsDenyAll
|
IsDenyAll | string |
Especificar true ou false |
|
|
ReportType
|
ReportType | string |
Especificar true ou false |
|
|
UploadLocation
|
UploadLocation | string |
Insira o local de carregamento |
|
|
Usuários
|
Users | array of string |
Usuários |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
groupId
|
groupId | string |
valor da ID do grupo |
|
isModified
|
isModified | boolean |
O grupo foi modificado |
|
mfaException
|
mfaException | string |
Exceção mfa |
|
modifyGroupException
|
modifyGroupException | string |
modificar exceção de grupo |
Modificar Usuário
Modificar permissões de usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de Usuário
|
userType | string |
Inserir Tipo de Usuário |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
AccountExpiresDate
|
AccountExpiresDate | string |
Data em que a conta expirará |
|
|
DisabledComments
|
DisabledComments | string |
Inserir Comentários |
|
|
Nome Completo
|
FullName | string |
Inserir Nome Completo |
|
|
Groups
|
Groups | array of string |
Groups |
|
|
IsAccountExpires
|
IsAccountExpires | string |
Especificar true ou false |
|
|
IsAdvanceFlow
|
IsAdvanceFlow | string |
Especificar true ou false |
|
|
IsAllowAccessToReports
|
IsAllowAccessToReports | string |
Especificar true ou false |
|
|
IsAllowOffline
|
IsAllowOffline | string |
Especificar true ou false |
|
|
IsChangeNextLogin
|
IsChangeNextLogin | string |
Especificar true ou false |
|
|
Desabilitado
|
IsDisabled | string |
Especificar true ou false |
|
|
IsFirmFlow
|
IsFirmFlow | string |
Especificar true ou false |
|
|
IsFirmFlowNotificationGroup
|
IsFirmFlowNotificationGroup | string |
Especificar true ou false |
|
|
IsFirmFlowNotificationUser
|
IsFirmFlowNotificationUser | string |
Especificar true ou false |
|
|
IsMfa
|
IsMfa | string |
Especificar true ou false |
|
|
IsUserAdministration
|
IsUserAdministration | string |
Especificar true ou false |
|
|
IsWorkflowManagerUser
|
IsWorkflowManagerUser | string |
Especificar true ou false |
|
|
LicenseType
|
LicenseType | string |
Inserir tipo de licença |
|
|
Nome de Usuário
|
LoginName | string |
Inserir Nome de Logon |
|
|
ManagerEmail
|
ManagerEmail | string |
Inserir Email do Gerenciador |
|
|
Senha
|
Password | string |
Inserir Senha |
|
|
Allow
|
Allow | array of string |
Allow |
|
|
Deny
|
Deny | array of string |
Deny |
|
|
IsAllowAll
|
IsAllowAll | string |
Especificar true ou false |
|
|
IsDenyAll
|
IsDenyAll | string |
Especificar true ou false |
|
|
ReportType
|
ReportType | string |
Especificar true ou false |
|
|
UploadLocation
|
UploadLocation | string |
Insira o local de carregamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
isModified
|
isModified | boolean |
O usuário foi modificado |
|
mfaException
|
mfaException | string |
Exceção mfa |
|
modifyUserException
|
modifyUserException | string |
modificar exceção de usuário |
|
userId
|
userId | string |
valor da ID do usuário |
Obter dados do FirmFlow por entrega
Obtém o relatório de acompanhamento por dados que podem ser entregues
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Responsável
|
Accountable | string |
Insira o valor responsável |
|
|
AssignedOn
|
AssignedOn | string |
Inserir Atribuído na Data |
|
|
AssignedTo
|
AssignedTo | string |
Inserir o valor Atribuído a |
|
|
AssignmentHistory
|
AssignmentHistory | string |
Inserir Histórico de Atribuições |
|
|
CompletedBy
|
CompletedBy | string |
Insira Concluído por valor |
|
|
CompletedOn
|
CompletedOn | string |
Insira Concluído na Data |
|
|
CurrentDueDate
|
CurrentDueDate | string |
Insira a data de conclusão atual |
|
|
CurrentStep
|
CurrentStep | string |
Insira a etapa atual |
|
|
DateExtended
|
DateExtended | string |
Inserir Data Estendida |
|
|
DaysAtStep
|
DaysAtStep | string |
Inserir dias na etapa |
|
|
DaysBetweenRoutings
|
DaysBetweenRoutings | string |
Inserir dias entre roteamentos |
|
|
DrawerId
|
DrawerId | string |
Inserir ID da Gaveta |
|
|
EngagementType
|
EngagementType | string |
Inserir tipo de compromisso |
|
|
InProcessOnly
|
InProcessOnly | string |
Insira o valor somente no processo |
|
|
Indexes
|
Indexes | array of string |
Indexes |
|
|
Campos de Informações
|
InformationFields | array of string |
Campos de Informações |
|
|
OriginalDueDate
|
OriginalDueDate | string |
Inserir data de conclusão original |
|
|
PIC
|
PIC | string |
Inserir PIC |
|
|
PageNumber
|
PageNumber | string |
Inserir Número de Página |
|
|
Priority
|
Priority | string |
Inserir Prioridade |
|
|
ReceivedFrom
|
ReceivedFrom | string |
Insira o valor recebido de |
|
|
Recebido em
|
ReceivedOn | string |
Inserir Recebido na Data |
|
|
Responsável
|
Responsible | string |
Insira o valor Responsável |
|
|
RoutingDetails
|
RoutingDetails | string |
Inserir detalhes de roteamento |
|
|
SentOn
|
SentOn | string |
Inserir Enviado na Data |
|
|
SentTo
|
SentTo | string |
Insira o valor enviado para |
|
|
ServiceType
|
ServiceType | string |
Inserir tipo de serviço |
|
|
Situação
|
Status | string |
Inserir Status |
|
|
TotalDaysAtStep
|
TotalDaysAtStep | string |
Insira o total de dias na etapa |
|
|
TotalDaysInProcess
|
TotalDaysInProcess | string |
Insira o total de dias em processo |
|
|
Workflow
|
Workflow | string |
Insira o nome do fluxo de trabalho |
|
|
WorkflowDescription
|
WorkflowDescription | string |
Inserir descrição do fluxo de trabalho |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
firmFlowReportResponse
|
firmFlowReportResponse | array of object |
firmFlowReportResponse |
|
responsável
|
firmFlowReportResponse.accountable | string |
valor responsável |
|
assignedOn
|
firmFlowReportResponse.assignedOn | string |
atribuído na data |
|
assignedTo
|
firmFlowReportResponse.assignedTo | string |
atribuído ao valor |
|
assignedToYesOrNo
|
firmFlowReportResponse.assignedToYesOrNo | string |
É o fluxo de trabalho atribuído |
|
assignmentHistory
|
firmFlowReportResponse.assignmentHistory | string |
valor do histórico de atribuições |
|
clientName
|
firmFlowReportResponse.clientName | string |
valor do nome do cliente |
|
clientNumber
|
firmFlowReportResponse.clientNumber | string |
valor do número do cliente |
|
completedBy
|
firmFlowReportResponse.completedBy | string |
concluído por valor |
|
completedOn
|
firmFlowReportResponse.completedOn | string |
concluído na data |
|
currentDueDate
|
firmFlowReportResponse.currentDueDate | string |
Data de conclusão atual |
|
currentStep
|
firmFlowReportResponse.currentStep | string |
valor da etapa atual |
|
dateExtended
|
firmFlowReportResponse.dateExtended | string |
data estendida |
|
daysAtStep
|
firmFlowReportResponse.daysAtStep | string |
dias de fluxo de trabalho na etapa |
|
daysBetweenRoutings
|
firmFlowReportResponse.daysBetweenRoutings | string |
dias de fluxo de trabalho entre roteamentos |
|
Produtos
|
firmFlowReportResponse.deliverables | string |
valor de entrega |
|
drawerId
|
firmFlowReportResponse.drawerId | string |
valor da ID da gaveta |
|
eFileYesOrNo
|
firmFlowReportResponse.eFileYesOrNo | string |
é a entrega a ser eFiled |
|
engagementType
|
firmFlowReportResponse.engagementType | string |
valor do tipo engagement |
|
extendedYesOrNo
|
firmFlowReportResponse.extendedYesOrNo | string |
tem a entrega foi estendida |
|
informationFields
|
firmFlowReportResponse.informationFields | array of object |
informationFields |
|
nome
|
firmFlowReportResponse.informationFields.name | string |
nome |
|
value
|
firmFlowReportResponse.informationFields.value | string |
value |
|
originalDueDate
|
firmFlowReportResponse.originalDueDate | string |
Data de conclusão original |
|
periodEnd
|
firmFlowReportResponse.periodEnd | string |
período Fim do fluxo de trabalho |
|
Pic
|
firmFlowReportResponse.pic | string |
foto do fluxo de trabalho |
|
picYesOrNo
|
firmFlowReportResponse.picYesOrNo | string |
tem a foto foi atribuída |
|
priority
|
firmFlowReportResponse.priority | string |
valor de prioridade |
|
progresso
|
firmFlowReportResponse.progress | string |
valor de progresso |
|
receivedFrom
|
firmFlowReportResponse.receivedFrom | string |
recebido do valor |
|
receivedOn
|
firmFlowReportResponse.receivedOn | string |
recebido na data |
|
responsável
|
firmFlowReportResponse.responsible | string |
valor responsável |
|
responsibleUserOrGroups
|
firmFlowReportResponse.responsibleUserOrGroups | array of |
responsibleUserOrGroups |
|
routingNotes
|
firmFlowReportResponse.routingNotes | string |
roteamento de notas do fluxo de trabalho |
|
routingSummary
|
firmFlowReportResponse.routingSummary | array of |
routingSummary |
|
sentOn
|
firmFlowReportResponse.sentOn | string |
enviado na data |
|
sentTo
|
firmFlowReportResponse.sentTo | string |
enviado para o valor |
|
serviceType
|
firmFlowReportResponse.serviceType | string |
tipo de serviço de fluxo de trabalho |
|
status
|
firmFlowReportResponse.status | string |
status do fluxo de trabalho |
|
totalDaysAtStep
|
firmFlowReportResponse.totalDaysAtStep | string |
fluxo de trabalho total dias em etapa |
|
totalDaysInProcess
|
firmFlowReportResponse.totalDaysInProcess | string |
fluxo de trabalho total dias em processo |
|
fluxo de trabalho
|
firmFlowReportResponse.workflow | string |
tipo de fluxo de trabalho |
|
workflowDescription
|
firmFlowReportResponse.workflowDescription | string |
Descrição do fluxo de trabalho |
|
ano
|
firmFlowReportResponse.year | string |
ano de fluxo de trabalho |
|
getFirmFlowException
|
getFirmFlowException | string |
obter exceção de FirmFlow |
|
pageNumber
|
pageNumber | string |
número de solicitação da página |
|
pageSize
|
pageSize | integer |
tamanho da solicitação da página |
|
totalPages
|
totalPages | integer |
total de páginas de solicitação |
|
totalRecords
|
totalRecords | integer |
total de registros de solicitação |
Obter Documento
Baixa o documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Inserir ID do Documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Obter Entrega Mestra
Obter Entrega Mestra
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Número da Página
|
PageNumber | integer |
Número da Página |
|
|
Tamanho da Página
|
pageSize | integer |
Tamanho da Página |
|
|
Tipo de Serviço
|
ServiceType | string |
Tipo de Serviço |
|
|
Nome da Gaveta
|
DrawerName | string |
Nome da Gaveta |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
deliverableList
|
deliverableList | array of object |
deliverableList |
|
Nome de entrega
|
deliverableList.deliverableName | string |
Nome de entrega |
|
Tipo de extensão
|
deliverableList.extensionType | string |
Tipo de extensão |
|
Data de vencimento
|
deliverableList.dueDate | string |
Data de vencimento |
|
Primeira extensão
|
deliverableList.firstExtension | string |
Primeira extensão |
|
Segunda extensão
|
deliverableList.secondExtension | string |
Segunda extensão |
|
Terceira extensão
|
deliverableList.thirdExtension | string |
Terceira extensão |
|
Extension
|
deliverableList.extension | string |
Extension |
|
Ação
|
deliverableList.action | string |
Ação |
|
ID da obrigação
|
deliverableList.obligationId | string |
ID da obrigação |
|
Opção Gerenciada da Empresa
|
deliverableList.firmManagedOption | string |
Opção Gerenciada da Empresa |
|
Total de registros
|
totalRecords | string |
Total de registros |
|
Mensagem de resposta
|
responseMessage | string |
Mensagem de resposta |
Obter gavetas
Busca as gavetas acessíveis para o usuário conectado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
drawerID
|
drawerID | string |
valor da ID da gaveta |
|
drawerName
|
drawerName | string |
valor do nome da gaveta |
|
adicionar
|
permissions.add | boolean |
adicionar valor |
|
excluir
|
permissions.delete | boolean |
valor de exclusão |
|
edição
|
permissions.edit | boolean |
editar valor |
|
lookupManagement
|
permissions.lookupManagement | boolean |
Valor lookupManagement |
|
exibição
|
permissions.view | boolean |
valor de exibição |
Obter grupos
Busca os grupos disponíveis para gerenciamento de usuários e grupos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
Valor da ID do grupo |
|
mfa
|
mfa | integer |
valor mfa |
|
mfaRequired
|
mfaRequired | integer |
valor necessário de mfa |
|
nome
|
name | string |
Valor do nome do grupo |
Obter histórico de documentos
Obtém o histórico do documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Inserir ID do Documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
documentAudit
|
documentAudit | array of |
documentAudit |
|
documentHistoryException
|
documentHistoryException | string |
Exceção do histórico do documento |
|
documentId
|
documentId | string |
valor da ID do documento |
|
mergeDocHistory
|
mergeDocHistory | array of |
mergeDocHistory |
Obter informações do usuário
Busca as informações do usuário do GFR
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome de Usuário
|
LoginName | True | string |
Insira LoginName |
|
Tipo de Usuário
|
UserType | True | string |
Selecionar UserType |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
data de criação
|
createDate | string |
data de criação |
|
createdBy
|
createdBy | string |
createdBy |
|
descrição
|
description | string |
descrição |
|
desabilitado
|
disabled | integer |
desabilitado |
|
disabledByAdmin
|
disabledByAdmin | boolean |
disabledByAdmin |
|
emailNotify
|
emailNotify | boolean |
emailNotify |
|
emailNotifyEventMgmtGroups
|
emailNotifyEventMgmtGroups | boolean |
emailNotifyEventMgmtGroups |
|
emailNotifyEventMgmtUsers
|
emailNotifyEventMgmtUsers | boolean |
emailNotifyEventMgmtUsers |
|
emailNotifyGroup
|
emailNotifyGroup | boolean |
emailNotifyGroup |
|
forcePasswordChange
|
forcePasswordChange | boolean |
forcePasswordChange |
|
fullName
|
fullName | string |
fullName |
|
hasDrawerSetupRights
|
hasDrawerSetupRights | string |
hasDrawerSetupRights |
|
isAdmin
|
isAdmin | integer |
isAdmin |
|
isManager
|
isManager | integer |
isManager |
|
licenseType
|
licenseType | string |
licenseType |
|
locationID
|
locationID | string |
locationID |
|
loginID
|
loginID | string |
loginID |
|
managerFullName
|
managerFullName | string |
managerFullName |
|
managerId
|
managerId | string |
managerId |
|
managerLoginId
|
managerLoginId | string |
managerLoginId |
|
oberonUser
|
oberonUser | integer |
oberonUser |
|
offline
|
offline | boolean |
offline |
|
passwordChangeDate
|
passwordChangeDate | string |
passwordChangeDate |
|
passwordChangeInterval
|
passwordChangeInterval | integer |
passwordChangeInterval |
|
passwordExpireDate
|
passwordExpireDate | string |
passwordExpireDate |
|
relatórios
|
reports | boolean |
relatórios |
|
assinatura
|
signature | string |
assinatura |
|
systemAdmin
|
systemAdmin | boolean |
systemAdmin |
|
taxFlow
|
taxFlow | boolean |
taxFlow |
|
userAdministration
|
userAdministration | integer |
userAdministration |
|
userID
|
userID | string |
userID |
|
workflowManagerUser
|
workflowManagerUser | boolean |
workflowManagerUser |
Obter informações do usuário V2
Obtém a inserção do usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
Nome do logon
|
LoginName | string |
Nome do logon |
|
|
Tipo de usuário
|
UserType | string |
Tipo de usuário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Usuário
|
userID | string |
ID do Usuário |
|
ID de logon
|
loginID | string |
ID de logon |
|
Nome Completo
|
fullName | string |
Nome Completo |
|
Criar Data
|
createDate | string |
Criar Data |
|
Criado por
|
createdBy | string |
Criado por |
|
Description
|
description | string |
Description |
|
Disabled
|
disabled | integer |
Disabled |
|
Desabilitado por administrador
|
disabledByAdmin | boolean |
Desabilitado por administrador |
|
Data de expiração da senha
|
passwordExpireDate | string |
Data de expiração da senha |
|
Forçar alteração de senha
|
forcePasswordChange | boolean |
Forçar alteração de senha |
|
Data da alteração da senha
|
passwordChangeDate | string |
Data da alteração da senha |
|
Intervalo de alteração de senha
|
passwordChangeInterval | integer |
Intervalo de alteração de senha |
|
Tipo de licença
|
licenseType | string |
Tipo de licença |
|
Offline
|
offline | boolean |
Offline |
|
Reports
|
reports | boolean |
Reports |
|
Administrador do sistema
|
systemAdmin | boolean |
Administrador do sistema |
|
Signature
|
signature | string |
Signature |
|
ID do Local
|
locationID | string |
ID do Local |
|
Tem direitos de instalação de gaveta
|
hasDrawerSetupRights | string |
Tem direitos de instalação de gaveta |
|
Fluxo de Impostos
|
taxFlow | boolean |
Fluxo de Impostos |
|
Notificação por Email
|
emailNotify | boolean |
Notificação por Email |
|
Grupo de Notificação de Email
|
emailNotifyGroup | boolean |
Grupo de Notificação de Email |
|
Notificar usuários do evento mgmt por email
|
emailNotifyEventMgmtUsers | boolean |
Notificar usuários do evento mgmt por email |
|
Notificar grupos mgmt de eventos por email
|
emailNotifyEventMgmtGroups | boolean |
Notificar grupos mgmt de eventos por email |
|
Administração de Usuário do Portal
|
portalUserAdministration | boolean |
Administração de Usuário do Portal |
|
Administração interna do usuário
|
internalUserAdministration | boolean |
Administração interna do usuário |
|
Usuário do Gerenciador de Fluxo de Trabalho
|
workflowManagerUser | boolean |
Usuário do Gerenciador de Fluxo de Trabalho |
|
ID do gerente
|
managerId | string |
ID do gerente |
|
ID de logon do gerenciador
|
managerLoginId | string |
ID de logon do gerenciador |
|
Nome completo do gerenciador
|
managerFullName | string |
Nome completo do gerenciador |
|
É Gerente
|
isManager | integer |
É Gerente |
|
Usuário do Oberon
|
oberonUser | integer |
Usuário do Oberon |
|
É administrador
|
isAdmin | integer |
É administrador |
|
Último Logon
|
lastLogin | string |
Último Logon |
|
groups
|
groups | array of string |
groups |
Obter licenças
Recupera contagens de licenciamento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
LicenseType
|
license | string |
Inserir tipo de licença |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
assignedLicenses
|
assignedLicenses | string |
contagem de licenças atribuída |
|
getLicenseException
|
getLicenseException | string |
obter exceção de licença |
|
licença
|
license | string |
nome da licença |
|
mensagem
|
message | string |
mensagem |
|
totalLicenses
|
totalLicenses | string |
contagem total de licenças |
Obter lista de relatórios
Busca os relatórios disponíveis para o gerenciamento de usuários
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
relatórios
|
reports | array of object |
relatórios |
|
reportName
|
reports.reportName | array of string |
reportName |
|
tipoDeRelatório
|
reports.reportType | string |
valor do tipo de relatório |
|
reportsException
|
reportsException | string |
relatórios valor de exceção |
Obter lista de valores de índice
Obtém todas as entradas de um índice de tipo de lista
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Insira a ID do índice |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
valor da ID do índice filho |
|
childListId
|
childListId | integer |
valor da ID da lista filho |
|
hasChildren
|
hasChildren | boolean |
O índice tem um índice filho |
|
listEntryId
|
listEntryId | integer |
listar o valor da ID da entrada |
|
listId
|
listId | integer |
valor da ID da lista |
|
value
|
value | string |
value |
Obter locais de carregamento
Busca os locais de upload para o usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
uploadLocations
|
uploadLocations | array of object |
uploadLocations |
|
locationName
|
uploadLocations.locationName | string |
valor do nome do local |
|
locationPath
|
uploadLocations.locationPath | string |
valor do caminho de localização |
|
uploadLocationsException
|
uploadLocationsException | string |
Exceção de locais de upload |
Obter permissões de grupo
Obtém permissões de grupos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
GroupName
|
groupName | string |
Inserir Nome do Grupo |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
cabinet
|
cabinet | string |
Nome do gabinete |
|
adicionar
|
cabinetPermissions.add | boolean |
adicionar permissões |
|
excluir
|
cabinetPermissions.delete | boolean |
excluir permissões |
|
deny
|
cabinetPermissions.deny | boolean |
negar permissões |
|
edição
|
cabinetPermissions.edit | boolean |
editar permissões |
|
pesquisa
|
cabinetPermissions.lookUp | boolean |
Permissões de pesquisa |
|
leitura
|
cabinetPermissions.read | boolean |
permissões de leitura |
|
drawerPermissions
|
drawerPermissions | array of object |
drawerPermissions |
|
gaveta
|
drawerPermissions.drawer | string |
Nome da Gaveta |
|
adicionar
|
drawerPermissions.permission.add | boolean |
adicionar permissões |
|
excluir
|
drawerPermissions.permission.delete | boolean |
excluir permissões |
|
deny
|
drawerPermissions.permission.deny | boolean |
negar permissões |
|
edição
|
drawerPermissions.permission.edit | boolean |
editar permissões |
|
pesquisa
|
drawerPermissions.permission.lookUp | boolean |
Permissões de pesquisa |
|
leitura
|
drawerPermissions.permission.read | boolean |
permissões de leitura |
|
groupName
|
groupName | string |
Nome de Grupo |
|
groupPermissionException
|
groupPermissionException | string |
Exceção de permissão de grupo |
Obter permissões de usuário
Obtém permissões de usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Entrar
|
login | True | string |
Insira Logon |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
cabinet
|
cabinet | string |
valor do nome do gabinete |
|
adicionar
|
cabinetPermission.add | boolean |
adicionar valor |
|
excluir
|
cabinetPermission.delete | boolean |
valor de exclusão |
|
deny
|
cabinetPermission.deny | boolean |
negar valor |
|
edição
|
cabinetPermission.edit | boolean |
editar valor |
|
pesquisa
|
cabinetPermission.lookUp | boolean |
Valor de pesquisa |
|
leitura
|
cabinetPermission.read | boolean |
valor de leitura |
|
drawerPermissions
|
drawerPermissions | array of object |
drawerPermissions |
|
gaveta
|
drawerPermissions.drawer | string |
valor do nome da gaveta |
|
adicionar
|
drawerPermissions.permission.add | boolean |
adicionar valor |
|
excluir
|
drawerPermissions.permission.delete | boolean |
valor de exclusão |
|
deny
|
drawerPermissions.permission.deny | boolean |
negar valor |
|
edição
|
drawerPermissions.permission.edit | boolean |
editar valor |
|
pesquisa
|
drawerPermissions.permission.lookUp | boolean |
Valor de pesquisa |
|
leitura
|
drawerPermissions.permission.read | boolean |
valor de leitura |
|
getUserPermissionException
|
getUserPermissionException | string |
Exceção de permissão do usuário |
|
loginId
|
loginId | string |
Valor da ID de logon |
Obter política de senha
Busca a política de senha para a empresa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
clientId
|
passwordPolicy.clientId | string |
valor da ID do cliente |
|
forbidden_pwd_words
|
passwordPolicy.forbidden_pwd_words | array of string |
forbidden_pwd_words |
|
lockout_threshold
|
passwordPolicy.lockout_threshold | integer |
limite de bloqueio |
|
max_length
|
passwordPolicy.max_length | integer |
comprimento máximo da senha |
|
max_login_similarity
|
passwordPolicy.max_login_similarity | string |
similaridade máxima de logon |
|
max_pwd_age
|
passwordPolicy.max_pwd_age | integer |
max pwd age of password |
|
max_repeat_chars
|
passwordPolicy.max_repeat_chars | string |
máximo de caracteres de repetição na senha |
|
max_sequential_chars
|
passwordPolicy.max_sequential_chars | string |
caracteres sequenciais máximos |
|
mfa
|
passwordPolicy.mfa | integer |
valor mfa |
|
min_length
|
passwordPolicy.min_length | integer |
comprimento mínimo da senha |
|
pwd_req_alpha
|
passwordPolicy.pwd_req_alpha | integer |
Requisito de senha alfa |
|
pwd_req_lower
|
passwordPolicy.pwd_req_lower | integer |
Requisito de senha inferior |
|
pwd_req_number
|
passwordPolicy.pwd_req_number | integer |
Requisito de número de senha |
|
pwd_req_symbol
|
passwordPolicy.pwd_req_symbol | integer |
Requisito de senha de símbolo |
|
pwd_req_upper
|
passwordPolicy.pwd_req_upper | integer |
Requisito de senha superior |
|
passwordPolicyException
|
passwordPolicyException | string |
passwordPolicyException |
Obter regras dinâmicas para índice
Obtém a lista de regras dinâmicas configuradas para o índice especificado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Insira a ID do índice |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
condition
|
condition | string |
valor da condição |
|
dependentIndexId
|
dependentIndexId | string |
valor de ID de índice dependente |
|
dynamicRuleId
|
dynamicRuleId | string |
valor da ID da regra dinâmica |
|
value
|
value | string |
value |
Obter segurança do documento de grupo
Recuperar a segurança do documento de grupo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
GroupName
|
groupName | True | string |
Inserir Nome do Grupo |
|
CabinetName
|
cabinetName | True | string |
Inserir Nome do Gabinete |
|
DrawerName
|
drawerName | True | string |
Inserir Nome da Gaveta |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome de Grupo
|
groupName | string |
Nome de Grupo |
|
Nome do gabinete
|
cabinetName | string |
Nome do gabinete |
|
Nome da Gaveta
|
drawerName | string |
Nome da Gaveta |
|
documentSecurity
|
documentSecurity | array of object |
documentSecurity |
|
Nome do índice
|
documentSecurity.indexName | string |
Nome do índice |
|
Tipo de segurança de documento
|
documentSecurity.docSecurityType | string |
Tipo de segurança de documento |
|
values
|
documentSecurity.values | array of string |
values |
|
Exceção de segurança do Group Doc
|
getGroupDocSecurityException | string |
Exceção de segurança do Group Doc |
Obter segurança do documento do usuário
Busca a segurança do documento do usuário por logon
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
LoginId
|
loginId | True | string |
Inserir ID de Logon |
|
CabinetName
|
cabinetName | True | string |
Inserir Nome do Gabinete |
|
DrawerName
|
drawerName | True | string |
Inserir Nome da Gaveta |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
cabinetName
|
cabinetName | string |
Nome do gabinete |
|
documentSecurity
|
documentSecurity | string |
valor de segurança do documento |
|
drawerName
|
drawerName | string |
valor do nome da gaveta |
|
getUserDocSecurityException
|
getUserDocSecurityException | string |
Exceção de segurança do documento de usuário |
|
loginId
|
loginId | string |
Valor da ID de logon |
Obter status do documento
Obter o status dos documentos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
body
|
body | array of string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
valor da ID do documento |
|
documentStatusException
|
documentStatusException | string |
Exceção de status do documento |
|
drawerId
|
drawerId | string |
valor da ID da gaveta |
|
tamanho do arquivo
|
fileSize | string |
valor do tamanho do arquivo |
|
isArchived
|
isArchived | boolean |
é o documento arquivado |
|
isCheckedOut
|
isCheckedOut | boolean |
é o documento check-out |
|
isEncrypted
|
isEncrypted | boolean |
é o documento Criptografado |
|
isFiled
|
isFiled | boolean |
é o documento arquivado |
|
isInRedactionQueue
|
isInRedactionQueue | boolean |
é o documento na fila de redação |
|
isInTaxsortQueue
|
isInTaxsortQueue | boolean |
é o documento na fila taxsort |
|
isLocked
|
isLocked | boolean |
é o documento Bloqueado |
|
isOfficeDocument
|
isOfficeDocument | boolean |
é o documento um documento do Office |
|
isPublished
|
isPublished | boolean |
é o documento Publicado |
|
isUndergoingMerging
|
isUndergoingMerging | boolean |
é o documento que está passando por mesclagem |
|
localFile
|
localFile | string |
é o documento de um arquivo local |
|
noEdit
|
noEdit | boolean |
sem valor editar |
|
Páginas
|
pages | integer |
páginas no documento |
|
revisado
|
reviewed | boolean |
status revisado |
|
taxSort
|
taxSort | boolean |
é o documento taxSorted |
|
tipo
|
type | string |
tipo de arquivo |
|
versão
|
version | integer |
versão do documento |
Obter usuários
Busca os usuários GFR para o usuário conectado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de Usuário
|
userType | string |
Inserir Tipo de Usuário |
|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
isActive
|
isActive | boolean |
É o usuário Ativo |
|
loginId
|
loginId | string |
Valor da ID de logon |
Obter valores de LookupList
Busca os valores da LookupList
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da gaveta. Gaveta de clientes de exemplo: "0000000001"
|
drawerId | True | string |
Inserir ID da Gaveta |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
clientName
|
clientName | string |
valor do nome do cliente |
|
clientNumber
|
clientNumber | string |
valor do número do cliente |
Obter índices de documento
Recupera os índices do documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Inserir ID do Documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
indexId
|
indexId | string |
valor da ID do índice |
|
indexValue
|
indexValue | string |
Valor do índice |
Obter índices de gaveta
Recupera uma lista de índices de documentos configurados para a gaveta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
DrawerId
|
drawerId | True | string |
Inserir ID da Gaveta |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
valor da ID do índice filho |
|
indexId
|
indexId | string |
valor da ID do índice |
|
indexName
|
indexName | string |
valor do nome do índice |
|
indexType
|
indexType | string |
valor do tipo de índice |
|
length
|
length | integer |
Comprimento do índice de gaveta |
|
listId
|
listId | integer |
valor da ID da lista |
|
lookupAutoUpdate
|
lookupAutoUpdate | boolean |
Pesquisa de Atualização Automática |
|
required
|
required | boolean |
É o índice necessário |
Obter índices filho
Obtém uma lista de valores de índice filho com base na ID da lista, que é fornecida quando o valor da lista pai é selecionado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IndexId
|
indexId | True | string |
Insira a ID do índice |
|
ListId
|
listId | True | string |
Inserir ID da Lista |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
childIndexId
|
childIndexId | string |
valor da ID do índice filho |
|
childListId
|
childListId | integer |
valor da ID da lista filho |
|
hasChildren
|
hasChildren | boolean |
O índice tem um índice filho |
|
listEntryId
|
listEntryId | integer |
listar o valor da ID da entrada |
|
listId
|
listId | integer |
valor da ID da lista |
|
value
|
value | string |
value |
Pesquisa de Documentos
Carrega todos os documentos aos quais o usuário tem acesso na gaveta especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
DrawerId
|
DrawerId | string |
Inserir ID da Gaveta |
|
|
IndexId
|
IndexId | string |
Inserir ID de Índice |
|
|
IndexValue
|
IndexValue | string |
Insira o valor do índice |
|
|
NumberOfRows
|
NumberOfRows | integer |
Inserir número de linhas |
|
|
PageNumber
|
PageNumber | integer |
Inserir Número de Página |
|
|
SortField
|
SortField | string |
Inserir Campo de Classificação |
|
|
SortOrder
|
SortOrder | string |
Inserir Ordem de Classificação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
documentIds
|
documentIds | array of string |
documentIds |
|
documentSearchCount
|
documentSearchCount | integer |
Contagem de pesquisa de documentos |
Publicar Status do Documento
Publicar ou cancelar a publicação de documentos do ClientFlow.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
DocumentId
|
documentId | True | string |
Inserir ID do Documento |
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
IsPublished
|
IsPublished | True | string |
Especificar true ou false |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentException
|
documentException | string |
Exceção do documento |
|
documentId
|
documentId | string |
valor da ID do documento |
|
isPublished
|
isPublished | boolean |
é o documento Publicado |
Reindex do documento
Reindexa os documentos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
DocumentIds
|
DocumentIds | array of string |
DocumentIds |
|
|
IndexId
|
IndexId | string |
Inserir ID de Índice |
|
|
IndexValue
|
IndexValue | string |
Insira o valor do índice |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
documentId
|
documentId | string |
valor da ID do documento |
|
isReIndexed
|
isReIndexed | boolean |
é o documento ReIndexed |
|
reIndexDocumentException
|
reIndexDocumentException | string |
Exceção de documento reIndex |
Validar Token
Validar o status do token
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
Retornos
- response
- boolean
Validar índices
Verifica se os índices fornecidos são válidos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
X-Authorization | string |
Autenticação de token |
|
|
DrawerId
|
DrawerId | string |
Inserir ID da Gaveta |
|
|
IndexId
|
IndexId | string |
Inserir ID de Índice |
|
|
IndexValue
|
IndexValue | string |
Insira o valor do índice |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
errorMessage
|
errorMessage | string |
mensagem de erro |
|
Erros
|
errors | array of |
Erros |
|
isValid
|
isValid | boolean |
é o índice válido |
Definições
cadeia
Esse é o tipo de dados básico 'string'.
boolean
Esse é o tipo de dados básico 'booleano'.