TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 165

changes.mady.by.user Leandro Carlos Pereira

Gravado em

comparado com

Nova versão 166

changes.mady.by.user Andressa Aparecida De Souza Heck

Gravado em

Chave

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

...

Webservice responsável por realizar operações referentes a formulários no fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar formulários, entre outras funcionalidadesoutros recursos.

 

Métodos

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

create

Cria um formulário.

 

Método:

create(int companyId, String user, String password, CardDto[] carddtos)

 

Parâmetros:

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

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


deleteCard

Exclui um formulário e envia para a lixeira.

 

Método:

deleteCard(int companyId, String user, String password, int cardId)

 

Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • cardId: número do formulário.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


getCardVersion

Retorna a versão de um formulário.

 

Método:

getCardVersion(int companyId, String user, String password, int nrDocumentId, int version, String colleagueId)

 

Método:

Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • nrDocumentId: número do formulário.
  • version: versão do formulário.
  • colleagueId: matrícula do usuário.

 

Retorno: CardDto[].

updateCard

Altera os metadados de um formulário.

 

Método:

updateCard(int companyId, String user, String password, CardDto[] cardDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs)

 

Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • cardDtos: formulário que será alterado.
  • attachs: anexos do formulário.
  • docsecurity: segurança do formulário.
  • docapprovers: aprovadores do formulário.
  • reldocs: documentos relacionados do formulário.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateCardData

Altera os campos de um formulário.

 

Método:

updateCardData(int companyId, String user, String password, int cardId, CardFieldDto[] cardData)

 

Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • cardId: número do formulário.
  • cardData: campos do formulário que serão alterados.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 5: Métodos da CardService.


...

Webservice responsável por realizar operações referentes a usuários substitutos no fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar usuários substitutos, entre outras funcionalidadesoutros recursos.

 

Métodos

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

createColleagueReplacement

Cria um substituto.

 

Método:

createColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

 

Parâmetros:

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

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


deleteColleagueReplacement

Exclui o cadastro de um substituto.

 

Método:

deleteColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

 

Parâmetros:

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

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


getColleagueReplacement

Retorna um substituto de um usuário.

 

Método:

getColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

 

Parâmetros:

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

 

Retorno: ColleagueReplacementDto.

 getReplacementsOfUser

 

Retorna todos os substitutos de um usuário.

 

Método:

getReplacementsOfUser(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 origem.

 

Retorno: ColleagueReplacementDto[].

getValidReplacedUsers

Retorna todos os usuário substituídos por um substituto válido.

 

Método:

getValidReplacedUsers(String username, String password, int companyId, String replacementId)

 

Parâmetros:

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

 

Retorno: ColleagueReplacementDto[].

getValidReplacement

Retorna um substituto válido de um usuário.

 

Método:

getValidReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

 

Parâmetros:

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

 

Retorno: ColleagueReplacementDto.

getValidReplacementsOfUser

Retorna todos os substitutos válidos de um usuário.

 

Método:

getValidReplacementsOfUser(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 origem.

 

Retorno: ColleagueReplacementDto[].

updateColleagueReplacement

Altera o cadastro de um substituto.

 

Método:

updateColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

 

Parâmetros:

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

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 7: Métodos da ColleagueReplacementService


...

Webservice responsável por realizar operações referentes a usuários no fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar usuários, entre outras funcionalidadesoutros recursos.

Atenção: Os métodos createColleague, createColleaguewithDependencies, updateColleague e updateColleaguewithDependencies, em um dos seus parâmetros, recebe uma lista de ColleagueDto, nos objetos destas listas  os valores para os campos de senha (password) devem ser criptografados com o algoritmo de hash MD5, exceto no caso de possuir o identity configurado, neste caso a senha deverá ser passada normalmente sem a criptografia.

...

Webservice responsável por realizar operações referentes à empresa no fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas, entre outras funcionalidadesoutros recursos.

 

Métodos

 

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

createCompany

Cria uma empresa no fluig.

 

Método:

createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • description: descrição da empresa.
  • urlAccessName: URL de acesso.
  • phisicalPath: caminho físico.
  • webdeskServer: servidor.
  • webPort: porta.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


delete

Exclui uma empresa do fluig.

 

Método:

delete(String username, String password, String companyId, Boolean deleteFiles)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • deleteFiles: indica se deve excluir o caminho físico.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


getCompanies

Retorna todas as empresas cadastradas no fluig.

 

Método:

getCompanies(String username, String password, String companyId)

 

Parâmetros:

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

 

Retorno: CompanyDto[].

getCompany

Retorna uma empresa cadastrada no fluig.

 

Método:

getCompany(int companyId)

 

Parâmetros:

  • companyId: código da empresa.

 

Retorno: CompanyDto.

updateCompany

Altera uma empresa no fluig.

 

Método:

updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • description: descrição da empresa.
  • urlAccessName: URL de acesso.
  • phisicalPath: caminho físico.
  • webdeskServer: servidor.
  • webPort: porta.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 9: Métodos da CompanyService


...

Webservice responsável por interagir com os campos customizados do fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar campos customizados, entre outras funcionalidadesoutros recursos.

 

Métodos

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.

 

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.

 

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: String.

 

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.

 

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.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 10: Métodos da CustomFieldsService


...

Webservice responsável por realizar operações referentes a documentos do fluig. Pode ser utilizado para criar, alterar, excluir e procurar documentos, entre outras funcionalidadesoutros recursos.

 

Métodos

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

approveDocument

Aprova ou reprova documento pendente de aprovação.

 

Metodo:

approveDocument(int companyId, String userId, String password, int documentId, int version, String approverId, boolean approved, String observation)

 

Parâmetros:

 

  • user: código do usuário de integração.
  • password: senha do usuário de integração.
  • companyId: código da empresa.
  • documentId: código do documento a ser aprovado.
  • version: versão do documento a ser aprovado.
  • approverId: código do aprovador
  • approved: true se aprova o documento e false caso o documento sera reprovado.
  • observation: observação da aprovação ou rejeição.

 

Retorno: WebServiceMessage[]

 

Estrutura de retorno com sucesso

 

Estrutura de retorno com erro


copyDocumentToUploadArea

Copia os arquivos (principal e anexos) de um documento para a area de upload do usuário. Isto permite que os documentos tornem-se acessíveis via FTP.

Método:

copyDocumentToUploadArea(String user, String password, int companyId, int documentId, int version, String colleagueId)

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número do documento que será copiado.
  • version: versão do documento
  • colleagueId: matrícula do usuário cuja área de upload será utilizada

 

Retorno: String[] nome dos arquivos que foram disponibilizados na área de upload

 

Estrutura de retorno com sucesso

 

Estrutura de retorno com erro


createDocument

Cria um documento.

 

Método:

createDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs,  DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docDtos: documento que será publicado (mais detalhes do parâmetro aqui).
  • attachs: arquivo anexado na publicação (mais detalhes do parâmetro aqui).
  • docSecurity: segurança do documento que será publicado  (mais detalhes do parâmetro aqui ).
  • docApprovers: aprovadores do documento que será publicado  (mais detalhes do parâmetro aqui ).
  • relDocs: documentos relacionados ao documento que será publicado  (mais detalhes do parâmetro aqui ).

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


createDocumentWithApprovementLevels

Cria um documento com nível de aprovação.

 

Método:

createDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docSecurity, ApproverWithLevelDto[] docApproversLevels, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docDtos: documento que será publicado.
  • attachs: arquivo anexado na publicação.
  • docSecurity: segurança do documento que será publicado.
  • docApproversLevel: nível de aprovação que os aprovadores do documento estão inseridos.
  • levels: níveis de aprovação que o documento terá.
  • relDocs: documentos relacionados ao documento que será publicado.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


createSimpleDocument

Cria um documento simples.

 

Método:

createSimpleDocument(String user, String password, int company, int parentDocumentId, String publisherId, String documentDescription, Attachment[] attachments)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • parentDocumentId: número da pasta pai.
  • publisherId: matrícula do usuário que publicará o documento.
  • documentDescription: descrição do documento.
  • attachments: arquivo anexado na publicação (para utilização via TDS é necessário instanciar a classe Attachment. Confira um exemplo de utilização em Criação de documento a partir do método createSimpleDocument).

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


createSimpleDocumentPrivate

Cria um documento simples na pasta particular.

 

Método:

createSimpleDocumentPrivate(String colleagueId, String password, int companyId, int parentDocumentId, String documentDescription, Attachment[] attachments)

 

Parâmetros:

  • colleagueId: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • parentDocumentId: número da pasta pai.
  • documentDescription: descrição do documento.
  • attachments: arquivo anexado na publicação.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


deleteDocument

Exclui um documento e o envia para a lixeira.

 

Método:

deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número do documento que será excluído.
  • colleagueId: matrícula do usuário.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


destroyDocument

Exclui um documento da lixeira.

 

Método:

destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número do documento que será excluído.
  • colleagueId: matrícula do usuário.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


destroyDocumentApproval

Exclui documento pendente de aprovação.

 

Metodo:

destroyDocumentApproval(String userId, String password, int companyId, int documentId, String publisherId)

 

Parâmetros:

 

  • user: código do usuário de integração.
  • password: senha do usuário de integração.
  • companyId: código da empresa.
  • documentId: código do documento a excluido.
  • publisherId: código do publicador.

 

Retorno: WebServiceMessage[]

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


findMostPopularDocuments

Retorna os documentos mais acessados no fluig que o usuário tenha permissão de acesso.

 

Método:

findMostPopularDocuments(String user, String password, int companyId, String colleagueId, int nr_resultados)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • nr_resultados: quantidade de documentos que serão retornados.

 

Retorno: DocumentDto[].

 

Atributos de Retorno:

  • accesCount
  • activeVersion
  • additionalComments
  • allowMuiltiCardsPerUser
  • approved
  • colleagueId
  • companyId
  • crc
  • createDate
  • datasetName
  • deleted
  • documentDescription
  • documentId
  • documentType
  • documentTypeId
  • downloadEnabled
  • draft
  • expirationDate
  • expires
  • iconId
  • imutable
  • indexed
  • inheritSecurity
  • isEncrypted
  • keyWord
  • lastModifiedDate
  • metaListId
  • metaListRecordId
  • parentDocumentId
  • permissionType
  • phisicalFile
  • phisicalFileSize
  • privateDocument
  • protectedCopy
  • publisherId
  • restrictionType
  • rowId
  • securityLevel
  • topicId
  • translated
  • UUID
  • updateIsoProperties
  • userNotify
  • validationStartDate
  • version
  • versionDescription
  • volumeId

findMostPopularDocumentsOnDemand

Retorna os documentos mais acessados no fluig que o usuário tenha permissão de acesso, paginados.

 

Método:

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

 

Parâmetros:

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

 

Retorno: DocumentDto[].

 

Atributos de Retorno:

  • accesCount
  • activeVersion
  • additionalComments
  • allowMuiltiCardsPerUser
  • approved
  • colleagueId
  • companyId
  • crc
  • createDate
  • datasetName
  • deleted
  • documentDescription
  • documentId
  • documentType
  • documentTypeId
  • downloadEnabled
  • draft
  • expirationDate
  • expires
  • iconId
  • imutable
  • indexed
  • inheritSecurity
  • isEncrypted
  • keyWord
  • lastModifiedDate
  • metaListId
  • metaListRecordId
  • parentDocumentId
  • permissionType
  • phisicalFile
  • phisicalFileSize
  • privateDocument
  • protectedCopy
  • publisherId
  • restrictionType
  • rowId
  • securityLevel
  • topicId
  • translated
  • UUID
  • updateIsoProperties
  • userNotify
  • validationStartDate
  • version
  • versionDescription
  • volumeId

findRecycledDocuments

Retorna os documentos da lixeira.

 

Método:

findRecycledDocuments(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[].

 

Atributos de Retorno:

  • accesCount
  • activeVersion
  • additionalComments
  • allowMuiltiCardsPerUser
  • approved
  • colleagueId
  • companyId
  • crc
  • createDate
  • datasetName
  • deleted
  • documentDescription
  • documentId
  • documentType
  • documentTypeId
  • downloadEnabled
  • draft
  • expirationDate
  • expires
  • iconId
  • imutable
  • indexed
  • inheritSecurity
  • isEncrypted
  • keyWord
  • lastModifiedDate
  • metaListId
  • metaListRecordId
  • parentDocumentId
  • permissionType
  • phisicalFile
  • phisicalFileSize
  • privateDocument
  • protectedCopy
  • publisherId
  • restrictionType
  • rowId
  • securityLevel
  • topicId
  • translated
  • UUID
  • updateIsoProperties
  • userNotify
  • validationStartDate
  • version
  • versionDescription
  • volumeId

getActiveDocument

Retorna um documento ativo.

 

Método:

getActiveDocument(String user, String password, int companyId, int nrDocumentId, String colleagueId)

 

Parâmetros:

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

 

Retorno: DocumentDto[].

getApprovers

Retorna os aprovadores de um documento.

 

Método:

getApprovers(String user, String password, int companyId, int nrDocumentId, int version)

 

Parâmetros:

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

 

Retorno: ApproverWithLevelDto[].

 

Atributos de Retorno:

  • approverType
  • colleagueId
  • companyId
  • documentId
  • levelId
  • version

getDocumentApprovalHistory

Retorna o histórico de aprovações do documento solicitado.

 

Metodo:

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

 

Parâmetros:

  • user: código do usuário de integração.
  • password: senha do usuário de integração.
  • companyId: código da empresa.
  • documentId: código do documento que se deseja visualizar o status.
  • version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento).

 

Retorno: DocumentApprovementHistoryDto[]

 

Atributos de Retorno:

  • colleagueId
  • documentVersion
  • iterationSequence
  • levelId
  • movementSequence
  • observation
  • signed
  • status

getDocumentApprovalStatus

Retorna o status do documento com relação a aprovação. O status do documento pode ser:

0 - Aprovado.

1 - Rejeitado.

2- Em aprovação.

 

Método:

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

 

Parâmetros:

 

  • user: código do usuário de integração.
  • password: senha do usuário de integração.
  • companyId: código da empresa.
  • documentId: código do documento que se deseja visualizar o status.
  • version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento).

 

Retorno: DocumentApprovalStatusDto[]

 

Atributos de Retorno:

  • companyId
  • documentId
  • status
  • version

getDocumentByExternalId

Retorna um documento pelo código externo.

 

Método:

getDocumentByExternalId(String user, String password, int companyId, String externalDocumentId, String colleagueId)

 

Parâmetros:

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

 

Retorno: DocumentDto[].

getDocumentContent

Retorna o byte do arquivo físico de um documento, caso o usuário tenha permissão para acessá-lo.

 

Método:

getDocumentContent(String user, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String nomeArquivo)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • nrDocumentId: número do documento.
  • colleagueId: matrícula do usuário.
  • documentVersao: número da versão do documento.
  • nomeArquivo: nome do arquivo.

 

Retorno: byte[].

getDocumentVersion

Retorna a versão de um documento.

 

Método:

getDocumentVersion(String user, String password, int companyId, int nrDocumentId, int version, String colleagueId)

 

Parâmetros:

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

 

Retorno: DocumentDto[].

 

Atributos de Retorno:

  • accesCount
  • activeVersion
  • additionalComments
  • allowMuiltiCardsPerUser
  • approved
  • colleagueId
  • companyId
  • crc
  • createDate
  • datasetName
  • deleted
  • documentDescription
  • documentId
  • documentType
  • documentTypeId
  • downloadEnabled
  • draft
  • expirationDate
  • expires
  • iconId
  • imutable
  • indexed
  • inheritSecurity
  • isEncrypted
  • keyWord
  • lastModifiedDate
  • metaListId
  • metaListRecordId
  • parentDocumentId
  • permissionType
  • phisicalFile
  • phisicalFileSize
  • privateDocument
  • protectedCopy
  • publisherId
  • restrictionType
  • rowId
  • securityLevel
  • topicId
  • translated
  • UUID
  • updateIsoProperties
  • userNotify
  • validationStartDate
  • version
  • versionDescription
  • volumeId

getRelatedDocuments

Retorna todos os documentos relacionados de um documento.

 

Método:

getRelatedDocuments(String user, String password, int companyId, int nrDocumentId, int version)

 

Parâmetros:

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

 

Retorno: RelatedDocumentDto[].

 

Atributos de Retorno:

  • companyId
  • documentId
  • relatedDocumentId
  • version

getReportSubjectId

Retorna o código do assunto de relatórios dentro do fluig.

 

Método:

getReportSubjectId(String user, String password, int companyId)

 

Parâmetros:

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

 

Retorno: int.

getSecurity

Retorna a segurança de um documento.

 

Método:

getSecurity(String user, String password, int company, int nrDocumentId, int version)

 

Parâmetros:

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

 

Retorno: DocumentSecurityConfigDto[].

 

Atributos de Retorno:

  • attributionType
  • attributionValue
  • companyId
  • documentId
  • permission
  • securityLevel
  • sequence
  • showContent
  • version

getUserPermissions

Retorna as permissões do usuário sobre um documento.

 

Método:

getUserPermissions(int companyId, String user, int nrDocumentId, int version)

 

Parâmetros:

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

 

Retorno: Integer.

 

Atributos de Retorno:

  • result

moveDocument

Move documentos para pasta destino.

 

Método:

moveDocument(String user, String password, int companyId, int[] documentIds, String colleagueId, int destfolder)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentIds: lista com os números dos documentos que serão movidos.
  • colleagueId: matrícula do usuário com permissão para mover o documento
  • destFolder: número da pasta de destino.

Retorno: String[]

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


removeSecurity

Remove a segurança de um documento.

 

Método:

removeSecurity(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: número da versão do documento.

 

Retorno: Não há retorno.

restoreDocument

Restaura um documento da lixeira.

 

Método:

restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número do documento que será restaurado.
  • colleagueId: matrícula do usuário.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateDocument

Altera um documento.

 

Método:

updateDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs,  DocumentSecurityConfigDto[] docSecurity,ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docDtos: documento que será publicado (mais detalhes do parâmetro aqui).
  • attachs: arquivo anexado na publicação (mais detalhes do parâmetro aqui).
  • docSecurity: segurança do documento que será publicado  (mais detalhes do parâmetro aqui ).
  • docApprovers: aprovadores do documento que será publicado  (mais detalhes do parâmetro aqui ).
  • relDocs: documentos relacionados ao documento que será publicado  (mais detalhes do parâmetro aqui ).

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro

updateDocumentWithApprovementLevels

Altera um documento com nível de aprovação.

 

Métodos:

updateDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecutiry, ApproverWithLevelDto[]  docApprovers, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docDtos: documento que será alterado.
  • attachs: arquivo anexado na alteração.
  • docSecurity: segurança do documento que será alterado.
  • docApprovers: nível de aprovação que os aprovadores do documento estão inseridos.
  • levels: níveis de aprovação que o documento terá.
  • relDocs: documentos relacionados ao documento que será alterado.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateGroupSecurityType

Modifica a tipo da segurança dos grupos na permissão e na restrição. Existem duas opções que são representadas por um inteiro:

0 - TODOS os usuários dos Grupos.

1 - SOMENTE usuários comuns dos grupos.

 

Método:

updateGroupSecurityType(String user, String password, int companyId, int documentId, int version, int permissionType, int restrictionType, String colleagueId)

 

Parâmetros:

  • user: código do usuário de integração.
  • password: senha do usuário de integração.
  • companyId: código da empresa.
  • documentId: código do documento.
  • version: versão do documento.
  • permissionType: tipo da permissão (0 - TODOS os usuários dos Grupos / 1 - SOMENTE usuários comuns dos grupos)
  • restrictionType: tipo da restrição (0 - TODOS os usuários dos Grupos / 1 - SOMENTE usuários comuns dos grupos)
  • colleagueId: matrícula do usuário

 

Retorno: WebServiceMessage[] 

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateSimpleDocument

Altera de forma simples um documento.

 

Método:

updateSimpleDocument(String username, String password, int companyId, int documentId, String publisherId, String documentDescription, Attachment[] attachments)

 

Parâmetros:

  • username: login do usuário de integração.
  • password: senha do usuário de integração.
  • companyId: código da empresa.
  • documentId: número do documento que será alterado.
  • publisherId: matrícula do usuário que realizará a alteração do documento.
  • documentDescription: descrição do documento.
  • attachments: arquivos anexados na alteração.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


validateIntegrationRequirements

Verifica a integração do usuário no fluig.

 

Método:

validateIntegrationRequirements (String user, String password, int companyId)

 

Parâmetros:

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

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 14: Métodos da DocumentService

...

Webservice responsável por realizar operações referentes a pastas no fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar pastas, entre outras funcionalidadesoutros recursos.

 

Métodos

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

createFolder

Cria uma pasta.

 

Método:

createFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers )

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docdtos: pasta que será criada.
  • docsecurity: segurança da pasta.
  • docapprovers: aprovadores da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


createFolderWithApprovementLevels

Cria uma pasta com nível de aprovação.

 

Método:

createFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docdtos: pasta que será criada.
  • docsecurity: segurança da pasta.
  • docapprovers: aprovadores em níveis.
  • levels: níveis de aprovação da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


createSimpleFolder

Cria uma pasta simples.

 

Método:

createSimpleFolder(String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • parentDocumentId: número do documento pai.
  • publisherId: matrícula do usuário publicador.
  • documentDescription: descrição da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


deleteDocument

Exclui uma pasta e envia para a lixeira.

 

Método:

deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

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

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


destroyDocument

Exclui uma pasta da lixeira.

 

Método:

destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

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

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


findRecycledDocuments

Retorna todos os documentos da lixeira de um usuário.

 

Método:

findRecycledDocuments(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[].

getApprovers

Retorna os aprovadores de uma pasta.

 

Método:

getApprovers(String user, String password, int companyId, int nrDocumentId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • nrDocumentId: número da pasta.

 

Retorno: ApproverWithLevelDto[].

getChildren

Retorna todos os documentos de uma pasta.

 

Método:

getChildren(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

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

 

Retorno: DocumentDto[].

getFolder

Retorna uma pasta.

 

Método:

getFolder(String user, String password, int companyId, int nrDocumentId, String colleagueId )

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • nrDocumentId: número da pasta.
  • colleagueId: matrícula do usuário origem.

 

Retorno: DocumentDto[].

getPrivateChildren

Retorna todos os documentos de uma pasta particular.

 

Método:

getPrivateChildren(String user, String password, int companyId, int parentDocumentId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta.

 

Retorno: DocumentDto[].

 

getRootFolders

Retorna as pastas root que um usuário tem acesso, exceto a pasta particular.

 

Método:

getRootFolders(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[].

getSecurity

Retorna a segurança de uma pasta.

 

Método:

getSecurity(String user, String password, int companyId, int nrDocumentId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • nrDocumentId: número da pasta.

 

Retorno: DocumentSecurityConfigDto[].

getSubFolders

Retorna todas as subpastas e arquivos de um pasta.

 

Método:

getSubFolders(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

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

 

Retorno: DocumentDto[].

getSubFoldersOnDemand

Retorna todas as subpastas e arquivos de um pasta, paginados.

 

Método:

getSubFoldersOnDemand(int companyId, String user, String password, int documentId, boolean privatefolder, String[] documenttypes, int limit , int lastRowId, String colleagueId)

 

Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • documentId: número da pasta.
  • privatefolder: identifica se é uma pasta particular.
  • documenttypes: tipos de documentos das pastas.
  • limit: número de registros a serem retornados.
  • lastRowId: última linha retornada.
  • colleagueId: matrícula do usuário.

 

Retorno: DocumentDto[].

getSubFoldersPermission

Retorna todas as subspastas em que o usuário tenha a permissão informada.

 

Método:

getSubFoldersPermission(String user, String password, int companyId, int documentId, String colleagueId, int permission)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta particular.
  • colleagueId: matrícula do usuário.
  • permission: permissão sobre a pasta.

 

Retorno: DocumentDto[].

getSubPrivateFolders

Retorna todas as subpastas de uma pasta particular.

 

Método:

getSubPrivateFolders(String colleagueId, String password, int companyId, int documentId)

 

Parâmetros:

  • colleagueId: matrícula do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta particular.

 

Retorno: DocumentDto[].

getUserPermissions

Retorna a permissão de um usuário sobre uma pasta.

 

Método:

getUserPermissions(int companyId, String user, int nrDocumentId, int version)

 

Parâmetros:

  • companyId: código da empresa.
  • user: matrícula do usuário.
  • nrDocumentId: número da pasta.
  • version: versão da pasta.

 

Retorno: Integer.

restoreDocument

Restaura uma pasta da lixeira.

 

Método:

restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

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

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateFolder

Altera uma pasta.

 

Método:

updateFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docdtos: pasta que será alterada.
  • docsecurity: segurança da pasta.
  • docapprovers: aprovadores da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateFolderWithApprovementLevels

Altera uma pasta com nível de aprovação.

 

Método:

updateFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docdtos: pasta que será alterada.
  • docsecurity: segurança da pasta.
  • docapprovers: aprovadores em níveis.
  • levels: níveis de aprovação da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateSimpleFolder

Altera de forma simples uma pasta.

 

Método:

updateSimpleFolder(String user, String Password, int companyId, DocumentDto[] docdtos)

 

Parâmetros:

  • user: login do usuário
  • password: senha do usuário
  • companyId: código da empresa
  • docdtos: pasta que será alterada.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 16: Métodos da FolderService


...

Webservice responsável por realizar operações referentes a grupos no fluig. Pode ser utilizado para criar, alterar, excluir e procurar grupos, entre outras funcionalidadesoutros recursos.

 

Métodos

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

createGroup

Cria um grupo no fluig.

 

Método:

createGroup(String username, String password, int companyId, GroupDto[] grupos)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • grupos: grupo que será criado.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


deleteGroup

Exclui um grupo do fluig.

 

Método:

deleteGroup(String username, String password, int companyId, String groupId)

 

Parâmetros:

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

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


getGroup

Retorna um grupo cadastrado no fluig.

 

Método:

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

 

Parâmetros:

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

 

Retorno: GroupDto[].

 

Atributos de Retorno:

  • companyId

  • groupDescription

  • groupId

getGroups

Retorna todos os grupos cadastrados no fluig.

 

Método:

getGroups(String username, String password, int companyId)

 

Parâmetros:

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

 

Retorno: GroupDto[].

 

Atributos de Retorno:

  • companyId

  • groupDescription

  • groupId

getGroupsByDescription

Retorna um grupo pela descrição.

 

Método:

getGroupsByDescription(String username, String password, int companyId, String desc)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • desc: descrição do grupo.

 

Retorno: GroupDto[].

 

Atributos de Retorno:

  • companyId

  • groupDescription

  • groupId

getOcurrenceByKey

Retorna se existe configuração de segurança para atribuição e valor da atribuição.

 

Método:

getOcurrenceByKey(String username, String password, int companyId, int pIdiAtribuic, String pDesValAtribuic)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • pIdiAtribuic: código da atribuição.
  • pDesValAtribuic: valor da atribuição.

 

Retorno: boolean.

updateGroup

Altera um grupo no fluig.

 

Método:

updateGroup(String username, String password, int companyId, GroupDto[] grupos)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • grupos: grupo que será alterado.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 18: Métodos da GroupService.


...

 Webservice responsável por realizar operações referentes a relatórios no fluig. Pode ser utilizado para criar, alterar, excluir e procurar relatórios, entre outras funcionalidadesoutros recursos.

 

Métodos

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

createSimpleReport

Cria um relatório de maneira simplificada no fluig.

 

Método:

createSimpleReport(String username, String password, int companyId, int parentDocId, String reportDescription, Attachment[] attachments)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • parentDocId: código da pasta pai.
  • reportDescription: descrição do relatório.
  • attachments: anexos do relatório.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


getActiveReport

Retorna um relatório ativo no fluig.

 

Método:

getActiveReport(int companyId, String username, String password, String documentId)

 

Parâmetros:

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

 

Retorno: DocumentDto.

getAttachmentsList

Retorna uma lista de anexos do relatório no fluig.

 

Método:

getAttachmentsList(String username, String password, int companyId, String documentId)

 

Parâmetros:

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

 

Retorno: String[].

getReportContent

Retorna o arquivo físico de um relatório.

 

Método:

getReportContent(String username, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String fileName)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • nrDocumentId: número do documento.
  • colleagueId: matrícula do usuário.
  • documentoVersao: versão do documento.
  • fileName: nome do arquivo.

 

Retorno: byte[].

getRepots

Retorna os relatórios disponíveis.

 

Método:

getRepots(String username, String password, int companyId)

 

Parâmetros:

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

 

Retorno: DocumentDto[].

updateSimpleReport

Atualiza um relatório de maneira simplificada no fluig.

 

Método:

createSimpleReport(String username, String password, int companyId, int docId, String reportDescription, Attachment[] attachments, String versionOption)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docId: código da pasta pai.
  • reportDescription: descrição do relatório.
  • attachments: anexos do relatório.
  • versionOption: informa se deseja atualizar a versão do relatório.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 20: Métodos da ReportService.


...

Webservice responsável por realizar operações referentes a workflow no fluig. Pode ser utilizado para movimentar solicitações, entre outras funcionalidadesoutros recursos.

 

Métodos

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

calculateDeadLineHours

Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em horas.

 

Método:

calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)

 

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • userId - Matrícula do usuário
  • data - data (Tipo String no formato "yyyy-MM-dd").
  • segundos - Quantidade de segundos após a meia noite
  • prazo - Prazo que será aplicado em horas (Variável int).
  • periodId - Código de Expediente

 

Retorno: Objeto DeadLineDto que contem variáveis com a data e hora.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


calculateDeadLineTime

Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em minutos.

 

Método:

calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)

 

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • userId - Matrícula do usuário
  • data - data (Tipo String no formato "yyyy-MM-dd").
  • segundos - Quantidade de segundos após a meia noite
  • prazo - Prazo que será aplicado em minutos (Variável int).
  • periodId - Código de Expediente

 

Retorno: Objeto DeadLineDto que contem variáveis com a data e hora.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


cancelInstance

Cancela uma solicitação.

 

Método:

cancelInstance(String user, String password, int companyId, int processInstanceId, String userId, String cancelText)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • userId: mátricula do usuário.
  • cancelText: comentários do cancelamento.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


cancelInstanceByReplacement

Cancela uma solicitação utilizando usuário substituto.

 

Método:

cancelInstanceByReplacement(String user, String password, int companyId, int processInstanceId, String userId, String cancelText, String replacementId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • userId: mátricula do usuário.
  • cancelText: comentários do cancelamento.
  • replacementId: matrícula do usuário substituto.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


createWorkFlowProcessVersion

Cria nova versão do processo workflow.

 

Método:

createWorkFlowProcessVersion(String user, String password, int companyId, int processId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: número da solicitação.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


exportProcess

Retorna o processo selecionado em uma String.

 

Método:

exportProcess (String username, String password, int companyId, String processId)

 

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • processId - Código do processo

Retorno: String que contém a definição do processo.

exportProcessInZipFormat

Retorna o processo selecionado no formato zip.

 

Método:

exportProcessInZipFormat(String username, String password, int companyId, String processId)

 

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • processId - Código do processo

Retorno: byte[] que contém a definição do processo.

getActualThread

Retorna a sequência da thread de uma solicitação.

 

Método:

getActualThread(String user, String password, int companyId, int processInstanceId, int stateSequence)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • userId: matrícula do usuário.
  • stateSequence: sequência do estado.

 

Retorno: int.

getAllActiveStates

Retorna o número da atividade em que uma solicitação esta.

 

Método:

getAllActiveStates(String user, String password, int companyId, String userId, int processInstanceId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • userId: matrícula do usuário.
  • processInstanceId: número da solicitação.

 

Retorno: Integer[].

getAllProcessAvailableToExport

Retorna uma lista de processos disponíveis para serem exportados.

 

Método:

getAllProcessAvailableToExport (String username, String password, int companyId)

 

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa

 

Retorno: ProcessDefinitionDto[].

getAllProcessAvailableToImport

Retorna uma lista de processos disponíveis para serem importados.

 

Método:

getAllProcessAvailableToImport (String username, String password, int companyId)

 

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa

 

Retorno: ProcessDefinitionDto[]

getAttachments

Retorna os anexos de uma solicitação.

 

Método:

getAttachments(String user, String password, int companyId, String userId, int processInstanceId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • userId: matrícula do usuário.
  • processInstanceId: número da solicitação.

 

Retorno: ProcessAttachmentDto[].

getAvailableProcess

Retorna os processos que o usuário pode iniciar uma solicitação.

 

Método:

getAvailableProcess(String username, String password, int companyId, String userId)

 

Parâmetros:

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

 

Retorno: ProcessDefinitionVersionDto[].

getAvailableProcessOnDemand

Retorna os processos que o usuário pode iniciar uma solicitação, paginados.

 

Método:

getAvailableProcessOnDemand(String username, String password, int companyId, String userId, int limit, int lastRowId)

 

Parâmetros:

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

 

Retorno: ProcessDefinitionVersionDto[].

getAvailableStates

Retorna o número da próxima atividade de uma solicitação.

 

Método:

getAvailableStates(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: código do processo.
  • processInstanceId: número da solicitação.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: Integer[].

getAvailableStatesDetail

Retorna detalhes das atividades disponíveis para seleção..

Atenção

Caso haja necessidade de utilizar este método na primeira instância do processo, favor consultar a .

Método:

getAvailableStatesDetail(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: código do processo.
  • processInstanceId: número da solicitação.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: ProcessStateDto[].

getAvailableUsers

Retorna os usuários que podem executar a tarefa corrente de uma solicitação.

 

Método:

getAvailableUsers(String username, String password, int companyId, int processInstanceId, int state, int threadSequence)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • state: número da atividade.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: String[].

getAvailableUsersOnDemand

Retorna os usuários que podem executar a tarefa corrente de uma solicitação, paginados e com busca.

 

Método:

getAvailableUsersOnDemand(String username, String password, int companyId, int processInstanceId, int state, int threadSequence, int limit, int initialUser, String userSearch)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • state: número da atividade.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
  • limit: número de registros a serem retornados.
  • initialUser: última linha retornada.
  • userSearch: texto a ser buscado.

 

Retorno: AvailableUsersDto.

getAvailableUsersStart

Retorna os usuários disponíveis na abertura de uma solicitação.

 

Método:

getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: código do processo.
  • state: número da atividade.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: String[].

getAvailableUsersStartOnDemand

Retorna os usuários disponíveis na abertura de uma solicitação, paginados e com busca.

 

Método:

getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence, int limit, int initialUser, String userSearch)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: código do processo.
  • state: número da atividade.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
  • limit: número de registros a serem retornados.
  • initialUser: última linha retornada.
  • userSearch: texto a ser buscado.

 

Retorno: AvailableUsersDto.

getCardValue

Retorna o valor de um campo do registro de formulário.

 

Método:

getCardValue(String user, String password, int companyId, int processInstanceId, String userId, String cardFieldName)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • userId: mátricula do usuário.
  • cardFieldName: nome do campo do registro de formulário.

 

Retorno: String.

getHistories

Retorna lista de históricos de um processo.

 

Método:

getHistories (String username, String password, int companyId)

 

Parâmetros:

  • username - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • userId - Matrícula do usuário
  • processInstanceId - número da solicitação workflow

 

Retorno: ProcessHistoryDto[].

 

getInstanceCardData

Retorna o valor dos campos do registro de formulário de uma solicitação.

 

Método:

getInstanceCardData(String user, String password, int companyId, String userId, int processInstanceId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • userId: matrícula do usuário.
  • processInstanceId: número da solicitação.

 

Retorno: String[][].

getProcessFormId

Retorna o código do formulário vinculado ao processo.

 

Método:

getProcessFormId(String user, String password, int companyId, string processId)

 

Parâmetros:

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

 

Retorno: int.

getWorkFlowProcessVersion

Retorna a versão de um processo.

 

Método:

getWorkFlowProcessVersion(String user, String password, int companyId, int processId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: número da solicitação.

 

Retorno: int.

importProcess

Importa processos workflow.

 

Método:

importProcess(String user, String password, int companyId, String processId, Attachment file, boolean newProcess, boolean overWrite, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: código do processo.
  • file: arquivo a ser importado.
  • newProcess: indica se deve ser criado um processo ou atualizado o existente.
  • overWrite: indica se  as atividade e fluxos do processo existente dever ser sobrescritas.
  • colleagueId : matrícula do usuário.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


importProcessWithCard

Importa processos workflow e formulário.

 

Método:

importProcessWithCard(String user, String password, int companyId, String processId, Attachment[] processAttachs, boolean newProcess, boolean overWrite, String colleagueId, int parentDocId, String docDescription, String cardDescription, String datasetName, Attachment[] cardAttachs, CardEventDto[] customEvents, boolean update)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: código do processo.
  • processAttachs: anexos do processo.
  • newProcess: indica se deve ser criado um processo ou atualizado o existente.
  • overWrite: indica se  as atividade e fluxos do processo existente dever ser sobrescritas.
  • colleagueId : matrícula do usuário.
  • parentDocId: número do formulário.
  • docDescription: descrição.
  • cardDescription: nome.
  • datasetName: nome do dataset.
  • cardAttachs: arquivo anexo.
  • customEvents: eventos.
  • update: caso verdadeiro ('true'), informa que será uma atualização.

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


releaseProcess

Libera processos workflow.

 

Método:

releaseProcess(String user, String password, int companyId, String processId)

 

Parâmetros:

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

Retorno: String.
Estrutura de retorno com sucesso

 

 

Estrutura de retorno com erro


saveAndSendTask

Movimenta solicitação para próxima atividade.

 

Método:

saveAndSendTask(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • choosedState: número da atividade.
  • colleagueIds: usuário que receberá a tarefa.
  • comments: comentários.
  • userId: matrícula do usuário que vai executar a tarefa.
  • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
  • attachments: anexos da solicitação.
  • cardData: dados do registro de formulário.
  • appointment: apontamentos da tarefa.
  • managerMode: indica se usuário esta executando a tarefa como gestor do processo.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: String[][].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


saveAndSendTaskByReplacement

Movimenta solicitação para próxima atividade utilizando usuário substituto.

 

Método:

saveAndSendTaskByReplacement (String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence, String replacementId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • choosedState: número da atividade.
  • colleagueIds: usuário que receberá a tarefa.
  • comments: comentários.
  • userId: matrícula do usuário que vai executar a tarefa.
  • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
  • attachments: anexos da solicitação.
  • cardData: dados do registro de formulário.
  • appointment: apontamentos da tarefa.
  • managerMode: indica se usuário esta executando a tarefa como gestor do processo.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
  • replacementId: matrícula do usuário substituto.

 

Retorno: String[][].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


saveAndSendTaskClassic

Movimenta solicitação para próxima atividade e retorna um array de objeto com chave e valor.

 

Método:

saveAndSendTaskClassic(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • choosedState: número da atividade.
  • colleagueIds: usuário que receberá a tarefa.
  • comments: comentários.
  • userId: matrícula do usuário que vai executar a tarefa.
  • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
  • attachments: anexos da solicitação.
  • cardData: dados do registro de formulário.
  • appointment: apontamentos da tarefa.
  • managerMode: indica se usuário esta executando a tarefa como gestor do processo.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Estrutura mínima para movimentação com anexo

xmlExemplo usando SoapUI

O exemplo de movimentação com anexo foi criado considerando do uso da pasta de upload do volume. Sendo assim, o arquivo para transferência deverá estar contido na pasta de upload do usuário.

Considerando o exemplo acima, o arquivo pdf_para_teste.pdf deverá estar contido na pasta do usuário, que fica localizada dentro do diretório upload no volume do fluig.

Caso não queira utilizar este tipo de transferência para anexo e sim a transferência via Bytes, devem ser adicionadas à estrutura, abaixo da tag <fileName>, as seguintes tags:

<fileSize> = para indicar o tamanho do arquivo
<filecontent> = que deverá conter os bytes referentes ao arquivo

Adicionando estas tags será ignorada a busca no diretório de upload do usuário, sendo considerado o arquivo contido na tag <filecontent>.

 

 

Retorno: KeyValueDto[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


searchProcess

Busca processo disponíveis para inicialização.

 

Método:

searchProcess(String user, String Password, int companyId, String colleagueId, String content, boolean favorite)

 

Parametros

 

  • user - Usuário de Integração
  • password - Senha de Integração
  • companyId - Código da empresa
  • colleagueId - Matrícula do usuário
  • content – nome do processo a ser pesquisado
  • favorite – busca da lista de processos favoritos ou da listagem padrão.

 

Retorno: ProcessDefinitionVersionDto[]

setAutomaticDecisionClassic

Seleciona usuário(s) e avança atividade automática.

 

Método:

setAutomaticDecisionClassic(String user, String password, int companyId, int processInstanceId, int iTaskAutom, int iTask, int condition, String[] colleagueIds, String comments, String userId, boolean managerMode, int threadSequence)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • iTaskAutom: número da atividade automática.
  • iTask: numero da atividade atual.
  • condition: numero da condição da atividade automática.
  • colleagueIds: usuário que receberá a tarefa.
  • comments: comentários.
  • userId: matrícula do usuário que vai executar a tarefa.
  • managerMode: indica se usuário esta executando a tarefa como gestor do processo.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: KeyValueDto[]

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


setDueDate

Altera a data de prazo da tarefa.

 

Método:

setDueDate(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String newDueDate, int timeInSeconds)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • userId: matrícula do usuário. Quando é Para um Grupo ou Para um Papel deve ser passado da seguinte forma:
    Papel: "Pool:Role:CodigoDoPapel";
    Grupo: "Pool:Group:CodigoDoGrupo".
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
  • newDueDate: nova data de prazo da tarefa. Exemplo: "2014-08-20".
  • timeInSeconds: quantidade de segundos após a meia noite. Exemplo: "32000".

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


setTasksComments

Altera os comentários da tarefa.

 

Método:

setTasksComments(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String comments)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação.
  • userId: mátricula do usuário.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
  • comments: comentários.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


simpleStartProcess

Inicia uma solicitação simples.

 

Método:

simpleStartProcess(String user, String password, int companyId, String processId, String comments, ProcessAttachmentDto[] attachments, String cardData[][])

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: código do processo.
  • comments: comentários.
  • attachments: anexos da solicitação.
  • cardData: dados do registro de formulário.

 

Retorno: String[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


startProcess

Inicia uma solicitação.

 

Método:

startProcess(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: código do processo.
  • choosedState: número da atividade.
  • colleagueIds: usuário que receberá a tarefa. Caso a solicitação esteja sendo atribuída "Para um Papel" ou "Para um Grupo", o parâmetro colleagueIds deve ser informado da seguinte forma:
    Papel: Pool:Role:Nome_do_papel
    Grupo: Pool:Group:Nome_do_grupo
  • comments: comentários.

  • userId: matrícula do usuário que vai iniciar a solicitação.

  • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
  • attachments: anexos da solicitação.
  • cardData: dados do registro de formulário.
  • appointment: apontamentos da tarefa.
  • managerMode: indica se usuário esta iniciando a solicitação como gestor do processo.

 

Retorno: String[][].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


startProcessClassic

Inicia uma solicitação e retorna um array de objeto com chave e valor.

 

Método:

startProcessClassic(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processId: código do processo.
  • choosedState: número da atividade.
  • colleagueIds: usuário que receberá a tarefa.
  • comments: comentários.
  • userId: matrícula do usuário que vai iniciar a solicitação.
  • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
  • attachments: anexos da solicitação.
  • cardData: dados do registro de formulário.
  • appointment: apontamentos da tarefa.
  • managerMode: indica se usuário esta iniciando a solicitação como gestor do processo.

 

Retorno: String[][].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


takeProcessTask

Assume uma tarefa.

 

Método:

takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • userId: matrícula do usuário.
  • processInstanceId: número da solicitação.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


takeProcessTaskByReplacement

Assume uma tarefa utilizando usuário substituto.

 

Método:

takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence, String replacementId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • userId: matrícula do usuário.
  • processInstanceId: número da solicitação.
  • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
  • replacementId: matrícula do usuário substituto.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateWorkflowAttachment

Atualiza um documento do tipo 7.

Retorna uma string contendo a descrição de sucesso ou falha da operação.

Método:

updateWorkflowAttachment(String username, String password, int companyId, int processInstanceId, String usuario, DocumentDto[] docdtos, Attachment[] attach)

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • processInstanceId: número da solicitação workflow.
  • usuario: usuário responsável pela edição do documento.
  • documents: documento ou documentos que serão publicados.
  • attachments: arquivo(s) anexado(s) na publicação.

 

Retorno: String.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


 

Quadro 24: Métodos da WorkflowEngineService


...

Webservice responsável por realizar operações referentes a papéis no fluig. Pode ser utilizado para criar, alterar, excluir e procurar papéis, entre outras funcionalidadesoutros recursos.

 

Métodos

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

createWorkflowRole

Cria um papel no fluig.

 

Método:

createWorkflowRole(String username, String password, int companyId, workflowRoleDto role)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • role: papel que será criado.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


deleteWorkflowRole

Exclui um papel do fluig.

 

Método:

deleteWorkflowRole(String username, String password, int companyId, String roleId)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • roleId: código do papel a ser excluído.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


getWorkflowRole

Retorna um papel cadastrado no fluig.

 

Método:

getWorkflowRole(String username, String password, int companyId, String roleId)

 

Parâmetros:

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

 

Retorno: WorkflowRoleDto.

 

Atributos de Retorno:

  • companyId
  • roleDescription
  • roleId

getWorkflowRoles

Retorna todos os papéis cadastrados no fluig.

 

Método:

getWorkflowRoles(String username, String password, int companyId)

 

Parâmetros:

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

 

Retorno: WorkflowRoleDto[].

 

Atributos de Retorno:

  • companyId
  • roleDescription
  • roleId

updateWorkflowRole

Atualiza um papel no fluig.

 

Método:

updateWorkflowRole(String username, String password, int companyId, workflowRoleDto role)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • role: papel que será criado.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 25: Métodos da WorkflowRoleService


...