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

feedback

54 views 0 19/06/2023 Atualizado em 20/06/2024 integrador

2.0info: 1.1.3 feedback description: Serviço de Feedback do ERP XT. x-senior-domain: erpxt x-senior-domain-path: erpxt x-senior-service-path: feedback 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/erpxtsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /feedback/queries/healthcheck: post: description: Verificação disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status do serviço checks: type: object allOf: – #/definitions/checkDTO description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verificação disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status do serviço checks: type: object allOf: – #/definitions/checkDTO description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/getTagKeys: post: description: Busca todas as chaves de tags existentes para uma aplicação sem repetição de valores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – appKey properties: appKey: type: string maxLength: 255 description: Chave da aplicação responses: 200: description: Ok schema: type: object properties: keys: type: array items: type: string maxLength: 255 description: Chaves distintas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todas as chaves de tags existentes para uma aplicação sem repetição de valores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: appKey description: Chave da aplicação in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object properties: keys: type: array items: type: string maxLength: 255 description: Chaves distintas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/getTotalizers: post: description: Busca os totalizadores de feedback de uma aplicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – appKey – startDate – endDate properties: appKey: type: string maxLength: 255 description: Chave da aplicação startDate: type: string format: date-time description: Data inicial endDate: type: string format: date-time description: Data final userFeedbackIds: type: array items: type: string maxLength: 255 description: Ids para filtro dos totalizadores de feedback por usuários responses: 200: description: Ok schema: type: object required: – userAmount – feedbackAmount – feedbackCommentAmount – averageRating properties: userAmount: type: integer format: int64 description: Quantidade de usuários únicos feedbackAmount: type: integer format: int64 description: Quantidade de feedbacks feedbackCommentAmount: type: integer format: int64 description: Quantidade de feedbacks com comentários averageRating: type: number format: double description: Média das avaliações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/getRatingDistribution: post: description: Busca os dados relacionados a distribuição de feedback por nota em um período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – appKey – startPeriod – endPeriod properties: appKey: type: string maxLength: 255 description: Chave da aplicação startPeriod: type: string maxLength: 255 description: Periodo inicial endPeriod: type: string maxLength: 255 description: Periodo final responses: 200: description: Ok schema: type: object required: – dataset properties: dataset: type: array items: type: object allOf: – #/definitions/feedbackRating minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados relacionados a distribuição de feedback por nota em um período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: appKey description: Chave da aplicação in: query required: true type: string maxLength: 255 – name: startPeriod description: Periodo inicial in: query required: true type: string maxLength: 255 – name: endPeriod description: Periodo final in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – dataset properties: dataset: type: array items: type: object allOf: – #/definitions/feedbackRating minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/getUserFeedbacksById: post: description: Query que busca todos os feedbacks do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Id do usuário responses: 200: description: Ok schema: type: object required: – amount – userId – userApplicationFeedbacks properties: amount: type: integer format: int64 description: Quantidade de aplicações userId: type: string maxLength: 255 description: Identificação do usuário userApplicationFeedbacks: type: array items: type: object allOf: – #/definitions/userApplicationFeedbacks minimum: 1 description: Lista de aplicações com os feedbacks 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query que busca todos os feedbacks do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id do usuário in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – amount – userId – userApplicationFeedbacks properties: amount: type: integer format: int64 description: Quantidade de aplicações userId: type: string maxLength: 255 description: Identificação do usuário userApplicationFeedbacks: type: array items: type: object allOf: – #/definitions/userApplicationFeedbacks minimum: 1 description: Lista de aplicações com os feedbacks 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/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 maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 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 maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/exportApplication: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/exportTag: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/exportUserFeedback: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/exportFeedback: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/exportApplicationView: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/exportUserFeedbackView: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/exportDashboardView: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/queries/exportFeedbackRatingView: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/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 /feedback/actions/revokeApiKey: post: description: Reseta a chave de uma aplicação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificador da aplicação responses: 200: description: Ok schema: type: object allOf: – #/definitions/application 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/actions/sendFeedback: post: description: Action que registra um feedback de usuário para uma aplicação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – applicationKey – userIdentificator – name – email – rating properties: applicationKey: type: string maxLength: 255 description: Chave única da aplicação gerada pelo sistema userIdentificator: type: string maxLength: 255 description: Identificação do usuário utilizada para verificar se o usuário já existe na base de dados name: type: string maxLength: 255 description: Nome do usuário email: type: string maxLength: 255 description: E-mail do usuário rating: type: number format: double description: Pontuação feedbackComment: type: string maxLength: 255 description: Comentário tags: type: array items: type: object allOf: – #/definitions/tag description: tags responses: 200: description: Ok schema: type: object allOf: – #/definitions/feedback default: description: Error response schema: #/definitions/genericError /feedback/actions/importApplication: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/actions/importTag: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/actions/importUserFeedback: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/actions/importFeedback: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/actions/importApplicationView: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/actions/importUserFeedbackView: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/actions/importDashboardView: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/actions/importFeedbackRatingView: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/events/importApplicationEvent: 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 /feedback/events/exportApplicationEvent: 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 /feedback/events/importTagEvent: 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 /feedback/events/exportTagEvent: 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 /feedback/events/importUserFeedbackEvent: 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 /feedback/events/exportUserFeedbackEvent: 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 /feedback/events/importFeedbackEvent: 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 /feedback/events/exportFeedbackEvent: 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 /feedback/events/importApplicationViewEvent: 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 /feedback/events/exportApplicationViewEvent: 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 /feedback/events/importUserFeedbackViewEvent: 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 /feedback/events/exportUserFeedbackViewEvent: 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 /feedback/events/importDashboardViewEvent: 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 /feedback/events/exportDashboardViewEvent: 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 /feedback/events/importFeedbackRatingViewEvent: 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 /feedback/events/exportFeedbackRatingViewEvent: 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 /feedback/entities/application: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/application responses: 200: description: The created resource schema: #/definitions/application 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/application responses: 200: description: The created resource schema: #/definitions/application 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: array items: #/definitions/application 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/application/{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/editApplication responses: 200: description: Ok schema: #/definitions/editApplication 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/application responses: 200: description: Ok schema: #/definitions/application 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/application 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 /feedback/entities/application/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/application responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/tag: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tag responses: 200: description: The created resource schema: #/definitions/tag 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/tag responses: 200: description: The created resource schema: #/definitions/tag 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: array items: #/definitions/tag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/tag/{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/editTag responses: 200: description: Ok schema: #/definitions/editTag 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/tag responses: 200: description: Ok schema: #/definitions/tag 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/tag 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 /feedback/entities/feedback/{parentId}/tags: 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/tag responses: 200: description: The created resources schema: type: array items: #/definitions/tag 401: description: Invalid Credentials 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/tag responses: 200: description: The created resources schema: type: array items: #/definitions/tag 401: description: Invalid Credentials 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 – 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: array items: #/definitions/tag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/feedback/{parentId}/tags/{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/editTag responses: 200: description: Ok schema: #/definitions/editTag 401: description: Invalid Credentials 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/tag responses: 200: description: Ok schema: #/definitions/tag 401: description: Invalid Credentials 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/tag 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/tag/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tag responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/userFeedback: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userFeedback responses: 200: description: The created resource schema: #/definitions/userFeedback 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/userFeedback responses: 200: description: The created resource schema: #/definitions/userFeedback 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: array items: #/definitions/userFeedback 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/userFeedback/{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/editUserFeedback responses: 200: description: Ok schema: #/definitions/editUserFeedback 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/userFeedback responses: 200: description: Ok schema: #/definitions/userFeedback 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/userFeedback 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 /feedback/entities/userFeedback/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userFeedback responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/feedback: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/feedback responses: 200: description: The created resource schema: #/definitions/feedback 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/feedback responses: 200: description: The created resource schema: #/definitions/feedback 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: array items: #/definitions/feedback 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/feedback/{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/editFeedback responses: 200: description: Ok schema: #/definitions/editFeedback 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/feedback responses: 200: description: Ok schema: #/definitions/feedback 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/feedback 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 /feedback/entities/feedback/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/feedback responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/applicationView: 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: array items: #/definitions/applicationView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/userFeedbackView: 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: array items: #/definitions/userFeedbackView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/dashboardView: 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: array items: #/definitions/dashboardView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /feedback/entities/feedbackRatingView: 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: array items: #/definitions/feedbackRatingView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: description: Define o Status do serviço type: string enum: – UP – DOWN 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 – LOCALDATETIME – 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 checkDTO: description: Dados do healthcheck type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome do healthcheck status: type: string allOf: – #/definitions/healthcheckDTO description: Status do healthcheck feedbackRating: description: Dados para o gráfico de distribuição de feedbacks por avaliação type: object required: – feedbackAmount – rating properties: feedbackAmount: type: integer format: int64 description: Quantidade de feedbacks rating: type: number format: double description: Avaliações userApplicationFeedbacks: description: Dados para lista de aplicações com os feedbacks type: object required: – name – feedbacks properties: id: type: string maxLength: 255 description: Identificador da aplicação name: type: string maxLength: 255 description: Nome da applicação feedbacks: type: array items: type: object allOf: – #/definitions/feedback minimum: 1 description: Lista de feedbacks application: description: Aplicação a tomar feedback type: object required: – name properties: id: type: string format: uuid description: Identificador da aplicação applicationKey: type: string format: uuid description: Chave única gerada pelo sistema name: type: string maxLength: 255 description: Nome da aplicação description: type: string maxLength: 2000 description: Descrição da aplicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: editApplication: type: object required: – id allOf: – #/definitions/application tag: description: Tag a ser utilizada como custom propertie type: object required: – name – value properties: id: type: string format: uuid description: Identificador da tag feedback: type: object allOf: – #/definitions/feedback description: Feedback vinculado a tag name: type: string maxLength: 255 description: Nome da tag value: type: string maxLength: 255 description: Nome da tag createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: editTag: type: object required: – id allOf: – #/definitions/tag userFeedback: description: Usuário que vai fornecer feedback type: object required: – identificator – name – email properties: id: type: string format: uuid description: Identificador do usuário identificator: type: string maxLength: 255 description: Identificação do usuário name: type: string maxLength: 255 description: Nome do usuário email: type: string maxLength: 255 description: Email do usuário createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: editUserFeedback: type: object required: – id allOf: – #/definitions/userFeedback feedback: description: Feedback type: object required: – application – userFeedback – rating properties: id: type: string format: uuid description: Identificador do feedback application: type: object allOf: – #/definitions/application description: Aplicação atrelada ao feedback userFeedback: type: object allOf: – #/definitions/userFeedback description: Usuário atrelado ao feedback rating: type: number format: double description: Pontuação feedbackComment: type: string maxLength: 1000 description: Comentário tags: type: array items: type: object allOf: – #/definitions/tag description: Tags customizadas createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: editFeedback: type: object required: – id allOf: – #/definitions/feedback applicationView: description: View de listagem de aplicações type: object required: – name – description – feedbackAmount properties: id: type: string format: uuid description: Identificador da aplicação applicationKey: type: string format: uuid description: Chave única gerada pelo sistema name: type: string maxLength: 255 description: Nome da aplicação description: type: string maxLength: 2000 description: Descrição da aplicação feedbackAmount: type: integer format: int64 description: Quantidade de feedbacks createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: userFeedbackView: description: View de relação entre aplicações e usuarios de feedback type: object required: – userFeedbackIdentificator – userFeedbackName – userFeedbackEmail properties: id: type: string format: uuid description: Identificador do feedback userFeedbackId: type: string format: uuid description: Identificador do usuário userFeedbackIdentificator: type: string maxLength: 255 description: Identificador externo do usuário userFeedbackName: type: string maxLength: 255 description: Nome do usuário userFeedbackEmail: type: string maxLength: 255 description: E-mail do usuário applicationKey: type: string format: uuid description: Chave da aplicação vinculada ao feedback dashboardView: description: View para os gráficos do dashboard type: object required: – period – feedbackAmount – averageRating properties: period: type: string maxLength: 255 description: Período da amostragem feedbackAmount: type: integer format: int64 description: Quantidade de feedbacks averageRating: type: number format: double description: Média das avaliações applicationKey: type: string format: uuid description: Chave da aplicação vinculada ao feedback feedbackRatingView: description: View para os gráficos de distribuição de notas por feedback type: object required: – id – applicationId – period – rating – amount properties: id: type: string maxLength: 255 description: Id applicationId: type: string format: uuid description: Id da aplicação period: type: string maxLength: 255 description: Período da amostragem rating: type: number format: double description: Nota amount: type: integer format: int64 description: Quantidade de feedbacks applicationKey: type: string format: uuid description: Chave da aplicação vinculada aos feedbacks 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 maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 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 maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 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 maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 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 maxLength: 255 description: message: type: string maxLength: 255 description: exceptionClass: type: string maxLength: 255 description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string maxLength: 255 description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string maxLength: 255 description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string maxLength: 255 description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string maxLength: 255 description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string maxLength: 255 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 maxLength: 255 description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string maxLength: 255 description: beanClass: type: string maxLength: 255 description: serviceClass: type: string maxLength: 255 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 maxLength: 255 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 maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string maxLength: 255 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 maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string maxLength: 255 description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string maxLength: 255 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 maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 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

Este artigo foi útil para você?

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