2.0info: 2.38.2 Apontamentos – Integração description: Chão de fábrica – Apontamentos(Integração) x-senior-domain: Gestão industrial x-senior-domain-path: erp_man x-senior-service-path: appointment_integration 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: /appointment_integration/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 /appointment_integration/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 /appointment_integration/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 /appointment_integration/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 /appointment_integration/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 /appointment_integration/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 /appointment_integration/events/finalizingOrder: post: description: Finalizar ordem e liberar saldo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – code – quantityRealized properties: id: type: integer format: int64 description: Identificador único da ordem de produção code: type: string description: Código único da ordem de produção quantityRealized: type: string description: Quantidade Realizada responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: 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 enumTipoApontamento: description: Tipo do apontamento type: string enum: – Tempo – Parada – Quantidade 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 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 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 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 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/enumTipoEtiqueta 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/enumSituacaoEtiqueta 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/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 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/enumTipoApontamento description: Tipo do apontamento 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