2.0info: 4.11.0 pcp_integracao description: PCP – Serviço de integração x-senior-domain: erp_man x-senior-domain-path: erp_man x-senior-service-path: pcp_integracao 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/erp_mansecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /pcp_integracao/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pcp_integracao/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 /pcp_integracao/events/movimentadoEtiqueta: post: description: Etiqueta movimentada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – etiqueta properties: etiqueta: type: object allOf: – #/definitions/etiquetaG5 description: Dados da etiqueta movimentada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/canceladoEtiqueta: post: description: Etiqueta cancelada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – etiqueta properties: etiqueta: type: object allOf: – #/definitions/etiquetaG5 description: Dados da etiqueta cancelada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/inseridoMotivoParada: post: description: Inserido de motivo de parada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – motivoParada properties: motivoParada: type: object allOf: – #/definitions/recMotivoParadaG5 description: Dados do motivo de parada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/alteradoMotivoParada: post: description: Alterado de motivo de parada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – motivoParada properties: motivoParada: type: object allOf: – #/definitions/recMotivoParadaG5 description: Dados do motivo de parada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/excluidoMotivoParada: post: description: Excluido de motivo de parada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – motivoParada properties: motivoParada: type: object allOf: – #/definitions/recMotivoParadaG5 description: Dados do motivo de parada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/inseridoOperador: post: description: Inserido de operador x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – operador properties: operador: type: object allOf: – #/definitions/recOperadorG5 description: Dados do operador responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/alteradoOperador: post: description: Alterado de operador x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – operador properties: operador: type: object allOf: – #/definitions/recOperadorG5 description: Dados do operador responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/excluidoOperador: post: description: Excluido de operador x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – operador properties: operador: type: object allOf: – #/definitions/recOperadorG5 description: Dados do operador responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/inseridoOrdemProducao: post: description: Inserido de ordem de produção x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ordemProducao properties: ordemProducao: type: object allOf: – #/definitions/recOrdemProducaoG5 description: Dados da ordem de produção responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/alteradoOrdemProducao: post: description: Alterado ordem de produção x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ordemProducao properties: ordemProducao: type: object allOf: – #/definitions/recOrdemProducaoG5 description: Dados da ordem de produção responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/iniciadoApontamentoOP: post: description: Iniciado apontamento de OP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – apontamentoOP properties: apontamentoOP: type: object allOf: – #/definitions/recApontamentoOPG5 description: Dados do apontamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/finalizadoApontamentoOP: post: description: Finalizado apontamento de OP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – apontamentoOP properties: apontamentoOP: type: object allOf: – #/definitions/recApontamentoOPG5 description: Dados do apontamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/iniciadoParadaOP: post: description: Iniciado uma parada de OP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – apontamento – codigoMotivoParada properties: apontamento: type: object allOf: – #/definitions/recApontamentoOPG5 description: Dados do apontamento codigoMotivoParada: type: string description: Código do motivo de parada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/finalizadoParadaOP: post: description: Finalizado uma parada de OP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – apontamento properties: apontamento: type: object allOf: – #/definitions/recApontamentoOPG5 description: Dados do apontamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/canceladoApontamentoTempoOP: post: description: Cancelado um apontamento de tempo da OP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – apontamento – inicioProducao properties: apontamento: type: object allOf: – #/definitions/recApontamentoOPG5 description: Dados do apontamento cancelado inicioProducao: type: boolean description: Indicativo se o apontamento cancelado é de início de produção(primeiro apontamento de tempo) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/canceladoApontamentoParadaOP: post: description: Cancelado um apontamento de parada da OP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – apontamento – inicioParada properties: apontamento: type: object allOf: – #/definitions/recApontamentoOPG5 description: Dados do apontamento cancelado inicioParada: type: boolean description: Indicativo se o apontamento cancelado é de início de parada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/alteradoApontamentoQuantidadeOP: post: description: Alterado apontamendo de quantidade da OP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – apontamento properties: apontamento: type: object allOf: – #/definitions/recApontamentoOPG5 description: Dados do apontamento alterado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/alteradoApontamentoTempoOP: post: description: Alterado apontamento de temopo da OP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – apontamento – inicioProducao properties: apontamento: type: object allOf: – #/definitions/recApontamentoOPG5 description: Dados do apontamento alterado inicioProducao: type: boolean description: Indicativo se apontamento alterado é de início de produção(primeiro apontamento de tempo) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/alteradoApontamentoParadaOP: post: description: Alterado apontamento de parada de OP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – apontamento – inicioParada properties: apontamento: type: object allOf: – #/definitions/recApontamentoOPG5 description: Dados do apontamento alterado codigoMotivoParada: type: string description: Opcional – Código do motivo de parada(informado somente quando é início de parada) inicioParada: type: boolean description: Indicativo se apontamento alterado é de início de parada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/abertoOrdemProducao: post: description: Liberado ordem de produção x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ordemProducao properties: ordemProducao: type: object allOf: – #/definitions/recOrdemProducaoG5 description: Dados da ordem de produção responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/bloqueadoOrdemProducao: post: description: Bloqueado ordem de produção x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ordemProducao properties: ordemProducao: type: object allOf: – #/definitions/recOrdemProducaoG5 description: Dados da ordem de produção responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pcp_integracao/events/canceladoOrdemProducao: post: description: Cancelado ordem de produção x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ordemProducao properties: ordemProducao: type: object allOf: – #/definitions/recOrdemProducaoG5 description: Dados da ordem de produção responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: tipoEtiqueta: description: Tipo da etiqueta type: string enum: – NaoInformado – Produto – Refugo – Subproduto – Consumo situacaoEtiqueta: description: Situação da etiqueta type: string enum: – Gerada – Processada – Movimentada – Cancelada – PendenteCancelamento tipoApontamento: description: Tipo do apontamento type: string enum: – Tempo – Parada – Quantidade enumTipoPessoa: description: Tipo de pessoa type: string enum: – Empresa – Filial – Fornecedor – Cliente enumTipoEtiqueta: description: Tipo da etiqueta type: string enum: – NaoInformado – Produto – Refugo – Subproduto – Consumo enumSituacaoEtiqueta: description: Situação da etiqueta type: string enum: – Gerada – Processada – Movimentada – Cancelada – PendenteCancelamento enumSituacaoOrdemProducao: description: Situção da ordem de produção type: string enum: – Programada – Liberada – Iniciada – Finalizada – Cancelada – Parada – EmLiberacao – EmCancelamento – EmFinalizacao – Pendente – Erro – Gerando enumTipoProduto: description: Tipo do produto para impostos type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufaturado – EmFabricacao – SubProduto – UsoConsumo – AtivoImobilizado – Servico – OutrosInsumos – Outros enumTipoReposicao: description: Tipo de reposição type: string enum: – Produzido – Comprado – Servico enumSituacaoSkuCompl: description: Situação do SKU type: string enum: – Inativo – Ativo – Bloqueado 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 etiquetaG5: description: Dados da etiqueta type: object required: – id – codigo – tipo – skuCodigo – familiaCodigo – quantidade – situacao properties: id: type: integer format: int64 description: Identificador único do registro da etiqueta codigo: type: string description: Código da etiqueta tipo: type: string allOf: – #/definitions/tipoEtiqueta description: Tipo de etiqueta skuCodigo: type: string description: Código do sku vinculado a etiqueta familiaCodigo: type: string description: Código da família do sku da etiqueta lote: type: string maxLength: 50 description: Lote informado serie: type: string maxLength: 50 description: Série informada quantidade: type: number format: double description: Quantidade do sku apontamento: type: object allOf: – #/definitions/apontamentoG5 description: Dados do apontamento situacao: type: string allOf: – #/definitions/situacaoEtiqueta description: Situação da etiqueta apontamentoG5: description: Dados do apontamento type: object required: – id – codigoEmpresa – codigoFilial – ordemProducaoId – codigoSKU – codigoFamilia – estagio – codigoOperador – codigoCentroRecurso – dataApontamento – sequenciaOperacional – codigoOperacao – geraEstoque – tipoApontamento properties: id: type: integer format: int64 description: Id do apontamento codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial ordemProducaoId: type: integer format: int64 description: Id da ordem de produção codigoSKU: type: string description: Código do SKU da ordem de produção codigoFamilia: type: string description: Código da família do SKU da ordem de produção estagio: type: object allOf: – #/definitions/estagioG5 description: Dados do estágio codigoOperador: type: integer format: int64 description: Código do operador codigoCentroRecurso: type: string description: Código do centro de recurso dataApontamento: type: string format: date-time description: Data do apontamento sequenciaOperacional: type: integer format: int64 description: Sequência operacional codigoOperacao: type: string description: Código da Operação sequenciaComponenteAtual: type: integer format: int64 description: Sequência do consumo geraEstoque: type: boolean description: Indicativo se o apontamento gera estoque tipoApontamento: type: string allOf: – #/definitions/tipoApontamento description: Tipo do apontamento estagioG5: description: Dados do estágio type: object required: – id – codigo – descricao – empresaCodigo properties: id: type: integer format: int64 description: Id do estágio codigo: type: string description: Código do estágio descricao: type: string description: Descrição do estágio empresaCodigo: type: integer format: int64 description: Código da empresa recMotivoParadaG5: description: Dados do motivo de parada type: object required: – id – empresa – ativo – codigo – descricao – calculaEficiencia properties: id: type: integer format: int64 description: Id do motivo de parada empresa: type: object allOf: – #/definitions/recPessoa description: Empresa ativo: type: boolean description: Indicativo se o motivo de parada está Ativo codigo: type: string description: Código do motivo de parada descricao: type: string description: Descriçao do motivo de parada calculaEficiencia: type: boolean description: Indicativo se o motivo de parada cálcula eficiência dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário de alteração recOperadorG5: description: Dados do operador type: object required: – id – empresa – ativo – cadastro – nome properties: id: type: integer format: int64 description: Id do operador empresa: type: object allOf: – #/definitions/recPessoa description: Empresa ativo: type: boolean description: Indicativo se o operador está Ativo cadastro: type: integer format: int64 description: Nº do cadastro do operador nome: type: string description: Nome do operador dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário de alteração recEtiquetaG5: description: Informações sobre as etiquetas que serão enviadas para G5 type: object required: – id – codigo – tipo – skuCodigo – familiaCodigo – quantidade – situacao properties: id: type: integer format: int64 description: Identificador único do registro da etiqueta codigo: type: string description: código da etiqueta tipo: type: string allOf: – #/definitions/enumTipoEtiqueta description: tipo de etiqueta skuCodigo: type: string description: código do sku vinculada a etiqueta familiaCodigo: type: string description: código da família do sku da etiqueta lote: type: string maxLength: 50 description: lote informado serie: type: string maxLength: 50 description: serie informada quantidade: type: string description: quantidade do sku informado situacao: type: string allOf: – #/definitions/enumSituacaoEtiqueta description: Situação da etiqueta recOrdemProducaoG5: description: Dados da ordem de produção type: object required: – id – codigoEmpresa – codigoFilial – codigoSKU – codigoFamilia – codigoRoteiro – codigoUnidadeMedida – sequencia – quantidadeProgramada – quantidadeRealizada – tempoExecucaoProcesso – situacao – bloqueada properties: id: type: integer format: int64 description: Id da ordem de produção codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial codigoSKU: type: string description: Código do SKU codigoFamilia: type: string description: Código da familia codigoRoteiro: type: string description: Código do roteiro codigoUnidadeMedida: type: string description: Código da unidade de medida sequencia: type: integer format: int64 description: Sequência da ordem de produção quantidadeProgramada: type: string description: Quantidade programada quantidadeRealizada: type: string description: Quantidade realizada tempoExecucaoProcesso: type: integer format: int64 description: Tempo de execução do processo situacao: type: string allOf: – #/definitions/enumSituacaoOrdemProducao description: Situação da ordem de produção bloqueada: type: boolean description: Indicativo se a ordem de produção está bloqueada codigoSKUProdutoRefugo: type: string description: Código do SKU de subproduto dataPrevistaEntrega: type: string format: date description: Data prevista de entrega dataPrevistaInicio: type: string format: date description: Data prevista de início dataPrevistaFim: type: string format: date description: Data prevista de fim dataGeracaoOP: type: string format: date description: Data de geração estagiosOrdemProducao: type: array items: type: object allOf: – #/definitions/recOrdemProducaoEstagioG5 description: Estágios da ordem de produção recOrdemProducaoEstagioG5: description: Dados do estágio type: object required: – id – codigoEstagio – dataInicioPrevista – dataFimPrevista – quantidadeProgramada properties: id: type: integer format: int64 description: Id do estágio da ordem de produção codigoEstagio: type: string description: Código do estágio dataInicioPrevista: type: string format: date description: Data de início prevista dataFimPrevista: type: string format: date description: Data de fim prevista quantidadeProgramada: type: string description: Quantidade programada componentes: type: array items: type: object allOf: – #/definitions/recOrdemProducaoConsumoG5 description: Componentes do estágio controlaTerceiro: type: boolean description: Indica se o estágio será processado por um terceirizado default: false codigoSKUServico: type: string description: Código do SKU do serviço codigoFamiliaSKUServico: type: string description: Código da família do SKU de serviço codigoFornecedor: type: integer format: int64 description: Código do fornecedor do serviço sequenciaOperacional: type: integer format: int64 description: Sequência operacional codigoOperacao: type: string description: Código da Operação recOrdemProducaoConsumoG5: description: Dados do consumo do estágio da ordem de produção type: object required: – id – sequencia – skuConsumo – quantidade properties: id: type: integer format: int64 description: Id do consumo do estágio da ordem de produção sequencia: type: integer format: int64 description: Sequência do consumo skuConsumo: type: object allOf: – #/definitions/recSku description: Dados do SKU consumo quantidade: type: string description: Quantidade consumida recApontamentoOPG5: description: Dados do apontamento type: object required: – id – ordemProducaoId – codigoSKU – codigoFamilia – codigoEmpresa – codigoFilial – estagio – codigoOperador – codigoCentroRecurso – dataApontamento – sequenciaOperacional – codigoOperacao – geraEstoque – finalizarProducao properties: id: type: integer format: int64 description: Id do apontamento ordemProducaoId: type: integer format: int64 description: Id da ordem de produção codigoSKU: type: string description: Código do SKU codigoFamilia: type: string description: Código da família codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial estagio: type: object allOf: – #/definitions/recEstagio description: Dados do estágio codigoOperador: type: integer format: int64 description: Código do operador codigoCentroRecurso: type: string description: Código do centro de recurso dataApontamento: type: string format: date-time description: Data/hora do apontamento etiquetas: type: array items: type: object allOf: – #/definitions/recEtiquetaG5 description: Etiquetas vinculadas ao apontamento sequenciaOperacional: type: integer format: int64 description: Sequência operacional codigoOperacao: type: string description: Código da Operação sequenciaComponenteAtual: type: integer format: int64 description: Sequência do consumo apontado geraEstoque: type: boolean description: Indicativo se o apontamento gera estoque finalizarProducao: type: boolean description: Indicativo se deve finalizar a produção do estágio recPessoa: description: Dados da pessoa type: object required: – id – codigo – nome – fantasia – tipo properties: id: type: integer format: int64 description: Id da pessoa codigo: type: integer format: int64 description: Código da pessoa nome: type: string description: Nome da pessoa fantasia: type: string description: Nome fantasia da pesso tipo: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo da pessoa recSku: description: Dados do SKU type: object required: – id – codigo – descricao – empresaCodigo – versaoId – familia – tipoProduto – tipoReposicao – situacao properties: id: type: integer format: int64 description: Id do SKU codigo: type: string description: Código do SKU descricao: type: string description: Descrição do SKU empresaCodigo: type: integer format: int64 description: Código da empresa versaoId: type: integer format: int64 description: versao atual do sku familia: type: object allOf: – #/definitions/recFamilia description: Dados da familia do SKU tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo de produto para impostos tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição do SKU unidadeMedidaEstoque: type: object allOf: – #/definitions/recUnidadeMedida description: Dados da unidade de medida de estoque unidadeMedidaProducao: type: object allOf: – #/definitions/recUnidadeMedida description: Dados da unidade de medida de produção unidadeMedidaCompras: type: object allOf: – #/definitions/recUnidadeMedida description: Dados da unidade de medida de compras situacao: type: string allOf: – #/definitions/enumSituacaoSkuCompl description: Situação do SKU recFamilia: description: Dados da família type: object required: – id – codigo – descricao – empresaCodigo – tipoReposicao – controlaLote – controlaSerie properties: id: type: integer format: int64 description: Id da família codigo: type: string description: Código da família descricao: type: string description: Descrição da família empresaCodigo: type: integer format: int64 description: Código da empresa tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição da família controlaLote: type: boolean description: Indicativo se a família tem controle por lote controlaSerie: type: boolean description: Indicativo se a família tem controle por série recUnidadeMedida: description: informações básicas da unidade de medida type: object required: – id – codigo – descricao – quantidadeDecimais properties: id: type: integer format: int64 description: identificador único da únidade de medida codigo: type: string description: código de identificação da unidade de medida descricao: type: string description: descrição da únidade de medida quantidadeDecimais: type: integer format: int64 description: quantidade de decimais da unidade de medida recEstagio: description: Dados do estágio type: object required: – id – codigo – descricao – ativo – empresaCodigo properties: id: type: integer format: int64 description: Id do estágio codigo: type: string description: Código do estágio descricao: type: string description: Descrição do estágio ativo: type: boolean description: Indicativo se o estágio está ativo empresaCodigo: type: integer format: int64 description: Código da empresa dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário de alteração checkDTO: description: Record declarado apenas para não gerar a implementação da primitiva HealthCheck type: object notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE