TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 205

changes.mady.by.user Julia Larissa Schultz

Gravado em

comparado com

Nova versão 206

changes.mady.by.user Julia Larissa Schultz

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Para os métodos de update que recebem objetos complexos (DocumentDto, ColleagueDto, GroupDto, etc) é obrigatório passar todos os campos do objeto alterado. Os campos não informados serão substituídos por branco, nulo ou zero, dependendo do seu tipo.

...

Cloak
visibletrue
titleNo quadro 8, é mostrado todos os métodos disponíveis na classe ColleagueService.

createColleague

Cria um usuário.


Método:

createColleague(String username, String password, int companyId, ColleagueDto[] colleagues)


Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagues: usuários.


Retorno: String.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


createColleaguewithDependencies

Cria um usuário com grupos e papéis.


Método:

createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto [] grupos, WorkflowRoleDto[] papeis)


Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagues: usuários.
  • grupos: grupos.
  • papeis: papéis.


Retorno: String.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


getColleague

Retorna um usuário.


Método:

getColleague(String username, String password, int companyId, String colleagueId)


Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.


Retorno: ColleagueDto[].

Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

    • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

    • getColleagueByLogin 

    Retorna o usuário a partir do login.

    Método:

    getColleagueByLogin(String username, String password)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.


    Retorno: ColleagueDto[].

    Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

    • rowId

  • usedSpace

    • getColleagues

    Retorna todos os usuários ativos.


    Método:

    getColleagues(String username, String password, int companyId)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.


    Retorno: ColleagueDto[].

    Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

    • usedSpace

    getColleaguesMail

    Retorna um usuário utilizando um e-mail.


    Método:

    getColleaguesMail(String username, String password, int companyId, String mail)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • mail: e-mail do usuário.


    Retorno: ColleagueDto[].

    Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

    • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

  • volumeId


    • Estrutura de retorno com sucesso

    xml

    getColleagueWithMap

    Retorna uma mensagem informando se o usuário foi criado corretamente.


    Método:

    getColleagueWithMap(String colleagueXML, String username, String password)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • colleagueXML: lista normalizada de documentos.


    Retorno: String.

    getGroups

    Retorna os grupos que o usuário participa.


    Método:

    getGroups(String username, String password, int companyId, String colleagueId)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: GroupDto [].

    Atributos de Retorno:

    • companyId 

    • groupDescription

    • groupId

    getSimpleColleague

    Retorna o usuário.


    Método:

    getSimpleColleague(String username, String password)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.


    Retorno: ColleagueDto[].

    Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

    • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

    • getSummaryColleagues

    Retorna todos os usuários ativos.


    Método:

    getSummaryColleagues(int companyId)


    Parâmetros:

    • companyId: código da empresa.


    Retorno: ColleagueDto[].Atributos de Retorno:

    • active 

    • colleagueId

    • colleagueName

    • companyId

    • maxPrivateSize

    • rowId

    • usedSpace

    removeColleague

    Desativa um usuário.


    Método:

    removeColleague(String username, String password, int companyId, String colleagueId)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    activateColleague

    Ativa um usuário.


    Método:

    activateColleague(String username, String password, int companyId, String colleagueId)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateColleague

    Altera um usuário.


    Método:

    updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagues: usuários.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateColleaguewithDependencies

    Altera um usuário com grupos e papéis.


    Método:

    updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto [] grupos, WorkflowRoleDto[] papeis)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagues: usuários.
    • grupos: grupos.
    • papeis: papéis.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    validateColleagueLogin

    Valida o acesso de um usuário no produto.


    Método:

    validateColleagueLogin(int companyId, String colleagueId, String password)


    Parâmetros:

    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • password: senha do usuário.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    Quadro 8: Métodos da ColleagueService.


    ...

    Cloak
    visibletrue
    titleNo quadro 10, é mostrado todos os métodos disponíveis na classe CustomFieldsService.

    createCustomFields

    Cria um campo customizado.


    Método:

    createCustomFields(String user, String password, int companyId, CustomFieldsDto [] customFieldsDto)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • customFieldsDto: campo customizado que será criado.


    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    getAllCustomField

    Retorna todos os campos customizados.


    Método:

    getAllCustomField(String user, String password, int companyId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.


    Retorno: CustomFieldsDto.

    getAllDocumentCustomField

    Retorna todos os campos customizados de um documento.


    Método:

    getAllDocumentCustomField(String user, String password, int companyId, int documentId, int version)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentId: número do documento.
    • version: versão do documento.


    Retorno: DocumentCustomFieldsDto.

    removeCustomField

    Exclui um campo customizado.


    Método:

    removeCustomField(String user, String password, int companyId, String customFieldsId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • customFieldsId: código do campo customizado.


    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos. 


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    removeDocumentCustomField

    Exclui um campo customizado de um documento.


    Método:

    removeDocumentCustomField(String user, String password, int companyId, String customFieldsId, int documentId, int version)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • customFieldsId: código do campo customizado.
    • documentId: número do documento.
    • version: versão do documento.


    Retorno:

    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos.

    .


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    setDocumentCustomFields

    Cria ou altera um campo customizado em um documento.


    Método:

    setDocumentCustomFields(String user, String password, int companyId, DocumentCustomFieldsDto [] documentCustomFieldsDto)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentCustomFieldsDto: documento com campo customizado.


    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos. 


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateCustomFields

    Altera um campo customizado.


    Método:

    updateCustomFields(String user, String password, int companyId, CustomFieldsDto [] customFieldsDto)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • customFieldsDto: campo customizado que será alterado.


    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos. 


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    Quadro 10: Métodos da CustomFieldsService


    ...

    Cloak
    visibletrue
    titleNo quadro 11, é mostrado todos os métodos disponíveis na classe DashBoardService.

    findMyDocuments

    Retorna os documentos do usuário que precisam ser aprovados.


    Método:

    findMyDocuments(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    findMyDocumentsOnDemand

    Retorna os documentos do usuário que precisam ser aprovados, paginados.


    Método:

    findMyDocumentsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: DocumentDto[].

    findDocumentsToApprove

    Retorna os documentos que o usuário precisa aprovar.


    Método:

    findDocumentsToApprove(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    findDocumentsToApproveOnDemand

    Retorna os documentos que o usuário precisa aprovar, paginados.


    Método:

    findDocumentsToApproveOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: DocumentDto[].

    findAgreementDocuments

    Retorna os documentos do usuário que estão em consenso.


    Método:

    findAgreementDocuments(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    findCheckoutDocuments

    Retorna os documentos do usuário que estão em checkout.


    Método:

    findCheckoutDocuments(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    findCancelledTasks

    Retorna as tarefas atribuidas ao usuário que foram canceladas.


    Método:

    findCancelledTasks(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findCompletedTasks

    Retorna as tarefas atribuidas ao usuário que foram finalizadas.


    Método:

    findCompletedTasks(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findConsensusTasks

    Retorna as tarefas atribuidas ao usuário que estão em consenso.


    Método:

    findConsensusTasks(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findTransferredTasks

    Retorna as tarefas atribuidas ao usuário que foram transferidas.


    Método:

    findTransferredTasks(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findWorkflowTasks

    Retorna as tarefas do usuário que estão abertas.


    Método:

    findWorkflowTasks(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: WorkflowProcessDto[].

    findWorkflowTasksOnDemand

    Retorna as tarefas do usuário que estão abertas, paginadas.


    Método:

    findWorkflowTasksOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.


    Retorno: WorkflowProcessDto[].

    findMyRequests

    Retorna as solicitações abertas que foram inicializadas pelo usuário.


    Método:

    findMyRequests(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findMyRequestsOnDemand

    Retorna as solicitações abertas que foram inicializadas pelo usuário, paginadas.


    Método:

    findMyRequestsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: WorkflowProcessDto[].

    findMyManagerTasks

    Retorna as tarefas gerenciadas pelo usuário.


    Método:

    findMyManagerTasks(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findExpiredWorkflowTasks

    Retorna as tarefas do usuário que estão em atraso


    Método: findExpiredWorkflowTasks(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: WorkflowProcessDto[].

    fillStatusTask

    Retorna a quantidade de tarefas atrasadas, no prazo e sem prazo de um usuário.


    Método:

    fillStatusTask(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: List de int[], com a quantidade de tarefas atrasadas.

    fillChronoTasks

    Retorna a quantidade de tarefas com prazo de conclusão que foram atribuidas atribuídas ao usuário e não foram finalizadas.


    Método:

    fillChronoTasks(String user, String password, int companyId, String colleagueId, int yearIni, int yearFin, int mounthIni, int mounthFin, int dayIni, int dayFin, int kindTask)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • yearIni: ano inicial.
    • yearFin: ano final.
    • mounthIni: mês inicial.
    • mounthFin: mês final.
    • dayIni: dia inicial.
    • dayFin: dia final.
    • kindTask: tipo da tarefa.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: : Lista de int[], com a quantidade de tarefas com prazo de conclusão atribuída ao usuário.

    fillTypeTasks

    Retorna os tipos de tarefas que o usuário possui.


    Método:

    fillTypeTasks(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: TaskVODto[].

    fillTypeTasksOfReplacement

    Retorna os tipos de tarefas que o usuário substituto possui.


    Método:

    fillTypeTasksOfReplacement(String user, String password, int companyId, String colleagueId, String replacementId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • replacementId: matrícula do usuário substituto.


    Retorno: TaskVODto[].

    getOpenTasksByColleagueGroups

    Retorna as tarefas atribuídas a um grupo que o usuário participa.


    Método:

    getOpenTasksByColleagueGroups(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowTaskDto[].

    getOpenTasksByColleagueGroupsOnDemand

    Retorna as tarefas atribuídas a um grupo que o usuário participa, paginadas.


    Método:

    getOpenTasksByColleagueGroupsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: WorkflowTaskDto[].

    getOpenTasksByColleagueRoles

    Retorna as tarefas atribuídas a um papel que o usuário participa.


    Método:

    getOpenTasksByColleagueRoles(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowTaskDto[].

    getOpenTasksByColleagueRolesOnDemand

    Retorna as tarefas atribuidas atribuídas a um papel workflow que o usuário participa, paginadas.


    Método:

    getOpenTasksByColleagueRolesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: WorkflowTaskDto[].

    getSummaryRequests

    Retorna os contadores de pendências da Home.


    Método:

    getSummaryRequests(int companyId, String user, String password, String colleagueId)


    Parâmetros:

    • companyId: código da empresa.
    • user: login do usuário.
    • password: senha do usuário.
    • colleagueId: matrícula do usuário.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: HomeRequestSummaryDto[].

    getUrlEcm

    Retorna a url do servidor.


    Método:

    getUrlEcm(long companyId)


    Parâmetros:

    • companyId: código da empresa.

    Retorno: String , com a url da empresa. 

    Quadro 11: Métodos da ECMDashBoardService


    ...