front_ponto_eletronico/docs/settings_integracoes/create.yml

78 lines
2.3 KiB
YAML

tags:
- Settings Integrações
summary: Cria uma nova configuração de integrações
description: >
Essa rota permite criar uma configuração de integrações associada a uma instância de serviço.
parameters:
- in: body
name: body
description: Dados para a criação de uma nova configuração.
required: true
schema:
type: object
properties:
integrar_folha_pagamento:
type: string
description: Habilita integração com folha de pagamento
example: "True"
exportar_dados:
type: string
description: Habilita exportação de dados
example: "True"
exportacao_csv:
type: string
description: Habilita exportação em formato CSV
example: "True"
exportacao_pdf:
type: string
description: Habilita exportação em formato PDF
example: "False"
integrar_calendario:
type: string
description: Habilita integração com calendários
example: "True"
service_instance_id:
type: integer
description: ID da instância de serviço associada
example: 1
responses:
201:
description: Configuração criada com sucesso
content:
application/json:
schema:
type: object
properties:
message:
type: string
settings_id:
type: integer
examples:
application/json:
message: "Configuração de integrações criada com sucesso"
settings_id: 1
400:
description: Requisição inválida (dados incorretos ou ausentes)
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Campos obrigatórios ausentes ou inválidos."
401:
description: Token inválido ou ausente
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Token inválido ou ausente"