erp_man

Apontamentos (appointment)

1 views 05/08/2021 10/09/2021 integrador 0

2.0info: 1.1.4 Apontamentos description: Chão de fábrica – Apontamentos x-senior-domain: Gestão industrial x-senior-domain-path: erp_man x-senior-service-path: appointment 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/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /appointment/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/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/actions/point: post: description: Realizar os apontamentos de tempos e/ou produção do estágio/ordem de produção\n ### Resources\n – res://senior.com.br/erp_man/pcp_programacaocontrole/apontamentos – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: productionOrderId: type: integer format: int64 description: Identificador único da ordem de produção productionOrderCode: type: string description: Código da ordem de produção, necessário informar o identificador único ou o código da ordem de produção, para o sistema conseguir encontrar a ordem productionOrderStageId: type: integer format: int64 description: Identificador único do estágio na ordem de produção productionOrderStageCode: type: string description: Código do estágio da ordem de produção, se não for informado o identificador único ou código, o sistema irá tentar encontrar o estágio automáticamente operatorId: type: integer format: int64 description: Identificador únido do operador que está realizando o apontamento operatorCode: type: integer format: int64 description: Código do operador que está realizando o apontamento, se não for informado o identificador único ou código, o sistema irá tentar encontrar o operador automáticamente startDateTime: type: string format: date-time description: Data e hora de inicio do apontamento, necessário informar somente para apontamento em estágios com as situações Liberado, Pausado e parado (caso não for informado, será assumido a data e hora local) endDateTime: type: string format: date-time description: Data e hora de fim do apontamento, necessário informar somente quando deseja finalizar o período de apontamento ou finalizar o estágio amountProduced: type: string description: Quantidade produzida, ao informar essa quantidade, será gerado um apontamento de produção typeAppointment: type: string allOf: – #/definitions/enumAppointmentTypeTime description: Identificador do tipo de apontamento, parcial (padrão quando não for informado) não finalizando o estágio ou total finalizando o estágio responses: 200: description: Ok schema: type: object required: – appointment properties: appointment: type: array items: type: object allOf: – #/definitions/recAppointment minimum: 1 description: Informações de retorno do(s) apontamento(s) 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /appointment/actions/pointOutUnlabelledConsumption: post: description: Realiza um apontamento de consumo sem necessidade de gerar uma etiqueta antecipadamente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – amount properties: orderProductionStageId: type: integer format: int64 description: Identificador único do estágio da OP skuCode: type: string description: Código do SKU para encontrar o consumo do estágio skuId: type: integer format: int64 description: Identificador único do SKU para encontrar o consumo do estágio orderProductionStageConsumptionId: type: integer format: int64 description: Identificador único do consumo do estágio da OP operatorId: type: integer format: int64 description: Identificador único do operador operatorCode: type: integer format: int64 description: Código do operador currentDateTime: type: string format: date-time description: Opcional – Data e hora do apontamento (caso não informado assume data e hora atual) amount: type: string description: Quantidade que está sendo apontada batchCode: type: string maxLength: 50 description: Opcional – Código do Lote que está sendo consumido seriesCode: type: string maxLength: 50 description: Opcional – Código da Série que está sendo consumida responses: 200: description: Ok schema: type: object required: – appointment properties: appointment: type: object allOf: – #/definitions/recAppointmentComplete description: Registro de apontamento 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericErrordefinitions: enumAppointmentTypeTime: description: Tipo do apontamento de tempo type: string enum: – Parcial – Total enumTypeAppointment: description: Tipo do apontamento type: string enum: – Tempo – Parada – Quantidade enumTypeTimeAppointment: description: Indentificador do apontamento de tempo type: string enum: – Inicio – Fim enumTipoApontamentoTempo: description: Tipo de apontamento de tempo type: string enum: – Inicio – Fim enumTipoControleValidade: description: Tipos de controle de validade type: string enum: – Desativa – Livre – Obriga enumProdctType: description: Tipo de produto para impostos type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufaturado – EmFabricacao – SubProduto – UsoConsumo – AtivoImobilizado – Servico – OutrosInsumos – Outros enumSkuComplStatus: description: Situação do SKU type: string enum: – Inativo – Ativo – Bloqueado enumReplacementType: description: Tipo de reposição type: string enum: – Produzido – Comprado – Servico enumTagType: description: Tipos de etiqueta type: string enum: – NaoInformado – Produto – Refugo – Subproduto – Consumo enumTagStatus: description: Situação da etiqueta type: string enum: – Gerada – Processada – Movimentada – Cancelada – PendenteCancelamento upDown: description: Up or down type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT recAppointment: description: Informações básicas do apontamento discriminator: _discriminator type: object required: – id – type – typeTime – amount – dateTimeAppointment – _discriminator properties: id: type: integer format: int64 description: Identificador único do apontamento type: type: string allOf: – #/definitions/enumTypeAppointment description: Identificador do tipo de apontamento, tempo, parada ou produto typeTime: type: string allOf: – #/definitions/enumTypeTimeAppointment description: Identificador do tipo do apontamento de tempo (inicio ou fim) amount: type: string description: Quantidade apontada dateTimeAppointment: type: string format: date-time description: Data e hora do apontamento _discriminator: type: string description: recAppointmentComplete: description: Informações do apontamento allOf: – #/definitions/recAppointment – type: object required: – orderProductionStageId – operator – realRuntime – stoppingTime properties: orderProductionStageId: type: integer format: int64 description: Identificador único do estágio operator: type: object allOf: – #/definitions/recOperator description: Dados do operador tags: type: array items: type: object allOf: – #/definitions/recTag description: Lista de etiquetas reasonStop: type: object allOf: – #/definitions/recReasonStop description: Motivo de parada realRuntime: type: integer format: int64 description: Tempo de execução real stoppingTime: type: integer format: int64 description: Tempo de parada recOperator: description: Dados do operador type: object required: – id – companyCode – register – name properties: id: type: integer format: int64 description: Identificador único do operador companyCode: type: integer format: int64 description: Código da empresa register: type: integer format: int64 description: Número do cadastro name: type: string description: Nome do operador recTag: description: Dados da etiqueta type: object required: – id – code – type – status – sku – amount properties: id: type: integer format: int64 description: Identificador único da etiqueta code: type: string description: Código da etiqueta type: type: string allOf: – #/definitions/enumTagType description: Tipo da etiqueta status: type: string allOf: – #/definitions/enumTagStatus description: Status da etiqueta sku: type: object allOf: – #/definitions/recSku description: Dados do SKU amount: type: string description: Quantidade batchCode: type: string maxLength: 50 description: Código do lote seriesCode: type: string maxLength: 50 description: Código da série recReasonStop: description: Dados do motivo de parada type: object required: – id – code – description properties: id: type: integer format: int64 description: Identificador único do motivo de parada code: type: string description: Código do motivo de parada description: type: string description: Descrição do motivo de parada recSku: description: Dados do SKU type: object required: – id – code – description – companyCode – prodctType – replacementType – status properties: id: type: integer format: int64 description: Identificador único do SKU code: type: string description: Código do SKU description: type: string description: Descrição do SKU companyCode: type: integer format: int64 description: Código da empresa do SKU prodctType: type: string allOf: – #/definitions/enumProdctType description: Tipo de produto replacementType: type: string allOf: – #/definitions/enumReplacementType description: Tipo de reposição stockUnitMeasure: type: object allOf: – #/definitions/recUnitMeasurement description: Unidade de medida de estoque productionUnitMeasure: type: object allOf: – #/definitions/recUnitMeasurement description: Unidade de medida de produção status: type: string allOf: – #/definitions/enumSkuComplStatus description: Situação do SKU recUnitMeasurement: description: Dados da unidade de medida type: object required: – id – code – description – numberDecimals properties: id: type: integer format: int64 description: Identificador único da únidade de medida code: type: string description: Código description: type: string description: Descrição numberDecimals: type: integer format: int64 description: Quantidade de decimais checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck 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

Este artigo foi útil para você?

Leave A Comment