2.0info: 0.20.1 ecm_ged description: Gestão de Documentos x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: ecm_ged contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ecm_ged/queries/newDocumentStatus: post: description: Retorna Andamento da criação arquivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket para obter o status do documento responses: 200: description: Ok schema: type: object required: – finished properties: finished: type: boolean description: Indica se o processo para novo documento foi finalizado documentId: type: string description: Identificador do Documento se estiver pronto default: description: Error response schema: #/definitions/genericError get: description: Retorna Andamento da criação arquivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticket description: Ticket para obter o status do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – finished properties: finished: type: boolean description: Indica se o processo para novo documento foi finalizado documentId: type: string description: Identificador do Documento se estiver pronto default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getPendenciesCount: post: description: Lista a quantidade de documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: user: type: string description: responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError get: description: Lista a quantidade de documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: user description: in: query type: string responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listPendencies: post: description: Lista os documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: user: type: string description: responses: 200: description: Ok schema: type: object properties: pendencies: type: array items: type: object allOf: – #/definitions/document description: default: description: Error response schema: #/definitions/genericError get: description: Lista os documentos pendentes, seja de revisão ou de propriedades, por padrão considera o usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: user description: in: query type: string responses: 200: description: Ok schema: type: object properties: pendencies: type: array items: type: object allOf: – #/definitions/document description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/folderList: post: description: Lista os documentos e pastas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Id da pasta para listar orderby: type: string description: Campo para ordenação responses: 200: description: Ok schema: type: object properties: path: type: array items: type: object allOf: – #/definitions/folderPosition description: Localização na árvore files: type: array items: type: object allOf: – #/definitions/file description: Lista de arquivos default: description: Error response schema: #/definitions/genericError get: description: Lista os documentos e pastas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id da pasta para listar in: query type: string – name: orderby description: Campo para ordenação in: query type: string responses: 200: description: Ok schema: type: object properties: path: type: array items: type: object allOf: – #/definitions/folderPosition description: Localização na árvore files: type: array items: type: object allOf: – #/definitions/file description: Lista de arquivos default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/requestDocumentVersionDownload: post: description: Solicita uma url para download do arquivo de uma determinada versão de documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Identificador da versão do documento preview: type: boolean description: Indica se deve busca a versão de pré visualização default: false responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url disponível para download default: description: Error response schema: #/definitions/genericError get: description: Solicita uma url para download do arquivo de uma determinada versão de documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentVersionId description: Identificador da versão do documento in: query required: true type: string – name: preview description: Indica se deve busca a versão de pré visualização in: query type: boolean responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url disponível para download default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/requestDocumentDownload: post: description: Solicita uma url para download do arquivo do documento versão publicada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento preview: type: boolean description: Indica se deve busca a versão de pré visualização default: false responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url disponível para download default: description: Error response schema: #/definitions/genericError get: description: Solicita uma url para download do arquivo do documento versão publicada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentId description: Identificador do documento in: query required: true type: string – name: preview description: Indica se deve busca a versão de pré visualização in: query type: boolean responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url disponível para download default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/searchDocument: post: description: Pesquisa documentos com base em uma string tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchTerm properties: searchTerm: type: string description: O valor a ser pesquisado offset: type: integer format: int64 description: Index de início da busca default: 0 size: type: integer format: int64 description: Tamanho da busca default: 10 responses: 200: description: Ok schema: type: object properties: documents: type: array items: type: object allOf: – #/definitions/documentInfo description: Documentos encontrados na busca default: description: Error response schema: #/definitions/genericError get: description: Pesquisa documentos com base em uma string tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchTerm description: O valor a ser pesquisado in: query required: true type: string – name: offset description: Index de início da busca in: query type: integer format: int64 – name: size description: Tamanho da busca in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: documents: type: array items: type: object allOf: – #/definitions/documentInfo description: Documentos encontrados na busca default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/validateDocumentVersionName: post: description: Valida se existe versao de documento com o nome pesquisado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – versionName – documentId properties: versionName: type: string description: Nome da versao do document documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Boolean que indica se o nome é valido default: description: Error response schema: #/definitions/genericError get: description: Valida se existe versao de documento com o nome pesquisado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: versionName description: Nome da versao do document in: query required: true type: string – name: documentId description: Identificador do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Boolean que indica se o nome é valido default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentViewUrl: post: description: Retorna o link de visualização de um documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento embedded: type: boolean description: Se o link deve ser montado considerando a view da plataforma default: true responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url para visualização do documento default: description: Error response schema: #/definitions/genericError get: description: Retorna o link de visualização de um documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentId description: Identificador do documento in: query required: true type: string – name: embedded description: Se o link deve ser montado considerando a view da plataforma in: query type: boolean responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url para visualização do documento default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentVersions: post: description: Retorna todas as versões de um documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Id do documento a ser verificado auditing: type: boolean description: Se deve considerar versões minor e patch do documento para auditoria default: false responses: 200: description: Ok schema: type: object required: – documentVersions properties: documentVersions: type: array items: type: object allOf: – #/definitions/documentVersionInfo minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as versões de um documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentId description: Id do documento a ser verificado in: query required: true type: string – name: auditing description: Se deve considerar versões minor e patch do documento para auditoria in: query type: boolean responses: 200: description: Ok schema: type: object required: – documentVersions properties: documentVersions: type: array items: type: object allOf: – #/definitions/documentVersionInfo minimum: 1 description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getUser: post: description: Obtém informações a respeito de um determinado usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: username: type: string description: Nome do usuário no formato nome@dominio_tenant responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/user description: default: description: Error response schema: #/definitions/genericError get: description: Obtém informações a respeito de um determinado usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: username description: Nome do usuário no formato nome@dominio_tenant in: query type: string responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/user description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listUsers: post: description: Lista os usuários da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: Termo para buscar nos campos nome, nome completo e e-mail pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 responses: 200: description: Ok schema: type: object required: – users – total properties: users: type: array items: type: object allOf: – #/definitions/user minimum: 1 description: Usuários encontrados total: type: integer format: int64 description: Quantidade total de usuários default: description: Error response schema: #/definitions/genericError get: description: Lista os usuários da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchValue description: Termo para buscar nos campos nome, nome completo e e-mail in: query type: string – name: pageNumber description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: pageSize description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – users – total properties: users: type: array items: type: object allOf: – #/definitions/user minimum: 1 description: Usuários encontrados total: type: integer format: int64 description: Quantidade total de usuários default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listGroups: post: description: Lista os grupos da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome do grupo pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 responses: 200: description: Ok schema: type: object required: – groups – total properties: groups: type: array items: type: object allOf: – #/definitions/group minimum: 1 description: Grupos encontrados total: type: integer format: int64 description: Quantidade total de grupos default: description: Error response schema: #/definitions/genericError get: description: Lista os grupos da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchValue description: O valor a ser pesquisado no nome do grupo in: query type: string – name: pageNumber description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: pageSize description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – groups – total properties: groups: type: array items: type: object allOf: – #/definitions/group minimum: 1 description: Grupos encontrados total: type: integer format: int64 description: Quantidade total de grupos default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/listRoles: post: description: Lista os papéis da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome dos papéis pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 responses: 200: description: Ok schema: type: object required: – roles – total properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis encontrados total: type: integer format: int64 description: Quantidade total de papéis default: description: Error response schema: #/definitions/genericError get: description: Lista os papéis da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchValue description: O valor a ser pesquisado no nome dos papéis in: query type: string – name: pageNumber description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: pageSize description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – roles – total properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis encontrados total: type: integer format: int64 description: Quantidade total de papéis default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDocumentVersionSubjects: post: description: Obtém os assuntos de uma versão de um document tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentVersionId properties: documentVersionId: type: string description: Identificador da versão do documento responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: type: array items: type: object allOf: – #/definitions/subject minimum: 1 description: Assuntos da versão do documento default: description: Error response schema: #/definitions/genericError get: description: Obtém os assuntos de uma versão de um document tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentVersionId description: Identificador da versão do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: type: array items: type: object allOf: – #/definitions/subject minimum: 1 description: Assuntos da versão do documento default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/verifyDocumentPermissions: post: description: Permite verificar se o usuário corrente possui determinadas permissões no documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId – permissionsType properties: documentId: type: string description: Id do documento permissionsType: type: array items: type: string allOf: – #/definitions/permissionType minimum: 1 description: Tipo da permissão responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/verifiedPermission minimum: 1 description: Permissões verificadas default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportSubject: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocument: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDraftDocument: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportFolder: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocumentTag: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocumentMetadata: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/exportDocumentTicket: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/approveDocumentVersion: post: description: Aprova ou Reprova uma versão do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentVersionId – approve properties: documentVersionId: type: string description: Versão do documento approve: type: boolean description: Aprovação responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/checkOutDocument: post: description: Faz o check-out de um documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object required: – lockedBy properties: lockedBy: type: string maxLength: 255 description: Retorna o usuário com documento locado default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/checkInDocument: post: description: Faz o check-in de um documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/newDocument: post: description: Cria um novo documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName – fileUrl – title properties: fileName: type: string description: Nome original do Arquivo fileUrl: type: string description: URL do documento type: string description: Título do documento description: type: string description: Descrição do documento folderPath: type: string description: Caminho da pasta documentId: type: string description: Identificador do documento para criar uma nova versão documento subject: type: string description: Assunto Relacionado ao documento autor: type: string description: Usuário autor do documento versionName: type: string description: Nome da Versão Documento definida pelo Usuário documentMetadados: type: string description: metadados para o documento no formato. Ex: area=rh, empresa=1 tags: type: string description: Nome das tags relacionadas. Ex: bpm, diretoria, urgente approved: type: boolean description: Indica se o documento requer aprovação default: false permissions: type: array items: type: object allOf: – #/definitions/documentPermissionKind description: Permissão para Visualização do Documento responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Ticket para obter o status do documento default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/moveDocument: post: description: Move um documento para uma pasta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sourceId properties: sourceId: type: string description: Identificador do documento ou pasta origem targetId: type: string description: Identificador da pasta destino. Caso não informado, será considerado a pasta raiz. responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/takeOverDocument: post: description: Assume Controle do Documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/startReview: post: description: Inicia um processo de revisão de documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentVersionId – reviewer properties: documentVersionId: type: string description: Versão do documento reviewer: type: string maxLength: 255 description: Revisor responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/updateDefaultReviewer: post: description: Aprova ou Reprova uma versão do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Versão do documento reviewer: type: string maxLength: 255 description: Novo revisor responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importSubject: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocument: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDraftDocument: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importFolder: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocumentTag: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocumentMetadata: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/actions/importDocumentTicket: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /ecm_ged/signals/generatePreview: post: description: Gera preview de um documento e armazena na nuvem tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documentVersion properties: documentVersion: type: string description: Identificador único da versão do documento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/subject: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/subject responses: 200: description: The created resource schema: #/definitions/subject default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/subject responses: 200: description: The created resource schema: #/definitions/subject default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/subject default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/subject/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/subject responses: 200: description: Ok schema: #/definitions/subject default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/subject responses: 200: description: Ok schema: #/definitions/subject default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/subject default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/subject/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/subject responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/applicant: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/applicant responses: 200: description: The created resource schema: #/definitions/applicant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/applicant responses: 200: description: The created resource schema: #/definitions/applicant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/applicant default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/applicant/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/applicant responses: 200: description: Ok schema: #/definitions/applicant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/applicant responses: 200: description: Ok schema: #/definitions/applicant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/applicant default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/subject/{parentId}/applicants: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/applicant responses: 200: description: The created resources schema: type: array items: #/definitions/applicant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/applicant responses: 200: description: The created resources schema: type: array items: #/definitions/applicant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/applicant default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/subject/{parentId}/applicants/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/applicant responses: 200: description: Ok schema: #/definitions/applicant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/applicant responses: 200: description: Ok schema: #/definitions/applicant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/applicant default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/applicant/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/applicant responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/document default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/document default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentVersion: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentVersion responses: 200: description: The created resource schema: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentVersion responses: 200: description: The created resource schema: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentVersion/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentVersion responses: 200: description: Ok schema: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentVersion responses: 200: description: Ok schema: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/versions: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/documentVersion responses: 200: description: The created resources schema: type: array items: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/documentVersion responses: 200: description: The created resources schema: type: array items: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/versions/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentVersion responses: 200: description: Ok schema: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentVersion responses: 200: description: Ok schema: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentVersion default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentVersion/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentVersion responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/timeline: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/timeline responses: 200: description: The created resource schema: #/definitions/timeline default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/timeline responses: 200: description: The created resource schema: #/definitions/timeline default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/timeline default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/timeline/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/timeline responses: 200: description: Ok schema: #/definitions/timeline default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/timeline responses: 200: description: Ok schema: #/definitions/timeline default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/timeline default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/timeline: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/timeline responses: 200: description: The created resources schema: type: array items: #/definitions/timeline default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/timeline responses: 200: description: The created resources schema: type: array items: #/definitions/timeline default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/timeline default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/timeline/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/timeline responses: 200: description: Ok schema: #/definitions/timeline default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/timeline responses: 200: description: Ok schema: #/definitions/timeline default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/timeline default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/timeline/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/timeline responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/draftDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/draftDocument responses: 200: description: The created resource schema: #/definitions/draftDocument default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/draftDocument responses: 200: description: The created resource schema: #/definitions/draftDocument default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/draftDocument default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/draftDocument/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/draftDocument responses: 200: description: Ok schema: #/definitions/draftDocument default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/draftDocument responses: 200: description: Ok schema: #/definitions/draftDocument default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/draftDocument default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/draftDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/draftDocument responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/folder: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/folder responses: 200: description: The created resource schema: #/definitions/folder default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/folder responses: 200: description: The created resource schema: #/definitions/folder default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/folder default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/folder/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/folder responses: 200: description: Ok schema: #/definitions/folder default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/folder responses: 200: description: Ok schema: #/definitions/folder default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/folder default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/folder/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/folder responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTag: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentTag responses: 200: description: The created resource schema: #/definitions/documentTag default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentTag responses: 200: description: The created resource schema: #/definitions/documentTag default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/documentTag default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTag/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentTag responses: 200: description: Ok schema: #/definitions/documentTag default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentTag responses: 200: description: Ok schema: #/definitions/documentTag default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentTag default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTag/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentTag responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentMetadata: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentMetadata responses: 200: description: The created resource schema: #/definitions/documentMetadata default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentMetadata responses: 200: description: The created resource schema: #/definitions/documentMetadata default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/documentMetadata default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentMetadata/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentMetadata responses: 200: description: Ok schema: #/definitions/documentMetadata default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentMetadata responses: 200: description: Ok schema: #/definitions/documentMetadata default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentMetadata default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentMetadata/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentMetadata responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/permission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/permission responses: 200: description: The created resource schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/permission responses: 200: description: The created resource schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/permission default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/permission/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/permission responses: 200: description: Ok schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/permission responses: 200: description: Ok schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/permissions: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/permission responses: 200: description: The created resources schema: type: array items: #/definitions/permission default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/permission responses: 200: description: The created resources schema: type: array items: #/definitions/permission default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/permission default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/folder/{parentId}/permissions: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/permission responses: 200: description: The created resources schema: type: array items: #/definitions/permission default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/permission responses: 200: description: The created resources schema: type: array items: #/definitions/permission default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/permission default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/document/{parentId}/permissions/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/permission responses: 200: description: Ok schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/permission responses: 200: description: Ok schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/folder/{parentId}/permissions/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/permission responses: 200: description: Ok schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/permission responses: 200: description: Ok schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/permission default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/permission/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/permission responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTicket: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentTicket responses: 200: description: The created resource schema: #/definitions/documentTicket default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentTicket responses: 200: description: The created resource schema: #/definitions/documentTicket default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/documentTicket default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTicket/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentTicket responses: 200: description: Ok schema: #/definitions/documentTicket default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentTicket responses: 200: description: Ok schema: #/definitions/documentTicket default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentTicket default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ecm_ged/entities/documentTicket/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentTicket responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN fileKind: description: Tipo de Arquivo type: string enum: – FOLDER – DOCUMENT documentStatus: description: Tipo de Arquivo type: string enum: – PENDING – REVIEW – PUBLISHED – EXPIRED – DEPRECATED timelineKind: description: Tipoe da Linha de Tempo do Documento type: string enum: – REVIEW – NEW_VERSION – CHECK_IN – CHECK_OUT – TAKE_OVER – MOVE – REMOVE subjectType: description: Tipos de sujeitos type: string enum: – USER – ROLE – GROUP permissionType: description: Tipo de permissão de um documento type: string enum: – VIEW – DOWNLOAD – EDIT userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck folderPosition: description: Representa o caminho na árvore type: object required: – id – name – level properties: id: type: string description: ID da pasta name: type: string maxLength: 255 description: Nome level: type: integer format: int64 description: Nível na árvore file: description: Representa arquivo ou pasta na árvore de navegação type: object required: – id – title – kind – children – publishedVersion – createdBy – lastModifiedDate properties: id: type: string description: Id do documento ou pasta type: string maxLength: 255 description: Nome kind: type: string allOf: – #/definitions/fileKind description: Indica se é um docuemnto ou pasta children: type: array items: type: string minimum: 1 description: Lista de IDs documentos e pastas filhas status: type: string allOf: – #/definitions/documentStatus description: Status Documento publishedVersion: type: string description: Versão publicada do documento mimetype: type: string description: Mimetype do arquivo, null caso seja uma pasta createdBy: type: string description: Autor lastModifiedDate: type: string format: date-time description: Data da última modificação lockedBy: type: string maxLength: 255 description: Documento travado para um usuário canEdit: type: boolean description: Verifica se o usuário tem permissão de editar canDownload: type: boolean description: Verifica se o usuário tem permissão de realizar download canChangeReview: type: boolean description: Verifica se o usuário tem permissão de editar a revisão removed: type: boolean description: Indicador para exclusão lógica do documento default: false documentInfo: description: Representação do documento em uma determinada versão type: object required: – id – title – version properties: id: type: string description: Identificador do documento type: string maxLength: 255 description: Nome lockedBy: type: string maxLength: 255 description: Documento travado para um usuário pending: type: boolean description: Status Pendente default: true type: object allOf: – #/definitions/documentVersionInfo description: Versão do documento documentVersionInfo: description: Representação de uma determinada versão de um documento type: object required: – id – title – createdBy – reviewer – createdDate – lastModifiedDate properties: id: type: string description: Id da versão do documento type: string maxLength: 255 description: Nome status: type: string allOf: – #/definitions/documentStatus description: Status Documento mimetype: type: string description: Mimetype do arquivo, null caso seja uma pasta versionName: type: string maxLength: 50 description: Nome da Versão do Usuário path: type: array items: type: object allOf: – #/definitions/folderPosition description: Caminho para o documento createdBy: type: string description: Publicador reviewer: type: string description: Revisor createdDate: type: string format: date-time description: Data de criação da versão lastModifiedDate: type: string format: date-time description: Data da última modificação user: description: Informações referente a um usuário type: object required: – id – username – fullName – email – tenantDomain – tenantName – tenantLocale properties: id: type: string description: Identificador do usuário username: type: string description: Nome do usuário fullName: type: string description: Nome completo do usuário description: type: string description: Descrição do usuário email: type: string description: Endereço de e-mail do usuário locale: type: string description: localidade do usuário tenantDomain: type: string description: Domínio do tenant no login do usuário tenantName: type: string description: Nome do tenant do usuario tenantLocale: type: string description: Localidade do tenant do usuario photo: type: string description: Foto do usuário em Base64. Retornado em apenas algumas primitivas por questão de performance group: description: Informações referente a um grupos type: object required: – id – name properties: id: type: string description: Identificador do Grupo name: type: string description: Nome do Grupo description: type: string description: Descrição do Grupo email: type: string description: Email do grupo role: description: Um papel de usuário type: object required: – name – description properties: name: type: string description: Nome único do papel description: type: string description: Descrição do papel verifiedPermission: description: Permissão verificada type: object required: – type – hasPermission properties: type: type: string allOf: – #/definitions/permissionType description: Tipo da permissão hasPermission: type: boolean description: Se possui permissão documentPermissionKind: description: Permissão para o novo documento type: object required: – subjectType – subjectName – permissionType properties: subjectType: type: string allOf: – #/definitions/subjectType description: Indica o sujeito (papel, grupo ou usuário) subjectName: type: string description: Identicador do sujeito permissionType: type: string allOf: – #/definitions/permissionType description: Tipo da permissão subject: description: Assunto type: object required: – name properties: id: type: string format: uuid description: Identificação name: type: string maxLength: 100 description: Nome do Assunto applicants: type: array items: type: object allOf: – #/definitions/applicant description: Interessados no assunto applicant: description: Interessados type: object properties: id: type: string format: uuid description: Identificação userName: type: string description: Nome do interessado type: type: string allOf: – #/definitions/subjectType description: Tipo do sujeito subject: type: object allOf: – #/definitions/subject description: Assunto groupId: type: string description: Identificação de um grupo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: document: description: Documento type: object properties: id: type: string format: uuid description: Identificação type: string maxLength: 255 description: Nome do Documento dueDate: type: string format: date-time description: Vencimento do Documento parent: type: string format: uuid description: ID do folder pai lockedBy: type: string maxLength: 255 description: Documento travado para um usuário versions: type: array items: type: object allOf: – #/definitions/documentVersion description: Versões do Documento currentVersion: type: object allOf: – #/definitions/documentVersion description: Versão Atual publishedVersion: type: object allOf: – #/definitions/documentVersion description: Versão Publicada pending: type: boolean description: Status Pendente default: true permissions: type: array items: type: object allOf: – #/definitions/permission description: Lista de permissões timeline: type: array items: type: object allOf: – #/definitions/timeline description: Timeline do documento removed: type: boolean description: Indicador para exclusão lógica do documento default: false defaultReviewer: type: string maxLength: 255 description: Revisor para proxima versao do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentVersion: description: Versão de um Documento type: object properties: id: type: string format: uuid description: ID document: type: object allOf: – #/definitions/document description: Documento Associado readOnly: true changeVersion: type: boolean description: Indicador Versão Atualizada default: false changeFile: type: boolean description: Indicador Arquivo Atualizado default: false versionName: type: string maxLength: 50 description: Nome da Versão do Usuário majorVersion: type: integer format: int64 description: Versão Maior – usuário trocou versão default: 0 minorVersion: type: integer format: int64 description: Versão Menor – upload novo arquivo default: 0 patchVersion: type: integer format: int64 description: Versão Mudança nas Propriedades do Documento default: 0 uploadId: type: string description: Identificador do upload originalFilename: type: string description: Nome Original do Arquivo size: type: integer format: int64 description: Tamanho do arquivo type: string maxLength: 255 description: Titulo da Versão do Documento description: type: string maxLength: 1024 description: Descrição do Documento mimetype: type: string maxLength: 255 description: Tipo do Arquivo status: type: string allOf: – #/definitions/documentStatus description: Status Documento meta: type: array items: type: object allOf: – #/definitions/documentMetadata description: Metadados do Documento tags: type: string maxLength: 512 description: Tags subjects: type: array items: type: object allOf: – #/definitions/subject description: Assunto author: type: string maxLength: 255 description: Autor do Documento reviewer: type: string maxLength: 255 description: Revisor expirationDate: type: string format: date description: Date de expiração deprecationDate: type: string format: date description: Date de depreciação previewId: type: string description: Identificador do upload de Preview previewFilename: type: string description: Nome Original do Arquivo de Preview createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: timeline: description: Timeline do documento type: object required: – kind properties: id: type: string format: uuid description: ID kind: type: string allOf: – #/definitions/timelineKind description: Tipo da timeline note: type: string description: Anotação sobre o documento document: type: object allOf: – #/definitions/document description: Documento Associado folder: type: object allOf: – #/definitions/folder description: Folder Associado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: draftDocument: description: Documento em rascunho type: object required: – filename properties: id: type: string format: uuid description: ID filename: type: string maxLength: 255 description: Nome do Arquivo uploadId: type: string maxLength: 255 description: Identificador do upload uploadVersion: type: string maxLength: 255 description: Versão do upload no serviço de armazenamento uploadURI: type: string maxLength: 2048 description: URI para upload do documento mimetype: type: string maxLength: 255 description: Tipo do Arquivo size: type: integer format: int64 description: Tamanho do Arquivo em bytes owner: type: string maxLength: 255 description: Proprietário do Arquivo trashed: type: boolean description: Indica se o foi marcado para remoção upload: type: boolean description: Indica se foi feito upload arquivo uploadDate: type: string format: date-time description: Data do Upload do arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: folder: description: Pasta type: object required: – name properties: id: type: string format: uuid description: Identificação name: type: string maxLength: 255 description: Nome do Arquivo description: type: string maxLength: 1024 description: Descrição parent: type: string format: uuid description: ID da pasta pai defaultMetadata: type: array items: type: object allOf: – #/definitions/documentMetadata description: Metadados Padrões para Documentos da Pasta permissions: type: array items: type: object allOf: – #/definitions/permission description: Lista de permissões removed: type: boolean description: Indicador para exclusão lógica da pasta default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentTag: description: Tag de documento type: object required: – name properties: id: type: string format: uuid description: Identificação documents: type: array items: type: object allOf: – #/definitions/documentVersion description: Documentos Relacionado name: type: string maxLength: 100 description: Nome da tag documentMetadata: description: Metadados do documento type: object required: – key properties: id: type: string format: uuid description: Identificação key: type: string maxLength: 50 description: Chave do Metadado value: type: string maxLength: 255 description: Valor da Chave permission: description: Permissão por subject type: object required: – subject – type – permissionLevel – active properties: id: type: string format: uuid description: Identificação folder: type: object allOf: – #/definitions/folder description: Folder document: type: object allOf: – #/definitions/document description: File subject: type: string description: Sujeito type: type: string allOf: – #/definitions/subjectType description: Tipo do sujeito permissionLevel: type: integer format: int64 description: Nível de permissão, 0 para sem permissão, 1 para permissão de visualização e 2 para permissão de edição active: type: boolean description: Indica se a permissão está ativa ou desabilitada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentTicket: description: Armazena status de criação de documentos via integração type: object required: – finished properties: id: type: string format: uuid description: Identificação do Ticket finished: type: boolean description: Indica se o processo de criação foi finalizado documentId: type: string description: Identificador do Documento Criado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE