Mais pesquisados:Customização, Tutorial, Documentação

contact

2 views 0 23/07/2025 Atualizado em 24/07/2025 integrador

2.0info: 1.1.2 contact x-senior-domain: flow x-senior-domain-path: flow x-senior-service-path: contact contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/flowsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /contact/queries/healthcheck: post: description: Endpoint para verificação da saúde 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/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para verificação da saúde 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/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/getNewContactUserBatchUrl: post: description: Primitiva que gera a URL assinada do arquivo de importação de criação de usuários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – newUserContactBatchId properties: newUserContactBatchId: type: string description: responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva que gera a URL assinada do arquivo de importação de criação de usuários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: newUserContactBatchId description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/getContactUserList: post: description: Listagem dos usuários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 size: type: integer format: int64 description: Quantidade de registros por página default: 20 orderByField: type: string allOf: – #/definitions/orderByField description: Campo para ordenação order: type: string allOf: – #/definitions/orderType description: Tipo de ordenação nameOrCpf: type: string description: Nome do usuário ou CPF para filtro responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de usuários encontrados contents: type: array items: type: object allOf: – #/definitions/contactUserDTO minimum: 1 description: Lista de usuários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listagem dos usuários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: orderByField description: Campo para ordenação in: query type: string allOf: – #/definitions/orderByField – name: order description: Tipo de ordenação in: query type: string allOf: – #/definitions/orderType – name: nameOrCpf description: Nome do usuário ou CPF para filtro in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de usuários encontrados contents: type: array items: type: object allOf: – #/definitions/contactUserDTO minimum: 1 description: Lista de usuários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/getAssociationList: post: description: Listagem dos Grupos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 size: type: integer format: int64 description: Quantidade de registros por página default: 20 order: type: string allOf: – #/definitions/orderType description: Tipo de ordenação name: type: string description: Nome do grupo active: type: boolean description: Filtrar por status ativo responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de usuários encontrados contents: type: array items: type: object allOf: – #/definitions/associationCompleteDTO minimum: 1 description: Lista de grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listagem dos Grupos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: order description: Tipo de ordenação in: query type: string allOf: – #/definitions/orderType – name: name description: Nome do grupo in: query type: string – name: active description: Filtrar por status ativo in: query type: boolean responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de usuários encontrados contents: type: array items: type: object allOf: – #/definitions/associationCompleteDTO minimum: 1 description: Lista de grupos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/getContactsByAssociation: post: description: Listagem dos contatos atribuídos a determinado grupo(association) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 size: type: integer format: int64 description: Quantidade de registros por página default: 20 orderByType: type: string allOf: – #/definitions/orderType description: Campo para ordenação associationId: type: string description: Id da associação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de contatos encontrados contents: type: array items: type: object allOf: – #/definitions/contactDTO minimum: 1 description: Lista de contatos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listagem dos contatos atribuídos a determinado grupo(association) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: orderByType description: Campo para ordenação in: query type: string allOf: – #/definitions/orderType – name: associationId description: Id da associação in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de contatos encontrados contents: type: array items: type: object allOf: – #/definitions/contactDTO minimum: 1 description: Lista de contatos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/getContactUserBatchList: post: description: Primitiva que faz a consulta da lista de arquivos importados pelo usuario tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 size: type: integer format: int64 description: Quantidade de registros por página default: 20 orderByField: type: string allOf: – #/definitions/orderByFieldContactUserBatch description: Campo para ordenação order: type: string allOf: – #/definitions/orderType description: Tipo de ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de usuários encontrados contents: type: array items: type: object allOf: – #/definitions/contactBatchDTO minimum: 1 description: Lista de arquivos de importação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva que faz a consulta da lista de arquivos importados pelo usuario tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: orderByField description: Campo para ordenação in: query type: string allOf: – #/definitions/orderByFieldContactUserBatch – name: order description: Tipo de ordenação in: query type: string allOf: – #/definitions/orderType responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas disponíveis totalElements: type: integer format: int64 description: Total de usuários encontrados contents: type: array items: type: object allOf: – #/definitions/contactBatchDTO minimum: 1 description: Lista de arquivos de importação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/getContactUserByCpf: post: description: Primitiva que realiza a busca de um Contato pelo CPF informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cpf properties: cpf: type: string description: CPF do contato responses: 200: description: Ok schema: type: object required: – contactUser properties: contactUser: type: object allOf: – #/definitions/contactUserDTO description: Dados do Contato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva que realiza a busca de um Contato pelo CPF informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cpf description: CPF do contato in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contactUser properties: contactUser: type: object allOf: – #/definitions/contactUserDTO description: Dados do Contato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/getUserConfigByLogin: post: description: Primitiva para recuperar as configurações do usuário pelo usuario logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object allOf: – #/definitions/userConfigDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para recuperar as configurações do usuário pelo usuario logado tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object allOf: – #/definitions/userConfigDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/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: 401: description: Invalid Credentials 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/exportContact: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/exportContactUser: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/exportAssociation: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/exportNewContactBatch: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/exportContactLog: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/exportContactUserLog: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/exportUserConfig: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/exportAssociationLog: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/exportNewContactBatchLog: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials 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: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/newContactUser: post: description: Primitiva para criar Usuários e Contato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: contactId: type: string description: ID do contato caso já exista cpf: type: string description: CPF do Contato name: type: string description: Nome Completo do Contato birthday: type: string format: date description: Data de Nascimento do Contato phone: type: string description: Telefone do Contato Usuário email: type: string description: E-mail do Contato Usuário login: type: string description: Login na platforma do Contato Usuário associations: type: array items: type: object allOf: – #/definitions/associationDTO description: Ids dos Grupos que o Contato Usuário pertence responses: 200: description: Ok schema: type: object required: – contactUserId properties: contactUserId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/changeAssociationStatus: post: description: Endpoint para ativar ou desativar uma associação de usuários tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – associationIds – active properties: associationIds: type: array items: type: string minimum: 1 description: Lista de identificação da associação active: type: boolean description: Status da associação responses: 200: description: Ok schema: type: object required: – associationsNotFound properties: hasError: type: boolean description: Se houve erro na execução default: false associationsNotFound: type: array items: type: string minimum: 1 description: Lista de identificação do Grupo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/changeContactUserStatus: post: description: Primitiva para desabilitar os contatos passados pelo input tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – active – contactUserIds properties: active: type: boolean description: Status os contatos serão alterados contactUserIds: type: array items: type: string minimum: 1 description: Lista de contatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/deleteContactBatch: post: description: Endpoint para deletar registros de newContactBatch tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – newContactBatchIds properties: newContactBatchIds: type: array items: type: string minimum: 1 description: Lista de identificação do newContactBatch responses: 200: description: Ok schema: type: object required: – newContactBatchIdsNotFound properties: hasError: type: boolean description: Se houve erro na execução default: false newContactBatchIdsNotFound: type: array items: type: string minimum: 1 description: Lista de identificação do newContactBatch não encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/newContactUserBatch: post: description: Primitiva para gerar contato em Lote através de arquivo .csv tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo de importação responses: 200: description: Ok schema: type: object required: – newContactUserBatchId – uploadURI properties: newContactUserBatchId: type: string description: ID do novo lote de importação de contatos uploadURI: type: string description: URL para upload do arquivo de importação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/processContactUserBatch: post: description: Primitiva que executa a importação de contatos a partir do arquivo enviado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – newContactBatchId properties: newContactBatchId: type: string description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/addContactUsersToAssociations: post: description: Primitiva que relaciona lista de Usuários Contatos com lista de grupos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contactUserIds – associations properties: contactUserIds: type: array items: type: string minimum: 1 description: Lista de contatos associations: type: array items: type: object allOf: – #/definitions/associationDTO minimum: 1 description: Lista de Grupos/Associações responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/editContactUser: post: description: Primitiva para Editar um contato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contactUserId properties: contactUserId: type: string description: Id do contato phone: type: string description: Telefone do Contato Usuário email: type: string description: E-mail do Contato Usuário login: type: string description: Login na platforma do Contato Usuário associations: type: array items: type: object allOf: – #/definitions/associationDTO description: Grupos que o Contato Usuário pertence responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/importContact: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/importContactUser: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/importAssociation: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/importNewContactBatch: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/importContactLog: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/importContactUserLog: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/importUserConfig: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/importAssociationLog: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/actions/importNewContactBatchLog: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/events/importContactEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/exportContactEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/importContactUserEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/exportContactUserEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/importAssociationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/exportAssociationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/importNewContactBatchEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/exportNewContactBatchEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/importContactLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/exportContactLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/importContactUserLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/exportContactUserLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/importUserConfigEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/exportUserConfigEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/importAssociationLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/exportAssociationLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/importNewContactBatchLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/events/exportNewContactBatchLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contact/entities/contact: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contact responses: 200: description: The created resource schema: #/definitions/contact 401: description: Invalid Credentials 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/contact responses: 200: description: The created resource schema: #/definitions/contact 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contact/{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/editContact responses: 200: description: Ok schema: #/definitions/editContact 401: description: Invalid Credentials 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/contact responses: 200: description: Ok schema: #/definitions/contact 401: description: Invalid Credentials 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/contact 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contact/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contactUser: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contactUser responses: 200: description: The created resource schema: #/definitions/contactUser 401: description: Invalid Credentials 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/contactUser responses: 200: description: The created resource schema: #/definitions/contactUser 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contactUser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contactUser/{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/editContactUser responses: 200: description: Ok schema: #/definitions/editContactUser 401: description: Invalid Credentials 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/contactUser responses: 200: description: Ok schema: #/definitions/contactUser 401: description: Invalid Credentials 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/contactUser 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contactUser/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contactUser responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/association: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/association responses: 200: description: The created resource schema: #/definitions/association 401: description: Invalid Credentials 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/association responses: 200: description: The created resource schema: #/definitions/association 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/association 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/association/{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/editAssociation responses: 200: description: Ok schema: #/definitions/editAssociation 401: description: Invalid Credentials 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/association responses: 200: description: Ok schema: #/definitions/association 401: description: Invalid Credentials 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/association 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/association/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/association responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/newContactBatch: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/newContactBatch responses: 200: description: The created resource schema: #/definitions/newContactBatch 401: description: Invalid Credentials 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/newContactBatch responses: 200: description: The created resource schema: #/definitions/newContactBatch 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/newContactBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/newContactBatch/{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/editNewContactBatch responses: 200: description: Ok schema: #/definitions/editNewContactBatch 401: description: Invalid Credentials 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/newContactBatch responses: 200: description: Ok schema: #/definitions/newContactBatch 401: description: Invalid Credentials 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/newContactBatch 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/newContactBatch/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/newContactBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contactLog: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contactLog responses: 200: description: The created resource schema: #/definitions/contactLog 401: description: Invalid Credentials 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/contactLog responses: 200: description: The created resource schema: #/definitions/contactLog 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contactLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contactLog/{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/editContactLog responses: 200: description: Ok schema: #/definitions/editContactLog 401: description: Invalid Credentials 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/contactLog responses: 200: description: Ok schema: #/definitions/contactLog 401: description: Invalid Credentials 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/contactLog 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contactLog/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contactLog responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contactUserLog: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contactUserLog responses: 200: description: The created resource schema: #/definitions/contactUserLog 401: description: Invalid Credentials 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/contactUserLog responses: 200: description: The created resource schema: #/definitions/contactUserLog 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contactUserLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contactUserLog/{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/editContactUserLog responses: 200: description: Ok schema: #/definitions/editContactUserLog 401: description: Invalid Credentials 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/contactUserLog responses: 200: description: Ok schema: #/definitions/contactUserLog 401: description: Invalid Credentials 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/contactUserLog 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/contactUserLog/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contactUserLog responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/userConfig: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userConfig responses: 200: description: The created resource schema: #/definitions/userConfig 401: description: Invalid Credentials 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/userConfig responses: 200: description: The created resource schema: #/definitions/userConfig 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/userConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/userConfig/{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/editUserConfig responses: 200: description: Ok schema: #/definitions/editUserConfig 401: description: Invalid Credentials 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/userConfig responses: 200: description: Ok schema: #/definitions/userConfig 401: description: Invalid Credentials 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/userConfig 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/userConfig/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userConfig responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/AssociationLog: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/AssociationLog responses: 200: description: The created resource schema: #/definitions/AssociationLog 401: description: Invalid Credentials 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/AssociationLog responses: 200: description: The created resource schema: #/definitions/AssociationLog 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/AssociationLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/AssociationLog/{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/editAssociationLog responses: 200: description: Ok schema: #/definitions/editAssociationLog 401: description: Invalid Credentials 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/AssociationLog responses: 200: description: Ok schema: #/definitions/AssociationLog 401: description: Invalid Credentials 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/AssociationLog 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/AssociationLog/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/AssociationLog responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/newContactBatchLog: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/newContactBatchLog responses: 200: description: The created resource schema: #/definitions/newContactBatchLog 401: description: Invalid Credentials 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/newContactBatchLog responses: 200: description: The created resource schema: #/definitions/newContactBatchLog 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/newContactBatchLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/newContactBatchLog/{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/editNewContactBatchLog responses: 200: description: Ok schema: #/definitions/editNewContactBatchLog 401: description: Invalid Credentials 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/newContactBatchLog responses: 200: description: Ok schema: #/definitions/newContactBatchLog 401: description: Invalid Credentials 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/newContactBatchLog 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contact/entities/newContactBatchLog/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/newContactBatchLog responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckStatus: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Executando normalmente * `DOWN` – Com problemas batchProcessStatus: type: string enum: – PROCESSING – SUCCESS – SUCCESS_PARTIAL – ERROR description: Status do Processamento do Lote: * `PROCESSING` – Processando * `SUCCESS` – Finalizado com sucesso * `SUCCESS_PARTIAL` – Finalizado parcialmente com sucesso (1 ou mais documentos não foram criados) * `ERROR` – Erro na criação de todos os documentos do lote typeLogAction: type: string enum: – INSERT – UPDATE – DELETE description: Tipo de Ação do LOG: * `INSERT` – Inserção de Novo Cadastro * `UPDATE` – Atualização de Cadastro * `DELETE` – Exclusão de Cadastro orderByFieldContactUserBatch: type: string enum: – CREATED_AT – STATUS description: Ordem de listagem de importação de contatos: * `CREATED_AT` – Data de Criação * `STATUS` – Status da importação do arquivo orderType: type: string enum: – ASC – DESC description: Tipo da ordenação: * `ASC` – Crescente * `DESC` – Decrescente orderByField: type: string enum: – CPF – NAME – BIRTHDAY description: Ordem de listagem dos usuários: * `CPF` – CPF do Usuário * `NAME` – Nome do Usuário * `BIRTHDAY` – Data de Nascimento do Usuário userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde associationDTO: description: Associação DTO type: object required: – associationName properties: associationId: type: string description: ID da Associação associationName: type: string description: Nome da Associação contactBatchDTO: description: Arquivo de importação DTO type: object required: – createdAt – createdBy – status properties: id: type: string description: ID createdAt: type: string format: date-time description: Data de Criação createdBy: type: string description: Criado por fileName: type: string description: Nome do arquivo status: type: string allOf: – #/definitions/batchProcessStatus description: Status da Importação errorMessage: type: string description: Descrição do possível erro de importação contactDTO: description: Record para o contato type: object properties: id: type: string description: Id do contato name: type: string description: Nome do contato cpf: type: string description: CPF do contato birthday: type: string description: Data de nascimento do contato phone: type: string description: Telefone do contato email: type: string description: Email do contato login: type: string description: Login do contato active: type: boolean description: Status do cadastro createdBy: type: string description: Criado por createdAt: type: string format: date-time description: Criado em associationCompleteDTO: description: Associação DTO type: object required: – name – contactUserTotal – active – createdAt – createdBy – updatedAt – updatedBy properties: id: type: string description: ID da Associação name: type: string description: Nome da Associação contactUserTotal: type: integer format: int64 description: Quantidade de Contatos relacionados active: type: boolean description: Status do grupo createdAt: type: string format: date-time description: Criado em createdBy: type: string description: Criado por updatedAt: type: string format: date-time description: Atualizado em updatedBy: type: string description: Atualizado por contactUserDTO: description: Record para a lista de usuários type: object required: – id – cpf – name – birthday – phone – email – login – active – createdAt – createdBy – updatedAt – updatedBy properties: id: type: string description: Id do usuário cpf: type: string description: CPF do usuário name: type: string description: Nome do usuário birthday: type: string description: Data de Nascimento do usuário phone: type: string description: Telefone do usuário email: type: string description: Email do usuário login: type: string description: Login do usuário active: type: boolean description: Status do usuário createdAt: type: string format: date-time description: Criado em createdBy: type: string description: Criado por updatedAt: type: string format: date-time description: Atualizado em updatedBy: type: string description: Atualizado por associations: type: array items: type: object allOf: – #/definitions/associationDTO description: Associações do usuário userConfigDTO: description: type: object required: – id – login – jsonValue – createdAt – createdBy – updatedAt – updatedBy properties: id: type: string description: Id do usuário login: type: string description: Login do usuário jsonValue: type: string description: Json dos dados de configuração createdAt: type: string format: date-time description: Criado em createdBy: type: string description: Criado por updatedAt: type: string format: date-time description: Atualizado em updatedBy: type: string description: Atualizado por contact: description: Entidade de Contato type: object required: – name – cpf – birthday properties: id: type: string format: uuid description: Identificação name: type: string description: Nome completo do Contato cpf: type: string description: CPF do Contato birthday: type: string format: date description: Data de Nascimento do Contato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContact: type: object required: – id allOf: – #/definitions/contact contactUser: description: Entidade de Usuário Contato type: object required: – contactId – active properties: id: type: string format: uuid description: Identificação contactId: type: string format: uuid description: Id do contato email: type: string description: Email do Usuário Contato phone: type: string description: Telefone do Usuário Contato login: type: string description: Login do Usuário Contato active: type: boolean description: Status Usuário Contato associations: type: array items: type: object allOf: – #/definitions/association description: Associações do Usuário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContactUser: type: object required: – id allOf: – #/definitions/contactUser association: description: Entidade de Associações de Usuários type: object required: – name – active properties: id: type: string format: uuid description: Identificação name: type: string description: Nome do Grupo active: type: boolean description: Status do Grupo contactUsers: type: array items: type: object allOf: – #/definitions/contactUser description: Usuários do Grupo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAssociation: type: object required: – id allOf: – #/definitions/association newContactBatch: description: Entidade de Lote de Contatos type: object required: – name – status – uploadId – versionId properties: id: type: string format: uuid description: Identificação name: type: string description: Nome do Arquivo CSV enviado status: type: string allOf: – #/definitions/batchProcessStatus description: Status do Processamento uploadId: type: string description: Chave do Id do Upload do Arquivo versionId: type: string description: ID da versão do Arquivo errorMessage: type: string description: Descrição do possível erro de importação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editNewContactBatch: type: object required: – id allOf: – #/definitions/newContactBatch contactLog: description: Entidade de Log de Contato type: object required: – contactId – type – detail properties: id: type: string format: uuid description: Identificação contactId: type: string format: uuid description: Id do contato type: type: string allOf: – #/definitions/typeLogAction description: Tipo de Ação do LOG detail: type: string description: Detalhe do Log createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContactLog: type: object required: – id allOf: – #/definitions/contactLog contactUserLog: description: Entidade de Log de Usuário Contato type: object required: – contactUserId – type – detail properties: id: type: string format: uuid description: Identificação contactUserId: type: string format: uuid description: Id do user contact type: type: string allOf: – #/definitions/typeLogAction description: Tipo de Ação do LOG detail: type: string description: Detalhe do Log createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContactUserLog: type: object required: – id allOf: – #/definitions/contactUserLog userConfig: description: Entidade de Configuração de Usuário type: object required: – login – jsonValue properties: id: type: string format: uuid description: Identificação login: type: string description: Login do Usuário jsonValue: type: string description: Json dos dados de configuração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editUserConfig: type: object required: – id allOf: – #/definitions/userConfig AssociationLog: description: Entidade de Log de Association type: object required: – associationId – type – detail properties: id: type: string format: uuid description: Identificação associationId: type: string format: uuid description: Id do association type: type: string allOf: – #/definitions/typeLogAction description: Tipo de Ação do LOG detail: type: string description: Detalhe do Log createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAssociationLog: type: object required: – id allOf: – #/definitions/AssociationLog newContactBatchLog: description: Entidade de Log de New Contact Batch type: object required: – newContactBatchId – type – detail properties: id: type: string format: uuid description: Identificação newContactBatchId: type: string format: uuid description: Id do new contact batch type: type: string allOf: – #/definitions/typeLogAction description: Tipo de Ação do LOG detail: type: string description: Detalhe do Log createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editNewContactBatchLog: type: object required: – id allOf: – #/definitions/newContactBatchLog 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação