Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.
  • attachs: arquivo anexado na publicação.
  • docSecurity: segurança do documento que será publicado.
  • docApprovers: aprovadores do documento que será publicado.
  • relDocs: documentos relacionados ao documento que será publicado.

 

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.

 

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[] attach, 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á alterado.
  • attachs: arquivo anexado na alteração.
  • docSecurity: segurança do documento que será alterado.
  • docApprovers: aprovadores do documento que será alterado.
  • relDocs: documentos relacionados ao documento que será alterado.

 

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

...