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

Campanhas (campaign)

34 views 0 29/05/2023 Atualizado em 07/08/2024 integrador

2.0info: 1.13.1 Campanhas description: Serviço responsável pelo módulo Campanhas do CRM. x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: campaign 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/crmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /campaign/queries/healthcheck: post: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/upDownEnum description: Status geral do serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/upDownEnum description: Status geral do serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/queries/confirmRead: post: description: Recebe através de uma string os dados para confirmar a leitura do email tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: string maxLength: 10485760 description: Dados do email responses: 200: description: Ok schema: type: object required: – confirmed properties: confirmed: type: boolean description: Se foi confirmada leitura com sucesso ou não default: description: Error response schema: #/definitions/genericError get: description: Recebe através de uma string os dados para confirmar a leitura do email tags: – Queries x-senior-visibility: PRIVATE parameters: – name: data description: Dados do email in: query required: true type: string maxLength: 10485760 responses: 200: description: Ok schema: type: object required: – confirmed properties: confirmed: type: boolean description: Se foi confirmada leitura com sucesso ou não default: description: Error response schema: #/definitions/genericError /campaign/queries/getAnalyticsEmailMarketing: post: description: Pegar dados gerais de visualização de um email marketing por período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – analytics – filter properties: analytics: type: string allOf: – #/definitions/analyticsEnum description: Analytics filter: type: object allOf: – #/definitions/analyticsFiltersRecord description: Filtro responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/analyticsResultRecord minimum: 1 description: Resultados do Analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/queries/getUrlUploadFiles: post: description: Retornar a url do S3 para realizar o upload dos arquivos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/urlUploadFileRecord minimum: 1 description: Arquivos responses: 200: description: Ok schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/urlUploadFileRecord minimum: 1 description: Arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/queries/getUrlDownloadFiles: post: description: Retornar a url do S3 para realizar o download dos arquivos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/urlDownloadFilesRecord minimum: 1 description: Arquivos responses: 200: description: Ok schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/urlDownloadFilesRecord minimum: 1 description: Arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/queries/getSmartMessage: post: description: Gerar mensagem inteligente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – subject – objective properties: subject: type: string maxLength: 10485760 description: Assunto objective: type: string maxLength: 255 description: Objetivo responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string maxLength: 10485760 description: Texto gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gerar mensagem inteligente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: subject description: Assunto in: query required: true type: string maxLength: 10485760 – name: objective description: Objetivo in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string maxLength: 10485760 description: Texto gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/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 /campaign/queries/exportAccount: 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 /campaign/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/queries/exportCancellationReason: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/queries/exportCampaignType: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/queries/exportEmailMarketing: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/queries/exportEmailMarketingTargetAudience: 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 /campaign/queries/exportTemplateEmailMarketing: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/queries/exportEmailMarketingAttachment: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/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 /campaign/actions/emailTest: post: description: Action referente ao email de teste tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – subject – content properties: subject: type: string maxLength: 255 description: Assunto content: type: string maxLength: 10485760 description: Conteúdo responses: 200: description: Ok schema: type: object required: – sent properties: sent: type: boolean description: Email enviado com sucesso ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/manageEmailMarketing: post: description: Gerenciar a criação/atualização de um emailMarketing tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/emailMarketingRecord responses: 200: description: Ok schema: type: object allOf: – #/definitions/emailMarketingRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/sendPlannedEmailsMarketing: post: description: Action assíncrona que inicia o processo dos envios de email dos Emails Marketing com o status atual como PLANNED tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – sendingStarted properties: sendingStarted: type: boolean description: Se começou o envio das campanhas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/confirmUploadFiles: post: description: Confirmará o upload dos arquivos tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/urlUploadFileRecord minimum: 1 description: Arquivos responses: 200: description: Ok schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/urlUploadFileRecord minimum: 1 description: Arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/configureEnvironment: post: description: Configurar ambiente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenants: type: array items: type: string maxLength: 255 description: Tenants responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se a configuração foi realizada com sucesso ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/importAccount: 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 /campaign/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/importCancellationReason: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/importCampaignType: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/importEmailMarketing: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/importEmailMarketingTargetAudience: 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 /campaign/actions/importTemplateEmailMarketing: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/actions/importEmailMarketingAttachment: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/events/importAccountEvent: 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 /campaign/events/exportAccountEvent: 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 /campaign/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 /campaign/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 /campaign/events/importCancellationReasonEvent: 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 /campaign/events/exportCancellationReasonEvent: 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 /campaign/events/importCampaignTypeEvent: 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 /campaign/events/exportCampaignTypeEvent: 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 /campaign/events/importEmailMarketingEvent: 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 /campaign/events/exportEmailMarketingEvent: 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 /campaign/events/importEmailMarketingTargetAudienceEvent: 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 /campaign/events/exportEmailMarketingTargetAudienceEvent: 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 /campaign/events/importTemplateEmailMarketingEvent: 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 /campaign/events/exportTemplateEmailMarketingEvent: 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 /campaign/events/importEmailMarketingAttachmentEvent: 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 /campaign/events/exportEmailMarketingAttachmentEvent: 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 /campaign/entities/cancellationReason: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cancellationReason responses: 200: description: The created resource schema: #/definitions/cancellationReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cancellationReason responses: 200: description: The created resource schema: #/definitions/cancellationReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC 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/cancellationReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/cancellationReason/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCancellationReason responses: 200: description: Ok schema: #/definitions/editCancellationReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cancellationReason responses: 200: description: Ok schema: #/definitions/cancellationReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cancellationReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/cancellationReason/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cancellationReason responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/campaignType: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/campaignType responses: 200: description: The created resource schema: #/definitions/campaignType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/campaignType responses: 200: description: The created resource schema: #/definitions/campaignType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC 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/campaignType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/campaignType/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCampaignType responses: 200: description: Ok schema: #/definitions/editCampaignType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/campaignType responses: 200: description: Ok schema: #/definitions/campaignType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/campaignType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/campaignType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/campaignType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/emailMarketing: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/emailMarketing responses: 200: description: The created resource schema: #/definitions/emailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/emailMarketing responses: 200: description: The created resource schema: #/definitions/emailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC 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/emailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/emailMarketing/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmailMarketing responses: 200: description: Ok schema: #/definitions/editEmailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/emailMarketing responses: 200: description: Ok schema: #/definitions/emailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/emailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/emailMarketing/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/emailMarketing responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/emailMarketingTargetAudience: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/emailMarketingTargetAudience responses: 200: description: The created resource schema: #/definitions/emailMarketingTargetAudience 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/emailMarketingTargetAudience responses: 200: description: The created resource schema: #/definitions/emailMarketingTargetAudience 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/emailMarketingTargetAudience 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/emailMarketingTargetAudience/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmailMarketingTargetAudience responses: 200: description: Ok schema: #/definitions/editEmailMarketingTargetAudience 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/emailMarketingTargetAudience responses: 200: description: Ok schema: #/definitions/emailMarketingTargetAudience 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/emailMarketingTargetAudience 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /campaign/entities/emailMarketingTargetAudience/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/emailMarketingTargetAudience responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/templateEmailMarketing: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/templateEmailMarketing responses: 200: description: The created resource schema: #/definitions/templateEmailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/templateEmailMarketing responses: 200: description: The created resource schema: #/definitions/templateEmailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC 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/templateEmailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/templateEmailMarketing/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTemplateEmailMarketing responses: 200: description: Ok schema: #/definitions/editTemplateEmailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/templateEmailMarketing responses: 200: description: Ok schema: #/definitions/templateEmailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/templateEmailMarketing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/templateEmailMarketing/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/templateEmailMarketing responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/emailMarketingAttachment: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/emailMarketingAttachment responses: 200: description: The created resource schema: #/definitions/emailMarketingAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/emailMarketingAttachment responses: 200: description: The created resource schema: #/definitions/emailMarketingAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC 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/emailMarketingAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/emailMarketingAttachment/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmailMarketingAttachment responses: 200: description: Ok schema: #/definitions/editEmailMarketingAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/emailMarketingAttachment responses: 200: description: Ok schema: #/definitions/emailMarketingAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/emailMarketingAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /campaign/entities/emailMarketingAttachment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/emailMarketingAttachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDownEnum: description: Up ou down type: string enum: – UP – DOWN senderOptionEnum: description: Enum referente a origem do email marketing type: string enum: – SMTP – RESPONSIBLE_ACCOUNT – MANUAL targetAudienceTypeEnum: description: Enum do tipo de público alvo type: string enum: – ACCOUNTS_AND_CONTACTS – ACCOUNTS_ONLY – ACCOUNT_CONTACTS_ONLY statusEnum: description: Enum referente ao status do email marketing type: string enum: – DRAFT – PLANNED – PREPARING – IN_PROGRESS – FINISHED – CANCELED analyticsEnum: description: Analytics disponíveis type: string enum: – READING_PERCENTAGE_ACCOUNT – READING_PERCENTAGE_CONTACT – READ_BY_DATE messageTypeEmailMarketingEnum: description: Enum referente ao tipo de mensagem do Email Marketing a ser enviada type: string enum: – TEXT – IMPORTED_HTML – TEMPLATE messageTypeTemplateEmailMarketingEnum: description: Enum referente ao tipo de mensagem do Email Marketing a ser enviada type: string enum: – TEXT – IMPORTED_HTML folderUploadEnum: description: Pasta armazenar os arquivos type: string enum: – EMAIL_MARKETING_ATTACHMENT – EMAIL_MARKETING_BODY – EMAIL_MARKETING_TEMPLATE_BODY 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 customRecord: description: Records com o atributo custom discriminator: _discriminator type: object required: – _discriminator properties: custom: type: string format: byte description: Campos customizados _discriminator: type: string maxLength: 255 description: emailMarketingRecord: description: Record igual a facade emailMarketing allOf: – #/definitions/customRecord – type: object required: – name – status – campaignType – scheduling – targetAudienceType – senderOption – subject – body – messageType properties: id: type: string maxLength: 255 description: Id name: type: string maxLength: 255 description: Nome status: type: string allOf: – #/definitions/statusEnum description: Status campaignType: type: object allOf: – #/definitions/campaignType description: Tipo da Campanha expectedRevenue: type: string description: Receita esperada expectedAnswer: type: number format: double description: Resposta esperada estimatedCost: type: string description: Custo estimado realCost: type: string description: Custo real scheduling: type: string format: date-time description: Agendamento note: type: string maxLength: 500 description: Observação targetAudienceType: type: string allOf: – #/definitions/targetAudienceTypeEnum description: Tipo de público alvo senderOption: type: string allOf: – #/definitions/senderOptionEnum description: Opção de Resposta subject: type: string maxLength: 255 description: Assunto sender: type: string maxLength: 255 description: Remetente replyTo: type: string maxLength: 255 description: Responder para body: type: string maxLength: 10485760 description: Corpo do email filters: type: array items: type: string maxLength: 255 description: Filtros negativeFilters: type: array items: type: integer format: int64 description: Negativa dos filtros cancellationReason: type: object allOf: – #/definitions/cancellationReason description: Motivo de Cancelamento messageType: type: string allOf: – #/definitions/messageTypeEmailMarketingEnum description: Tipo da mensagem template: type: object allOf: – #/definitions/templateEmailMarketing description: Template para o email marketing attachments: type: array items: type: object allOf: – #/definitions/emailMarketingAttachment description: Anexos do Email Marketing analyticsResultRecord: description: Resultado do Analytics type: object required: – name – value properties: name: type: string maxLength: 255 description: Nome value: type: number format: double description: Valor(Total) analyticsFiltersRecord: description: Filtros dos Analytics type: object required: – emailMarketingId properties: emailMarketingId: type: string maxLength: 255 description: Identificador do email marketing accountName: type: string maxLength: 255 description: Nome da Conta contactName: type: string maxLength: 255 description: Nome do contato accountEmail: type: string maxLength: 255 description: Email da Conta contactEmail: type: string maxLength: 255 description: Email do Contato readingStartDate: type: string format: date description: Data de início do envio dos email-s readingEndDate: type: string format: date description: Data de fim do envio dos email-s sent: type: boolean description: Enviados urlUploadFileRecord: description: Upload de arquivo discriminator: _discriminator type: object required: – fileName – folderName – _discriminator properties: fileName: type: string maxLength: 255 description: Nome do arquivo folderName: type: string allOf: – #/definitions/folderUploadEnum description: Nome da pasta type: string maxLength: 255 description: Versão url: type: string maxLength: 500 description: URL _discriminator: type: string maxLength: 255 description: urlDownloadFilesRecord: description: Download de arquivo allOf: – #/definitions/urlUploadFileRecord – type: object properties: isDeleted: type: boolean description: Define se o arquivo foi excluído account: description: Conta type: object properties: id: type: string format: uuid description: ID accountId: type: integer format: int64 description: Id da Conta no CRM name: type: string maxLength: 255 description: Nome type: type: string maxLength: 255 description: Tipo document: type: string maxLength: 255 description: Documento email: type: string maxLength: 1000 description: Email responsibleEmail: type: string maxLength: 255 description: Email do responsável contact: description: Contato type: object properties: id: type: string format: uuid description: ID contactId: type: integer format: int64 description: Id do Contato no CRM name: type: string maxLength: 255 description: Nome email: type: string maxLength: 255 description: Email account: type: object allOf: – #/definitions/account description: Record da conta cancellationReason: description: Motivo/Razão de cancelamento type: object properties: id: type: string format: uuid description: ID name: type: string maxLength: 255 description: Nome active: type: boolean description: Status default: true editCancellationReason: type: object required: – id allOf: – #/definitions/cancellationReason campaignType: description: Tipo de Campanha type: object properties: id: type: string format: uuid description: ID name: type: string maxLength: 255 description: Nome active: type: boolean description: Status default: true editCampaignType: type: object required: – id allOf: – #/definitions/campaignType emailMarketing: description: Email Marketing type: object required: – name – status – campaignType – scheduling – targetAudienceType – senderOption – subject – body – messageType properties: id: type: string format: uuid description: Id name: type: string maxLength: 255 description: Nome status: type: string allOf: – #/definitions/statusEnum description: Status campaignType: type: object allOf: – #/definitions/campaignType description: Tipo da Campanha expectedRevenue: type: string description: Receita esperada expectedAnswer: type: number format: double description: Resposta esperada estimatedCost: type: string description: Custo estimado realCost: type: string description: Custo real scheduling: type: string format: date-time description: Agendamento targetAudienceType: type: string allOf: – #/definitions/targetAudienceTypeEnum description: Tipo de público alvo senderOption: type: string allOf: – #/definitions/senderOptionEnum description: Opção de Resposta note: type: string maxLength: 500 description: Observação subject: type: string maxLength: 255 description: Assunto sender: type: string maxLength: 255 description: Remetente replyTo: type: string maxLength: 255 description: Responder para body: type: string maxLength: 10485760 description: Corpo do email filters: type: string maxLength: 20000 description: Filtros negativeFilters: type: string maxLength: 20000 description: Negativa dos filtros amountTargetAudience: type: integer format: int64 description: Quantidade de publico alvos relacionados cancellationReason: type: object allOf: – #/definitions/cancellationReason description: Motivo de Cancelamento messageType: type: string allOf: – #/definitions/messageTypeEmailMarketingEnum description: Tipo da mensagem template: type: object allOf: – #/definitions/templateEmailMarketing description: Template para o email marketing createdBy: type: string maxLength: 255 description: createdAt: type: string format: date-time description: changedBy: type: string maxLength: 255 description: changedAt: type: string format: date-time description: editEmailMarketing: type: object required: – id allOf: – #/definitions/emailMarketing emailMarketingTargetAudience: description: Público Alvo do Email Marketing type: object required: – emailMarketing – account properties: id: type: string format: uuid description: Id email: type: string maxLength: 255 description: Email destinatário dispatchDate: type: string format: date-time description: Data de envio readDate: type: string format: date-time description: Data de leitura emailMarketing: type: object allOf: – #/definitions/emailMarketing description: Email Marketing account: type: object allOf: – #/definitions/account description: Conta contact: type: object allOf: – #/definitions/contact description: Contato editEmailMarketingTargetAudience: type: object required: – id allOf: – #/definitions/emailMarketingTargetAudience templateEmailMarketing: description: Template para o email marketing type: object required: – name – body properties: id: type: string format: uuid description: ID name: type: string maxLength: 255 description: Nome body: type: string maxLength: 10485760 description: Corpo do template messageType: type: string allOf: – #/definitions/messageTypeTemplateEmailMarketingEnum description: Tipo da mensagem active: type: boolean description: Status default: true editTemplateEmailMarketing: type: object required: – id allOf: – #/definitions/templateEmailMarketing emailMarketingAttachment: description: Anexos do Email Marketing type: object required: – fileName – size properties: id: type: string format: uuid description: ID fileName: type: string maxLength: 255 description: Nome do arquivo size: type: number format: double description: Tamanho do Arquivo minimum: 0 maximum: 20 emailMarketing: type: object allOf: – #/definitions/emailMarketing description: Email Marketing editEmailMarketingAttachment: type: object required: – id allOf: – #/definitions/emailMarketingAttachment 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