{"loaderData":{"3":{"integrations":[{"id":"banco-do-brasil","name":"Banco do Brasil","description":"Manage your banking services with Banco do Brasil.","logo_url":"https://assets.abstra.cloud/connectors/logos/banco-do-brasil.jpg","category":[],"triggers":[],"actions":[{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/post_arrecadacao_qrcodes","parameters":{"gw-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. Em produção o nome do parâmetro deve ser alterado para gw-dev-app-key."},"Authorization":{"type":"string","description":"É um \"token\" de acesso fornecido pelo OAuth 2.0.\nEx: Bearer [ACCESS_TOKEN]"},"data":{"type":"object","properties":{"numeroConvenio":{"type":"integer","format":"int32","description":"Refere-se ao número de convênio de arrecadação de um Ente Público com o Banco do Brasil e possui até 6 posições numéricas. Não confundir com código Febraban. No ambiente de testes utilize o número de convênio de arrecadação: 78806","example":62191},"indicadorCodigoBarras":{"type":"string","example":"S","description":"Informe S (sim) caso envie um código de barras padrão Febraban no campo seguinte (codigoGuiaRecebimento) ou N (não) caso não seja informado um código de barras mas apenas um código para conciliação."},"codigoGuiaRecebimento":{"type":"string","description":"Código de Barras padrão Febraban de 44 posições (se S no indicadorCodigoBarras) ou outro identificador do cliente (se N no indicadorCodigoBarras). O código de barras deverá ser gerado para o Número de Convênio informado no campo “NumeroConvenio”.","example":"83660000000199800053846101173758000000000000"},"emailDevedor":{"type":"string","description":"E-mail do devedor para contato","example":"contribuinte.silva@provedor.com.br"},"codigoPaisTelefoneDevedor":{"type":"integer","description":"Código do País do Telefone do Devedor","example":55,"format":"int32"},"dddTelefoneDevedor":{"type":"integer","description":"DDD do telefone do devedor","example":61,"format":"int32"},"numeroTelefoneDevedor":{"type":"string","description":"Numero do telefone do devedor","example":"999731240","format":"int32"},"codigoSolicitacaoBancoCentralBrasil":{"type":"string","description":"Refere-se à Chave Pix do Recebedor cadastrada no Banco do Brasil. O campo é obrigatório. Em ambiente de produção, a Chave Pix deverá estar vinculada a uma conta cujo CNPJ seja o mesmo utilizado na credencial de acesso à API. Em ambiente de homologação, use as chaves Pix criadas para usuários testes. A chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT que retornará a informação e identificará o recebedor da arrecadação.","example":"88a33759-78b0-43b7-8c60-e5e3e7cb55fe"},"descricaoSolicitacaoPagamento":{"type":"string","description":"Determina um texto a ser apresentado ao pagador em formato livre limitado a 140 caracteres.","example":"Arrecadação Pix"},"valorOriginalSolicitacao":{"type":"number","format":"float","description":"Valor original do documento. O valor do QRCode deverá, obrigatoriamente, corresponder ao valor registrado no código de barras.","example":19.98},"cpfDevedor":{"type":"string","description":"Determina o CPF do devedor, caso haja. O campo não é obrigatório, porém, se informado, o campo NomeDevedor também deverá ser preenchido. Este campo não poderá ser informado, caso o campo cnpjDevedor contenha dados. Para fins de testes, usar os CPF da seção de dados para testes do portal BB Developers.","example":"19917885250"},"cnpjDevedor":{"type":"string","description":"Determina o CNPJ do devedor, caso haja. O campo não é obrigatório, porém se informado, o campo NomeDevedor também deverá ser preenchido. Este campo não poderá ser informado, caso o campo cpfDevedor contenha dados. Para fins de testes, usar os CNPJ da seção de dados para testes do portal BB Developers."},"nomeDevedor":{"type":"string","description":"Determina o nome da instituição ou pessoa a quem a cobrança está endereçada. O preenchimento do campo \"Nome Devedor\" é obrigatório se o campo \"Numero CPF Devedor\" ou o campo \"Numero Cadastro Nac Pessoas Juridicas Devedor\" estiver preenchido","example":"Contribuinte da Silva"},"quantidadeSegundoExpiracao":{"type":"integer","description":"Duração que indica limite, com granularidade de segundos, para que o pagamento do QR Code possa ser realizado, a partir da data-hora de criação. Deve ser utilizado como espécie de data de vencimentos em segundos que deverá ser calculada da data-hora de criação até a data-hora de vencimento. Caso não informado, assume-se a duração de 86400 segundos, que corresponde a 24 horas.","example":3600,"format":"int32"},"listaInformacaoAdicional":{"type":"array","description":"O campo \"listaInformacaoAdicional\", se estiver presente, se refere a uma lista em que cada elemento deve\nutilizar o esquema abaixo:","items":{"type":"object","properties":{"codigoInformacaoAdicional":{"type":"string","description":"Título das informações adicionais","example":"IPTU"},"textoInformacaoAdicional":{"type":"string","description":"Valor/texto das informações adicionais","example":"Cota Única 2021"}}}}},"required":{"0":"numeroConvenio","1":"indicadorCodigoBarras","2":"codigoGuiaRecebimento","3":"codigoSolicitacaoBancoCentralBrasil","4":"valorOriginalSolicitacao"}}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/parameters_arrecadacao_qrcodes","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/get_arrecadacao_qrcodes","parameters":{"Authorization":{"type":"string","description":"É um \"token\" de acesso fornecido pelo OAuth 2.0.Ex: Bearer [ACCESS_TOKEN]"},"gw-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. Em produção o nome do parâmetro deve ser alterado para gw-dev-app-key."},"numeroConvenio":{"type":"integer","description":"Número do convenio registrado no Banco do Brasil. No ambiente de testes utilize o número de convênio de arrecadação: 78806"},"codigoGuiaRecebimento":{"type":"string","description":"Código de Barras ou outro identificador do cliente informado no momento da criação da solicitação de pagamento."}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/parameters_arrecadacao_qrcodes_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/put_arrecadacao_qrcodes_by_id","parameters":{"id":{"type":"string"},"gw-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. Em produção o nome do parâmetro deve ser alterado para gw-dev-app-key."},"Authorization":{"type":"string","description":"É um \"token\" de acesso fornecido pelo OAuth 2.0.\nEx: Bearer [ACCESS_TOKEN]"},"data":{"type":"object","properties":{"numeroConvenio":{"type":"integer","format":"int32","description":"Refere-se ao número de convênio de arrecadação de um Ente Público com o Banco do Brasil e possui até 6 posições numéricas. No ambiente de testes utilize o número de convênio de arrecadação: 78806"},"indicadorCodigoBarras":{"type":"string","example":"S","description":"Informe S (sim) caso envie um código de barras padrão Febraban no campo seguinte (codigoGuiaRecebimento) ou N (não) caso não seja informado um código de barras mas apenas um código para conciliação."},"codigoGuiaRecebimento":{"type":"string","description":"Código de Barras padrão Febraban de 44 posições (se S no indicadorCodigoBarras) ou outro identificador do cliente (se N no indicadorCodigoBarras). O código de barras deverá ser gerado para o Número de Convênio informado no campo “NumeroConvenio”.","example":"81620000900000031902020102600390000011517750"},"emailDevedor":{"type":"string","description":"E-mail do devedor para contato","example":"joaodasilva@bb.com.br"},"codigoPaisTelefoneDevedor":{"type":"integer","description":"Código do País do Telefone do Devedor","example":55,"format":"int32"},"dddTelefoneDevedor":{"type":"integer","description":"DDD do telefone do devedor","example":61,"format":"int32"},"numeroTelefoneDevedor":{"type":"string","description":"Numero do telefone do devedor","example":"999731240","format":"int32"},"codigoSolicitacaoBancoCentralBrasil":{"type":"string","description":"Refere-se à Chave Pix do Recebedor cadastrada no Banco do Brasil. O campo é obrigatório. Em ambiente de produção, a Chave Pix deverá estar vinculada a uma conta cujo CNPJ seja o mesmo utilizado na credencial de acesso à API. Em ambiente de homologação, use as chaves Pix criadas para usuários testes. A chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT que retornará a informação e identificará o recebedor da arrecadação.","example":"88a33759-78b0-43b7-8c60-e5e3e7cb55fe"},"descricaoSolicitacaoPagamento":{"type":"string","description":"Determina um texto a ser apresentado ao pagador em formato livre limitado a 140 caracteres.","example":"Taxa de limpeza urbana ano competência 2021"},"valorOriginalSolicitacao":{"type":"number","format":"float","description":"Valor original do documento. O valor do QRCode deverá, obrigatoriamente, corresponder ao valor registrado no código de barras.","example":100.1},"cpfDevedor":{"type":"string","description":"Determina o CPF do devedor, caso haja. O campo não é obrigatório, porém, se informado, o campo NomeDevedor também deverá ser preenchido. Este campo não poderá ser informado, caso o campo cnpjDevedor contenha dados. Para fins de testes, usar os CPF da seção de dados para testes do portal BB Developers.","example":"19917885250"},"cnpjDevedor":{"type":"string","description":"Determina o CNPJ do devedor, caso haja. O campo não é obrigatório, porém se informado, o campo NomeDevedor também deverá ser preenchido. Este campo não poderá ser informado, caso o campo cpfDevedor contenha dados. Para fins de testes, usar os CNPJ da seção de dados para testes do portal BB Developers.","example":"95288107000193"},"nomeDevedor":{"type":"string","description":"Determina o nome da instituição ou pessoa a quem a cobrança está endereçada. O preenchimento do campo \"Nome Devedor\" é obrigatório se o campo \"Numero CPF Devedor\" ou o campo \"Numero Cadastro Nac Pessoas Juridicas Devedor\" estiver preenchido","example":"João da Silva"},"quantidadeSegundoExpiracao":{"type":"integer","description":"Duração que indica limite, com granularidade de segundos, para que o pagamento do QR Code possa ser realizado, a partir da data-hora de criação. Deve ser utilizado como espécie de data de vencimentos em segundos que deverá ser calculada da data-hora de criação até a data-hora de vencimento. Caso não informado, assume-se a duração de 86400 segundos, que corresponde a 24 horas.","example":3600,"format":"int32"},"listaInformacaoAdicional":{"type":"array","description":"O campo \"listaInformacaoAdicional\", se estiver presente, se refere a uma lista em que cada elemento deve\nutilizar o esquema abaixo:","items":{"type":"object","properties":{"codigoInformacaoAdicional":{"type":"string","description":"Título das informações adicionais"},"textoInformacaoAdicional":{"type":"string","description":"Valor/texto das informações adicionais"}}}}},"required":{"0":"numeroConvenio","1":"indicadorCodigoBarras","2":"codigoGuiaRecebimento","3":"codigoSolicitacaoBancoCentralBrasil","4":"valorOriginalSolicitacao"}}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/get_arrecadacao_qrcodes_by_id","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É um \"token\" de acesso fornecido pelo OAuth 2.0.\nEx: Bearer [ACCESS_TOKEN]"},"gw-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. Em produção o nome do parâmetro deve ser alterado para gw-dev-app-key."},"numeroConvenio":{"type":"integer","description":"Número do convenio registrado no Banco do Brasil. No ambiente de testes utilize o número de convênio de arrecadação: 78806"}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/post_arrecadacao_qrcodes_by_id_baixar","parameters":{"id":{"type":"string"},"gw-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. Em produção o nome do parâmetro deve ser alterado para gw-dev-app-key."},"Authorization":{"type":"string","description":"É um \"token\" de acesso fornecido pelo OAuth 2.0.\nEx: Bearer [ACCESS_TOKEN]"},"data":{"type":"object","properties":{"numeroConvenio":{"type":"integer","format":"int32","description":"Refere-se ao número de convênio de arrecadação de um Ente Público com o Banco do Brasil e possui até 6 posições numéricas. No ambiente de testes utilize o número de convênio de arrecadação: 78806","example":176520},"codigoSolicitacaoBancoCentralBrasil":{"type":"string","description":"Refere-se à Chave Pix do Recebedor cadastrada no Banco do Brasil. O campo é obrigatório. Em ambiente de produção, a Chave Pix deverá estar vinculada a uma conta cujo CNPJ seja o mesmo utilizado na credencial de acesso à API. Em ambiente de homologação, use as chaves Pix criadas para usuários testes. A chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT que retornará a informação e identificará o recebedor da arrecadação.","example":"88a33759-78b0-43b7-8c60-e5e3e7cb55fe"},"cpfDevedor":{"type":"integer","format":"int64","description":"Determina o CPF do devedor, caso haja. O campo não é obrigatório, porém, se informado, o campo NomeDevedor também deverá ser preenchido. Este campo não poderá ser informado, caso o campo cnpjDevedor contenha dados. Para fins de testes, usar os CPF da seção de dados para testes do portal BB Developers.","example":19917885250},"cnpjDevedor":{"type":"integer","format":"int64","description":"Determina o CNPJ do devedor, caso haja. O campo não é obrigatório, porém se informado, o campo NomeDevedor também deverá ser preenchido. Este campo não poderá ser informado, caso o campo cpfDevedor contenha dados. Para fins de testes, usar os CNPJ da seção de dados para testes do portal BB Developers.","example":35990785000171}},"required":{"0":"numeroConvenio","1":"codigoSolicitacaoBancoCentralBrasil"}}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/parameters_arrecadacao_qrcodes_by_id_baixar","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/parameters_arrecadacao_qrcodes_pagamentos_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/get_arrecadacao_qrcodes_pagamentos_by_id","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É um \"token\" de acesso fornecido pelo OAuth 2.0.Ex: Bearer [ACCESS_TOKEN]"},"gw-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. Em produção o nome do parâmetro deve ser alterado para gw-dev-app-key."}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/parameters_pagamentos_codigo_barras_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/get_pagamentos_codigo_barras_by_id","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É um \"token\" de acesso fornecido pelo OAuth 2.0.Ex: Bearer [ACCESS_TOKEN]"},"gw-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. Em produção o nome do parâmetro deve ser alterado para gw-dev-app-key."},"numeroConvenio":{"type":"integer","description":"Número do convenio registrado no Banco do Brasil. No ambiente de testes utilize o número de convênio de arrecadação: 78806"}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/parameters_pagamentos_transacao_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"arrecadacao_integrada_ao_pix/get_pagamentos_transacao_by_id","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É um \"token\" de acesso fornecido pelo OAuth 2.0.Ex: Bearer [ACCESS_TOKEN]"},"gw-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. Em produção o nome do parâmetro deve ser alterado para gw-dev-app-key."},"numeroConvenio":{"type":"integer","description":"Número do convenio registrado no Banco do Brasil. No ambiente de testes utilize o número de convênio de arrecadação: 78806"}}},{"connectionName":"banco-do-brasil","actionName":"autorizacao_debito_automatico/post_direct_debit_authorizations","parameters":{"data":{"type":"object","properties":{"codigoConvenio":{"type":"integer","format":"int32","description":"Código de convênio do convenente do sistema DBT","examples":{"0":"78860"}},"codigoIdentificador":{"type":"string","description":"Código de identificação da autorização de débito automático do convenente junto ao seu cliente.","maxLength":25}},"required":{"0":"codigoConvenio","1":"codigoIdentificador"}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/post_solicitacao_pagamento","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"data":{"type":"object","properties":{"numeroConvenio":{"type":"integer","format":"int32","minimum":0,"maximum":9999999999,"example":1351002000,"description":"Número de Convênio do cliente com o Checkout "},"timestampLimiteSolicitacaoPagamento":{"type":"string","maxLength":26,"minLength":0,"example":"2010-01-10T03:00:00.000000","description":"Data e hora limite máximo para pagamento da solicitação de pagamento (timestamp)"},"indicadorPagamentoUnico":{"type":"string","maxLength":1,"minLength":0,"example":"S","description":"Indicador se a solicitação aceita um ou mais pagamentos, se aceitar Open Banking é obrigatório ser \"S\""},"valorSolicitacaoPagamento":{"type":"number","format":"double","maximum":1000000000000000,"minimum":0,"description":"Valor que o cliente deseja receber do pagador, quando não informado será definido pelo pagador; se aceitar Open Banking é obrigatório"},"codigoConciliacaoSolicitacaoPagamento":{"type":"string","minLength":0,"maxLength":36,"example":"cobranças Open Banking","description":"Código da conciliação da solicitação de pagamento"},"descricaoSolicitacaoPagamento":{"type":"string","maxLength":255,"minLength":0,"example":"TV LG 50 polegadas/ Pedido: 123456 ","description":"Descrição da solicitação do pagamento"},"tipoPessoaDevedor":{"type":"integer","maximum":9999,"minimum":0,"format":"int32","example":0,"description":"Código do tipo da pessoa do devedor, se aceitar Open Banking é obrigatório"},"cpfCnpjDevedor":{"type":"integer","example":30580698509,"maximum":99999999999999,"minimum":0,"format":"int64","description":"Número do CPF/CNPJ do devedor, ´e obrigatório se tiver o tipo de pessoa preenchido"},"cepDevedor":{"type":"integer","format":"int32","minimum":0,"maximum":999999999,"example":2314060,"description":"Número do CEP do devedor "},"enderecoDevedor":{"type":"string","maxLength":100,"example":"Rua Benvenuto, 258","minLength":0,"description":"Texto com o endereço do devedor"},"bairroDevedor":{"type":"string","maxLength":50,"minLength":0,"example":"Vila Coração","description":"Nome do bairro do devedor"},"cidadeDevedor":{"type":"string","maxLength":50,"minLength":0,"example":"São Paulo","description":"Nome do bairro do devedor"},"ufDevedor":{"type":"string","maxLength":2,"minLength":0,"example":"SP","description":"Sigla da Unidade da Federação (sigla do Estado) do devedor"},"emailDevedor":{"type":"string","maxLength":100,"minLength":0,"example":"joao@gmail.com","description":"Texto com o endereço do e-mail do devedor"},"dddTelefoneDevedor":{"type":"integer","maximum":9999,"minimum":0,"format":"int32","example":11,"description":"Número do DDD do telefone do devedor "},"telefoneDevedor":{"type":"integer","maximum":999999999,"minimum":0,"format":"int32","example":29918855,"description":"Número do telefone do devedor "},"cpfCnpjRepresentanteEmpresa":{"type":"integer","format":"int64","maximum":99999999999999,"minimum":0,"description":"CPF ou CNPJ do representante da empresa indicada como devedora"},"quantidadeTiposPagamentosLista":{"type":"integer","maximum":9999,"minimum":0,"format":"int32","example":2,"description":"Quantidade de tipos de pagamentos da solicitação de cobrança,"},"listaPagamentos":{"type":"array","minItems":0,"maxItems":100,"description":"Lista de pagamentos","items":{"type":"object","description":"Lista de pagamentos","properties":{"codigoTipoPagamento":{"type":"string","maxLength":3,"minLength":0,"example":"PIX","description":"Código do tipo de pagamentos"}},"required":{"0":"codigoTipoPagamento"}}}},"required":{"0":"numeroConvenio","1":"indicadorPagamentoUnico","2":"descricaoSolicitacaoPagamento","3":"quantidadeTiposPagamentosLista","4":"listaPagamentos"}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/get_solicitacao_pagamento_by_numero_solicitacao_pagamento","parameters":{"numeroSolicitacaoPagamento":{"type":"string"},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"numeroConvenio":{"type":"integer","description":"Número de Convênio do cliente com o Checkout "},"dataPagamento":{"type":"string","description":"Data do pagamento. Se não informar número da solicitação de pagamento, é obrigatório informar a data."},"numeroUltimoPagamentoConsultado":{"type":"integer","description":"Número do último pagamento enviado em resposta devolvida pelo banco anteriormente, com os mesmos campos de entrada"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/parameters_solicitacao_pagamento_by_numero_solicitacao_pagamento","parameters":{"numeroSolicitacaoPagamento":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/parameters_pagamentos_by_numero_pagamento_solicitacao","parameters":{"numeroPagamentoSolicitacao":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/get_pagamentos_by_numero_pagamento_solicitacao","parameters":{"numeroPagamentoSolicitacao":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"numeroConvenio":{"type":"integer","description":"Número de Convênio do cliente"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/parameters_pagamentos_by_numero_pagamento_solicitacao_devolver","parameters":{"numeroPagamentoSolicitacao":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/post_pagamentos_by_numero_pagamento_solicitacao_devolver","parameters":{"numeroPagamentoSolicitacao":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"data":{"type":"object","properties":{"numeroConvenio":{"type":"integer","format":"int32","minimum":1,"maximum":999999999,"example":1,"description":"Número de convênio do cliente com o Checkout."},"valorDevolucao":{"type":"number","format":"double","maximum":1000000000000000,"minimum":0.01,"example":10,"description":"Valor que o cliente deseja solicitar devolução."},"motivoDevolucao":{"type":"string","maxLength":100,"example":"OUTROS","description":"Motivo da devolução.","enum":{"0":"COBRANCA_EM_DUPLICIDADE","1":"SOLICITADA_PELO_PAGADOR","2":"VALOR_RECUSADO_PELO_PAGADOR","3":"AJUSTE_DE_VALOR","4":"OUTROS"}},"textoMotivoDevolucao":{"type":"string","maxLength":140,"example":"Pagador devolveu mercadoria","description":"Texto do usuário para identificar a devolução, caso tenha informado o motivo OUTROS."}},"required":{"0":"numeroConvenio","1":"valorDevolucao"}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/post_solicitacao_pagamentos_by_numero_solicitacao_pagamento_autorizacoes","parameters":{"numeroSolicitacaoPagamento":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"data":{"type":"object","properties":{"numeroMarcaParticipanteOpenbanking":{"type":"integer","description":"Número da marca do participante OpenBanking escolhido pelo usuário pagador."},"informacaoPagador":{"type":"string","minLength":0,"maxLength":140,"description":"Texto do pagador para identificar o pagamento."},"agenciaPagador":{"type":"integer","format":"int32","maximum":9999,"minimum":0,"description":"Código da agência do pagador."},"tipoContaPagador":{"type":"integer","maximum":9999,"minimum":0,"format":"int32","description":"Código do tipo de conta do pagador."},"contaCorrentePagador":{"type":"integer","minimum":0,"maximum":99999999999,"format":"int64","description":"Número da conta corrente do Pagador."},"numeroConvenio":{"type":"integer","format":"int32","minimum":0,"maximum":999999999,"description":"Número do convênio do cliente com o checkout."}},"required":{"0":"numeroMarcaParticipanteOpenbanking","1":"numeroConvenio"}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/parameters_solicitacao_pagamentos_by_numero_solicitacao_pagamento_autorizacoes","parameters":{"numeroSolicitacaoPagamento":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/parameters_by_id_marcas_ativas","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/get_by_id_marcas_ativas","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"numeroConvenio":{"type":"integer","description":"Número de convênio do cliente com o Checkout."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/parameters_pagamentos_by_numero_pagamento_solicitacao_autorizacoes","parameters":{"numeroPagamentoSolicitacao":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/get_pagamentos_by_numero_pagamento_solicitacao_autorizacoes","parameters":{"numeroPagamentoSolicitacao":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v1/get_devolucoes_pagamentos","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"numeroConvenio":{"type":"integer","description":"Número de Convênio do cliente com o BB Pay "},"numeroSolicitacaoPagamento":{"type":"integer","description":"Numero Solicitacao Pagamento, só deve ser inserido se a data não for informada"},"dataPagamento":{"type":"string","description":"Data das devoluções, só deve ser inserida se o número da solicitação de pagamento não for informado"},"numeroUltimaDevolucao":{"type":"integer","description":"Número se referente ao ultimo valor de numeroDevolucao retornado na resposta anterior, e se este é o ultimo valor da pesquisa (medida necessária devido ao limite de resposta de 250 itens por requisição)"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_solicitacoes","parameters":{"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente no BB Pay"},"codigoConciliacaoSolicitacao":{"type":"string","description":"Código de conciliação informado pelo convênio na criação da solicitação"},"dataSolicitacao":{"type":"string","description":"Data de criação das solicitações"},"codigoEstadoSolicitacao":{"type":"array","description":"Lista de códigos de estado das solicitações"},"tokenPaginacao":{"type":"string","description":"Token para continuação de pesquisa (paginação)"},"itensPorPagina":{"type":"integer","description":"Número de itens retornados na consulta"},"numeroParticipante":{"type":"integer","description":"Número identificador único do Participante"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/post_solicitacoes","parameters":{"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."},"data":{"title":"Root Type for requisicao-POST-solicitacoes","description":"Requisição do recurso POST /v2/solicitacoes","required":["formasPagamento","geral"],"type":"object","properties":{"geral":{"$ref":"#/components/schemas/Geral","properties":{"numeroConvenio":{"format":"int32","type":"integer"},"timestampLimiteSolicitacao":{"format":"date-time","type":"string"},"indicadorPagamentoUnico":{"type":"string"},"valorSolicitacaoPagamento":{"format":"double","type":"number"},"codigoConciliacaoSolicitacaoPagamento":{"type":"string"},"descricaoSolicitacaoPagamento":{"type":"string"}}},"devedor":{"$ref":"#/components/schemas/Devedor","properties":{"tipoDocumento":{"format":"int32","type":"integer"},"numeroDocumento":{"format":"int32","type":"integer"},"cep":{"format":"int32","type":"integer"},"endereco":{"type":"string"},"bairro":{"type":"string"},"cidade":{"type":"string"},"uf":{"type":"string"},"email":{"type":"string"},"dddTelefone":{"format":"int32","type":"integer"},"telefone":{"format":"int32","type":"integer"},"cpfRepresentanteEmpresa":{"format":"int32","type":"integer"}}},"vencimento":{"$ref":"#/components/schemas/Vencimento","properties":{"dataVencimento":{"format":"date","type":"string"},"multaValorFixo":{"format":"double","type":"number"},"jurosPercentual":{"format":"double","type":"number"},"descontos":{"type":"array","items":{"type":"object","properties":{"dataLimite":{"format":"date","type":"string"},"valorFixo":{"format":"int32","type":"integer"}}}}}},"formasPagamento":{"description":"Código do tipo de pagamento (PIX, BLT, ... )","type":"array","items":{"$ref":"#/components/schemas/FormaPagamento"}},"repasse":{"$ref":"#/components/schemas/Repasse","properties":{"tipoValorRepasse":{"type":"string"},"recebedores":{"type":"array","items":{"type":"object","properties":{"identificadorRecebedor":{"format":"int32","type":"integer"},"tipoRecebedor":{"type":"string"},"valorRepasse":{"format":"int32","type":"integer"},"responsavelTarifa":{"type":"boolean"}}}}}}},"example":{"geral":{"numeroConvenio":98825,"timestampLimiteSolicitacao":"2030-01-10T03:00:00Z","pagamentoUnico":true,"valorSolicitacao":1525.9,"codigoConciliacaoSolicitacao":"cobranças Openfinance","descricaoSolicitacao":"TV LG 50 polegadas/ Pedido: 123456","urlCallback":"https://teste.com"},"devedor":{"tipoDocumento":1,"numeroDocumento":303762624,"cep":2314060,"endereco":"Rua Benvenuto, 258","bairro":"Vila Coração","cidade":"São Paulo","uf":"SP","email":"joao@gmail.com","dddTelefone":11,"telefone":29918855,"cpfRepresentanteEmpresa":123456789012},"vencimento":{"data":"2030-01-01","multaValorFixo":0,"jurosPercentual":0.22,"descontos":[{"dataLimite":"2029-01-01","valorFixo":10}]},"formasPagamento":[{"codigoTipoPagamento":"PIX","quantidadeParcelas":1}]}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_solicitacoes","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_pagamentos_by_numero_pagamento","parameters":{"numeroPagamento":{"type":"integer","description":"Número identificador do pagamento"},"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente no BB Pay"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_pagamentos_by_numero_pagamento","parameters":{"numeroPagamento":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_pagamentos","parameters":{"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente no BB Pay"},"numeroSolicitacao":{"type":"integer","description":"Número identificador da solicitação"},"codigoConciliacaoSolicitacao":{"type":"string","description":"Código de conciliacao da solicitação de pagamento\n"},"codigoTipoPagamento":{"type":"array","description":"Lista de códigos de tipo dos pagamentos"},"codigoEstadoPagamento":{"type":"array","description":"Lista de códigos de estado dos pagamentos"},"dataPagamento":{"type":"string","description":"Data do pagamento"},"numeroDocumentoPagador":{"type":"integer","description":"Número do CPF ou CNPJ do pagador"},"tokenPaginacao":{"type":"string","description":"Token para continuação de pesquisa (paginação)"},"itensPorPagina":{"type":"integer","description":"Limite de itens por pagina"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_pagamentos","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_devolucoes_by_numero_devolucao","parameters":{"numeroDevolucao":{"type":"string"},"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente no BB Pay\n"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_devolucoes_by_numero_devolucao","parameters":{"numeroDevolucao":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_devolucoes","parameters":{"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente no BB Pay"},"numeroPagamento":{"type":"integer","description":"Número identificador do pagamento"},"dataDevolucao":{"type":"string","description":"Data da devolução"},"tokenPaginacao":{"type":"string","description":"Token para continuação de pesquisa (paginação)"},"itensPorPagina":{"type":"integer","description":"Número de itens retornados na consulta"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/post_devolucoes","parameters":{"data":{"title":"Root Type for resisicao-POST-devolucoes-devolver","description":"Requisição do recurso POST /v2/devolucoes","required":["valorDevolucao","numeroPagamento","numeroConvenio"],"type":"object","properties":{"numeroPagamento":{"format":"int32","description":"Número identificador do pagamento","type":"integer"},"numeroConvenio":{"format":"int32","description":"Número do convênio do cliente no BB Pay","type":"integer"},"valorDevolucao":{"format":"double","description":"Valor que o convênio deseja devolver ao pagador. Pode ser de 0,01 até o valor final do pagamento. É possível fazer 'n' devoluções, desde que a soma das devoluções não extrapole o valor final do pagamento. Aceito até 2 casas decimais.","type":"number"},"textoMotivoDevolucao":{"description":"Descrição do motivo da devolução. Pode ser apresentado ao pagador, beneficiário da devolução","maxLength":255,"type":"string"}},"example":{"numeroPagamento":23457,"numeroConvenio":123456,"valorDevolucao":25.9,"textoMotivoDevolucao":"Cancelamento de compra"}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_devolucoes","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_participantes","parameters":{"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente no BB Pay"},"codigoEstadoParticipante":{"type":"array","description":"Código do estado do Participante. (0 - Ativo, 1 - Pendente, 900 - Cancelado)"},"itensPorPagina":{"type":"integer","description":"Número de itens retornados na consulta"},"tokenPaginacao":{"type":"string","description":"Token para continuação de pesquisa (paginação)"},"numeroSolicitacao":{"type":"integer","description":"Número identificador da solicitação de pagamento"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/post_participantes","parameters":{"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."},"data":{"title":"Root Type for requisicao-POST-participantes","description":"Requisição do recurso POST /v2/participantes","required":["numeroConvenio","nomeParticipante","numeroDocumento","tipoDocumento","tipoConta","numeroConta","numeroAgencia","codigoIspb"],"type":"object","properties":{"numeroConvenio":{"format":"int32","description":"Número do convênio do cliente no BB Pay","type":"integer"},"nomeParticipante":{"description":"Nome identificador do Participante para controle do Cliente.","maxLength":60,"type":"string"},"tipoDocumento":{"format":"int32","description":"Código do tipo de pessoa do Participante (1 - CPF, 2 - CNPJ)","type":"integer"},"numeroDocumento":{"format":"int32","description":"Número do CPF/CNPJ do Participante ","type":"integer"},"numeroConta":{"format":"int32","description":"Número da Conta utilizada para fazer o repasse para o Participante","type":"integer"},"tipoConta":{"format":"int32","description":"Código do tipo de conta do repasse do participante. As opções disponiveis são: (1 - Conta Corrente, 2 - Conta Poupança, 3 - Conta Salario 4 - Conta pré-paga)","type":"integer"},"variacaoPoupanca":{"format":"int32","description":"Valor de variação da poupança. Deve ser informado se tipo de conta for Poupança","type":"integer"},"codigoIspb":{"format":"int32","description":"Código identificador do Sistema de Pagamentos Brasileiro. Atualmente aceitamos apenas Banco do Brasil, codigoIspb igual a 0 ","type":"integer"},"numeroAgencia":{"format":"int32","description":"Número da Agência (sem dígito verificador) utilizada para fazer o repasse para o Participante ","type":"integer"}},"example":{"numeroConvenio":701,"nomeParticipante":"Participante Teste","tipoDocumento":1,"numeroDocumento":64655215801,"numeroConta":1033,"numeroAgencia":551,"tipoConta":1,"variacaoPoupanca":51,"codigoIspb":0}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_participantes","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_participantes_by_numero_participante","parameters":{"numeroParticipante":{"type":"string"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/put_participantes_by_numero_participante","parameters":{"numeroParticipante":{"type":"string"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."},"data":{"title":"Root Type for resposta-DELETE-participante","description":"Requisição do recurso PUT /v2/participantes/editar","type":"object","properties":{"nomeParticipante":{"description":"Nome identificador do Participante para controle do Cliente","maxLength":60,"type":"string"},"numeroConta":{"format":"int32","description":"Número da Conta utilizada para fazer o repasse para o Participante ","type":"integer"},"numeroAgencia":{"format":"int32","description":"Número da Agência (sem dígito verificador) utilizada para fazer o repasse para o Participante","type":"integer"},"codigoTipoConta":{"format":"int32","description":"Código do tipo de conta do repasse do participante. As opções disponiveis são: (1 - Conta Corrente, 2 - Conta Poupança, 3 - Conta Salario 4 - Conta pré-paga)","type":"integer"},"numeroVariacaoPoupanca":{"format":"int32","description":"Valor de variação da poupança. Só deve ser informado se tipo de conta for Poupança","type":"integer"},"codigoIspb":{"format":"int32","description":"Código identificador do Sistema de Pagamentos Brasileiro. Atualmente aceitamos apenas Banco do Brasil, codigoIspb igual a 0","type":"integer"}},"example":{"nomeParticipante":"participante A","numeroConta":5446,"numeroAgencia":551,"codigoTipoConta":2,"numeroVariacaoPoupanca":1,"codigoIspb":0}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/delete_participantes_by_numero_participante","parameters":{"numeroParticipante":{"type":"string"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_participantes_by_numero_participante","parameters":{"numeroParticipante":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/post_openfinance_autorizacoes","parameters":{"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."},"data":{"title":"Root Type for requisicao-POST-openbanking-autorizacoes","description":"Requisição do recurso POST /v2/openfinance/autorizacoes","required":["numeroMarcaParticipanteOpenfinance","numeroConvenio"],"type":"object","properties":{"numeroSolicitacao":{"format":"int64","description":"Número identificador da solicitação de pagamento","type":"integer"},"numeroConvenio":{"format":"int32","description":"Número do convênio do cliente no BB Pay","type":"integer"},"informacaoPagador":{"description":"Texto do pagador para identificar o pagamento","maxLength":140,"type":"string"},"agenciaPagador":{"format":"int32","description":"Código da agência do pagador","type":"integer"},"tipoContaPagador":{"format":"int32","description":"Código do tipo de conta do pagador","type":"integer"},"contaCorrentePagador":{"format":"int64","description":"Número da conta corrente do Pagador","type":"integer"},"numeroMarcaParticipanteOpenfinance":{"format":"int32","description":"Número da marca do participante Open Finance escolhido pelo usuário pagador","type":"integer"}},"example":{"numeroSolicitacao":389686,"numeroConvenio":5446,"numeroMarcaParticipanteOpenfinance":55253,"informacaoPagador":"IdentificadorCompra","agenciaPagador":3374,"tipoContaPagador":1,"contaCorrentePagador":569987}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_openfinance_autorizacoes","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_openfinance_autorizacoes_by_numero_pagamento","parameters":{"numeroPagamento":{"type":"string"},"numeroConvenio":{"type":"number","description":"Número do convênio do cliente no BB Pay\n"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_openfinance_autorizacoes_by_numero_pagamento","parameters":{"numeroPagamento":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_openfinance_marcas_ativas","parameters":{"numeroConvenio":{"type":"number","description":"Número do convênio do cliente no BB Pay"},"tokenPaginacao":{"type":"string","description":"Token para continuação de pesquisa (paginação)"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_openfinance_marcas_ativas","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/get_solicitacoes_by_numero_solicitacao","parameters":{"numeroSolicitacao":{"type":"string"},"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente no BB Pay"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/put_solicitacoes_by_numero_solicitacao","parameters":{"numeroSolicitacao":{"type":"string"},"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente no BB Pay"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."},"data":{"title":"Root Type for requisicao-PUT-solicitacao","description":"Requisição do recurso PUT /v2/solicitacoes/{numeroSolicitacao}","type":"object","properties":{"valorSolicitacao":{"format":"double","description":"Valor que o cliente deseja receber do pagador. É possível alterar apenas solicitações que tenham valor definido. Aceito até 2 casas decimais.","type":"number"},"descricaoSolicitacao":{"description":"Descrição da solicitação do pagamento","maxLength":255,"type":"string"},"dataVencimento":{"format":"date","description":"Data de vencimento da solicitação. É possível alterar apenas solicitações que tenham data de vencimento definida","maxLength":10,"type":"string"},"timestampLimiteSolicitacao":{"format":"date-time","description":"Data e hora limite máximo para pagamento da solicitação de pagamento (timestamp)","maxLength":26,"type":"string"}},"example":{"valorSolicitacao":152.9,"descricaoSolicitacao":"Pedido: 1234","dataVencimento":"2025-01-31","timestampLimiteSolicitacao":"2025-06-31T15:16:09.358603"}}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/delete_solicitacoes_by_numero_solicitacao","parameters":{"numeroSolicitacao":{"type":"string"},"numeroConvenio":{"type":"integer","description":"Número do convênio do cliente no BB Pay"},"Authorization":{"type":"string","description":"Token de acesso fornecido pelo OAuth BB."}}},{"connectionName":"banco-do-brasil","actionName":"bb_pay_v2/parameters_solicitacoes_by_numero_solicitacao","parameters":{"numeroSolicitacao":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_boletos","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/get_boletos","parameters":{"indicadorSituacao":{"type":"string","description":"Situação do boleto. Campo obrigatoriamente MAIÚSCULO.\nDomínios:\nA - Em ser\nB - Baixados/Protestados/Liquidados"},"contaCaucao":{"type":"integer","description":"Número da conta caução.\n\nDomínio:\n1 - Compõe Garantia;\n2 - Não Compõe Garantia;\n4 - Não Compõe Garantia (vencimento superior a 180 dias);\n5 - Não Compõe Garantia (Vedado);\n6 - Em análise;\n7 - Em análise;\n8 - Não Compõe Garantia."},"agenciaBeneficiario":{"type":"integer","description":"Número da agência do beneficiário, sem o dígito verificador. Ex: 452. CAMPO OBRIGATÓRIO."},"contaBeneficiario":{"type":"integer","description":"Número da conta do beneficiário, sem o dígito verificador. Ex: 123873. CAMPO OBRIGATÓRIO."},"carteiraConvenio":{"type":"integer","description":"Número da carteira do convênio de cobrança. Ex: 17"},"variacaoCarteiraConvenio":{"type":"integer","description":"Número da variação da carteira do convênio de cobrança. Ex: 35"},"modalidadeCobranca":{"type":"integer","description":"Código para identificar a característica dos boletos dentro das modalidades de cobrança existentes no BB.\nDomínio:\n1 - SIMPLES COM REGISTRO\n2 - SIMPLES SEM REGISTRO\n4 - VINCULADA\n6 - DESCONTADA\n8 - FINANCIADA VENDOR"},"cnpjPagador":{"type":"integer","description":"CNPJ do pagador\nEx: 123456789012"},"digitoCNPJPagador":{"type":"integer","description":"Dígito verificador do CNPJ do pagador\nEx: 12"},"cpfPagador":{"type":"integer","description":"CPF do pagador sem o dígito. Ex: 711285901"},"digitoCPFPagador":{"type":"integer","description":"Dígito verificador do CPF do pagador. Ex: 82"},"dataInicioVencimento":{"type":"string","description":"Data inicial de vencimento do boleto que delimita o período da consulta. Campo não obrigatório. Se informado Data Início, deixando em branco a Data Fim, o sistema deve assumir a data atual como Data Fim. Ex: 22.04.2020"},"dataFimVencimento":{"type":"string","description":"Data final de vencimento do boleto que delimita o período da consulta - deverá ser maior que a data de início. Campo não obrigatório. Se informado, deverá ser preenchido dataInicioVencimento. Ex: 28.04.2020"},"dataInicioRegistro":{"type":"string","description":"Data inicial do registro do boleto que delimita o período da consulta. Ex: 22.04.2020"},"dataFimRegistro":{"type":"string","description":"Data final do registro do boleto que delimita o período da consulta - deverá ser maior que a data de início. Campo não obrigatório. Se informado, deverá ser preenchido dataInicioRegistro. Ex: 28.04.2020"},"dataInicioMovimento":{"type":"string","description":"Delimita o período da consulta de boletos liquidados, baixados ou protestados, caso seja informado, no campo codigoEstadoTituloCobranca os códigos 05, 06, 07 ou 09. Ex: 22.04.2020"},"dataFimMovimento":{"type":"string","description":"Data final do movimento que delimita o período da consulta de boletos liquidados, baixados ou protestados, caso seja informado, no campo codigoEstadoTituloCobranca os códigos 05, 06, 07 ou 09. Data fim deverá ser maior que a data de início. Campo não obrigatório. Se informado, deverá ser preenchido dataInicioMovimento. Ex: 28.04.2020"},"codigoEstadoTituloCobranca":{"type":"integer","description":"Código da situação atual do boleto. \n\nDomínios:\n\n01 - NORMAL\n02 - MOVIMENTO CARTORIO\n03 - EM CARTORIO\n04 - TITULO COM OCORRENCIA DE CARTORIO\n05 - PROTESTADO ELETRONICO\n06 - LIQUIDADO\n07 - BAIXADO\n09 - TITULO PROTESTADO MANUAL\n10 - TITULO BAIXADO/PAGO EM CARTORIO\n11 - TITULO LIQUIDADO/PROTESTADO\n12 - TITULO LIQUIDADO/PAGO CARTORIO\n13 - TITULO PROTESTADO AGUARDANDO BAIXA\n18 - PAGO PARCIALMENTE"},"boletoVencido":{"type":"string","description":"Indica se o Boleto está vencido ou não. Campo obrigatoriamente MAIÚSCULO.\nDomínio:\nS para boletos vencidos\nN para boletos não vencidos"},"indice":{"type":"integer","description":"Somente deve ser utilizado em caso de pesquisas que retornem mais de 300 boletos. Caso o campo RPST \"Indicador Continuidade\" retorne com o valor \"S\", o usuário deve informar o conteúdo do campo RPST \"Numero Ultimo Registro\" a partir do qual será iniciada nova consulta.\n"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/post_boletos","parameters":{"data":{"type":"object","description":"Representação dos campos de requisição de uma solicitação de criação de boletos bancários.","title":"","properties":{"numeroConvenio":{"type":"integer","description":"Número do convênio de Cobrança do Cliente. Identificador determinado pelo sistema Cobrança para controlar a emissão de boletos, liquidação, crédito de valores ao Beneficiário e intercâmbio de dados com o cliente.","format":"int64"},"numeroCarteira":{"type":"integer","description":"Características do serviço de boleto bancário e como ele deve ser tratado pelo banco.","format":"int32"},"numeroVariacaoCarteira":{"type":"integer","description":"Número da variação da carteira do convênio de cobrança.","format":"int32"},"codigoModalidade":{"type":"integer","description":"Identifica a característica dos boletos dentro das modalidades de cobrança existentes no banco.\n\nDomínio:\n01 - SIMPLES;\n04 - VINCULADA","format":"int32"},"dataEmissao":{"type":"string","description":"Data de emissão do boleto (formato \"dd.mm.aaaaa\"). "},"dataVencimento":{"type":"string","description":"Data de vencimento do boleto (formato \"dd.mm.aaaaa\")."},"valorOriginal":{"type":"number","description":"Valor de cobrança > 0.00, emitido em Real (formato decimal separado por \".\"). Valor do boleto no registro. Deve ser maior que a soma dos campos “VALOR DO DESCONTO DO TÍTULO” e “VALOR DO ABATIMENTO DO TÍTULO”, se informados. Informação não passível de alteração após a criação. No caso de emissão com valor equivocado, sugerimos cancelar e emitir novo boleto.","format":"float"},"valorAbatimento":{"type":"number","description":"Valor de dedução do boleto >= 0.00 (formato decimal separado por \".\").","format":"float"},"quantidadeDiasProtesto":{"type":"number","description":"Quantos dias após a data de vencimento do boleto para iniciar o processo de cobrança através de protesto. (valor inteiro >= 0).","format":"float"},"quantidadeDiasNegativacao":{"type":"integer","description":"Quantos dias após a data de vencimento do boleto para iniciar o processo de negativação através da opção escolhida no campo orgaoNegativador. (valor inteiro >= 0).","format":"int32"},"orgaoNegativador":{"type":"integer","description":"Código do Órgão Negativador.\n\nDomínio:\n10 - SERASA","format":"int32"},"indicadorAceiteTituloVencido":{"type":"string","description":"Indicador de que o boleto pode ou não ser recebido após o vencimento. Campo não obrigatório\n\nSe não informado, será assumido a informação de limite de recebimento que está definida no convênio.\n\nQuando informado \"S\" em conjunto com o campo \"numeroDiasLimiteRecebimento\", será definido a quantidade de dias (corridos) que este boleto ficará disponível para pagamento após seu vencimento.\nObs.: Se definido \"S\" e o campo \"numeroDiasLimiteRecebimento\" ficar com valor zero também será assumido a informação de limite de recebimento que está definida no convênio.\n\nQuando informado \"N\", fica definindo que o boleto NÃO permite pagamento em atraso, portanto só aceitará pagamento até a data do vencimento ou o próximo dia útil, quando o vencimento ocorrer em dia não útil.\n\nQuando informado qualquer valor diferente de \"S\" ou \"N\" será assumido a informação de limite de recebimento que está definida no convênio."},"numeroDiasLimiteRecebimento":{"type":"integer","description":"Número de dias limite para recebimento. Informar valor inteiro > 0.","format":"int32"},"codigoAceite":{"type":"string","description":"Código para identificar se o boleto de cobrança foi aceito (reconhecimento da dívida pelo Pagador).\n\nDomínios:\nA - ACEITE\nN - NAO ACEITE"},"codigoTipoTitulo":{"type":"integer","description":"Código para identificar o tipo de boleto de cobrança.\n\nDomínios:\n1- CHEQUE\n2- DUPLICATA MERCANTIL\n3- DUPLICATA MTIL POR INDICACAO\n4- DUPLICATA DE SERVICO\n5- DUPLICATA DE SRVC P/INDICACAO\n6- DUPLICATA RURAL\n7- LETRA DE CAMBIO\n8- NOTA DE CREDITO COMERCIAL\n9- NOTA DE CREDITO A EXPORTACAO\n10- NOTA DE CREDITO INDULTRIAL\n11- NOTA DE CREDITO RURAL\n12- NOTA PROMISSORIA\n13- NOTA PROMISSORIA RURAL\n14- TRIPLICATA MERCANTIL\n15- TRIPLICATA DE SERVICO\n16- NOTA DE SEGURO\n17- RECIBO\n18- FATURA\n19- NOTA DE DEBITO\n20- APOLICE DE SEGURO\n21- MENSALIDADE ESCOLAR\n22- PARCELA DE CONSORCIO\n23- DIVIDA ATIVA DA UNIAO\n24- DIVIDA ATIVA DE ESTADO\n25- DIVIDA ATIVA DE MUNICIPIO\n31- CARTAO DE CREDITO\n32- BOLETO PROPOSTA\n33- BOLETO APORTE\n99- OUTROS.","format":"int32"},"descricaoTipoTitulo":{"type":"string","description":"Descrição do tipo de boleto."},"indicadorPermissaoRecebimentoParcial":{"type":"string","description":"Código para identificação da autorização de pagamento parcial do boleto.\n\nDomínios:\nS - SIM\nN - NÃO\n"},"numeroTituloBeneficiario":{"type":"string","description":"São aceitos como caracteres válidos:\n\n • caracteres alfanuméricos: A a Z, 0 a 9;\n\n • caracteres especiais de conjunção: hifen (-),apostrofo (');\n\n exemplos: D'EL-REI, D'ALCORTIVO, SANT'ANA\n\n • separador de palavras: branco ( );\n\n Obs: Quaisquer caracteres diferentes dos mencionados acima, serão considerados inválidos."},"campoUtilizacaoBeneficiario":{"type":"string","description":"Informações adicionais sobre o beneficiário."},"numeroTituloCliente":{"type":"string","description":"Número de identificação do boleto (correspondente ao NOSSO NÚMERO), no formato STRING, com 20 dígitos, que deverá ser formatado da seguinte forma: “000” + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda)."},"mensagemBloquetoOcorrencia":{"type":"string","description":"Mensagem definida pelo beneficiário para ser impressa no boleto.
O limite é de 165 caracteres, sendo que a cada 55 caracteres, a linha é quebrada.
O limite é de 3 linhas de mensagem (cada uma com 55 caracteres).
Caracteres de quebra de linha e de escape (como \\n, \\r e \\lf) não são permitidos."},"desconto":{"type":"object","description":"Define a ausência ou a forma como será concedido o desconto para o Título de Cobrança.","properties":{"tipo":{"type":"integer","description":"Como o desconto será concedido, inteiro >= 0. Domínios: \n0 - SEM DESCONTO;\n1 - VLR FIXO ATE A DATA INFORMADA;\n2 - PERCENTUAL ATE A DATA INFORMADA; \n3 - DESCONTO POR DIA DE ANTECIPACAO.","format":"int32"},"dataExpiracao":{"type":"string","description":"Se tipo > 0, Definir uma data de expiração do desconto, no formato \"dd.mm.aaaa\"."},"porcentagem":{"type":"number","description":"Se tipo = 2, definir uma porcentagem de desconto >= 0.00 (formato decimal separado por \".\").","format":"float"},"valor":{"type":"number","description":"Se tipo = 1, definir um valor de desconto >= 0.00 (formato decimal separado por \".\").","format":"float"}}},"segundoDesconto":{"type":"object","properties":{"dataExpiracao":{"type":"string","description":"Se tipo > 0, Definir uma data de expiração do desconto, no formato \"dd.mm.aaaa\" ."},"porcentagem":{"type":"number","description":"Se tipo = 2, definir uma porcentagem de desconto >= 0.00 (formato decimal separado por \".\").","format":"float"},"valor":{"type":"number","description":"Se tipo = 1, definir um valor de desconto >= 0.00 (formato decimal separado por \".\").","format":"float"}}},"terceiroDesconto":{"type":"object","properties":{"dataExpiracao":{"type":"string","description":"Se tipo > 0, Definir uma data de expiração do desconto, no formato \"dd.mm.aaaa\"."},"porcentagem":{"type":"number","description":"Se tipo = 2, definir uma porcentagem de desconto >= 0.00 (formato decimal separado por \".\").","format":"float"},"valor":{"type":"number","description":"Se tipo = 1, definir um valor de desconto >= 0.00 (formato decimal separado por \".\").","format":"float"}}},"jurosMora":{"type":"object","description":"Código utilizado pela FEBRABAN para identificar o tipo de taxa de juros, sendo:\n0 - DISPENSAR, 1 - VALOR DIA ATRASO, 2 - TAXA MENSAL, 3 - ISENTO. Se informado ‘0’ (zero) ou ‘3’ (três), os campos “PERCENTUAL DE JUROS DO TÍTULO” e “VALOR DO JUROS DO TÍTULO” não devem ser informados ou ser informados igual a ‘0’ (zero).\n\nO valor de juros e multa incidem sobre o valor atual do boleto (valor do boleto - valor de abatimento).","properties":{"tipo":{"type":"integer","description":"Código utilizado pela FEBRABAN para identificar o tipo de taxa de juros.\n\nDomínios:\n0 - DISPENSAR;\n1 - VALOR DIA ATRASO;\n2 - TAXA MENSAL;\n3 - ISENTO.","format":"int32"},"porcentagem":{"type":"number","description":"Se tipo = 2, definir uma porcentagem de juros >= 0.00 (formato decimal separado por \".\").","format":"float"},"valor":{"type":"number","description":"Se tipo = 1, definir um valor de juros >= 0.00 (formato decimal separado por \".\").","format":"float"}}},"multa":{"type":"object","description":"Código para identificação do tipo de multa para o Título de Cobrança, inteiro >= 0, sendo: 0 - Sem multa, 1 - Valor da Multa, 2 - Percentual da Multa. Se informado ‘0’ (zero) os campos “DATA DE MULTA”, “PERCENTUAL DE MULTA” e “VALOR DA MULTA” não devem ser informados ou ser informados iguais a ‘0’ (zero).\n\nO valor de juros e multa incidem sobre o valor atual do boleto (valor do boleto - valor de abatimento).","properties":{"tipo":{"type":"integer","description":"Como a multa será concedida, inteiro >= 0.\n\nDomínios: \n0 - DISPENSAR; \n1 - VALOR DIA ATRASO; \n2 - TAXA MENSAL; \n3 - ISENTO.","format":"int32"},"data":{"type":"string","description":"Se tipo > 0, Definir uma data de multa, no formato \"dd.mm.aaaa\" "},"porcentagem":{"type":"number","description":"Se tipo = 2, definir porcentagem >= 0.00 (formato decimal separado por \".\").","format":"float"},"valor":{"type":"number","description":"Se tipo = 1, definir valor do juros >= 0.00 (formato decimal separado por \".\").","format":"float"}}},"pagador":{"type":"object","properties":{"tipoInscricao":{"type":"integer","description":"Código que identifica o tipo de inscrição do Pagador.\n\nDomínios:\n1 - CPF;\n2 - CNPJ","format":"int32"},"numeroInscricao":{"type":"integer","description":"Número de inscrição do pagador. \nPara o tipo = 1, informar numero do CPF. \nPara o tipo = 2, informar numero do CNPJ.","format":"int64"},"nome":{"type":"string","description":"Nome do pagador."},"endereco":{"type":"string","description":"Endereço do pagador."},"cep":{"type":"integer","description":"Código postal do pagador.","format":"int32"},"cidade":{"type":"string","description":"Cidade do pagador."},"bairro":{"type":"string","description":"Bairro do pagador."},"uf":{"type":"string","description":"Sigla do unidade federativa em que o pagador vive."},"telefone":{"type":"string","description":"Número de telefone do pagador."},"email":{"type":"string","description":"Email do pagador."}},"required":["tipoInscricao","numeroInscricao"]},"beneficiarioFinal":{"type":"object","properties":{"tipoInscricao":{"type":"integer","description":"Código que identifica o tipo de inscrição do beneficiário final.\n\nDomínios:\n1 - CPF;\n2 - CNPJ","format":"int32"},"numeroInscricao":{"type":"integer","description":"Número de registro do beneficiário final. \nPara o tipo = 1, informar numero do CPF. \nPara o tipo = 2, informar numero do CNPJ.","format":"int64"},"nome":{"type":"string","description":"Nome do beneficiário final"}}},"indicadorPix":{"type":"string","description":"Código para informar se o boleto terá um QRCode Pix atrelado. Se informado caracter inválido, assumirá 'N'.\n\nDomínios:\n'S' - QRCODE DINAMICO;\n'N' - SEM PIX; OUTRO - SEM PIX"}},"required":["numeroConvenio","dataVencimento","valorOriginal"]}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_boletos_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/get_boletos_by_id","parameters":{"id":{"type":"string","description":"Número do título de cobrança."},"numeroConvenio":{"type":"number","description":"Número do convênio."}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/patch_boletos_by_id","parameters":{"id":{"type":"string","description":"Número do título de cobrança."},"data":{"title":"RequisicaoAlterarBoleto","required":["indicadorAlterarAbatimento","indicadorAlterarDataDesconto","indicadorAlterarDesconto","indicadorAlterarEnderecoPagador","indicadorAlterarPrazoBoletoVencido","indicadorAlterarSeuNumero","indicadorAtribuirDesconto","indicadorCancelarProtesto","indicadorCobrarJuros","indicadorCobrarMulta","indicadorDispensarJuros","indicadorDispensarMulta","indicadorIncluirAbatimento","indicadorNegativar","indicadorNovaDataVencimento","indicadorProtestar","indicadorSustacaoProtesto","indicadorNovoValorNominal"],"type":"object","properties":{"numeroConvenio":{"type":"integer","description":"Identificador determinado pelo sistema de boleto bancário para fornecer a emissão e liquidação do boleto e, portanto, usado para creditar o Beneficiário.","format":"int32"},"indicadorNovaDataVencimento":{"type":"string","description":"Indica a intenção de atribuir nova data de vencimento ao boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"alteracaoData":{"$ref":"#/components/schemas/alteracaoData"},"indicadorNovoValorNominal":{"type":"string","description":"Indica a intenção de alterar valor nominal do boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"alteracaoValor":{"$ref":"#/components/schemas/AlterarValorNominal"},"indicadorAtribuirDesconto":{"type":"string","description":"Indica a intenção de atribuir desconto ao boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"desconto":{"$ref":"#/components/schemas/desconto"},"indicadorAlterarDesconto":{"type":"string","description":"Indica a intenção de alterar desconto do boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"alteracaoDesconto":{"$ref":"#/components/schemas/alteracaoDesconto"},"indicadorAlterarDataDesconto":{"type":"string","description":"Indica a intenção de alterar a data do desconto do boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"alteracaoDataDesconto":{"$ref":"#/components/schemas/alteracaoDataDesconto"},"indicadorProtestar":{"type":"string","description":"Indica a intenção de protestar o boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"protesto":{"$ref":"#/components/schemas/protesto"},"indicadorSustacaoProtesto":{"type":"string","description":"Indica a intenção de sustar/cancelar um comando de protesto do boleto que já tenha sido processado pelo Banco. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar."},"indicadorCancelarProtesto":{"type":"string","description":"Deve ser utilizada para cancelar uma instrução de protesto enviada ao Banco na mesma data ou que ainda não tenha sido processada pelo Banco. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"indicadorIncluirAbatimento":{"type":"string","description":"Indica a intenção de incluir abatimento no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"abatimento":{"$ref":"#/components/schemas/abatimento"},"indicadorAlterarAbatimento":{"type":"string","description":"Indica a intenção de alterar o valor do abatimento no boleto. Domínio:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"alteracaoAbatimento":{"$ref":"#/components/schemas/alteracaoAbatimento"},"indicadorCobrarJuros":{"type":"string","description":"Indica a intenção de cobrar juros no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"juros":{"$ref":"#/components/schemas/juros"},"indicadorDispensarJuros":{"type":"string","description":"Indica a intenção de dispensar juros no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"indicadorCobrarMulta":{"type":"string","description":"Indica a intenção de cobrar multa no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"multa":{"$ref":"#/components/schemas/multa"},"indicadorDispensarMulta":{"type":"string","description":"Indica a intenção de dispensar cobrança de multa no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"indicadorNegativar":{"type":"string","description":"Indica a intenção de negativar ou cancelar negativação boleto. (Inclusão ou Cancelamento) Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"negativacao":{"$ref":"#/components/schemas/negativacao"},"indicadorAlterarSeuNumero":{"type":"string","description":"Indica a intenção de alterar Seu Numero no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"alteracaoSeuNumero":{"$ref":"#/components/schemas/alteracaoSeuNumero"},"indicadorAlterarEnderecoPagador":{"type":"string","description":"Indica a intenção de alterar endereço do Pagador no boleto. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"alteracaoEndereco":{"$ref":"#/components/schemas/alteracaoEndereco"},"indicadorAlterarPrazoBoletoVencido":{"type":"string","description":"Indica a intenção de prazo de aceite de boleto vencido. Valores a informar:\n\"S\" -> Sim, desejo alterar\n\"N\" -> Não, não desejo alterar"},"alteracaoPrazo":{"$ref":"#/components/schemas/alteracaoPrazo"}},"description":"Representação dos campos de requisição de uma solicitação de alteração dos dados de boletos bancários."}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_boletos_by_id_baixar","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/post_boletos_by_id_baixar","parameters":{"id":{"type":"string","description":"Número do boleto bancário (único e exclusivo) que identifica o título e é usado para pagá-lo."},"data":{"required":["numeroConvenio"],"type":"object","properties":{"numeroConvenio":{"type":"number","description":"Identificador determinado pelo sistema de boleto bancário usado para emissão e liquidação do boleto e, portanto, usado para creditar o Beneficiário."}},"description":"Objeto de requisição da baixa de boletos."}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_boletos_by_id_cancelar_pix","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/post_boletos_by_id_cancelar_pix","parameters":{"id":{"type":"string"},"data":{"type":"object","properties":{"numeroConvenio":{"type":"integer","format":"int32","description":"Número do convênio de Cobrança do Cliente."}},"required":{"0":"numeroConvenio"}}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_boletos_by_id_gerar_pix","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/post_boletos_by_id_gerar_pix","parameters":{"id":{"type":"string"},"data":{"type":"object","properties":{"numeroConvenio":{"type":"integer","format":"int32","description":"Número do convênio de Cobrança do Cliente."}},"required":{"0":"numeroConvenio"}}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_boletos_by_id_pix","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/get_boletos_by_id_pix","parameters":{"id":{"type":"string","description":"Número de identificação do boleto (correspondente ao NOSSO NÚMERO, numeroTituloCliente), no formato STRING, com 20 dígitos, que deverá ser formatado da seguinte forma: “000” + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda). Campo Obrigatório."},"numeroConvenio":{"type":"number","description":"Número do convênio de Cobrança do Cliente"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_convenios_by_id_listar_retorno_movimento","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/post_convenios_by_id_listar_retorno_movimento","parameters":{"id":{"type":"string"},"data":{"type":"object","properties":{"dataMovimentoRetornoInicial":{"type":"string","description":"Data inicial do processamento do movimento de retorno de cobrança de Boleto.","example":"01.03.2022"},"dataMovimentoRetornoFinal":{"type":"string","description":"Data final do processamento do movimento de retorno de cobrança de Boleto.","example":"20.03.2022"},"codigoPrefixoAgencia":{"type":"integer","description":"Código do prefixo identificador de uma dependência do Banco.","example":1,"format":"int64"},"numeroContaCorrente":{"type":"integer","description":"Número identificador de uma Conta Corrente contratada pelo cliente junto ao Banco do Brasil.","example":12345678,"format":"int64"},"numeroCarteiraCobranca":{"type":"integer","description":"Número identificador da carteira de Cobrança. Indica o tipo de serviço de cobrança, para o qual são aplicadas regras específicas.","example":17,"format":"int32"},"numeroVariacaoCarteiraCobranca":{"type":"integer","description":"Número identificador da variação da Carteira de Cobrança. Identifica cada grupo de condições específicas (variação) para um mesmo tipo de serviço de cobrança contratado pelo cliente (carteira), visando separar os títulos de cobrança de acordo com os interesses do próprio cliente e previamente negociados com o Banco.","example":35,"format":"int32"},"numeroRegistroPretendido":{"type":"integer","description":"Número do registro ou da página que deseja buscar na consulta. Quando primeira chamada, informar \"001\"","example":1,"format":"int64"},"quantidadeRegistroPretendido":{"type":"integer","description":"Quantidade de registros ou páginas que desejar buscar na consulta. Quantidade máxima de 10000 boletos por chamada","format":"int64","example":10000}},"required":{"0":"dataMovimentoRetornoInicial","1":"dataMovimentoRetornoFinal"}}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_boletos_baixa_operacional","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/get_boletos_baixa_operacional","parameters":{"agencia":{"type":"integer","description":"Número da agência do beneficiário, sem o dígito verificador."},"conta":{"type":"integer","description":"Número da conta do beneficiário, sem o dígito verificador."},"carteira":{"type":"integer","description":"Número da carteira do convênio de cobrança."},"variacao":{"type":"integer","description":"Número da variação da carteira do convênio de cobrança."},"estadoBaixaOperacional":{"type":"integer","description":"Código para identificar o estado da baixa operacional. Domínio:1 - BAIXA OPERACIONAL BB; 2 - BAIXA OPERACIONAL OUTROS BANCOS; 10- CANCELAMENTO DE BAIXA OPERACIONAL"},"modalidadeTitulo":{"type":"integer","description":"Código para identificar a característica dos boletos dentro das modalidades de cobrança existentes no banco.\n\nDomínio:\n1 - SIMPLES\n4 - VINCULADA"},"dataInicioVencimentoTitulo":{"type":"string","description":"Data de vencimento inicial para delimitar período da consulta."},"dataFimVencimentoTitulo":{"type":"string","description":"Data de vencimento final para delimitar período da consulta."},"dataInicioRegistroTitulo":{"type":"string","description":"Data de registro inicial para delimitar período da consulta."},"dataFimRegistroTitulo":{"type":"string","description":"Data de registro final para delimitar período da consulta."},"dataInicioAgendamentoTitulo":{"type":"string","description":"Data de agendamento inicial para delimitar período da consulta."},"dataFimAgendamentoTitulo":{"type":"string","description":"Data de agendamento final para delimitar período da consulta."},"horarioInicioAgendamentoTitulo":{"type":"string","description":"Hora de agendamento inicial para delimitar período da consulta."},"horarioFimAgendamentoTitulo":{"type":"string","description":"Hora de agendamento final para delimitar período da consulta."},"idProximoTitulo":{"type":"string","description":"Identificador do próximo título da próxima paginação a ser consultado. Somente deve ser utilizado em caso de pesquisas que retornem mais de 650 boletos.\nSe na resposta da primeira consulta, ou consulta anterior, o campo \"possuiMaisTitulos\" retorne o valor \"S\", então na próxima chamada, o usuário deve informar o valor do campo \"proximoTitulo\" que veio na resposta, a partir do qual será iniciada nova consulta."}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_convenios_by_id_ativar_consulta_baixa_operacional","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/patch_convenios_by_id_ativar_consulta_baixa_operacional","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/parameters_convenios_by_id_desativar_consulta_baixa_operacional","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"cobrancas/patch_convenios_by_id_desativar_consulta_baixa_operacional","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"debitos_veiculantes/post_solicitacoes","parameters":{"data":{"type":"object","properties":{"numeroRenavam":{"type":"string","description":"Código do Registro Nacional de Veículos Automotores a ser consultado. Informação obrigatória para realizar a consulta. O registro é único por unidades da federação.","example":"1367558066"},"codigoCpf":{"type":"string","description":"Código do Cadastro de Pessoas Físicas do solicitante da consulta de veículo. Informação que deverá ser enviada para realizar a consulta. Para alguns entes é obrigatório informar, além do Renavam, a identificação do solicitante. Para outros entes a consulta é apenas pelo Renavam. Cada ente tem a sua característica. A identificação da pessoa poderá ser feita por CPF ou CNPJ, sendo este informado em campo específico.","example":"31212332112"},"codigoCnpj":{"type":"string","description":"Código do Cadastro Nacional de Pessoa Jurídica do solicitante da consulta de veículo. Informação que deverá ser enviada para realizar a consulta. Para alguns entes é obrigatório informar, além do Renavam, a identificação do solicitante. Para outros entes a consulta é apenas pelo Renavam. Cada ente tem a sua característica. A identificação da pessoa poderá ser feita por CNPJ ou CPF, sendo este informado em campo específico.","example":"12123123000122"},"codigoUf":{"type":"string","description":"Sigla da Unidade Federativa onde o veículo está cadastrado. Informação obrigatória para realizar a consulta.","example":"SP"},"codigoPlaca":{"type":"string","description":"Número da placa do veículo a ser consultado. Informação que deverá ser enviada para realizar a consulta. Para alguns entes é obrigatório informar, além do Renavam, a placa do veículo. Para outros entes a consulta é apenas pelo Renavam. Cada ente tem a sua característica.","example":"ABC1234"}},"required":["numeroRenavam","codigoUf"]}}},{"connectionName":"banco-do-brasil","actionName":"debitos_veiculantes/post_pagamentos","parameters":{"data":{"type":"object","properties":{"codigoSolicitacao":{"type":"string","description":"Código de protocolo que identifica cada solicitação de consulta realizada.","maxLength":20,"example":"VEIC24M3SVVAY9"},"codigoServico":{"type":"integer","format":"int32","description":"Código que identifica unicamente um grupo no detalhamento de pagamento de tributos.","example":1100},"numeroUnicoItemBanco":{"type":"integer","format":"int64","description":"Identificação do grupo do tributo no Banco do Brasil, no momento da realização da consulta. A cada consulta ao órgão, o BB gera esse número para identificação da consulta daquele grupo. Número gerado automaticamente (dinâmico) para cada tributo do grupo. Necessário para realizar o pagamento.","example":12312423},"numeroIdentificadorItem":{"type":"integer","format":"int32","description":"Número sequencial que identifica o tributo dentro do grupo no qual foi constatado débito na consulta.","example":1}},"required":["codigoSolicitacao","codigoServico","numeroUnicoItemBanco","numeroIdentificadorItem"]}}},{"connectionName":"banco-do-brasil","actionName":"debitos_veiculantes/get_solicitacoes_by_codigo_solicitacao","parameters":{"codigoSolicitacao":{"type":"string","description":"Código de protocolo que identifica cada solicitação de consulta realizada."}}},{"connectionName":"banco-do-brasil","actionName":"extratos/parameters_conta_corrente_agencia_by_agencia_conta_by_conta","parameters":{"agencia":{"type":"string"},"conta":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"extratos/get_conta_corrente_agencia_by_agencia_conta_by_conta","parameters":{"agencia":{"type":"string"},"conta":{"type":"string"},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"numeroPaginaSolicitacao":{"type":"integer","description":"Número da página solicitada. Opcionalmente, quando não informado, será atribuído página 1."},"":{"type":"integer","description":"Quantidade de registros da página solicitada (pagesize). Opcionalmente, quando não informado, será atribuído pagesize 200. Pagesize máximo: 200 registros. Pagesize mínimo: 50 registros. O pagesize informado na solicitação da primeira página deverá ser mantido nos pedidos das páginas subsequentes do extrato."},"dataInicioSolicitacao":{"type":"integer","description":"Data inicial do período do extrato solicitado. Formato DDMMAAAA. Limite máximo para data inicial: 5 anos a partir da data atual. Para casos onde os campos data inicial e data final não estejam preenchidos, será retornado o extrato dos últimos 30 dias. Caso o campo data inicial seja preenchido, o preenchimento do campo data final será obrigatório."},"dataFimSolicitacao":{"type":"integer","description":"Data final do período do extrato solicitado. Formato DDMMAAAA. Período máximo entre a data inicial e a data final: 31 dias. Para casos onde os campos data final e data inicial não estejam preenchidos, será retornado o extrato dos últimos 30 dias. Caso o campo data final seja preenchido, o preenchimento do campo data inicial será obrigatório."}}},{"connectionName":"banco-do-brasil","actionName":"fundos_de_investimento/get_saldo_agencia_by_numero_agencia_conta_by_numero_conta","parameters":{"numeroAgencia":{"type":"integer","description":"Número da agência do cliente sem o dígito verificador."},"numeroConta":{"type":"integer","description":"Número da conta do cliente sem o dígito verificador."}}},{"connectionName":"banco-do-brasil","actionName":"fundos_de_investimento/post_aplicacao","parameters":{"data":{"type":"object","properties":{"numeroAgencia":{"type":"integer","format":"int32","description":"Número da agência sem o dígito verificador.","examples":{"0":"7984"}},"numeroConta":{"type":"integer","format":"int64","description":"Número da conta sem o dígito verificador.","examples":{"0":"4024"}},"codigoFundo":{"type":"integer","format":"int32","description":"Código do Fundo de Investimento no sistema GFI.","examples":{"0":"1320"}},"dataAplicacao":{"type":"string","description":"Data da aplicação no fundo de investimento.","maxLength":10,"examples":{"0":"2024-11-11"}},"valorAplicacao":{"type":"number","format":"float","description":"Valor da aplicação no fundo de investimento.","examples":{"0":"100.55"}}},"required":{"0":"numeroAgencia","1":"numeroConta","2":"codigoFundo","3":"dataAplicacao","4":"valorAplicacao"}}}},{"connectionName":"banco-do-brasil","actionName":"fundos_de_investimento/post_resgate","parameters":{"data":{"type":"object","properties":{"numeroAgencia":{"type":"integer","format":"int32","description":"Número da Agência sem o dígito verificador.","examples":{"0":"7984"}},"numeroConta":{"type":"integer","format":"int64","description":"Número da Conta sem o dígito verificador.","examples":{"0":"4010"}},"codigoFundo":{"type":"integer","format":"int32","description":"Código do Fundo de Investimento no sistema GFI.","examples":{"0":"1320"}},"dataResgate":{"type":"string","description":"Data do resgate no fundo de investimento.","maxLength":10,"examples":{"0":"2024-11-11"}},"valorResgate":{"type":"number","format":"float","description":"Valor do resgate no fundo de investimento.","examples":{"0":"100.33"}}},"required":{"0":"numeroAgencia","1":"numeroConta","2":"codigoFundo","3":"dataResgate","4":"valorResgate"}}}},{"connectionName":"banco-do-brasil","actionName":"fundos_de_investimento/post_resgate_total","parameters":{"data":{"type":"object","properties":{"numeroAgencia":{"type":"integer","format":"int32","description":"Número da Agência sem o dígito verificador.","examples":{"0":"7984"}},"numeroConta":{"type":"integer","format":"int64","description":"Número da Conta sem o dígito verificador.","examples":{"0":"4010"}},"codigoFundo":{"type":"integer","format":"int32","description":"Código do Fundo de Investimento no sistema GFI.","examples":{"0":"1320"}},"dataResgate":{"type":"string","description":"Data do resgate de todo o saldo no fundo de investimento.","maxLength":10,"examples":{"0":"2024-11-11"}}},"required":{"0":"numeroAgencia","1":"numeroConta","2":"codigoFundo","3":"dataResgate"}}}},{"connectionName":"banco-do-brasil","actionName":"login_bb/servers_oauth_jwks","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"login_bb/get_oauth_jwks","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"login_bb/get_oauth_v2_userinfo","parameters":{"gw-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor (developer_application_key) criada no portal do desenvolvedor. Você pode consultar este valor acessando no Portal do Desenvolvedor -> Aplicações -> Credenciais -> developer_application_key."}}},{"connectionName":"banco-do-brasil","actionName":"pag_bb/post_lotes_pix","parameters":{"gw-dev-app-key":{"type":"string","description":"Chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"data":{"type":"object","properties":{"idLote":{"description":"Número identificador do lote Pix que deve ser informado pelo cliente no momento da inclusão. Não precisa ser sequencial. De uso único, por contrato PagBB.","type":"integer","format":"int64","maxLength":11,"example":1234567891},"numeroAgenciaDebito":{"description":"Número da agência da conta corrente onde será efetuado o débito do valor total do lote.","type":"string","example":"1234"},"numeroContaDebito":{"description":"Número da conta corrente onde será efetuado o débito do valor total do lote.","type":"string","example":"987654321"},"numeroContrato":{"description":"Número do contrato PagBB firmado entre o cliente e o Banco do Brasil.","type":"integer","format":"int64","example":900056789},"lancamentos":{"description":"Lista de Lançamentos","type":"array","items":{"$ref":"#/components/schemas/LancamentoPIX"}}}}}},{"connectionName":"banco-do-brasil","actionName":"pag_bb/get_lotes_by_id_lote_pix_lancamentos","parameters":{"id-lote":{"type":"string","description":"Número identificador do lote informado pelo cliente no momento da inclusão."},"gw-dev-app-key":{"type":"string","description":"Chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"contrato":{"type":"integer","description":"Número do contrato PagBB do cliente com o Banco do Brasil."}}},{"connectionName":"banco-do-brasil","actionName":"pag_bb/get_lotes_by_id_lote_pix_lancamentos_by_id_lancamento","parameters":{"id-lote":{"type":"string","description":"Número identificador do lote informado pelo cliente no momento da inclusão."},"id-lancamento":{"type":"string","description":"Número identificador do lançamento em um lote."},"gw-dev-app-key":{"type":"string","description":"Chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"contrato":{"type":"integer","description":"Número do contrato PagBB do cliente com o Banco do Brasil."}}},{"connectionName":"banco-do-brasil","actionName":"pag_bb/put_lotes_by_id_lote_liberacoes","parameters":{"id-lote":{"type":"string","description":"Número identificador do lote informado pelo cliente no momento da inclusão."},"gw-dev-app-key":{"type":"string","description":"Chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"contrato":{"type":"integer","description":"Número do contrato PagBB do cliente com o Banco do Brasil."}}},{"connectionName":"banco-do-brasil","actionName":"pag_bb/put_lotes_by_id_lote_cancelamentos","parameters":{"id-lote":{"type":"string","description":"Número identificador do lote informado pelo cliente no momento da inclusão."},"gw-dev-app-key":{"type":"string","description":"Chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"contrato":{"type":"integer","description":"Número do contrato PagBB do cliente com o Banco do Brasil."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/post_liberar_pagamentos","parameters":{"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"data":{"type":"object","description":"Campos de uma requisição ao recurso de liberação de pagamentos.","x-oad-type":"object","properties":{"numeroRequisicao":{"type":"integer","description":"Número sequencial da requisição enviada e controlada pelo cliente conveniado, cujos pagamentos estão sendo liberados.","format":"int32","x-oad-type":"integer"},"indicadorFloat":{"type":"string","description":"Indicador de confirmação/concordância quanto ao pagamento da tarifa de antecipacao de float a ser calculada posteriormente.\n\nEssa tarifa somente será cobrada quando a data de liberação dos pagamentos for posterior a data de cobrança do float pactuado na contratação do serviço.\n","x-oad-type":"string"}},"required":["indicadorFloat","numeroRequisicao"]}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_lotes_transferencias","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"numeroContratoPagamento":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente.\nQuando utilizado Login Máquina Máquina: É opcional.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token."},"agenciaDebito":{"type":"integer","description":"Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\nQuando utilizado Login Máquina Máquina: É opcional.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token."},"contaCorrenteDebito":{"type":"integer","description":"Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\nQuando utilizado Login Máquina Máquina: É opcional.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token."},"digitoVerificadorContaCorrente":{"type":"string","description":"Dígito do verificador da conta corrente para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\nQuando utilizado Login Máquina Máquina: É opcional.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token."},"dataInicio":{"type":"integer","description":"Data inicial de envio da requisição a ser pesquisada."},"dataFim":{"type":"integer","description":"Data final de envio da requisição a ser pesquisada."},"tipoPagamento":{"type":"integer","description":"A modalidade que representa o tipo de pagamento, descrita a seguir: \n126 significa pagamento de fornecedores;\n127 significa pagamento de salário; \n128 significa pagamento diverso."},"estadoRequisicao":{"type":"integer","description":"Código que identifica o estado da solicitação. \n \n 1 - Requisição com todos os lançamentos com dados consistentes; \n \n 2 - Requisição com ao menos um dos lançamentos com dados inconsistentes; \n \n 3 - Requisição com todos os lançamentos com dados inconsistentes; \n \n 4 - Requisição pendente de ação pelo Conveniado - falta autorizar o pagamento; \n \n 5 - Requisição em processamento pelo Banco; \n \n 6 - Requisição Processada; \n \n 7 - Requisição Rejeitada, \n \n 8 - Preparando remessa não liberada, \n \n 9 - Requisição liberada via API, \n \n 10 - Preparando remessa liberada. \n \n As situações 1, 2 e 8 são transitórias e não requerem qualquer ação do Cliente Conveniado. \n \n situação 3 sempre será migrada para situação 7. \n \n A situação 4 Significa que, ao menos um lançamento, depende de ação do Cliente Conveniado, seja liberando ou cancelando os pagamentos. \n \n As situações 5, 6, 7, 9 e 10 não requerem qualquer ação do Cliente Conveniado. \n \n A situação 5 significa que, ao menos um lançamento, está agendado. \n \n As situações 6 e 7 são definitivas não havendo alteração posterior da situação da requisição. "},"indice":{"type":"integer","description":"Posição do índice. Cada resposta tem um limite de 300 ocorrências na lista paymentList, iniciada a partir do valor do índice fornecido. Para todas as ocorrências, itere sobre esse recurso usando o valor do campo nextIndex da resposta.\n"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/post_lotes_transferencias","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"data":{"type":"object","description":"Objeto de Requisição ao efetuar Lotes de Pagamentos realizados via Transferência Bancária.","x-oad-type":"object","properties":{"numeroRequisicao":{"type":"integer","description":"Numero controlado pelo cliente para identificar cada acionamento da API e os lançamentos de cada chamada.\nNão precisa ser sequencial. \nDe uso único.","format":"int64","x-oad-type":"integer"},"numeroContratoPagamento":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente.","format":"int64","x-oad-type":"integer"},"agenciaDebito":{"type":"integer","description":"Número da agência da Conta Corrente onde deverá ser efetuado o débito do valor total de cada requisição.\nQuando utilizado Login Máquina Máquina: É informado pelo cliente.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.","format":"int64","x-oad-type":"integer"},"contaCorrenteDebito":{"type":"integer","description":"Número da Conta Corrente onde deverá ser efetuado o débito do valor total de cada requisição.\nQuando utilizado Login Máquina Máquina: É informado pelo cliente.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.","format":"int64","x-oad-type":"integer"},"digitoVerificadorContaCorrente":{"type":"string","description":"Digito verificador da Conta corrente onde deverá ser efetuado o débito do valor total de cada requisição.\nQuando utilizado Login Máquina Máquina: É informado pelo cliente.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.","x-oad-type":"string","maxLength":1},"tipoPagamento":{"type":"integer","description":"Informado pela API de acordo com o endpoint utilizado pelo cliente.\nPode ser: \n126=Pagamento a Fornecedores; \n127=Pagamento de Salários; \n128=Pagamentos Diversos.","format":"int64","x-oad-type":"integer"},"listaTransferencias":{"type":"array","description":"Lista de Transferências","x-oad-type":"array","items":{"type":"object","x-oad-type":"object","properties":{"numeroCOMPE":{"type":"integer","description":"Número COMPE (Código do Sistema de Operações Monetárias e Compensações de Outros Papéis) da instituição detentora da conta do favorecido. Uma lista de códigos permitidos é obtida através do site do Banco Central (https://dadosabertos.bcb.gov.br/dataset/lista-de-participantes-do-str).","format":"int64","x-oad-type":"integer"},"numeroISPB":{"type":"integer","description":"Número ISPB (Identificador de Sistema de Pagamento Brasileiro) da instituição detentora da conta do favorecido. Uma lista de códigos permitidos é obtida através do site do Banco Central (https://dadosabertos.bcb.gov.br/dataset/lista-de-participantes-do-str).Se atentar para o código \"0\" que é existente na relação do Banco Central.","format":"int64","x-oad-type":"integer"},"agenciaCredito":{"type":"integer","description":"Número da Agência da Conta do favorecido onde deverá ser efetuado o crédito.","format":"int64","x-oad-type":"integer","maxLength":4},"contaCorrenteCredito":{"type":"integer","description":"Número da Conta Corrente do favorecido onde deverá ser efetuado o crédito.","format":"int64","x-oad-type":"integer"},"digitoVerificadorContaCorrente":{"type":"string","x-oad-type":"string","maxLength":1},"contaPagamentoCredito":{"type":"string","description":"Número da conta pagamento do favorecido onde deverá ser efetuado crédito.\nQuando informado, os campos Número Agência de Crédito, Número da Conta Corrente Crédito, Dígito Verificador da Conta Corrente Crédito e Número Depósito Judicial deverão ser vazio.","x-oad-type":"string","maxLength":20},"cpfBeneficiario":{"type":"integer","description":"Número do CPF do favorecido do crédito.\nQuando informado, o campo \"\"CNPJ\"\" deverá ser vazio.","format":"int64","x-oad-type":"integer"},"cnpjBeneficiario":{"type":"integer","description":"Número do CNPJ do favorecido do crédito.\nQuando informado, o campo \"\"CPF\"\" deverá ser vazio.","format":"int64","x-oad-type":"integer"},"dataTransferencia":{"type":"integer","description":"Data em que deverá ser efetuada a transferência para a favorecido (formato: ddmmaaaa). Solicitações de pagamentos para dias não úteis serão pagas no próximo dia útil, com exceção de transferências entre contas do Banco do Brasil.","format":"int64","x-oad-type":"integer"},"valorTransferencia":{"type":"number","description":"Valor da transferência que deverá ser efetuada a crédito do favorecido (formato 0.00)","format":"double","x-oad-type":"number"},"documentoDebito":{"type":"integer","description":"Uso opcional. \n\nQuando não informado ou informados números idênticos para todos os lançamentos de uma mesma requisição: o débito na conta do pagador será exibido em um único registro no valor total dos lançamentos validados. \n\nQuando informados números diversos para cada lançamento: os débitos serão exibidos de forma individualizada no extrato da conta debitada. \n\n O número de documento do débito é consolidado a partir do dia seguinte da efetivação destes lançamentos.","format":"int64","x-oad-type":"integer"},"documentoCredito":{"type":"integer","description":"Uso opcional.\nPermite a personalização do Número do documento de crédito exibido no extrato do favorecido - uso exclusivo para Crédito em conta corrente no BB.","format":"int64","x-oad-type":"integer"},"codigoFinalidadeDOC":{"type":"integer","description":"\"01' = Crédito em Conta \n'02' = Pagamento de Aluguel/Condomínio \n'03' = Pagamento de Duplicata/Títulos \n'04' = Pagamento de Dividendos \n'05' = Pagamento de Mensalidade Escolar \n'06' = Pagamento de Salários\n'07' = Pagamento a Fornecedores \n'08' = Operações de Câmbios/Fundos/Bolsa de Valores \n'09' = Repasse de Arrecadação/Pagamento de Tributos \n'10' = Transferência Internacional em Real \n'11' = DOC para Poupança \n'12' = DOC para Depósito Judicial \n'13' = Outros \n'22' =\n'99' =\"","format":"int64","x-oad-type":"integer"},"codigoFinalidadeTED":{"type":"integer","format":"int64","x-oad-type":"integer"},"numeroDepositoJudicial":{"type":"string","description":"Número do depósito judicial.\nDisponível para efetivação de Depósito Judicial no BB.\nInformar sempre COMPE = 1 ou ISPB = 0\nOs campos Número Agência de Crédito, Número da Conta Corrente Crédito, Dígito Verificador da Conta Corrente Crédito e Número Conta Pagamento Crédito deverão ser vazio.","x-oad-type":"string"},"descricaoTransferencia":{"type":"string","description":"Campo de uso livre pelo Cliente Conveniado - sem tratamento pelo Banco.","x-oad-type":"string","maxLength":40}},"required":["numeroCOMPE","numeroISPB","agenciaCredito","contaCorrenteCredito","digitoVerificadorContaCorrente","contaPagamentoCredito","cpfBeneficiario","cnpjBeneficiario","dataTransferencia","valorTransferencia","codigoFinalidadeDOC","codigoFinalidadeTED","numeroDepositoJudicial"]}}}}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/post_lotes_transferencias_pix","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"data":{"type":"object","description":"Objeto de Requisição quando da solicitação para efetuar pagamentos em lote via Transferência PIX.","x-oad-type":"object","properties":{"numeroRequisicao":{"type":"integer","description":"Identificador da requisição de pagamento em lote. Além de não precisar ser sequencial, o valor do identificador é controlado pelo cliente.","format":"int32","x-oad-type":"integer"},"numeroContrato":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente.","format":"int32","x-oad-type":"integer"},"agenciaDebito":{"type":"integer","description":"Número da agência da conta corrente onde deverá ser efetuado o débito do valor total de cada requisição.\n\nObrigatoriedade conforme fluxo OAuth:\n- Client Credentials: campo obrigatório;\n- Authorization Code: informação extraída do token.","format":"int32","x-oad-type":"integer"},"contaCorrenteDebito":{"type":"integer","description":"Número da conta corrente onde deverá ser efetuado o débito do valor total de cada requisição.\n\nObrigatoriedade conforme fluxo OAuth:\n- Client Credentials: campo obrigatório;\n- Authorization Code: informação extraída do token.","format":"int64","x-oad-type":"integer"},"digitoVerificadorContaCorrente":{"type":"string","description":"Digito verificador da conta corrente onde deverá ser efetuado o débito do valor total de cada requisição.\n\nObrigatoriedade conforme fluxo OAuth:\n- Client Credentials: campo obrigatório;\n- Authorization Code: informação extraída do token.","x-oad-type":"string","maxLength":1},"tipoPagamento":{"type":"integer","description":"Tipo de pagamento pretendido pelo cliente conveniado.\n\nDomínio:\n126 - Pagamento a Fornecedores\n127 - Pagamento de Salários\n128 - Pagamentos Diversos","format":"int32","x-oad-type":"integer","example":127,"enum":[126,127,128]},"listaTransferencias":{"type":"array","description":"Lista de transferências a serem efetuadas aos favorecidos. Os campos desta lista dizem respeito a crédito a determinado beneficiário.\n\nO limite de transferências feita em cada requisição é de 320.","x-oad-type":"array","items":{"type":"object","x-oad-type":"object","properties":{"data":{"type":"integer","description":"Data em que deverá ser efetuada a transferência para o favorecido.\n\nFormato: ddmmaaaa. Zero no início de numérico deve ser omitido.","format":"int32","x-oad-type":"integer","example":5112020},"valor":{"type":"number","format":"double","x-oad-type":"number","description":"Valor do pagamento em reais (formato 0.00)"},"documentoDebito":{"type":"integer","description":"Uso opcional. \n\nQuando não informado ou informados números idênticos para todos os lançamentos de uma mesma requisição: o débito na conta do pagador será exibido em um único registro no valor total dos lançamentos validados. \n\nQuando informados números diversos para cada lançamento: os débitos serão exibidos de forma individualizada no extrato da conta debitada. \n\n O número de documento do débito é consolidado a partir do dia seguinte da efetivação destes lançamentos.","format":"int64","x-oad-type":"integer"},"documentoCredito":{"type":"integer","description":"Documento de crédito. Uso opcional.\n\nPermite a personalização do Número do documento de crédito exibido no extrato do favorecido - uso exclusivo para Crédito em conta corrente no BB.","format":"int64","x-oad-type":"integer"},"descricaoPagamento":{"type":"string","description":"Descrição do pagamento.\n\nCampo de uso livre pelo Cliente Conveniado - sem tratamento pelo Banco.","maxLength":40},"descricaoPagamentoInstantaneo":{"type":"string","description":"Descrição do pagamento instantâneo para fins de conciliação do próprio cliente.\n\nCampo de uso livre pelo Cliente Conveniado - sem tratamento pelo Banco.","maxLength":35},"formaIdentificacao":{"type":"integer","description":"Código da forma de identificação da conta transacional, a fim de que a transferência seja feita por meio da utilização de chaves ou apelidos.\n\nDomínio:\n1 - Chave Pix tipo Telefone\n2 - Chave Pix tipo Email\n3 - Chave Pix tipo CPF/CNPJ\n4 - Chave Aleatória\n5 - Dados Bancários","format":"int32"},"dddTelefone":{"type":"integer","format":"int32","description":"Número de Discagem Direta à Distancia (DDD) do telefone do favorecido do crédito.Campo numérico contendo dois dígitos.\n\nObrigatório caso campo \"formaIdentificacao\" seja 1.","example":61},"telefone":{"type":"integer","format":"int32","description":"Número do telefone do favorecido do crédito.Campo numérico contendo nove dígitos.\n\nObrigatório caso campo \"formaIdentificacao\" seja 1."},"email":{"type":"string","description":"Email do favorecido do crédito.\n\nObrigatório caso campo \"formaIdentificacao\" seja 2.","maxLength":99},"cpf":{"type":"integer","description":"Número do CPF do favorecido.\n\nOpcionalmente será validado caso campo \"formaIdentificacao\" seja 1 ou 2, e caso o campo \"cnpj\" não seja informado.\n\nObrigatório caso campo \"formaIdentificacao\" seja 3 ou 5, e caso o campo \"cnpj\" não seja informado.","format":"int64","x-oad-type":"integer"},"cnpj":{"type":"integer","description":"Número do CNPJ do favorecido.\n\nOpcionalmente será validado caso campo \"formaIdentificacao\" seja 1 ou 2, e caso o campo \"cpf\" não seja informado.\n\nObrigatório caso campo \"formaIdentificacao\" seja 3 ou 5, e caso o campo \"cpf\" não seja informado.","format":"int64","x-oad-type":"integer"},"identificacaoAleatoria":{"type":"string","description":"Código de identificação Aleatória do favorecido do crédito.\n\nObrigatório caso campo \"formaIdentificacao\" seja 4.","maxLength":99},"numeroCOMPE":{"type":"integer","description":"Número COMPE (Código do Sistema de Operações Monetárias e Compensações de Outros Papéis) da instituição detentora da conta do favorecido. Uma lista de códigos permitidos é obtida através do site do Banco Central (https://dadosabertos.bcb.gov.br/dataset/lista-de-participantes-do-str).Obrigatório caso o número ISPB não seja informado e a formaIdentificacao seja 5. Deve ser 1 caso a transferência seja para Banco do Brasil e a formaIdentificacao seja 5, não devendo ser informado o ISPB.","format":"int32","x-oad-type":"integer"},"numeroISPB":{"type":"integer","description":"Número ISPB (Identificador de Sistema de Pagamento Brasileiro) da instituição detentora da conta do favorecido. Uma lista de códigos permitidos é obtida através do site do Banco Central (https://dadosabertos.bcb.gov.br/dataset/lista-de-participantes-do-str).Se atentar para o código \"0\" que é existente na relação do Banco Central.Obrigatório caso o número COMPE não seja informado e a formaIdentificacao seja 5.","format":"int32","x-oad-type":"integer"},"tipoConta":{"description":"Codigo do tipo de conta de crédito do favorecido.\n\nDomínio:\n1 - Conta Corrente\n2 - Conta Pagamento\n3 - Conta Poupança\n\nObrigatório caso campo \"formaIdentificacao\" seja 5.","format":"int32","type":"integer"},"agencia":{"type":"integer","description":"Número da agência da conta de crédito do favorecido.\n\nObrigatório caso campo \"formaIdentificacao\" seja 5, e se campo \"contaPagamento\" não informado.","format":"int32","x-oad-type":"integer"},"conta":{"type":"integer","description":"Número da conta de crédito do favorecido.\n\nObrigatório caso campo \"formaIdentificacao\" seja 5, e se campo \"contaPagamento\" não informado.","format":"int64","x-oad-type":"integer"},"digitoVerificadorConta":{"type":"string","x-oad-type":"string","description":"Dígito verificador da agência da conta de crédito do favorecido.\n\nObrigatório caso campo \"formaIdentificacao\" seja 5, e se campo \"contaPagamento\" não informado.","maxLength":1},"contaPagamento":{"type":"string","description":"Número da conta pagamento do favorecido.\n\nObrigatório caso campo \"formaIdentificacao\" seja 5, e caso os campos \"agencia\", \"conta\" e \"digitoVerificadorConta\" não sejam informados.","x-oad-type":"string","maxLength":20}},"required":["data","valor","formaIdentificacao"]}}},"required":["numeroRequisicao","listaTransferencias"]}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/post_cancelar_pagamentos","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"data":{"type":"object","properties":{"agenciaDebito":{"type":"integer","description":"Número da agência da Conta Corrente onde deverá ser efetuado o débito do valor total de cada requisição.\nQuando utilizado Login Máquina Máquina: É informado pelo cliente.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.","format":"int64","x-oad-type":"integer"},"contaCorrenteDebito":{"type":"integer","description":"Número da Conta Corrente onde deverá ser efetuado o débito do valor total de cada requisição.\nQuando utilizado Login Máquina Máquina: É informado pelo cliente.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.","format":"int64","x-oad-type":"integer"},"digitoVerificadorContaCorrente":{"type":"string","description":"Digito verificador da Conta corrente onde deverá ser efetuado o débito do valor total de cada requisição.\nQuando utilizado Login Máquina Máquina: É informado pelo cliente.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.","x-oad-type":"string"},"listaPagamentos":{"type":"array","description":"Lista de pagamentos a serem cancelados em lote.","items":{"required":["codigoPagamento"],"type":"object","properties":{"codigoPagamento":{"type":"string","description":"Identificação do pagamento que será cancelado. Representa o número do protocolo por meio do qual o beneficiário pode verificar a situação do crédito, se necessário.\n","format":"int64","x-oad-type":"integer"}},"x-oad-type":"object"},"x-oad-type":"array"},"numeroContratoPagamento":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente.","format":"int64","x-oad-type":"integer"}},"description":"Objeto de Requisição ao CANCELAR Lotes de Pagamentos.","x-oad-type":"object"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_darf_preto_by_id","parameters":{"id":{"type":"string"},"agencia":{"type":"number","description":"Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token.\n"},"contaCorrente":{"type":"number","description":"Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"digitoVerificador":{"type":"string","description":"Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_darf_preto_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_guias_codigo_barras_by_id","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"agencia":{"type":"number","description":"Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"contaCorrente":{"type":"number","description":"Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"digitoVerificador":{"type":"string","description":"Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_guias_codigo_barras_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_lotes_guias_codigo_barras_by_id_solicitacao","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"agencia":{"type":"number","description":"Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"contaCorrente":{"type":"number","description":"Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"digitoVerificador":{"type":"string","description":"Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_lotes_guias_codigo_barras_by_id_solicitacao","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_gru_by_id","parameters":{"id":{"type":"string"},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"agencia":{"type":"number","description":"Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token.\n"},"digitoVerificador":{"type":"string","description":"Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"contaCorrente":{"type":"number","description":"Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_gru_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_gps_by_id","parameters":{"id":{"type":"string"},"agencia":{"type":"integer","description":"Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"contaCorrente":{"type":"integer","description":"Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"digitoVerificador":{"type":"string","description":"Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo.\n"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_gps_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/post_pagamentos_gru","parameters":{"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"data":{"required":["listaRequisicao","numeroRequisicao"],"type":"object","properties":{"numeroRequisicao":{"type":"integer","description":"Numero controlado pelo cliente para identificar cada acionamento da API e os lançamentos de cada chamada.\nNão precisa ser sequencial. \nDe uso único.","format":"int64","x-oad-type":"integer"},"codigoContrato":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente.","format":"int64","x-oad-type":"integer"},"agencia":{"type":"integer","description":"\"Número da agência da Conta Corrente onde deverá ser efetuado o débito do valor total de cada requisição.\nQuando utilizado Login Máquina Máquina: Informado pelo cliente. Pode ser qualquer uma das contas do pagador.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.\"","format":"int64","x-oad-type":"integer"},"conta":{"type":"integer","description":"\"Número da Conta Corrente onde deverá ser efetuado o débito do valor total de cada requisição.\nQuando utilizado Login Máquina Máquina: Informado pelo cliente. Pode ser qualquer uma das contas do pagador.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.\"","format":"int64","x-oad-type":"integer"},"digitoConta":{"type":"string","description":"\"Digito verificador da Conta corrente onde deverá ser efetuado o débito do valor total de cada requisição.\nQuando utilizado Login Máquina Máquina: Informado pelo cliente. Pode ser qualquer uma das contas do pagador.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.\"","x-oad-type":"string","maxLength":1},"listaRequisicao":{"type":"array","items":{"type":"object","properties":{"codigoBarras":{"type":"string","description":"Código de barras da Guia GRU a ser paga.","x-oad-type":"string","maxLength":44},"dataVencimento":{"type":"integer","description":"Data de vencimento do GRU.\n","format":"int64","x-oad-type":"integer"},"dataPagamento":{"type":"integer","description":"Data em que deverá ser efetivado o pagamento da Guia GRU\n","format":"int64","x-oad-type":"integer"},"valorPagamento":{"type":"number","description":"Valor do pagamento.\n","format":"double","x-oad-type":"number"},"numeroDocumentoDebito":{"type":"integer","description":"Uso opcional. \n\nQuando não informado ou informados números idênticos para todos os lançamentos de uma mesma requisição: o débito na conta do pagador será exibido em um único registro no valor total dos lançamentos validados. \n\nQuando informados números diversos para cada lançamento: os débitos serão exibidos de forma individualizada no extrato da conta debitada. \n\n O número de documento do débito é consolidado a partir do dia seguinte da efetivação destes lançamentos.","format":"int64","x-oad-type":"integer"},"textoPagamento":{"type":"string","description":"Campo de uso livre para inserção de informações de controle do pagador. Sem tratamento pelo Banco.\n","x-oad-type":"string","maxLength":40},"numeroReferencia":{"type":"string","description":"Numero de referencia do GRU.\n","x-oad-type":"string"},"mesAnoCompetencia":{"type":"integer","description":"Mês e ano de competência do GRU. Formato: MMAAAA\n","format":"int64","x-oad-type":"integer"},"idContribuinte":{"type":"integer","description":"Numero de identificaçao do contribuinte (CPF ou CNPJ).\n","format":"int64","x-oad-type":"integer"},"valorPrincipal":{"type":"number","description":"Valor do principal.\n","format":"double","x-oad-type":"number"},"valorDesconto":{"type":"number","description":"Valor do desconto ou abatimento.\n","format":"double","x-oad-type":"number"},"valorOutraDeducao":{"type":"number","description":"Valor de outras deduçoes.\n","format":"double","x-oad-type":"number"},"valorMulta":{"type":"number","description":"Valor da mora/multa.\n","format":"double","x-oad-type":"number"},"valorJuroEncargo":{"type":"number","description":"Valor de juros/encargos.\n","format":"double","x-oad-type":"number"},"valorOutroAcrescimo":{"type":"number","description":"Valor de outros acréscimos.\n","format":"double","x-oad-type":"number"}},"x-oad-type":"object"},"x-oad-type":"array"}},"description":"Objeto de Requisição ao Efetuar Lotes de Pagamentos de GRU.","x-oad-type":"object"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_pagamentos","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"agenciaDebito":{"type":"integer","description":"Número da agência da conta corrente de débito. Obrigatoriedade conforme fluxo OAuth: 1) Client Credentials: campo opcional; 2) Authorization Code: informação extraída do token."},"contaCorrenteDebito":{"type":"integer","description":"Número da conta corrente de débito. Obrigatoriedade conforme fluxo OAuth: 1) Client Credentials: campo opcional; 2) Authorization Code: informação extraída do token."},"digitoVerificadorContaCorrente":{"type":"string","description":"Dígito verificador da conta corrente de débito. Obrigatoriedade conforme fluxo OAuth: 1) Client Credentials: campo opcional; 2) Authorization Code: informação extraída do token."},"numeroContratoPagamento":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil. Obrigatoriedade conforme fluxo OAuth: 1) Client Credentials: campo opcional; 2) Authorization Code: informação extraída do token."},"dataInicio":{"type":"integer","description":"Data inicial de envio da requisição a ser pesquisada."},"dataFim":{"type":"integer","description":"Data final de envio da requisição a ser pesquisada. Não pode ser um intervalo maior que 30 dias."},"estadoPagamento":{"type":"string","description":"Estados dos pagamentos. Domínio: 1) Agendado: Pagamento aguardando a data para efetivação do crédito; 2) Cancelado: Pagamento cancelado pelo Cliente Conveniado antes da data do crédito; 3) Consistente: Dados recebidos pelo Banco sem ocorrências quanto ao formato. Aguardando validação dos dados para liberação/efetivação dos pagamentos; 4) Devolvido: Pagamento efetuado e posteriormente recusado pelo recebedor. O valor é devolvida para a Conta corrente onde ocorreu o débito da requisição; 5) Inconsistente: Dados recebidos pelo Banco com ocorrências quanto ao formato. A situação será alterada para rejeitado; 6) Pago: Pagamento efetuado; 7) Pendente: Falta autorização para o débito do pagamento na conta do cliente conveniado; 8) Rejeitado: Dados do pagamento não passaram na validações físicas e/ou lógicas. Ex: agência e conta não existem, conta não pertence ao CPF informado; 9) Vencido: Pagamento não efetuado na data indicada por falta de saldo ou falta de autorização para débito do pagamento na conta do cliente conveniado."},"indice":{"type":"integer","description":"Posição do índice na pesquisa, utilizado para fazer a paginação. A primeira consulta deve ter o valor zerado. Cada resposta tem um limite de 100 registros, e inicia-se a partir do valor do índice fornecido. Para consultar todos os registros, itere sobre este recurso usando o valor do campo \"indice\" que vem na da resposta."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_pagamentos","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_transferencias_by_id","parameters":{"id":{"type":"string"},"agencia":{"type":"integer","description":"Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"contaCorrente":{"type":"integer","description":"Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"digitoVerificador":{"type":"string","description":"Dígito do verificador da conta corrente para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_transferencias_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_by_id","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_by_id_solicitacao","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_by_id_solicitacao","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_lotes_gru_by_id_solicitacao","parameters":{"id":{"type":"string"},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer $"},"numeroAgenciaDebito":{"type":"integer","description":"Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é opcionalmente informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do Token.\n"},"numeroContaCorrenteDebito":{"type":"integer","description":"Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é opcionalmente informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do Token."},"digitoVerificadorContaCorrenteDebito":{"type":"string","description":"Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é opcionalmente informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do Token."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_lotes_gru_by_id_solicitacao","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_lotes_gps_by_id_solicitacao","parameters":{"id":{"type":"string"},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer $"},"numeroAgenciaDebito":{"type":"integer","description":"Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é opcionalmente informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do Token.\n"},"numeroContaCorrenteDebito":{"type":"integer","description":"Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é opcionalmente informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do Token."},"digitoVerificadorContaCorrenteDebito":{"type":"string","description":"Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é opcionalmente informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do Token."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_lotes_gps_by_id_solicitacao","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_lotes_darf_preto_normal_by_id_solicitacao","parameters":{"id":{"type":"string"},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer $"},"numeroAgenciaDebito":{"type":"integer","description":"Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é opcionalmente informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do Token.\n"},"numeroContaCorrenteDebito":{"type":"integer","description":"Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é opcionalmente informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do Token."},"digitoVerificadorContaCorrenteDebito":{"type":"string","description":"Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é opcionalmente informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do Token."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_lotes_darf_preto_normal_by_id_solicitacao","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/post_lotes_darf_normal_preto","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"data":{"required":["id","lancamentos"],"type":"object","properties":{"id":{"type":"integer","description":"Número identificador da requisição do pagamento. Número único controlado pelo cliente conveniado.","format":"int64","x-oad-type":"integer"},"codigoContrato":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente.","format":"int64","x-oad-type":"integer"},"numeroAgenciaDebito":{"type":"integer","description":"Número da agência da conta corrente onde deverá ser efetuado o débito do pagamento.","format":"int32","x-oad-type":"integer"},"numeroContaCorrenteDebito":{"type":"integer","description":"Número da conta corrente onde deverá ser efetuado o débito do pagamento.","format":"int64","x-oad-type":"integer"},"digitoVerificadorContaCorrenteDebito":{"type":"string","description":"Dígito verificador da conta corrente onde deverá ser efetuado o débito do pagamento.","x-oad-type":"string","maxLength":1},"lancamentos":{"type":"array","description":"Lista com até 100 guias a serem pagas.","items":{"required":["codigoIdentificadorTributo","codigoReceitaTributo","codigoSeuDocumento","codigoTipoContribuinte","dataApuracao","dataPagamento","dataVencimento","numeroIdentificacaoContribuinte","numeroReferencia","textoDescricaoPagamento","valorPagamento","valorPrincipal"],"type":"object","properties":{"dataPagamento":{"type":"integer","description":"Data do pagamento. Formato: \"ddmmaaaaa\".","format":"int32","x-oad-type":"integer"},"valorPagamento":{"type":"number","description":"Valor do pagamento. Moeda: \"BRL\".","format":"double","x-oad-type":"number"},"numeroDocumentoDebito":{"type":"integer","description":"Uso opcional. \n\nQuando não informado ou informados números idênticos para todos os lançamentos de uma mesma requisição: o débito na conta do pagador será exibido em um único registro no valor total dos lançamentos validados. \n\nQuando informados números diversos para cada lançamento: os débitos serão exibidos de forma individualizada no extrato da conta debitada. \n\n O número de documento do débito é consolidado a partir do dia seguinte da efetivação destes lançamentos.","format":"int64","x-oad-type":"integer"},"codigoSeuDocumento":{"type":"string","description":"Seu número na solicitação de pagamento. Não validado pelo Banco.","x-oad-type":"string","maxLength":20},"textoDescricaoPagamento":{"type":"string","description":"Campo de descrição do pagamento e de uso livre pelo cliente conveniado. Não há tratamento pelo Banco.","x-oad-type":"string","maxLength":40},"codigoReceitaTributo":{"type":"integer","description":"Código da receita do tributo na Receita Federal.","format":"int32","x-oad-type":"integer"},"codigoTipoContribuinte":{"type":"integer","description":"Código do tipo de contribuinte na Guia da Previdência Social.\n\nDOMÍNIO:\n1 - CNPJ;\n2 - CPF;\n3 - NIT/PIS/PASEP;\n4 - CEI;\n6 - NB;\n7 - N° Título;\n8 - DEBCAD;\n9- Referência.","format":"int32","x-oad-type":"integer"},"numeroIdentificacaoContribuinte":{"type":"integer","description":"Número de identificação do contribuinte.","format":"int64","x-oad-type":"integer"},"codigoIdentificadorTributo":{"type":"string","description":"Código de identificação do tributo.","x-oad-type":"string"},"dataApuracao":{"type":"integer","description":"Data do período de apuração.","format":"int32","x-oad-type":"integer"},"numeroReferencia":{"type":"integer","description":"Número de referência.","format":"int64","x-oad-type":"integer"},"valorPrincipal":{"type":"number","description":"Valor do principal.","format":"double","x-oad-type":"number"},"valorMulta":{"type":"number","description":"Valor da multa.","format":"double","x-oad-type":"number"},"valorJuroEncargo":{"type":"number","description":"Valor dos juros/encargos.","format":"double","x-oad-type":"number"},"dataVencimento":{"type":"integer","description":"Data de vencimento. Formato: \"ddmmaaaaa\".","format":"int32","x-oad-type":"integer"}},"x-oad-type":"object"},"x-oad-type":"array"}},"description":"Objeto de Requisição à Solicitação de Pagamentos em Lote de Darf Normal ou Darf Preto.","x-oad-type":"object"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_lotes_darf_normal_preto","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/post_lotes_gps","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"data":{"type":"object","description":"Objeto de Requisição à Solicitação de Pagamentos em Lote de Guia da Previdência Social - GPS.","x-oad-type":"object","properties":{"numeroRequisicao":{"type":"integer","description":"Número identificador da requisição do pagamento. Número único controlado pelo cliente conveniado.","format":"int64","x-oad-type":"integer"},"codigoContrato":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil.","format":"int64","x-oad-type":"integer"},"numeroAgenciaDebito":{"type":"integer","description":"Número da agência da conta corrente onde deverá ser efetuado o débito do pagamento. Quando fluxo Client Credentials for utilizado, este campo deve ser informado. Quando fluxo Authorization Code for utilizado, este campo será obtido do Token.","format":"int32","x-oad-type":"integer"},"numeroContaCorrenteDebito":{"type":"integer","description":"Número da conta corrente onde deverá ser efetuado o débito do pagamento. Quando fluxo Client Credentials for utilizado, este campo deve ser informado. Quando fluxo Authorization Code for utilizado, este campo será obtido do Token.","format":"int64","x-oad-type":"integer"},"digitoVerificadorContaCorrenteDebito":{"type":"string","description":"Dígito verificador da conta corrente onde deverá ser efetuado o débito do pagamento. Quando fluxo Client Credentials for utilizado, este campo deve ser informado. Quando fluxo Authorization Code for utilizado, este campo será obtido do Token.","x-oad-type":"string","maxLength":1},"lancamentos":{"type":"array","description":"Lista com até 100 guias a serem pagas.","x-oad-type":"array","items":{"type":"object","x-oad-type":"object","properties":{"dataPagamento":{"type":"integer","description":"Data do pagamento. Formato: \"ddmmaaaaa\".","format":"int32","x-oad-type":"integer"},"valorPagamento":{"type":"number","description":"Valor do pagamento. Moeda: \"BRL\".","format":"double","x-oad-type":"number"},"numeroDocumentoDebito":{"type":"integer","description":"Uso opcional. \n\nQuando não informado ou informados números idênticos para todos os lançamentos de uma mesma requisição: o débito na conta do pagador será exibido em um único registro no valor total dos lançamentos validados. \n\nQuando informados números diversos para cada lançamento: os débitos serão exibidos de forma individualizada no extrato da conta debitada. \n\n O número de documento do débito é consolidado a partir do dia seguinte da efetivação destes lançamentos.","format":"int64","x-oad-type":"integer"},"codigoSeuDocumento":{"type":"string","description":"Seu número na solicitação de pagamento. Não validado pelo Banco.","x-oad-type":"string","maxLength":20},"textoDescricaoPagamento":{"type":"string","description":"Campo de descrição do pagamento e de uso livre pelo cliente conveniado. Não há tratamento pelo Banco.","x-oad-type":"string","maxLength":40},"codigoReceitaTributoGuiaPrevidenciaSocial":{"type":"integer","description":"Código da Receita do Tributo Guia Da Previdencia Social - GPS.","format":"int32","x-oad-type":"integer"},"codigoTipoContribuinteGuiaPrevidenciaSocial":{"type":"integer","description":"Código do tipo de contribuinte na Guia da Previdência Social.\n\nDOMÍNIO:\n1 - CNPJ;\n2 - CPF;\n3 - NIT/PIS/PASEP;\n4 - CEI;\n6 - NB;\n7 - N° Título;\n8 - DEBCAD;\n9- Referência.","format":"int32","x-oad-type":"integer"},"numeroIdentificacaoContribuinteGuiaPrevidenciaSocial":{"type":"integer","description":"Número de identificação do contribuinte.","format":"int64","x-oad-type":"integer"},"codigoIdentificadorTributoGuiaPrevidenciaSocial":{"type":"string","description":"Número de identificação na Previdência (limitado a 2 caracteres).","x-oad-type":"string"},"mesAnoCompetenciaGuiaPrevidenciaSocial":{"type":"integer","description":"Mês e ano de competência. Formato: \"mmaaaa\".","format":"int32","x-oad-type":"integer"},"valorPrevistoInstNacSeguridadeSocialGuiaPrevidenciaSocial":{"type":"number","description":"Valor devido ao INSS pelo contribuinte.","format":"double","x-oad-type":"number"},"valorOutroEntradaGuiaPrevidenciaSocial":{"type":"number","description":"Valor outras entradas.","format":"double","x-oad-type":"number"},"valorAtualizacaoMonetarioGuiaPrevidenciaSocial":{"type":"number","description":"Valor da atualização monetária.","format":"double","x-oad-type":"number"}},"required":["dataPagamento","valorPagamento","codigoSeuDocumento","textoDescricaoPagamento","codigoReceitaTributoGuiaPrevidenciaSocial","codigoTipoContribuinteGuiaPrevidenciaSocial","numeroIdentificacaoContribuinteGuiaPrevidenciaSocial","codigoIdentificadorTributoGuiaPrevidenciaSocial","mesAnoCompetenciaGuiaPrevidenciaSocial","valorPrevistoInstNacSeguridadeSocialGuiaPrevidenciaSocial","valorOutroEntradaGuiaPrevidenciaSocial","valorAtualizacaoMonetarioGuiaPrevidenciaSocial"]}}},"required":["numeroRequisicao","codigoContrato"]}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_pagamentos_codigo_barras_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_pagamentos_codigo_barras_by_id","parameters":{"id":{"type":"string"},"agenciaDebito":{"type":"integer","description":"Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth."},"contaCorrenteDebito":{"type":"integer","description":"Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth."},"digitoVerificadorContaCorrente":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_beneficiarios_by_id_transferencias","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_beneficiarios_by_id_transferencias","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"agenciaDebito":{"type":"integer","description":"Número da agência da Conta Corrente onde foi efetuado o débito para efetivação do pagamento consultado."},"contaCorrenteDebito":{"type":"integer","description":"Número da Conta Corrente onde foi efetuado o débito para efetivação do pagamento consultado."},"digitoVerificadorContaCorrente":{"type":"string","description":"Digito verificador da Conta corrente onde foi efetuado o débito para efetivação do pagamento consultado."},"tipoPagamento":{"type":"integer","description":"Modalidade que representa o tipo de pagamento, sendo: 126 pagamento de fornecedores; 127 pagamento de salário e 128 pagamentos diversos"},"numeroCOMPE":{"type":"integer","description":"Número COMPE (Código do Sistema de Operações Monetárias e Compensações de Outros Papéis) da instituição detentora da conta do favorecido. Uma lista de códigos permitidos é obtida através do site do Banco Central (https://dadosabertos.bcb.gov.br/dataset/lista-de-participantes-do-str)."},"numeroISPB":{"type":"integer","description":"Número ISPB (Identificador de Sistema de Pagamento Brasileiro) da instituição detentora da conta do favorecido. Uma lista de códigos permitidos é obtida através do site do Banco Central (https://dadosabertos.bcb.gov.br/dataset/lista-de-participantes-do-str).Se atentar para o código \"0\" que é existente na relação do Banco Central."},"agenciaCredito":{"type":"integer","description":"Número da agência da Conta Corrente onde foi efetuado o crédito do pagamento consultado. Quando informado, o campo contaPagamentoCredito, este deve ser branco."},"contaCorrenteCredito":{"type":"integer","description":"Número da Conta Corrente onde foi efetuado o crédito do pagamento consultado. Quando informado, o campo contaPagamentoCredito, este deve ser branco."},"digitoVerificadorContaCorrenteCredito":{"type":"string","description":"Digito verificador da Conta corrente onde foi efetuado o crédito do pagamento consultado. Quando informado, o campo contaPagamentoCredito, este deve ser branco."},"contaPagamentoCredito":{"type":"string","description":"Número da Conta Pagamento dos pagamentos a serem pesquisados.\nQuando informado, os campos agenciaCredito, contaCorrenteCredito e digitoVerificadorContaCorrenteCredito, este campo não deve ser informado.\n"},"dataInicio":{"type":"integer","description":"Data inicial de envio da requisição a ser pesquisada (formato: ddmmaaaa). "},"dataFim":{"type":"integer","description":"Data final de envio da requisição a ser pesquisada (formato: ddmmaaaa). "},"indice":{"type":"integer","description":"Posição do índice de paginação. Indica a posição a partir da qual a pesquisa tratá os registros (ex: valor 0, indica que está trazendo a partir do registro 1, valor 300 indica que está trazendo a partir do 301). Cada resposta tem um limite de 300 ocorrências na lista paymentList, iniciada a partir do valor do índice fornecido. Para todas as ocorrências, itere sobre esse recurso usando o valor do campo indice da resposta. "},"tipoBeneficiario":{"type":"integer","description":"Tipo do número de inscrição da pessoa favorecida do crédito. Quando 1 é uma Pessoa Física (CPF) e 2 é Pessoa Jurídica (CNPJ).\n1 - CPF\n2 - CNPJ"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_boletos_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_boletos_by_id","parameters":{"id":{"type":"string"},"agencia":{"type":"number","description":"Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token.\n"},"contaCorrente":{"type":"number","description":"Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"digitoVerificador":{"type":"string","description":"Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_lotes_boletos","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/post_lotes_boletos","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"data":{"type":"object","description":"Objeto de Requisição à Solicitação de Pagamentos em Lote de Boletos.","x-oad-type":"object","properties":{"numeroRequisicao":{"type":"integer","description":"Número único de contrato para cada cliente conveniado.\nQuando utilizado Login Máquina Máquina: É opcional.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.IDENTIFICADOR DO CONTRATO DENTRO DO PGT - número único de contrato para cada cliente conveniado.\nQuando utilizado Login Máquina Máquina: É opcional.\nQuando utilizado Login Explícito: É obrigatório. É extraído do token.","format":"int64","x-oad-type":"integer"},"codigoContrato":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil.","format":"int64","x-oad-type":"integer"},"numeroAgenciaDebito":{"type":"integer","description":"Número da agência da conta corrente onde deverá ser efetuado o débito do pagamento. Quando fluxo Client Credentials for utilizado, este campo deve ser informado. Quando fluxo Authorization Code for utilizado, este campo será obtido do Token.","format":"int32","x-oad-type":"integer"},"numeroContaCorrenteDebito":{"type":"integer","description":"Número da conta corrente onde deverá ser efetuado o débito do pagamento. Quando fluxo Client Credentials for utilizado, este campo deve ser informado. Quando fluxo Authorization Code for utilizado, este campo será obtido do Token.","format":"int64","x-oad-type":"integer"},"digitoVerificadorContaCorrenteDebito":{"type":"string","description":"Dígito verificador da conta corrente onde deverá ser efetuado o débito do pagamento. Quando fluxo Client Credentials for utilizado, este campo deve ser informado. Quando fluxo Authorization Code for utilizado, este campo será obtido do Token.","x-oad-type":"string","maxLength":1},"lancamentos":{"type":"array","description":"Lista com até 100 guias a serem pagas.","x-oad-type":"array","items":{"type":"object","x-oad-type":"object","properties":{"numeroDocumentoDebito":{"type":"integer","description":"Uso opcional. \n\nQuando não informado ou informados números idênticos para todos os lançamentos de uma mesma requisição: o débito na conta do pagador será exibido em um único registro no valor total dos lançamentos validados. \n\nQuando informados números diversos para cada lançamento: os débitos serão exibidos de forma individualizada no extrato da conta debitada. \n\n O número de documento do débito é consolidado a partir do dia seguinte da efetivação destes lançamentos.","format":"int64","x-oad-type":"integer"},"numeroCodigoBarras":{"type":"string","description":"Código de barras do boleto a ser pago. Não é aceito o número da linha digitável.","maxLength":44},"dataPagamento":{"type":"integer","description":"Data em que deverá ser efetivado o pagamento do boleto.","format":"int32","x-oad-type":"integer"},"valorPagamento":{"type":"number","description":"Valor do pagamento do boleto","format":"double","x-oad-type":"number"},"descricaoPagamento":{"type":"string","description":"Campo de descrição do pagamento e de uso livre pelo cliente conveniado. Não há tratamento pelo Banco.","x-oad-type":"string","maxLength":40},"codigoSeuDocumento":{"type":"string","description":"Seu número na solicitação de pagamento. Não validado pelo Banco.","x-oad-type":"string","maxLength":20},"codigoNossoDocumento":{"type":"string","description":"Nº indicado no Boleto no campo Nosso Número.","x-oad-type":"string","maxLength":20},"valorNominal":{"type":"number","description":"Valor do boleto registrado pelo Beneficiário do Boleto.","format":"double"},"valorDesconto":{"type":"number","description":"Valor do desconto ou do abatimento registrados pelo Beneficiário do Boleto.","format":"double"},"valorMoraMulta":{"type":"number","description":"Valor da mora ou multa registrados pelo Beneficiário do Boleto.","format":"double"},"codigoTipoPagador":{"type":"integer","description":"Determina que será enviado um Nº CPF ou um Nº de CNPJ no campo Número Inscrição Pagador","format":"int32"},"documentoPagador":{"type":"integer","description":"Nº CPF ou um Nº de CNPJ no campo Número Inscrição Beneficiario.\nDeve ser igual ao nº registrado no boleto pelo Beneficiário. Informação diferente do registrado no boleto impede o pagamento do boleto.","format":"int64"},"codigoTipoBeneficiario":{"type":"integer","description":"Determina que será enviado um Nº CPF ou um Nº de CNPJ no campo Número Inscrição Beneficiario.","format":"int32"},"documentoBeneficiario":{"type":"integer","description":"Nº CPF ou um Nº de CNPJ no campo Número Inscrição Beneficiario.\nDeve ser igual ao nº registrado no boleto pelo Beneficiário. Informação diferente do registrado no boleto impede o pagamento do boleto.","format":"int64"},"codigoTipoAvalista":{"type":"integer","description":"Determina que será enviado um Nº CPF ou um Nº de CNPJ no campo Número Inscrição Avalista.","format":"int32"},"documentoAvalista":{"type":"integer","description":"Nº CPF ou um Nº de CNPJ no campo Número Inscrição Avalista.\nDeve ser igual ao nº registrado no boleto pelo Beneficiário.","format":"int64"}},"required":["numeroCodigoBarras","dataPagamento","valorPagamento","descricaoPagamento","valorNominal","codigoTipoBeneficiario","documentoBeneficiario"]}}},"required":["numeroRequisicao","codigoContrato"]}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/post_lotes_guias_codigo_barras","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."},"data":{"title":"RequisicaoPOSTLotePagamentoGuiasCodigoBarras","type":"object","description":"Objeto de requisição do recurso de pagamento em lote de Guias com Código de Barras.","properties":{"numeroRequisicao":{"type":"integer","description":"Identificação da solicitação de pagamento. É um número único, não sequencial, controlado pelo cliente, cujo valor vai de 1 a 999999.","format":"int32","x-oad-type":"integer"},"codigoContrato":{"type":"integer","description":"Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente.","format":"int32","x-oad-type":"integer"},"numeroAgenciaDebito":{"type":"integer","description":"Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.","format":"int32","x-oad-type":"integer"},"numeroContaCorrenteDebito":{"type":"integer","description":"Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.","format":"int32","x-oad-type":"integer"},"digitoVerificadorContaCorrenteDebito":{"type":"string","description":"Dígito do verificador da conta corrente para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.","x-oad-type":"string","maxLength":1},"lancamentos":{"type":"array","description":"Lista de Guias de Pagamento detalhadas","x-oad-type":"array","items":{"type":"object","description":"Lista de Guias de Pagamento detalhadas","x-oad-type":"object","properties":{"codigoBarras":{"type":"string","description":"Define o código de barras numérico da Guia de Recolhimento.","x-oad-type":"string","maxLength":44},"dataPagamento":{"type":"integer","description":"Data em que deverá ser efetivado o pagamento (formato: ddmmaaaa). Os pagamentos poderão ser agendados para até 180 dias. Campo Obrigatório.","format":"int32","x-oad-type":"integer"},"valorPagamento":{"type":"number","description":"Valor total das Guias de Recolhimento (formato 0.00). Campo Obrigatório.","format":"float","x-oad-type":"number"},"numeroDocumentoDebito":{"type":"integer","description":"Uso opcional. \n\nQuando não informado ou informados números idênticos para todos os lançamentos de uma mesma requisição: o débito na conta do pagador será exibido em um único registro no valor total dos lançamentos validados. \n\nQuando informados números diversos para cada lançamento: os débitos serão exibidos de forma individualizada no extrato da conta debitada. \n\n O número de documento do débito é consolidado a partir do dia seguinte da efetivação destes lançamentos.","format":"int64","x-oad-type":"integer"},"codigoSeuDocumento":{"type":"string","description":"Nº de uso livre pelo cliente conveniado. Equivalente ao Seu Número (Limitado a 20 caracteres).","x-oad-type":"string","maxLength":20},"descricaoPagamento":{"type":"string","description":"Descrição do pagamento. Pode ser preenchido livremente pelo cliente como forma de identificação para o pagamento.","x-oad-type":"string","maxLength":40}},"required":["codigoBarras","dataPagamento","valorPagamento"]}}},"required":["numeroRequisicao","lancamentos"]}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_lotes_transferencias_pix_by_id_solicitacao","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_lotes_transferencias_pix_by_id_solicitacao","parameters":{"id":{"type":"string"},"agencia":{"type":"integer","description":"Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"contaCorrente":{"type":"integer","description":"Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"digitoVerificador":{"type":"string","description":"Dígito do verificador da conta corrente para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_pix_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_pix_by_id","parameters":{"id":{"type":"string"},"agencia":{"type":"integer","description":"Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"contaCorrente":{"type":"integer","description":"Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"digitoVerificador":{"type":"string","description":"Dígito do verificador da conta corrente para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_lotes_boletos_by_id_solicitacao","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_lotes_boletos_by_id_solicitacao","parameters":{"id":{"type":"string"},"agencia":{"type":"integer","description":"Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"contaCorrente":{"type":"integer","description":"Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"digitoVerificador":{"type":"string","description":"Dígito do verificador da conta corrente para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.\n"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.\nExemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. \nEssa chave será usada para identificação do aplicativo."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/get_lancamentos_periodo","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.Exemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"codigoClienteConveniado":{"type":"integer","description":"Campo preenchido pela API. Identificação do cliente conveniado."},"numeroAgenciaDebito":{"type":"integer","description":"Número da agência da conta corrente onde deverá ser efetuado o débito do pagamento. Quando utilizado Login M2M: não é iformado. Quanto utilizado login explícito: é informado, sendo extraído do "},"numeroContaCorrenteDebito":{"type":"integer","description":"Número da conta corrente onde deverá ser efetuado o débito do pagamento. Quando utilizado login M2M: não é informado. Quando utilizado login explícito: é informado, sendo extraído "},"digitoVerificadorContaCorrenteDebito":{"type":"string","description":"Digito verificador da conta corrente onde deverá ser efetuado o débito do pagamento."},"dataInicialdeEnviodaRequisicao":{"type":"integer","description":"Data inicial de envio da requisição (formato \"ddmmaaaaa\")."},"dataFinaldeEnviodaRequisicao":{"type":"integer","description":"Data final de envio da requisição (formato \"ddmmaaaaa\"). Quando não informado sistema assume Data Final igual a Data Inicial."},"codigodoEstadodoPagamento":{"type":"integer","description":"Codigo do estado do pagamento."},"codigoProduto":{"type":"integer","description":"Código atribuído pelo sistema PRD ao produto a ser comercializado pelo BB (ativo/passivo/prestação de serviços) EX.: 0=Todos os tipos de produto; 126=Pagamento a Fornecedores; 127=Pagamento de Salários; 128=Pagamentos Diversos."},"numeroDaPosicaoDePesquisa":{"type":"integer","description":"Numero da posição, do registro, de continuidade da pesquisa (Valor zerado indica uma pesquisa inicial)."}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/put_by_id_data_pagamentos","parameters":{"id":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth.Exemplo: Bearer "},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"data":{"type":"object","x-examples":{"example-1":{"numeroAgenciaDebito":3477,"numeroContaCorrenteDebito":123456,"digitoVerificadorContaCorrenteDebito":"X","codigoProduto":123456,"dataOriginalPagamento":15012020,"dataNovoPagamento":15032020}},"properties":{"numeroAgenciaDebito":{"type":"integer","description":"Número da agência da conta corrente onde deverá ser efetuado o débito do pagamento.","example":3477},"numeroContaCorrenteDebito":{"type":"integer","description":"Número da conta corrente onde deverá ser efetuado o débito do pagamento.","example":123456789},"digitoVerificadorContaCorrenteDebito":{"type":"string","description":"Digito verificador da conta corrente onde deverá ser efetuado o débito do pagamento.","example":"X","maxLength":1},"codigoProduto":{"type":"integer","description":"Código atribuído pelo sistema PRD ao produto a ser comercializado pelo BB (ativo/passivo/prestação de serviços) EX.: 0=Todos os tipos de produto; 126=Pagamento a Fornecedores; 127=Pagamento de Salários; 128=Pagamentos Diversos.","example":126},"dataOriginalPagamento":{"type":"integer","description":"Data original do pagamento (formato \"ddmmaaaaa\").","example":15012020},"dataNovoPagamento":{"type":"integer","description":"Data do novo pagamento (formato \"ddmmaaaaa\").","example":15012021}},"required":{"0":"numeroAgenciaDebito","1":"numeroContaCorrenteDebito","2":"digitoVerificadorContaCorrenteDebito","3":"dataOriginalPagamento","4":"dataNovoPagamento"}}}},{"connectionName":"banco-do-brasil","actionName":"pagamentos_em_lote/parameters_by_id_data_pagamentos","parameters":{"id":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_webhookcobr","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"pix/delete_webhookcobr","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"pix/put_webhookcobr","parameters":{"data":{"type":"object","properties":{"webhookUrl":{"type":"string","description":"URL Webhook","maxLength":140,"examples":{"0":"https://usuario.recebedor.com/api/webhookcobr/"}}},"required":{"0":"webhookUrl"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_pix","parameters":{"inicio":{"type":"string","description":"Data inicial da pesquisa. Intervalo máximo: 5 dias."},"fim":{"type":"string","description":"Data final da pesquisa. Intervalo máximo: 5 dias."},"txid":{"type":"string","description":"txid"},"txIdPresente":{"type":"boolean","description":"txIdPresente"},"devolucaoPresente":{"type":"boolean","description":"devolucaoPresente"},"cpf":{"type":"string","description":"cpf"},"cnpj":{"type":"string","description":"cnpj"},"paginacao.paginaAtual":{"type":"integer","description":"paginacao.paginaAtual"},"paginacao.itensPorPagina":{"type":"integer","description":"paginacao.itensPorPagina"}}},{"connectionName":"banco-do-brasil","actionName":"pix/delete_locrec_by_id_id_rec","parameters":{"id":{"type":"string","description":"Id da location cadastrada para servir um payload"}}},{"connectionName":"banco-do-brasil","actionName":"pix/patch_cob_by_txid","parameters":{"txid":{"type":"string","description":"txid"},"data":{"type":"object","properties":{"calendario":{"type":"object","description":"Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.","properties":{"expiracao":{"type":"integer","format":"int32","description":"Tempo de vida da cobrança, especificado em segundos a partir da data de criação (Calendario.criacao)","examples":{"0":"3600"}}}},"devedor":{"type":"object","description":"Os campos aninhados sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento. Não é permitido que o campo devedor.cpf e campo devedor.cnpj estejam preenchidos ao mesmo tempo. Se o campo devedor.cnpj está preenchido, então o ca","properties":{"cpf":{"type":"string","description":"CPF do usuário.","pattern":"[0-9]{11}","maxLength":11},"cnpj":{"type":"string","description":"CNPJ do usuário.","pattern":"[0-9]{14}","maxLength":14},"nome":{"type":"string","description":"Nome do usuário.","maxLength":200}},"required":{"0":"nome"}},"loc":{"type":"object","description":"Identificador da localização do payload.","properties":{"id":{"type":"integer","description":"id"}}},"status":{"type":"string","description":"Status da Cobrança","maxLength":31},"valor":{"type":"object","description":"Valores monetários referentes à cobrança.","properties":{"original":{"type":"string","description":"Valor original da cobrança.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}}},"chave":{"type":"string","description":"**Formato do campo chave**\n- O campo chave, obrigatório, determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.\n- Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.\n- O formato das chaves pode ser encontrado na seção \"Formatação das chaves do DICT no BR Code\" do Manual de Padrões para iniciação do Pix.","maxLength":77},"solicitacaoPagador":{"type":"string","description":"O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.","maxLength":140},"infoAdicionais":{"type":"array","description":"Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.","maxItems":50,"items":{"type":"object","properties":{"nome":{"type":"string","description":"Nome do campo.","maxLength":50},"valor":{"type":"string","description":"Dados do campo","maxLength":200}},"required":{"0":"nome","1":"valor"}}}}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_cob_by_txid","parameters":{"txid":{"type":"string","description":"txid"}}},{"connectionName":"banco-do-brasil","actionName":"pix/put_cob_by_txid","parameters":{"txid":{"type":"string","description":"txid"},"data":{"type":"object","properties":{"calendario":{"type":"object","description":"Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.","properties":{"expiracao":{"type":"integer","format":"int32","description":"Tempo de vida da cobrança, especificado em segundos a partir da data de criação (Calendario.criacao)","pattern":"default: 86400","examples":{"0":"3600"}}}},"devedor":{"type":"object","description":"Os campos aninhados sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento.","properties":{"cpf":{"type":"string","description":"CPF do usuário.","pattern":"[0-9]{11}","maxLength":11},"cnpj":{"type":"string","description":"CNPJ do usuário.","pattern":"[0-9]{14}","maxLength":14},"nome":{"type":"string","description":"Nome do usuário.","maxLength":200}},"required":{"0":"nome"}},"loc":{"type":"object","description":"Identificador da localização do payload.","properties":{"id":{"type":"integer","description":"Identificador da localização do payload."}}},"valor":{"type":"object","description":"Valores monetários referentes à cobrança.","properties":{"original":{"type":"string","description":"Valor original da cobrança.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"original"}},"chave":{"type":"string","description":"**Formato do campo chave**\n- O campo chave, obrigatório, determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.\n- Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.\n- O formato das chaves pode ser encontrado na seção \"Formatação das chaves do DICT no BR Code\" do Manual de Padrões para iniciação do Pix.","maxLength":77},"solicitacaoPagador":{"type":"string","description":"O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.","maxLength":140},"infoAdicionais":{"type":"array","description":"Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.","maxItems":50,"items":{"type":"object","properties":{"nome":{"type":"string","description":"Nome do campo.","maxLength":50},"valor":{"type":"string","description":"Dados do campo.","maxLength":200}},"required":{"0":"nome","1":"valor"}}}},"required":{"0":"calendario","1":"valor","2":"chave"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/delete_loc_by_id_txid","parameters":{"id":{"type":"string","description":"Id da location cadastrada para servir um payload"}}},{"connectionName":"banco-do-brasil","actionName":"pix/patch_lotecobv_by_id","parameters":{"id":{"type":"string","description":"Identificador do lote de cobranças com vencimento, em formato de texto."},"data":{"type":"object","properties":{"descricao":{"type":"string","description":"Descrição do lote","maxLength":140,"examples":{"0":"TesteLoteCobv1Descricao"}},"cobsv":{"type":"array","description":"Array of objects","maxItems":500,"items":{"type":"object","properties":{"txid":{"type":"string","description":"Id da Transação","pattern":"[a-zA-Z0-9]{26,35}","maxLength":35,"examples":{"0":"TesteLoteCobv1Txid"}},"calendario":{"type":"object","description":"object (Calendário) - Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.","properties":{"dataDeVencimento":{"type":"string","description":"Data de vencimento da cobrança","maxLength":10,"examples":{"0":"2024-12-26"}},"validadeAposVencimento":{"type":"integer","format":"int32","description":"Validade após vencimento - Trata-se da quantidade de dias corridos após calendario.dataDeVencimento, em que a cobrança poderá ser paga.\nDefault: 30","examples":{"0":"30"}}},"required":{"0":"dataDeVencimento"}},"devedor":{"type":"object","description":"Pessoa Física (object) or Pessoa Jurídica (object)\nO objeto devedor organiza as informações sobre o devedor da cobrança.","properties":{"cpf":{"type":"string","description":"CPF do usuário.","pattern":" /^\\d{11}$/","maxLength":11,"examples":{"0":"12345678900"}},"cnpj":{"type":"string","description":"CNPJ do usuário.","pattern":" /^\\d{14}$/","maxLength":14,"examples":{"0":"12345678000190"}},"nome":{"type":"string","description":"Nome do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"NOMETESTE DA SILVA"}},"email":{"type":"string","description":"Email do usuário.","maxLength":256,"examples":{"0":"hmtestes2@bb.com.br"}},"logradouro":{"type":"string","description":"Logradouro do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"Rua A, 123"}},"cidade":{"type":"string","description":"Cidade do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"São Paulo"}},"uf":{"type":"string","description":"UF do usuário.","pattern":"<= 2 characters","maxLength":2,"examples":{"0":"SP"}},"cep":{"type":"string","description":"CEP do usuário.","pattern":"<= 8 characters","maxLength":8,"examples":{"0":"12345678"}}},"required":{"0":"cpf","1":"cnpj","2":"nome"}},"loc":{"type":"object","description":"object - Identificador da localização do payload.","properties":{"id":{"type":"integer","description":"Id da loc","examples":{"0":"1234"}}}},"status":{"type":"string","description":"Status do registro de cobrança","maxLength":50,"examples":{"0":"REMOVIDA_PELO_USUARIO_RECEBEDOR"}},"valor":{"type":"object","description":"object - Valores monetários.","properties":{"original":{"type":"string","description":"Valor original da cobrança.","pattern":" \\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"123.00"}},"multa":{"type":"object","description":"object - Multa aplicada à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade da multa, conforme tabela de domínios.\n1 - Valor Fixo\n2 - Percentual","pattern":"[ 1 .. 2 ]","examples":{"0":"1"}},"valorPerc":{"type":"string","description":"Valor percentual dos juros","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"modalidade","1":"valorPerc"}},"juros":{"type":"object","description":"object -Juro aplicado à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de juros, conforme tabela de domínios.\n1 - Valor (dias corridos)\n2 - Percentual ao dia (dias corridos)\n3 - Percentual ao mês (dias corridos)\n4 - Percentual ao ano (dias corridos)\n5 - Valor (dias úteis)\n6 - Percentual ao dia (dias úteis)\n7 - Percentual ao mês (dias úteis)\n8 - Percentual ao ano (dias úteis)","pattern":"[ 1 .. 8 ]","examples":{"0":"1"}},"valorPerc":{"type":"string","description":"Valor ou percentual dos juros","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"modalidade","1":"valorPerc"}},"abatimento":{"type":"object","description":"object - Abatimento aplicado à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de abatimentos, conforme tabela de domínios.\n1 - Valor Fixo\n2 - Percentual","pattern":"[ 1 .. 2 ]","examples":{"0":"1"}},"valorPerc":{"type":"string","description":"Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"modalidade","1":"valorPerc"}},"desconto":{"type":"object","description":"object - Descontos aplicados à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de desconto, conforme tabela de domínios.\n1 - Valor Fixo até a[s] data[s] informada[s]\t\n2 - Percentual até a data informada\t\n3 - Valor por antecipação dia corrido\t\n4 - Valor por antecipação dia útil\t\n5 - Percentual por antecipação dia corrido\t\n6 - Percentual por antecipação dia útil","pattern":"[ 1 .. 6 ]","examples":{"0":"1"}},"descontoDataFixa":{"type":"array","description":"Descontos absolutos aplicados à cobrança.\n[ 1 .. 3 ]","maxItems":3,"items":{"type":"object","properties":{"data":{"type":"string","description":"Data limite para o desconto absoluto da cobrança.","maxLength":10,"examples":{"0":"2024-12-26"}},"valorPerc":{"type":"string","description":"Valor do desconto absoluto - Desconto em valor absoluto ou percentual por dia, útil ou corrido, conforme valor.desconto.modalidade","pattern":" \\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"data","1":"valorPerc"}}},"valorPerc":{"type":"string","description":"Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"modalidade","1":"valorPerc"}}}},"chave":{"type":"string","description":"Chave DICT do recebedor","pattern":"<= 77 characters","maxLength":77,"examples":{"0":"+5511985732102\n\nhmtestes2@bb.com.br\n\n12345678900 \n00123456789\n\n12345678901234\n0012345678"}},"solicitacaoPagador":{"type":"string","description":"Solicitação ao pagador","pattern":"<= 140 characters","maxLength":140,"examples":{"0":"SolicitacaoPagadorqualquercoisaate140caracteres01"}},"infoAdicionais":{"type":"array","description":"Array of objects (Informações adicionais)","maxItems":50,"items":{"type":"object","properties":{"nome":{"type":"string","description":"Nome do campo (infoAdicionais)","pattern":"<= 50 characters","maxLength":50,"examples":{"0":"Nome do campo"}},"valor":{"type":"string","description":"Dados do campo.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"Dados do campo"}}},"required":{"0":"nome","1":"valor"}}}},"required":{"0":"txid"}}}}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_lotecobv_by_id","parameters":{"id":{"type":"string","description":"Identificador do lote de cobranças com vencimento"}}},{"connectionName":"banco-do-brasil","actionName":"pix/put_lotecobv_by_id","parameters":{"id":{"type":"string","description":"Identificador do lote de cobranças com vencimento, em formato de texto."},"data":{"type":"object","properties":{"descricao":{"type":"string","description":"Descrição do lote","maxLength":140,"examples":{"0":"TesteLoteCobv1Descricao"}},"cobsv":{"type":"array","description":"Array of objects","maxItems":500,"items":{"type":"object","properties":{"txid":{"type":"string","description":"Id da Transação","pattern":" [a-zA-Z0-9]{26,35}","maxLength":35,"examples":{"0":"TesteLoteCobv1Txid"}},"calendario":{"type":"object","description":"object (Calendário) - Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.","properties":{"dataDeVencimento":{"type":"string","description":"Data de vencimento da cobrança","maxLength":10,"examples":{"0":"2024-12-26"}},"validadeAposVencimento":{"type":"integer","format":"int32","description":"Validade após vencimento - Trata-se da quantidade de dias corridos após calendario.dataDeVencimento, em que a cobrança poderá ser paga.\nDefault: 30","examples":{"0":"30"}}},"required":{"0":"dataDeVencimento"}},"devedor":{"type":"object","description":"Pessoa Física (object) or Pessoa Jurídica (object)\nO objeto devedor organiza as informações sobre o devedor da cobrança.","properties":{"cpf":{"type":"string","description":"CPF do usuário.","pattern":" /^\\d{11}$/","maxLength":11,"examples":{"0":"12345678900"}},"cnpj":{"type":"string","description":"CNPJ do usuário.","pattern":" /^\\d{14}$/","maxLength":14,"examples":{"0":"12345678000190"}},"nome":{"type":"string","description":"Nome do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"NOMETESTE DA SILVA"}},"email":{"type":"string","description":"Email do usuário.","maxLength":256,"examples":{"0":"hmtestes2@bb.com.br"}},"logradouro":{"type":"string","description":"Logradouro do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"Rua A, 123"}},"cidade":{"type":"string","description":"Cidade do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"São Paulo"}},"uf":{"type":"string","description":"UF do usuário.","pattern":"<= 2 characters","maxLength":2,"examples":{"0":"SP"}},"cep":{"type":"string","description":"CEP do usuário.","pattern":"<= 8 characters","maxLength":8,"examples":{"0":"12345678"}}},"required":{"0":"cpf","1":"cnpj","2":"nome"}},"loc":{"type":"object","description":"object - Identificador da localização do payload.","properties":{"id":{"type":"integer","description":"Id da loc","examples":{"0":"1234"}}}},"valor":{"type":"object","description":"object - Valores monetários.","properties":{"original":{"type":"string","description":"Valor original da cobrança.","pattern":" \\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"123.00"}},"multa":{"type":"object","description":"object - Multa aplicada à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade da multa, conforme tabela de domínios.\n1 - Valor Fixo\n2 - Percentual","pattern":"[ 1 .. 2 ]","examples":{"0":"1"}},"valorPerc":{"type":"string","description":"Valor da multa absoluta - Multa do documento em valor absoluto ou percentual, conforme \"valor.multa.modalidade\".","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"modalidade","1":"valorPerc"}},"juros":{"type":"object","description":"object - Juro aplicado à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de juros, conforme tabela de domínios.\n1 - Valor (dias corridos)\n2 - Percentual ao dia (dias corridos)\n3 - Percentual ao mês (dias corridos)\n4 - Percentual ao ano (dias corridos)\n5 - Valor (dias úteis)\n6 - Percentual ao dia (dias úteis)\n7 - Percentual ao mês (dias úteis)\n8 - Percentual ao ano (dias úteis)","pattern":"[ 1 .. 8 ]","examples":{"0":"1"}},"valorPerc":{"type":"string","description":"Valor ou percentual dos juros","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"modalidade","1":"valorPerc"}},"abatimento":{"type":"object","description":"object - Abatimento aplicado à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de abatimentos, conforme tabela de domínios.\n1 - Valor Fixo\n2 - Percentual","pattern":"[ 1 .. 2 ]","examples":{"0":"1"}},"valorPerc":{"type":"string","description":"Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"modalidade","1":"valorPerc"}},"desconto":{"type":"object","description":"object - Descontos aplicados à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de desconto, conforme tabela de domínios.\n1 - Valor Fixo até a[s] data[s] informada[s]\t\n2 - Percentual até a data informada\t\n3 - Valor por antecipação dia corrido\t\n4 - Valor por antecipação dia útil\t\n5 - Percentual por antecipação dia corrido\t\n6 - Percentual por antecipação dia útil","pattern":"[ 1 .. 6 ]","examples":{"0":"1"}},"descontoDataFixa":{"type":"array","description":"Descontos absolutos aplicados à cobrança.\n[ 1 .. 3 ]","maxItems":3,"items":{"type":"object","properties":{"data":{"type":"string","description":"Data limite para o desconto absoluto da cobrança.","maxLength":10,"examples":{"0":"2024-12-26"}},"valorPerc":{"type":"string","description":"Valor do desconto absoluto - Desconto em valor absoluto ou percentual por dia, útil ou corrido, conforme valor.desconto.modalidade","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"data","1":"valorPerc"}}},"valorPerc":{"type":"string","description":"Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}},"required":{"0":"modalidade","1":"valorPerc"}}},"required":{"0":"original"}},"chave":{"type":"string","description":"Chave DICT do recebedor","pattern":"<= 77 characters","maxLength":77,"examples":{"0":"+5511985732102\n\nhmtestes2@bb.com.br\n\n12345678900 \n00123456789\n\n12345678901234\n0012345678"}},"solicitacaoPagador":{"type":"string","description":"Solicitação ao pagador","pattern":"<= 140 characters","maxLength":140,"examples":{"0":"SolicitacaoPagadorqualquercoisaate140caracteres01"}},"infoAdicionais":{"type":"array","description":"Array of objects (Informações adicionais)","maxItems":50,"items":{"type":"object","properties":{"nome":{"type":"string","description":"Nome do campo (infoAdicionais)","pattern":"<= 50 characters","maxLength":50,"examples":{"0":"Nome do campo"}},"valor":{"type":"string","description":"Dados do campo.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"Dados do campo"}}},"required":{"0":"nome","1":"valor"}}}},"required":{"0":"txid","1":"calendario","2":"devedor","3":"valor","4":"chave"}}}},"required":{"0":"descricao","1":"cobsv"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/post_rec","parameters":{"data":{"type":"object","properties":{"vinculo":{"type":"object","description":"object (Descrição do Objeto da Recorrência)","properties":{"objeto":{"type":"string","description":"Identificador do objeto de vínculo - Campo de texto livre para informações referentes ao contrato que permitam ao usuário pagador reconhecer o objeto dos pagamentos periódicos por meio do Pix Automático.","pattern":"<= 35 characters","maxLength":35,"examples":{"0":"Serviços de Gestão de Imóveis"}},"devedor":{"type":"object","description":"Pessoa Física (object) or Pessoa Jurídica (object)\nO objeto devedor organiza as informações sobre o devedor da recorrência.","properties":{"cpf":{"type":"string","description":"CPF do usuário.","pattern":"/^\\d{11}$/","maxLength":11,"examples":{"0":"12345678900"}},"cnpj":{"type":"string","description":"CNPJ do usuário.","pattern":"/^\\d{14}$/","maxLength":14,"examples":{"0":"12345678900"}},"nome":{"type":"string","description":"Nome do usuário.","pattern":"<= 140 characters","maxLength":140,"examples":{"0":"Imobiliária Bom Sucesso"}}},"required":{"0":"cpf","1":"cnpj","2":"nome"}},"contrato":{"type":"string","description":"Objeto da autorização - Número, identificador, ou código que representa o objeto da autorização (contrato, pedido etc.).","pattern":"<= 35 characters","maxLength":35,"examples":{"0":"63100862"}}},"required":{"0":"devedor","1":"contrato"}},"calendario":{"type":"object","description":"object (Informações sobre calendário da recorrência)","properties":{"dataInicial":{"type":"string","description":"Data estimada de primeiro pagamento - Trata-se de uma data, no formato YYYY-MM-DD, segundo ISO 8601. Data estimada de primeiro pagamento.","maxLength":10,"examples":{"0":"2024-12-26"}},"dataFinal":{"type":"string","description":"Data final da vigência - Campo opcional que deve ser preenchido para autorizações com vigência pré-definida, devendo ser compatível com os valores informados em tipoFrequencia e a dataInicialRecorrencia. Não deve ser preenchido para autorizações por tempo indeterminado. Trata-se de uma data, no formato YYYY-MM-DD, segundo ISO 8601.","maxLength":10,"examples":{"0":"2024-12-26"}},"periodicidade":{"type":"string","description":"Periodicidade das cobranças recorrentes \nEnum: \"SEMANAL\" \"MENSAL\" \"TRIMESTRAL\" \"SEMESTRAL\" \"ANUAL\"","maxLength":25,"examples":{"0":"SEMANAL"}}},"required":{"0":"dataInicial","1":"periodicidade"}},"valor":{"type":"object","description":"object (valor)","properties":{"valorRec":{"type":"string","description":"Valor da recorrência - Campo opcional, deve ser preenchido apenas quando o valor dos pagamentos for fixo ou não for sujeito a alteração durante a vigência da autorização.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"123.00"}},"valorMinimoRecebedor":{"type":"string","description":"Valor mínimo da recorrência - Campo opcional. Valor definido pelo usuário recebedor. Se o usuário pagador atribuir um valor máximo para os pagamentos daquela autorização, ele não poderá ser inferior ao piso definido pelo usuário recebedor. Não pode ser preenchido nas autorizações de valor fixo, ou seja, com campo valor preenchido.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"12.00"}}}},"politicaRetentativa":{"type":"string","description":"Política de retentativa pós vencimento da recorrência\nEnum: \"NAO_PERMITE\", \"PERMITE_3R_7D\"","maxLength":25,"examples":{"0":"PERMITE_3R_7D"}},"loc":{"type":"integer","format":"int32","description":"Identificador da location a ser informada na criação de uma recorrência.","examples":{"0":"5100"}},"ativacao":{"type":"object","description":"object (Dados relacionados à confirmação da ativação da recorrência.)","properties":{"dadosJornada":{"type":"object","description":"Cobrança imediata vinculada à Jornada 3 (object) (Dados de confirmação da jornada e início da recorrência)","properties":{"txid":{"type":"string","description":"Id da Transação - Identificador da transação","pattern":"[a-zA-Z0-9]{26,35}","maxLength":35,"examples":{"0":"33beb661beda44a8928fef47dbeb2dc5\n"}}},"required":{"0":"txid"}}}},"recebedor":{"type":"object","description":"recebedor","properties":{"convenio":{"type":"string","description":"Convênio entre usuário e participante recebedor.","pattern":"<= 60 characters","maxLength":60,"examples":{"0":"123456"}}}}},"required":{"0":"vinculo","1":"calendario","2":"politicaRetentativa"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_rec","parameters":{"inicio":{"type":"string","description":"Data de início - Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339."},"fim":{"type":"string","description":"Data de fim - Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339."},"cpf":{"type":"string","description":"CPF - Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ."},"cnpj":{"type":"string","description":"CNPJ - Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF."},"locationPresente":{"type":"boolean","description":"Filtro pela existência de location vinculada."},"status":{"type":"string","description":"Status do registro da recorrência - Filtro pelo status da recorrência."},"convenio":{"type":"string","description":"Convênio entre usuário e participante recebedor."},"paginacao.paginaAtual":{"type":"integer","description":"Página atual - Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.\nDefault: 0"},"paginacao.itensPorPagina":{"type":"integer","description":"Itens por Página - Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.\nDefault: 100"}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_pix_by_e2eid_devolucao_by_id","parameters":{"e2eid":{"type":"string","description":"e2eid"},"id":{"type":"string","description":"id"}}},{"connectionName":"banco-do-brasil","actionName":"pix/put_pix_by_e2eid_devolucao_by_id","parameters":{"e2eid":{"type":"string","description":"e2eid"},"id":{"type":"string","description":"id"},"data":{"type":"object","properties":{"valor":{"type":"string","description":"Valor solicitado para devolução. A soma dos valores de todas as devolucões não podem ultrapassar o valor total do Pix.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":10}},"required":{"0":"valor"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/post_solicrec","parameters":{"data":{"type":"object","properties":{"idRec":{"type":"string","description":"ID Recorrência\n\nRRxxxxxxxxyyyyMMddkkkkkkkkkkk: com retentativa\nRNxxxxxxxxyyyyMMddkkkkkkkkkkk: sem retentativa\nCRxxxxxxxxyyyyMMddkkkkkkkkkkk: Open finance com retent\nCNxxxxxxxxyyyyMMddkkkkkkkkkkk: Open finance sem retent","pattern":"[a-zA-Z0-9]{29}","maxLength":29,"examples":{"0":"SC876456782024021577825477312"}},"calendario":{"type":"object","description":"object (Informações de Calendário da Solicitação da Recorrência)","properties":{"dataExpiracaoSolicitacao":{"type":"string","description":"Data da expiração da solicitação enviada ao usuário pagador. Respeita RFC 3339.","maxLength":32,"examples":{"0":" 2023-04-22T20:15:30.358Z"}}},"required":{"0":"dataExpiracaoSolicitacao"}},"destinatario":{"type":"object","description":"Pessoa Física (object) or Pessoa Jurídica (object)","properties":{"cpf":{"type":"string","description":"CPF do usuário.","pattern":"/^\\d{11}$/","maxLength":11,"examples":{"0":"12345678900"}},"cnpj":{"type":"string","description":"CNPJ do usuário.","pattern":"/^\\d{14}$/","maxLength":14,"examples":{"0":"12345678900"}},"conta":{"type":"string","description":"Conta do Usuário Pagador - Número da conta do usuário pagador.","pattern":"<= 20 characters","maxLength":20,"examples":{"0":"550689"}},"ispbParticipante":{"type":"string","description":"ISPB do usuário pagador.","pattern":"\\d{8}","maxLength":8,"examples":{"0":"91193552"}},"agencia":{"type":"string","description":"Número da agência do usuário pagador.","pattern":"<= 4 characters","maxLength":4,"examples":{"0":"9708"}}},"required":{"0":"cpf","1":"cnpj","2":"conta","3":"ispbParticipante"}}},"required":{"0":"idRec","1":"calendario","2":"destinatario"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/patch_cobv_by_txid","parameters":{"txid":{"type":"string","description":"txid"},"data":{"type":"object","properties":{"calendario":{"type":"object","description":"Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.","properties":{"dataDeVencimento":{"type":"string","description":"Trata-se de uma data, no formato yyyy-mm-dd, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.","maxLength":29,"examples":{"0":"2020-04-01"}},"validadeAposVencimento":{"type":"integer","format":"int32","description":"Trata-se da quantidade de dias corridos após o vencimento em que a cobrança poderá ser paga. Caso vencido este período e a cobrança não tenha sido paga, esta continuará ATIVA.","pattern":"default: 30"}},"required":{"0":"dataDeVencimento","1":"validadeAposVencimento"}},"devedor":{"type":"object","description":"O objeto devedor organiza as informações sobre o devedor da cobrança.","properties":{"email":{"type":"string","description":"Email do usuário.","maxLength":256},"logradouro":{"type":"string","description":"Logradouro do usuário.","pattern":"maxLength: 200","maxLength":200},"cidade":{"type":"string","description":"Cidade do usuário.","pattern":"maxLength: 200","maxLength":200},"uf":{"type":"string","description":"UF do usuário.","pattern":"maxLength: 2","maxLength":2},"cep":{"type":"string","description":"CEP do usuário.","pattern":"maxLength: 8","maxLength":8},"cpf":{"type":"string","description":"CPF do usuário.","pattern":"[0-9]{11}","maxLength":11},"cnpj":{"type":"string","description":"CNPJ do usuário.","pattern":"[0-9]{14}","maxLength":14},"nome":{"type":"string","description":"Nome do usuário.","maxLength":200}},"required":{"0":"logradouro","1":"cidade","2":"uf","3":"cep"}},"loc":{"type":"object","description":"Identificador da localização do payload.","properties":{"id":{"type":"integer","description":"id"},"location":{"type":"string","description":"location","maxLength":77},"tipoCob":{"type":"string","description":"tipoCob","maxLength":4},"criacao":{"type":"string","description":"criacao","maxLength":29}}},"status":{"type":"string","description":"Status da Cobrança","pattern":"[ REMOVIDA_PELO_USUARIO_RECEBEDOR ]","maxLength":31},"valor":{"type":"object","description":"Valores monetários.","properties":{"original":{"type":"string","description":"Valor original da cobrança.","maxLength":13},"multa":{"type":"object","description":"Multa aplicada à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade da multa, conforme tabela de domínios.\nDescrição\tDomínio\nValor Fixo\t1\nPercentual\t2","pattern":"minimum: 1\nmaximum: 2"},"valorPerc":{"type":"string","description":"Multa do documento em valor absoluto ou percentual, conforme \"valor.multa.modalidade\".","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"modalidade","1":"valorPerc"}},"juros":{"type":"object","description":"Juro aplicado à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de juros, conforme tabela de domínios.\nDescrição\tDomínio\nValor (dias corridos)\t1\nPercentual ao dia (dias corridos)\t2\nPercentual ao mês (dias corridos)\t3\nPercentual ao ano (dias corridos)\t4\nValor (dias úteis)\t5\nPercentual ao dia (dias úteis)\t6\nPercentual ao mês (dias úteis)\t7\nPercentual ao ano (dias úteis)\t8","pattern":"minimum: 1\nmaximum: 8"},"valorPerc":{"type":"string","description":"Valor","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"modalidade","1":"valorPerc"}},"abatimento":{"type":"object","description":"Abatimento aplicado à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de abatimentos, conforme tabela de domínios.\nDescrição\tDomínio\nValor Fixo\t1\nPercentual\t2","pattern":"minimum: 1\nmaximum: 2"},"valorPerc":{"type":"string","description":"Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"modalidade","1":"valorPerc"}},"desconto":{"type":"object","description":"Abatimento aplicado à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de desconto, conforme tabela de domínios.\nDescrição\tDomínio\nValor Fixo até a[s] data[s] informada[s]\t1\nPercentual até a data informada\t2\nValor por antecipação dia corrido\t3\nValor por antecipação dia útil\t4\nPercentual por antecipação dia corrido\t5\nPercentual por antecipação dia útil\t6","pattern":"minimum: 1\nmaximum: 6"},"descontoDataFixa":{"type":"array","description":"Descontos absolutos aplicados à cobrança.","maxItems":3,"items":{"type":"object","properties":{"data":{"type":"string","description":"Descontos por pagamento antecipado, com data fixa. Matriz com até três elementos, sendo que cada elemento é composto por um par \"data e valorPerc\", para estabelecer descontos percentuais ou absolutos, até aquela data de pagamento. Trata-se de uma data, no formato yyyy-mm-dd, segundo ISO 8601. A data de desconto obrigatoriamente deverá ser menor que a data de vencimento da cobrança.","maxLength":10,"examples":{"0":"2020-04-01"}},"valorPerc":{"type":"string","description":"valorPerc","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"data","1":"valorPerc"}}},"valorPerc":{"type":"string","description":"Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"modalidade"}}}},"chave":{"type":"string","description":"**Formato do campo chave**\n- O campo chave, obrigatório, determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.\n- Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.\n- O formato das chaves pode ser encontrado na seção \"Formatação das chaves do DICT no BR Code\" do Manual de Padrões para iniciação do Pix.","pattern":"maxLength: 77","maxLength":77},"solicitacaoPagador":{"type":"string","description":"O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.","pattern":"140","maxLength":140},"infoAdicionais":{"type":"array","description":"Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.","maxItems":50,"items":{"type":"object","properties":{"nome":{"type":"string","description":"Nome do campo.","pattern":"maxLength: 50","maxLength":50},"valor":{"type":"string","description":"Dados do campo.","pattern":"maxLength: 200","maxLength":200}},"required":{"0":"nome","1":"valor"}}}}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_cobv_by_txid","parameters":{"txid":{"type":"string","description":"txid"},"revisao":{"type":"integer","description":"revisao"}}},{"connectionName":"banco-do-brasil","actionName":"pix/put_cobv_by_txid","parameters":{"txid":{"type":"string","description":"txid"},"data":{"type":"object","properties":{"calendario":{"type":"object","description":"Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.","properties":{"dataDeVencimento":{"type":"string","description":"Trata-se de uma data, no formato yyyy-mm-dd, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.","maxLength":10,"examples":{"0":"2020-04-01"}},"validadeAposVencimento":{"type":"integer","format":"int32","description":"Trata-se da quantidade de dias corridos após o vencimento em que a cobrança poderá ser paga. Caso vencido este período e a cobrança não tenha sido paga, esta continuará ATIVA."}},"required":{"0":"dataDeVencimento","1":"validadeAposVencimento"}},"devedor":{"type":"object","description":"O objeto devedor organiza as informações sobre o devedor da cobrança.","properties":{"email":{"type":"string","description":"Email do usuário.","maxLength":256},"logradouro":{"type":"string","description":"Logradouro do usuário.","maxLength":200},"cidade":{"type":"string","description":"Cidade do usuário.","maxLength":200},"uf":{"type":"string","description":"UF do usuário.","maxLength":2},"cep":{"type":"string","description":"CEP do usuário.","maxLength":8},"cpf":{"type":"string","description":"CPF do usuário.","pattern":"[0-9]{11}","maxLength":11},"cnpj":{"type":"string","description":"CNPJ do usuário.","pattern":"[0-9]{14}","maxLength":14},"nome":{"type":"string","description":"Nome do usuário.","maxLength":200}},"required":{"0":"logradouro","1":"cidade","2":"uf","3":"cep","4":"nome"}},"loc":{"type":"object","description":"Identificador da localização do payload.","properties":{"id":{"type":"integer","description":"Identificador da location a ser informada na criação da cobrança."},"location":{"type":"string","description":"location","maxLength":77},"tipoCob":{"type":"string","description":"tipoCob","maxLength":4},"criacao":{"type":"string","description":"criacao","maxLength":29}}},"valor":{"type":"object","description":"Valores monetários referentes à cobrança.","properties":{"original":{"type":"string","description":"Valor original da cobrança.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13},"multa":{"type":"object","description":"Multa aplicada à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade da multa, conforme tabela de domínios.\nDescrição\tDomínio\nValor Fixo\t1\nPercentual\t2","pattern":"minimum: 1\nmaximum: 2"},"valorPerc":{"type":"string","description":"Multa do documento em valor absoluto ou percentual, conforme \"valor.multa.modalidade\".","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"modalidade","1":"valorPerc"}},"juros":{"type":"object","description":"Juro aplicado à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de juros, conforme tabela de domínios.\nDescrição\tDomínio\nValor (dias corridos)\t1\nPercentual ao dia (dias corridos)\t2\nPercentual ao mês (dias corridos)\t3\nPercentual ao ano (dias corridos)\t4\nValor (dias úteis)\t5\nPercentual ao dia (dias úteis)\t6\nPercentual ao mês (dias úteis)\t7\nPercentual ao ano (dias úteis)\t8","pattern":"minimum: 1\nmaximum: 8"},"valorPerc":{"type":"string","description":"Valor","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"modalidade","1":"valorPerc"}},"abatimento":{"type":"object","description":"Abatimento aplicado à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de abatimentos, conforme tabela de domínios.\nDescrição\tDomínio\nValor Fixo\t1\nPercentual\t2","pattern":"minimum: 1\nmaximum: 2"},"valorPerc":{"type":"string","description":"Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"modalidade","1":"valorPerc"}},"desconto":{"type":"object","description":"Descontos aplicados à cobrança","properties":{"modalidade":{"type":"integer","format":"int32","description":"Modalidade de desconto, conforme tabela de domínios.\nDescrição\tDomínio\nValor Fixo até a[s] data[s] informada[s]\t1\nPercentual até a data informada\t2\nValor por antecipação dia corrido\t3\nValor por antecipação dia útil\t4\nPercentual por antecipação dia corrido\t5\nPercentual por antecipação dia útil\t6"},"descontoDataFixa":{"type":"array","description":"Descontos absolutos aplicados à cobrança.","maxItems":3,"items":{"type":"object","properties":{"data":{"type":"string","description":"Descontos por pagamento antecipado, com data fixa. Matriz com até três elementos, sendo que cada elemento é composto por um par \"data e valorPerc\", para estabelecer descontos percentuais ou absolutos, até aquela data de pagamento. Trata-se de uma data, no formato yyyy-mm-dd, segundo ISO 8601. A data de desconto obrigatoriamente deverá ser menor que a data de vencimento da cobrança.","maxLength":10,"examples":{"0":"2020-04-01"}},"valorPerc":{"type":"string","description":"Desconto em valor absoluto ou percentual por dia, útil ou corrido, conforme valor.desconto.modalidade","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"data","1":"valorPerc"}}},"valorPerc":{"type":"string","description":"Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13}},"required":{"0":"modalidade","1":"valorPerc"}}},"required":{"0":"original"}},"chave":{"type":"string","description":"**Formato do campo chave**\n- O campo chave, obrigatório, determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.\n- Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.\n- O formato das chaves pode ser encontrado na seção \"Formatação das chaves do DICT no BR Code\" do Manual de Padrões para iniciação do Pix.","maxLength":77},"solicitacaoPagador":{"type":"string","description":"O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.","maxLength":140},"infoAdicionais":{"type":"array","description":"Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.","maxItems":50,"items":{"type":"object","properties":{"nome":{"type":"string","description":"Nome do campo.","maxLength":50},"valor":{"type":"string","description":"Dados do campo.","maxLength":200}},"required":{"0":"nome","1":"valor"}}}},"required":{"0":"calendario","1":"devedor","2":"valor","3":"chave"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_webhook","parameters":{"inicio":{"type":"string","description":"data inicial da pesquisa. Intervalo máximo: 5 dias."},"fim":{"type":"string","description":"data final da pesquisa. Intervalo máximo: 5 dias."},"paginacao.paginaAtual":{"type":"integer","description":"Default value : 0"},"paginacao.itensPorPagina":{"type":"integer","description":"Default value : 100"}}},{"connectionName":"banco-do-brasil","actionName":"pix/post_locrec","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"pix/get_locrec","parameters":{"inicio":{"type":"string","description":"Data de início - Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339."},"fim":{"type":"string","description":"Data de fim - Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339."},"idRecPresente":{"type":"boolean","description":"Filtro pela existência de id da recorrência:\ntrue \u0013 traz somente location com idRec\nfalse \u0013 traz somente location sem idRec"},"convenio":{"type":"string","description":"Convenio"},"paginacao.paginaAtual":{"type":"integer","description":"Página atual - Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.\nDefault: 0"},"paginacao.itensPorPagina":{"type":"integer","description":"Itens por Página - Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.\nDefault: 100"}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_webhook_by_chave","parameters":{"chave":{"type":"string","description":"chave"}}},{"connectionName":"banco-do-brasil","actionName":"pix/delete_webhook_by_chave","parameters":{"chave":{"type":"string","description":"chave"}}},{"connectionName":"banco-do-brasil","actionName":"pix/put_webhook_by_chave","parameters":{"chave":{"type":"string","description":"chave"},"data":{"type":"object","properties":{"webhookUrl":{"type":"string","description":"webhookUrl","maxLength":300,"examples":{"0":"https://pix.example.com/api/webhook/"}}},"required":{"0":"webhookUrl"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/patch_cobr_by_txid","parameters":{"txid":{"type":"string","description":"Id da Transação"},"data":{"type":"object","properties":{"status":{"type":"string","description":"Status do registro da cobrança\nValue: \"CANCELADA\"","maxLength":25,"examples":{"0":"CANCELADA"}}}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_cobr_by_txid","parameters":{"txid":{"type":"string","description":"Id da Transação - Identificador da transação único por CPF/CNPJ do usuário recebedor."}}},{"connectionName":"banco-do-brasil","actionName":"pix/put_cobr_by_txid","parameters":{"txid":{"type":"string","description":"Id da Transação"},"data":{"type":"object","properties":{"idRec":{"type":"string","description":"ID Recorrência","pattern":"[a-zA-Z0-9]{29}","maxLength":29,"examples":{"0":"RN1234567820241130lkwdefghijk"}},"infoAdicional":{"type":"string","description":"Informações adicionais da fatura.","pattern":"<= 140 characters","maxLength":140,"examples":{"0":"Serviços de Streamming de Música e Filmes."}},"calendario":{"type":"object","description":"object (Calendário) - Informações sobre calendário da cobrança.","properties":{"dataDeVencimento":{"type":"string","description":"Data de vencimento da cobrança.","maxLength":10,"examples":{"0":"2024-12-26"}}},"required":{"0":"dataDeVencimento"}},"valor":{"type":"object","description":"object (valor) - Valor da cobrança recorrente.","properties":{"original":{"type":"string","description":"Valor original da cobrança.","pattern":" \\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"123.00"}}},"required":{"0":"original"}},"ajusteDiaUtil":{"type":"boolean","description":"Ajuste data vencimento para próximo dia útil - Campo de ativação do ajuste da data de vencimento para próximo dia útil caso o vencimento corrente seja um dia não útil. O PSP Pagador deverá considerar os feriados locais com base no código município do usuário pagador.\nDefault: true","examples":{"0":"true"}},"recebedor":{"type":"object","description":"object (recebedor) - O objeto recebedor organiza as informações sobre o recebedor da cobrança.","properties":{"conta":{"type":"string","description":"Número da conta do usuário recebedor.","pattern":"<= 20 characters","maxLength":20,"examples":{"0":"012682\n"}},"tipoConta":{"type":"string","description":"Tipo da conta do usuário recebedor.\nEnum: \"CORRENTE\", \"POUPANCA\" ,\"PAGAMENTO\"","maxLength":25,"examples":{"0":"CORRENTE"}},"agencia":{"type":"string","description":"Número da agência do usuário recebedor.","pattern":"<= 4 characters","maxLength":4,"examples":{"0":"9708"}}},"required":{"0":"conta","1":"tipoConta"}},"devedor":{"type":"object","description":"object (devedor) - O objeto devedor organiza as informações sobre o devedor da recorrência.","properties":{"email":{"type":"string","description":"Email do usuário.","maxLength":256,"examples":{"0":"hmtestes2@bb.com.br"}},"logradouro":{"type":"string","description":"Logradouro do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"Rua A, 123"}},"cidade":{"type":"string","description":"Cidade do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"São Paulo"}},"uf":{"type":"string","description":"UF do usuário.","pattern":"<= 2 characters","maxLength":2,"examples":{"0":"SP"}},"cep":{"type":"string","description":"CEP do usuário.","pattern":"<= 8 characters","maxLength":8,"examples":{"0":"12345678"}}}}},"required":{"0":"idRec","1":"calendario","2":"valor","3":"ajusteDiaUtil","4":"recebedor"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/patch_rec_by_id_rec","parameters":{"idRec":{"type":"string","description":"ID Recorrência - Id da location cadastrada para servir um payload"},"data":{"type":"object","properties":{"status":{"type":"string","description":"Status do registro da recorrência\nValue: \"CANCELADA\"","maxLength":25,"examples":{"0":"CANCELADA"}},"vinculo":{"type":"object","description":"object (Descrição do Objeto da Recorrência)","properties":{"devedor":{"type":"object","description":"Pessoa Física (object) or Pessoa Jurídica (object)\nO objeto devedor organiza as informações sobre o devedor da recorrência.","properties":{"nome":{"type":"string","description":"Nome do usuário.","pattern":"<= 140 characters","maxLength":140,"examples":{"0":"Imobiliária Bom Sucesso"}}},"required":{"0":"nome"}}}},"loc":{"type":"integer","format":"int32","description":"Identificador da location a ser informada na criação de uma recorrência.","examples":{"0":"5100"}},"calendario":{"type":"object","description":"object (Informações sobre calendário da recorrência)","properties":{"dataInicial":{"type":"string","description":"Data estimada de primeiro pagamento - Trata-se de uma data, no formato YYYY-MM-DD, segundo ISO 8601. Data estimada de primeiro pagamento.","maxLength":10,"examples":{"0":"2024-12-26"}}}},"ativacao":{"type":"object","description":"object (Dados relacionados à confirmação da ativação da recorrência.)","properties":{"dadosJornada":{"type":"object","description":"Cobrança imediata vinculada à Jornada 3 (object) - Dados de confirmação da jornada e início da recorrência","properties":{"txid":{"type":"string","description":"Id da Transação","pattern":"[a-zA-Z0-9]{26,35}","maxLength":35,"examples":{"0":"TesteCobr1Txid"}}},"required":{"0":"txid"}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_rec_by_id_rec","parameters":{"idRec":{"type":"string","description":"ID Recorrência - Id da location cadastrada para servir um payload"},"txid":{"type":"string","description":"TxId da cobrança associada a recorrência"}}},{"connectionName":"banco-do-brasil","actionName":"pix/post_loc","parameters":{"data":{"type":"object","properties":{"tipoCob":{"type":"string","description":"Tipo da cobrança\n[ cob, cobv ]","maxLength":10}},"required":{"0":"tipoCob"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_loc","parameters":{"inicio":{"type":"string","description":"Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339."},"fim":{"type":"string","description":"Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339."},"txIdPresente":{"type":"boolean","description":"txIdPresente"},"tipoCob":{"type":"string","description":"Available values : \"cob\", \"cobv\""},"paginacao.paginaAtual":{"type":"integer","description":"Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.\n\nDefault value : 0"},"paginacao.itensPorPagina":{"type":"integer","description":"Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.\n\nDefault value : 100"}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_loc_by_id","parameters":{"id":{"type":"string","description":"Id da location cadastrada para servir um payload"}}},{"connectionName":"banco-do-brasil","actionName":"pix/post_cobr_by_txid_retentativa_by_data","parameters":{"txid":{"type":"string","description":"Id da Transação"},"data":{"type":"string","description":"Data prevista para liquidação da ordem de pagamento correspondente. Trata-se de uma data, no formato YYYY-MM-DD, segundo ISO 8601."}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_cobv","parameters":{"inicio":{"type":"string","description":"Data inicial da pesquisa. Intervalo máximo: 5 dias."},"fim":{"type":"string","description":"Data final da pesquisa. Intervalo máximo: 5 dias."},"cpf":{"type":"string","description":"cpf"},"cnpj":{"type":"string","description":"cnpj"},"locationPresente":{"type":"boolean","description":"locationPresente"},"status":{"type":"string","description":"status"},"loteCobVId":{"type":"integer","description":"loteCobVId"},"paginacao.paginaAtual":{"type":"integer","description":"paginacao.paginaAtual"},"paginacao.itensPorPagina":{"type":"integer","description":"paginacao.itensPorPagina"}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_pix_bb_devolucoes","parameters":{"inicio":{"type":"string","description":"Data inicial utilizada na consulta. Respeita RFC 3339."},"fim":{"type":"string","description":"Data de fim utilizada na consulta. Respeita RFC 3339."},"estadoDevolucao":{"type":"string","description":"Estado da devolução."},"paginacao.paginaAtual":{"type":"integer","description":"paginacao.paginaAtual"},"paginacao.itensPorPagina":{"type":"integer","description":"paginacao.itensPorPagina"}}},{"connectionName":"banco-do-brasil","actionName":"pix/post_cobr","parameters":{"data":{"type":"object","properties":{"idRec":{"type":"string","description":"ID Recorrência - Identificador da Recorrência","pattern":"[a-zA-Z0-9]{29}","maxLength":29,"examples":{"0":"RN1234567820241130lkwdefghijk"}},"infoAdicional":{"type":"string","description":"Informações adicionais da fatura.","pattern":"<= 140 characters","maxLength":140,"examples":{"0":"Serviços de Streamming de Música e Filmes."}},"calendario":{"type":"object","description":"object (Calendário) - Informações sobre calendário da cobrança.","properties":{"dataDeVencimento":{"type":"string","description":"Data de vencimento da cobrança.","pattern":" YYYY-MM-DD","maxLength":10,"examples":{"0":"2024-12-26"}}},"required":{"0":"dataDeVencimento"}},"valor":{"type":"object","description":"object (valor) - Valor da cobrança recorrente.","properties":{"original":{"type":"string","description":"Valor original da cobrança.","pattern":" \\d{1,10}\\.\\d{2}","maxLength":13,"examples":{"0":"123.00"}}},"required":{"0":"original"}},"ajusteDiaUtil":{"type":"boolean","description":"Ajuste data vencimento para próximo dia útil - Campo de ativação do ajuste da data de vencimento para próximo dia útil caso o vencimento corrente seja um dia não útil. O PSP Pagador deverá considerar os feriados locais com base no código município do usuário pagador.\nDefault: true","examples":{"0":"true"}},"recebedor":{"type":"object","description":"object (recebedor) - O objeto recebedor organiza as informações sobre o recebedor da cobrança.","properties":{"conta":{"type":"string","description":"Número da conta do usuário recebedor.","pattern":"<= 20 characters","maxLength":20,"examples":{"0":"012682"}},"tipoConta":{"type":"string","description":"Tipo da conta do usuário recebedor.\nEnum: \"CORRENTE\", \"POUPANCA\" ,\"PAGAMENTO\"","maxLength":25,"examples":{"0":"CORRENTE"}},"agencia":{"type":"string","description":"Número da agência do usuário recebedor.","pattern":"<= 4 characters","maxLength":4,"examples":{"0":"9708"}}},"required":{"0":"conta","1":"tipoConta"}},"devedor":{"type":"object","description":"object (devedor) - O objeto devedor organiza as informações sobre o devedor da recorrência.","properties":{"email":{"type":"string","description":"Email do usuário.","maxLength":256,"examples":{"0":"hmtestes2@bb.com.br"}},"logradouro":{"type":"string","description":"Logradouro do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"Rua A, 123"}},"cidade":{"type":"string","description":"Cidade do usuário.","pattern":"<= 200 characters","maxLength":200,"examples":{"0":"São Paulo"}},"uf":{"type":"string","description":"UF do usuário.","pattern":"<= 2 characters","maxLength":2,"examples":{"0":"SP"}},"cep":{"type":"string","description":"CEP do usuário.","pattern":"<= 8 characters","maxLength":8,"examples":{"0":"12345678"}}}}},"required":{"0":"idRec","1":"calendario","2":"valor","3":"ajusteDiaUtil","4":"recebedor"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_cobr","parameters":{"inicio":{"type":"string","description":"Data de início - Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339."},"fim":{"type":"string","description":"Data de fim - Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339."},"idRec":{"type":"string","description":"ID Recorrência - Filtro pelo Identificador da Recorrência."},"cpf":{"type":"string","description":"CPF - Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ."},"cnpj":{"type":"string","description":"CNPJ - Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF."},"status":{"type":"string","description":"Status do registro da cobrança."},"convenio":{"type":"string","description":"Campo opcional para o caso de mais de um convênio dentro de um mesmo PSP recebedor, por CNPJ"},"paginacao.paginaAtual":{"type":"integer","description":"Página atual - Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.\nDefault: 0"},"paginacao.itensPorPagina":{"type":"integer","description":"Itens por Página - Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.\nDefault: 100"}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_lotecobv","parameters":{"inicio":{"type":"string","description":"Data de início - Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339."},"fim":{"type":"string","description":"Data de fim - Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339."},"paginacao.paginaAtual":{"type":"integer","description":"Página atual - Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.\nDefault: 0"},"paginacao.itensPorPagina":{"type":"integer","description":"Itens por Página - Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.\nDefault: 100"}}},{"connectionName":"banco-do-brasil","actionName":"pix/post_cob","parameters":{"data":{"type":"object","properties":{"calendario":{"type":"object","description":"Os campos aninhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.","properties":{"expiracao":{"type":"integer","format":"int32","description":"Tempo de vida da cobrança, especificado em segundos a partir da data de criação (calendario.criacao).","pattern":"default: 86400","examples":{"0":"3600"}}}},"devedor":{"type":"object","description":"Os campos aninhados sob o objeto devedor são opcionais e identificam o devedor, ou seja, a pessoa ou a instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar, efetivamente, o pagamento do documento. Não é permitido que o campo devedor.cpf e campo devedor.cnpj estejam preenchidos ao mesmo tempo. Se o campo devedor.cnpj está preenchido, então o","properties":{"cpf":{"type":"string","description":"CPF do usuário.","pattern":"[0-9]{11}","maxLength":11},"cnpj":{"type":"string","description":"CNPJ do usuário.","pattern":"[0-9]{14}","maxLength":14},"nome":{"type":"string","description":"Nome do usuário.","maxLength":200}}},"loc":{"type":"object","description":"Identificador da localização do payload.","properties":{"id":{"type":"integer","description":"Identificador da localização do payload."}}},"valor":{"type":"object","description":"Valores monetários referentes à cobrança.","properties":{"original":{"type":"string","description":"Valor original da cobrança.","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13},"modalidadeAlteracao":{"type":"integer","format":"int32","description":"Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0. Se o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.","pattern":"minimum: 0\nmaximum: 1"},"retirada":{"type":"object","description":"É uma estrutura opcional relacionada ao conceito de recebimento de numerário. Apenas um agrupamento por vez é permitido, quando há saque não há troco e vice-versa.","properties":{"saque":{"type":"object","description":"Informações relacionadas ao saque","properties":{"valor":{"type":"string","description":"Valor do saque efetuado","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13},"modalidadeAlteracao":{"type":"integer","format":"int32","description":"Modalidade de alteração de valor do saque. Quando não preenchido o valor assumido é o 0 (zero).","pattern":"minimum: 0\nmaximum: 1\ndefault: 0"},"modalidadeAgente":{"type":"string","description":"AGTEC: Agente Estabelecimento Comercial\nAGTOT:Agente Outra Espécie de Pessoa Jurídica ou Correspondente no País\nAGPSS: Agente Facilitador de Serviço de Saque (ATENÇÃO: no mapeamento para o campo 'modalidadeAgente', da pacs.008, esse valor deve ser substituído por AGFSS)","pattern":"[ AGTEC, AGTOT, AGPSS ]","maxLength":5},"prestadorDoServicoDeSaque":{"type":"string","description":"ISPB do Facilitador de Serviço de Saque","pattern":"\\d{8}","maxLength":8}},"required":{"0":"valor","1":"modalidadeAgente","2":"prestadorDoServicoDeSaque"}},"troco":{"type":"object","description":"Informações relacionadas ao troco","properties":{"valor":{"type":"string","description":"Valor do troco efetuado","pattern":"\\d{1,10}\\.\\d{2}","maxLength":13},"modalidadeAlteracao":{"type":"integer","format":"int32","description":"Modalidade de alteração de valor do troco. Quando não preenchido o valor assumido é o 0 (zero).","pattern":"minimum: 0\nmaximum: 1\ndefault: 0"},"modalidadeAgente":{"type":"string","description":"SIGLA\tDescrição\nAGTEC\tAgente Estabelecimento Comercial\nAGTOT\tAgente Outra Espécie de Pessoa Jurídica ou Correspondente no País","pattern":"[ AGTEC, AGTOT ]","maxLength":5},"prestadorDoServicoDeSaque":{"type":"string","description":"ISPB do Facilitador de Serviço de Saque","pattern":"\\d{8}","maxLength":8}},"required":{"0":"valor","1":"modalidadeAgente","2":"prestadorDoServicoDeSaque"}}}}},"required":{"0":"original"}},"chave":{"type":"string","description":"**Formato do campo chave**\n- O campo chave, obrigatório, determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.\n- Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.\n- O formato das chaves pode ser encontrado na seção \"Formatação das chaves do DICT no BR Code\" do Manual de Padrões para iniciação do Pix.","maxLength":77},"solicitacaoPagador":{"type":"string","description":"O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres.","maxLength":140},"infoAdicionais":{"type":"array","description":"Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.","maxItems":50,"items":{"type":"object","properties":{"nome":{"type":"string","description":"Nome do campo.","maxLength":50},"valor":{"type":"string","description":"Dados do campo.","maxLength":200}},"required":{"0":"nome","1":"valor"}}}},"required":{"0":"calendario","1":"chave"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_cob","parameters":{"inicio":{"type":"string","description":"Data inicial da pesquisa. Intervalo máximo: 5 dias"},"fim":{"type":"string","description":"Data final da pesquisa. Intervalo máximo: 5 dias."},"cpf":{"type":"string","description":"cpf"},"cnpj":{"type":"string","description":"cnpj"},"locationPresente":{"type":"boolean","description":"locationPresente"},"status":{"type":"string","description":"status"},"paginacao.paginaAtual":{"type":"integer","description":"paginacao.paginaAtual"},"paginacao.itensPorPagina":{"type":"integer","description":"paginacao.itensPorPagina"}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_locrec_by_id","parameters":{"id":{"type":"string","description":"Id da location cadastrada para servir um payload"}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_pix_by_e2eid","parameters":{"e2eid":{"type":"string","description":"e2eid"}}},{"connectionName":"banco-do-brasil","actionName":"pix/patch_solicrec_by_id_solic_rec","parameters":{"idSolicRec":{"type":"string","description":"\"string (ID Solicitação da Recorrência) 29 characters [a-zA-Z0-9]{29}"},"data":{"type":"object","properties":{"status":{"type":"string","description":"Status do registro da solicitação de recorrência\nValue: \"CANCELADA\"","maxLength":25,"examples":{"0":"CANCELADA"}}},"required":{"0":"status"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_solicrec_by_id_solic_rec","parameters":{"idSolicRec":{"type":"string","description":"ID Solicitação da Recorrência - Identificador da Solicitação da Recorrência"}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_webhookrec","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"pix/delete_webhookrec","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"pix/put_webhookrec","parameters":{"data":{"type":"object","properties":{"webhookUrl":{"type":"string","description":"URL Webhook","maxLength":140,"examples":{"0":"https://usuario.recebedor.com/api/webhookrec/"}}},"required":{"0":"webhookUrl"}}}},{"connectionName":"banco-do-brasil","actionName":"pix/get_pix_bb","parameters":{"inicio":{"type":"string","description":"Data inicial utilizada na consulta. Respeita RFC 3339."},"fim":{"type":"string","description":"Data de fim utilizada na consulta. Respeita RFC 3339."},"txid":{"type":"string","description":"txid"},"txIdPresente":{"type":"boolean","description":"txIdPresente"},"devolucaoPresente":{"type":"boolean","description":"Filtro pela existência de devolução."},"contestacaoPresente":{"type":"boolean","description":"Indicador do filtro por existência de contestação."},"cpf":{"type":"string","description":"CPF do usuário."},"cnpj":{"type":"string","description":"CNPJ do usuário."},"chave":{"type":"string","description":"**Chave DICT do recebedor**\n\nFormato do campo chave\n- Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.\n- O formato das chaves pode ser encontrado na seção \"Formatação das chaves do DICT no BR Code\" do Manual de Padrões para iniciação do Pix."},"paginacao.paginaAtual":{"type":"integer","description":"paginacao.paginaAtual"},"paginacao.itensPorPagina":{"type":"integer","description":"paginacao.itensPorPagina"}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_acessos_token","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_acessos_token","parameters":{"data":{"type":"object","required":["codigoBalcaoVenda","codigoCanalVendaBalcao","codigoSecaoAtendimento","numeroTipoPessoa","textoCpfCadastroNacPessoasJuridicas"],"properties":{"codigoBalcaoVenda":{"type":"number","description":"Código do balcão de venda contidos na plataforma maestro (Utilizar 1103).","example":1459},"codigoCanalVendaBalcao":{"type":"number","description":"Código do canal de vendas do balcão contidos na plataforma maestro.","example":1},"codigoSecaoAtendimento":{"type":"string","description":"Código da sessão de atendimento da vendo do produto.","example":"450a6382-0791-47c6-90c7-fb296dc8c7fd"},"numeroTipoPessoa":{"type":"number","description":"Código do tipo da pessoa da pessoa (1-Pessoa Fisica) (2-Pessoa Juridica)","example":1},"textoCpfCadastroNacPessoasJuridicas":{"type":"string","description":"Número do CPF ou CNPJ do cliente que esta adiquirindo o produto.","example":"35369157871"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_cotacoes_emissao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_cotacoes_emissao","parameters":{"data":{"type":"object","required":["canal","meioCanal","nrGrupoProduto","pontoVenda"],"properties":{"canal":{"required":["nmMeioCanal","nrMeioCanal"],"type":"object","properties":{"nmCanal":{"type":"string","description":"Nome do canal de vendas.","example":"Brasilseg"},"nrCanal":{"type":"number","description":"Número do canal de vendas.","example":1}}},"meioCanal":{"required":["nmMeioCanal","nrMeioCanal"],"type":"object","properties":{"nmMeioCanal":{"type":"string","example":"P_DEV_BB","description":"Sempre Informar P_DEV_BB"},"nrMeioCanal":{"type":"number","example":43,"description":"Número correspondente ao canal (54-SandBox) (43-Ambiente Produtivo)"}}},"pontoVenda":{"required":["nmPontoVenda","nrPontoVenda"],"type":"object","properties":{"nmPontoVenda":{"type":"string","description":"Nome do ponto de venda.","example":"BB Seguros"},"nrPontoVenda":{"type":"number","description":"Número do grupo de produtos.","example":2}}},"nrGrupoProduto":{"type":"string","description":"Número do grupo de produtos.","example":"0171"},"nrOferta":{"type":"number","description":"Número da oferta. (FIXO)","example":10615},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais do proponente titular da cotação, Caso ja informe um poponente na cotação não havera necessidade de chamar o serviço: /seguros/v1/cotacoes/proponente\n","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean","example":true},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Nicho referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"$ref":"#/components/schemas/TipoEstadoCivil"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_cotacoes_oferta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_cotacoes_oferta","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"nmIdentificadorOferta":{"type":"string","description":"Nome identificador da oferta.","example":"7de6cc99-c3f1-4ccf-b55d-de3ef57ebc7f"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_cotacoes_proponente","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmCpfCnpj","nmNome","tpGenero","dtNascimento"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador da cotação","example":"20231102000006"},"proponente":{"type":"object","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"31465091050"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Teste Outro Solicitante"},"pessoaFisica":{"type":"object","properties":{"tpGenero":{"$ref":"#/components/schemas/Genero"},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"nmNomeSocial":{"type":"string","description":"Nome social do proponente","example":"Rafael Veloso"}}},"lsEmail":{"type":"array","items":{"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Indicador se o e-mail é principal","example":true},"nmEmail":{"type":"string","description":"Endereço de e-mail","example":"tnasciment@brasilseg.com.br"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsTelefone":{"type":"array","items":{"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Indicador se o telefone é principal","example":true},"nmContato":{"type":"string","description":"Nome do contato","example":"Catia"},"nmDdd":{"type":"string","description":"DDD do telefone","example":"55"},"nmNumero":{"type":"string","description":"Número do telefone","example":"929883022"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}},"lsDocumento":{"type":"array","items":{"type":"object","description":"Lista de documentos do proponente"}},"lsEndereco":{"type":"array","items":{"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Indicador se o endereço é principal","example":true},"nmBairro":{"type":"string","description":"Bairro do endereço","example":"VILA ALEXANDRIA"},"nmCep":{"type":"string","description":"CEP do endereço","example":"04635010"},"nmComplemento":{"type":"string","description":"Complemento do endereço","example":"comercial"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço","example":"R ALBUQUERQUE S MUNIZ"},"nmMunicipio":{"type":"string","description":"Município do endereço","example":"SAO PAULO"},"nmNumero":{"type":"string","description":"Número do endereço","example":"227"},"nmPais":{"type":"string","description":"País do endereço","example":"Brasil"},"nmUf":{"type":"string","description":"Estado do endereço","example":"SP"},"tpEndereco":{"$ref":"#/components/schemas/Endereco"}}}},"tpProponente":{"type":"object","properties":{"nmDescricao":{"type":"string","description":"Descrição do tipo de proponente","example":"pessoa física"},"nrProponenteTipo":{"type":"integer","description":"Número do tipo de proponente","example":1}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/put_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","proponente"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais da proponente titular da cotação.","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"tpProponente":{"type":"object","properties":{"nrProponenteTipo":{"type":"number","example":1,"description":"código do proponente (1)(2)(3)"},"nmDescricao":{"type":"string","example":"Titular","description":"(1-Titular),(2-Conjuge),(3-Mutuario)"}}},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean"},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Nicho referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"$ref":"#/components/schemas/EstadoCivil"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/delete_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmCpfCnpj"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ da proponente da cotação.","example":"82038611050"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_cotacoes_objeto_segurado","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_cotacoes_objeto_segurado","parameters":{"data":{"type":"object","required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","example":"20240827000127"},"nmIdentificadorChassi":{"type":"string","example":"4774692e-752b-495b-a69a-c6d01b08bbdd"},"objetoSegurado":{"type":"object","properties":{"objeto":{"type":"object","properties":{"obNome":{"type":"object","properties":{"nmResposta":{"type":"string","example":"Teste Outro Solicitante"}}},"obCpf":{"type":"object","properties":{"nmResposta":{"type":"string","example":"31465091050"}}},"obSexo":{"type":"object","properties":{"nmResposta":{"type":"string","example":"M"}}},"obDataNascimento":{"type":"object","properties":{"nmResposta":{"type":"string","example":"1986-08-03"}}},"obCodigoOperacaoCredito":{"type":"object","properties":{"nmResposta":{"type":"string","example":"245611219"}}},"obNumeroLinhaCredito":{"type":"object","properties":{"nmResposta":{"type":"integer","example":598}}},"obNumeroItemOperacao":{"type":"object","properties":{"nmResposta":{"type":"string","example":"6"}}},"obNumeroSubContrato":{"type":"object","properties":{"nmResposta":{"type":"string","example":"1"}}},"obNomeLinhaCredito":{"type":"object","properties":{"nmResposta":{"type":"string","example":"RENEGOCIACAO MASSIFICADA PF/ PJ"}}},"obCodigoModalidadeLinhaCredito":{"type":"object","properties":{"nmResposta":{"type":"string","example":"9"}}},"obCodigoProdutoLinhaCredito":{"type":"object","properties":{"nmResposta":{"type":"string","example":"349"}}},"obPrazoEmDias":{"type":"object","properties":{"nmResposta":{"type":"integer","example":1844}}},"obRespostaDps":{"type":"object","properties":{"nmResposta":{"type":"string","example":"Sim"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/put_cotacoes_objeto_segurado","parameters":{"data":{"required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"3"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","properties":{"nmIdentificadorObjetoSegurado":{"type":"string","description":"Identificador único do objeto segurado.","example":"c423e287-a188-4629-9094-871fea0f49f6"},"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obAgencia(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"1629"}}},"obConta(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"09250924-7"}}},"obInstituicaoFinanceira":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"001"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_cotacoes_plano","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_cotacoes_plano","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorPlano"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlano":{"type":"string","description":"Nome identificador do plano escolhido.","example":"d5200825-d76b-4f94-a5b1-7385580b4e4e"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado.","example":"3"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_cotacoes_periodicidade","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_cotacoes_periodicidade","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorChassi","qtPeriodicidade","nmIdentificadorPeriodicidade"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"qtPeriodicidade":{"type":"number","description":"Quantidade de parcelas do contrato.","example":3},"nmIdentificadorPeriodicidade":{"type":"string","description":"Nome identificador da periodicidade selecionada.","example":"dd3b2de0-966a-4257-9166-b64bf9861a77"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_contratacoes_plano_pagamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_contratacoes_plano_pagamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlanoPagamento":{"type":"string","description":"Nome identificador do plano de pagamento selecionado.","example":"f1dc735f-3532-4d85-ab04-a7198fd11ce1"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_contratacoes_plano_pagamento_parcelamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_contratacoes_plano_pagamento_parcelamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231105000005"},"nmIdentificadorParcela":{"type":"string","description":"Nome identificador do parcelamento selecionado.","example":"8a29f51f-fe0d-4ed1-ae93-efc05f138289"},"nrDiaVencimento":{"type":"integer","description":"Dia do vencimento do parcelamento","example":28}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_contratacoes_de_acordo","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_contratacoes_de_acordo","parameters":{"data":{"type":"object","properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/get_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_contratacoes_contrato_cobranca","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/post_contratacoes_contrato_cobranca","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"dadoCartaoCredito":{"required":["dtExpiracao","nrCartao","nrBandeiraCartao"],"type":"object","description":"Dados do cartão de crédito para pagamento.","properties":{"cdSeguranca":{"type":"string","description":"Código de segurança do cartão.","example":"484"},"dtExpiracao":{"type":"string","description":"Data de expiração do cartão.","example":"09/2023"},"nrCartao":{"type":"string","description":"Número do cartão.","example":"5226662239152154"},"nrBandeiraCartao":{"type":"number","description":"Número da bandeira do cartão.","example":5}}},"dadoDebitoConta":{"required":["nmNumeroConta","nrAgencia","nrBanco"],"type":"object","description":"Dados da conta de débito para pagamento. (Não está habilitado)","properties":{"nmNumeroConta":{"type":"string","description":"Número da conta.","example":"12313455"},"nmContaDigito":{"type":"string","description":"Dígito da conta.","example":"1"},"nrAgencia":{"type":"string","description":"Número da agência.","example":"0002"},"nmAgenciaDigito":{"type":"string","description":"Dígito da agência.","example":"1"},"nrBanco":{"type":"number","description":"Número do banco.","example":1},"inPagamentoAto":{"type":"string","example":"1"}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/parameters_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_credito_protegido/get_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_acessos_token","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_acessos_token","parameters":{"data":{"type":"object","required":["codigoBalcaoVenda","codigoCanalVendaBalcao","codigoSecaoAtendimento","numeroTipoPessoa","textoCpfCadastroNacPessoasJuridicas"],"properties":{"codigoBalcaoVenda":{"type":"number","description":"Código do balcão de venda contidos na plataforma maestro (Utilizar 1103).","example":1459},"codigoCanalVendaBalcao":{"type":"number","description":"Código do canal de vendas do balcão contidos na plataforma maestro.","example":1},"codigoSecaoAtendimento":{"type":"string","description":"Código da sessão de atendimento da vendo do produto.","example":"450a6382-0791-47c6-90c7-fb296dc8c7fd"},"numeroTipoPessoa":{"type":"number","description":"Código do tipo da pessoa da pessoa (1-Pessoa Fisica) (2-Pessoa Juridica)","example":1},"textoCpfCadastroNacPessoasJuridicas":{"type":"string","description":"Número do CPF ou CNPJ do cliente que esta adiquirindo o produto.","example":"35369157871"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_cotacoes_emissao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_cotacoes_emissao","parameters":{"data":{"type":"object","required":["canal","meioCanal","nrGrupoProduto","pontoVenda"],"properties":{"canal":{"required":["nmMeioCanal","nrMeioCanal"],"type":"object","properties":{"nmCanal":{"type":"string","description":"Nome do canal de vendas.","example":"Banco do Brasil"},"nrCanal":{"type":"number","description":"Número do canal de vendas.","example":1}}},"meioCanal":{"required":["nmMeioCanal","nrMeioCanal","nrGrupoProduto"],"type":"object","properties":{"nmMeioCanal":{"type":"string","example":"P_DEV_BB","description":"Central de Atendimento"},"nrMeioCanal":{"type":"number","example":43,"description":"Número correspondente ao canal (54-SandBox) (43-Ambiente Produtivo)"}}},"nrGrupoProduto":{"type":"string","example":"0171","description":"Número do grupo do produto que rera comercioalizado"},"pontoVenda":{"required":["nmPontoVenda","nrPontoVenda"],"type":"object","properties":{"nmPontoVenda":{"type":"string","description":"Nome do ponto de venda.","example":"BB Seguros"},"nrPontoVenda":{"type":"number","description":"Número do grupo de produtos.","example":2}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_cotacoes_oferta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_cotacoes_oferta","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"nmIdentificadorOferta":{"type":"string","description":"Nome identificador da oferta.","example":"7de6cc99-c3f1-4ccf-b55d-de3ef57ebc7f"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_cotacoes_objeto_segurado_bolsa","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_cotacoes_objeto_segurado_bolsa","parameters":{"data":{"type":"object","required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"2"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","required":["objeto"],"properties":{"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obBolsaProtegida":{"type":"object","description":"Confirmação de Objeto bolsa protegida selecionado","properties":{"nmResposta":{"type":"string","example":"Sim"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/put_cotacoes_objeto_segurado_bolsa","parameters":{"data":{"required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"2"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","properties":{"nmIdentificadorObjetoSegurado":{"type":"string","description":"Identificador único do objeto segurado.","example":"c423e287-a188-4629-9094-871fea0f49f6"},"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obBolsaProtegida":{"type":"object","description":"Inidicador de objeto Bolsa informado.","properties":{"nmResposta":{"type":"string","example":"Não"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_cotacoes_objeto_segurado_conta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_cotacoes_objeto_segurado_conta","parameters":{"data":{"type":"object","required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"2"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","required":["objeto"],"properties":{"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obAgencia(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"1629"}}},"obConta(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"09250924-7"}}},"obInstituicaoFinanceira":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"001"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/put_cotacoes_objeto_segurado_conta","parameters":{"data":{"required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"2"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","properties":{"nmIdentificadorObjetoSegurado":{"type":"string","description":"Identificador único do objeto segurado.","example":"c423e287-a188-4629-9094-871fea0f49f6"},"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obAgencia(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"1629"}}},"obConta(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"09250924-7"}}},"obInstituicaoFinanceira":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"001"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_cotacoes_proponente","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","proponente"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais da proponente titular da cotação.","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"tpProponente":{"type":"object","properties":{"nrProponenteTipo":{"type":"number","example":1,"description":"código do proponente (1)(2)(3)"},"nmDescricao":{"type":"string","example":"Titular","description":"(1-Titular),(2-Conjuge),(3-Mutuario)"}}},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean","example":true},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"type":"string","example":"1","description":"Classificação do tipo do estado civil do proponente"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/put_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","proponente"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais da proponente titular da cotação.","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"tpProponente":{"type":"object","properties":{"nrProponenteTipo":{"type":"number","example":1,"description":"código do proponente (1)(2)(3)"},"nmDescricao":{"type":"string","example":"Titular","description":"(1-Titular),(2-Conjuge),(3-Mutuario)"}}},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean"},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Nicho referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"$ref":"#/components/schemas/EstadoCivil"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/delete_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmCpfCnpj"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ da proponente da cotação.","example":"82038611050"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_cotacoes_plano_bolsa","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_cotacoes_plano_bolsa","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorPlano"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlano":{"type":"string","description":"Nome identificador do plano escolhido.","example":"d5200825-d76b-4f94-a5b1-7385580b4e4e"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado.","example":"2"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_cotacoes_plano_conta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_cotacoes_plano_conta","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorPlano"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlano":{"type":"string","description":"Nome identificador do plano escolhido.","example":"d5200825-d76b-4f94-a5b1-7385580b4e4e"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado.","example":"3"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_cotacoes_periodicidade","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_cotacoes_periodicidade","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorChassi","qtPeriodicidade","nmIdentificadorPeriodicidade"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"aaf35293-fc18-4c6a-bc6a-043e94ea04ac"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"e99a1eeb-2fda-46ed-8d02-e546e62afb94"},"qtPeriodicidade":{"type":"number","description":"Quantidade de parcelas do contrato.","example":3},"nmIdentificadorPeriodicidade":{"type":"string","description":"Nome identificador da periodicidade selecionada.","example":"4a4b0e7a-9c85-4f86-bd92-536cbcade995"},"dtInicioPeriodicidade":{"type":"string","description":"Data de inicio da periodicidade","example":"2023-10-06T09:00:00"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_contratacoes_de_acordo","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_contratacoes_de_acordo","parameters":{"data":{"type":"object","properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_contratacoes_plano_pagamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_contratacoes_plano_pagamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlanoPagamento":{"type":"string","description":"Nome identificador do plano de pagamento selecionado.","example":"f1dc735f-3532-4d85-ab04-a7198fd11ce1"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_contratacoes_plano_pagamento_parcelamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_contratacoes_plano_pagamento_parcelamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231105000005"},"nmIdentificadorParcela":{"type":"string","description":"Nome identificador do parcelamento selecionado.","example":"8a29f51f-fe0d-4ed1-ae93-efc05f138289"},"nrDiaVencimento":{"type":"integer","description":"Dia do vencimento do parcelamento","example":28}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/get_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_contratacoes_contrato_cobranca","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/post_contratacoes_contrato_cobranca","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"dadoCartaoCredito":{"required":["dtExpiracao","nrCartao","nrBandeiraCartao"],"type":"object","description":"Dados do cartão de crédito para pagamento.","properties":{"cdSeguranca":{"type":"string","description":"Código de segurança do cartão.","example":"484"},"dtExpiracao":{"type":"string","description":"Data de expiração do cartão.","example":"09/2023"},"nrCartao":{"type":"string","description":"Número do cartão.","example":"5226662239152154"},"nrBandeiraCartao":{"type":"number","description":"Número da bandeira do cartão.","example":5}}},"dadoDebitoConta":{"required":["nmNumeroConta","nrAgencia","nrBanco"],"type":"object","description":"Dados da conta de débito para pagamento. (Não está habilitado)","properties":{"nmNumeroConta":{"type":"string","description":"Número da conta.","example":"12313455"},"nmContaDigito":{"type":"string","description":"Dígito da conta.","example":"1"},"nrAgencia":{"type":"string","description":"Número da agência.","example":"0002"},"nmAgenciaDigito":{"type":"string","description":"Dígito da agência.","example":"1"},"nrBanco":{"type":"number","description":"Número do banco.","example":1},"inPagamentoAto":{"type":"string","example":"1"}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/parameters_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_de_itens_pessoais/get_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_acessos_token","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_acessos_token","parameters":{"data":{"type":"object","required":["codigoBalcaoVenda","codigoCanalVendaBalcao","codigoSecaoAtendimento","numeroTipoPessoa","textoCpfCadastroNacPessoasJuridicas"],"properties":{"codigoBalcaoVenda":{"type":"number","description":"Código do balcão de venda contidos na plataforma maestro (Utilizar 1103).","example":1459},"codigoCanalVendaBalcao":{"type":"number","description":"Código do canal de vendas do balcão contidos na plataforma maestro.","example":1},"codigoSecaoAtendimento":{"type":"string","description":"Código da sessão de atendimento da vendo do produto.","example":" 450a6382-0791-47c6-90c7-fb296dc8c7fd"},"numeroTipoPessoa":{"type":"number","description":"Código do tipo da pessoa da pessoa (1-Pessoa Fisica) (2-Pessoa Juridica)","example":1},"textoCpfCadastroNacPessoasJuridicas":{"type":"string","description":"Número do CPF ou CNPJ do cliente que esta adiquirindo o produto.","example":"35369157871"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_empresarial_cotacoes_emissao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_empresarial_cotacoes_emissao","parameters":{"data":{"type":"object","required":["canal","meioCanal","nrGrupoProduto","pontoVenda"],"properties":{"canal":{"required":["nmMeioCanal","nrMeioCanal"],"type":"object","properties":{"nmCanal":{"type":"string","description":"Nome do canal de vendas.","example":"Banco do Brasil"},"nrCanal":{"type":"number","description":"Número do canal de vendas.","example":3}}},"meioCanal":{"required":["nmMeioCanal","nrMeioCanal"],"type":"object","properties":{"nmMeioCanal":{"type":"string","example":"P_DEV_BB","description":"Central de Atendimento"},"nrMeioCanal":{"type":"number","example":5,"description":"Número correspondente ao canal (54-SandBox) (43-Ambiente Produtivo)"}}},"pontoVenda":{"required":["nmPontoVenda","nrPontoVenda"],"type":"object","properties":{"nmPontoVenda":{"type":"string","description":"Nome do ponto de venda.","example":"BB Seguros"},"nrPontoVenda":{"type":"number","description":"Número do grupo de produtos.","example":2}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_cotacoes_oferta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_cotacoes_oferta","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"nmIdentificadorOferta":{"type":"string","description":"Nome identificador da oferta.","example":"7de6cc99-c3f1-4ccf-b55d-de3ef57ebc7f"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_cotacoes_objeto_segurado","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_cotacoes_objeto_segurado","parameters":{"data":{"type":"object","required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"3"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","required":["objeto"],"properties":{"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obAgencia(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"1629"}}},"obConta(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"09250924-7"}}},"obInstituicaoFinanceira":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"001"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/put_cotacoes_objeto_segurado","parameters":{"data":{"required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"3"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","properties":{"nmIdentificadorObjetoSegurado":{"type":"string","description":"Identificador único do objeto segurado.","example":"c423e287-a188-4629-9094-871fea0f49f6"},"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obAgencia(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"1629"}}},"obConta(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"09250924-7"}}},"obInstituicaoFinanceira":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"001"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/delete_cotacoes_objeto_segurado","parameters":{"data":{"type":"object","required":["nmIdentificadorObjetoSegurado","localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorObjetoSegurado":{"type":"string","description":"Nome identificador do objeto segurado.","example":"c423e287-a188-4629-9094-871fea0f49f6"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_cotacoes_proponente","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","proponente"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais da proponente titular da cotação.","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"tpProponente":{"type":"object","properties":{"nrProponenteTipo":{"type":"number","example":1,"description":"código do proponente (1)(2)(3)"},"nmDescricao":{"type":"string","example":"Titular","description":"(1-Titular),(2-Conjuge),(3-Mutuario)"}}},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean","example":true},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"type":"string","example":"1","description":"Classificação do tipo do estado civil do proponente"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/put_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","proponente"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais da proponente titular da cotação.","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"tpProponente":{"type":"object","properties":{"nrProponenteTipo":{"type":"number","example":1,"description":"código do proponente (1)(2)(3)"},"nmDescricao":{"type":"string","example":"Titular","description":"(1-Titular),(2-Conjuge),(3-Mutuario)"}}},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean"},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Nicho referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"$ref":"#/components/schemas/EstadoCivil"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/delete_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmCpfCnpj"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ da proponente da cotação.","example":"82038611050"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_cotacoes_plano","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_cotacoes_plano","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorPlano"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlano":{"type":"string","description":"Nome identificador do plano escolhido.","example":"d5200825-d76b-4f94-a5b1-7385580b4e4e"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado.","example":"3"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_cotacoes_periodicidade","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_cotacoes_periodicidade","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorChassi","qtPeriodicidade","nmIdentificadorPeriodicidade"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"aaf35293-fc18-4c6a-bc6a-043e94ea04ac"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"e99a1eeb-2fda-46ed-8d02-e546e62afb94"},"qtPeriodicidade":{"type":"number","description":"Quantidade de parcelas do contrato.","example":1},"nmIdentificadorPeriodicidade":{"type":"string","description":"Nome identificador da periodicidade selecionada.","example":"4a4b0e7a-9c85-4f86-bd92-536cbcade995"},"dtInicioPeriodicidade":{"type":"string","description":"Data de inicio da periodicidade","example":"2023-10-06T09:00:00"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_contratacoes_de_acordo","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_contratacoes_de_acordo","parameters":{"data":{"type":"object","properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_contratacoes_plano_pagamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_contratacoes_plano_pagamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlanoPagamento":{"type":"string","description":"Nome identificador do plano de pagamento selecionado.","example":"f1dc735f-3532-4d85-ab04-a7198fd11ce1"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_contratacoes_plano_pagamento_parcelamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_contratacoes_plano_pagamento_parcelamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231105000005"},"nmIdentificadorParcela":{"type":"string","description":"Nome identificador do parcelamento selecionado.","example":"8a29f51f-fe0d-4ed1-ae93-efc05f138289"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/get_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_contratacoes_contrato_cobranca","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/post_contratacoes_contrato_cobranca","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"dadoCartaoCredito":{"required":["dtExpiracao","nrCartao","nrBandeiraCartao"],"type":"object","description":"Dados do cartão de crédito para pagamento.","properties":{"cdSeguranca":{"type":"string","description":"Código de segurança do cartão.","example":"484"},"dtExpiracao":{"type":"string","description":"Data de expiração do cartão.","example":"09/2023"},"nrCartao":{"type":"string","description":"Número do cartão.","example":"5226662239152154"},"nrBandeiraCartao":{"type":"number","description":"Número da bandeira do cartão.","example":5}}},"dadoDebitoConta":{"required":["nmNumeroConta","nrAgencia","nrBanco"],"type":"object","description":"Dados da conta de débito para pagamento. (Não está habilitado)","properties":{"nmNumeroConta":{"type":"string","description":"Número da conta.","example":"12313455"},"nmContaDigito":{"type":"string","description":"Dígito da conta.","example":"1"},"nrAgencia":{"type":"string","description":"Número da agência.","example":"0002"},"nmAgenciaDigito":{"type":"string","description":"Dígito da agência.","example":"1"},"nrBanco":{"type":"number","description":"Número do banco.","example":1},"inPagamentoAto":{"type":"string","example":"1"}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/parameters_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_empresarial/get_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_acessos_token","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_acessos_token","parameters":{"data":{"type":"object","required":["codigoBalcaoVenda","codigoCanalVendaBalcao","codigoSecaoAtendimento","numeroTipoPessoa","textoCpfCadastroNacPessoasJuridicas"],"properties":{"codigoBalcaoVenda":{"type":"number","description":"Código do balcão de venda contidos na plataforma maestro (Utilizar 1103).","example":1459},"codigoCanalVendaBalcao":{"type":"number","description":"Código do canal de vendas do balcão contidos na plataforma maestro.","example":1},"codigoSecaoAtendimento":{"type":"string","description":"Código da sessão de atendimento da vendo do produto.","example":"450a6382-0791-47c6-90c7-fb296dc8c7fd"},"numeroTipoPessoa":{"type":"number","description":"Código do tipo da pessoa da pessoa (1-Pessoa Fisica) (2-Pessoa Juridica)","example":1},"textoCpfCadastroNacPessoasJuridicas":{"type":"string","description":"Número do CPF ou CNPJ do cliente que esta adiquirindo o produto.","example":"35369157871"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_cotacoes_emissao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_cotacoes_emissao","parameters":{"data":{"type":"object","required":["canal","meioCanal","nrGrupoProduto","pontoVenda"],"properties":{"canal":{"required":["nmMeioCanal","nrMeioCanal"],"type":"object","properties":{"nmCanal":{"type":"string","description":"Nome do canal de vendas.","example":"Brasilseg"},"nrCanal":{"type":"number","description":"Número do canal de vendas.","example":1}}},"meioCanal":{"required":["nmMeioCanal","nrMeioCanal"],"type":"object","properties":{"nmMeioCanal":{"type":"string","example":"P_DEV_BB","description":"Sempre Informar P_DEV_BB"},"nrMeioCanal":{"type":"number","example":43,"description":"Número correspondente ao canal (54-SandBox) (43-Ambiente Produtivo)"}}},"pontoVenda":{"required":["nmPontoVenda","nrPontoVenda"],"type":"object","properties":{"nmPontoVenda":{"type":"string","description":"Nome do ponto de venda.","example":"BB Seguros"},"nrPontoVenda":{"type":"number","description":"Número do grupo de produtos.","example":2}}},"nrGrupoProduto":{"type":"string","description":"Número do grupo de produtos.","example":"0171"},"nrOferta":{"type":"number","description":"Número da oferta. (FIXO)","example":10615},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais do proponente titular da cotação, Caso ja informe um poponente na cotação não havera necessidade de chamar o serviço: /seguros/v1/cotacoes/proponente\n","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean","example":true},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Nicho referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"$ref":"#/components/schemas/TipoEstadoCivil"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_cotacoes_oferta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_cotacoes_oferta","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"nmIdentificadorOferta":{"type":"string","description":"Nome identificador da oferta.","example":"7de6cc99-c3f1-4ccf-b55d-de3ef57ebc7f"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_cotacoes_proponente","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmCpfCnpj","nmNome","tpGenero","dtNascimento"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador da cotação","example":"20231102000006"},"proponente":{"type":"object","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"31465091050"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Teste Outro Solicitante"},"pessoaFisica":{"type":"object","properties":{"tpGenero":{"$ref":"#/components/schemas/Genero"},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"nmNomeSocial":{"type":"string","description":"Nome social do proponente","example":"Rafael Veloso"}}},"lsEmail":{"type":"array","items":{"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Indicador se o e-mail é principal","example":true},"nmEmail":{"type":"string","description":"Endereço de e-mail","example":"tnasciment@brasilseg.com.br"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsTelefone":{"type":"array","items":{"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Indicador se o telefone é principal","example":true},"nmContato":{"type":"string","description":"Nome do contato","example":"Catia"},"nmDdd":{"type":"string","description":"DDD do telefone","example":"55"},"nmNumero":{"type":"string","description":"Número do telefone","example":"929883022"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}},"lsDocumento":{"type":"array","items":{"type":"object","description":"Lista de documentos do proponente"}},"lsEndereco":{"type":"array","items":{"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Indicador se o endereço é principal","example":true},"nmBairro":{"type":"string","description":"Bairro do endereço","example":"VILA ALEXANDRIA"},"nmCep":{"type":"string","description":"CEP do endereço","example":"04635010"},"nmComplemento":{"type":"string","description":"Complemento do endereço","example":"comercial"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço","example":"R ALBUQUERQUE S MUNIZ"},"nmMunicipio":{"type":"string","description":"Município do endereço","example":"SAO PAULO"},"nmNumero":{"type":"string","description":"Número do endereço","example":"227"},"nmPais":{"type":"string","description":"País do endereço","example":"Brasil"},"nmUf":{"type":"string","description":"Estado do endereço","example":"SP"},"tpEndereco":{"$ref":"#/components/schemas/Endereco"}}}},"tpProponente":{"type":"object","properties":{"nmDescricao":{"type":"string","description":"Descrição do tipo de proponente","example":"pessoa física"},"nrProponenteTipo":{"type":"integer","description":"Número do tipo de proponente","example":1}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/put_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","proponente"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais da proponente titular da cotação.","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"tpProponente":{"type":"object","properties":{"nrProponenteTipo":{"type":"number","example":1,"description":"código do proponente (1)(2)(3)"},"nmDescricao":{"type":"string","example":"Titular","description":"(1-Titular),(2-Conjuge),(3-Mutuario)"}}},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean"},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Nicho referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"$ref":"#/components/schemas/EstadoCivil"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/delete_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmCpfCnpj"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ da proponente da cotação.","example":"82038611050"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_cotacoes_objeto_segurado","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_cotacoes_objeto_segurado","parameters":{"data":{"type":"object","required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","example":"20240827000127"},"nmIdentificadorChassi":{"type":"string","example":"4774692e-752b-495b-a69a-c6d01b08bbdd"},"objetoSegurado":{"type":"object","properties":{"objeto":{"type":"object","properties":{"obNome":{"type":"object","properties":{"nmResposta":{"type":"string","example":"Teste Outro Solicitante"}}},"obCpf":{"type":"object","properties":{"nmResposta":{"type":"string","example":"31465091050"}}},"obSexo":{"type":"object","properties":{"nmResposta":{"type":"string","example":"M"}}},"obDataNascimento":{"type":"object","properties":{"nmResposta":{"type":"string","example":"1986-08-03"}}},"obCodigoOperacaoCredito":{"type":"object","properties":{"nmResposta":{"type":"string","example":"245611219"}}},"obNumeroLinhaCredito":{"type":"object","properties":{"nmResposta":{"type":"integer","example":598}}},"obNumeroItemOperacao":{"type":"object","properties":{"nmResposta":{"type":"string","example":"6"}}},"obNumeroSubContrato":{"type":"object","properties":{"nmResposta":{"type":"string","example":"1"}}},"obNomeLinhaCredito":{"type":"object","properties":{"nmResposta":{"type":"string","example":"RENEGOCIACAO MASSIFICADA PF/ PJ"}}},"obCodigoModalidadeLinhaCredito":{"type":"object","properties":{"nmResposta":{"type":"string","example":"9"}}},"obCodigoProdutoLinhaCredito":{"type":"object","properties":{"nmResposta":{"type":"string","example":"349"}}},"obPrazoEmDias":{"type":"object","properties":{"nmResposta":{"type":"integer","example":1844}}},"obRespostaDps":{"type":"object","properties":{"nmResposta":{"type":"string","example":"Sim"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/put_cotacoes_objeto_segurado","parameters":{"data":{"required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"3"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","properties":{"nmIdentificadorObjetoSegurado":{"type":"string","description":"Identificador único do objeto segurado.","example":"c423e287-a188-4629-9094-871fea0f49f6"},"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obAgencia(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"1629"}}},"obConta(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"09250924-7"}}},"obInstituicaoFinanceira":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"001"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_cotacoes_plano","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_cotacoes_plano","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorPlano"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlano":{"type":"string","description":"Nome identificador do plano escolhido.","example":"d5200825-d76b-4f94-a5b1-7385580b4e4e"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado.","example":"3"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_cotacoes_periodicidade","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_cotacoes_periodicidade","parameters":{"data":{"type":"object","required":["localizadorCotacao","qtPeriodicidade","nmIdentificadorPeriodicidade"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"qtPeriodicidade":{"type":"number","description":"Quantidade de parcelas do contrato.","example":3},"nmIdentificadorPeriodicidade":{"type":"string","description":"Nome identificador da periodicidade selecionada.","example":"dd3b2de0-966a-4257-9166-b64bf9861a77"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_contratacoes_plano_pagamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_contratacoes_plano_pagamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlanoPagamento":{"type":"string","description":"Nome identificador do plano de pagamento selecionado.","example":"f1dc735f-3532-4d85-ab04-a7198fd11ce1"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_contratacoes_plano_pagamento_parcelamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_contratacoes_plano_pagamento_parcelamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231105000005"},"nmIdentificadorParcela":{"type":"string","description":"Nome identificador do parcelamento selecionado.","example":"8a29f51f-fe0d-4ed1-ae93-efc05f138289"},"nrDiaVencimento":{"type":"integer","description":"Dia do vencimento do parcelamento","example":28}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_contratacoes_de_acordo","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_contratacoes_de_acordo","parameters":{"data":{"type":"object","properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/get_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_contratacoes_contrato_cobranca","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/post_contratacoes_contrato_cobranca","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"dadoCartaoCredito":{"required":["dtExpiracao","nrCartao","nrBandeiraCartao"],"type":"object","description":"Dados do cartão de crédito para pagamento.","properties":{"cdSeguranca":{"type":"string","description":"Código de segurança do cartão.","example":"484"},"dtExpiracao":{"type":"string","description":"Data de expiração do cartão.","example":"09/2023"},"nrCartao":{"type":"string","description":"Número do cartão.","example":"5226662239152154"},"nrBandeiraCartao":{"type":"number","description":"Número da bandeira do cartão.","example":5}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/parameters_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_protecao_pessoal/get_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_acessos_token","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_acessos_token","parameters":{"data":{"type":"object","required":["codigoBalcaoVenda","codigoCanalVendaBalcao","codigoSecaoAtendimento","numeroTipoPessoa","textoCpfCadastroNacPessoasJuridicas"],"properties":{"codigoBalcaoVenda":{"type":"number","description":"Código do balcão de venda contidos na plataforma maestro (Utilizar 1103).","example":1459},"codigoCanalVendaBalcao":{"type":"number","description":"Código do canal de vendas do balcão contidos na plataforma maestro.","example":1},"codigoSecaoAtendimento":{"type":"string","description":"Código da sessão de atendimento da vendo do produto.","example":" 450a6382-0791-47c6-90c7-fb296dc8c7fd"},"numeroTipoPessoa":{"type":"number","description":"Código do tipo da pessoa da pessoa (1-Pessoa Fisica) (2-Pessoa Juridica)","example":1},"textoCpfCadastroNacPessoasJuridicas":{"type":"string","description":"Número do CPF ou CNPJ do cliente que esta adiquirindo o produto.","example":"35369157871"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_cotacoes_emissao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_cotacoes_emissao","parameters":{"data":{"type":"object","required":["canal","meioCanal","nrGrupoProduto","pontoVenda"],"properties":{"canal":{"required":["nmMeioCanal","nrMeioCanal"],"type":"object","properties":{"nmCanal":{"type":"string","description":"Nome do canal de vendas.","example":"Banco do Brasil"},"nrCanal":{"type":"number","description":"Número do canal de vendas.","example":3}}},"meioCanal":{"required":["nmMeioCanal","nrMeioCanal"],"type":"object","properties":{"nmMeioCanal":{"type":"string","example":"P_DEV_BB","description":"Central de Atendimento"},"nrMeioCanal":{"type":"number","example":5,"description":"Número correspondente ao canal (54-SandBox) (43-Ambiente Produtivo)"}}},"pontoVenda":{"required":["nmPontoVenda","nrPontoVenda"],"type":"object","properties":{"nmPontoVenda":{"type":"string","description":"Nome do ponto de venda.","example":"BB Seguros"},"nrPontoVenda":{"type":"number","description":"Número do grupo de produtos.","example":2}}},"nrGrupoProduto":{"type":"string","description":"Número do grupo de produtos.","example":"0171"},"nrOferta":{"type":"number","description":"Número da oferta. (FIXO)","example":10615},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais do proponente titular da cotação, Caso ja informe um poponente na cotação não havera necessidade de chamar o serviço: /seguros/v1/cotacoes/proponente\n","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean","example":true},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Nicho referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"$ref":"#/components/schemas/TipoEstadoCivil"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_cotacoes_oferta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_cotacoes_oferta","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"nmIdentificadorOferta":{"type":"string","description":"Nome identificador da oferta.","example":"7de6cc99-c3f1-4ccf-b55d-de3ef57ebc7f"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_cotacoes_objeto_segurado","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_cotacoes_objeto_segurado","parameters":{"data":{"type":"object","required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"3"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","required":["objeto"],"properties":{"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obAgencia(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"1629"}}},"obConta(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"09250924-7"}}},"obInstituicaoFinanceira":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"001"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/put_cotacoes_objeto_segurado","parameters":{"data":{"required":["nmIdentificadorChassi","localizadorCotacao","objetoSegurado"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"dda2861d-2c15-4a82-a38f-5b4b5695597a"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado que será incluído.","example":"3"},"objetoSegurado":{"type":"object","description":"Estrutura do objeto segurado.","properties":{"nmIdentificadorObjetoSegurado":{"type":"string","description":"Identificador único do objeto segurado.","example":"c423e287-a188-4629-9094-871fea0f49f6"},"objeto":{"type":"object","description":"Responsável por armazenar as respostas dos questionários.","properties":{"obAgencia(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"1629"}}},"obConta(comDigito)":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"09250924-7"}}},"obInstituicaoFinanceira":{"type":"object","description":"Propriedade do questionário da conta segurado do produto itens pessoais.","properties":{"nmResposta":{"type":"string","example":"001"}}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/delete_cotacoes_objeto_segurado","parameters":{"data":{"type":"object","required":["nmIdentificadorObjetoSegurado","localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorObjetoSegurado":{"type":"string","description":"Nome identificador do objeto segurado.","example":"c423e287-a188-4629-9094-871fea0f49f6"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_cotacoes_proponente","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","proponente"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais da proponente titular da cotação.","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"tpProponente":{"type":"object","properties":{"nrProponenteTipo":{"type":"number","example":1,"description":"código do proponente (1)(2)(3)"},"nmDescricao":{"type":"string","example":"Titular","description":"(1-Titular),(2-Conjuge),(3-Mutuario)"}}},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean","example":true},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"type":"string","example":"1","description":"Classificação do tipo do estado civil do proponente"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/put_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","proponente"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"proponente":{"required":["nmCpfCnpj","nmNome"],"type":"object","description":"Informações gerais da proponente titular da cotação.","properties":{"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ do contratante.","example":"83696083615"},"nmNome":{"type":"string","description":"Nome completo do contratante.","example":"Raimundo Lucca Caleb da Mota"},"nrCodigoMci":{"type":"number","example":0,"description":"Codigo do cliente no Banco do Brasil"},"tpProponente":{"type":"object","properties":{"nrProponenteTipo":{"type":"number","example":1,"description":"código do proponente (1)(2)(3)"},"nmDescricao":{"type":"string","example":"Titular","description":"(1-Titular),(2-Conjuge),(3-Mutuario)"}}},"pessoaFisica":{"type":"object","properties":{"ppe":{"required":["inPPE"],"type":"object","properties":{"dtFim":{"type":"string","example":"1988-10-05T00:00:00","description":"data do fim"},"dtInicio":{"type":"string","example":"1988-10-05T00:00:00","description":"data do inicio"},"inPPE":{"type":"boolean","example":false,"description":"Indica se há ppe"}}},"dtNascimento":{"type":"string","description":"Data de nascimento do proponente","example":"1988-10-05T00:00:00"},"inUniaoEstavel":{"description":"Indicativo de união estavel","type":"boolean"},"nmFormaTratamento":{"type":"string","description":"Pronome de tratamento que o proponente deve ser referido","example":"Sr."},"nmNicho":{"type":"string","example":"Varejo","description":"Nicho referente ao tipo da carteira."},"nmNomeSocial":{"type":"string","example":"Raimundo","description":"Nome social do proponente"},"tpEstadoCivil":{"$ref":"#/components/schemas/EstadoCivil"},"tpGenero":{"$ref":"#/components/schemas/Genero"},"vlRenda":{"type":"number","example":10000,"description":"Valor da renda mensal do proponente"},"vlScore":{"type":"number","example":0,"description":"Valor do score do proponente em relação ao serviço de analises de credito"}}},"lsDocumento":{"type":"array","description":"Lista de documentos.","items":{"type":"object","properties":{"dtEmissao":{"type":"string","description":"Data de emissão do documento.","example":"1998-10-05T00:00:00"},"nmIdentificadorDocumento":{"type":"string","description":"Nome identificador do documento.","example":"182301709"},"nmNumeroDocumento":{"type":"string","description":"Número do documento cadastrado em texto.","example":"Carteira de identidade"},"nmOrgaoExpedidor":{"type":"string","description":"Nome do orgão expedidor do documento.","example":"SSP"},"tpDocumento":{"$ref":"#/components/schemas/Documento"}}}},"lsEmail":{"type":"array","description":"Lista de emails cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o email principal.","example":1},"nmEmail":{"type":"string","description":"Email cadastrado.","example":"raimundo@email.com"},"tpEmail":{"$ref":"#/components/schemas/Email"}}}},"lsEndereco":{"type":"array","description":"Lista de endereços cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmCep","nmNumero","tpEndereco"],"type":"object","properties":{"inPrincipal":{"type":"boolean","description":"Sinalizador para verificar se é o endereço principal."},"tpEndereco":{"$ref":"#/components/schemas/Endereco"},"nmBairro":{"type":"string","description":"Nome do bairro.","example":"Garrote"},"nmCep":{"type":"string","description":"CEP do endereço em forma de texto.","example":"61617024"},"nmComplemento":{"type":"string","description":"Complemento do endereço.","example":"Casa"},"nmLogradouro":{"type":"string","description":"Logradouro do endereço.","example":"Rua Santo Antônio"},"nmMunicipio":{"type":"string","description":"Município do endereço.","example":"Caucaia"},"nmNumero":{"type":"string","description":"Número do endereço.","example":"984"},"nmUf":{"type":"string","description":"Nome do estado ao qual pertence o endereço.","example":"CE"}}}},"lsTelefone":{"type":"array","description":"Lista de telefones cadastrados. É necessário ter pelo menos um item da lista com a flag inPrincipal igual true","items":{"required":["nmDdd","nmNumero"],"type":"object","properties":{"inPrincipal":{"type":"number","description":"Sinalizador para verificar se é o telefone principal.","example":1},"nmContato":{"type":"string","description":"Nome associado ao telefone.","example":"Raimundo"},"nmDdd":{"type":"string","description":"DDD do telefone.","example":"11"},"nmNumero":{"type":"string","description":"Número do telefone.","example":"995928640"},"tpTelefone":{"$ref":"#/components/schemas/Telefone"}}}}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/delete_cotacoes_proponente","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmCpfCnpj"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220916000039"},"nmCpfCnpj":{"type":"string","description":"CPF/CNPJ da proponente da cotação.","example":"82038611050"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_cotacoes_plano","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_cotacoes_plano","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorPlano"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlano":{"type":"string","description":"Nome identificador do plano escolhido.","example":"d5200825-d76b-4f94-a5b1-7385580b4e4e"},"nrTipoObjetoSegurado":{"type":"string","description":"Tipo do objeto segurado.","example":"3"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_cotacoes_periodicidade","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_cotacoes_periodicidade","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorChassi","qtPeriodicidade","nmIdentificadorPeriodicidade"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"aaf35293-fc18-4c6a-bc6a-043e94ea04ac"},"nmIdentificadorChassi":{"type":"string","description":"Nome identificador do Chassi.","example":"e99a1eeb-2fda-46ed-8d02-e546e62afb94"},"qtPeriodicidade":{"type":"number","description":"Quantidade de parcelas do contrato.","example":1},"nmIdentificadorPeriodicidade":{"type":"string","description":"Nome identificador da periodicidade selecionada.","example":"4a4b0e7a-9c85-4f86-bd92-536cbcade995"},"dtInicioPeriodicidade":{"type":"string","description":"Data de inicio da periodicidade","example":"2023-10-06T09:00:00"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_cotacoes_plano_beneficio","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_cotacoes_plano_beneficio","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorPlanoChassi","nmIdentificadorPlano","nmIdentificadorBeneficio"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"nmIdentificadorPlanoChassi":{"type":"string","description":"Nome identificador do plano de chassi.","example":"a1ddf59a-57ed-45c6-88cd-28a68185683d"},"nmIdentificadorPlano":{"type":"string","description":"Nome identificador do plano selecionado.","example":"32be02ed-fbd5-4241-b640-35f70261900f"},"nmIdentificadorBeneficio":{"type":"string","description":"Nome identificador do benefício selecionado.","example":"abb87fd1-c995-4a51-9059-a61cd185bc22"},"cdEnderecoEntrega":{"type":"number","description":"Código do endereço de entrega.","example":1}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_contratacoes_de_acordo","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_contratacoes_de_acordo","parameters":{"data":{"type":"object","properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_contratacoes_plano_pagamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_contratacoes_plano_pagamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231102000006"},"nmIdentificadorPlanoPagamento":{"type":"string","description":"Nome identificador do plano de pagamento selecionado.","example":"f1dc735f-3532-4d85-ab04-a7198fd11ce1"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_contratacoes_plano_pagamento_parcelamento","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_contratacoes_plano_pagamento_parcelamento","parameters":{"data":{"type":"object","required":["localizadorCotacao","nmIdentificadorParcela"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20231105000005"},"nmIdentificadorParcela":{"type":"string","description":"Nome identificador do parcelamento selecionado.","example":"8a29f51f-fe0d-4ed1-ae93-efc05f138289"}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/get_contratacoes_bandeira_cartao","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_contratacoes_contrato_cobranca","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/post_contratacoes_contrato_cobranca","parameters":{"data":{"type":"object","required":["localizadorCotacao"],"properties":{"localizadorCotacao":{"type":"string","description":"Localizador único da cotação.","example":"20220706000126"},"dadoCartaoCredito":{"required":["dtExpiracao","nrCartao","nrBandeiraCartao"],"type":"object","description":"Dados do cartão de crédito para pagamento.","properties":{"cdSeguranca":{"type":"string","description":"Código de segurança do cartão.","example":"484"},"dtExpiracao":{"type":"string","description":"Data de expiração do cartão.","example":"09/2023"},"nrCartao":{"type":"string","description":"Número do cartão.","example":"5226662239152154"},"nrBandeiraCartao":{"type":"number","description":"Número da bandeira do cartão.","example":5}}},"dadoDebitoConta":{"required":["nmNumeroConta","nrAgencia","nrBanco"],"type":"object","description":"Dados da conta de débito para pagamento. (Não está habilitado)","properties":{"nmNumeroConta":{"type":"string","description":"Número da conta.","example":"12313455"},"nmContaDigito":{"type":"string","description":"Dígito da conta.","example":"1"},"nrAgencia":{"type":"string","description":"Número da agência.","example":"0002"},"nmAgenciaDigito":{"type":"string","description":"Dígito da agência.","example":"1"},"nrBanco":{"type":"number","description":"Número do banco.","example":1},"inPagamentoAto":{"type":"string","example":"1"}}}}}}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/parameters_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"seguro_residencial/get_consultas_pdf_proposta","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"servicos_de_arrecadacao/parameters_arrecadacoes","parameters":{}},{"connectionName":"banco-do-brasil","actionName":"servicos_de_arrecadacao/post_arrecadacoes","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"data":{"type":"object","properties":{"codigoClienteSolicitacao":{"type":"integer","description":"Código que identifica o parceiro de arrecadação no Banco do Brasil","example":1},"codigoBarraDigitado":{"type":"string","description":"Código de barras digitado (48 posições). Obs: Deve ser informado o campo Barra Digitada ou Barra Capturada","example":"846600000000579901090111004593766944301423277708"},"codigoBarraCapturado":{"type":"string","description":"Código de barras capturado (44 posições). Obs: Deve ser informado o campo Barra Digitada ou Barra Capturada","example":"84660000000579901090110045937669430142327770"},"valorPagamento":{"type":"number","description":"Valor Pagamento da guia de arrecadação","example":57.99,"format":"double"}},"required":{"0":"codigoClienteSolicitacao","1":"valorPagamento"}}}},{"connectionName":"banco-do-brasil","actionName":"servicos_de_arrecadacao/post_liquidar_guia","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"data":{"type":"object","properties":{"codigoClienteSolicitacao":{"type":"integer","description":"Código que identifica o parceiro de arrecadação no Banco do Brasil","example":1},"valorPagamento":{"type":"number","description":"Valor Pagamento da guia de arrecadação","example":57.99,"format":"double"},"codigoBarraDigitado":{"type":"string","description":"Código de barras digitado (48 posições). Obs: Deve ser informado o campo Barra Digitada ou Barra Capturada","example":"846600000000579901090111004593766944301423277708"},"codigoBarraCapturado":{"type":"string","description":"Código de barras capturado (44 posições). Obs: Deve ser informado o campo Barra Digitada ou Barra Capturada","example":"84660000000579901090110045937669430142327770"},"codigoConciliacao":{"type":"string","example":"API22018075654886620","description":"Este campo determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao parceiro a funcionalidade de conciliação da sua solicitação de pagamento junto ao BB."}},"required":{"0":"codigoClienteSolicitacao","1":"valorPagamento","2":"codigoConciliacao"}}}},{"connectionName":"banco-do-brasil","actionName":"servicos_de_arrecadacao/get_pagamentos","parameters":{"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"codigoParceiro":{"type":"number","description":"Código do Parceiro de Arrecadação junto ao BB."},"codigoConciliacao":{"type":"string","description":"Este campo determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao parceiro a funcionalidade de conciliação da sua solicitação de pagamento junto ao BB."}}},{"connectionName":"banco-do-brasil","actionName":"simulacao_de_pagar_boleto/parameters_boletos_cobranca_by_linha_digitavel_pagar","parameters":{"linhaDigitavel":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"simulacao_de_pagar_boleto/post_boletos_cobranca_by_linha_digitavel_pagar","parameters":{"linhaDigitavel":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"validacao_de_contas/parameters_contas_by_agencia_by_conta_situacao","parameters":{"agencia":{"type":"string"},"conta":{"type":"string"}}},{"connectionName":"banco-do-brasil","actionName":"validacao_de_contas/get_contas_by_agencia_by_conta_situacao","parameters":{"agencia":{"type":"string"},"conta":{"type":"string"},"Authorization":{"type":"string","description":"É o valor do token de acesso fornecido pelo OAuth."},"gw-dev-app-key":{"type":"string","description":"É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo."},"cpfCnpj":{"type":"integer","description":"Número do CPF ou CNPJ do cliente. Somente números."}}}],"slug":"banco-do-brasil","created_at":"2025-09-25T18:49:39.433Z"},{"id":"bling","name":"Bling","description":"Manage your retail operations with Bling ERP.","logo_url":"https://assets.abstra.cloud/connectors/logos/bling.svg","category":[],"setup_instructions":"Manage your retail operations with Bling ERP.","triggers":[],"actions":[],"slug":"bling","created_at":"2025-09-25T18:49:39.472Z"},{"id":"bradesco","name":"Bradesco","description":"Manage your banking and insurance services with Bradesco.","logo_url":"https://assets.abstra.cloud/connectors/logos/bradesco.png","category":[],"triggers":[],"actions":[{"connectionName":"bradesco","actionName":"auto_api_apolicesarenovar/post_apolices_renovar","parameters":{"data":{"type":"object","properties":{"autenticacao":{"$ref":"#/components/schemas/Autenticacao","description":"Dados de autenticação"},"filtros":{"$ref":"#/components/schemas/Filtros","description":"Filtros para renovação de apólices"}},"required":["autenticacao"]}}},{"connectionName":"bradesco","actionName":"auto_api_autenticacao/post","parameters":{}},{"connectionName":"bradesco","actionName":"auto_api_cancelaverbadce/post_cancelar_verba","parameters":{"data":{"type":"object","properties":{"autenticacao":{"$ref":"#/components/schemas/Autenticacao","description":"Informações de autenticação"},"lancamento":{"$ref":"#/components/schemas/LancamentoIn","description":"Informações do lançamento"}},"required":["autenticacao","lancamento"]}}},{"connectionName":"bradesco","actionName":"auto_api_downloadparcela/post_download_parcela","parameters":{"data":{"type":"object","properties":{"autenticacao":{"$ref":"#/components/schemas/Autenticacao","description":"Informações de autenticação"},"parcela":{"$ref":"#/components/schemas/DadosGeraBoletoSegundaViaAutoDto","description":"Dados da parcela para geração da segunda via do boleto"}},"required":["autenticacao","parcela"]}}},{"connectionName":"bradesco","actionName":"auto_api_efetivarproposta/post_efetivar_cotacao","parameters":{"data":{"type":"object","properties":{"autenticacao":{"$ref":"#/components/schemas/Autenticacao","description":"Dados de autenticação"},"eEfetivarCotacaoVoIn":{"$ref":"#/components/schemas/EEfetivarCotacaoVoIn","description":"Dados da efetivação da cotação"}},"required":["autenticacao","eEfetivarCotacaoVoIn"]}}},{"connectionName":"bradesco","actionName":"auto_api_enquadramentov2/post_v2_enquadramento_produto","parameters":{"data":{"type":"object","properties":{"autenticacao":{"$ref":"#/components/schemas/Autenticacao","description":"Autenticação do usuário"},"cotacao":{"$ref":"#/components/schemas/CotacaoAltoValorRestVo","description":"Cotação de alto valor"}}}}},{"connectionName":"bradesco","actionName":"auto_api_impresaocsp/post_ccb","parameters":{"data":{"type":"object","properties":{"nuProposta":{"type":"integer"},"cdSucursal":{"type":"integer","description":"Código da sucursal","example":678},"cdCorretor":{"type":"integer","description":"Código do corretor","example":987654321},"cnpjProvedor":{"type":"integer","description":"CNPJ do provedor","example":12345678000199},"cpfCnpjCorretor":{"type":"integer","description":"CPF ou CNPJ do corretor","example":12345678901}},"required":["nuProposta","cdSucursal","cdCorretor","cnpjProvedor","cpfCnpjCorretor"]}}},{"connectionName":"bradesco","actionName":"auto_api_impresaocsp/post_proposta_vendas","parameters":{"data":{"type":"object","properties":{"cdCorretor":{"type":"integer","description":"Código do corretor","example":12345},"cdEspecieSeguro":{"type":"integer","description":"Código da espécie do seguro","example":678},"cdModalidade":{"type":"string","description":"Código da modalidade","example":"MOD123"},"cdSucursal":{"type":"integer","description":"Código da sucursal","example":910},"flHabilitarDesconto":{"type":"string","description":"Flag para habilitar desconto","example":"S"},"nuCpfCnpjCorretor":{"type":"integer","description":"Número do CPF ou CNPJ do corretor","example":12345678901},"nuProposta":{"type":"string","description":"Número da proposta","example":"PROP456"},"cnpjProvedor":{"type":"integer","description":"CNPJ do provedor","example":9876543210001}},"required":["nuProposta","cdSucursal","cdCorretor","cnpjProvedor","nuCpfCnpjCorretor"]}}},{"connectionName":"bradesco","actionName":"auto_api_impresaocsp/post_cotacao_vendas","parameters":{"data":{"type":"object","properties":{"nuCotacao":{"type":"string","description":"Número da cotação","example":"123456"},"cdSucursal":{"type":"integer","description":"Código da sucursal","example":1},"cdCorretor":{"type":"integer","description":"Código do corretor","example":123456789},"cnpjProvedor":{"type":"integer","description":"CNPJ do provedor","example":12345678000199},"cpfCnpjCorretor":{"type":"integer","description":"CPF ou CNPJ do corretor","example":12345678901},"cdItem":{"type":"string","description":"Código do item","example":"ITEM123"},"cdModalidade":{"type":"string","description":"Código da modalidade","example":"MOD123"},"flHabilitarDesconto":{"type":"string","description":"Flag para habilitar desconto","example":"S"}},"required":["nuCotacao","cdSucursal","cdCorretor","cnpjProvedor","cpfCnpjCorretor"]}}},{"connectionName":"bradesco","actionName":"auto_api_listaveiculos/post_veiculo","parameters":{"data":{"type":"object","properties":{"provedor":{"type":"integer","format":"int64","description":"Provedor de autenticação","example":1},"usuario":{"type":"string","description":"Nome de usuário","example":"usuario123"},"senha":{"type":"string","description":"Senha do usuário","example":"senhaSegura123"}},"required":["provedor","usuario","senha"]}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_alteracao_cadastral_v1_0/post_tcap_proposta_v1_listar_propostas","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string"},"sentido":{"type":"string"},"numAtendimento":{"type":"string"},"numPlano":{"type":"string"},"numAquisicao":{"type":"string"},"maxOcorrencia":{"type":"string"},"agencia":{"type":"string"},"conta":{"type":"string"},"tpTitular":{"type":"string"},"tpBusca":{"type":"string"},"tpPgto":{"type":"string"},"tpVisualizacao":{"type":"string"},"dataInicio":{"type":"string"},"dataFim":{"type":"string"},"qtdDiasCorridos":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_alteracao_cadastral_v1_0/post_tcap_titulos_v1_listar_titulos","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string"},"conta":{"type":"string"},"cpfCnpj":{"type":"string"},"fim":{"type":"array","items":{"$ref":"#/components/schemas/Fim"}},"inicio":{"type":"array","items":{"$ref":"#/components/schemas/Inicio"}},"maxOcorrencias":{"type":"string"},"midia":{"type":"string"},"sentido":{"type":"string"},"tpBusca":{"type":"string"},"tpPgto":{"type":"string"},"tpTitularidade":{"type":"string"},"tpVisualizacao":{"type":"string"}},"title":"ListarTitulosRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_alteracao_cadastral_v1_0/post_tcap_cliente_v1_consultar_nome_titular_subscritor","parameters":{"data":{"type":"object","properties":{"codModalidade":{"type":"string","description":"\"Codigo modalidade.\n Numerico(1)\"\n"},"cpfSubscritor":{"type":"string","description":"CPF/CNPJ do subscritor.\n String(14)\n"},"cpfTitular":{"type":"string","description":"CPF/CNPJ do titular. String(14)\n"},"midia":{"type":"string","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"}},"title":"NomeTitularSubscritorRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_alteracao_cadastral_v1_0/post_tcap_proposta_v1_detalhar_informacoes_proposta_capitalizacao","parameters":{"data":{"type":"object","properties":{"centroCusto":{"description":"Centro de custo. \n Numerico(4)\n","type":"string"},"cpf":{"description":"Número do CPF/CNPJ.\n String(11)\n","type":"string"},"midia":{"description":"\"Canal de Contratação.\n Inteiro(3)\"\n","type":"string"},"modalidade":{"description":"Modalidade da capitalizaçã. \n Numerico(1)\n","type":"integer"},"numAquisicao":{"description":"Numero de proposta de aquisicao do titulo. \n String(10)\n","type":"string"},"numPlano":{"description":"\"Número do plano.\n Inteiro(4)\"\n","type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_alteracao_cadastral_v1_0/post_tcap_proposta_v1_listar_titulares","parameters":{"data":{"type":"object","properties":{"aquisicao":{"description":"Numero de proposta de aquisicao do titulo. \n String(10)\n","type":"string"},"midia":{"description":"\"Canal de Contratação.\n Inteiro(3)\"\n","type":"string"},"planoCaptz":{"description":"\"Número do plano.\n Inteiro(4)\"\n","type":"string"},"serie":{"description":"Numero da serie. \n Numerico(4)\n","type":"string"},"titulo":{"description":"Numero do titulo. \n Numerico(7)\n","type":"string"},"tpBusca":{"description":"Tipo de busca. \n 1 - Listar titulares da proposta; \n 2 - Listar titulares do titulo.\n String(1)\n","type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_planos_v1_produtos_canal","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"modalidade":{"type":"string","description":"Código da modalidade \n Inteiro(3)"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_aquisicao_v1_validar_documento","parameters":{"data":{"type":"object","properties":{"documento":{"type":"string","description":"Documento do cliente"},"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_cliente_v1_buscar_dados_cliente","parameters":{"data":{"type":"object","properties":{"club":{"type":"string"},"midia":{"type":"string"},"tpPartc":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_cliente_v1_consultar_cliente","parameters":{"data":{"type":"object","properties":{"cpf":{"type":"string","description":"\"Numero base do CPF/CNPJ.\n String(14)\"\n"},"midia":{"type":"integer","format":"int32","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"},"modalidade":{"type":"integer","format":"int32","description":"\"Codigo modalidade.\n Numerico(1)\"\n"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_cliente_v1_incluir_cliente","parameters":{"data":{"type":"object","properties":{"modalidade":{"type":"integer","format":"int64","example":1},"plano":{"type":"integer","format":"int64","example":198772},"cpfCnpj":{"type":"string","description":"Documento CPF/CNPJ","example":"12345678"},"declaraPep":{"type":"string","description":"Se declara pessoa publicamente exposta\n* 1 - NÃO\n* 2 - SIM\n","example":"1"},"temRelacPep":{"type":"string","description":"Cliente possui algum relacionamento com PEP"},"autConsBancCentral":{"type":"string","description":"Cliente autoriza consulta de informacoes de credito do Banco Central.\n * N - NÃO\n * S - SIM\n"},"admFundos":{"type":"string","description":"Cliente realiza operacao de investimentos em nome de terceiros"},"autorTransmissao":{"type":"string","description":"Cliente autoriza a transmissao de ordens por procurador"},"mobilidadeReduzida":{"type":"string","description":"Cliente apresenta mobilidade reduzida ou possui deficiencia.\n* 0 - NÃO POSSUI\n* 1 - FISICA \n* 2 - VISUAL \n* 3 - MENTAL \n* 4 - AUDITIVA \n* 5 - MOBILIDADE REDUZIDA\n","example":"0"},"nomeCliente":{"type":"string","description":"Nome do cliente","example":"Fulano Beltrano"},"dataNasc":{"type":"string","description":"Data de nascimento. Obrigatorio para cadastrar no PSDC","example":"25.05.1995"},"sexo":{"type":"string","description":"Obrigatorio para cadastrar no PSDC.\n * F - Feminino\n * M - Masculino\n","example":"F"},"nascPais":{"type":"string","description":"Codigo dos paises de nascimento do cliente Default = 46 Brasil","example":"46"},"nascUF":{"type":"integer","description":"Codigo das Unidades Federativas onde nasceu o cliente","example":54},"siglaNascUF":{"type":"string","description":"Unidades Federativas onde nasceu o cliente","example":"GO"},"municipioNasc":{"type":"integer","description":"Codigo dos municipios onde nasceu o cliente","example":28147},"nomeMunicipioNasc":{"type":"string","description":"Nome do municipio onde nasceu o cliente","example":"SAO JOSE DOS CAMPOS"},"idMae":{"type":"integer","description":"Identificador se preenchido ou nao o nome da mãe.\n * 0 - PREENCHIDO\n * 1 - DESCONHECIDO\n * 2 - NÃO TEM\n * 3 - NÃO INFORMADO\n","example":1},"nomeMae":{"type":"string","description":"Nome da mãe completo","example":54},"idPai":{"type":"integer","description":"Identificador se preenchido ou nao o nome do pai.\n* 0 - PREENCHIDO\n* 1 - DESCONHECIDO\n* 2 - NÃO TEM\n* 3 - NÃO INFORMADO\n","example":1},"nomePai":{"type":"string","description":"Nome do pai completo"},"estadoCivil":{"type":"integer","description":"Codigo do estado civil","example":2},"cpfConjugado":{"type":"string","description":"CPF do conjuge se tiver.","example":"32356789"},"conjugadoCompleto":{"type":"string","description":"Nome do conjuge","example":"Ciclana Beltrana"},"quantidadeDocumentos":{"type":"string","description":"Quantidade de documentos enviados Pode enviar até 4 documentos","example":"2"},"listaAreaDocumento":{"type":"array","items":{"$ref":"#/components/schemas/AreaDocumento"}},"quantidadeEndereco":{"type":"string","description":"Quantidade de enderecos enviados. Até 5"},"listaAreaEndereco":{"type":"array","items":{"$ref":"#/components/schemas/AreaEndereco"}},"quantidadeTelefone":{"type":"integer","description":"Quantidade de telefones enviado. Pode ate 5"},"listaAreaTelefone":{"type":"array","items":{"$ref":"#/components/schemas/AreaTelefone"}},"quantidadeEnderecoEletronico":{"type":"integer","description":"Quantidade de endereco eletronico. Pode ate 5"},"listaAreaEnderecoEletronico":{"type":"array","items":{"$ref":"#/components/schemas/AreaEnderecoEletronico"}},"dadosProfissional":{"$ref":"#/components/schemas/DadosProfissional"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_planos_v1_plano","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string"},"numPlano":{"type":"string"}},"title":"PlanoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_planos_v1_listar_planos_compativeis","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string"},"codModalidade":{"type":"string"},"conta":{"type":"string"},"cpf":{"type":"string"},"formaPgto":{"type":"string"},"midia":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_aquisicao_v1_informacao_plano_aquisicao","parameters":{"data":{"type":"object","properties":{"codModalidade":{"type":"string","description":"Código da modalidade \n inteiro(1)"},"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"numPlano":{"type":"string","description":"Número do plano \n Inteiro(4)"},"vlrParcelaTitulo":{"type":"string","description":"Valor da Parcela do título \n Inteiro(13) "}},"title":"InformacaoPlanoAquisicaoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_planos_v1_probabilidade_tipo_sorteio_plano","parameters":{"data":{"type":"object","properties":{"codModalidade":{"type":"integer","format":"int32","description":"Código da modalidade \n Inteiro(3)"},"midia":{"type":"integer","format":"int32","description":"Canal de Contratação \n Inteiro(3)"},"numPlano":{"type":"integer","format":"int32","description":"Número do plano \n Inteiro(4)"}},"title":"ProbabilidadeSorteioRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_planos_v1_quantidade_sorteios","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"modalidade":{"type":"integer","format":"int32","description":"Código da modalidade \n Inteiro(3)"},"numPlano":{"type":"string","description":"Número do plano \n Inteiro(4)"}},"title":"QuantidadeSorteioRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_planos_v1_valores_plano","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"numPlano":{"type":"string","description":"Número do plano \n Inteiro(4)"},"vlrMax":{"type":"string","description":"Valor máximo de parcela do plano \n Numérico(13)"},"vlrMin":{"type":"string","description":"Valor mínimo de parcela do plano \n Numérico(13)"},"vlrMult":{"type":"string","description":"Valor múltiplo multiplicador sobre o valor de parcela do plano \n Numérico(5)"}},"title":"ValoresPlanoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_aquisicao_v1_forma_pagamento_produto_aquisicao","parameters":{"data":{"type":"object","properties":{"codModalidade":{"type":"string","description":"Código da modalidade \n inteiro(1)"},"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"numPlano":{"type":"string","description":"Número do plano \n Inteiro(4)"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_planos_v1_cotas_capitalizacao_produto","parameters":{"data":{"type":"object","properties":{"codModalidade":{"type":"string","description":"Código da modalidade \n Inteiro(3)"},"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"numPlano":{"type":"string","description":"Número do plano \n Inteiro(4)"},"vlrParcelaTitulo":{"type":"string","description":"Valor da parcela do título \n Numérico(13)"}},"title":"CotasCapitalizacaoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_proposta_v1_aceitar_recusar_propostas","parameters":{"data":{"type":"object","properties":{"codAceite":{"type":"string","description":"Forma de aceite. \\n D - Digital. \\n String(1)\\n"},"codSubscritor":{"type":"string","description":"Codigo do subscritor. \\n Numerico(10)\\n"},"indAceite":{"type":"string","description":"Indicativo de aceite. \\n String(1)\\n"},"midia":{"type":"string","description":"\\\"Canal de Contratação.\\n"},"numPlano":{"type":"string","description":"\\\"Número do plano.\\n"},"numPropsota":{"type":"string","description":"\\\"Numero da Proposta de aquisição do título de capitalização.\\n"},"solicitacaoUsuario":{"type":"string","description":"Usuário responsável pela solicitação. \\n"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_proposta_v1_efetivar_proposta_pix","parameters":{"data":{"type":"object","properties":{"dadosAtendimento":{"description":"Dados subscritor","$ref":"#/components/schemas/DadosAtendimentoRequest"},"dadosProcurador":{"description":"Dados procurador","$ref":"#/components/schemas/DadosProcuradorRequest"},"dadosSubscritor":{"description":"Dados subscritor","$ref":"#/components/schemas/DadosSubscritorRequest"},"dadosTelefone":{"$ref":"#/components/schemas/DadosTelefoneRequest"},"identQrCode":{"type":"string","description":"Identificador do QR Code\n"},"listaDadosTitular":{"type":"array","items":{"$ref":"#/components/schemas/DadosTitularRequest0"}},"midia":{"type":"integer","format":"int32","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"},"qtdTitulares":{"type":"integer","format":"int32","description":"Quantidade de titulares em cada plano adquirido com valor maximo de 99. \n Numerico(2)\n"}},"title":"EfetivarPropostaPIXRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_proposta_v1_confirmar_pagamento_pix","parameters":{"data":{"type":"object","properties":{"codigoPix":{"type":"string","description":"Codigo string do pix\n String\n"}},"title":"ConfirmacaoPagamentoPIXRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_proposta_v1_efetivar_proposta_pagamento_especie","parameters":{"data":{"type":"object","properties":{"dadosAtendimento":{"$ref":"#/components/schemas/DadosAtendimento"},"dadosSubscritor":{"$ref":"#/components/schemas/DadosSubscritor"},"listaDadosTitular":{"type":"array","items":{"$ref":"#/components/schemas/ListaDadosTitular"}},"midia":{"type":"integer","format":"int32","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"},"qtotTtlar":{"type":"integer","format":"int32"}},"title":"EfetivarpropostapagamentoespecieRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_proposta_v1_liquidar_pagamento_especie","parameters":{"data":{"type":"object","properties":{"midia":{"type":"integer","format":"int32","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"},"numPlano":{"type":"integer","format":"int32","description":"\"Número do plano.\n Inteiro(4)\"\n"},"numProposta":{"type":"integer","format":"int64","description":"\"Numero da Proposta de aquisição do título de capitalização.\n Numerico(10)\"\n"}},"title":"LiquidarPagamentoEspecieRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_proposta_v1_efetivar_proposta","parameters":{"data":{"type":"object","properties":{"dadosTitular":{"type":"array","description":"Dados do Titular","items":{"$ref":"#/components/schemas/DadosTitularRequest"}},"dataDebito":{"type":"string","description":"Data do Debito da primeira parcela dos títulos, efetivando a aquisição.\n String(10)\n"},"diaDebito":{"type":"string","description":"Dia de Debito das demais parcelas dos títulos adquiridos.\n String(2)\n"},"envioCorrespondencia":{"type":"string","description":"Forma de envio de correspondências dos títulos de capitalização. \n 01 - EMAIL\n 02 - Correio\n String(2)\n"},"formaAceite":{"type":"string","description":"Forma de aceite. \n 'D' - Digital.\n 'N' - Normal/Convencional.\n String(1)\n"},"formaPgto":{"type":"string","description":"Forma de pagamento das parcelas do título de capitalização. \n 03 - Boleto de cobrança\n 31 - Débito em conta com consulta\n 37 - Benefício INSS\n String(2)\n"},"indicTitularDiferente":{"type":"string","description":"Indicador de Titular Diferente do Subscritor. \n 'N' - Não\n 'S' - 'Sim\n String(1)\n"},"mesSorteio":{"type":"string","description":"Mes escolhido para o sorteio especial. String(2)\n"},"midia":{"type":"string","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"},"numAtendimento":{"type":"string","description":"\"Numero de atendimento\"\n Numerico(18)\n"},"numPlano":{"type":"string","description":"\"Número do plano.\n Inteiro(4)\"\n"},"procurador":{"description":"Dados do Procurador","$ref":"#/components/schemas/ProcuradorRequest"},"qtdTitulo":{"type":"string","description":"Quantidade de Titulos que serão adquiridos na proposta.\n String(5)\n"},"qtdTotTitular":{"type":"string","description":"Quantidade total titular\n String(3)\n"},"subscritor":{"description":"Dados do Subscritor","$ref":"#/components/schemas/SubscritorRequest"},"tpAcao":{"type":"string","description":"\"Identificador do tipo de ação requerida pelo canal. \n 'V' - Validação\"\n 'E' - Efetivação.\"\n String(1).\n"},"vlrParcela":{"type":"string","description":"Valor da Parcela de cada Título adquirido na proposta.\n String(13.2)\n"}},"title":"PropostaRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_proposta_v1_verificar_titulos_implantados","parameters":{"data":{"type":"object","properties":{"dadosTitular":{"type":"array","description":"Dados do Titular","items":{"$ref":"#/components/schemas/DadosTitularRequest"}},"dataDebito":{"type":"string","description":"Data do Debito da primeira parcela dos títulos, efetivando a aquisição.\n String(10)\n"},"diaDebito":{"type":"string","description":"Dia de Debito das demais parcelas dos títulos adquiridos.\n String(2)\n"},"envioCorrespondencia":{"type":"string","description":"Forma de envio de correspondências dos títulos de capitalização. \n 01 - EMAIL\n 02 - Correio\n String(2)\n"},"formaAceite":{"type":"string","description":"Forma de aceite. \n 'D' - Digital.\n 'N' - Normal/Convencional.\n String(1)\n"},"formaPgto":{"type":"string","description":"Forma de pagamento das parcelas do título de capitalização. \n 03 - Boleto de cobrança\n 31 - Débito em conta com consulta\n 37 - Benefício INSS\n String(2)\n"},"indicTitularDiferente":{"type":"string","description":"Indicador de Titular Diferente do Subscritor. \n 'N' - Não\n 'S' - 'Sim\n String(1)\n"},"mesSorteio":{"type":"string","description":"Mes escolhido para o sorteio especial. String(2)\n"},"midia":{"type":"string","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"},"numAtendimento":{"type":"string","description":"\"Numero de atendimento\"\n Numerico(18)\n"},"numPlano":{"type":"string","description":"\"Número do plano.\n Inteiro(4)\"\n"},"procurador":{"description":"Dados do Procurador","$ref":"#/components/schemas/ProcuradorRequest"},"qtdTitulo":{"type":"string","description":"Quantidade de Titulos que serão adquiridos na proposta.\n String(5)\n"},"qtdTotTitular":{"type":"string","description":"Quantidade total titular\n String(3)\n"},"subscritor":{"description":"Dados do Subscritor","$ref":"#/components/schemas/SubscritorRequest"},"tpAcao":{"type":"string","description":"\"Identificador do tipo de ação requerida pelo canal. \n 'V' - Validação\"\n 'E' - Efetivação.\"\n String(1).\n"},"vlrParcela":{"type":"string","description":"Valor da Parcela de cada Título adquirido na proposta.\n String(13.2)\n"}},"title":"PropostaRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_aquisicao_v1_0/post_tcap_planos_v1_produtos_por_segmento","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string","description":"Código da agência \n Inteiro(5)"},"conta":{"type":"string","description":"Número da Conta \n Inteiro(5)"},"cpfCnpj":{"type":"string","description":"CPF \n Inteiro(11)"},"indicador":{"type":"string","description":"Indicador. \n String(1)"},"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"primeiroNumPlano":{"type":"integer","format":"int64","description":"Primeiro numero do Plano. \n Numerico(4)"},"ultimoNumPlano":{"type":"integer","format":"int64","description":"Ultimo numero do Plano. \n Numerico(4)"}},"title":"ProdutosPorSegmentoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_cancelamento_v1_0/post_tcap_proposta_v1_listar_propostas","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string"},"sentido":{"type":"string"},"numAtendimento":{"type":"string"},"numPlano":{"type":"string"},"numAquisicao":{"type":"string"},"maxOcorrencia":{"type":"string"},"agencia":{"type":"string"},"conta":{"type":"string"},"tpTitular":{"type":"string"},"tpBusca":{"type":"string"},"tpPgto":{"type":"string"},"tpVisualizacao":{"type":"string"},"dataInicio":{"type":"string"},"dataFim":{"type":"string"},"qtdDiasCorridos":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_cancelamento_v1_0/post_tcap_proposta_v1_detalhar_informacoes_proposta_capitalizacao","parameters":{"data":{"type":"object","properties":{"centroCusto":{"description":"Centro de custo. \n Numerico(4)\n","type":"string"},"cpf":{"description":"Número do CPF/CNPJ.\n String(11)\n","type":"string"},"midia":{"description":"\"Canal de Contratação.\n Inteiro(3)\"\n","type":"string"},"modalidade":{"description":"Modalidade da capitalizaçã. \n Numerico(1)\n","type":"integer"},"numAquisicao":{"description":"Numero de proposta de aquisicao do titulo. \n String(10)\n","type":"string"},"numPlano":{"description":"\"Número do plano.\n Inteiro(4)\"\n","type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_cancelamento_v1_0/post_tcap_titulos_v1_listar_titulos","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string"},"conta":{"type":"string"},"fim":{"$ref":"#/components/schemas/Fim"},"inicio":{"$ref":"#/components/schemas/Inicio"},"maxOcorrencias":{"type":"string"},"midia":{"type":"string"},"sentido":{"type":"string"},"tpBusca":{"type":"string"},"tpPgto":{"type":"string"},"tpTitularidade":{"type":"string"},"tpVisualizacao":{"type":"string"}},"title":"ListarTitulosRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_cancelamento_v1_0/post_tcap_proposta_v1_cancelamento_proposta_agendada","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"},"numAquisicao":{"type":"string","description":"Numero de proposta de aquisicao do titulo. \n String(10)\n"},"numPlano":{"type":"string","description":"\"Número do plano.\n Inteiro(4)\"\n"},"tpBusca":{"type":"string","description":"Tipo de busca. \n 1 - Listar titulares da proposta; \n 2 - Listar titulares do titulo.\n String(1)\n"}},"title":"CancelamentoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_cancelamento_v1_0/post_tcap_proposta_v1_cancelamento_proposta_implantada","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"},"numAquisicao":{"type":"string","description":"Numero de proposta de aquisicao do titulo. \n String(10)\n"},"numPlano":{"type":"string","description":"\"Número do plano.\n Inteiro(4)\"\n"},"tpBusca":{"type":"string","description":"Tipo de busca. \n 1 - Listar titulares da proposta; \n 2 - Listar titulares do titulo.\n String(1)\n"}},"title":"CancelamentoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_proposta_v1_listar_propostas","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string"},"sentido":{"type":"string"},"numAtendimento":{"type":"string"},"numPlano":{"type":"string"},"numAquisicao":{"type":"string"},"maxOcorrencia":{"type":"string"},"agencia":{"type":"string"},"conta":{"type":"string"},"tpTitular":{"type":"string"},"tpBusca":{"type":"string"},"tpPgto":{"type":"string"},"tpVisualizacao":{"type":"string"},"dataInicio":{"type":"string"},"dataFim":{"type":"string"},"qtdDiasCorridos":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_titulos_v1_listar_titulos","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string"},"conta":{"type":"string"},"cpfCnpj":{"type":"string"},"fim":{"type":"array","items":{"$ref":"#/components/schemas/Fim"}},"inicio":{"type":"array","items":{"$ref":"#/components/schemas/Inicio"}},"maxOcorrencias":{"type":"string"},"midia":{"type":"string"},"sentido":{"type":"string"},"tpBusca":{"type":"string"},"tpPgto":{"type":"string"},"tpTitularidade":{"type":"string"},"tpVisualizacao":{"type":"string"}},"title":"ListarTitulosRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_titulos_v1_consultar_detalhe_titulo","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"numAquisicao":{"type":"string","description":"Número da proposta de aquisição do título \n Numérico(10)"},"numPlano":{"type":"string","description":"Número do plano \n Inteiro(4)"},"numTitulo":{"type":"string","description":"Número do título \n String(7)"},"seriePlano":{"type":"string","description":"Número da Série do título \n String(4)"},"tpBusca":{"type":"string","description":"Tipo de busca – Lista títulos ativos, – Lista títulos inativos \n Numérico(1) "}},"title":"DetalheTituloRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/get_tcap_titulos_v1_combo_titulos_capitalizacao","parameters":{"aquisicao":{"type":"string","description":"Número da proposta de aquisição do título \n Numérico(10)"},"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"plano":{"type":"string","description":"Número do plano \n Inteiro(4)"},"qtdOcorrencias":{"type":"string","description":"Combo Títulos de Capitalização \n Numérico(3)"},"tpBusca":{"type":"string","description":"Tipo de busca – Lista títulos ativos, – Lista títulos inativos \n Numérico(1) "}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/get_tcap_titulos_v1_titulos_capitalizacao","parameters":{"aquisicao":{"type":"string","description":"Número da proposta de aquisição do título \n Numérico(10)"},"limit":{"type":"string","description":"limit"},"mesAno":{"type":"string","description":"Mês / ano solicitado para o acompanhamento \n String(6)"},"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"plano":{"type":"string","description":"Número do plano \n Inteiro(4)"},"sentido":{"type":"string","description":" Sentido da paginação I - Inicial \n P - Primeira \n S - Seguinte A - Anterior U – Última"},"serieFim":{"type":"string","description":"Último Número de Série para paginação \n Numérico(4)"},"serieInicio":{"type":"string","description":"Primeiro Número de Série para paginação \n Numérico(4)"},"tituloFim":{"type":"string","description":"Último Número de título para paginação \n Numérico(7)"},"tituloInicio":{"type":"string","description":"Primeiro Número de título para paginação \n Numérico(7)"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_titulos_tcap_planos_v1_v1_extrato_consolidado","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string","description":"Agência \n Numérico(6)"},"conta":{"type":"string","description":"Conta \n Numérico(13)"},"cpfCnpj":{"type":"string","description":"CPF \n Inteiro(11)"},"fim":{"type":"array","items":{"$ref":"#/components/schemas/FimExtratoConsolidado"}},"inicio":{"type":"array","items":{"$ref":"#/components/schemas/InicioExtratoConsolidado"}},"maxOcorrencia":{"type":"integer","format":"int32"},"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"sentido":{"type":"string","description":" Sentido da paginação: \n I - Inicial \n P - Primeira \n S - Seguinte \n A - Anterior \n U – Última"},"tpBusca":{"type":"string","description":"Tipo de busca – Lista títulos ativos, – Lista títulos inativos \n Numérico(1) "},"tpConta":{"type":"string","description":"Tipo de titularidade da conta \n Numérico(1)"},"tpPgto":{"type":"string","description":"Periodicidade de pagamento: \n 0 - Todos \n 1 - PM \n 2 - PU \n 3 - PP \n Numérico(1)"},"tpVisualizacao":{"type":"string","description":"Tipo de visualização: \n 0 - Todos \n 1 - SÓ ADQUIRIDOS NO CANAL \n Numérico(1) "}},"title":"ExtratoConsolidadoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/get_tcap_dadosbancarios_v1_verificar_informe_ir","parameters":{"anoCalendario":{"type":"string","description":"Ano Calendário \n String(4)"},"documento":{"type":"string","description":"Canal de Acesso \n Inteiro(3)"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_dadosbancarios_v1_consultar_informe_rendimento","parameters":{"data":{"title":"ConsultarinformerendimentoRequest","type":"object","properties":{"anoRendimento":{"type":"string"},"cpf":{"type":"string"},"identificadorPeriferico":{"type":"string"},"maxOcorrencia":{"type":"string"},"midia":{"type":"string"},"pessoaJuridica":{"type":"string"},"tpPartcPessoa":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_titulos_v1_certificado","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"numAquisicao":{"type":"string","description":"Número da proposta de aquisição do título \n Numérico(10)"},"numPlano":{"type":"string","description":"Número do plano \n Inteiro(4)"},"numSerie":{"type":"string","description":"Número da Série de Títulos \n Numérico(4) "},"numTitulo":{"type":"string","description":"Número do título \n String(7)"}},"title":"ConsultarCertificadoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_titulos_v1_emitir_certificado","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string"},"chaveFim":{"$ref":"#/components/schemas/ChaveFim"},"chaveIni":{"$ref":"#/components/schemas/ChaveIni"},"conta":{"type":"string"},"midia":{"type":"string"},"qtdOcorrencias":{"type":"string"},"sentido":{"type":"string"},"tipoVisualizacao":{"type":"string"},"tpPagamento":{"type":"string"},"tpTitularidade":{"type":"string"}},"title":"EmitirCertificadoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_planos_v1_produtos_por_segmento","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string","description":"Código da agência \n Inteiro(5)"},"conta":{"type":"string","description":"Número da Conta \n Inteiro(5)"},"cpfCnpj":{"type":"string","description":"CPF \n Inteiro(11)"},"indicador":{"type":"string","description":"Indicador. \n String(1)"},"midia":{"type":"string","description":"Canal de Contratação \n Inteiro(3)"},"primeiroNumPlano":{"type":"integer","format":"int64","description":"Primeiro numero do Plano. \n Numerico(4)"},"ultimoNumPlano":{"type":"integer","format":"int64","description":"Ultimo numero do Plano. \n Numerico(4)"}},"title":"ProdutosPorSegmentoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_proposta_v1_detalhar_informacoes_proposta_capitalizacao","parameters":{"data":{"type":"object","properties":{"centroCusto":{"description":"Centro de custo. \n Numerico(4)\n","type":"string"},"cpf":{"description":"Número do CPF/CNPJ.\n String(11)\n","type":"string"},"midia":{"description":"\"Canal de Contratação.\n Inteiro(3)\"\n","type":"string"},"modalidade":{"description":"Modalidade da capitalizaçã. \n Numerico(1)\n","type":"integer"},"numAquisicao":{"description":"Numero de proposta de aquisicao do titulo. \n String(10)\n","type":"string"},"numPlano":{"description":"\"Número do plano.\n Inteiro(4)\"\n","type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_proposta_v1_listar_titulares","parameters":{"data":{"type":"object","properties":{"aquisicao":{"description":"Numero de proposta de aquisicao do titulo. \n String(10)\n","type":"string"},"midia":{"description":"\"Canal de Contratação.\n Inteiro(3)\"\n","type":"string"},"planoCaptz":{"description":"\"Número do plano.\n Inteiro(4)\"\n","type":"string"},"serie":{"description":"Numero da serie. \n Numerico(4)\n","type":"string"},"titulo":{"description":"Numero do titulo. \n Numerico(7)\n","type":"string"},"tpBusca":{"description":"Tipo de busca. \n 1 - Listar titulares da proposta; \n 2 - Listar titulares do titulo.\n String(1)\n","type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_titulos_v1_consultar_total_pago_provisao_matematica_titulos_cliente","parameters":{"data":{"type":"object","properties":{"cpfCnpj":{"type":"string"},"digCpfCnpj":{"type":"string"},"filialCnpj":{"type":"string"},"midia":{"type":"string"},"modalidade":{"type":"string"},"tipoBusca":{"type":"string"}},"title":"TotalPagoProvisaoMatematicaTitulosClienteRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_cliente_v1_listar_comunicados","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"integer","format":"int64"},"conta":{"type":"integer","format":"int64"},"midia":{"type":"integer","format":"int32"},"numFinalProtocolo":{"type":"integer","format":"int64"},"numInicialProtocolo":{"type":"integer","format":"int64"},"numOcorrencias":{"type":"integer","format":"int32"},"sentido":{"type":"string"},"tpBusca":{"type":"integer","format":"int32"},"tpTitularidade":{"type":"integer","format":"int32"}},"title":"ListarComunicadosRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_sorteios_v1_combinacoes","parameters":{"data":{"type":"object","properties":{"maxOcorrencias":{"type":"string"},"midia":{"type":"string"},"numAquisicao":{"type":"string"},"numPlano":{"type":"string"},"numTitulos":{"type":"string"},"serieCaptz":{"type":"string"}},"title":"CombinacoesRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_sorteios_v1_consultar_resultado_sorteios_combinacoes","parameters":{"data":{"type":"object","properties":{"chaveIni":{"$ref":"#/components/schemas/ChaveIni"},"chaveUlt":{"$ref":"#/components/schemas/ChaveUlt"},"dataSorteio":{"type":"string"},"indicadorSentido":{"type":"string"},"midia":{"type":"integer","format":"int32"},"numPlano":{"type":"string"},"tpBusca":{"type":"integer","format":"int32"}},"title":"ConsultarcombinacoesRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_sorteios_v1_listar_resultados_plano","parameters":{"data":{"type":"object","properties":{"fimNumPlano":{"type":"string"},"indicadorSentido":{"type":"string"},"iniNumPlano":{"type":"string"},"midia":{"type":"string"},"numPlano":{"type":"string"}},"title":"ListarResultadoPlanoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_sorteios_v1_proximo_sorteio","parameters":{"data":{"type":"object","properties":{"midia":{"type":"integer","format":"int32"},"numPlano":{"type":"integer","format":"int32"},"numProposta":{"type":"string"}},"title":"ProximoSorteioRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_consulta_v1_0/post_tcap_dadosbancarios_v1_consultar_demonstrativo_detalhado","parameters":{"data":{"type":"object","properties":{"midia":{"description":"Canal de Acesso \n Inteiro(3)","type":"string"},"numAquisicao":{"description":"Número da proposta de aquisição do título \n String(10)","type":"string"},"numPlano":{"description":"Número do plano de capitalização \n String(4)","type":"string"},"numTitulo":{"description":"Número do título \n String(7)","type":"string"},"seriePlanoCaptz":{"description":"Número da Série do título \n String(4)","type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_proposta_v1_propostas_club","parameters":{"data":{"type":"object","properties":{"cpfCnpj":{"type":"string","description":"Código do club do Procurador do subscritor do título de capitalização.\n String(10)\n"},"indPaginacao":{"type":"string","description":"Indicador de paginacao, Iniciar, primeira pagina, voltar pagina e avancar pagina. \n A = Voltar; \n I = Primeira pagina; \n S = Seguinte. \n String(1)\n"},"midia":{"type":"integer","format":"int32","description":"\"Canal de Contratação.\n Inteiro(3)\"\n"},"planoPrimeiro":{"type":"integer","format":"int32","description":"Numero do plano. Informacao para controle de paginacao. \n Numerico(4)\n"},"planoUltimo":{"type":"integer","format":"int32","description":"Numero do plano. Informacao para controle de paginacao. \n Numerico(4)\n"},"propostaPrimeiro":{"type":"string","description":"Valor numero do plano. Informacao para controle de paginacao proposta. \n Numerico(10)\n"},"propostaUltimo":{"type":"string","description":"Numero do plano. Informacao para controle de paginacao. \n Numerico(4)\n"},"tpBusca":{"type":"integer","format":"int32","description":"Tipo de busca. \n 1 - Listar titulares da proposta; \n 2 - Listar titulares do titulo.\n String(1)\n"}},"title":"PropostaClubRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_proposta_passiveis_resgate","parameters":{"data":{"title":"PropostaPassivelResgateRequest","type":"object","properties":{"agencia":{"type":"string"},"conta":{"type":"string"},"cpf":{"type":"string"},"digConta":{"type":"string"},"midia":{"type":"string"},"numPag":{"type":"string"},"qtdLinhas":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_titulos_v1_listar_titulos","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string"},"conta":{"type":"string"},"fim":{"$ref":"#/components/schemas/Fim"},"inicio":{"$ref":"#/components/schemas/Inicio"},"maxOcorrencias":{"type":"string"},"midia":{"type":"string"},"sentido":{"type":"string"},"tpBusca":{"type":"string"},"tpPgto":{"type":"string"},"tpTitularidade":{"type":"string"},"tpVisualizacao":{"type":"string"}},"title":"ListarTitulosRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_listar_titulos_passiveis_resgate","parameters":{"data":{"title":"ListarTitulosPassiveisRequest","type":"object","properties":{"agencia":{"type":"integer","format":"int32"},"conta":{"type":"integer","format":"int32"},"cpfCnpj":{"type":"string"},"midia":{"type":"string"},"numPagina":{"type":"integer","format":"int32"},"numPlano":{"type":"integer","format":"int32"},"numProposta":{"type":"integer","format":"int32"},"qtdLinhas":{"type":"integer","format":"int32"},"tpBusca":{"type":"integer","format":"int32"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_tabela_resgate","parameters":{"data":{"title":"TabelaResgateRequest","type":"object","properties":{"midia":{"type":"string"},"numPlano":{"type":"string"},"vlrParcelaTitulo":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_detalhar_resgate","parameters":{"data":{"title":"DetalharSolicitacaoResgateRequest","type":"object","properties":{"midia":{"type":"string"},"modalidade":{"type":"string"},"numSolicitacao":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_incluir_solicitacao_resgate","parameters":{"data":{"title":"IncluirsolicitacaoderesgateRequest","type":"object","properties":{"banco":{"$ref":"#/components/schemas/Banco"},"midia":{"type":"string"},"representante":{"$ref":"#/components/schemas/Representante"},"solicitacao":{"$ref":"#/components/schemas/Solicitacao1"},"titular":{"$ref":"#/components/schemas/Titular"},"tpBusca":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_cancelar_solicitacao_resgate","parameters":{"data":{"title":"CancelarSolicitacaoResgateRequest","type":"object","properties":{"codModalidade":{"type":"string"},"midia":{"type":"string"},"numResgate":{"type":"string"},"sistema":{"type":"string"},"tpBusca":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_formas_credito_resgate","parameters":{"data":{"type":"object","properties":{"midia":{"description":"Canal de contratação","type":"string"},"modalidade":{"description":"Número da modalidade","type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_planos_v1_probabilidade_contemplacao_resgate","parameters":{"data":{"title":"ProbabilidadeContemplacaoResgateResponse","type":"object","properties":{"cota":{"type":"array","description":"Lista de Cotas","items":{"$ref":"#/components/schemas/Cota"}},"numPlano":{"type":"integer","description":"Número do plano \n Inteiro(4)","format":"int32"},"origemInfo":{"type":"string","description":"Sistema origem da informação de saída \n String(1)"},"qtdNumSerie":{"type":"integer","description":"Quantidade números de Série \n Numérico(7)","format":"int32"},"resgates":{"type":"array","description":"Lista de resgates","items":{"$ref":"#/components/schemas/Resgates"}},"tabelaProbabilidade":{"type":"array","description":"Tabelas de probabilidade","items":{"$ref":"#/components/schemas/TabelaProbabilidade"}},"totOcorrenciasCota":{"type":"integer","description":"Total de ocorrências da lista - Tabela de Cota de Capitalização \n Numérico(3)","format":"int32"},"totOcorrenciasProbabilidade":{"type":"integer","description":"Total de ocorrências da lista – Probabilidade \n Numérico(3)","format":"int32"},"totOcorrenciasResgate":{"type":"integer","description":"Total de ocorrências da lista - Tabela de Resgate \n Numérico(3) ","format":"int32"},"vlrParcela":{"type":"number","description":"Valor da parcela \n Numérico(13)"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_demonstrativo_resgate","parameters":{"data":{"title":"DemonstrativoResgateRequest","type":"object","properties":{"midia":{"type":"string"},"numTitulo":{"type":"string"},"seriePlano":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/put_tcap_proposta_v1_alteracao_proposta_agendada","parameters":{"data":{"title":"AlterarPropostaRequest","type":"object","properties":{"dataDemaisParcelas":{"type":"string","description":"Dia de debito das demais parcelas do titulo. String(2)"},"dataPrimeiraParcela":{"type":"string","description":"Data de pagamento da primeira parcela. String(10)"},"midia":{"type":"string","description":"Canal de Contratação - inteiro(3)"},"numAquisicao":{"type":"string","description":"Numero da proposta de aquisicao de titulo. String(10)"},"numPlano":{"type":"string","description":"Número do plano - inteiro(4)"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_listar_motivos_resgate","parameters":{"data":{"title":"ListarmotivosresgateRequest","type":"object","properties":{"midia":{"type":"string"},"modalidade":{"type":"integer","format":"int32"},"numPlano":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_titulos_v1_consultar_total_pago_provisao_matematica_titulos_cliente","parameters":{"data":{"type":"object","properties":{"cpfCnpj":{"type":"string"},"digCpfCnpj":{"type":"string"},"filialCnpj":{"type":"string"},"midia":{"type":"string"},"modalidade":{"type":"string"},"tipoBusca":{"type":"string"}},"title":"TotalPagoProvisaoMatematicaTitulosClienteRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_resgate_v1_consultar_resgate_pagos","parameters":{"data":{"title":"ConsultarResgatePagosRequest","type":"object","properties":{"anoPesquisa":{"type":"integer","format":"int32"},"indPaginacao":{"type":"string"},"mesPesquisa":{"type":"integer","format":"int32"},"midia":{"type":"integer","format":"int32"},"modalidade":{"type":"integer","format":"int32"},"numOcorrencias":{"type":"integer","format":"int32"},"numPlanoPrimeiraChave":{"type":"integer","format":"int32"},"numPlanoUltimaChave":{"type":"integer","format":"int32"},"numSequenciaPrimeiraChave":{"type":"integer","format":"int32"},"numSequenciaUltimaChave":{"type":"integer","format":"int32"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_resgate_v1_0/post_tcap_sorteios_v1_proximo_sorteio","parameters":{"data":{"type":"object","properties":{"midia":{"type":"integer","format":"int32"},"numPlano":{"type":"integer","format":"int32"},"numProposta":{"type":"string"}},"title":"ProximoSorteioRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_proposta_v1_listar_propostas","parameters":{"data":{"type":"object","properties":{"midia":{"type":"string"},"sentido":{"type":"string"},"numAtendimento":{"type":"string"},"numPlano":{"type":"string"},"numAquisicao":{"type":"string"},"maxOcorrencia":{"type":"string"},"agencia":{"type":"string"},"conta":{"type":"string"},"tpTitular":{"type":"string"},"tpBusca":{"type":"string"},"tpPgto":{"type":"string"},"tpVisualizacao":{"type":"string"},"dataInicio":{"type":"string"},"dataFim":{"type":"string"},"qtdDiasCorridos":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_titulos_v1_listar_titulos","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string"},"conta":{"type":"string"},"fim":{"$ref":"#/components/schemas/Fim"},"inicio":{"$ref":"#/components/schemas/Inicio"},"maxOcorrencias":{"type":"string"},"midia":{"type":"string"},"sentido":{"type":"string"},"tpBusca":{"type":"string"},"tpPgto":{"type":"string"},"tpTitularidade":{"type":"string"},"tpVisualizacao":{"type":"string"}},"title":"ListarTitulosRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_sorteios_v1_consultar_resultados","parameters":{"data":{"type":"object","properties":{"anoSorteio":{"type":"string"},"mesSorteio":{"type":"string"},"midia":{"type":"string"},"numPlano":{"type":"string"},"numSusep":{"type":"string"}}}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_sorteios_v1_combinacoes","parameters":{"data":{"type":"object","properties":{"maxOcorrencias":{"type":"string"},"midia":{"type":"string"},"numAquisicao":{"type":"string"},"numPlano":{"type":"string"},"numTitulos":{"type":"string"},"serieCaptz":{"type":"string"}},"title":"CombinacoesRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_sorteios_v1_listar_combinacoes","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string"},"conta":{"type":"string"},"midia":{"type":"string"},"qtdOcorrencias":{"type":"string"},"tpPgto":{"type":"string"},"tpTitular":{"type":"string"},"tpVisualizacao":{"type":"string"}},"title":"ListarCombinacoesRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_sorteios_v1_listar_premios","parameters":{"data":{"type":"object","properties":{"codModalidade":{"type":"string"},"midia":{"type":"string"},"numPlano":{"type":"string"},"numSusep":{"type":"string"},"vlrParcelaTitulo":{"type":"string"}},"title":"ListarPremioSorteioRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_sorteios_v1_consultar_resultado_sorteios_combinacoes","parameters":{"data":{"type":"object","properties":{"chaveIni":{"$ref":"#/components/schemas/ChaveIni"},"chaveUlt":{"$ref":"#/components/schemas/ChaveUlt"},"dataSorteio":{"type":"string"},"indicadorSentido":{"type":"string"},"midia":{"type":"integer","format":"int32"},"numPlano":{"type":"string"},"tpBusca":{"type":"integer","format":"int32"}},"title":"ConsultarcombinacoesRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_sorteios_v1_listar_resultados","parameters":{"data":{"type":"object","properties":{"agencia":{"type":"string"},"anoSorteio":{"type":"string"},"conta":{"type":"string"},"mesSorteio":{"type":"string"},"midia":{"type":"string"},"tpPgto":{"type":"string"},"tpTitular":{"type":"string"}},"title":"ListarResultadoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_sorteios_v1_listar_resultados_plano","parameters":{"data":{"type":"object","properties":{"fimNumPlano":{"type":"string"},"indicadorSentido":{"type":"string"},"iniNumPlano":{"type":"string"},"midia":{"type":"string"},"numPlano":{"type":"string"}},"title":"ListarResultadoPlanoRequest"}}},{"connectionName":"bradesco","actionName":"capitalizacaocards_jornada_sorteio_v1_0/post_tcap_cliente_v1_obter_pagina_comunicados","parameters":{"data":{"type":"object","properties":{"club":{"description":"\"Código do club do cliente.\n Numerico(10)\"\n","type":"string"},"codForm":{"description":"Codigo interno do formulario Bradesco parametrizado para a impressao de documentos.\n Numerico(5)\n","type":"integer"},"indComunicadoInserido":{"description":"Indica a data/hora em que o comunicado foi inserido nas bases do TCAP.\n String(26)\n","type":"string"},"midia":{"description":"\"Canal de Contratação.\n Inteiro(3)\"\n","type":"integer"},"numOcorrencias":{"description":"Numero maximo de ocorrencias.\n Numerico(3)\n","type":"integer"},"numProtocolo":{"description":"Numero de protocolo para impressao do documento.\n Numerico(10)\n","type":"integer"},"primeiraPagina":{"description":"Primeiro numero de pagina do comunicado para paginacao.\n Numerico(5)\n","type":"integer"},"sentido":{"description":"\"Sentido da paginacao.\n I - Inical\n P - Primeira\n S - Seguinte\n A - Anterior\n U - Ultima\n String(1)\n","type":"string"},"siglaForm":{"description":"Sigla do template do formulário de documento a ser parametrizado e impresso pelo sistema\n DOCG, definido no dicionário de dados do sistema produto, parametrizado no sistema\n corporativo DICM.\n String(5)\n","type":"string"},"tpBusca":{"description":"Tipo de busca\n 1 - TODOS\n 2 - APENAS NAO LIDOS\n 3 - APENAS LIDOS\n Numerico(1)\n","type":"integer"},"ultimaPagina":{"description":"Ultimo numero de pagina do comunicado para paginacao.\n Numerico(5)\n","type":"integer"}}}}},{"connectionName":"bradesco","actionName":"empresarial_api_analise_comercial_v2_3_0/get_v1_analise","parameters":{"env":{"type":"string"},"cpf":{"type":"string"},"cep":{"type":"string"},"idParceiro":{"type":"string"},"dataNascimento":{"type":"string"},"politica":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_api_analise_comercial_v2_3_0/get_v1_analise_historico","parameters":{"env":{"type":"string"},"cpf":{"type":"string"},"idParceiro":{"type":"string"},"codigoOperacao":{"type":"string"},"origem":{"type":"string"},"requestStatusId":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_api_analise_comercial_v2_3_0/get_v1_analise_comercial_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_by_id_canal_by_numero_bloco_produtos","parameters":{"idParceiro":{"type":"string"},"idCanal":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos","parameters":{"idParceiro":{"type":"string"},"idProduto":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos_by_id_plano_coberturas","parameters":{"idParceiro":{"type":"string"},"numeroBloco":{"type":"string"},"idProduto":{"type":"string"},"idPlano":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_produtos_by_id_produto_assistencias","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_parceiro_produtos_by_id_produto_capitalizacao","parameters":{"idProduto":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_produto_by_id_produto_formas_pagamento","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_endosso_dados_cadastrais","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_certificado","parameters":{"env":{"type":"string"},"idParceiro":{"type":"string"},"tipoDocumento":{"type":"string"},"numeroDocumento":{"type":"string"},"numeroBloco":{"type":"string"},"status":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_certificado_parcelas","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"},"numeroBloco":{"type":"string"},"status":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_status_parcela","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_status_parcela_cancelamento","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_renda","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_profissao","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_motivo_cancelamento","parameters":{"codigoParceiro":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_imovel","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_dados_pessoais","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_dados_cobranca","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_analise_comercial","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_contatos","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_documentos","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_objetos_risco","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_objeto_segurado","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_dados_pagamento_cobranca","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_mensagens","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_tabelas_dados_classificacao_produtos","parameters":{}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_produtos_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_seguro_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_consultas_v2_3_3/get_re_v1_proposta_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/post_re_analise_comercial_v2_gerar_analise_comercial","parameters":{"env":{"type":"string"},"data":{"required":["analiseComercialREEntity"],"type":"object","properties":{"analiseComercialREEntity":{"$ref":"#/components/schemas/AnaliseComercialRequest"}}}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/post_re_analise_comercial_v2_consultar_historico","parameters":{"env":{"type":"string"},"data":{"required":["proponente"],"type":"object","properties":{"proponente":{"$ref":"#/components/schemas/CreditTalkDadosConsulta"},"representante":{"$ref":"#/components/schemas/CreditTalkDadosConsulta"}},"description":"Dados de entrada para a consulta do histórico para o empresarial."}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/get_re_v1_parceiro_by_id_parceiro_by_id_canal_by_numero_bloco_produtos","parameters":{"idParceiro":{"type":"string"},"idCanal":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos","parameters":{"idParceiro":{"type":"string"},"idProduto":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos_by_id_plano_coberturas","parameters":{"idParceiro":{"type":"string"},"numeroBloco":{"type":"string"},"idProduto":{"type":"string"},"idPlano":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/get_re_v1_parceiro_by_id_parceiro_produtos_by_id_produto_assistencias","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/get_re_v1_parceiro_produtos_by_id_produto_capitalizacao","parameters":{"idProduto":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/get_re_v1_parceiro_by_id_parceiro_produto_by_id_produto_formas_pagamento","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/get_re_v1_parceiro_produtos","parameters":{"idParceiro":{"type":"string"},"idCanal":{"type":"string"},"numeroBloco":{"type":"string"},"codigoOperacao":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/get_re_analise_comercial_v1_analise_comercial_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_cotacao_v2_3_5/get_re_v1_produtos_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/post_re_v1_seguro_efetivar_participantes_dados_pagamentos","parameters":{"env":{"type":"string"},"data":{"required":["pagamentos"],"type":"object","properties":{"pagamentos":{"type":"array","description":"Informações de pagamentos","items":{"$ref":"#/components/schemas/PagamentoPCI"}}},"description":"Informações de pagamento na contratacao do seguro"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/post_re_v1_seguro_efetivar_participantes_dados_documentos","parameters":{"env":{"type":"string"},"data":{"required":["documentos"],"type":"object","properties":{"documentos":{"type":"array","description":"Informações de documentos","items":{"$ref":"#/components/schemas/DocumentoObjectPCI"}},"quadroSocietario":{"$ref":"#/components/schemas/QuadroSocietarioPCI"}},"description":"Informações de documentos do proponente do seguro"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/post_re_v1_seguro_efetivar_participantes_dados_cadastrais","parameters":{"env":{"type":"string"},"data":{"required":["dadosCadastrais","contatos","enderecos"],"type":"object","properties":{"dadosCadastrais":{"$ref":"#/components/schemas/DadosCadastraisPCI"},"contatos":{"type":"array","description":"Informações de contato","items":{"$ref":"#/components/schemas/ContatoObjectPCI"}},"enderecos":{"type":"array","description":"Informações do endereço","items":{"$ref":"#/components/schemas/EnderecoObjectPCI"}}},"description":"Informações cadastrais do proponente do seguro"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/post_re_v1_seguro_efetivar_dados_seguros","parameters":{"env":{"type":"string"},"data":{"required":["seguros"],"type":"object","properties":{"seguros":{"type":"array","description":"Informações de um seguro","items":{"$ref":"#/components/schemas/SeguroPCI"}}},"description":"Informações para a contratacao de um seguro"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/post_re_v1_seguro_seguro_cancelar_segurado_dados_pessoais_dados_documento","parameters":{"env":{"type":"string"},"data":{"required":["dadosDocumento"],"type":"object","properties":{"dadosDocumento":{"$ref":"#/components/schemas/CancelarDadosDocumento"}},"description":"Informações cadastrais (documentais) para o cancelamento dao seguro"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/post_re_v1_seguro_seguro_cancelar_segurado_dados_pessoais_dados_pagamento","parameters":{"env":{"type":"string"},"data":{"required":["dadosPagamento"],"type":"object","properties":{"dadosPagamento":{"$ref":"#/components/schemas/CancelarDadosPagamentoContaBancaria"}},"description":"Informações cadastrais de pagamento (restituição) para o cancelamento do seguro"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/post_re_v1_seguro_seguro_cancelar_dados_seguro","parameters":{"env":{"type":"string"},"data":{"required":["seguro"],"type":"object","properties":{"seguro":{"$ref":"#/components/schemas/CancelarAllDadosSeguro"}},"description":"Informações cadastrais (reunidas) para o cancelamento do seguro"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/post_re_v1_proposta_cancelar","parameters":{"env":{"type":"string"},"data":{"required":["idCertificado","idParceiro","motivoCancelamento","versaoDocumento"],"type":"object","properties":{"idParceiro":{"type":"string","description":"identificador do parceiro vinculado a proposta","example":"15689595"},"idCertificado":{"type":"string","description":"Identificador da proposta a ser cancelada","example":"3206676"},"versaoDocumento":{"type":"string","description":"Versao do documento","example":"1"},"motivoCancelamento":{"type":"string","description":"Motivo do cancelamento(Na URL /v1/seguro/tabelas/motivo-cancelamento)","example":"1"},"usuario":{"type":"string","description":"Usuario do servico","example":"API_RE"}},"description":"Entidade que reune os dados de entrada (request body) para realizar o cancelamento de uma proposta"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/post_v1_seguro_impressao","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/get_re_v1_proposta_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_efetivacao_v2_3_8/get_re_v1_seguro_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_endosso_v2_3_3/get_re_v1_seguro_endosso_dados_cadastrais","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_endosso_v2_3_3/post_re_v1_seguro_endosso_dados_cadastrais","parameters":{"env":{"type":"string"},"data":{"required":["parceiro","segurado"],"type":"object","properties":{"parceiro":{"$ref":"#/components/schemas/ParceiroEntity"},"segurado":{"$ref":"#/components/schemas/SeguradoEntity"}},"description":"Informações cadastrais"}}},{"connectionName":"bradesco","actionName":"empresarial_endosso_v2_3_3/get_re_v1_seguro_endosso_endosso_cadastral","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_endosso_v2_3_3/post_re_v1_seguro_endosso_endosso_cadastral","parameters":{"env":{"type":"string"},"data":{"required":["seguro"],"type":"object","properties":{"seguro":{"$ref":"#/components/schemas/EndossoSeguroEntity"}},"description":"Informações cadastrais"}}},{"connectionName":"bradesco","actionName":"empresarial_endosso_v2_3_3/get_re_v1_seguro_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"empresarial_pagamentocc_v2_3_1/post_re_v1_pagamento_cobranca_cartao_credito","parameters":{"env":{"type":"string"},"data":{"type":"object","properties":{"incluirCobrancaEcommerceRequest":{"$ref":"#/components/schemas/CobrancaCartaoCreditoEntity"}},"description":"Informações para a request do pagamento"}}},{"connectionName":"bradesco","actionName":"empresarial_pagamentocc_v2_3_1/get_re_v1_pagamento_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_oferta_plano_previdencia","parameters":{"cpf":{"type":"integer"},"perfil":{"type":"integer"},"agencia":{"type":"integer"},"conta":{"type":"integer"},"segmento":{"type":"integer"},"modalidade":{"type":"integer"},"tipoContribuicao":{"type":"integer"},"valorContribuicao":{"type":"integer"},"regimeTributario":{"type":"integer"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identificaFuncionario":{"type":"string"},"codigoCorretor":{"type":"integer"},"identificaRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_parametros_beneficio_acumulacao","parameters":{"cpf":{"type":"integer"},"dtNascimento":{"type":"string"},"sexo":{"type":"string"},"codPlano":{"type":"integer"},"codBeneficio":{"type":"integer"},"codPlanoJovem":{"type":"integer"},"tpContribuicao":{"type":"integer"},"cpfPatrocinador":{"type":"integer"},"dtNascimentoPatrocinador":{"type":"string"},"sexoPatrocinador":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"codCorretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_parametros_beneficio_risco","parameters":{"cpf":{"type":"integer"},"dtNascimento":{"type":"number"},"sexo":{"type":"string"},"codPlano":{"type":"integer"},"codBeneficio":{"type":"integer"},"tpContribuicao":{"type":"integer"},"codPlanoJovem":{"type":"integer"},"cpfPatrocinador":{"type":"integer"},"dtNascimentoPatrocinador":{"type":"string"},"sexoPatrocinador":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_associa_beneficio_risco","parameters":{"Content-Type":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"},"data":{"type":"object","example":{"codProdutoNegociado":"00204","codBloco":125,"codBeneficio":496,"dtInicioVigencia":"25.01.2019","qtdeLinha":2}}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_valida_proposta_inscricao","parameters":{"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identificaFuncionario":{"type":"string"},"codigoCorretor":{"type":"integer"},"identificaRepresentante":{"type":"string"},"data":{"type":"object","example":{"planoPagamento":310,"dtInicioPlano":"2017-01-01","dtInicioBeneficio":"2017-01-01","serie":55,"numeroProposta":110846,"codProdutoNegociado":"00079","dtVenda":"25.01.2019","dtAgendamento":"25.02.2019","indAgendamento":"S","codTipoProduto":1,"codModalidade":2,"codIdentProduto":"PFPPP","codIndTributacao":1,"codFinalidade":1,"dtConcessao":"2050-01-02","codBloco":84,"codIndicie":0,"taxaCarregamento":0,"vlrTotalContrib":5000,"codOrigemRecurso":0,"observacaoOrigem":"","cpfCnpjParticipante":342108328,"filialCnpj":0,"controleCpfCnpj":20,"dtNascimento":"16.01.1985","sexo":"M","nome":"EDIVANI PORTILHO DE CARVALHO","idade":33,"estadoCivil":2,"email":"EDIVANICARVALHO@SISCONSULTORIA.COM.BR","codBanco":237,"agencia":3977,"nrConta":43000,"tpConta":1,"formaEnvio":3,"dtExpedicao":"0001-01-01","vlrRendaMensal":100,"vlrPatrimonio":200,"codOcupacao":126,"telefones":{"0":{"tpTelefone":1,"codArea":11,"nrTelefone":47846426,"nrRamal":0},"1":{"tpTelefone":2,"codArea":11,"nrTelefone":37116530,"nrRamal":6931},"2":{"tpTelefone":3,"codArea":0,"nrTelefone":0,"nrRamal":0}},"codIdentTipoDoc":0,"codParticipante":"","codPais":46,"cep":18133,"complemento":330,"cpfCnpjJovem":0,"filialCnpjJovem":0,"controleCpfCnpjJovemPatrocinado":0,"dtNascimentoJovem":"0001-01-01","sexoJovem":"","nomeJovem":"","idadeJovem":0,"estadoCivilJovem":0,"emailJovem":"","telefonesJovem":{"0":{"tpTelefone":0,"codArea":0,"nrTelefone":0,"nrRamal":0},"1":{"tpTelefone":0,"codArea":0,"nrTelefone":0,"nrRamal":0},"2":{"tpTelefone":0,"codArea":0,"nrTelefone":0,"nrRamal":0}},"codGrauParentesco":0,"codIdentDependencia":0,"cepJovem":0,"complementoJovem":0,"codConcessao":9384006,"codRecurso":35,"codRegistro":0,"codAgente":9911348,"codConvenio":884,"codSucursal":9039,"codSuperintencia":9806,"codExecutiva":371,"codBancoVenda":237,"codAgenciaVenda":2,"perfilUsuario":"B","codIndCargoPublico":1,"orgaoContratante":"PREFEITURA MUNICIPAL DA CIDADE","cpfCnpjEmpregador":342108328,"filialEmpregador":0,"controleCpfCnpjEmpregador":20,"dsCargo":"PREFEITO","dtInicio":"2012-01-01","dtFim":"31.12.2016","vlrPatrimonioDeclarado":200,"vlrRendaMensalContratante":200,"codRelacionamento":1,"nmAgente":"CONCEICAO APARECIDA PORTILHO DE CARVALHO","cpfCnpjAgente":20945318,"filialAgente":0,"controleCpfCnpjAg":48,"dsCargoAgente":"VEREADORA","dsRelacionamentoAgente":"MAE","indNascionalidadeFatca":1,"indResidenciaFatca":1,"indVistoFatca":1,"qtdeFatca":3,"fatcas":{"0":{"identSituacao":1,"codPaisEstrangeiro":25,"codDocFiscal":"123456/78","codEmissaoFiscal":1,"codIndicadorObr":2,"codIndicadorDis":2,"codIndicadorRenuncia":1,"codDocRenuncia":1},"1":{"identSituacao":"2","codPaisEstrangeiro":20,"codDocFiscal":"987654/32 ","codEmissaoFiscal":2,"codIndicadorObr":1,"codIndicadorDis":2,"codIndicadorRenuncia":2,"codDocRenuncia":2},"2":{"identSituacao":3,"codPaisEstrangeiro":35,"codDocFiscal":"567890/12","codEmissaoFiscal":2,"codIndicadorObr":2,"codIndicadorDis":1,"codIndicadorRenuncia":1,"codDocRenuncia":2},"3":{"identSituacao":0,"codPaisEstrangeiro":0,"codDocFiscal":"","codEmissaoFiscal":0,"codIndicadorObr":0,"codIndicadorDis":0,"codIndicadorRenuncia":0,"codDocRenuncia":0}},"qtdeBeneficio":1,"beneficios":{"0":{"nrBeneficio":1,"codBeneficio":22205,"vlrContribRisco":1009990000000,"vlrRendaBenRisco":5000000000000,"tpRecRisco":0,"tpCobertura":0,"qtdeBeneficiario":4,"beneficiarios":{"0":{"nrBeneficiario":1,"nmBeneficiario":"BENEFICIARIO 1","dtNasimentoBeneficiario":"2014-12-02","sexoBeneficiario":"M","grauParentescoBeneficiario":5,"percentualBeneficiario":2000},"1":{"nrBeneficiario":2,"nmBeneficiario":"BENEFICIARIO 2","dtNasimentoBeneficiario":"27.03.2017","sexoBeneficiario":"F","grauParentescoBeneficiario":5,"percentualBeneficiario":2100},"2":{"nrBeneficiario":3,"nmBeneficiario":"BENEFICIARIO 3 ","dtNasimentoBeneficiario":"1985-09-05","sexoBeneficiario":"F","grauParentescoBeneficiario":4,"percentualBeneficiario":2200},"3":{"nrBeneficiario":4,"nmBeneficiario":"BENEFICIARIO 4 ","dtNasimentoBeneficiario":"23.09.1957","sexoBeneficiario":"F","grauParentescoBeneficiario":4,"percentualBeneficiario":3700}}}}}}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_rascunho_proposta","parameters":{"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"},"Content-Type":{"type":"string"},"data":{"type":"object","example":{"agenciaDebito":3977,"bairro":"OSASCO","banco":237,"beneficios":{"0":{"beneficiarios":{"0":{"beneficiario":"fulano 1","dtNascimentoBeneficiario":"2000-01-01","grau":2,"partBeneficiario":"5000","sexoBeneficiario":"M"},"1":{"beneficiario":"fulano 2","dtNascimentoBeneficiario":"2000-01-01","grau":2,"partBeneficiario":"3000","sexoBeneficiario":"F"},"2":{"beneficiario":"fulano 3","dtNascimentoBeneficiario":"2000-01-01","grau":2,"partBeneficiario":"1000","sexoBeneficiario":"M"},"3":{"beneficiario":"fulano 4","dtNascimentoBeneficiario":"2000-01-01","grau":2,"partBeneficiario":"1000","sexoBeneficiario":"F"}},"beneficioPrev":726,"qtdeBeneficiario":4,"vlrContribuicao":123.45}},"cep":6693,"codAge":0,"codConvenio":884,"codFilialCnpj":0,"codFinalidadeProposta":1,"codIdentificacaoExerc":2,"codProduto":"00052","codProdutoNegociado":"00052","indicadorOperacao":1,"complemento":90,"complementoParticipanete":"","concsBenef":"2050-01-01","conta":43000,"controle":49,"cpfCnpj":352624785,"dtAgendamento":"2019-03-05","dtExpedicao":"","dtIniVigenciaPlano":"2050-01-01","dtIniVigenciaBenef":"","dtNascimento":"23.06.2006","dtVencimento":"05","dtVenda":"2019-03-05","emailParticipante":"teste@teste.com.br","emissaoExtrato":"3","estadoCivil":1,"fatcas":{"0":{"codDocFiscal":"1","codDocRenuncia":2,"codEmissaoFiscal":2,"codIndicadorDis":2,"codIndicadorObr":2,"codIndicadorRenuncia":1,"codPaisEstrangeiro":"019","identSituacao":1},"1":{"codDocFiscal":"2","codDocRenuncia":1,"codEmissaoFiscal":2,"codIndicadorDis":2,"codIndicadorObr":1,"codIndicadorRenuncia":2,"codPaisEstrangeiro":"028","identSituacao":2},"2":{"codDocFiscal":"3","codDocRenuncia":2,"codEmissaoFiscal":1,"codIndicadorDis":1,"codIndicadorObr":2,"codIndicadorRenuncia":2,"codPaisEstrangeiro":"031","identSituacao":3},"3":{"codDocFiscal":"","codDocRenuncia":0,"codEmissaoFiscal":0,"codIndicadorDis":0,"codIndicadorObr":0,"codIndicadorRenuncia":0,"codPaisEstrangeiro":"","identSituacao":0}},"formaExtrato":3,"formaPagamento":1,"funcao":0,"identAgContribuinte":2,"identPagamento":1,"isento":"N","logradouro":"RUA SEM NOME","municipio":"ITAPEVI","nmParticipante":"Andre Mendes Junior","nrEndereco":"16","observacaoOrigem":"","ocupacao":101,"origemRecProdt":2,"pais":46,"planoPgt":435,"qtdeBeneficio":1,"quantidade":3,"respProposta":"Andre Mendes Junior","serie":0,"sexo":"M","telefones":{"0":{"codArea":11,"nrRamal":0,"nrTelefone":11111111,"tpTelefone":1},"1":{"codArea":11,"nrRamal":0,"nrTelefone":911111111,"tpTelefone":3},"2":{"codArea":11,"nrRamal":0,"nrTelefone":11111111,"tpTelefone":2}},"telefonesJovem":{"0":{"codArea":0,"nrRamal":0,"nrTelefone":0,"tpTelefone":0},"1":{"codArea":0,"nrRamal":0,"nrTelefone":0,"tpTelefone":0},"2":{"codArea":0,"nrRamal":0,"nrTelefone":0,"tpTelefone":0}},"tpContaParticipante":1,"ufParticipante":"SP","vlrBoleto":123.45,"vlrRenda":1000}}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_aceite_proposta","parameters":{"access-token":{"type":"string"},"Content-Type":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"},"data":{"type":"object","example":{"serie":10,"nrProposta":3000121,"tpProposta":"I","tpAceite":1}}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_proposta_implantada","parameters":{"agencia":{"type":"integer"},"conta":{"type":"integer"},"cpf":{"type":"integer"},"dataNascimento":{"type":"string"},"sexo":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identificaFuncionario":{"type":"string"},"codigoCorretor":{"type":"integer"},"identificaRepresentante":{"type":"string"},"tpConsulta":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/delete_proposta_implantada","parameters":{"centroCusto":{"type":"string"},"serie":{"type":"integer"},"nrProposta":{"type":"integer"},"nrMatricula":{"type":"integer"},"codBeneficio":{"type":"integer"},"dtCancelamento":{"type":"number"},"Content-Type":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_parametros_aporte","parameters":{"cpf":{"type":"integer"},"dtNascimento":{"type":"number"},"sexo":{"type":"string"},"codPlano":{"type":"integer"},"codBeneficio":{"type":"integer"},"codPlanoJovem":{"type":"integer"},"tpContribuicao":{"type":"integer"},"cpfPatrocinador":{"type":"integer"},"dtNascimentoPatrocinador":{"type":"number"},"sexoPatrocinador":{"type":"string"},"access-token":{"type":"string","description":"example: a38b9763-0a66-4b00-baac-126d2916baa6"},"canal":{"type":"integer","description":"example: '8'"},"origem":{"type":"integer","description":" example: '5310'"},"usuario":{"type":"integer","description":"example: '9911348'"},"identFuncionario":{"type":"integer","description":"example: '1'"},"corretor":{"type":"integer","description":"example: '9911349'"},"identRepresentante":{"type":"string","description":"example: S"},"Authorization":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_proposta_aporte","parameters":{"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"integer"},"Content-Type":{"type":"string"},"data":{"type":"object","example":{"deptoUsuario":5310,"codPlanoPagamento":318,"dtInicioVigencia":"","serie":55,"nrProposta":1154806,"codProdutoNegociado":"00043","dtNascimento":"1956-12-10","email":"JSARAIVA1956@UOL.COM.BR","dtVenda":"2018-09-08","dtAgendamento":"2019-09-08","indAgendamento":"N","codContb":2,"banco":237,"agencia":1382,"nrConta":10000,"tpConta":1,"formaEnvio":3,"cpfCnpj":56606798,"controleFilialCpfCnpj":0,"controleCpfCnpjJovem":62,"sexo":"M","dtExpedicao":"1956-12-10","vlrRendaMensal":100,"vlrPatrimonioLiquido":0,"codOcupacao":999,"telefones":{"0":{"tpTelefone":1,"codArea":11,"nrTelefone":36821299,"nrRamal":0},"1":{"tpTelefone":2,"codArea":11,"nrTelefone":37111820,"nrRamal":0},"2":{"tpTelefone":2,"codArea":11,"nrTelefone":983460909,"nrRamal":0}},"codFinalidadePropsota":2,"codUsuarioSistema":"0000001","codNac":46,"cep":6020,"cepComplemento":70,"codOrigem":1,"dsOrigemRecurso":"","dtVendaPropostaPrev":"2002-12-04","codConcessao":8000271,"codIdentificacao":35,"codRegistro":0,"codAgente":9911348,"codConvenio":884,"codSucursal":5310,"codSuperintencia":0,"codSuperintenciaExec":0,"bancoPrevidencia":237,"codAgencia":1,"departamentoUsuario":5310,"matriculaUnificada":25329650,"serieProposta":55,"codProposta":1154806,"codTipoProduto":2,"vlrAporte":15000,"nrProduto":0,"dtVendaProposta":"2018-09-08","txCarregamento":3,"qtdeMeses":0,"vlrRenda":0}}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/put_forma_cobranca","parameters":{"Content-Type":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"},"data":{"type":"object","example":{"tipoServico":"I","agencia":1,"agenciaDigito":"X","conta":949999,"contaDigito":"7","matricula":66012260,"serieProposta":"012","numeroProposta":709950,"agenciaSolicitada":1,"agenciaSolicitadaDigito":"X","contaSolicitada":1,"contaSolicitadaDigito":"C","tipoConta":"C"}}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/put_dia_vencimento","parameters":{"Content-Type":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"},"data":{"type":"object","example":{"tipoServico":"I","agencia":1,"agenciaDigito":"X","conta":949999,"contaDigito":"7","matricula":66012260,"serieProposta":12,"numeroProposta":709950,"diaVencimento":12}}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/put_dados_participante","parameters":{"Content-Type":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"integer"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"},"data":{"type":"object","example":{"matricula":43634982,"nmParticipante":"FABIO REZENDE SIS","estadoCivil":"C","codPaisNascimento":20,"fatcaPergunta1":"S","fatcaPergunta2":"N","fatcaPergunta3":"N","codProfissao":164,"vlrRendaMensal":13456.12,"vlrPatrimonio":54000,"cep":11700,"complementoCep":601,"endereco":"RUA MARECHAL TEODORO DA FONSECA DE SOUZA","numero":"00001","complemento":"CASA CONDOMINIO","bairro":"VILA ARRITE","cidade":"SOCORRO","uf":"00","codArea1":"0041","telefone1":21073859,"ramal":3859,"codArea2":"0000","telefone2":0,"codArea3":"0041","telefone3":999999991,"email":"TESTE@BRADESCO.COM.BR","qtdeRegistros":1,"ocorrenciasFatca":{"0":{"referenciaPergunta":1,"codPaisReferencia":1,"identificacaoNif":"","nifPergunta1":"N","nifPergunta2":"N","nifPergunta3":"N","renunciaAbdica":1,"renunciaAbdicaPergunta":"S"}}}}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_carteira_recomendada","parameters":{"regime":{"type":"Integer"},"modalidade":{"type":"Integer"},"qtdLinhas":{"type":"Integer"},"qtdOcorrencias":{"type":"Integer"},"perfil":{"type":"Integer"},"segmento":{"type":"Integer"},"access-token":{"type":"String"},"trancode":{"type":"String"},"filler":{"type":"String"},"canal":{"type":"Integer"},"origem":{"type":"Integer"},"usuario":{"type":"Integer"},"identFuncionario":{"type":"String"},"corretor":{"type":"Integer"},"identRepresentante":{"type":"String"},"mqoauth":{"type":"String"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_validar_proposta_inscricao","parameters":{"access-token":{"type":"String"},"canal":{"type":"Integer"},"identificaFuncionario":{"type":"String"},"identificaRepresentante":{"type":"String"},"Content-Type":{"type":"String"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_participante","parameters":{"matricula":{"type":"integer"},"cpf":{"type":"integer"},"dtNascimento":{"type":"number"},"sexo":{"type":"string"},"Authorization":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_proposta_digitada","parameters":{"usuarioPrev":{"type":"string"},"dtVendata":{"type":"string"},"serie":{"type":"integer"},"proposta":{"type":"integer"},"codProduto":{"type":"integer"},"codModalidade":{"type":"integer"},"codFinalidade":{"type":"integer"},"banco":{"type":"integer"},"agencia":{"type":"integer"},"situacao":{"type":"string"},"pesquisa":{"type":"string"},"cpf":{"type":"string"},"filial":{"type":"integer"},"controleCpf":{"type":"integer"},"dtNascimento":{"type":"number"},"sexo":{"type":"string"},"Authorization":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/delete_proposta_digitada","parameters":{"indicadorOperacao":{"type":"integer"},"serieProposta":{"type":"integer"},"produtoProposta":{"type":"integer"},"Content-Type":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_token","parameters":{"Content-Type":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_simulacao","parameters":{"cpf":{"type":"integer"},"serie":{"type":"integer"},"proposta":{"type":"integer"},"tpResgate":{"type":"integer"},"vlrSolicitado":{"type":"integer"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_resgate","parameters":{"Content-Type":{"type":"string"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_proposta_implantada_7_dias","parameters":{"nrMatricula":{"type":"integer"},"cpf":{"type":"string"},"dtNascimento":{"type":"string"},"sexo":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"string"},"usuario":{"type":"string"},"identFuncionario":{"type":"string"},"corretor":{"type":"string"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_detalhe_proposta_digitada","parameters":{"serieProposta":{"type":"integer"},"produtoProposta":{"type":"integer"},"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_detalhe_proposta_implantada","parameters":{"matricula":{"type":"integer"},"serie":{"type":"integer"},"nrProposta":{"type":"integer"},"centroCusto":{"type":"string"},"access-token":{"type":"string"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"canal":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/get_proposta_transferencia","parameters":{"cpf":{"type":"integer"},"dtNascimento":{"type":"string"},"sexo":{"type":"string"},"produtoComercial":{"type":"string"},"serie":{"type":"string"},"nrProposta":{"type":"integer"},"funcao":{"type":"string"},"Authorization":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_proposta_transferencia","parameters":{"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"},"Content-type":{"type":"string"}}},{"connectionName":"bradesco","actionName":"previdencia_previdenciav3/post_valida_proposta_transferencia","parameters":{"access-token":{"type":"string"},"canal":{"type":"integer"},"origem":{"type":"integer"},"usuario":{"type":"integer"},"identFuncionario":{"type":"string"},"corretor":{"type":"integer"},"identRepresentante":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_analise_comercial_v2_3_0/get_v1_analise","parameters":{"env":{"type":"string"},"cpf":{"type":"string"},"cep":{"type":"string"},"idParceiro":{"type":"string"},"dataNascimento":{"type":"string"},"politica":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_analise_comercial_v2_3_0/get_v1_analise_historico","parameters":{"env":{"type":"string"},"cpf":{"type":"string"},"idParceiro":{"type":"string"},"codigoOperacao":{"type":"string"},"origem":{"type":"string"},"requestStatusId":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_analise_comercial_v2_3_0/get_v1_analise_comercial_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_analise_comercial_v2_gerar_analise_comercial","parameters":{"env":{"type":"string"},"data":{"required":["analiseComercialREEntity"],"type":"object","properties":{"analiseComercialREEntity":{"$ref":"#/components/schemas/AnaliseComercialRequest"}}}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_parceiro_by_id_parceiro_produtos_by_id_produto_plano_by_id_plano_parcelamento","parameters":{"idParceiro":{"type":"string"},"idProduto":{"type":"string"},"idPlano":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_parceiro_by_id_parceiro_by_id_canal_by_numero_bloco_produtos","parameters":{"idParceiro":{"type":"string"},"idCanal":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos","parameters":{"idParceiro":{"type":"string"},"idProduto":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos_by_id_plano_coberturas","parameters":{"idParceiro":{"type":"string"},"numeroBloco":{"type":"string"},"idProduto":{"type":"string"},"idPlano":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_parceiro_by_id_parceiro_produtos_by_id_produto_assistencias","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_parceiro_produtos_by_id_produto_capitalizacao","parameters":{"idProduto":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_parceiro_by_id_parceiro_produto_by_id_produto_formas_pagamento","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_parceiro_produtos","parameters":{"idParceiro":{"type":"string"},"idCanal":{"type":"string"},"numeroBloco":{"type":"string"},"codigoOperacao":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_analisar_proposta","parameters":{"env":{"type":"string"},"data":{"required":["seguros"],"type":"object","properties":{"seguros":{"type":"array","description":"Informações de um seguro","items":{"$ref":"#/components/schemas/SeguroPCI"}}},"description":"Informações para a contratacao de um seguro"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_efetivar_participantes_dados_pagamentos","parameters":{"env":{"type":"string"},"data":{"required":["pagamentos"],"type":"object","properties":{"pagamentos":{"type":"array","description":"Informações de pagamentos","items":{"$ref":"#/components/schemas/PagamentoPCI"}}},"description":"Informações de pagamento na contratacao do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_efetivar_participantes_dados_documentos","parameters":{"env":{"type":"string"},"data":{"required":["documentos"],"type":"object","properties":{"documentos":{"type":"array","description":"Informações de documentos","items":{"$ref":"#/components/schemas/DocumentoObjectPCI"}},"quadroSocietario":{"$ref":"#/components/schemas/QuadroSocietarioPCI"}},"description":"Informações de documentos do proponente do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_efetivar_participantes_dados_cadastrais","parameters":{"env":{"type":"string"},"data":{"required":["dadosCadastrais","contatos","enderecos"],"type":"object","properties":{"dadosCadastrais":{"$ref":"#/components/schemas/DadosCadastraisPCI"},"contatos":{"type":"array","description":"Informações de contato","items":{"$ref":"#/components/schemas/ContatoObjectPCI"}},"enderecos":{"type":"array","description":"Informações do endereço","items":{"$ref":"#/components/schemas/EnderecoObjectPCI"}}},"description":"Informações cadastrais do proponente do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_efetivar_dados_seguros","parameters":{"env":{"type":"string"},"data":{"required":["seguros"],"type":"object","properties":{"seguros":{"type":"array","description":"Informações de um seguro","items":{"$ref":"#/components/schemas/SeguroPCI"}}},"description":"Informações para a contratacao de um seguro"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_endosso_dados_cadastrais","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_endosso_dados_cadastrais","parameters":{"env":{"type":"string"},"data":{"required":["parceiro","segurado"],"type":"object","properties":{"parceiro":{"$ref":"#/components/schemas/ParceiroEntity"},"segurado":{"$ref":"#/components/schemas/SeguradoEntity"}},"description":"Informações cadastrais"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_endosso_endosso_cadastral","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_endosso_endosso_cadastral","parameters":{"env":{"type":"string"},"data":{"required":["seguro"],"type":"object","properties":{"seguro":{"$ref":"#/components/schemas/EndossoSeguroEntity"}},"description":"Informações cadastrais"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_seguro_cancelar_segurado_dados_pessoais_dados_pagamento","parameters":{"env":{"type":"string"},"data":{"required":["dadosPagamento"],"type":"object","properties":{"dadosPagamento":{"$ref":"#/components/schemas/CancelarDadosPagamentoContaBancaria"}},"description":"Informações cadastrais de pagamento (restituição) para o cancelamento do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_seguro_cancelar_segurado_dados_pessoais_dados_documento","parameters":{"env":{"type":"string"},"data":{"required":["dadosDocumento"],"type":"object","properties":{"dadosDocumento":{"$ref":"#/components/schemas/CancelarDadosDocumento"}},"description":"Informações cadastrais (documentais) para o cancelamento dao seguro"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_seguro_cancelar_dados_seguro","parameters":{"env":{"type":"string"},"data":{"required":["seguro"],"type":"object","properties":{"seguro":{"$ref":"#/components/schemas/CancelarAllDadosSeguro"}},"description":"Informações cadastrais (reunidas) para o cancelamento do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_proposta_cancelar","parameters":{"env":{"type":"string"},"data":{"required":["idCertificado","idParceiro","motivoCancelamento","versaoDocumento"],"type":"object","properties":{"idParceiro":{"type":"string","description":"identificador do parceiro vinculado a proposta","example":"15689595"},"idCertificado":{"type":"string","description":"Identificador da proposta a ser cancelada","example":"3206676"},"versaoDocumento":{"type":"string","description":"Versao do documento","example":"1"},"motivoCancelamento":{"type":"string","description":"Motivo do cancelamento(Na URL /v1/seguro/tabelas/motivo-cancelamento)","example":"1"},"usuario":{"type":"string","description":"Usuario do servico","example":"API_RE"}},"description":"Entidade que reune os dados de entrada (request body) para realizar o cancelamento de uma proposta"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_certificado","parameters":{"env":{"type":"string"},"idParceiro":{"type":"string"},"tipoDocumento":{"type":"string"},"numeroDocumento":{"type":"string"},"numeroBloco":{"type":"string"},"status":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_v1_seguro_impressao","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_certificado_parcelas","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"},"numeroBloco":{"type":"string"},"status":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_seguro_analisar_proposta_certificado","parameters":{"env":{"type":"string"},"data":{"type":"object","properties":{"certificado":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CertificadoWrapper"}}},"required":["certificado"]}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_pagamento_cartao_validar","parameters":{"env":{"type":"string"},"data":{"type":"object","properties":{"pagamento":{"type":"object","properties":{"idParceiro":{"type":"string","example":"15684242"},"cartao":{"type":"object","properties":{"administradora":{"type":"string","example":"40002"},"numero":{"type":"string","example":"5162920982746291"},"validade":{"type":"string","example":"06/2032"}},"required":["administradora","numero","validade"]}},"required":["idParceiro","cartao"]}},"required":["pagamento"]}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_pagamento_cobranca_cartao_credito","parameters":{"env":{"type":"string"},"data":{"type":"object","properties":{"incluirCobrancaEcommerceRequest":{"$ref":"#/components/schemas/CobrancaCartaoCreditoEntity"}},"description":"Informações para a request do pagamento"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_pagamento_cobranca_debito_conta","parameters":{"env":{"type":"string"},"data":{"required":["bilhetes","dadosCadastrais","dadosCobranca","dadosParcela","dadosPrimeiroContato","dadosProposta","dadosSegundoContato","primeiroEnderecoRisco","segundoEnderecoRisco"],"type":"object","properties":{"bilhetes":{"$ref":"#/components/schemas/Bilhetes"},"dadosCadastrais":{"$ref":"#/components/schemas/DadosCadastraisDebito"},"dadosCobranca":{"$ref":"#/components/schemas/DadosCobranca"},"dadosParcela":{"$ref":"#/components/schemas/DadosParcela"},"dadosProposta":{"$ref":"#/components/schemas/DadosProposta"},"primeiroEnderecoRisco":{"$ref":"#/components/schemas/DadosEndereco"},"segundoEnderecoRisco":{"$ref":"#/components/schemas/DadosEndereco"},"dadosPrimeiroContato":{"$ref":"#/components/schemas/DadosContato"},"dadosSegundoContato":{"$ref":"#/components/schemas/DadosContato"},"dadosComplementares":{"$ref":"#/components/schemas/DadosComplementares"}},"description":"Informações para a request do pagamento via débito em conta"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/post_re_v1_pagamento_pix","parameters":{"env":{"type":"string"},"data":{"type":"object","properties":{"pagamento":{"type":"array","items":{"$ref":"#/components/schemas/Pagamento"}},"requestStatusId":{"type":"string","description":"ID do status da requisição"}}}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_status_parcela","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_status_parcela_cancelamento","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_renda","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_profissao","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_motivo_cancelamento","parameters":{"codigoParceiro":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_imovel","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_dados_pessoais","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_dados_cobranca","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_analise_comercial","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_contatos","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_documentos","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_objetos_risco","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_objeto_segurado","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_mensagens","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_dados_classificacao_risco_produtos","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_tabelas_dados_socio","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_analise_comercial_v1_analise_comercial_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_produtos_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_seguro_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_re_v1_proposta_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_api_re_v2_3_21/get_v1_pagamento_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_by_id_canal_by_numero_bloco_produtos","parameters":{"idParceiro":{"type":"string"},"idCanal":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos","parameters":{"idParceiro":{"type":"string"},"idProduto":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos_by_id_plano_coberturas","parameters":{"idParceiro":{"type":"string"},"numeroBloco":{"type":"string"},"idProduto":{"type":"string"},"idPlano":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_produtos_by_id_produto_assistencias","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_parceiro_produtos_by_id_produto_capitalizacao","parameters":{"idProduto":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_parceiro_by_id_parceiro_produto_by_id_produto_formas_pagamento","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_endosso_dados_cadastrais","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_certificado","parameters":{"env":{"type":"string"},"idParceiro":{"type":"string"},"tipoDocumento":{"type":"string"},"numeroDocumento":{"type":"string"},"numeroBloco":{"type":"string"},"status":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_certificado_parcelas","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"},"numeroBloco":{"type":"string"},"status":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_status_parcela","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_status_parcela_cancelamento","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_renda","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_profissao","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_motivo_cancelamento","parameters":{"codigoParceiro":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_imovel","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_dados_pessoais","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_dados_cobranca","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_analise_comercial","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_contatos","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_documentos","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_objetos_risco","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_objeto_segurado","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_dados_pagamento_cobranca","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_mensagens","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_tabelas_dados_classificacao_produtos","parameters":{}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_produtos_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_seguro_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_consultas_v2_3_3/get_re_v1_proposta_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/post_re_analise_comercial_v2_gerar_analise_comercial","parameters":{"env":{"type":"string"},"data":{"required":["analiseComercialREEntity"],"type":"object","properties":{"analiseComercialREEntity":{"$ref":"#/components/schemas/AnaliseComercialRequest"}}}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_v1_parceiro_by_id_parceiro_produtos_by_id_produto_plano_by_id_plano_parcelamento","parameters":{"idParceiro":{"type":"string"},"idProduto":{"type":"string"},"idPlano":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_v1_parceiro_by_id_parceiro_by_id_canal_by_numero_bloco_produtos","parameters":{"idParceiro":{"type":"string"},"idCanal":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos","parameters":{"idParceiro":{"type":"string"},"idProduto":{"type":"string"},"numeroBloco":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_v1_parceiro_by_id_parceiro_by_numero_bloco_produtos_by_id_produto_planos_by_id_plano_coberturas","parameters":{"idParceiro":{"type":"string"},"numeroBloco":{"type":"string"},"idProduto":{"type":"string"},"idPlano":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_v1_parceiro_by_id_parceiro_produtos_by_id_produto_assistencias","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_v1_parceiro_produtos_by_id_produto_capitalizacao","parameters":{"idProduto":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_v1_parceiro_by_id_parceiro_produto_by_id_produto_formas_pagamento","parameters":{"idProduto":{"type":"string"},"idParceiro":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_v1_parceiro_produtos","parameters":{"idParceiro":{"type":"string"},"idCanal":{"type":"string"},"numeroBloco":{"type":"string"},"codigoOperacao":{"type":"string"},"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_analise_comercial_v1_analise_comercial_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_cotacao_v2_3_7/get_re_v1_produtos_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_seguro_analisar_proposta","parameters":{"env":{"type":"string"},"data":{"required":["seguros"],"type":"object","properties":{"seguros":{"type":"array","description":"Informações de um seguro","items":{"$ref":"#/components/schemas/SeguroPCI"}}},"description":"Informações para a contratacao de um seguro"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_proposta_cancelar","parameters":{"env":{"type":"string"},"data":{"required":["idCertificado","idParceiro","motivoCancelamento","versaoDocumento"],"type":"object","properties":{"idParceiro":{"type":"string","description":"identificador do parceiro vinculado a proposta","example":"15689595"},"idCertificado":{"type":"string","description":"Identificador da proposta a ser cancelada","example":"3206676"},"versaoDocumento":{"type":"string","description":"Versao do documento","example":"1"},"motivoCancelamento":{"type":"string","description":"Motivo do cancelamento(Na URL /v1/seguro/tabelas/motivo-cancelamento)","example":"1"},"usuario":{"type":"string","description":"Usuario do servico","example":"API_RE"}},"description":"Entidade que reune os dados de entrada (request body) para realizar o cancelamento de uma proposta"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_seguro_analisar_proposta_certificado","parameters":{"env":{"type":"string"},"data":{"type":"object","properties":{"certificado":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CertificadoWrapper"}}},"required":["certificado"]}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_seguro_efetivar_participantes_dados_pagamentos","parameters":{"env":{"type":"string"},"data":{"required":["pagamentos"],"type":"object","properties":{"pagamentos":{"type":"array","description":"Informações de pagamentos","items":{"$ref":"#/components/schemas/PagamentoPCI"}}},"description":"Informações de pagamento na contratacao do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_seguro_efetivar_participantes_dados_documentos","parameters":{"env":{"type":"string"},"data":{"required":["documentos"],"type":"object","properties":{"documentos":{"type":"array","description":"Informações de documentos","items":{"$ref":"#/components/schemas/DocumentoObjectPCI"}},"quadroSocietario":{"$ref":"#/components/schemas/QuadroSocietarioPCI"}},"description":"Informações de documentos do proponente do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_seguro_efetivar_participantes_dados_cadastrais","parameters":{"env":{"type":"string"},"data":{"required":["dadosCadastrais","contatos","enderecos"],"type":"object","properties":{"dadosCadastrais":{"$ref":"#/components/schemas/DadosCadastraisPCI"},"contatos":{"type":"array","description":"Informações de contato","items":{"$ref":"#/components/schemas/ContatoObjectPCI"}},"enderecos":{"type":"array","description":"Informações do endereço","items":{"$ref":"#/components/schemas/EnderecoObjectPCI"}}},"description":"Informações cadastrais do proponente do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_seguro_efetivar_dados_seguros","parameters":{"env":{"type":"string"},"data":{"required":["seguros"],"type":"object","properties":{"seguros":{"type":"array","description":"Informações de um seguro","items":{"$ref":"#/components/schemas/SeguroPCI"}}},"description":"Informações para a contratacao de um seguro"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_seguro_seguro_cancelar_segurado_dados_pessoais_dados_pagamento","parameters":{"env":{"type":"string"},"data":{"required":["dadosPagamento"],"type":"object","properties":{"dadosPagamento":{"$ref":"#/components/schemas/CancelarDadosPagamentoContaBancaria"}},"description":"Informações cadastrais de pagamento (restituição) para o cancelamento do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_seguro_seguro_cancelar_segurado_dados_pessoais_dados_documento","parameters":{"env":{"type":"string"},"data":{"required":["dadosDocumento"],"type":"object","properties":{"dadosDocumento":{"$ref":"#/components/schemas/CancelarDadosDocumento"}},"description":"Informações cadastrais (documentais) para o cancelamento dao seguro"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_re_v1_seguro_seguro_cancelar_dados_seguro","parameters":{"env":{"type":"string"},"data":{"required":["seguro"],"type":"object","properties":{"seguro":{"$ref":"#/components/schemas/CancelarAllDadosSeguro"}},"description":"Informações cadastrais (reunidas) para o cancelamento do seguro"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/post_v1_seguro_impressao","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/get_re_v1_proposta_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_efetivacao_v2_3_9/get_re_v1_seguro_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_endosso_v2_3_4/get_re_v1_seguro_endosso_dados_cadastrais","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_endosso_v2_3_4/post_re_v1_seguro_endosso_dados_cadastrais","parameters":{"env":{"type":"string"},"data":{"required":["parceiro","segurado"],"type":"object","properties":{"parceiro":{"$ref":"#/components/schemas/ParceiroEntity"},"segurado":{"$ref":"#/components/schemas/SeguradoEntity"}},"description":"Informações cadastrais"}}},{"connectionName":"bradesco","actionName":"residencial_endosso_v2_3_4/get_re_v1_seguro_endosso_endosso_cadastral","parameters":{"env":{"type":"string"},"idCertificado":{"type":"string"},"versaoDocumento":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_endosso_v2_3_4/post_re_v1_seguro_endosso_endosso_cadastral","parameters":{"env":{"type":"string"},"data":{"required":["seguro"],"type":"object","properties":{"seguro":{"$ref":"#/components/schemas/EndossoSeguroEntity"}},"description":"Informações cadastrais"}}},{"connectionName":"bradesco","actionName":"residencial_endosso_v2_3_4/get_re_v1_seguro_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"residencial_pagamentocc_v2_3_1/post_re_v1_pagamento_cobranca_cartao_credito","parameters":{"env":{"type":"string"},"data":{"type":"object","properties":{"incluirCobrancaEcommerceRequest":{"$ref":"#/components/schemas/CobrancaCartaoCreditoEntity"}},"description":"Informações para a request do pagamento"}}},{"connectionName":"bradesco","actionName":"residencial_pagamentocc_v2_3_1/get_re_v1_pagamento_health_check","parameters":{"env":{"type":"string"}}},{"connectionName":"bradesco","actionName":"seguroprestamista_swaggercotacaoprestv3/post_v1_cotacao_incluir_cotacao","parameters":{"cdOrigemTransmissao":{"type":"integer","description":"Canal de Origem de Transmissao ou Canal de Comercialização. Código interno da Bradesco Seguros. Para as empresas parceiras esse código deve ser informado préviamente."},"nroControleCotacao":{"type":"integer","description":"Número de Controle da Cotação. Número sequêncial gerado internamento pelo sistema, toda vez que uma nova cotação é gerada."},"data":{"required":["pagamento","produto","proponente"],"type":"object","properties":{"cdEmpresa":{"$ref":"#/components/schemas/cdEmpresa"},"cdSucursal":{"$ref":"#/components/schemas/cdSucursal"},"produto":{"$ref":"#/components/schemas/ProdutoCotacao"},"proponente":{"$ref":"#/components/schemas/Proponente"},"pagamento":{"$ref":"#/components/schemas/Pagamento"},"socio":{"$ref":"#/components/schemas/socio"}}}}},{"connectionName":"bradesco","actionName":"seguroprestamista_swaggercotacaoprestv3/post_v1_proposta_gerar_proposta","parameters":{"cdOrigemTransmissao":{"type":"integer","description":"Canal de Origem de Transmissao ou Canal de Comercialização. Código interno da Bradesco Seguros. Para a empresas parceiras esse código deve ser informado préviamente."},"data":{"required":["cIndcdPssoaPoltcExpto","cdPlano","nroProposta"],"type":"object","properties":{"nroControleCotacao":{"$ref":"#/components/schemas/nCtrlCotac"},"nroPrefixo":{"$ref":"#/components/schemas/nroPrefixo"},"nroProposta":{"$ref":"#/components/schemas/nroProposta"},"cdPlano":{"$ref":"#/components/schemas/cdPlano"},"dtIniVigencia":{"$ref":"#/components/schemas/dtIniVigencia"},"dtFimVigencia":{"$ref":"#/components/schemas/dtFimVigencia"},"dtVencPrimeiraParcFinanc":{"$ref":"#/components/schemas/dtVencPrimeiraParcFinanc"},"nroDiaVencimento":{"$ref":"#/components/schemas/nroDiaVencimento"},"endereco":{"$ref":"#/components/schemas/Endereco"},"contato":{"$ref":"#/components/schemas/Contato"},"socio":{"$ref":"#/components/schemas/socios"},"cdConcessionario":{"$ref":"#/components/schemas/cdConcessionario"},"cdSupervisor":{"$ref":"#/components/schemas/cdSupervisor"},"cdAngariador":{"$ref":"#/components/schemas/cdAngariador"},"cdCodigoComercial":{"$ref":"#/components/schemas/cdCodigoComercial"},"cdSegmento":{"$ref":"#/components/schemas/cdSegmento"},"cIndcdPssoaPoltcExpto":{"$ref":"#/components/schemas/cIndcdPssoaPoltcExpto"}}}}},{"connectionName":"bradesco","actionName":"seguroprestamista_swaggercotacaoprestv3/get_v1_produto_consulta_cotacao","parameters":{"cdOrigemTransmissao":{"type":"integer","description":"Canal de Origem de Transmissao ou Canal de Comercialização. Código interno da Bradesco Seguros. Para a empresas parceiras esse código deve ser informado préviamente."},"tpPesquisa":{"type":"integer","description":"Tipo de pesquisa\n- 1: P/ Nro. Controle - > Recuperar Vcto e Status\n- 2: P/ Nro. Controle - > Recuperar Objeto Cotação"},"nroControleCotacao":{"type":"integer","description":"Número de Controle da Cotação a ser consultada. Este número é gerado internamento pelo sistema toda vez que uma nova cotação é gerada."}}},{"connectionName":"bradesco","actionName":"seguroprestamista_swaggercotacaoprestv3/get_v1_proposta_log_emissao","parameters":{"cdOrigemTransmissao":{"type":"integer","description":"Canal de Origem de Transmissao ou Canal de Comercialização. Código interno da Bradesco Seguros. Para a empresas parceiras esse código deve ser informado préviamente."},"nroControleCotacao":{"type":"integer","description":"Número de Controle da Cotação. Número sequêncial gerado internamento pelo sistema, toda vez que uma nova cotação é gerada."}}},{"connectionName":"bradesco","actionName":"seguroprestamista_swaggercotacaoprestv3/put_v1_proposta_reprocessar_emissao","parameters":{"data":{"required":["cdOrigemTransmissao","cdProduto","cdStatus","nroControleCotacao","nroProposta"],"type":"object","properties":{"cdOrigemTransmissao":{"$ref":"#/components/schemas/cdOrigemTransmissao"},"tpPesquisa":{"$ref":"#/components/schemas/tpPesquisa"},"nroControleCotacao":{"$ref":"#/components/schemas/nCtrlCotac"},"cdProduto":{"$ref":"#/components/schemas/cdProduto"},"nroProposta":{"$ref":"#/components/schemas/nroProposta"},"cdStatus":{"$ref":"#/components/schemas/cdStatusPropt"}}}}},{"connectionName":"bradesco","actionName":"seguroprestamista_swaggercotacaoprestv3/post_v1_produto_consulta_cotacao_parcelas_pendentes","parameters":{"data":{"required":["cdOrigemTransmissao","cdProduto","nroProposta"],"type":"object","properties":{"cdOrigemTransmissao":{"$ref":"#/components/schemas/cdOrigemTransmissao"},"cdProduto":{"$ref":"#/components/schemas/cdProduto"},"nroProposta":{"$ref":"#/components/schemas/nroProposta"}}}}},{"connectionName":"bradesco","actionName":"seguroprestamista_swaggercotacaoprestv3/post_v1_produto_consulta_proposta_pdf_cheque_empresarial","parameters":{"data":{"required":["cdOrigemTransmissao","cdProduto","nCtrlCotac"],"type":"object","properties":{"nCtrlCotac":{"$ref":"#/components/schemas/nCtrlCotac"},"cdProduto":{"$ref":"#/components/schemas/cdProduto"},"cdOrigemTransmissao":{"$ref":"#/components/schemas/cdOrigemTransmissao"},"nroContrBanco":{"$ref":"#/components/schemas/nroContrBanco"},"nroProtocolo":{"$ref":"#/components/schemas/nroProtocolo"}}}}},{"connectionName":"bradesco","actionName":"seguroviagem_aceite_digital/get_api_v1_aceite_digital_correntista_by_cpf_by_sistema_requerente_id","parameters":{"cpf":{"type":"string","description":"CPF do cliente (Correntista)"},"sistemaRequerenteId":{"type":"string","description":"Id do sistema reponsavel pela interface do aceite digital ex. IB ou APP"}}},{"connectionName":"bradesco","actionName":"seguroviagem_aceite_digital/post_api_v1_aceite_digital_confirmar_aceite","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_aceite_digital/post_api_v1_aceite_digital_cancelar_aceite","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_contratacao/get_api_v1_vendas_comum_sucursais","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_contratacao/post_api_v1_vendas_cotacao_seguro_viagem_contratar_seguro_viagem","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_cotacao/get_api_v1_vendas_cotacao_view_models_seguro_viagem","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_cotacao/post_api_v1_vendas_cotacao_seguro_viagem_cotar","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/get_api_v1_vendas_proposta_individual_pesquisa","parameters":{"cpf":{"type":"string","description":"Informar o n�mero do documento"},"segurado":{"type":"string","description":"Informar o segurado"},"numeroProposta":{"type":"string","description":"Informar o n�mero da proposta"},"produtoId":{"type":"string","description":"Informar o id do produto"},"planoId":{"type":"string","description":"Informar o id do plano"},"propostaId":{"type":"string","description":"Informar o id da proposta"},"statusProposta":{"type":"string","description":"Informar o status da proposta"},"seguradoraId":{"type":"string","description":"Informar o id do segurado"},"sucursalId":{"type":"string","description":"Informar o id da sucursal"},"dataInicio":{"type":"string","description":"data assinatura inicial ex. '2019-01-20'"},"dataFinal":{"type":"string","description":"data assinatura final ex. '2019-01-20'"},"sentidoOrdenacao":{"type":"string","description":"'asc' ou 'desc'"},"campoOrdenacao":{"type":"string","description":"a pesquisa pode ser ordernada por esses campos:\r\n 'CPFCNPJ' ou\r\n 'Nome' ou\r\n 'NumeroProposta' ou\r\n 'DataDigitacao' ou\r\n 'Produto.Codigo' ou\r\n 'Produto.Descricao' ou\r\n 'Plano.Codigo' ou\r\n 'Plano.Descricao' ou\r\n 'Seguradora.Codigo' ou\r\n 'Seguradora.Descricao' ou\r\n 'Sucursal.Codigo' ou\r\n 'Nome' ou \r\n 'Sucursal.Descricao' ou\r\n 'Status.Codigo' ou\r\n 'Status.Descricao' ou\r\n 'EtapaCadastro.Codigo' ou\r\n 'EtapaCadastro.Descricao' ou\r\n 'PermiteDigitalizacaoGCC' ou"},"paginaAtual":{"type":"string","description":"Informar a paginal atual do grid"},"qtdItensPorPagina":{"type":"string","description":"informar a quantidade maxima para ser retornado na pesquisa"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/post_api_v1_vendas_proposta_individual_dados_viagem","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/get_api_v1_vendas_proposta_individual_by_proposta_id_demais_viajantes","parameters":{"propostaId":{"type":"string"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/post_api_v1_vendas_proposta_individual_by_proposta_id_demais_viajantes","parameters":{"propostaId":{"type":"string"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/post_api_v1_vendas_proposta_individual_by_proposta_id_segurado","parameters":{"propostaId":{"type":"string","description":"Id da proposta. Par�metro obrigat�rio"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/get_api_v1_vendas_proposta_view_models_estrutura_comercial_by_seguradora_id_by_produto_id_by_plano_id","parameters":{"seguradoraId":{"type":"string","description":"Informar o Id do segurado. Par�metro obrigat�rio"},"produtoId":{"type":"string","description":"Informar o Id do produto. Par�metro obrigat�rio"},"planoId":{"type":"string","description":"Informar o Id do plano. Par�metro obrigat�rio"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/post_api_v1_vendas_proposta_by_proposta_id_add_or_update_estrutura_comercial","parameters":{"propostaId":{"type":"string","description":"Id da proposta. Par�metro obrigat�rio"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/get_api_v1_vendas_proposta_view_models_dados_cobranca_by_proposta_id","parameters":{"propostaId":{"type":"string","description":"Informar o Id da proposta. Par�metro obrigat�rio"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/post_api_v1_vendas_proposta_by_proposta_id_add_or_update_dados_cobranca","parameters":{"propostaId":{"type":"string","description":"Id da proposta. Par�metro obrigat�rio"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/post_api_v1_vendas_proposta_calcular_premio","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/post_api_v1_vendas_proposta_by_proposta_id_imprimir","parameters":{"propostaId":{"type":"string","description":"Id da proposta. Par�metro obrigat�rio"},"seguradoId":{"type":"string"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/post_api_v1_vendas_proposta_validar","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/post_api_v1_vendas_proposta_by_proposta_id_emitir","parameters":{"propostaId":{"type":"string","description":""}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/get_api_v1_vendas_proposta_view_models_acompanhamento_by_proposta_id","parameters":{"propostaId":{"type":"string"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/get_api_v1_vendas_proposta_view_models_dados_do_segurado_by_proposta_id","parameters":{"propostaId":{"type":"string","description":"Informar o Id da proposta. Par�metro obrigat�rio"}}},{"connectionName":"bradesco","actionName":"seguroviagem_proposta/get_api_v1_vendas_comum_enum","parameters":{}},{"connectionName":"bradesco","actionName":"seguroviagem_servicos/get_api_v1_servicos_bradesco_correntista_by_cpf","parameters":{"cpf":{"type":"string","description":"� necessario informar o documento CPF para realizar a pesquisa. Par�metro obrigat�rio"}}},{"connectionName":"bradesco","actionName":"vida_vida/get_produtos","parameters":{"Authorization":{"type":"string","description":"Authorization"},"token":{"type":"string","description":"token"}}},{"connectionName":"bradesco","actionName":"vida_vida/get_produtos_informacoes","parameters":{"Authorization":{"type":"string","description":"Authorization"},"token":{"type":"string","description":"token"}}},{"connectionName":"bradesco","actionName":"vida_vida/get_produtos_planos_caracteristicas","parameters":{"Authorization":{"type":"string","description":"Authorization"},"token":{"type":"string","description":"parametros criptografados:\r\nCodigoOrigem [Numerico, 4] - Código de Acesso Origem\r\nChaveProduto [Texto] - Chave do Produto\r\nChavePlano [Texto] - Chave do Plano"}}},{"connectionName":"bradesco","actionName":"vida_vida/get_produtos_planos","parameters":{"Authorization":{"type":"string","description":"Authorization"},"token":{"type":"string","description":"parametros criptografados:\r\nCodigoOrigem [Numerico, 4] - Código de Acesso Origem\r\nChaveProduto [Texto] - Chave do Produto"}}},{"connectionName":"bradesco","actionName":"vida_vida/get_produtos_coberturas","parameters":{"Authorization":{"type":"string","description":"Authorization"},"token":{"type":"string","description":"token"}}}],"slug":"bradesco","created_at":"2025-09-25T18:49:39.463Z"},{"id":"brex","name":"Brex","description":"Manage your corporate cards and expenses with Brex.","logo_url":"https://assets.abstra.cloud/connectors/logos/brex.png","category":[],"triggers":["EXPENSE_PAYMENT_UPDATED","REFERRAL_CREATED","REFERRAL_ACTIVATED","REFERRAL_APPLICATION_STATUS_CHANGED","TRANSFER_PROCESSED","TRANSFER_FAILED","USER_UPDATED"],"actions":[{"connectionName":"brex","actionName":"budgets/get_v1_budget_programs","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"budgets/post_v1_budget_programs","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["budget_blueprints","name"],"type":"object","properties":{"existing_budget_ids":{"type":"array","description":"\nIDs for existing Spend Limits associated with this Budget Program.\n","nullable":true,"items":{"type":"string"}},"budget_blueprints":{"type":"array","items":{"$ref":"#/components/schemas/CreateBudgetBlueprintRequest"}},"employee_filter":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/EmployeeFilter"}]},"name":{"type":"string"},"description":{"type":"string","nullable":true}},"description":"\nBudget Program used to create Spend Limits for eligible users.\n"}}},{"connectionName":"brex","actionName":"budgets/get_v1_budget_programs_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"budgets/put_v1_budget_programs_by_id","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"type":"object","properties":{"existing_budget_ids":{"type":"array","description":"\nIDs for existing Spend Limits associated with this Budget Program.\n","nullable":true,"items":{"type":"string"}},"budget_blueprints":{"type":"array","description":"\nThe Blueprints to update the budget program with. Blueprints without an ID are treated as new blueprints to be created.\nBlueprints that exist currently on the Budget Program, but are missing from the input, will be deleted.\n","nullable":true,"items":{"$ref":"#/components/schemas/UpdateBudgetBlueprintRequest"}},"employee_filter":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/EmployeeFilter"}]},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"description":"\nBudget Program used to create Spend Limits for eligible users.\n"}}},{"connectionName":"brex","actionName":"budgets/delete_v1_budget_programs_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"budgets/get_v1_budgets","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"budgets/post_v1_budgets","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["description","limit","limit_type","limit_visibility","name","parent_budget_id","period_type","spend_type"],"type":"object","properties":{"name":{"type":"string","description":"\nName for the Spend Limit.\n"},"description":{"type":"string","description":"\nDescription of what the Spend Limit is used for.\n"},"parent_budget_id":{"type":"string","description":"\nID of parent Budget.\n"},"owner_user_ids":{"type":"array","description":"\nUser IDs of the owners of the Spend Limit.\n","nullable":true,"items":{"type":"string"}},"member_user_ids":{"type":"array","description":"\nUser IDs of the members of the Spend Limit.\n","nullable":true,"items":{"type":"string"}},"period_type":{"$ref":"#/components/schemas/PeriodType"},"limit":{"$ref":"#/components/schemas/Money"},"limit_type":{"$ref":"#/components/schemas/LimitType"},"spend_type":{"$ref":"#/components/schemas/SpendType"},"start_date":{"type":"string","description":"\nThe UTC date when the Spend Limit should start counting.\n","format":"date","nullable":true},"end_date":{"type":"string","description":"\nThe UTC date when the Spend Limit should stop counting.\n","format":"date","nullable":true},"limit_visibility":{"$ref":"#/components/schemas/BudgetLimitVisibilityType"},"policy_id":{"type":"string","nullable":true},"entity_id":{"type":"string","nullable":true}}}}},{"connectionName":"brex","actionName":"budgets/get_v1_budgets_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"budgets/put_v1_budgets_by_id","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"type":"object","properties":{"name":{"type":"string","description":"\nName for the Spend Limit.\n","nullable":true},"description":{"type":"string","description":"\nDescription of what the Spend Limit is used for.\n","nullable":true},"owner_user_ids":{"type":"array","description":"\nUser IDs of the owners of the Spend Limit.\n","nullable":true,"items":{"type":"string"}},"member_user_ids":{"type":"array","description":"\nUser IDs of the members of the Spend Limit.\n","nullable":true,"items":{"type":"string"}},"limit":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Money"}]},"limit_type":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LimitType"}]},"spend_type":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SpendType"}]},"start_date":{"type":"string","description":"\nThe UTC date when the Spend Limit should start counting.\n","format":"date","nullable":true},"end_date":{"type":"string","description":"\nThe UTC date when the Spend Limit should stop counting.\n","format":"date","nullable":true},"limit_visibility":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BudgetLimitVisibilityType"}]},"period_type":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PeriodType"}]}}}}},{"connectionName":"brex","actionName":"budgets/post_v1_budgets_by_id_archive","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"budgets/get_v2_budgets","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"budgets/post_v2_budgets","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["amount","description","name","parent_budget_id","period_recurrence_type"],"type":"object","properties":{"name":{"type":"string","description":"\nName for the Budget.\n"},"description":{"type":"string","description":"\nDescription of what the Budget is used for.\n"},"parent_budget_id":{"type":"string","description":"\nID of parent Budget.\n"},"owner_user_ids":{"type":"array","description":"\nUser IDs of the owners of the Budget.\n","nullable":true,"items":{"type":"string"}},"period_recurrence_type":{"allOf":[{"$ref":"#/components/schemas/PeriodRecurrenceType"},{"description":"\nPeriod type of the Budget e.g. MONTHLY.\n"}]},"amount":{"$ref":"#/components/schemas/Money"},"limit_type":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LimitType_3"},{"description":"\nWhether the Budget amount blocks spend.\n"}]},"start_date":{"type":"string","description":"\nThe date when the Budget should start counting.\n","format":"date","nullable":true},"end_date":{"type":"string","description":"\nThe date when the Budget should stop counting.\n","format":"date","nullable":true}}}}},{"connectionName":"brex","actionName":"budgets/get_v2_budgets_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"budgets/put_v2_budgets_by_id","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"type":"object","properties":{"name":{"type":"string","description":"\nName for the Budget.\n","nullable":true},"description":{"type":"string","description":"\nDescription of what the Budget is used for.\n","nullable":true},"parent_budget_id":{"type":"string","description":"\nID of parent Budget.\n","nullable":true},"owner_user_ids":{"type":"array","description":"\nUser IDs of the owners of the Budget.\n","nullable":true,"items":{"type":"string"}},"period_recurrence_type":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PeriodRecurrenceType"},{"description":"\nPeriod type of the Budget e.g. MONTHLY.\n"}]},"amount":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Money"},{"description":"\nTarget amount for the Budget to track.\n"}]},"limit_type":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LimitType_4"},{"description":"\nWhether the Budget amount blocks spend.\n"}]},"start_date":{"type":"string","description":"\nThe date when the Budget should start counting.\n","format":"date","nullable":true},"end_date":{"type":"string","description":"\nThe date when the Budget should stop counting.\n","format":"date","nullable":true}}}}},{"connectionName":"brex","actionName":"budgets/post_v2_budgets_by_id_archive","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"budgets/get_v2_spend_limits","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"},"member_user_id[]":{"type":"array"}}},{"connectionName":"brex","actionName":"budgets/post_v2_spend_limits","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["authorization_settings","authorization_visibility","auto_create_limit_cards_setting","auto_transfer_cards_setting","expense_policy_id","expense_visibility","limit_increase_setting","name","period_recurrence_type","spend_type"],"type":"object","properties":{"name":{"type":"string","description":"\nName for the Spend Limit.\n"},"description":{"type":"string","description":"\nDescription of what the Spend Limit is used for.\n","nullable":true},"parent_budget_id":{"type":"string","description":"\nID of parent Budget.\n","nullable":true},"period_recurrence_type":{"allOf":[{"$ref":"#/components/schemas/SpendLimitPeriodRecurrenceType"},{"description":"\nPeriod type of the Spend Limit e.g. MONTHLY.\n"}]},"start_date":{"type":"string","description":"\nThe date when the Spend Limit should start counting.\n","format":"date","nullable":true},"end_date":{"type":"string","description":"\nThe date when the Spend Limit should expire.\n","format":"date","nullable":true},"authorization_settings":{"allOf":[{"$ref":"#/components/schemas/CreateAuthorizationSettings"},{"description":"\nSpend authorization settings.\n"}]},"expense_visibility":{"allOf":[{"$ref":"#/components/schemas/ExpenseVisibility"},{"description":"\nWhether or not expense related to this Spend Limit should be viewable to all members.\n"}]},"authorization_visibility":{"allOf":[{"$ref":"#/components/schemas/AuthorizationVisibility"},{"description":"\nDescribes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral).\n"}]},"transaction_limit":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Money"},{"description":"\nThe transaction limit that this Spend Limit will enforce.\n"}]},"limit_increase_setting":{"allOf":[{"$ref":"#/components/schemas/LimitIncreaseSetting"},{"description":"\nWhether or not members can request limit increases.\n"}]},"spend_type":{"allOf":[{"$ref":"#/components/schemas/SpendType"},{"description":"\nWhether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. \n"}]},"auto_transfer_cards_setting":{"allOf":[{"$ref":"#/components/schemas/AutoTransferCardsSetting"},{"description":"\nSetting for how auto transfer works for virtual cards.\n"}]},"auto_create_limit_cards_setting":{"allOf":[{"$ref":"#/components/schemas/AutoCreateLimitCardsSetting"},{"description":"\nSetting for how auto limit card creation works for members.\n"}]},"owner_user_ids":{"type":"array","description":"\nUser IDs of the owners of the Spend Limit.\n","nullable":true,"items":{"type":"string"}},"member_user_ids":{"type":"array","description":"\nUser IDs of the members of the Spend Limit.\n","nullable":true,"items":{"type":"string"}},"expense_policy_id":{"type":"string","description":"\nThe ID of the expense policy corresponding to this Spend Limit.\n"},"limit_increase_request_policy_id":{"type":"string","description":"\nThe ID of the policy for limit increase requests for this Spend Limit.\n","nullable":true},"limit_approval_policy_id":{"type":"string","description":"\nThe ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id.\n","nullable":true},"legal_entity_id":{"type":"string","description":"\nThe legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user's entity.\n","nullable":true},"department_id":{"type":"string","description":"\nThe department ID to which Spend Limit expenses will be attributed.\n","nullable":true}}}}},{"connectionName":"brex","actionName":"budgets/get_v2_spend_limits_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"budgets/put_v2_spend_limits_by_id","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"type":"object","properties":{"name":{"type":"string","description":"\nName for the Spend Limit.\n","nullable":true},"description":{"type":"string","description":"\nDescription of what the Spend Limit is used for.\n","nullable":true},"status":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SpendLimitStatus"},{"description":"\nStatus of the Spend Limit e.g. ACTIVE.\n"}]},"period_recurrence_type":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SpendLimitPeriodRecurrenceType"},{"description":"\nPeriod type of the Spend Limit e.g. MONTHLY.\n"}]},"start_date":{"type":"string","description":"\nThe date when the Spend Limit should start counting.\n","format":"date","nullable":true},"end_date":{"type":"string","description":"\nThe date when the Spend Limit should expire.\n","format":"date","nullable":true},"authorization_settings":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/UpdateAuthorizationSettings"},{"description":"\nSpend authorization settings.\n"}]},"expense_visibility":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ExpenseVisibility"},{"description":"\nWhether or not expense related to this Spend Limit should be viewable to all members.\n"}]},"authorization_visibility":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/AuthorizationVisibility"},{"description":"\nDescribes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral).\n"}]},"merchant_category_controls":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/MerchantCategoryControls"},{"description":"\nThe Spend Limit's merchant category controls.\n"}]},"transaction_limit":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Money"},{"description":"\nThe transaction limit that this Spend Limit will enforce.\n"}]},"limit_increase_setting":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LimitIncreaseSetting"},{"description":"\nWhether or not members can request limit increases.\n"}]},"spend_type":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SpendType"},{"description":"\nWhether this Spend Limit only can be spent from by cards provisioned by this Spend Limit. \n"}]},"auto_transfer_cards_setting":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/AutoTransferCardsSetting"},{"description":"\nSetting for how auto transfer works for virtual cards.\n"}]},"auto_create_limit_cards_setting":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/AutoCreateLimitCardsSetting"},{"description":"\nSetting for how auto limit card creation works for members.\n"}]},"owner_user_ids":{"type":"array","description":"\nUser IDs of the owners of the Spend Limit.\n","nullable":true,"items":{"type":"string"}},"member_user_ids":{"type":"array","description":"\nUser IDs of the members of the Spend Limit.\n","nullable":true,"items":{"type":"string"}},"expense_policy_id":{"type":"string","description":"\nThe ID of the expense policy corresponding to this Spend Limit.\n","nullable":true},"limit_increase_request_policy_id":{"type":"string","description":"\nThe ID of the policy for limit increase requests for this Spend Limit.\n","nullable":true},"limit_approval_policy_id":{"type":"string","description":"\nThe ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id.\n","nullable":true},"legal_entity_id":{"type":"string","description":"\nThe legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user's entity.\n","nullable":true},"department_id":{"type":"string","description":"\nThe department ID to which Spend Limit expenses will be attributed.\n","nullable":true}}}}},{"connectionName":"brex","actionName":"budgets/post_v2_spend_limits_by_id_archive","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"expenses/get_v1_expenses","parameters":{"expand[]":{"type":"array","description":"Get additional details for the expense, e.g. merchant mcc code, by passing in `expand[]=merchant`. Query parameters include `location`, `department`, `merchant`, `receipts.download_uris`, `user`, `budget` and `payment`."},"user_id[]":{"type":"array","description":"Get expenses belong to provided user(s)."},"parent_expense_id[]":{"type":"array","description":"Get itemized expenses belong to provided parent expenses ID(s)."},"budget_id[]":{"type":"array"},"spending_entity_id[]":{"type":"array"},"expense_type[]":{"type":"array"},"status[]":{"type":"array"},"payment_status[]":{"type":"array"},"purchased_at_start":{"type":"string","description":"\nShows only expenses with a `purchased_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"purchased_at_end":{"type":"string","description":"\nShows only expenses with a `purchased_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"updated_at_start":{"type":"string","description":"\nShows only expenses with a `updated_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"updated_at_end":{"type":"string","description":"\nShows only expenses with a `updated_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"payment_posted_at_start":{"type":"string","description":"\nShows only expenses with a `payment_posted_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"payment_posted_at_end":{"type":"string","description":"\nShows only expenses with a `payment_posted_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"load_custom_fields":{"type":"boolean","description":"Load custom fields for the expenses."},"cursor":{"type":"string","description":"\nThe cursor to use for pagination. This is the `next_cursor` value returned from the previous response.\n"},"limit":{"type":"integer","description":"\nControls the maximum number of expenses returned in the response, can't be greater than 1000\n"}}},{"connectionName":"brex","actionName":"expenses/get_v1_expenses_card","parameters":{"expand[]":{"type":"array","description":"Get additional details for the expense, e.g. merchant mcc code, by passing in `expand[]=merchant`. Query parameters include `location`, `department`, `merchant`, `receipts.download_uris`, `user`, `budget` and `payment`."},"user_id[]":{"type":"array","description":"Get expenses belong to provided user(s)."},"parent_expense_id[]":{"type":"array","description":"Get itemized expenses belong to provided parent expenses ID(s)."},"budget_id[]":{"type":"array"},"spending_entity_id[]":{"type":"array"},"status[]":{"type":"array"},"payment_status[]":{"type":"array"},"purchased_at_start":{"type":"string","description":"\nShows only expenses with a `purchased_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"purchased_at_end":{"type":"string","description":"\nShows only expenses with a `purchased_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"updated_at_start":{"type":"string","description":"\nShows only expenses with a `updated_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"updated_at_end":{"type":"string","description":"\nShows only expenses with a `updated_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"payment_posted_at_start":{"type":"string","description":"\nShows only expenses with a `payment_posted_at` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"payment_posted_at_end":{"type":"string","description":"\nShows only expenses with a `payment_posted_at` on or before this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), e.g. 2022-11-12T23:59:59.999\n"},"load_custom_fields":{"type":"boolean","description":"Load custom fields for the expenses."},"cursor":{"type":"string","description":"\nThe cursor to use for pagination. This is the `next_cursor` value returned from the previous response.\n"},"limit":{"type":"integer","description":"\nControls the maximum number of expenses returned in the response, can't be greater than 1000\n"}}},{"connectionName":"brex","actionName":"expenses/post_v1_expenses_card_receipt_match","parameters":{"data":{"required":["receipt_name"],"type":"object","properties":{"receipt_name":{"type":"string","description":"The name of the receipt (with the file extension). It will be used in the matching result email."}},"description":"The parameter for creating a receipt match."}}},{"connectionName":"brex","actionName":"expenses/get_v1_expenses_card_by_expense_id","parameters":{"expense_id":{"type":"string"},"expand[]":{"type":"array","description":"Get additional details for the expense, e.g. merchant mcc code, by passing in `expand[]=merchant`. Query parameters include `location`, `department`, `merchant`, `receipts.download_uris`, `user`, `budget` and `payment`."},"load_custom_fields":{"type":"boolean","description":"Load custom fields for the expense."}}},{"connectionName":"brex","actionName":"expenses/put_v1_expenses_card_by_expense_id","parameters":{"expense_id":{"type":"string"},"data":{"type":"object","properties":{"memo":{"type":"string","description":"Expense memo.","nullable":true}},"description":"The parameter for updating an expense."}}},{"connectionName":"brex","actionName":"expenses/post_v1_expenses_card_by_expense_id_receipt_upload","parameters":{"expense_id":{"type":"string"},"data":{"required":["receipt_name"],"type":"object","properties":{"receipt_name":{"type":"string","description":"The name of the receipt (with the file extension)."}},"description":"The parameter for creating a receipt upload."}}},{"connectionName":"brex","actionName":"expenses/get_v1_expenses_by_id","parameters":{"id":{"type":"string"},"expand[]":{"type":"array","description":"Get additional details for the expense, e.g. merchant mcc code, by passing in `expand[]=merchant`. Query parameters include `location`, `department`, `merchant`, `receipts.download_uris`, `user`, `budget` and `payment`."},"load_custom_fields":{"type":"boolean","description":"Load custom fields for the expense."}}},{"connectionName":"brex","actionName":"fields/get_v1_fields","parameters":{"field_id[]":{"type":"array","description":"The Brex identifiers of the field to filter by"},"cursor":{"type":"string","description":"The cursor to use for pagination. This is the `next_cursor` value returned from the previous response."},"limit":{"type":"integer","description":"Controls the maximum number of field values returned in the response. It can't be greater than 1000."}}},{"connectionName":"brex","actionName":"fields/post_v1_fields","parameters":{"Idempotency-Key":{"type":"string","description":"Idempotency key for this request."},"data":{"title":"Field creation","required":["group","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the field"},"group":{"allOf":[{"$ref":"#/components/schemas/FieldGroup"},{"description":"The category of the field, indicating its purpose or context. For example, it could belong to accounting-related fields or user-related fields."}]},"remote_id":{"type":"string","description":"Remote/external ID of custom field from external system (e.g. ERP or HRIS system)","nullable":true,"example":"foo_bar"},"is_disabled":{"type":"boolean","description":"Indicates if the field is disabled","nullable":true}},"description":"Represents the data needed to create a field"}}},{"connectionName":"brex","actionName":"fields/get_v1_fields_by_field_id_values","parameters":{"field_id":{"type":"string","description":"The Field Brex identifier"},"brex_id[]":{"type":"array","description":"Field value Brex identifier(s) to filter by"},"value_id[]":{"type":"array","description":"Field value identifier(s) to filter by"},"remote_id[]":{"type":"array","description":"Field value remote identifier(s) to filter by"},"cursor":{"type":"string","description":"The cursor to use for pagination. This is the `next_cursor` value returned from the previous response."},"limit":{"type":"integer","description":"Controls the maximum number of field values returned in the response. It can't be greater than 1000."},"value":{"type":"string","description":"Field value's value to filter by"}}},{"connectionName":"brex","actionName":"fields/put_v1_fields_by_field_id_values","parameters":{"field_id":{"type":"string","description":"The Field Brex identifier"},"data":{"title":"Field value list update","required":["items"],"type":"object","properties":{"items":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/UpdateFieldValueBody"}}},"description":"Represents the data needed to update multiple field values. It can't contain more than 1000 values at once."}}},{"connectionName":"brex","actionName":"fields/post_v1_fields_by_field_id_values","parameters":{"field_id":{"type":"string","description":"The Field Brex identifier"},"Idempotency-Key":{"type":"string","description":"Idempotency key for this request."},"data":{"title":"Field value list creation","required":["items"],"type":"object","properties":{"items":{"minItems":1,"type":"array","description":"The list of field values to be created","items":{"$ref":"#/components/schemas/CreateFieldValueBody"}}},"description":"Represents the data needed to create multiple field values. It can't contain more than 1000 values at once."}}},{"connectionName":"brex","actionName":"fields/delete_v1_fields_by_field_id_values","parameters":{"field_id":{"type":"string","description":"The Field Brex identifier"},"data":{"title":"Field value list deletion","required":["items"],"type":"object","properties":{"items":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/DeleteFieldValueBody"}}},"description":"Represents the data needed to delete field values. It can't contain more than 1000 values at once."}}},{"connectionName":"brex","actionName":"fields/get_v1_fields_by_field_id_values_by_brex_id","parameters":{"field_id":{"type":"string","description":"The Field Brex identifier"},"brex_id":{"type":"string","description":"The field value ID (`brex_id`) to retrieve."}}},{"connectionName":"brex","actionName":"fields/get_v1_fields_by_id","parameters":{"id":{"type":"string","description":"The Brex identifier of the field to retrieve"}}},{"connectionName":"brex","actionName":"fields/put_v1_fields_by_id","parameters":{"id":{"type":"string","description":"The Brex identifier of the field to update"},"data":{"title":"Field update","type":"object","properties":{"name":{"type":"string","description":"The name of the field","nullable":true},"is_disabled":{"type":"boolean","description":"Indicates if the field is disabled","nullable":true}},"description":"Represents the data needed to update a field"}}},{"connectionName":"brex","actionName":"fields/delete_v1_fields_by_id","parameters":{"id":{"type":"string","description":"The Brex identifier of the field to delete"}}},{"connectionName":"brex","actionName":"onboarding/get_v1_referrals","parameters":{"cursor":{"type":"string"}}},{"connectionName":"brex","actionName":"onboarding/post_v1_referrals","parameters":{"data":{"required":["applicant","referral_code"],"type":"object","properties":{"referral_code":{"required":["true"],"type":"string","description":"Referral code that attributes credit to you if the prospect signs up for a Brex account."},"applicant":{"$ref":"#/components/schemas/Applicant"},"business":{"allOf":[{"$ref":"#/components/schemas/Business"},{"nullable":true}]},"contact_preference":{"allOf":[{"$ref":"#/components/schemas/ContactPreference"},{"nullable":true}]}},"description":"Submit a new referral to Brex for onboarding."}}},{"connectionName":"brex","actionName":"onboarding/get_v1_referrals_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"onboarding/post_v1_referrals_by_id_document_upload","parameters":{"id":{"type":"string"},"data":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentType"}},"description":"Request for creating new document upload URL."}}},{"connectionName":"brex","actionName":"payments/post_v1_incoming_transfers","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["amount","counterparty","description","receiving_account"],"type":"object","properties":{"counterparty":{"$ref":"#/components/schemas/CounterPartyIncomingTransfer"},"receiving_account":{"$ref":"#/components/schemas/ReceivingAccount"},"amount":{"$ref":"#/components/schemas/Money"},"description":{"type":"string","description":" \nDescription of the transfer for internal use. Not exposed externally. \n"}}}}},{"connectionName":"brex","actionName":"payments/get_v1_linked_accounts","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"payments/get_v1_transfers","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"payments/post_v1_transfers","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["amount","counterparty","description","external_memo","originating_account"],"type":"object","properties":{"counterparty":{"$ref":"#/components/schemas/CounterParty"},"amount":{"$ref":"#/components/schemas/Money"},"description":{"type":"string","description":"Description of the transfer for internal use. Not exposed externally."},"external_memo":{"maxLength":90,"type":"string","description":"External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. \nMust be at most 90 characters for `ACH` and `WIRE` transactions\nand at most 40 characters for `CHEQUES`\n"},"originating_account":{"allOf":[{"$ref":"#/components/schemas/OriginatingAccount"},{"description":"Brex originating account details. Account IDs are returned by the /accounts\nendpoint. This endpoint currently only supports accounts with instrument type `CASH` (Brex business accounts)\nCurrently only USD transfers are supported and amount should be positive\n"}]},"approval_type":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ApprovalType"}]},"is_ppro_enabled":{"type":"boolean","description":"When set to true, add Principal Protection (PPRO) to the transaction.\n PPRO means Brex will cover any fees charged by intemediary or receiving banks. PPRO charges will be billed separately\n in a monthly statement. PPRO is only available for international wire transactions.\n"}}}}},{"connectionName":"brex","actionName":"payments/get_v1_transfers_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"payments/get_v1_vendors","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"},"name":{"type":"string"}}},{"connectionName":"brex","actionName":"payments/post_v1_vendors","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["company_name"],"type":"object","properties":{"company_name":{"type":"string","description":"Name for vendor. The name must be unique."},"email":{"type":"string","description":"Email for vendor.","format":"email","nullable":true},"phone":{"type":"string","description":"Phone number for vendor.","nullable":true},"payment_accounts":{"type":"array","description":"Payment accounts associated with the vendor.","nullable":true,"items":{"$ref":"#/components/schemas/PaymentAccountRequest"}}}}}},{"connectionName":"brex","actionName":"payments/get_v1_vendors_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"payments/put_v1_vendors_by_id","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"type":"object","properties":{"company_name":{"type":"string","description":"Name for vendor","nullable":true},"email":{"type":"string","description":"Email for vendor","format":"email","nullable":true},"phone":{"type":"string","description":"Phone number for vendor","nullable":true},"payment_accounts":{"type":"array","description":"To update payment instruments, we require the entire payload for each payment instrument that is being updated.\n","nullable":true,"items":{"$ref":"#/components/schemas/PaymentAccountRequest"}},"beneficiary_name":{"type":"string","description":"Name for the Beneficiary","nullable":true}}}}},{"connectionName":"brex","actionName":"payments/delete_v1_vendors_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"team/get_v2_cards","parameters":{"user_id":{"type":"string"},"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"team/post_v2_cards","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["card_name","card_type","limit_type","owner"],"type":"object","properties":{"owner":{"$ref":"#/components/schemas/CardOwner"},"card_name":{"minLength":1,"type":"string"},"card_type":{"$ref":"#/components/schemas/CardType"},"limit_type":{"$ref":"#/components/schemas/LimitType"},"spend_controls":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SpendControlRequest"}]},"mailing_address":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Address"}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"\nSet of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here.\nLimitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. \n","nullable":true},"card_attribute_preferences":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/CardAttributePreferences"}]}},"description":"\nThe `spend_controls` field is required when `limit_type` = `CARD`.\nThe `shipping_address` field is required for physical cards, and the first 2 lines of the address must be under 60 characters long.\n"}}},{"connectionName":"brex","actionName":"team/get_v2_cards_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"team/put_v2_cards_by_id","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"type":"object","properties":{"spend_controls":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SpendControlUpdateRequest"}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"\nSet of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here.\nLimitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. \n","nullable":true}}}}},{"connectionName":"brex","actionName":"team/post_v2_cards_by_id_lock","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"required":["reason"],"type":"object","properties":{"description":{"type":"string","description":"Description for locking a card","nullable":true},"reason":{"$ref":"#/components/schemas/ChangeCardReason"}},"description":"Parameters for locking a card."}}},{"connectionName":"brex","actionName":"team/get_v2_cards_by_id_pan","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"team/post_v2_cards_by_id_secure_email","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"required":["recipient_email","sender_name"],"type":"object","properties":{"recipient_email":{"type":"string","description":"Email address to send card details to"},"sender_name":{"type":"string","description":"Sender name. Shows up in the subject of the email"},"message":{"type":"string","description":"Message to send with the card details","nullable":true},"expiry_days":{"maximum":30,"type":"integer","description":"Link expiry in number of days. Defaults to 30","format":"int32","nullable":true}}}}},{"connectionName":"brex","actionName":"team/post_v2_cards_by_id_terminate","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"required":["reason"],"type":"object","properties":{"description":{"type":"string","description":"Description for terminating a card","nullable":true},"reason":{"$ref":"#/components/schemas/ChangeCardReason"}},"description":"Parameters for terminating a card."}}},{"connectionName":"brex","actionName":"team/post_v2_cards_by_id_unlock","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"}}},{"connectionName":"brex","actionName":"team/get_v2_company","parameters":{}},{"connectionName":"brex","actionName":"team/get_v2_departments","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"},"name":{"type":"string"}}},{"connectionName":"brex","actionName":"team/post_v2_departments","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the department"},"description":{"type":"string","description":"Description of the department","nullable":true}}}}},{"connectionName":"brex","actionName":"team/get_v2_departments_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"team/get_v2_legal_entities","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"team/get_v2_legal_entities_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"team/get_v2_locations","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"},"name":{"type":"string"}}},{"connectionName":"brex","actionName":"team/post_v2_locations","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the location"},"description":{"type":"string","description":"Description of the location","nullable":true}}}}},{"connectionName":"brex","actionName":"team/get_v2_locations_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"team/get_v2_titles","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"},"name":{"type":"string"}}},{"connectionName":"brex","actionName":"team/post_v2_titles","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the title"}}}}},{"connectionName":"brex","actionName":"team/get_v2_titles_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"team/get_v2_users","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"},"email":{"type":"string"},"remote_display_id":{"type":"string"},"expand[]":{"type":"array"}}},{"connectionName":"brex","actionName":"team/post_v2_users","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["email","first_name","last_name"],"type":"object","properties":{"first_name":{"minLength":1,"type":"string"},"last_name":{"minLength":1,"type":"string"},"email":{"type":"string","format":"email"},"manager_id":{"type":"string","nullable":true},"department_id":{"type":"string","nullable":true},"location_id":{"type":"string","nullable":true},"title_id":{"type":"string","nullable":true},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"The metadata or customized attributes of the user. Maximum number of entries: 100","nullable":true}}}}},{"connectionName":"brex","actionName":"team/get_v2_users_me","parameters":{}},{"connectionName":"brex","actionName":"team/get_v2_users_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"team/put_v2_users_by_id","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"type":"object","properties":{"status":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/UpdateUserStatus"}]},"manager_id":{"type":"string","description":"The user id of the manager of this user","nullable":true},"department_id":{"type":"string","nullable":true},"location_id":{"type":"string","nullable":true},"title_id":{"type":"string","nullable":true},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"The metadata or customized attributes of the user. Maximum number of entries: 100","nullable":true}}}}},{"connectionName":"brex","actionName":"team/get_v2_users_by_id_limit","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"team/post_v2_users_by_id_limit","parameters":{"id":{"type":"string"},"Idempotency-Key":{"type":"string"},"data":{"type":"object","properties":{"monthly_limit":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Money"}]}},"description":"Request that sets the monthly user limit."}}},{"connectionName":"brex","actionName":"transactions/get_v2_accounts_card","parameters":{}},{"connectionName":"brex","actionName":"transactions/get_v2_accounts_card_primary_statements","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"transactions/get_v2_accounts_cash","parameters":{}},{"connectionName":"brex","actionName":"transactions/get_v2_accounts_cash_primary","parameters":{}},{"connectionName":"brex","actionName":"transactions/get_v2_accounts_cash_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"transactions/get_v2_accounts_cash_by_id_statements","parameters":{"id":{"type":"string"},"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"transactions/get_v2_transactions_card_primary","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"},"user_ids":{"type":"array"},"posted_at_start":{"type":"string","description":"\nShows only transactions with a `posted_at_date` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)\n"},"expand[]":{"type":"array"}}},{"connectionName":"brex","actionName":"transactions/get_v2_transactions_cash_by_id","parameters":{"id":{"type":"string"},"cursor":{"type":"string"},"limit":{"type":"integer"},"posted_at_start":{"type":"string","description":"\nShows only transactions with a `posted_at_date` on or after this date-time. This parameter is the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)\n"}}},{"connectionName":"brex","actionName":"travel/get_v1_trips","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"},"last_updated_after":{"type":"string"}}},{"connectionName":"brex","actionName":"travel/get_v1_trips_by_trip_id","parameters":{"trip_id":{"type":"string"}}},{"connectionName":"brex","actionName":"travel/get_v1_trips_by_trip_id_bookings","parameters":{"trip_id":{"type":"string"},"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"travel/get_v1_trips_by_trip_id_bookings_by_booking_id","parameters":{"trip_id":{"type":"string"},"booking_id":{"type":"string"}}},{"connectionName":"brex","actionName":"webhooks/get_v1_webhooks","parameters":{"cursor":{"type":"string"},"limit":{"type":"integer"}}},{"connectionName":"brex","actionName":"webhooks/post_v1_webhooks","parameters":{"Idempotency-Key":{"type":"string"},"data":{"required":["event_types","url"],"type":"object","properties":{"url":{"type":"string"},"event_types":{"required":["true"],"type":"array","description":"The Brex API sends webhooks for the events listed below.\nFor more details, see the [webhook guide](/docs/webhooks/#webhook-event-catalog) and\n[webhook events API reference](/openapi/webhooks_api/#tag/Webhook-Events).","items":{"$ref":"#/components/schemas/WebhookEventType"}}}}}},{"connectionName":"brex","actionName":"webhooks/get_v1_webhooks_secrets","parameters":{}},{"connectionName":"brex","actionName":"webhooks/get_v1_webhooks_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"brex","actionName":"webhooks/put_v1_webhooks_by_id","parameters":{"id":{"type":"string"},"data":{"required":["event_types","status","url"],"type":"object","properties":{"url":{"type":"string"},"event_types":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEventType"}},"status":{"$ref":"#/components/schemas/UpdateWebhookSubscriptionStatus"}}}}},{"connectionName":"brex","actionName":"webhooks/delete_v1_webhooks_by_id","parameters":{"id":{"type":"string"}}}],"slug":"brex","created_at":"2025-09-25T18:49:39.480Z"},{"id":"clara","name":"Clara","description":"Manage your corporate spending with Clara.","logo_url":"https://assets.abstra.cloud/connectors/logos/clara.png","category":[],"triggers":[],"actions":[{"connectionName":"clara","actionName":"v1/servers_v1_api_docs","parameters":{}},{"connectionName":"clara","actionName":"v1/servers_v2_api_docs","parameters":{}},{"connectionName":"clara","actionName":"v1/get_api_v1_users","parameters":{"page":{"type":"integer","description":"Zero-based page index (0..N)"},"size":{"type":"integer","description":"The size of the page to be returned"},"statusName":{"type":"string","description":"Status of the user"},"role":{"type":"string","description":"Role of the user."}}},{"connectionName":"clara","actionName":"v1/get_api_v1_users_by_uuid","parameters":{"uuid":{"type":"string","description":"User UUID"}}},{"connectionName":"clara","actionName":"v1/get_api_v1_locations","parameters":{"page":{"type":"integer","description":"Zero-based page index (0..N)"},"size":{"type":"integer","description":"The size of the page to be returned"}}},{"connectionName":"clara","actionName":"v1/get_api_v1_locations_by_uuid","parameters":{"uuid":{"type":"string","description":"Location UUID"}}},{"connectionName":"clara","actionName":"v1/get_api_v1_groups","parameters":{"page":{"type":"integer","description":"Zero-based page index (0..N)"},"size":{"type":"integer","description":"The size of the page to be returned"}}},{"connectionName":"clara","actionName":"v1/get_api_v1_groups_by_uuid","parameters":{"uuid":{"type":"string","description":"Group UUID"}}},{"connectionName":"clara","actionName":"v1/get_api_v1_cards","parameters":{"page":{"type":"integer","description":"Zero-based page index (0..N)"},"size":{"type":"integer","description":"The size of the page to be returned"},"userUuid":{"type":"string","description":"UUID of the user for which to retrieve cards"},"status":{"type":"string","description":"Status of the cards"},"periodicityType":{"type":"string","description":"Periodicity of the cards."},"type":{"type":"string","description":"Type of the cards"}}},{"connectionName":"clara","actionName":"v1/get_api_v1_cards_by_uuid","parameters":{"uuid":{"type":"string","description":"Card UUID"}}},{"connectionName":"clara","actionName":"v1/get_api_v1_transactions","parameters":{"page":{"type":"integer","description":"Zero-based page index (0..N)"},"size":{"type":"integer","description":"The size of the page to be returned"},"operationDateRangeStart":{"type":"string","description":"Operation start date"},"operationDateRangeEnd":{"type":"string","description":"Operation max date"},"accountingDateRangeStart":{"type":"string","description":"Accounting start date"},"accountingDateRangeEnd":{"type":"string","description":"Accounting max date"},"userUuid":{"type":"string","description":"UUID of the user associated with the transactions"},"cardUuid":{"type":"string","description":"UUID of the card associated with the transactions"},"merchantCategoryDescription":{"type":"string","description":"Merchant category of the transactions"},"operationTypeCode":{"type":"string","description":"Operation status. Values include 'AU' for Pending and 'OP' for Authorized transactions."}}},{"connectionName":"clara","actionName":"v1/get_api_v1_transactions_by_uuid","parameters":{"uuid":{"type":"string","description":"Transaction UUID"}}},{"connectionName":"clara","actionName":"v2/servers_v1_api_docs","parameters":{}},{"connectionName":"clara","actionName":"v2/servers_v2_api_docs","parameters":{}},{"connectionName":"clara","actionName":"v2/get_api_v2_users","parameters":{"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"},"statusName":{"type":"string","description":"Status of the user"},"role":{"type":"string","description":"Role of the user."}}},{"connectionName":"clara","actionName":"v2/post_api_v2_users","parameters":{}},{"connectionName":"clara","actionName":"v2/get_api_v2_users_by_uuid","parameters":{"uuid":{"type":"string","description":"User UUID"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_locations","parameters":{"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_locations_by_uuid","parameters":{"uuid":{"type":"string","description":"Location UUID"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_groups","parameters":{"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"}}},{"connectionName":"clara","actionName":"v2/put_api_v2_groups","parameters":{}},{"connectionName":"clara","actionName":"v2/post_api_v2_groups","parameters":{}},{"connectionName":"clara","actionName":"v2/get_api_v2_groups_by_uuid","parameters":{"uuid":{"type":"string","description":"Group UUID"}}},{"connectionName":"clara","actionName":"v2/delete_api_v2_groups_by_uuid","parameters":{"uuid":{"type":"string","description":"UUID of the group to delete"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_cards","parameters":{"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"},"userUuid":{"type":"string","description":"UUID of the user for which to retrieve cards"},"username":{"type":"string","description":"Username of the user"},"status":{"type":"string","description":"Status of the cards"},"periodicity":{"type":"string","description":"Periodicity of the cards."},"brand":{"type":"string","description":"Brand of the cards"},"type":{"type":"string","description":"Type of the cards"},"userErpId":{"type":"string","description":"User ERP ID"}}},{"connectionName":"clara","actionName":"v2/post_api_v2_cards","parameters":{}},{"connectionName":"clara","actionName":"v2/get_api_v2_cards_by_uuid","parameters":{"uuid":{"type":"string","description":"Card UUID"}}},{"connectionName":"clara","actionName":"v2/delete_api_v2_cards_by_uuid","parameters":{"uuid":{"type":"string","description":"Card's UUID"}}},{"connectionName":"clara","actionName":"v2/patch_api_v2_cards_by_uuid","parameters":{"uuid":{"type":"string","description":"Card's UUID"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_transactions","parameters":{"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"},"sort":{"type":"string","description":"Sort the results by specific fields and directions. (accountingDate | operationDate),(ASC | DESC)"},"operationDateRangeStart":{"type":"string","description":"Operation start date"},"operationDateRangeEnd":{"type":"string","description":"Operation max date"},"accountingDateRangeStart":{"type":"string","description":"Accounting start date"},"accountingDateRangeEnd":{"type":"string","description":"Accounting max date"},"userUuid":{"type":"string","description":"UUID of the user associated with the transactions"},"cardUuid":{"type":"string","description":"UUID of the card associated with the transactions"},"cardLastDigits":{"type":"string","description":"Masked Pan Last Digits of the card associated with the transactions"},"merchantCategoryDescription":{"type":"string","description":"Merchant category of the transactions"},"userErpId":{"type":"string","description":"ERP id of the transaction user"},"username":{"type":"string","description":"Username of the transaction user"},"operationTypeCode":{"type":"string","description":"Operation status"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_transactions_by_uuid","parameters":{"uuid":{"type":"string","description":"Transaction UUID"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_billing_statements_current","parameters":{"userUuid":{"type":"string","description":"UUID of the user associated with the transactions"},"cardUuid":{"type":"string","description":"UUID of the card associated with the transactions"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_billing_statements_by_yyyy_d_4_by_m_m_d_2_","parameters":{"yyyy:\\d{4":{"type":"string","description":"Year of the billing statement (always 4 digits)"},"MM:\\d{2":{"type":"string","description":"Month of the billing statement (always 2 digits)"},"userUuid":{"type":"string","description":"UUID of the user associated with the transactions"},"cardUuid":{"type":"string","description":"UUID of the card associated with the transactions"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_labels","parameters":{"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"},"name":{"type":"string","description":"Name of the label"},"active":{"type":"string","description":"Active status of the label"}}},{"connectionName":"clara","actionName":"v2/post_api_v2_labels","parameters":{}},{"connectionName":"clara","actionName":"v2/get_api_v2_labels_by_uuid","parameters":{"uuid":{"type":"string","description":"Label UUID"}}},{"connectionName":"clara","actionName":"v2/delete_api_v2_labels_by_uuid","parameters":{"uuid":{"type":"string","description":"Label's UUID"}}},{"connectionName":"clara","actionName":"v2/patch_api_v2_labels_by_uuid","parameters":{"uuid":{"type":"string","description":"Label's UUID"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_payments","parameters":{"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"},"id":{"type":"string","description":"Id of the payment"},"batchId":{"type":"string","description":"BatchId of the payments"},"externalId":{"type":"string","description":"External Id of the optional boleto"},"barcode":{"type":"string","description":"Bar code number that describes the payment"},"digitableLine":{"type":"string","description":"Number sequence that describes the payment"},"creationStartDate":{"type":"string","description":"Creation start date of the payment"},"creationEndDate":{"type":"string","description":"Creation end date of the payment"},"transactionId":{"type":"string","description":"The transaction ID related to the receipt"},"beneficiaryDocumentNumber":{"type":"string","description":"Document number of the beneficiary"},"beneficiaryName":{"type":"string","description":"Name of the beneficiary"},"paymentDateStart":{"type":"string","description":"Start date of the payment"},"paymentDateEnd":{"type":"string","description":"End date of the payment"},"status":{"type":"string","description":"Status of the payment"},"latestStatus":{"type":"string","description":"Last status of the payment by barcode/digitableLine"}}},{"connectionName":"clara","actionName":"v2/post_api_v2_payments","parameters":{}},{"connectionName":"clara","actionName":"v2/get_api_v2_invoices","parameters":{"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"},"invoiceNumber":{"type":"string","description":"Invoice number to filter invoices"},"transactionUuid":{"type":"string","description":"Transaction UUID to filter invoices"},"invoiceId":{"type":"string","description":"Invoice ID to filter invoices"},"startDocumentDate":{"type":"string","description":"Start date for invoice date range filter"},"endDocumentDate":{"type":"string","description":"End date for invoice date range filter"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_attachments","parameters":{}},{"connectionName":"clara","actionName":"v2/get_api_v2_attachments_by_uuid","parameters":{"uuid":{"type":"string","description":"UUID of the attachment"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_attachments_by_uuid_base64","parameters":{"uuid":{"type":"string","description":"UUID of the attachment"}}},{"connectionName":"clara","actionName":"v2/servers_v3_api_docs","parameters":{}},{"connectionName":"clara","actionName":"v2/post_api_v2_labels_bulk_delete","parameters":{}},{"connectionName":"clara","actionName":"v2/patch_api_v2_cards_by_uuid_lock","parameters":{"uuid":{"type":"string","description":"Card's UUID"}}},{"connectionName":"clara","actionName":"v2/get_api_v2_cards_by_uuid_configurations","parameters":{"uuid":{"type":"string","description":"Card's UUID"}}},{"connectionName":"clara","actionName":"v2/post_api_v2_cards_by_uuid_configurations","parameters":{"uuid":{"type":"string"}}},{"connectionName":"clara","actionName":"v2/delete_api_v2_cards_by_uuid_configurations","parameters":{"uuid":{"type":"string","description":"Card's UUID"}}},{"connectionName":"clara","actionName":"v2/patch_api_v2_cards_by_uuid_configurations","parameters":{"uuid":{"type":"string","description":"Card's UUID"}}},{"connectionName":"clara","actionName":"v3/servers_v1_api_docs","parameters":{}},{"connectionName":"clara","actionName":"v3/servers_v2_api_docs","parameters":{}},{"connectionName":"clara","actionName":"v3/servers_v3_api_docs","parameters":{}},{"connectionName":"clara","actionName":"v3/get_api_v3_transactions_by_uuid_documents","parameters":{"uuid":{"type":"string","description":"Transaction UUID"}}},{"connectionName":"clara","actionName":"v3/get_api_v3_transactions_by_uuid_invoices","parameters":{"uuid":{"type":"string","description":"Transaction UUID"}}},{"connectionName":"clara","actionName":"v3/get_api_v3_cards","parameters":{"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"},"userUuid":{"type":"string","description":"Uuid of the user for which to retrieve cards"},"username":{"type":"string","description":"Username of the user"},"claraStatus":{"type":"string","description":"[DEPRECATED] Status of the card. Use 'status' instead. Since: v3"},"status":{"type":"string","description":"Clara status of the cards"},"periodicity":{"type":"string","description":"Periodicity of the cards."},"type":{"type":"string","description":"Type of the cards"},"userErpId":{"type":"string","description":"User ERP ID. It applies only if userUuid is not present"}}},{"connectionName":"clara","actionName":"v3/post_api_v3_cards","parameters":{}},{"connectionName":"clara","actionName":"v3/get_api_v3_cards_by_uuid","parameters":{"uuid":{"type":"string","description":"Card uuid"}}},{"connectionName":"clara","actionName":"v3/delete_api_v3_cards_by_uuid","parameters":{"uuid":{"type":"string","description":"Card's Uuid"}}},{"connectionName":"clara","actionName":"v3/get_api_v3_reimbursements","parameters":{}},{"connectionName":"clara","actionName":"v3/post_api_v3_transactions_comments_bulk","parameters":{}},{"connectionName":"clara","actionName":"v3/post_api_v3_transactions_by_uuid_comment","parameters":{"uuid":{"type":"string"}}},{"connectionName":"clara","actionName":"v3/delete_api_v3_transactions_by_uuid_comment","parameters":{"uuid":{"type":"string","description":"Label's UUID"}}},{"connectionName":"clara","actionName":"v3/post_api_v3_transactions_labels_bulk","parameters":{}},{"connectionName":"clara","actionName":"v3/post_api_v3_cards_bulk_create","parameters":{}},{"connectionName":"clara","actionName":"v3/post_api_v3_cards_delete","parameters":{}},{"connectionName":"clara","actionName":"v3/patch_api_v3_cards_lock","parameters":{}},{"connectionName":"clara","actionName":"v3/patch_api_v3_cards_threshold","parameters":{}},{"connectionName":"clara","actionName":"v3/get_api_v3_transactions","parameters":{"operationDateRangeStart":{"type":"string","description":"Start date for the operation date range (format: YYYY-MM-DD)"},"operationDateRangeEnd":{"type":"string","description":"End date for the operation date range (format: YYYY-MM-DD)"},"userUuid":{"type":"string","description":"UUID of the user related to the transactions"},"cardUuid":{"type":"string","description":"UUID of the card used in the transactions"},"cardLastDigits":{"type":"string","description":"Last four digits of the card number"},"userErpId":{"type":"string","description":"ERP ID of the user related to the transactions"},"status":{"type":"string","description":"Status of the transactions"},"page":{"type":"string","description":"Page number to retrieve (starting from 0)"},"size":{"type":"string","description":"Number of transactions per page (max 100)"}}},{"connectionName":"clara","actionName":"v3/get_api_v3_transactions_by_uuid","parameters":{"uuid":{"type":"string","description":"Transaction UUID"}}},{"connectionName":"clara","actionName":"v3/get_api_v3_billing_statements","parameters":{"billingPeriodStartDate":{"type":"string","description":"Start date for the billing period (format: YYYY-MM-DD)"},"billingPeriodEndDate":{"type":"string","description":"End date for the billing period (format: YYYY-MM-DD)"}}},{"connectionName":"clara","actionName":"v3/get_api_v3_billing_statements_current","parameters":{"userUuid":{"type":"string","description":"UUID of the user related to the transactions"},"cardUuid":{"type":"string","description":"UUID of the card used in the transactions"},"cardLastDigits":{"type":"string","description":"Last four digits of the card number"},"userErpId":{"type":"string","description":"ERP ID of the user related to the transactions"},"status":{"type":"string","description":"Status of the transactions"},"page":{"type":"string","description":"Page number to retrieve (starting from 0)"},"size":{"type":"string","description":"Number of transactions per page (max 100)"}}},{"connectionName":"clara","actionName":"v3/get_api_v3_billing_statements_by_uuid","parameters":{"uuid":{"type":"string","description":"Billing statement Contract"},"userUuid":{"type":"string","description":"UUID of the user related to the transactions"},"cardUuid":{"type":"string","description":"UUID of the card used in the transactions"},"cardLastDigits":{"type":"string","description":"Last four digits of the card number"},"userErpId":{"type":"string","description":"ERP ID of the user related to the transactions"},"status":{"type":"string","description":"Status of the transactions"},"page":{"type":"string","description":"Page number to retrieve (starting from 0)"},"size":{"type":"string","description":"Number of transactions per page (max 100)"}}},{"connectionName":"clara","actionName":"v3/get_api_v3_transactions_by_uuid_extracted_documents","parameters":{"uuid":{"type":"string","description":"Unique identifier of the document"},"page":{"type":"string","description":"Zero-based page index (0..N)"},"size":{"type":"string","description":"The size of the page to be returned"},"type":{"type":"string","description":"Type of the extracted document"},"validationStatus":{"type":"string","description":"Status of the validation of the document"}}},{"connectionName":"clara","actionName":"v3/get_api_v3_users","parameters":{"page":{"type":"integer","description":"Zero-based page index (0..N)"},"size":{"type":"integer","description":"The size of the page to be returned"},"status":{"type":"string","description":"Status of the user"},"role":{"type":"string","description":"Role of the user"},"uuid":{"type":"string","description":"Uuid of the user"},"name":{"type":"string","description":"User name of the user"},"lastName":{"type":"string","description":"Last name of the user"},"fullName":{"type":"string","description":"Full name of the user"},"email":{"type":"string","description":"Email of the user"},"mobilePhone":{"type":"string","description":"Mobile phone of the user"},"taxIdentifier":{"type":"string","description":"Tax identifier of the user"},"erpId":{"type":"string","description":"Erp id of the user"},"createdAtStart":{"type":"string","description":"Creation start date of the user"},"createdAtEnd":{"type":"string","description":"Creation end date of the user"},"locationUuid":{"type":"string","description":"Location uuid of the user"},"locationName":{"type":"string","description":"Location name of the user"},"managerUuid":{"type":"string","description":"Manager uuid of the user"}}},{"connectionName":"clara","actionName":"v3/post_api_v3_users","parameters":{}},{"connectionName":"clara","actionName":"v3/get_api_v3_users_by_uuid","parameters":{"uuid":{"type":"string","description":"User uuid"}}},{"connectionName":"clara","actionName":"v3/delete_api_v3_users_by_uuid","parameters":{"uuid":{"type":"string","description":"User uuid"}}},{"connectionName":"clara","actionName":"v3/patch_api_v3_users_by_uuid","parameters":{"uuid":{"type":"string","description":"User uuid"}}}],"slug":"clara","created_at":"2025-09-25T18:49:39.453Z"},{"id":"clickup","name":"ClickUp","description":"Manage your projects and tasks with ClickUp.","logo_url":"https://assets.abstra.cloud/connectors/logos/clickup.png","category":[],"triggers":["taskCreated","taskUpdated","taskDeleted","taskPriorityUpdated","taskStatusUpdated","taskAssigneeUpdated","taskDueDateUpdated","taskTagUpdated","taskMoved","taskCommentPosted","taskCommentUpdated","taskTimeEstimateUpdated","taskTimeTrackedUpdated","spaceDeleted","goalCreated","goalUpdated","goalDeleted","keyResultCreated","keyResultUpdated","keyResultDeleted"],"actions":[{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_attachment","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by its custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."}}},{"connectionName":"clickup","actionName":"post_v2_oauth_token","parameters":{"data":{"title":"GetAccessTokenrequest","required":{"0":"client_id","1":"client_secret","2":"code"},"type":"object","properties":{"client_id":{"type":"string","description":"OAuth app client id"},"client_secret":{"type":"string","description":"OAuth app client secret"},"code":{"type":"string","description":"Code given in redirect url"}},"examples":{"0":{"client_id":"your_client_id","client_secret":"your_client_secret","code":"authorization_code"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_oauth_token","parameters":{}},{"connectionName":"clickup","actionName":"get_v2_user","parameters":{}},{"connectionName":"clickup","actionName":"parameters_v2_user","parameters":{}},{"connectionName":"clickup","actionName":"get_v2_team","parameters":{}},{"connectionName":"clickup","actionName":"parameters_v2_team","parameters":{}},{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_checklist","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"CreateChecklistrequest","required":{"0":"name"},"type":"object","properties":{"name":{"type":"string"}},"examples":{"0":{"name":"Checklist"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_checklist","parameters":{"task_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"put_v2_checklist_by_checklist_id","parameters":{"checklist_id":{"type":"string","description":"b8a8-48d8-a0c6-b4200788a683 (uuid)"},"data":{"title":"EditChecklistrequest","type":"object","properties":{"name":{"type":"string"},"position":{"description":"Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`.","type":"integer","contentEncoding":"int32"}},"examples":{"0":{"name":"Updated Checklist","position":1}}}}},{"connectionName":"clickup","actionName":"delete_v2_checklist_by_checklist_id","parameters":{"checklist_id":{"type":"string","description":"b8a8-48d8-a0c6-b4200788a683 (uuid)"}}},{"connectionName":"clickup","actionName":"parameters_v2_checklist_by_checklist_id","parameters":{"checklist_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_checklist_by_checklist_id_checklist_item","parameters":{"checklist_id":{"type":"string","description":"b8a8-48d8-a0c6-b4200788a683 (uuid)"},"data":{"title":"CreateChecklistItemrequest","type":"object","properties":{"name":{"type":"string"},"assignee":{"type":"integer","contentEncoding":"int32"}},"examples":{"0":{"name":"Checklist Item","assignee":183}}}}},{"connectionName":"clickup","actionName":"parameters_v2_checklist_by_checklist_id_checklist_item","parameters":{"checklist_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"put_v2_checklist_by_checklist_id_checklist_item_by_checklist_item_id","parameters":{"checklist_id":{"type":"string","description":"b8a8-48d8-a0c6-b4200788a683 (uuid)"},"checklist_item_id":{"type":"string","description":"e491-47f5-9fd8-d1dc4cedcc6f (uuid)"},"data":{"title":"EditChecklistItemrequest","type":"object","properties":{"name":{"type":"string"},"assignee":{"type":{"0":"string","1":"null"}},"resolved":{"type":"boolean"},"parent":{"description":"To nest a checklist item under another checklist item, include the other item's `checklist_item_id`.","type":{"0":"string","1":"null"}}},"examples":{"0":{"name":"Updated Checklist Item","assignee":null,"resolved":true,"parent":null}}}}},{"connectionName":"clickup","actionName":"delete_v2_checklist_by_checklist_id_checklist_item_by_checklist_item_id","parameters":{"checklist_id":{"type":"string","description":"b8a8-48d8-a0c6-b4200788a683 (uuid)"},"checklist_item_id":{"type":"string","description":"e491-47f5-9fd8-d1dc4cedcc6f (uuid)"}}},{"connectionName":"clickup","actionName":"parameters_v2_checklist_by_checklist_id_checklist_item_by_checklist_item_id","parameters":{"checklist_id":{"type":"string"},"checklist_item_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_task_by_task_id_comment","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"start":{"type":"integer","description":"Enter the `date` of a task comment using Unix time in milliseconds."},"start_id":{"type":"string","description":"Enter the Comment `id` of a task comment."}}},{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_comment","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"CreateTaskCommentrequest","required":{"0":"comment_text","1":"notify_all"},"type":"object","properties":{"comment_text":{"type":"string"},"assignee":{"type":"integer","contentEncoding":"int32"},"group_assignee":{"type":"string","contentEncoding":"int32","description":""},"notify_all":{"description":"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.","type":"boolean"}},"examples":{"0":{"comment_text":"Task comment content","assignee":183,"group_assignee":"d01f92f-48ca-446d-88a1-0beb0e8f5f14","notify_all":true}}}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_comment","parameters":{"task_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_view_by_view_id_comment","parameters":{"view_id":{"type":"string","description":"105 (string)"},"start":{"type":"integer","description":"Enter the `date` of a Chat view comment using Unix time in milliseconds."},"start_id":{"type":"string","description":"Enter the Comment `id` of a Chat view comment."}}},{"connectionName":"clickup","actionName":"post_v2_view_by_view_id_comment","parameters":{"view_id":{"type":"string","description":"105 (string)"},"data":{"title":"CreateChatViewCommentrequest","required":{"0":"comment_text","1":"notify_all"},"type":"object","properties":{"comment_text":{"type":"string"},"notify_all":{"description":"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.","type":"boolean"}},"examples":{"0":{"comment_text":"View comment content","notify_all":true}}}}},{"connectionName":"clickup","actionName":"parameters_v2_view_by_view_id_comment","parameters":{"view_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_list_by_list_id_comment","parameters":{"list_id":{"type":"number","description":""},"start":{"type":"integer","description":"Enter the `date` of a List info comment using Unix time in milliseconds."},"start_id":{"type":"string","description":"Enter the Comment `id` of a List info comment."}}},{"connectionName":"clickup","actionName":"post_v2_list_by_list_id_comment","parameters":{"list_id":{"type":"number","description":""},"data":{"title":"CreateListCommentrequest","required":{"0":"comment_text","1":"assignee","2":"notify_all"},"type":"object","properties":{"comment_text":{"type":"string"},"assignee":{"type":"integer","contentEncoding":"int32"},"notify_all":{"description":"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.","type":"boolean"}},"examples":{"0":{"comment_text":"List comment content","assignee":183,"notify_all":true}}}}},{"connectionName":"clickup","actionName":"parameters_v2_list_by_list_id_comment","parameters":{"list_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"put_v2_comment_by_comment_id","parameters":{"comment_id":{"type":"number","description":""},"data":{"title":"UpdateCommentrequest","required":{"0":"comment_text","1":"assignee","2":"resolved"},"type":"object","properties":{"comment_text":{"type":"string"},"assignee":{"type":"integer","contentEncoding":"int32"},"group_assignee":{"type":"integer","contentEncoding":"int32","description":""},"resolved":{"description":"","type":"boolean"}},"examples":{"0":{"comment_text":"Updated comment content","assignee":183,"resolved":true}}}}},{"connectionName":"clickup","actionName":"delete_v2_comment_by_comment_id","parameters":{"comment_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_comment_by_comment_id","parameters":{"comment_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_comment_by_comment_id_reply","parameters":{"comment_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"post_v2_comment_by_comment_id_reply","parameters":{"comment_id":{"type":"number","description":""},"data":{"title":"CreateTaskCommentrequest","required":["comment_text","notify_all"],"type":"object","properties":{"comment_text":{"type":"string"},"assignee":{"type":"integer","contentEncoding":"int32"},"group_assignee":{"type":"string","contentEncoding":"int32","description":""},"notify_all":{"description":"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.","type":"boolean"}},"examples":[{"comment_text":"Task comment content","assignee":183,"group_assignee":"d01f92f-48ca-446d-88a1-0beb0e8f5f14","notify_all":true}]}}},{"connectionName":"clickup","actionName":"get_v2_list_by_list_id_field","parameters":{"list_id":{"type":"number","description":""},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_list_by_list_id_field","parameters":{"list_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_folder_by_folder_id_field","parameters":{"folder_id":{"type":"number","description":""},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_folder_by_folder_id_field","parameters":{"folder_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_space_by_space_id_field","parameters":{"space_id":{"type":"number","description":""},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_space_by_space_id_field","parameters":{"space_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_field","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_field","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_field_by_field_id","parameters":{"task_id":{"type":"string","description":"Enter the task ID of the task you want to update."},"field_id":{"type":"string","description":"Enter the universal unique identifier (UUID) of the Custom Field you want to set."},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by its Custom Task ID, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"SetCustomFieldValuerequest","anyOf":{"0":{"type":"object","title":"URL Custom Field","description":"The `value` must be a string with a valid URL.","required":{"0":"value"},"properties":{"value":{"type":"string","example":"https://clickup.com/api"}}},"1":{"type":"object","title":"Dropdown Custom Field","description":"Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.","required":{"0":"value"},"properties":{"value":{"type":"string","example":"uuid1234"}}},"2":{"type":"object","title":"Email Custom Field","description":"The `value` must be a string with a valid email address.","required":{"0":"value"},"properties":{"value":{"type":"string","example":"user@company.com"}}},"3":{"type":"object","title":"Phone Custom Field","description":"The `value` must be a string with a valid country code.","required":{"0":"value"},"properties":{"value":{"type":"string","example":"+1 123 456 7890"}}},"4":{"type":"object","title":"Date Custom Field","description":"The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.","properties":{"value":{"type":"integer","format":"int32","example":1667367645000},"value_options":{"type":"object","required":{"0":"time"},"properties":{"time":{"type":"boolean","example":true}}}}},"5":{"type":"object","title":"Short or Long Text Custom Field","description":"Enter a string of text.","required":{"0":"value"},"properties":{"value":{"type":"string","example":"This is short or long text in a Custom Field."}}},"6":{"type":"object","title":"Number Custom Field","description":"Enter a number.","required":{"0":"value"},"properties":{"value":{"type":"number","example":-28}}},"7":{"type":"object","title":"Money Custom Field","description":"You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)","required":{"0":"value"},"properties":{"value":{"type":"number","example":8000}}},"8":{"type":"object","title":"Task Relationship Custom Field","description":"Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship.","required":{"0":"value"},"properties":{"value":{"type":"object","properties":{"add":{"type":"array","items":{"type":"string"}},"rem":{"type":"array","items":{"type":"string"}}}}}},"9":{"type":"object","title":"People Custom Field","description":"Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams)","required":{"0":"value"},"properties":{"value":{"type":"object","properties":{"add":{"type":"array","items":{"type":"number"}},"rem":{"type":"array","items":{"type":"number"}}}}}},"10":{"type":"object","title":"Emoji (Rating) Custom Field","description":"Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)","required":{"0":"value"},"properties":{"value":{"type":"integer","format":"int32","example":4}}},"11":{"type":"object","title":"Manual Progress Custom Field","description":"Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)","required":{"0":"value"},"properties":{"value":{"type":"object","required":{"0":"current"},"properties":{"current":{"type":"number","example":20}}}}},"12":{"type":"object","title":"Label Custom Field","description":"Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)","required":{"0":"value"},"properties":{"value":{"type":"array","items":{"type":"string","example":{"0":"uuid1234","1":"uuid9876"}}}}},"13":{"type":"object","title":"Location Custom Field","description":"Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)","required":{"0":"value"},"properties":{"value":{"type":"object","properties":{"location":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"formatted_address":{"type":"string"}}}}},"14":{"type":"object","title":"Button Custom Field","description":"Set a button Custom Field to `true` to \"click\" it. This will trigger the button's action as if it was clicked in the UI.","required":{"0":"value"},"properties":{"value":{"type":"boolean","example":true}}}}}}},{"connectionName":"clickup","actionName":"delete_v2_task_by_task_id_field_by_field_id","parameters":{"task_id":{"type":"string","description":""},"field_id":{"type":"string","description":"b8a8-48d8-a0c6-b4200788a683 (uuid)"},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_field_by_field_id","parameters":{"task_id":{"type":"string"},"field_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_dependency","parameters":{"task_id":{"type":"string","description":"This is the task which is waiting on or blocking another task."},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"AddDependencyrequest","type":"object","properties":{"depends_on":{"type":"string"},"depedency_of":{"type":"string"}},"examples":{"0":{"depends_on":"9hw"}}}}},{"connectionName":"clickup","actionName":"delete_v2_task_by_task_id_dependency","parameters":{"task_id":{"type":"string","description":""},"depends_on":{"type":"string","description":""},"dependency_of":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_dependency","parameters":{"task_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_link_by_links_to","parameters":{"task_id":{"type":"string","description":"The task to initiate the link from."},"links_to":{"type":"string","description":"The task to link to."},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."}}},{"connectionName":"clickup","actionName":"delete_v2_task_by_task_id_link_by_links_to","parameters":{"task_id":{"type":"string","description":""},"links_to":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_link_by_links_to","parameters":{"task_id":{"type":"string"},"links_to":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_space_by_space_id_folder","parameters":{"space_id":{"type":"number","description":""},"archived":{"type":"boolean","description":""}}},{"connectionName":"clickup","actionName":"post_v2_space_by_space_id_folder","parameters":{"space_id":{"type":"number","description":""},"data":{"title":"CreateFolderrequest","required":{"0":"name"},"type":"object","properties":{"name":{"type":"string"}},"examples":{"0":{"name":"New Folder Name"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_space_by_space_id_folder","parameters":{"space_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_folder_by_folder_id","parameters":{"folder_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"put_v2_folder_by_folder_id","parameters":{"folder_id":{"type":"number","description":""},"data":{"title":"UpdateFolderrequest","required":{"0":"name"},"type":"object","properties":{"name":{"type":"string"}},"examples":{"0":{"name":"Updated Folder Name"}}}}},{"connectionName":"clickup","actionName":"delete_v2_folder_by_folder_id","parameters":{"folder_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_folder_by_folder_id","parameters":{"folder_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_goal","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"include_completed":{"type":"boolean","description":""}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_goal","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"CreateGoalrequest","required":{"0":"name","1":"due_date","2":"description","3":"multiple_owners","4":"owners","5":"color"},"type":"object","properties":{"name":{"type":"string"},"due_date":{"type":"integer","contentEncoding":"int64"},"description":{"type":"string"},"multiple_owners":{"type":"boolean"},"owners":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":"Array of user IDs."},"color":{"type":"string"}},"examples":{"0":{"name":"Goal Name","due_date":1568036964079,"description":"Goal Description","multiple_owners":true,"owners":{"0":183},"color":"#32a852"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_goal","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_goal_by_goal_id","parameters":{"goal_id":{"type":"string","description":"900e-462d-a849-4a216b06d930 (uuid)"}}},{"connectionName":"clickup","actionName":"put_v2_goal_by_goal_id","parameters":{"goal_id":{"type":"string","description":"900e-462d-a849-4a216b06d930 (uuid)"},"data":{"title":"UpdateGoalrequest","required":{"0":"name","1":"due_date","2":"description","3":"rem_owners","4":"add_owners","5":"color"},"type":"object","properties":{"name":{"type":"string"},"due_date":{"type":"integer","contentEncoding":"int64"},"description":{"type":"string"},"rem_owners":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":"Array of user IDs."},"add_owners":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":"Array of user IDs."},"color":{"type":"string"}},"examples":{"0":{"name":"Updated Goal Name","due_date":1568036964079,"description":"Updated Goal Description","rem_owners":{"0":183},"add_owners":{"0":184},"color":"#32a852"}}}}},{"connectionName":"clickup","actionName":"delete_v2_goal_by_goal_id","parameters":{"goal_id":{"type":"string","description":"900e-462d-a849-4a216b06d930 (uuid)"},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_goal_by_goal_id","parameters":{"goal_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_goal_by_goal_id_key_result","parameters":{"goal_id":{"type":"string","description":"900e-462d-a849-4a216b06d930 (uuid)"},"data":{"title":"CreateKeyResultrequest","required":{"0":"name","1":"owners","2":"type","3":"steps_start","4":"steps_end","5":"unit","6":"task_ids","7":"list_ids"},"type":"object","properties":{"name":{"type":"string"},"owners":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""},"type":{"description":"Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`.","type":"string"},"steps_start":{"type":"integer","contentEncoding":"int32"},"steps_end":{"type":"integer","contentEncoding":"int32"},"unit":{"type":"string"},"task_ids":{"description":"Enter an array of task IDs to link this target with one or more tasks.","type":"array","items":{"type":"string"}},"list_ids":{"type":"array","items":{"type":"string"},"description":"Enter an array of List IDs to link this target with one or more Lists."}},"examples":{"0":{"name":"New Target Name","owners":{"0":183},"type":"number","steps_start":0,"steps_end":10,"unit":"km","task_ids":{},"list_ids":{}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_goal_by_goal_id_key_result","parameters":{"goal_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"put_v2_key_result_by_key_result_id","parameters":{"key_result_id":{"type":"string","description":"8480-49bc-8c57-e569747efe93 (uuid)"},"data":{"title":"EditKeyResultrequest","required":{"0":"steps_current","1":"note"},"type":"object","properties":{"steps_current":{"type":"integer","contentEncoding":"int32"},"note":{"type":"string"}},"examples":{"0":{"steps_current":5,"note":"Target achieved"}}}}},{"connectionName":"clickup","actionName":"delete_v2_key_result_by_key_result_id","parameters":{"key_result_id":{"type":"string","description":"8480-49bc-8c57-e569747efe93 (uuid)"}}},{"connectionName":"clickup","actionName":"parameters_v2_key_result_by_key_result_id","parameters":{"key_result_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_guest","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"InviteGuestToWorkspacerequest","required":{"0":"email"},"type":"object","properties":{"email":{"type":"string"},"can_edit_tags":{"type":"boolean"},"can_see_time_spent":{"type":"boolean"},"can_see_time_estimated":{"type":"boolean"},"can_create_views":{"type":"boolean"},"can_see_points_estimated":{"type":"boolean"},"custom_role_id":{"type":"integer","contentEncoding":"int32"}},"examples":{"0":{"email":"guest@example.com","can_edit_tags":true,"can_see_time_spent":true,"can_see_time_estimated":true,"can_create_views":true,"can_see_points_estimated":true,"custom_role_id":12345}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_guest","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_guest_by_guest_id","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"guest_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"put_v2_team_by_team_id_guest_by_guest_id","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"guest_id":{"type":"number","description":""},"data":{"title":"EditGuestOnWorkspacerequest","type":"object","properties":{"can_see_points_estimated":{"type":"boolean"},"can_edit_tags":{"type":"boolean"},"can_see_time_spent":{"type":"boolean"},"can_see_time_estimated":{"type":"boolean"},"can_create_views":{"type":"boolean"},"custom_role_id":{"type":"integer","contentEncoding":"int32"}},"examples":{"0":{"can_see_points_estimated":true,"can_edit_tags":true,"can_see_time_spent":true,"can_see_time_estimated":true,"can_create_views":true,"custom_role_id":12345}}}}},{"connectionName":"clickup","actionName":"delete_v2_team_by_team_id_guest_by_guest_id","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"guest_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_guest_by_guest_id","parameters":{"team_id":{"type":"string"},"guest_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_guest_by_guest_id","parameters":{"task_id":{"type":"string","description":""},"guest_id":{"type":"number","description":""},"include_shared":{"type":"boolean","description":"Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"AddGuestToTaskrequest","required":{"0":"permission_level"},"type":"object","properties":{"permission_level":{"description":"Can be `read` (view only), `comment`, `edit`, or `create` (full).","type":"string"}},"examples":{"0":{"permission_level":"read"}}}}},{"connectionName":"clickup","actionName":"delete_v2_task_by_task_id_guest_by_guest_id","parameters":{"task_id":{"type":"string","description":""},"guest_id":{"type":"number","description":""},"include_shared":{"type":"boolean","description":"Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_guest_by_guest_id","parameters":{"task_id":{"type":"string"},"guest_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_list_by_list_id_guest_by_guest_id","parameters":{"list_id":{"type":"number","description":""},"guest_id":{"type":"number","description":""},"include_shared":{"type":"boolean","description":"Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."},"data":{"title":"AddGuestToListrequest","required":{"0":"permission_level"},"type":"object","properties":{"permission_level":{"description":"Can be `read` (view only), `comment`, `edit`, or `create` (full).","type":"string"}},"examples":{"0":{"permission_level":"read"}}}}},{"connectionName":"clickup","actionName":"delete_v2_list_by_list_id_guest_by_guest_id","parameters":{"list_id":{"type":"number","description":""},"guest_id":{"type":"number","description":""},"include_shared":{"type":"boolean","description":"Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."}}},{"connectionName":"clickup","actionName":"parameters_v2_list_by_list_id_guest_by_guest_id","parameters":{"list_id":{"type":"string"},"guest_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_folder_by_folder_id_guest_by_guest_id","parameters":{"folder_id":{"type":"number","description":""},"guest_id":{"type":"number","description":""},"include_shared":{"type":"boolean","description":"Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."},"data":{"title":"AddGuestToFolderrequest","required":{"0":"permission_level"},"type":"object","properties":{"permission_level":{"description":"Can be `read` (view only), `comment`, `edit`, or `create` (full).","type":"string"}},"examples":{"0":{"permission_level":"read"}}}}},{"connectionName":"clickup","actionName":"delete_v2_folder_by_folder_id_guest_by_guest_id","parameters":{"folder_id":{"type":"number","description":""},"guest_id":{"type":"number","description":""},"include_shared":{"type":"boolean","description":"Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."}}},{"connectionName":"clickup","actionName":"parameters_v2_folder_by_folder_id_guest_by_guest_id","parameters":{"folder_id":{"type":"string"},"guest_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_folder_by_folder_id_list","parameters":{"folder_id":{"type":"number","description":""},"archived":{"type":"boolean","description":""}}},{"connectionName":"clickup","actionName":"post_v2_folder_by_folder_id_list","parameters":{"folder_id":{"type":"number","description":""},"data":{"title":"CreateListrequest","required":{"0":"name"},"type":"object","properties":{"name":{"type":"string"},"content":{"type":"string"},"markdown_content":{"type":"string","description":"Use `markdown_content` instead of `content` to format your List description."},"due_date":{"type":"integer","contentEncoding":"int64"},"due_date_time":{"type":"boolean"},"priority":{"type":"integer","contentEncoding":"int32"},"assignee":{"description":"Include a `user_id` to assign this List.","type":"integer","contentEncoding":"int32"},"status":{"description":"**Status** refers to the List color rather than the task Statuses available in the List.","type":"string"}},"examples":{"0":{"name":"New List Name","content":"New List Content","markdown_content":"# This is markdown\n ***bold and italicized text***","due_date":1567780450202,"due_date_time":false,"priority":1,"assignee":183,"status":"red"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_folder_by_folder_id_list","parameters":{"folder_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_space_by_space_id_folder_template_by_template_id","parameters":{"space_id":{"type":"string","description":"ID of the Space where the Folder will be created"},"template_id":{"type":"string","description":"ID of the Folder template to use."},"data":{"type":"object","required":{"0":"name"},"properties":{"name":{"type":"string","description":"Name of the new Folder"},"options":{"type":"object","description":"Options for creating the Folder","properties":{"return_immediately":{"type":"boolean","description":"Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n","default":true},"content":{"type":"string","description":"List description"},"time_estimate":{"type":"boolean","description":"Include time (hours, minutes and seconds)"},"automation":{"type":"boolean","description":"Import automation options"},"include_views":{"type":"boolean","description":"Import views"},"old_due_date":{"type":"boolean","description":"Import tasks due dates"},"old_start_date":{"type":"boolean","description":"Import tasks start dates"},"old_followers":{"type":"boolean","description":"Import tasks watchers"},"comment_attachments":{"type":"boolean","description":"Import tasks comment attachments"},"recur_settings":{"type":"boolean","description":"Import tasks recurring settings"},"old_tags":{"type":"boolean","description":"Import tasks tags"},"old_statuses":{"type":"boolean","description":"Import tasks status settings"},"subtasks":{"type":"boolean","description":"Import tasks subtasks"},"custom_type":{"type":"boolean","description":"Import tasks types"},"old_assignees":{"type":"boolean","description":"Import tasks assignees"},"attachments":{"type":"boolean","description":"Import tasks attachments"},"comment":{"type":"boolean","description":"Import tasks comments"},"old_status":{"type":"boolean","description":"Import tasks current statuses"},"external_dependencies":{"type":"boolean","description":"Import tasks external dependencies"},"internal_dependencies":{"type":"boolean","description":"Import tasks internal dependencies"},"priority":{"type":"boolean","description":"Import tasks priority"},"custom_fields":{"type":"boolean","description":"Import tasks Custom Fields"},"old_checklists":{"type":"boolean","description":"Import tasks checklists"},"relationships":{"type":"boolean","description":"Import tasks relationships"},"old_subtask_assignees":{"type":"boolean","description":"Import tasks subtasks and assignees combination"},"start_date":{"type":"string","format":"date-time","description":"Project start date for remapping dates"},"due_date":{"type":"string","format":"date-time","description":"Project due date for remapping dates"},"remap_start_date":{"type":"boolean","description":"Remap start dates"},"skip_weekends":{"type":"boolean","description":"Skip weekends when remapping dates"},"archived":{"type":"integer","enum":{"0":1,"1":2,"2":null},"description":"Include archived tasks (1 or 2 or null)"}}}}}}},{"connectionName":"clickup","actionName":"get_v2_space_by_space_id_list","parameters":{"space_id":{"type":"number","description":""},"archived":{"type":"boolean","description":""}}},{"connectionName":"clickup","actionName":"post_v2_space_by_space_id_list","parameters":{"space_id":{"type":"number","description":""},"data":{"title":"CreateFolderlessListrequest","required":{"0":"name"},"type":"object","properties":{"name":{"type":"string"},"content":{"type":"string"},"markdown_content":{"type":"string","description":"Use `markdown_content` instead of `content` to format your List description."},"due_date":{"type":"integer","contentEncoding":"int64"},"due_date_time":{"type":"boolean"},"priority":{"type":"integer","contentEncoding":"int32"},"assignee":{"description":"Include a `user_id` to add a List owner.","type":"integer","contentEncoding":"int32"},"status":{"description":"**Status** refers to the List color rather than the task Statuses available in the List.","type":"string"}},"examples":{"0":{"name":"New List Name","content":"New List Content","due_date":1567780450202,"due_date_time":false,"priority":1,"assignee":183,"status":"red"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_space_by_space_id_list","parameters":{"space_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_list_by_list_id","parameters":{"list_id":{"type":"number","description":"The List ID. To find the List ID, right-click the List in your Sidebar, select Copy link, and paste the link in your URL. The last string in the URL is your List ID."}}},{"connectionName":"clickup","actionName":"put_v2_list_by_list_id","parameters":{"list_id":{"type":"string","description":""},"data":{"title":"UpdateListrequest","required":{"0":"name"},"type":"object","properties":{"name":{"type":"string"},"content":{"type":"string"},"markdown_content":{"type":"string","description":"Use `markdown_content` instead of `content` to format your List description."},"due_date":{"type":"integer","contentEncoding":"int64"},"due_date_time":{"type":"boolean"},"priority":{"type":"integer","contentEncoding":"int32"},"assignee":{"type":"string"},"status":{"description":"**Status** refers to the List color rather than the task Statuses available in the List.","type":"string"},"unset_status":{"description":"By default, this is `false.` To remove the List color use `unset_status: true`.","type":"boolean"}},"examples":{"0":{"name":"Updated List Name","content":"Updated List Content","markdown_content":"# This is markdown\n ***bold and italicized text***","due_date":1567780450202,"due_date_time":true,"priority":2,"assignee":"none","status":"red","unset_status":true}}}}},{"connectionName":"clickup","actionName":"delete_v2_list_by_list_id","parameters":{"list_id":{"type":"number","description":""},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_list_by_list_id","parameters":{"list_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_list_by_list_id_task_by_task_id","parameters":{"list_id":{"type":"number","description":""},"task_id":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"delete_v2_list_by_list_id_task_by_task_id","parameters":{"list_id":{"type":"number","description":""},"task_id":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_list_by_list_id_task_by_task_id","parameters":{"list_id":{"type":"string"},"task_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_task_by_task_id_member","parameters":{"task_id":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_member","parameters":{"task_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_list_by_list_id_member","parameters":{"list_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_list_by_list_id_member","parameters":{"list_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_customroles","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"include_members":{"type":"boolean","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_customroles","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_shared","parameters":{"team_id":{"type":"number","description":"Workspace ID"}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_shared","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_space","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"archived":{"type":"boolean","description":""}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_space","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"CreateSpacerequest","required":{"0":"name","1":"multiple_assignees","2":"features"},"type":"object","properties":{"name":{"type":"string"},"multiple_assignees":{"type":"boolean"},"features":{"title":"Features","required":["due_dates","time_tracking","tags","time_estimates","checklists","custom_fields","remap_dependencies","dependency_warning","portfolios"],"type":"object","properties":{"due_dates":{"title":"DueDates","required":["enabled","start_date","remap_due_dates","remap_closed_due_date"],"type":"object","properties":{"enabled":{"type":"boolean"},"start_date":{"type":"boolean"},"remap_due_dates":{"type":"boolean"},"remap_closed_due_date":{"type":"boolean"}},"examples":[{"enabled":true,"start_date":false,"remap_due_dates":true,"remap_closed_due_date":false}]},"time_tracking":{"title":"TimeTracking","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":[{"enabled":false}]},"tags":{"title":"Tags","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":[{"enabled":true}]},"time_estimates":{"title":"TimeEstimates","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":[{"enabled":true}]},"checklists":{"title":"Checklists","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":[{"enabled":true}]},"custom_fields":{"title":"CustomFields","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":[{"enabled":true}]},"remap_dependencies":{"title":"RemapDependencies","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":[{"enabled":true}]},"dependency_warning":{"title":"DependencyWarning","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":[{"enabled":true}]},"portfolios":{"title":"Portfolios","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":[{"enabled":true}]}},"examples":[{"due_dates":{"enabled":true,"start_date":false,"remap_due_dates":true,"remap_closed_due_date":false},"time_tracking":{"enabled":false},"tags":{"enabled":true},"time_estimates":{"enabled":true},"checklists":{"enabled":true},"custom_fields":{"enabled":true},"remap_dependencies":{"enabled":true},"dependency_warning":{"enabled":true},"portfolios":{"enabled":true}}]}},"examples":{"0":{"name":"New Space Name","multiple_assignees":true,"features":{"due_dates":{"enabled":true,"start_date":false,"remap_due_dates":true,"remap_closed_due_date":false},"time_tracking":{"enabled":false},"tags":{"enabled":true},"time_estimates":{"enabled":true},"checklists":{"enabled":true},"custom_fields":{"enabled":true},"remap_dependencies":{"enabled":true},"dependency_warning":{"enabled":true},"portfolios":{"enabled":true}}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_space","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_space_by_space_id","parameters":{"space_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"put_v2_space_by_space_id","parameters":{"space_id":{"type":"number","description":""},"data":{"title":"UpdateSpacerequest","required":{"0":"name","1":"color","2":"private","3":"admin_can_manage","4":"multiple_assignees","5":"features"},"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"},"private":{"type":"boolean"},"admin_can_manage":{"description":"***Note:** Allowing or restricting admins from managing private Spaces using `\"admin_can_manage\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*","type":"boolean"},"multiple_assignees":{"type":"boolean"},"features":{"title":"Features","required":{"0":"due_dates","1":"time_tracking","2":"tags","3":"time_estimates","4":"checklists","5":"custom_fields","6":"remap_dependencies","7":"dependency_warning","8":"portfolios"},"type":"object","properties":{"due_dates":{"title":"DueDates","required":{"0":"enabled","1":"start_date","2":"remap_due_dates","3":"remap_closed_due_date"},"type":"object","properties":{"enabled":{"type":"boolean"},"start_date":{"type":"boolean"},"remap_due_dates":{"type":"boolean"},"remap_closed_due_date":{"type":"boolean"}},"examples":{"0":{"enabled":true,"start_date":false,"remap_due_dates":true,"remap_closed_due_date":false}}},"time_tracking":{"title":"TimeTracking","required":{"0":"enabled"},"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":{"0":{"enabled":false}}},"tags":{"title":"Tags","required":{"0":"enabled"},"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":{"0":{"enabled":true}}},"time_estimates":{"title":"TimeEstimates","required":{"0":"enabled"},"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":{"0":{"enabled":true}}},"checklists":{"title":"Checklists","required":{"0":"enabled"},"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":{"0":{"enabled":true}}},"custom_fields":{"title":"CustomFields","required":{"0":"enabled"},"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":{"0":{"enabled":true}}},"remap_dependencies":{"title":"RemapDependencies","required":{"0":"enabled"},"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":{"0":{"enabled":true}}},"dependency_warning":{"title":"DependencyWarning","required":{"0":"enabled"},"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":{"0":{"enabled":true}}},"portfolios":{"title":"Portfolios","required":{"0":"enabled"},"type":"object","properties":{"enabled":{"type":"boolean"}},"examples":{"0":{"enabled":true}}}},"examples":{"0":{"due_dates":{"enabled":true,"start_date":false,"remap_due_dates":true,"remap_closed_due_date":false},"time_tracking":{"enabled":false},"tags":{"enabled":true},"time_estimates":{"enabled":true},"checklists":{"enabled":true},"custom_fields":{"enabled":true},"remap_dependencies":{"enabled":true},"dependency_warning":{"enabled":true},"portfolios":{"enabled":true}}}}},"examples":{"0":{"name":"Updated Space Name","color":"#7B68EE","private":false,"admin_can_manage":false,"multiple_assignees":false,"features":{"due_dates":{"enabled":false,"start_date":false,"remap_due_dates":false,"remap_closed_due_date":false},"time_tracking":{"enabled":false},"tags":{"enabled":false},"time_estimates":{"enabled":false},"checklists":{"enabled":true},"custom_fields":{"enabled":true},"remap_dependencies":{"enabled":false},"dependency_warning":{"enabled":false},"portfolios":{"enabled":false}}}}}}},{"connectionName":"clickup","actionName":"delete_v2_space_by_space_id","parameters":{"space_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_space_by_space_id","parameters":{"space_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_space_by_space_id_tag","parameters":{"space_id":{"type":"number","description":""},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"post_v2_space_by_space_id_tag","parameters":{"space_id":{"type":"number","description":""},"data":{"title":"CreateSpaceTagrequest","required":{"0":"tag"},"type":"object","properties":{"tag":{"title":"Tag","required":{"0":"name","1":"tag_fg","2":"tag_bg"},"type":"object","properties":{"name":{"type":"string"},"tag_fg":{"type":"string"},"tag_bg":{"type":"string"}},"examples":{"0":{"name":"Tag Name","tag_fg":"#000000","tag_bg":"#000000"}}}},"examples":{"0":{"tag":{"name":"Tag Name","tag_fg":"#000000","tag_bg":"#000000"}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_space_by_space_id_tag","parameters":{"space_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"put_v2_space_by_space_id_tag_by_tag_name","parameters":{"space_id":{"type":"number","description":""},"tag_name":{"type":"string","description":""},"data":{"title":"EditSpaceTagrequest","required":{"0":"tag"},"type":"object","properties":{"tag":{"title":"Tag1","required":{"0":"name","1":"fg_color","2":"bg_color"},"type":"object","properties":{"name":{"type":"string"},"fg_color":{"type":"string"},"bg_color":{"type":"string"}},"examples":{"0":{"name":"Updated Tag","fg_color":"#ffffff","bg_color":"#ffffff"}}}},"examples":{"0":{"tag":{"name":"Updated Tag","fg_color":"#ffffff","bg_color":"#ffffff"}}}}}},{"connectionName":"clickup","actionName":"delete_v2_space_by_space_id_tag_by_tag_name","parameters":{"space_id":{"type":"number","description":""},"tag_name":{"type":"string","description":""},"data":{"title":"DeleteSpaceTagrequest","required":{"0":"tag"},"type":"object","properties":{"tag":{"title":"Tag","required":["name","tag_fg","tag_bg"],"type":"object","properties":{"name":{"type":"string"},"tag_fg":{"type":"string"},"tag_bg":{"type":"string"}},"examples":[{"name":"Tag Name","tag_fg":"#000000","tag_bg":"#000000"}]}},"examples":{"0":{"tag":{"name":"Tag name","tag_fg":"#000000","tag_bg":"#000000"}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_space_by_space_id_tag_by_tag_name","parameters":{"space_id":{"type":"string"},"tag_name":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_tag_by_tag_name","parameters":{"task_id":{"type":"string","description":""},"tag_name":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"delete_v2_task_by_task_id_tag_by_tag_name","parameters":{"task_id":{"type":"string","description":""},"tag_name":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_tag_by_tag_name","parameters":{"task_id":{"type":"string"},"tag_name":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_list_by_list_id_task","parameters":{"list_id":{"type":"number","description":"To find the list_id: \\ 1. In the Sidebar, hover over the List and click the **ellipsis ...** menu. \\ 2. Select **Copy link.** \\ 3. Use the copied URL to find the list_id. The list_id is the number that follows /li in the URL."},"archived":{"type":"boolean","description":""},"include_markdown_description":{"type":"boolean","description":"To return task descriptions in Markdown format, use `?include_markdown_description=true`."},"page":{"type":"integer","description":"Page to fetch (starts at 0)."},"order_by":{"type":"string","description":"Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`."},"reverse":{"type":"boolean","description":"Tasks are displayed in reverse order."},"subtasks":{"type":"boolean","description":"Include or exclude subtasks. By default, subtasks are excluded."},"statuses":{"type":"array","description":"Filter by statuses. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`"},"include_closed":{"type":"boolean","description":"Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`."},"include_timl":{"type":"boolean","description":"Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.\\\n \\\nTo include tasks that exist in multiple lists, use `include_timl: true`."},"assignees":{"type":"array","description":"Filter by Assignees. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`"},"watchers":{"type":"array","description":"Filter by watchers."},"tags":{"type":"array","description":"Filter by tags. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`"},"due_date_gt":{"type":"integer","description":"Filter by due date greater than Unix time in milliseconds."},"due_date_lt":{"type":"integer","description":"Filter by due date less than Unix time in milliseconds."},"date_created_gt":{"type":"integer","description":"Filter by date created greater than Unix time in milliseconds."},"date_created_lt":{"type":"integer","description":"Filter by date created less than Unix time in milliseconds."},"date_updated_gt":{"type":"integer","description":"Filter by date updated greater than Unix time in milliseconds."},"date_updated_lt":{"type":"integer","description":"Filter by date updated less than Unix time in milliseconds."},"date_done_gt":{"type":"integer","description":"Filter by date done greater than Unix time in milliseconds."},"date_done_lt":{"type":"integer","description":"Filter by date done less than Unix time in milliseconds."},"custom_fields":{"type":"array","description":"Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)"},"custom_field":{"type":"array","description":"Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship."},"custom_items":{"type":"array","description":"Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace."}}},{"connectionName":"clickup","actionName":"post_v2_list_by_list_id_task","parameters":{"list_id":{"type":"number","description":""},"data":{"title":"CreateTaskrequest","required":{"0":"name"},"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"assignees":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""},"archived":{"type":"boolean"},"group_assignees":{"type":"array","items":{"type":"string"},"description":"Assign multiple user groups to the task."},"tags":{"type":"array","items":{"type":"string"},"description":""},"status":{"type":"string"},"priority":{"type":{"0":"integer","1":"null"},"contentEncoding":"int32"},"due_date":{"type":"integer","contentEncoding":"int64"},"due_date_time":{"type":"boolean"},"time_estimate":{"type":"integer","contentEncoding":"int32"},"start_date":{"type":"integer","contentEncoding":"int64"},"start_date_time":{"type":"boolean"},"points":{"type":"number","description":"Add Sprint Points to the task."},"notify_all":{"type":"boolean","description":"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."},"parent":{"description":"You can create a subtask by including an existing task ID.\\\n \\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter.","type":{"0":"string","1":"null"}},"markdown_content":{"type":"string","description":"Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`."},"links_to":{"description":"Include a task ID to create a linked dependency with your new task.","type":{"0":"string","1":"null"}},"check_required_custom_fields":{"description":"When creating a task via API any required Custom Fields are ignored by default (`false`).\\\n \\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`.","type":"boolean"},"custom_fields":{"type":"array","items":{"title":"CustomFields6","required":{"0":"id","1":"value"},"type":"object","properties":{"id":{"type":"string"},"value":{"oneOf":{"0":{"type":"integer","contentEncoding":"int32"},"1":{"type":"string"}}}},"examples":{"0":{"id":"0a52c486-5f05-403b-b4fd-c512ff05131c","value":23}}},"description":"[Filter by Custom Fields.](doc:filtertasks)"},"custom_item_id":{"type":"number","description":"The custom task type ID for this task. A value of `null` (default) creates a standard task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)."}},"examples":{"0":{"name":"New Task Name","description":"New Task Description","assignees":{"0":183},"archived":false,"group_assignees":{"0":"dd01f92f-48ca-446d-88a1-0beb0e8f5f14"},"tags":{"0":"tag name 1"},"status":"Open","priority":3,"due_date":1508369194377,"due_date_time":false,"time_estimate":8640000,"start_date":1567780450202,"start_date_time":false,"points":3,"notify_all":true,"parent":null,"links_to":null,"check_required_custom_fields":true,"custom_fields":{"0":{"id":"0a52c486-5f05-403b-b4fd-c512ff05131c","value":23},"1":{"id":"03efda77-c7a0-42d3-8afd-fd546353c2f5","value":"Text field input"}}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_list_by_list_id_task","parameters":{"list_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_task_by_task_id","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by its custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"include_subtasks":{"type":"boolean","description":"Include subtasks, default false"},"include_markdown_description":{"type":"boolean","description":"To return task descriptions in Markdown format, use `?include_markdown_description=true`."},"custom_fields":{"type":"array","description":"Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:filtertasks)"}}},{"connectionName":"clickup","actionName":"put_v2_task_by_task_id","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by its custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"UpdateTaskrequest","type":"object","properties":{"custom_item_id":{"type":{"0":"number","1":"null"},"description":"The custom task type ID for this task. A value of `null` (default) sets the task type to type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)."},"name":{"type":"string"},"description":{"description":"To clear the task description, include `Description` with `\" \"`.","type":"string"},"markdown_content":{"type":"string","description":"Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`."},"status":{"type":"string"},"priority":{"type":"integer","contentEncoding":"int32"},"due_date":{"type":"integer","contentEncoding":"int64"},"due_date_time":{"type":"boolean"},"parent":{"description":"You can move a subtask to another parent task by including `\"parent\"` with a valid `task id`.\\\n \\\nYou cannot convert a subtask to a task by setting `\"parent\"` to `null`.","type":"string"},"time_estimate":{"type":"integer","contentEncoding":"int32"},"start_date":{"type":"integer","contentEncoding":"int64"},"start_date_time":{"type":"boolean"},"points":{"type":"number","description":"Update the task's Sprint Points."},"assignees":{"title":"Assignees","required":{"0":"add","1":"rem"},"type":"object","properties":{"add":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""},"rem":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""}},"examples":{"0":{"add":{"0":182},"rem":{"0":183}}}},"group_assignees":{"type":"object","properties":{"add":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""},"rem":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""}}},"watchers":{"title":"Watchers","required":{"0":"add","1":"rem"},"type":"object","properties":{"add":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""},"rem":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""}},"examples":{"0":{"add":{"0":182,"1":121},"rem":{"0":183,"1":122}}}},"archived":{"type":"boolean"}},"examples":{"0":{"name":"Updated Task Name","description":"Updated Task Content","status":"in progress","priority":1,"due_date":1508369194377,"due_date_time":false,"parent":"abc1234","time_estimate":8640000,"start_date":1567780450202,"start_date_time":false,"points":3,"assignees":{"add":{"0":182},"rem":{"0":183}},"group_assignees":{"add":{"0":"dd01f92f-48ca-446d-88a1-0beb0e8f5f14"},"rem":{"0":"dd01f92f-48ca-446d-88a1-0beb0e8f5f13"}},"watchers":{"add":{"0":182},"rem":{"0":183}},"archived":false}}}}},{"connectionName":"clickup","actionName":"delete_v2_task_by_task_id","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by its custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id","parameters":{"task_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_task","parameters":{"team_Id":{"type":"number","description":"Workspace ID"},"page":{"type":"integer","description":"Page to fetch (starts at 0)."},"order_by":{"type":"string","description":"Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`."},"reverse":{"type":"boolean","description":"Tasks are displayed in reverse order."},"subtasks":{"type":"boolean","description":"Include or exclude subtasks. By default, subtasks are excluded."},"space_ids":{"type":"array","description":"Filter by Spaces. For example: \\\n \\\n`?space_ids[]=1234&space_ids[]=6789`"},"project_ids":{"type":"array","description":"Filter by Folders. For example: \\\n \\\n`?project_ids[]=1234&project_ids[]=6789`"},"list_ids[]":{"type":"array","description":"Filter by Lists. For example: \\\n \\\n`?list_ids[]=1234&list_ids[]=6789` "},"statuses":{"type":"array","description":"Filter by statuses. Use `%20` to represent a space character. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`"},"include_closed":{"type":"boolean","description":"Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`."},"assignees":{"type":"array","description":"Filter by Assignees using people's ClickUp user id. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`"},"tags":{"type":"array","description":"Filter by tags. User `%20` to represent a space character. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`"},"due_date_gt":{"type":"integer","description":"Filter by due date greater than Unix time in milliseconds."},"due_date_lt":{"type":"integer","description":"Filter by due date less than Unix time in milliseconds."},"date_created_gt":{"type":"integer","description":"Filter by date created greater than Unix time in milliseconds."},"date_created_lt":{"type":"integer","description":"Filter by date created less than Unix time in milliseconds."},"date_updated_gt":{"type":"integer","description":"Filter by date updated greater than Unix time in milliseconds."},"date_updated_lt":{"type":"integer","description":"Filter by date updated less than Unix time in milliseconds."},"date_done_gt":{"type":"integer","description":"Filter by date done greater than Unix time in milliseconds."},"date_done_lt":{"type":"integer","description":"Filter by date done less than Unix time in milliseconds."},"custom_fields":{"type":"array","description":"Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"}{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. The `=` operator isn't supported with Label Custom Fields.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)"},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by its custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"parent":{"type":"string","description":"Include the parent task ID to return subtasks."},"include_markdown_description":{"type":"boolean","description":"To return task descriptions in Markdown format, use `?include_markdown_description=true`."},"custom_items":{"type":"array","description":"Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace."}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_task","parameters":{"team_Id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_merge","parameters":{"task_id":{"type":"string","description":"ID of the target task that other tasks will be merged into."},"data":{"type":"object","required":{"0":"source_task_ids"},"properties":{"source_task_ids":{"type":"array","description":"Array of task IDs to merge into the target task.","items":{"type":"string"},"examples":{"0":{"0":"abc123","1":"def456"}}}}}}},{"connectionName":"clickup","actionName":"get_v2_task_by_task_id_time_in_status","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_time_in_status","parameters":{"task_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_task_bulk_time_in_status_task_ids","parameters":{"task_ids":{"type":"string","description":"Include this paramater once per `task_id`.\nYou can include up to 100 task ids per request.\nFor example: `task_ids=3cuh&task_ids=g4fs`"},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_task_bulk_time_in_status_task_ids","parameters":{}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_task_template","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"page":{"type":"integer","description":""},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_task_template","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_list_by_list_id_task_template_by_template_id","parameters":{"list_id":{"type":"number","description":""},"template_id":{"type":"string","description":""},"data":{"title":"CreateTaskFromTemplaterequest","required":{"0":"name"},"type":"object","properties":{"name":{"type":"string"}},"examples":{"0":{"name":"New task name"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_list_by_list_id_task_template_by_template_id","parameters":{"list_id":{"type":"string"},"template_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_folder_by_folder_id_list_template_by_template_id","parameters":{"folder_id":{"type":"string","description":"ID of the Folder where the List will be created"},"template_id":{"type":"string","description":"ID of the template to use"},"data":{"type":"object","required":{"0":"name"},"properties":{"name":{"type":"string","description":"Name of the new List"},"options":{"type":"object","description":"Options for creating the List","properties":{"return_immediately":{"type":"boolean","description":"Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n","default":true},"content":{"type":"string","description":"List description"},"time_estimate":{"type":"number","description":"Include time (hours, minutes and seconds)"},"automation":{"type":"boolean","description":"Import automation settings"},"include_views":{"type":"boolean","description":"Import views"},"old_due_date":{"type":"boolean","description":"Import tasks' due dates"},"old_start_date":{"type":"boolean","description":"Import tasks' start dates"},"old_followers":{"type":"boolean","description":"Import tasks' watchers"},"comment_attachments":{"type":"boolean","description":"Import tasks' comment attachments"},"recur_settings":{"type":"boolean","description":"Import tasks' recurring settings"},"old_tags":{"type":"boolean","description":"Import tasks' tags"},"old_statuses":{"type":"boolean","description":"Import tasks' status settings"},"subtasks":{"type":"boolean","description":"Import tasks' subtasks"},"custom_type":{"type":"boolean","description":"Import tasks' task types"},"old_assignees":{"type":"boolean","description":"Import tasks' assignees"},"attachments":{"type":"boolean","description":"Import tasks' attachments"},"comment":{"type":"boolean","description":"Import tasks' comments"},"old_status":{"type":"boolean","description":"Import tasks' current statuses"},"external_dependencies":{"type":"boolean","description":"Import tasks' external dependencies"},"internal_dependencies":{"type":"boolean","description":"Import tasks' internal dependencies"},"priority":{"type":"boolean","description":"Import tasks' priorities"},"custom_fields":{"type":"boolean","description":"Import tasks' Custom Fields"},"old_checklists":{"type":"boolean","description":"Import tasks' checklists"},"relationships":{"type":"boolean","description":"Import tasks' relationships"},"old_subtask_assignees":{"type":"boolean","description":"Import tasks' subtask assignees"},"start_date":{"type":"string","format":"date-time","description":"Project start date for remapping dates"},"due_date":{"type":"string","format":"date-time","description":"Project due date for remapping dates"},"remap_start_date":{"type":"boolean","description":"Remap start dates"},"skip_weekends":{"type":"boolean","description":"Skip weekends when remapping dates"},"archived":{"type":"integer","enum":[1,2,null],"description":"Include archived tasks"}}}}}}},{"connectionName":"clickup","actionName":"post_v2_space_by_space_id_list_template_by_template_id","parameters":{"space_id":{"type":"string","description":"ID of the Space where the List will be created"},"template_id":{"type":"string","description":"ID of the template to use"},"data":{"type":"object","required":{"0":"name"},"properties":{"name":{"type":"string","description":"Name of the new List"},"options":{"type":"object","description":"Options for creating the List","properties":{"return_immediately":{"type":"boolean","description":"Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n","default":true},"content":{"type":"string","description":"List description"},"time_estimate":{"type":"number","description":"Include time (hours, minutes and seconds)"},"automation":{"type":"boolean","description":"Import automation settings"},"include_views":{"type":"boolean","description":"Import views"},"old_due_date":{"type":"boolean","description":"Import tasks' due dates"},"old_start_date":{"type":"boolean","description":"Import tasks' start dates"},"old_followers":{"type":"boolean","description":"Import tasks' watchers"},"comment_attachments":{"type":"boolean","description":"Import tasks' comment attachments"},"recur_settings":{"type":"boolean","description":"Import tasks' recurring settings"},"old_tags":{"type":"boolean","description":"Import tasks' tags"},"old_statuses":{"type":"boolean","description":"Import tasks' status settings"},"subtasks":{"type":"boolean","description":"Import tasks' subtasks"},"custom_type":{"type":"boolean","description":"Import tasks' task types"},"old_assignees":{"type":"boolean","description":"Import tasks' assignees"},"attachments":{"type":"boolean","description":"Import tasks' attachments"},"comment":{"type":"boolean","description":"Import tasks' comments"},"old_status":{"type":"boolean","description":"Import tasks' current statuses"},"external_dependencies":{"type":"boolean","description":"Import tasks' external dependencies"},"internal_dependencies":{"type":"boolean","description":"Import tasks' internal dependencies"},"priority":{"type":"boolean","description":"Import tasks' priorities"},"custom_fields":{"type":"boolean","description":"Import tasks' Custom Fields"},"old_checklists":{"type":"boolean","description":"Import tasks' checklists"},"relationships":{"type":"boolean","description":"Import tasks' relationships"},"old_subtask_assignees":{"type":"boolean","description":"Import tasks' subtask assignees"},"start_date":{"type":"string","format":"date-time","description":"Project start date for remapping dates"},"due_date":{"type":"string","format":"date-time","description":"Project due date for remapping dates"},"remap_start_date":{"type":"boolean","description":"Remap start dates"},"skip_weekends":{"type":"boolean","description":"Skip weekends when remapping dates"},"archived":{"type":"integer","enum":{"0":1,"1":2,"2":null},"description":"Include archived tasks"}}}}}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_seats","parameters":{"team_id":{"type":"string","description":"Workspace ID"}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_seats","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_plan","parameters":{"team_id":{"type":"string","description":"Workspace ID"}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_plan","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_group","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"CreateTeamrequest","required":{"0":"name","1":"members"},"type":"object","properties":{"name":{"type":"string"},"handle":{"type":"string"},"members":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""}},"examples":{"0":{"name":"New team name","handle":"newteamname","members":{"0":123456,"1":987654}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_group","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_custom_item","parameters":{"team_id":{"type":"number","description":"Workspace ID"}}},{"connectionName":"clickup","actionName":"put_v2_group_by_group_id","parameters":{"group_id":{"type":"string","description":"User Group ID"},"data":{"title":"UpdateTeamrequest","type":"object","properties":{"name":{"type":"string"},"handle":{"type":"string"},"members":{"title":"Members2","required":{"0":"add","1":"rem"},"type":"object","properties":{"add":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""},"rem":{"type":"array","items":{"type":"integer","contentEncoding":"int32"},"description":""}},"examples":{"0":{"add":{"0":123456,"1":987654},"rem":{"0":159753}}}}},"examples":{"0":{"name":"New User Group Name","handle":"newusergroupname","members":{"add":{"0":123456,"1":987654},"rem":{"0":159753}}}}}}},{"connectionName":"clickup","actionName":"delete_v2_group_by_group_id","parameters":{"group_id":{"type":"string","description":"User Group ID"}}},{"connectionName":"clickup","actionName":"parameters_v2_group_by_group_id","parameters":{"group_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_group","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"group_ids":{"type":"string","description":"Enter one or more User Group IDs to retrieve information about specific User Group."}}},{"connectionName":"clickup","actionName":"parameters_v2_group","parameters":{}},{"connectionName":"clickup","actionName":"get_v2_task_by_task_id_time","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"post_v2_task_by_task_id_time","parameters":{"task_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"Tracktimerequest","required":{"0":"start","1":"end","2":"time"},"type":"object","properties":{"start":{"type":"integer","contentEncoding":"int64"},"end":{"type":"integer","contentEncoding":"int64"},"time":{"type":"integer","contentEncoding":"int32"}},"examples":{"0":{"start":1567780450202,"end":1508369194377,"time":8640000}}}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_time","parameters":{"task_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"put_v2_task_by_task_id_time_by_interval_id","parameters":{"task_id":{"type":"string","description":""},"interval_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"Edittimetrackedrequest","required":{"0":"start","1":"end","2":"time"},"type":"object","properties":{"start":{"type":"integer","contentEncoding":"int64"},"end":{"type":"integer","contentEncoding":"int64"},"time":{"type":"integer","contentEncoding":"int32"}},"examples":{"0":{"start":1567780450202,"end":1508369194377,"time":8640000}}}}},{"connectionName":"clickup","actionName":"delete_v2_task_by_task_id_time_by_interval_id","parameters":{"task_id":{"type":"string","description":""},"interval_id":{"type":"string","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_task_by_task_id_time_by_interval_id","parameters":{"task_id":{"type":"string"},"interval_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_time_entries","parameters":{"team_Id":{"type":"number","description":"Workspace ID"},"start_date":{"type":"number","description":"Unix time in milliseconds"},"end_date":{"type":"number","description":"Unix time in milliseconds"},"assignee":{"type":"number","description":"Filter by `user_id`. For multiple assignees, separate `user_id` using commas.\\\n \\\n **Example:** `assignee=1234,9876`\\\n \\\n***Note:** Only Workspace Owners/Admins have access to do this.*"},"include_task_tags":{"type":"boolean","description":"Include task tags in the response for time entries associated with tasks."},"include_location_names":{"type":"boolean","description":"Include the names of the List, Folder, and Space along with the `list_id`,`folder_id`, and `space_id`."},"include_approval_history":{"type":"boolean","description":"Include the history of the approval for each time entry. Adds status changes, notes, and approvers."},"include_approval_details":{"type":"boolean","description":"Include the details of the approval for each time entry. Adds Approver ID, Approved Time, List of Approvers, and Approval Status."},"space_id":{"type":"number","description":"Only include time entries associated with tasks in a specific Space."},"folder_id":{"type":"number","description":"Only include time entries associated with tasks in a specific Folder."},"list_id":{"type":"number","description":"Only include time entries associated with tasks in a specific List."},"task_id":{"type":"string","description":"Only include time entries associated with a specific task."},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"is_billable":{"type":"boolean","description":"Include only billable time entries by using a value of `true` or only non-billable time entries by using a value of `false`.\\\n \\\nFor example: `?is_billable=true`."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_time_entries","parameters":{"team_Id":{"type":"number","description":"Workspace ID"},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"Createatimeentryrequest","required":{"0":"start","1":"duration"},"type":"object","properties":{"description":{"type":"string"},"tags":{"description":"Users on the Business Plan and above can include a time tracking label.","type":"array","items":{"title":"Tags6","required":{"0":"name","1":"tag_fg","2":"tag_bg"},"type":"object","properties":{"name":{"type":"string"},"tag_fg":{"type":"string"},"tag_bg":{"type":"string"}},"examples":{"0":{"name":"Tag name","tag_fg":"#000000","tag_bg":"#000000"}}}},"start":{"type":"integer","contentEncoding":"int64"},"stop":{"type":"integer","contentEncoding":"int64","description":"The `duration` parameter can be used instead of the `stop` parameter. "},"end":{"type":"integer","contentEncoding":"int64"},"billable":{"type":"boolean"},"duration":{"description":"When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter.","type":"integer","contentEncoding":"int32"},"assignee":{"description":"Workspace owners and admins can include any user id. Workspace members can only include their own user id.","type":"integer","contentEncoding":"int32"},"tid":{"type":"string"}},"examples":{"0":{"description":"from api","tags":{"0":{"name":"name of tag","tag_bg":"#BF55EC","tag_fg":"#FFFFFF"}},"start":1595282645000,"end":1595282660000,"billable":true,"duration":50000,"assignee":1,"tid":"task_id"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_time_entries","parameters":{"team_Id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_time_entries_by_timer_id","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"timer_id":{"type":"string","description":"The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint."},"include_task_tags":{"type":"boolean","description":"Include task tags in the response for time entries associated with tasks."},"include_location_names":{"type":"boolean","description":"Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`."},"include_approval_history":{"type":"boolean","description":"Include the history of the approval for the time entry."},"include_approval_details":{"type":"boolean","description":"Include the details of the approval for the time entry."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"delete_v2_team_by_team_id_time_entries_by_timer_id","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"timer_id":{"type":"number","description":"Array of timer ids to delete separated by commas"},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"put_v2_team_by_team_id_time_entries_by_timer_id","parameters":{"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`"},"timer_id":{"type":"number","description":""},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"data":{"title":"UpdateatimeEntryrequest","required":{"0":"tags","1":"tid"},"type":"object","properties":{"description":{"type":"string"},"tags":{"description":"Users on the Business Plan and above can include a time tracking label.","type":"array","items":{"title":"Tags6","required":["name","tag_fg","tag_bg"],"type":"object","properties":{"name":{"type":"string"},"tag_fg":{"type":"string"},"tag_bg":{"type":"string"}},"examples":[{"name":"Tag name","tag_fg":"#000000","tag_bg":"#000000"}]}},"tag_action":{"type":"string"},"start":{"type":"integer","contentEncoding":"int64","description":"When providing `start`, you must also provide `end`."},"end":{"type":"integer","contentEncoding":"int64","description":"When providing `end`, you must also provide `start`."},"tid":{"type":"string"},"billable":{"type":"boolean"},"duration":{"type":"integer","contentEncoding":"int32"}},"examples":{"0":{"description":"","tags":{"0":{"name":"name of tag","tag_bg":"#BF55EC","tag_fg":"#FFFFFF"}},"tag_action":"add","start":1595289395842,"end":1595289495842,"tid":"task_id","billable":true,"duration":100000}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_time_entries_by_timer_id","parameters":{"team_id":{"type":"string"},"timer_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_time_entries_by_timer_id_history","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"timer_id":{"type":"string","description":"The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint."},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_time_entries_by_timer_id_history","parameters":{"team_id":{"type":"string"},"timer_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_time_entries_current","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"assignee":{"type":"number","description":"user id"},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_time_entries_current","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"delete_v2_team_by_team_id_time_entries_tags","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"Removetagsfromtimeentriesrequest","required":{"0":"time_entry_ids","1":"tags"},"type":"object","properties":{"time_entry_ids":{"type":"array","items":{"type":"string"},"description":""},"tags":{"type":"array","items":{"title":"Tags10","required":["name"],"type":"object","properties":{"name":{"type":"string"}},"examples":[{"name":"name of tag"}]},"description":""}},"examples":{"0":{"time_entry_ids":{"0":"timer_id"},"tags":{"0":{"name":"name of tag"}}}}}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_time_entries_tags","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_time_entries_tags","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"Addtagsfromtimeentriesrequest","required":{"0":"time_entry_ids","1":"tags"},"type":"object","properties":{"time_entry_ids":{"type":"array","items":{"type":"string"},"description":""},"tags":{"type":"array","items":{"title":"Tags6","required":["name","tag_fg","tag_bg"],"type":"object","properties":{"name":{"type":"string"},"tag_fg":{"type":"string"},"tag_bg":{"type":"string"}},"examples":[{"name":"Tag name","tag_fg":"#000000","tag_bg":"#000000"}]},"description":""}},"examples":{"0":{"time_entry_ids":{"0":"timer_id"},"tags":{"0":{"name":"name of tag","tag_bg":"#BF55EC","tag_fg":"#FFFFFF"}}}}}}},{"connectionName":"clickup","actionName":"put_v2_team_by_team_id_time_entries_tags","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"Changetagnamesfromtimeentriesrequest","required":{"0":"name","1":"new_name","2":"tag_bg","3":"tag_fg"},"type":"object","properties":{"name":{"type":"string"},"new_name":{"type":"string"},"tag_bg":{"type":"string"},"tag_fg":{"type":"string"}},"examples":{"0":{"name":"old tag name","new_name":"new tag name","tag_bg":"#000000","tag_fg":"#000000"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_time_entries_tags","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_time_entries_start","parameters":{"team_Id":{"type":"number","description":"Workspace ID"},"custom_task_ids":{"type":"boolean","description":"If you want to reference a task by it's custom task id, this value must be `true`."},"team_id":{"type":"number","description":"When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`."},"data":{"title":"StartatimeEntryrequest","type":"object","properties":{"description":{"type":"string"},"tags":{"description":"Users on the Business Plan and above can include a time tracking label.","type":"array","items":{"title":"Tags10","required":{"0":"name"},"type":"object","properties":{"name":{"type":"string"}},"examples":{"0":{"name":"name of tag"}}}},"tid":{"type":"string"},"billable":{"type":"boolean"}},"examples":{"0":{"description":"from api","tags":{"0":{"name":"tag1"}},"tid":"task_id","billable":false}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_time_entries_start","parameters":{"team_Id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_time_entries_stop","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"Content-Type":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_time_entries_stop","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_user","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"InviteUserToWorkspacerequest","required":{"0":"email","1":"admin"},"type":"object","properties":{"email":{"type":"string"},"admin":{"type":"boolean"},"custom_role_id":{"type":"integer","contentEncoding":"int32"}},"examples":{"0":{"email":"user@example.com","admin":true,"custom_role_id":112233}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_user","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_user_by_user_id","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"user_id":{"type":"number","description":""},"include_shared":{"type":"boolean","description":"Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."}}},{"connectionName":"clickup","actionName":"put_v2_team_by_team_id_user_by_user_id","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"user_id":{"type":"number","description":""},"data":{"title":"EditUserOnWorkspacerequest","required":{"0":"username","1":"admin","2":"custom_role_id"},"type":"object","properties":{"username":{"type":"string"},"admin":{"type":"boolean"},"custom_role_id":{"type":"integer","contentEncoding":"int32"}},"examples":{"0":{"username":"User Name","admin":false,"custom_role_id":998877}}}}},{"connectionName":"clickup","actionName":"delete_v2_team_by_team_id_user_by_user_id","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"user_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_user_by_user_id","parameters":{"team_id":{"type":"string"},"user_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_view","parameters":{"team_id":{"type":"number","description":"Workspace ID"}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_view","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"CreateTeamViewrequest","required":{"0":"name","1":"type","2":"grouping","3":"divide","4":"sorting","5":"filters","6":"columns","7":"team_sidebar","8":"settings"},"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."},"grouping":{"title":"Grouping","required":["field","dir","collapsed","ignore"],"type":"object","properties":{"field":{"type":"string","description":"Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`."},"dir":{"description":"Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.","type":"integer","contentEncoding":"int32"},"collapsed":{"type":"array","items":{"type":"string"},"description":""},"ignore":{"type":"boolean"}},"examples":[{"field":"status","dir":1,"collapsed":[],"ignore":false}]},"divide":{"title":"Divide","required":["collapsed"],"type":"object","properties":{"field":{"type":["null"]},"dir":{"type":["null"]},"collapsed":{"type":["boolean"]}},"examples":[{"field":null,"dir":null,"collapsed":[]}]},"sorting":{"title":"Sorting","required":["fields"],"type":"object","properties":{"fields":{"type":"array","items":{"type":"string"},"description":"Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)."}},"examples":[{"fields":[{"field":"cf_624a423a-c1d1-4467-99e2-63e225658cb2","dir":-1,"idx":0}]}]},"filters":{"title":"Filters","required":["op","fields","search","show_closed"],"type":"object","properties":{"op":{"type":"string","description":"The available operator (`op``) values are `AND`` and `OR``."},"fields":{"type":"array","items":{"type":"string"},"description":"View the list of [fields available](doc:filter-views) to filter by."},"search":{"type":"string"},"show_closed":{"type":"boolean"}},"examples":[{"op":"AND","fields":[],"search":"","show_closed":false}]},"columns":{"title":"Columns","description":"Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.","required":["fields"],"type":"object","properties":{"fields":{"description":"Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`","type":"array","items":{"type":"string"}}},"examples":[{"fields":[]}]},"team_sidebar":{"title":"TeamSidebar","required":["assignees","assigned_comments","unassigned_tasks"],"type":"object","properties":{"assignees":{"type":"array","items":{"type":"string"},"description":""},"assigned_comments":{"type":"boolean"},"unassigned_tasks":{"type":"boolean"}},"examples":[{"assignees":[],"assigned_comments":false,"unassigned_tasks":false}]},"settings":{"title":"Settings","required":["show_task_locations","show_subtasks","show_subtask_parent_names","show_closed_subtasks","show_assignees","show_images","collapse_empty_columns","me_comments","me_subtasks","me_checklists"],"type":"object","properties":{"show_task_locations":{"type":"boolean"},"show_subtasks":{"description":"Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.","type":"integer","contentEncoding":"int32"},"show_subtask_parent_names":{"type":"boolean"},"show_closed_subtasks":{"type":"boolean"},"show_assignees":{"type":"boolean"},"show_images":{"type":"boolean"},"collapse_empty_columns":{"type":["string","null"]},"me_comments":{"type":"boolean"},"me_subtasks":{"type":"boolean"},"me_checklists":{"type":"boolean"}},"examples":[{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}]}},"examples":{"0":{"name":"New Team View Name","type":"list","grouping":{"field":"status","dir":1,"collapsed":{},"ignore":false},"divide":{"field":null,"dir":null,"collapsed":{}},"sorting":{"fields":{}},"filters":{"op":"AND","fields":{},"search":"","show_closed":false},"columns":{"fields":{}},"team_sidebar":{"assignees":{},"assigned_comments":false,"unassigned_tasks":false},"settings":{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_view","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_space_by_space_id_view","parameters":{"space_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"post_v2_space_by_space_id_view","parameters":{"space_id":{"type":"number","description":""},"data":{"title":"CreateSpaceViewrequest","required":{"0":"name","1":"type","2":"grouping","3":"divide","4":"sorting","5":"filters","6":"columns","7":"team_sidebar","8":"settings"},"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."},"grouping":{"title":"Grouping","required":["field","dir","collapsed","ignore"],"type":"object","properties":{"field":{"type":"string","description":"Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`."},"dir":{"description":"Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.","type":"integer","contentEncoding":"int32"},"collapsed":{"type":"array","items":{"type":"string"},"description":""},"ignore":{"type":"boolean"}},"examples":[{"field":"status","dir":1,"collapsed":[],"ignore":false}]},"divide":{"title":"Divide","required":["collapsed"],"type":"object","properties":{"field":{"type":["null"]},"dir":{"type":["null"]},"collapsed":{"type":["boolean"]}},"examples":[{"field":null,"dir":null,"collapsed":[]}]},"sorting":{"title":"Sorting","required":["fields"],"type":"object","properties":{"fields":{"type":"array","items":{"type":"string"},"description":"Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)."}},"examples":[{"fields":[{"field":"cf_624a423a-c1d1-4467-99e2-63e225658cb2","dir":-1,"idx":0}]}]},"filters":{"title":"Filters","required":["op","fields","search","show_closed"],"type":"object","properties":{"op":{"type":"string","description":"The available operator (`op``) values are `AND`` and `OR``."},"fields":{"type":"array","items":{"type":"string"},"description":"View the list of [fields available](doc:filter-views) to filter by."},"search":{"type":"string"},"show_closed":{"type":"boolean"}},"examples":[{"op":"AND","fields":[],"search":"","show_closed":false}]},"columns":{"title":"Columns","description":"Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.","required":["fields"],"type":"object","properties":{"fields":{"description":"Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`","type":"array","items":{"type":"string"}}},"examples":[{"fields":[]}]},"team_sidebar":{"title":"TeamSidebar","required":["assignees","assigned_comments","unassigned_tasks"],"type":"object","properties":{"assignees":{"type":"array","items":{"type":"string"},"description":""},"assigned_comments":{"type":"boolean"},"unassigned_tasks":{"type":"boolean"}},"examples":[{"assignees":[],"assigned_comments":false,"unassigned_tasks":false}]},"settings":{"title":"Settings","required":["show_task_locations","show_subtasks","show_subtask_parent_names","show_closed_subtasks","show_assignees","show_images","collapse_empty_columns","me_comments","me_subtasks","me_checklists"],"type":"object","properties":{"show_task_locations":{"type":"boolean"},"show_subtasks":{"description":"Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.","type":"integer","contentEncoding":"int32"},"show_subtask_parent_names":{"type":"boolean"},"show_closed_subtasks":{"type":"boolean"},"show_assignees":{"type":"boolean"},"show_images":{"type":"boolean"},"collapse_empty_columns":{"type":["string","null"]},"me_comments":{"type":"boolean"},"me_subtasks":{"type":"boolean"},"me_checklists":{"type":"boolean"}},"examples":[{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}]}},"examples":{"0":{"name":"New Space View Name","type":"list","grouping":{"field":"status","dir":1,"collapsed":{},"ignore":false},"divide":{"field":null,"dir":null,"collapsed":{}},"sorting":{"fields":{}},"filters":{"op":"AND","fields":{},"search":"","show_closed":false},"columns":{"fields":{}},"team_sidebar":{"assignees":{},"assigned_comments":false,"unassigned_tasks":false},"settings":{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_space_by_space_id_view","parameters":{"space_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_folder_by_folder_id_view","parameters":{"folder_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"post_v2_folder_by_folder_id_view","parameters":{"folder_id":{"type":"number","description":""},"data":{"title":"CreateFolderViewrequest","required":{"0":"name","1":"type","2":"grouping","3":"divide","4":"sorting","5":"filters","6":"columns","7":"team_sidebar","8":"settings"},"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."},"grouping":{"title":"Grouping","required":["field","dir","collapsed","ignore"],"type":"object","properties":{"field":{"type":"string","description":"Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`."},"dir":{"description":"Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.","type":"integer","contentEncoding":"int32"},"collapsed":{"type":"array","items":{"type":"string"},"description":""},"ignore":{"type":"boolean"}},"examples":[{"field":"status","dir":1,"collapsed":[],"ignore":false}]},"divide":{"title":"Divide","required":["collapsed"],"type":"object","properties":{"field":{"type":["null"]},"dir":{"type":["null"]},"collapsed":{"type":["boolean"]}},"examples":[{"field":null,"dir":null,"collapsed":[]}]},"sorting":{"title":"Sorting","required":["fields"],"type":"object","properties":{"fields":{"type":"array","items":{"type":"string"},"description":"Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)."}},"examples":[{"fields":[{"field":"cf_624a423a-c1d1-4467-99e2-63e225658cb2","dir":-1,"idx":0}]}]},"filters":{"title":"Filters","required":["op","fields","search","show_closed"],"type":"object","properties":{"op":{"type":"string","description":"The available operator (`op``) values are `AND`` and `OR``."},"fields":{"type":"array","items":{"type":"string"},"description":"View the list of [fields available](doc:filter-views) to filter by."},"search":{"type":"string"},"show_closed":{"type":"boolean"}},"examples":[{"op":"AND","fields":[],"search":"","show_closed":false}]},"columns":{"title":"Columns","description":"Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.","required":["fields"],"type":"object","properties":{"fields":{"description":"Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`","type":"array","items":{"type":"string"}}},"examples":[{"fields":[]}]},"team_sidebar":{"title":"TeamSidebar","required":["assignees","assigned_comments","unassigned_tasks"],"type":"object","properties":{"assignees":{"type":"array","items":{"type":"string"},"description":""},"assigned_comments":{"type":"boolean"},"unassigned_tasks":{"type":"boolean"}},"examples":[{"assignees":[],"assigned_comments":false,"unassigned_tasks":false}]},"settings":{"title":"Settings","required":["show_task_locations","show_subtasks","show_subtask_parent_names","show_closed_subtasks","show_assignees","show_images","collapse_empty_columns","me_comments","me_subtasks","me_checklists"],"type":"object","properties":{"show_task_locations":{"type":"boolean"},"show_subtasks":{"description":"Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.","type":"integer","contentEncoding":"int32"},"show_subtask_parent_names":{"type":"boolean"},"show_closed_subtasks":{"type":"boolean"},"show_assignees":{"type":"boolean"},"show_images":{"type":"boolean"},"collapse_empty_columns":{"type":["string","null"]},"me_comments":{"type":"boolean"},"me_subtasks":{"type":"boolean"},"me_checklists":{"type":"boolean"}},"examples":[{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}]}},"examples":{"0":{"name":"New Folder View Name","type":"list","grouping":{"field":"status","dir":1,"collapsed":{},"ignore":false},"divide":{"field":null,"dir":null,"collapsed":{}},"sorting":{"fields":{}},"filters":{"op":"AND","fields":{},"search":"","show_closed":false},"columns":{"fields":{}},"team_sidebar":{"assignees":{},"assigned_comments":false,"unassigned_tasks":false},"settings":{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_folder_by_folder_id_view","parameters":{"folder_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_list_by_list_id_view","parameters":{"list_id":{"type":"number","description":""}}},{"connectionName":"clickup","actionName":"post_v2_list_by_list_id_view","parameters":{"list_id":{"type":"number","description":""},"data":{"title":"CreateListViewrequest","required":{"0":"name","1":"type","2":"grouping","3":"divide","4":"sorting","5":"filters","6":"columns","7":"team_sidebar","8":"settings"},"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."},"grouping":{"title":"Grouping","required":["field","dir","collapsed","ignore"],"type":"object","properties":{"field":{"type":"string","description":"Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`."},"dir":{"description":"Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.","type":"integer","contentEncoding":"int32"},"collapsed":{"type":"array","items":{"type":"string"},"description":""},"ignore":{"type":"boolean"}},"examples":[{"field":"status","dir":1,"collapsed":[],"ignore":false}]},"divide":{"title":"Divide","required":["collapsed"],"type":"object","properties":{"field":{"type":["null"]},"dir":{"type":["null"]},"collapsed":{"type":["boolean"]}},"examples":[{"field":null,"dir":null,"collapsed":[]}]},"sorting":{"title":"Sorting","required":["fields"],"type":"object","properties":{"fields":{"type":"array","items":{"type":"string"},"description":"Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)."}},"examples":[{"fields":[{"field":"cf_624a423a-c1d1-4467-99e2-63e225658cb2","dir":-1,"idx":0}]}]},"filters":{"title":"Filters","required":["op","fields","search","show_closed"],"type":"object","properties":{"op":{"type":"string","description":"The available operator (`op``) values are `AND`` and `OR``."},"fields":{"type":"array","items":{"type":"string"},"description":"View the list of [fields available](doc:filter-views) to filter by."},"search":{"type":"string"},"show_closed":{"type":"boolean"}},"examples":[{"op":"AND","fields":[],"search":"","show_closed":false}]},"columns":{"title":"Columns","description":"Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.","required":["fields"],"type":"object","properties":{"fields":{"description":"Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`","type":"array","items":{"type":"string"}}},"examples":[{"fields":[]}]},"team_sidebar":{"title":"TeamSidebar","required":["assignees","assigned_comments","unassigned_tasks"],"type":"object","properties":{"assignees":{"type":"array","items":{"type":"string"},"description":""},"assigned_comments":{"type":"boolean"},"unassigned_tasks":{"type":"boolean"}},"examples":[{"assignees":[],"assigned_comments":false,"unassigned_tasks":false}]},"settings":{"title":"Settings","required":["show_task_locations","show_subtasks","show_subtask_parent_names","show_closed_subtasks","show_assignees","show_images","collapse_empty_columns","me_comments","me_subtasks","me_checklists"],"type":"object","properties":{"show_task_locations":{"type":"boolean"},"show_subtasks":{"description":"Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.","type":"integer","contentEncoding":"int32"},"show_subtask_parent_names":{"type":"boolean"},"show_closed_subtasks":{"type":"boolean"},"show_assignees":{"type":"boolean"},"show_images":{"type":"boolean"},"collapse_empty_columns":{"type":["string","null"]},"me_comments":{"type":"boolean"},"me_subtasks":{"type":"boolean"},"me_checklists":{"type":"boolean"}},"examples":[{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}]}},"examples":{"0":{"name":"New List View Name","type":"list","grouping":{"field":"status","dir":1,"collapsed":{},"ignore":false},"divide":{"field":null,"dir":null,"collapsed":{}},"sorting":{"fields":{}},"filters":{"op":"AND","fields":{},"search":"","show_closed":false},"columns":{"fields":{}},"team_sidebar":{"assignees":{},"assigned_comments":false,"unassigned_tasks":false},"settings":{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}}}}}},{"connectionName":"clickup","actionName":"parameters_v2_list_by_list_id_view","parameters":{"list_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_view_by_view_id","parameters":{"view_id":{"type":"string","description":""}}},{"connectionName":"clickup","actionName":"put_v2_view_by_view_id","parameters":{"view_id":{"type":"string","description":""},"data":{"title":"UpdateViewrequest","required":{"0":"name","1":"type","2":"parent","3":"grouping","4":"divide","5":"sorting","6":"filters","7":"columns","8":"team_sidebar","9":"settings"},"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"parent":{"title":"Parent","description":"The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\n \\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\n \\\nThe `type` value indciates the level of the Hierarchy where the view is located.","required":{"0":"id","1":"type"},"type":"object","properties":{"id":{"type":"string","description":"The id of the Workspace, Space, Folder, or List where the view is located."},"type":{"type":"integer","description":"The level of the Hierarchy where the view is created. \\\n \\\nOptions include: \\\n \\\nWorkspace (Everything Level): `7` \\\n \\\nSpace: `4` \\\n \\\nFolder: `5` \\\n \\\nList: `6`","contentEncoding":"int32"}},"examples":{"0":{"id":"512","type":7}}},"grouping":{"title":"Grouping","required":{"0":"field","1":"dir","2":"collapsed","3":"ignore"},"type":"object","properties":{"field":{"type":"string","description":"Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`."},"dir":{"description":"Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.","type":"integer","contentEncoding":"int32"},"collapsed":{"type":"array","items":{"type":"string"},"description":""},"ignore":{"type":"boolean"}},"examples":{"0":{"field":"status","dir":1,"collapsed":{},"ignore":false}}},"divide":{"title":"Divide","required":{"0":"collapsed"},"type":"object","properties":{"field":{"type":{"0":"null"}},"dir":{"type":{"0":"null"}},"collapsed":{"type":{"0":"boolean"}}},"examples":{"0":{"field":null,"dir":null,"collapsed":{}}}},"sorting":{"title":"Sorting","required":{"0":"fields"},"type":"object","properties":{"fields":{"type":"array","items":{"type":"string"},"description":"Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)."}},"examples":{"0":{"fields":{"0":{"field":"cf_624a423a-c1d1-4467-99e2-63e225658cb2","dir":-1,"idx":0}}}}},"filters":{"title":"Filters","required":{"0":"op","1":"fields","2":"search","3":"show_closed"},"type":"object","properties":{"op":{"type":"string","description":"The available operator (`op``) values are `AND`` and `OR``."},"fields":{"type":"array","items":{"type":"string"},"description":"View the list of [fields available](doc:filter-views) to filter by."},"search":{"type":"string"},"show_closed":{"type":"boolean"}},"examples":{"0":{"op":"AND","fields":{},"search":"","show_closed":false}}},"columns":{"title":"Columns","description":"Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.","required":{"0":"fields"},"type":"object","properties":{"fields":{"description":"Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`","type":"array","items":{"type":"string"}}},"examples":{"0":{"fields":{}}}},"team_sidebar":{"title":"TeamSidebar","required":{"0":"assignees","1":"assigned_comments","2":"unassigned_tasks"},"type":"object","properties":{"assignees":{"type":"array","items":{"type":"string"},"description":""},"assigned_comments":{"type":"boolean"},"unassigned_tasks":{"type":"boolean"}},"examples":{"0":{"assignees":{},"assigned_comments":false,"unassigned_tasks":false}}},"settings":{"title":"Settings","required":{"0":"show_task_locations","1":"show_subtasks","2":"show_subtask_parent_names","3":"show_closed_subtasks","4":"show_assignees","5":"show_images","6":"collapse_empty_columns","7":"me_comments","8":"me_subtasks","9":"me_checklists"},"type":"object","properties":{"show_task_locations":{"type":"boolean"},"show_subtasks":{"description":"Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.","type":"integer","contentEncoding":"int32"},"show_subtask_parent_names":{"type":"boolean"},"show_closed_subtasks":{"type":"boolean"},"show_assignees":{"type":"boolean"},"show_images":{"type":"boolean"},"collapse_empty_columns":{"type":{"0":"string","1":"null"}},"me_comments":{"type":"boolean"},"me_subtasks":{"type":"boolean"},"me_checklists":{"type":"boolean"}},"examples":{"0":{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}}}},"examples":{"0":{"name":"New View Name","type":"list","parent":{"id":"512","type":7},"grouping":{"field":"status","dir":1,"collapsed":{},"ignore":false},"divide":{"field":null,"dir":null,"collapsed":{}},"sorting":{"fields":{}},"filters":{"op":"AND","fields":{},"search":"","show_closed":false},"columns":{"fields":{}},"team_sidebar":{"assignees":{},"assigned_comments":false,"unassigned_tasks":false},"settings":{"show_task_locations":false,"show_subtasks":3,"show_subtask_parent_names":false,"show_closed_subtasks":false,"show_assignees":true,"show_images":true,"collapse_empty_columns":null,"me_comments":true,"me_subtasks":true,"me_checklists":true}}}}}},{"connectionName":"clickup","actionName":"delete_v2_view_by_view_id","parameters":{"view_id":{"type":"string","description":"105 (string)"}}},{"connectionName":"clickup","actionName":"parameters_v2_view_by_view_id","parameters":{"view_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_view_by_view_id_task","parameters":{"view_id":{"type":"string","description":"105 (string)"},"page":{"type":"integer","description":""}}},{"connectionName":"clickup","actionName":"parameters_v2_view_by_view_id_task","parameters":{"view_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v2_team_by_team_id_webhook","parameters":{"team_id":{"type":"number","description":"Workspace ID"}}},{"connectionName":"clickup","actionName":"post_v2_team_by_team_id_webhook","parameters":{"team_id":{"type":"number","description":"Workspace ID"},"data":{"title":"CreateWebhookrequest","required":{"0":"endpoint","1":"events"},"type":"object","properties":{"endpoint":{"type":"string"},"events":{"type":"array","description":"See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events.","items":{"type":"string"}},"space_id":{"type":"integer"},"folder_id":{"type":"integer"},"list_id":{"type":"integer"},"task_id":{"type":"string"}},"examples":{"0":{"endpoint":"https://yourdomain.com/webhook","events":{"0":"taskCreated","1":"taskUpdated","2":"taskDeleted","3":"taskPriorityUpdated","4":"taskStatusUpdated","5":"taskAssigneeUpdated","6":"taskDueDateUpdated","7":"taskTagUpdated","8":"taskMoved","9":"taskCommentPosted","10":"taskCommentUpdated","11":"taskTimeEstimateUpdated","12":"taskTimeTrackedUpdated","13":"listCreated","14":"listUpdated","15":"listDeleted","16":"folderCreated","17":"folderUpdated","18":"folderDeleted","19":"spaceCreated","20":"spaceUpdated","21":"spaceDeleted","22":"goalCreated","23":"goalUpdated","24":"goalDeleted","25":"keyResultCreated","26":"keyResultUpdated","27":"keyResultDeleted"},"space_id":1234,"folder_id":5678,"list_id":9876,"task_id":"abc1234"}}}}},{"connectionName":"clickup","actionName":"parameters_v2_team_by_team_id_webhook","parameters":{"team_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"put_v2_webhook_by_webhook_id","parameters":{"webhook_id":{"type":"string","description":"e506-4a29-9d42-26e504e3435e (uuid)"},"data":{"title":"UpdateWebhookrequest","required":{"0":"endpoint","1":"events","2":"status"},"type":"object","properties":{"endpoint":{"type":"string"},"events":{"type":"string"},"status":{"type":"string"}},"examples":{"0":{"endpoint":"https://yourdomain.com/webhook","events":"*","status":"active"}}}}},{"connectionName":"clickup","actionName":"delete_v2_webhook_by_webhook_id","parameters":{"webhook_id":{"type":"string","description":"e506-4a29-9d42-26e504e3435e (uuid)"}}},{"connectionName":"clickup","actionName":"parameters_v2_webhook_by_webhook_id","parameters":{"webhook_id":{"type":"string"}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_docs","parameters":{"workspaceId":{"type":"number","description":"The ID of your Workspace."},"id":{"type":"string","description":"Filter results to a single Doc with the given Doc ID."},"creator":{"type":"number","description":"Filter results to Docs created by the user with the given user ID."},"deleted":{"type":"boolean","description":"Filter results to return deleted Docs."},"archived":{"type":"boolean","description":"Filter results to return archived Docs."},"parent_id":{"type":"string","description":"Filter results to children of a parent Doc with the given parent Doc ID."},"parent_type":{"type":"string","description":"Filter results to children of the given parent Doc type. For example, `SPACE`, `FOLDER`, `LIST`, `EVERYTHING`, `WORKSPACE`."},"limit":{"type":"number","description":"The maximum number of results to retrieve for each page."},"next_cursor":{"type":"string","description":"The cursor to use to get the next page of results."}}},{"connectionName":"clickup","actionName":"post_v3_workspaces_by_workspace_id_docs","parameters":{"workspaceId":{"type":"number","description":"The ID of the Workspace."},"data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the new Doc."},"parent":{"description":"The parent of the new Doc.","allOf":{"0":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"number","description":"The parent Doc type. Use `4` for Space, `5` for Folder, `6` for List, `7` for Everything, and `12` for Workspace."}},"required":["id","type"]}}},"visibility":{"type":"string","description":"The visibility of the new Doc. For example, `PUBLIC` or `PRIVATE`."},"create_page":{"type":"boolean","description":"Create a new page when creating the Doc.","default":true}}}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_docs_by_doc_id","parameters":{"workspaceId":{"type":"number","description":"The ID of the Workspace."},"docId":{"type":"string","description":"The ID of the Doc."}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_docs_by_doc_id_page_listing","parameters":{"workspaceId":{"type":"number","description":"The ID of the Workspace."},"docId":{"type":"string","description":"The ID of the Doc."},"max_page_depth":{"type":"number","description":"The maximum depth to retrieve pages and subpages. A value less than 0 does not limit the depth."}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_docs_by_doc_id_pages","parameters":{"workspaceId":{"type":"number","description":"The ID of the Workspace."},"docId":{"type":"string","description":"The ID of the Doc."},"max_page_depth":{"type":"number","description":"The maximum depth to retrieve pages and subpages. A value less than 0 does not limit the depth."},"content_format":{"type":"string","description":"The format to return the page content in. For example, `text/md` for markdown or `text/plain` for plain."}}},{"connectionName":"clickup","actionName":"post_v3_workspaces_by_workspace_id_docs_by_doc_id_pages","parameters":{"workspaceId":{"type":"number","description":"The ID of the Workspace."},"docId":{"type":"string","description":"The ID of the Doc."},"data":{"type":"object","properties":{"parent_page_id":{"type":"string","description":"The ID of the parent page. If this is a root page in the Doc, `parent_page_id` will not be returned.","default":null},"name":{"type":"string","description":"The name of the new page.","default":""},"sub_title":{"type":"string","description":"The subtitle of the new page.","default":null},"content":{"type":"string","description":"The content of the new page.","default":""},"content_format":{"type":"string","description":"The format the page content is in. For example, `text/md` for markdown or `text/plain` for plain.","default":"text/md"}}}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_docs_by_doc_id_pages_by_page_id","parameters":{"workspaceId":{"type":"number","description":"The ID of the Workspace."},"docId":{"type":"string","description":"The ID of the Doc."},"pageId":{"type":"string","description":"The ID of the page."},"content_format":{"type":"string","description":"The format to return the page content in. For example, `text/md` for markdown or `text/plain` for plain."}}},{"connectionName":"clickup","actionName":"put_v3_workspaces_by_workspace_id_docs_by_doc_id_pages_by_page_id","parameters":{"workspaceId":{"type":"number","description":"The ID of the Workspace."},"docId":{"type":"string","description":"The ID of the Doc."},"pageId":{"type":"string","description":"The ID of the page."},"data":{"type":"object","properties":{"name":{"type":"string","description":"The updated name of the page."},"sub_title":{"type":"string","description":"The updated subtitle of the page."},"content":{"type":"string","description":"The updated content of the page."},"content_edit_mode":{"type":"string","description":"The strategy for updating content on the page. For example, `replace`, `append`, or `prepend`.","default":"replace"},"content_format":{"type":"string","description":"The format the page content is in. For example, `text/md` for markdown and `text/plain` for plain.","default":"text/md"}}}}},{"connectionName":"clickup","actionName":"post_v3_workspaces_by_workspace_id_auditlogs","parameters":{"workspace_id":{"type":"string","description":"The ID of the Workspace."},"data":{"type":"object","required":{"0":"applicability"},"properties":{"filter":{"description":"A filter containing the criteria to filter logs by.","allOf":{"0":{"type":"object","properties":{"workspaceId":{"type":"string","description":"The ID of the Workspace.","required":true},"userId":{"description":"The user ID. This can be a single user or multiple.","type":"array","items":{"type":"string"}},"userEmail":{"description":"User emails. This can be a single email or multiple.","type":"array","items":{"type":"string"}},"eventType":{"description":"Types of events to filter by. Options include `USER_LOGIN`, `USER_LOGOUT`, `CHANGE_2FA`, `CHANGE_PASSWORD`, `CHANGE_EMAIL`, `JOIN_WORKSPACE`, `LEAVE_WORKSPACE`, `REMOVE_FROM_WORKSPACE`, `RESET_PASSWORD`, `ROLE_CHANGE`, `SCIM_PROVISION`, `SCIM_DEPROVISION`, `SCIM_UPDATE`, `ADVANCED_SETTINGS_UPDATED`, `CHANGE_ROLE_PERMISSIONS`, `INVITE_TO_WORKSPACE`, `CHANGE_USER_ROLE`, `CHANGE_SSO_POLICY`, `CHANGE_2FA_POLICY`, `CUSTOM_ROLE_CREATED`, `CUSTOM_ROLE_UPDATED`, `CUSTOM_ROLE_DELETED`, `SCIM_GROUP_CREATED`, `SCIM_GROUP_UPDATED`, `SCIM_GROUP_DELETED`, `GROUP_CREATED`, `GROUP_DELETED`, `GROUP_EDITED`, `GROUP_MEMBER_ADDED`, `GROUP_MEMBER_REMOVED`, `SSO_CONFIG_UPDATED`, `TASK_CREATED`, `TASK_ARCHIVED`, `TASK_DELETED`, `TASK_RESTORED`, `TASK_UNARCHIVED`, `TASK_STATUS_CHANGED`, `TASK_PRIORITY_CHANGED`, `TASK_ASSIGNEES_CHANGED`, and `TASK_CUSTOM_FIELD_VALUES_CHANGED`.","type":"array","items":{"type":"string"}},"eventStatus":{"type":"string","description":"Status of events you're filtering by. Options include `success`, `failed`, `started`, `completed`, `error`, `system_error`."},"startTime":{"type":"number","description":"The start time to begin paginating your logs."},"endTime":{"type":"number","description":"The end time to begin paginating your logs."}}}}},"applicability":{"type":"string","description":"Type of logs to filter by. Options include `auth-and-security` and `user-activity`. Most use cases will use `auth-and-security`."},"pagination":{"description":"The pagination request determines where logs should start and how many to return.","allOf":{"0":{"type":"object","properties":{"pageRows":{"type":"number","description":"The number of rows to return."},"pageTimestamp":{"type":"number","description":"The timestamp to index on. This should be the timestamp of the last row on the previous page. If you are requesting the first page, this should be the current timestamp."},"pageDirection":{"type":"string","description":"Pagination direction. This should be set to `before` for most use cases. Options include `before` and `after`."}}}}}}}}},{"connectionName":"clickup","actionName":"patch_v3_workspaces_by_workspace_id_by_object_type_by_object_id_acls","parameters":{"workspace_id":{"type":"string","description":"The ID of the Workspace."},"object_type":{"type":"string","description":"Any object that can be shared in a Workspace. For example, `customField`, `dashboard`, `folder`, `goal`, `goalFolder`,`list`, `space`, `task`, and `view`."},"object_id":{"type":"string","description":"The ID of the object to share."},"data":{"type":"object","properties":{"entries":{"description":"The user or user group (Team) you wish to give, remove, or edit permissions.","type":"array","items":{"type":"object","properties":{"id":{"description":"The ID of user or user group (Team) you wish to give, remove, or edit permissions.","type":"string"},"kind":{"description":"The type of ID. Options are `user` or `group`.","type":"string"},"permission_level":{"description":"The permission level you wish to give to user or user group (Team). `1`=read, `3`=comment, `4`=edit, `5`=create, and `null`=remove access.","type":"number"}}}},"private":{"description":"The privacy of an object or location.","type":"boolean"}}}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_chat_channels","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"description_format":{"type":"string","description":"Format of the Channel Description (Default: text/md)"},"cursor":{"type":"string","description":"Used to request the next or previous page of results"},"limit":{"type":"integer","description":"The maximum number of results to fetch for this page."},"is_follower":{"type":"boolean","description":"Only return Channels the user is following"},"include_hidden":{"type":"boolean","description":"Include DMs/Group DMs that have been explicitly closed."},"with_comment_since":{"type":"number","description":"Only return Channels with comments since the given timestamp"},"room_types":{"type":"array","description":"Type of Channel (Channel, DM, Group DM) to return"}}},{"connectionName":"clickup","actionName":"post_v3_workspaces_by_workspace_id_chat_channels","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"data":{"type":"object","properties":{"description":{"type":"string","description":"The description for the Channel being created."},"name":{"type":"string","description":"The name for the Channel being created."},"topic":{"type":"string","description":"The topic of the Channel being created."},"user_ids":{"type":"array","description":"Optionally specify unique user IDs, up to 100.","items":{"type":"string"},"maxItems":100,"uniqueItems":true},"visibility":{"type":"string","description":"The visibility of the Channel being created. If not specified, the Channel is PUBLIC.","enum":["PUBLIC","PRIVATE"]}},"required":["name"]}}},{"connectionName":"clickup","actionName":"post_v3_workspaces_by_workspace_id_chat_channels_location","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"data":{"type":"object","properties":{"description":{"type":"string","description":"The description for the Channel being created."},"topic":{"type":"string","description":"The topic of the Channel being created."},"user_ids":{"type":"array","description":"Optionally specify unique user IDs, up to 100.","items":{"type":"string"},"maxItems":100,"uniqueItems":true},"visibility":{"type":"string","description":"The visibility of the Channel being created. If not specified, the Channel is PUBLIC.","enum":["PUBLIC","PRIVATE"]},"location":{"description":"The location of the Channel: Space, Folder, or List","allOf":[{"$ref":"#/components/schemas/ChatChannelLocation"}]}},"required":["location"]}}},{"connectionName":"clickup","actionName":"post_v3_workspaces_by_workspace_id_chat_channels_direct_message","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"data":{"type":"object","properties":{"user_ids":{"type":"array","description":"The unique user IDs of participants in the Direct Message, up to 10. A Self DM is created when no user IDs are provided","items":{"type":"string"},"maxItems":10,"uniqueItems":true}}}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_chat_channels_by_channel_id","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"channel_id":{"type":"string","description":"The ID of the specified Channel."},"description_format":{"type":"string","description":"Format of the Channel Description (Default: text/md)"}}},{"connectionName":"clickup","actionName":"patch_v3_workspaces_by_workspace_id_chat_channels_by_channel_id","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"channel_id":{"type":"string","description":"The ID of the specified Channel."},"data":{"type":"object","properties":{"content_format":{"type":"string","description":"The format of content field values (Default: text/md)","default":"text/md","enum":["text/md","text/plain"]},"description":{"type":"string","description":"The updated description of the Channel."},"location":{"description":"The updated location of the Channel: Space, Folder, or List","allOf":[{"$ref":"#/components/schemas/ChatChannelLocation"}]},"name":{"type":"string","description":"The updated name of the Channel."},"topic":{"type":"string","description":"The updated topic of the Channel."},"visibility":{"type":"string","description":"The updated visibility of the Channel.","enum":["PUBLIC","PRIVATE"]}}}}},{"connectionName":"clickup","actionName":"delete_v3_workspaces_by_workspace_id_chat_channels_by_channel_id","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"channel_id":{"type":"string","description":"The ID of the specified Channel."}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_chat_channels_by_channel_id_followers","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"channel_id":{"type":"string","description":"The ID of the specified Channel."},"cursor":{"type":"string","description":"The cursor to use to fetch the next page of results."},"limit":{"type":"integer","description":"The maximum number of results to fetch for this page."}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_chat_channels_by_channel_id_members","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"channel_id":{"type":"string","description":"The ID of the specified Channel."},"cursor":{"type":"string","description":"The cursor to use to fetch the next page of results."},"limit":{"type":"integer","description":"The maximum number of results to fetch for this page."}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_chat_channels_by_channel_id_messages","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"channel_id":{"type":"string","description":"The ID of the Channel where the messages live."},"cursor":{"type":"string","description":"The cursor to use to fetch the next page of results."},"limit":{"type":"integer","description":"The maximum number of results to fetch for this page."},"content_format":{"type":"string","description":"Format of the message content (Default: text/md)"}}},{"connectionName":"clickup","actionName":"post_v3_workspaces_by_workspace_id_chat_channels_by_channel_id_messages","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"channel_id":{"type":"string","description":"The ID of the Channel or direct message."},"data":{"type":"object","properties":{"assignee":{"type":"string","description":"The possible assignee of the message."},"group_assignee":{"type":"string","description":"The possible group assignee of the message."},"triaged_action":{"type":"number","description":"The triaged action applied to the message.","enum":[1,2]},"triaged_object_id":{"type":"string","description":"The message triaged action object id."},"triaged_object_type":{"type":"number","description":"The message triaged action object type."},"type":{"type":"string","description":"The type of message.","enum":["message","post"]},"content":{"type":"string","description":"The full content of the message to be created","format":"RichText","maxLength":40000},"reactions":{"type":"array","description":"The reactions to the message that exist at creation time","items":{"$ref":"#/components/schemas/ChatReaction"},"maxItems":10},"followers":{"type":"array","description":"The ids of the followers of the message","items":{"type":"string"},"maxItems":10},"content_format":{"type":"string","description":"The format of the message content (Default: text/md)","default":"text/md","enum":["text/md","text/plain"]},"post_data":{"description":"The data of the post message.","allOf":[{"$ref":"#/components/schemas/CommentChatPostDataCreate"}]}},"required":["type","content"]}}},{"connectionName":"clickup","actionName":"patch_v3_workspaces_by_workspace_id_chat_messages_by_message_id","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"message_id":{"type":"string","description":"The ID of the specified message"},"data":{"type":"object","properties":{"assignee":{"type":"string","description":"The possible assignee of the message."},"group_assignee":{"type":"string","description":"The possible group assignee of the message."},"content":{"type":"string","description":"The full content of the message to be created","format":"RichText","maxLength":40000},"content_format":{"type":"string","description":"The format of the message content (Default: text/md)","default":"text/md","enum":["text/md","text/plain"]},"post_data":{"description":"The data of the post message.","allOf":[{"$ref":"#/components/schemas/CommentChatPostDataPatch"}]},"resolved":{"type":"boolean","description":"The resolved status of the message."}}}}},{"connectionName":"clickup","actionName":"delete_v3_workspaces_by_workspace_id_chat_messages_by_message_id","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"message_id":{"type":"string","description":"The ID of the specified message"}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_chat_messages_by_message_id_reactions","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"message_id":{"type":"string","description":"The ID of the specified message"},"cursor":{"type":"string","description":"The cursor to use to fetch the next page of results."},"limit":{"type":"integer","description":"The maximum number of results to fetch for this page."}}},{"connectionName":"clickup","actionName":"post_v3_workspaces_by_workspace_id_chat_messages_by_message_id_reactions","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"message_id":{"type":"string","description":"The ID of the specified message"},"data":{"type":"object","properties":{"reaction":{"type":"string","description":"The name of the emoji to use for the reaction."}},"required":["reaction"]}}},{"connectionName":"clickup","actionName":"delete_v3_workspaces_by_workspace_id_chat_messages_by_message_id_reactions_by_reaction","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"message_id":{"type":"string","description":"The ID of the specified message"},"reaction":{"type":"string","description":"The name of the reaction to be deleted."}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_chat_messages_by_message_id_replies","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"message_id":{"type":"string","description":"The ID of the specified message"},"cursor":{"type":"string","description":"The cursor to use to fetch the next page of results."},"limit":{"type":"integer","description":"The maximum number of results to fetch for this page."},"content_format":{"type":"string","description":"Format of the message content (Default: text/md)"}}},{"connectionName":"clickup","actionName":"post_v3_workspaces_by_workspace_id_chat_messages_by_message_id_replies","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"message_id":{"type":"string","description":"The ID of the specified message"},"data":{"type":"object","properties":{"assignee":{"type":"string","description":"The possible assignee of the message."},"group_assignee":{"type":"string","description":"The possible group assignee of the message."},"triaged_action":{"type":"number","description":"The triaged action applied to the message.","enum":[1,2]},"triaged_object_id":{"type":"string","description":"The message triaged action object id."},"triaged_object_type":{"type":"number","description":"The message triaged action object type."},"type":{"type":"string","description":"The type of message.","enum":["message","post"]},"content":{"type":"string","description":"The full content of the message to be created","format":"RichText","maxLength":40000},"reactions":{"type":"array","description":"The reactions to the message that exist at creation time","items":{"$ref":"#/components/schemas/ChatReaction"},"maxItems":10},"followers":{"type":"array","description":"The ids of the followers of the message","items":{"type":"string"},"maxItems":10},"content_format":{"type":"string","description":"The format of the message content (Default: text/md)","default":"text/md","enum":["text/md","text/plain"]},"post_data":{"description":"The data of the post message.","allOf":[{"$ref":"#/components/schemas/CommentChatPostDataCreate"}]}},"required":["type","content"]}}},{"connectionName":"clickup","actionName":"get_v3_workspaces_by_workspace_id_chat_messages_by_message_id_tagged_users","parameters":{"workspace_id":{"type":"integer","description":"The ID of the Workspace."},"message_id":{"type":"string","description":"The ID of the specified message"},"cursor":{"type":"string","description":"The cursor to use to fetch the next page of results."},"limit":{"type":"integer","description":"The maximum number of results to fetch for this page."}}}],"slug":"clickup","created_at":"2025-09-25T18:49:39.454Z"},{"id":"confluence-oauth","name":"Confluence","description":"Create and manage content in Confluence.","logo_url":"https://assets.abstra.cloud/connectors/logos/confluence.svg","category":[],"setup_instructions":"Create and manage content in Confluence.","triggers":[],"actions":[{"connectionName":"confluence-oauth","actionName":"get_admin_key","parameters":{}},{"connectionName":"confluence-oauth","actionName":"post_admin_key","parameters":{"data":{"type":"object","properties":{"durationInMinutes":{"type":"integer","format":"int32","description":"The requested duration of admin key access in minutes, up to a maximum of 60 minutes, after which the issued admin key will automatically expire.","example":60}}}}},{"connectionName":"confluence-oauth","actionName":"delete_admin_key","parameters":{}},{"connectionName":"confluence-oauth","actionName":"get_attachments","parameters":{"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"status":{"type":"array","description":"Filter the results to attachments based on their status. By default, `current` and `archived` are used."},"mediaType":{"type":"string","description":"Filters on the mediaType of attachments. Only one may be specified."},"filename":{"type":"string","description":"Filters on the file-name of attachments. Only one may be specified."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_attachments_by_id","parameters":{"id":{"type":"string","description":"The ID of the attachment to be returned. If you don't know the attachment's ID, use Get attachments for page/blogpost/custom content."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-labels":{"type":"boolean","description":"Includes labels associated with this attachment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this attachment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this attachment in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this attachment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this attachment in the response.\nBy default this is included and can be omitted by setting the value to `false`."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the attachment."}}},{"connectionName":"confluence-oauth","actionName":"delete_attachments_by_id","parameters":{"id":{"type":"integer","description":"The ID of the attachment to be deleted."},"purge":{"type":"boolean","description":"If attempting to purge the attachment."}}},{"connectionName":"confluence-oauth","actionName":"get_attachments_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the attachment for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_attachments_by_id_operations","parameters":{"id":{"type":"string","description":"The ID of the attachment for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_attachments_by_attachment_id_properties","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_attachments_by_attachment_id_properties","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_attachments_by_attachment_id_properties_by_property_id","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property to be returned"}}},{"connectionName":"confluence-oauth","actionName":"put_attachments_by_attachment_id_properties_by_property_id","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_attachments_by_attachment_id_properties_by_property_id","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_attachments_by_id_versions","parameters":{"id":{"type":"string","description":"The ID of the attachment to be queried for its versions. If you don't know the attachment ID, use Get attachments and filter the results."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_attachments_by_attachment_id_versions_by_version_number","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the attachment to be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_attachments_by_id_footer_comments","parameters":{"id":{"type":"string","description":"The ID of the attachment for which comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"version":{"type":"integer","description":"Version number of the attachment to retrieve comments for. If no version provided, retrieves comments for the latest version."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts","parameters":{"id":{"type":"array","description":"Filter the results based on blog post ids. Multiple blog post ids can be specified as a comma-separated list."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"status":{"type":"array","description":"Filter the results to blog posts based on their status. By default, `current` is used."},"title":{"type":"string","description":"Filter the results to blog posts based on their title."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of blog posts per result to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_blogposts","parameters":{"private":{"type":"boolean","description":"The blog post will be private. Only the user who creates this blog post will have permission to view and edit one."},"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space"},"status":{"enum":["current","draft"],"type":"string","description":"The status of the blog post, specifies if the blog post will be created as a new blog post or a draft"},"title":{"type":"string","description":"Title of the blog post, required if creating non-draft."},"body":{"oneOf":[{"$ref":"#/components/schemas/BlogPostBodyWrite"},{"$ref":"#/components/schemas/BlogPostNestedBodyWrite"}]},"createdAt":{"type":"string","description":"Created date of the blog post in the format of \"yyyy-MM-ddTHH:mm:ss.SSSZ\"."}}}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id","parameters":{"id":{"type":"integer","description":"The ID of the blog post to be returned. If you don't know the blog post ID, use Get blog posts and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"get-draft":{"type":"boolean","description":"Retrieve the draft version of this blog post."},"status":{"type":"array","description":"Filter the blog post being retrieved by its status."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-labels":{"type":"boolean","description":"Includes labels associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this blog post in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-likes":{"type":"boolean","description":"Includes likes associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this blog post in the response.\nBy default this is included and can be omitted by setting the value to `false`."},"include-favorited-by-current-user-status":{"type":"boolean","description":"Includes whether this blog post has been favorited by the current user."},"include-webresources":{"type":"boolean","description":"Includes web resources that can be used to render blog post content on a client."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the blog post."}}},{"connectionName":"confluence-oauth","actionName":"put_blogposts_by_id","parameters":{"id":{"type":"integer","description":"The ID of the blog post to be updated. If you don't know the blog post ID, use Get Blog Posts and filter the results."},"data":{"type":"object","required":["id","status","title","body","version"],"properties":{"id":{"type":"string","description":"Id of the blog post."},"status":{"enum":["current","draft"],"type":"string","description":"The updated status of the blog post.\n\nNote, if you change the status of a blog post from 'current' to 'draft' and it has an existing draft, the existing draft will be deleted in favor of the updated draft.\nAdditionally, this endpoint can be used to restore a 'trashed' or 'deleted' blog post to 'current' status. For restoration, blog post contents will not be updated and only the blog post status will be changed."},"title":{"type":"string","description":"Title of the blog post."},"spaceId":{"type":"string","description":"ID of the containing space.\n\nThis currently **does not support moving the blog post to a different space**."},"body":{"oneOf":[{"$ref":"#/components/schemas/BlogPostBodyWrite"},{"$ref":"#/components/schemas/BlogPostNestedBodyWrite"}]},"version":{"type":"object","properties":{"number":{"format":"int32","type":"integer","description":"The new version number of the updated blog post. \nSet this to the current version number plus one, unless you are updating the status to 'draft' which requires a version number of 1.\n\nIf you don't know the current version number, use Get blog post by id."},"message":{"type":"string","description":"An optional message to be stored with the version."}}},"createdAt":{"type":"string","description":"Created date of the blog post in the format of \"yyyy-MM-ddTHH:mm:ss.SSSZ\"."}}}}},{"connectionName":"confluence-oauth","actionName":"delete_blogposts_by_id","parameters":{"id":{"type":"integer","description":"The ID of the blog post to be deleted."},"purge":{"type":"boolean","description":"If attempting to purge the blog post."},"draft":{"type":"boolean","description":"If attempting to delete a blog post that is a draft."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_attachments","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which attachments should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"status":{"type":"array","description":"Filter the results to attachments based on their status. By default, `current` and `archived` are used."},"mediaType":{"type":"string","description":"Filters on the mediaType of attachments. Only one may be specified."},"filename":{"type":"string","description":"Filters on the file-name of attachments. Only one may be specified."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_custom_content","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which custom content should be returned."},"type":{"type":"string","description":"The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_likes_count","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which like count should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_likes_users","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which account IDs should be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of account IDs per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_blogpost_id_properties","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_blogposts_by_blogpost_id_properties","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_blogpost_id_properties_by_property_id","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the property being requested"}}},{"connectionName":"confluence-oauth","actionName":"put_blogposts_by_blogpost_id_properties_by_property_id","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_blogposts_by_blogpost_id_properties_by_property_id","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_versions","parameters":{"id":{"type":"integer","description":"The ID of the blog post to be queried for its versions. If you don't know the blog post ID, use Get blog posts and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_blogpost_id_versions_by_version_number","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the blog post to be returned."}}},{"connectionName":"confluence-oauth","actionName":"post_content_convert_ids_to_types","parameters":{"data":{"type":"object","required":["contentIds"],"properties":{"contentIds":{"description":"The content ids to convert. They may be provided as strings or numbers.","type":"array","maxItems":100,"items":{"anyOf":[{"type":"string"},{"type":"number"}]}}}}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content","parameters":{"type":{"type":"string","description":"The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content."},"id":{"type":"array","description":"Filter the results based on custom content ids. Multiple custom content ids can be specified as a comma-separated list."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."}}},{"connectionName":"confluence-oauth","actionName":"post_custom_content","parameters":{"data":{"type":"object","required":["body","title","type"],"properties":{"type":{"type":"string","description":"Type of custom content."},"status":{"enum":["current","draft"],"type":"string","description":"The status of the custom content. Defaults to `current` when status not provided."},"spaceId":{"type":"string","description":"ID of the containing space."},"pageId":{"type":"string","description":"ID of the containing page."},"blogPostId":{"type":"string","description":"ID of the containing Blog Post."},"customContentId":{"type":"string","description":"ID of the containing custom content."},"title":{"type":"string","description":"Title of the custom content."},"body":{"oneOf":[{"$ref":"#/components/schemas/CustomContentBodyWrite"},{"$ref":"#/components/schemas/CustomContentNestedBodyWrite"}]}}}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_id","parameters":{"id":{"type":"integer","description":"The ID of the custom content to be returned. If you don't know the custom content ID, use Get Custom Content by Type and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-labels":{"type":"boolean","description":"Includes labels associated with this custom content in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this custom content in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this custom content in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this custom content in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this custom content in the response.\nBy default this is included and can be omitted by setting the value to `false`."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the custom content."}}},{"connectionName":"confluence-oauth","actionName":"put_custom_content_by_id","parameters":{"id":{"type":"integer","description":"The ID of the custom content to be updated. If you don't know the custom content ID, use Get Custom Content by Type and filter the results."},"data":{"type":"object","required":["body","id","status","title","type","version"],"properties":{"id":{"type":"string","description":"Id of custom content."},"type":{"type":"string","description":"Type of custom content."},"status":{"enum":["current"],"type":"string","description":"The status of the custom content."},"spaceId":{"type":"string","description":"ID of the containing space (must be the same as the spaceId of the space the custom content was created in)."},"pageId":{"type":"string","description":"ID of the containing page."},"blogPostId":{"type":"string","description":"ID of the containing Blog Post."},"customContentId":{"type":"string","description":"ID of the containing custom content."},"title":{"type":"string","description":"Title of the custom content."},"body":{"oneOf":[{"$ref":"#/components/schemas/CustomContentBodyWrite"},{"$ref":"#/components/schemas/CustomContentNestedBodyWrite"}]},"version":{"type":"object","properties":{"number":{"format":"int32","type":"integer","description":"The version number, must be incremented by one."},"message":{"type":"string","description":"An optional message to be stored with the version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_custom_content_by_id","parameters":{"id":{"type":"integer","description":"The ID of the custom content to be deleted."},"purge":{"type":"boolean","description":"If attempting to purge the custom content."}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_id_attachments","parameters":{"id":{"type":"integer","description":"The ID of the custom content for which attachments should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"status":{"type":"array","description":"Filter the results to attachments based on their status. By default, `current` and `archived` are used."},"mediaType":{"type":"string","description":"Filters on the mediaType of attachments. Only one may be specified."},"filename":{"type":"string","description":"Filters on the file-name of attachments. Only one may be specified."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_id_footer_comments","parameters":{"id":{"type":"integer","description":"The ID of the custom content for which comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the custom content for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the custom content for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_custom_content_id_properties","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_custom_content_by_custom_content_id_properties","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_custom_content_id_properties_by_property_id","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-oauth","actionName":"put_custom_content_by_custom_content_id_properties_by_property_id","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_custom_content_by_custom_content_id_properties_by_property_id","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_labels","parameters":{"label-id":{"type":"array","description":"Filters on label ID. Multiple IDs can be specified as a comma-separated list."},"prefix":{"type":"array","description":"Filters on label prefix. Multiple IDs can be specified as a comma-separated list."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_labels_by_id_attachments","parameters":{"id":{"type":"integer","description":"The ID of the label for which attachments should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_labels_by_id_blogposts","parameters":{"id":{"type":"integer","description":"The ID of the label for which blog posts should be returned."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of blog posts per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_labels_by_id_pages","parameters":{"id":{"type":"integer","description":"The ID of the label for which pages should be returned."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_pages","parameters":{"id":{"type":"array","description":"Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"status":{"type":"array","description":"Filter the results to pages based on their status. By default, `current` and `archived` are used."},"title":{"type":"string","description":"Filter the results to pages based on their title."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"subtype":{"type":"string","description":"Filter the results to pages based on their subtype."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_pages","parameters":{"embedded":{"type":"boolean","description":"Tag the content as embedded and content will be created in NCS."},"private":{"type":"boolean","description":"The page will be private. Only the user who creates this page will have permission to view and edit one."},"root-level":{"type":"boolean","description":"The page will be created at the root level of the space (outside the space homepage tree). If true, then a \nvalue may not be supplied for the `parentId` body parameter."},"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"status":{"enum":["current","draft"],"type":"string","description":"The status of the page, published or draft."},"title":{"type":"string","description":"Title of the page, required if page status is not draft."},"parentId":{"type":"string","description":"The parent content ID of the page. If the `root-level` query parameter is set to false and a value is \nnot supplied for this parameter, then the space homepage's ID will be used. If the `root-level` query \nparameter is set to true, then a value may not be supplied for this parameter."},"body":{"oneOf":[{"$ref":"#/components/schemas/PageBodyWrite"},{"$ref":"#/components/schemas/PageNestedBodyWrite"}]},"subtype":{"enum":["live"],"type":"string","description":"The subtype of the page. Provide the subtype live to create a live doc or no subtype to create a page."}}}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id","parameters":{"id":{"type":"integer","description":"The ID of the page to be returned. If you don't know the page ID, use Get pages and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"get-draft":{"type":"boolean","description":"Retrieve the draft version of this page."},"status":{"type":"array","description":"Filter the page being retrieved by its status."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-labels":{"type":"boolean","description":"Includes labels associated with this page in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this page in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this page in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-likes":{"type":"boolean","description":"Includes likes associated with this page in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this page in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this page in the response.\nBy default this is included and can be omitted by setting the value to `false`."},"include-favorited-by-current-user-status":{"type":"boolean","description":"Includes whether this page has been favorited by the current user."},"include-webresources":{"type":"boolean","description":"Includes web resources that can be used to render page content on a client."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the page."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the page, as defined in the `ChildrenResponse` object."}}},{"connectionName":"confluence-oauth","actionName":"put_pages_by_id","parameters":{"id":{"type":"integer","description":"The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results."},"data":{"type":"object","required":["id","status","title","body","version"],"properties":{"id":{"type":"string","description":"Id of the page."},"status":{"enum":["current","draft"],"type":"string","description":"The updated status of the page.\n\nNote, if you change the status of a page from 'current' to 'draft' and it has an existing draft, the existing draft will be deleted in favor of the updated draft.\nAdditionally, this endpoint can be used to restore a 'trashed' or 'deleted' page to 'current' status. For restoration, page contents will not be updated and only the page status will be changed."},"title":{"type":"string","description":"Title of the page."},"spaceId":{"format":"string","description":"ID of the containing space.\n\nThis currently **does not support moving the page to a different space**."},"parentId":{"format":"string","description":"ID of the parent content.\n\nThis allows the page to be moved under a different parent within the same space."},"ownerId":{"format":"string","description":"Account ID of the page owner.\n\nThis allows page ownership to be transferred to another user."},"body":{"oneOf":[{"$ref":"#/components/schemas/PageBodyWrite"},{"$ref":"#/components/schemas/PageNestedBodyWrite"}]},"version":{"type":"object","properties":{"number":{"format":"int32","type":"integer","description":"The new version of the updated page. \nSet this to the current version number plus one, unless you are updating the status to 'draft' which requires a version number of 1.\n\nIf you don't know the current version number, use Get page by id."},"message":{"type":"string","description":"An optional message to be stored with the version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_pages_by_id","parameters":{"id":{"type":"integer","description":"The ID of the page to be deleted."},"purge":{"type":"boolean","description":"If attempting to purge the page."},"draft":{"type":"boolean","description":"If attempting to delete a page that is a draft."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_attachments","parameters":{"id":{"type":"integer","description":"The ID of the page for which attachments should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"status":{"type":"array","description":"Filter the results to attachments based on their status. By default, `current` and `archived` are used."},"mediaType":{"type":"string","description":"Filters on the mediaType of attachments. Only one may be specified."},"filename":{"type":"string","description":"Filters on the file-name of attachments. Only one may be specified."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_custom_content","parameters":{"id":{"type":"integer","description":"The ID of the page for which custom content should be returned."},"type":{"type":"string","description":"The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the page for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_likes_count","parameters":{"id":{"type":"integer","description":"The ID of the page for which like count should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_likes_users","parameters":{"id":{"type":"integer","description":"The ID of the page for which like count should be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of account IDs per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the page for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_page_id_properties","parameters":{"page-id":{"type":"integer","description":"The ID of the page for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_pages_by_page_id_properties","parameters":{"page-id":{"type":"integer","description":"The ID of the page to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_page_id_properties_by_property_id","parameters":{"page-id":{"type":"integer","description":"The ID of the page for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-oauth","actionName":"put_pages_by_page_id_properties_by_property_id","parameters":{"page-id":{"type":"integer","description":"The ID of the page the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_pages_by_page_id_properties_by_property_id","parameters":{"page-id":{"type":"integer","description":"The ID of the page the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"post_pages_by_id_redact","parameters":{"id":{"type":"integer","description":"The ID of the page to redact content from."},"data":{"type":"object","required":["createdAt","cleanHistory"],"properties":{"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the content was last updated."},"cleanHistory":{"type":"boolean","description":"Whether to clean up previous versions containing the redaction. When true, historical versions of the content that contain the redacted text will be squashed."},"body":{"type":"object","properties":{"redactions":{"type":"array","items":{"$ref":"#/components/schemas/Redaction"}}}},"title":{"type":"object","properties":{"redactions":{"type":"array","items":{"$ref":"#/components/schemas/Redaction"}}}}}}}},{"connectionName":"confluence-oauth","actionName":"post_blogposts_by_id_redact","parameters":{"id":{"type":"integer","description":"The ID of the blog post to redact content from."},"data":{"type":"object","required":["createdAt","cleanHistory"],"properties":{"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the content was last updated."},"cleanHistory":{"type":"boolean","description":"Whether to clean up previous versions containing the redaction. When true, historical versions of the content that contain the redacted text will be squashed."},"body":{"type":"object","properties":{"redactions":{"type":"array","items":{"$ref":"#/components/schemas/Redaction"}}}},"title":{"type":"object","properties":{"redactions":{"type":"array","items":{"$ref":"#/components/schemas/Redaction"}}}}}}}},{"connectionName":"confluence-oauth","actionName":"put_pages_by_id_title","parameters":{"id":{"type":"integer","description":"The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results"},"data":{"type":"object","required":["status","title"],"properties":{"status":{"enum":["current","draft"],"type":"string","description":"The status of the page, current or draft."},"title":{"type":"string","description":"The updated title for the page"}}}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_versions","parameters":{"id":{"type":"integer","description":"The ID of the page to be queried for its versions. If you don't know the page ID, use Get pages and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"post_whiteboards","parameters":{"private":{"type":"boolean","description":"The whiteboard will be private. Only the user who creates this whiteboard will have permission to view and edit one."},"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"title":{"type":"string","description":"Title of the whiteboard."},"parentId":{"type":"string","description":"The parent content ID of the whiteboard."},"templateKey":{"type":"string","description":"Providing a template key will add that template to the new whiteboard.","enum":["2x2-prioritization","4ls-retro","annual-calendar","brainwriting","concept-map","crazy-8s","daily-sync","disruptive-brainstorm","dot-voting","elevator-pitch","flow-chart","gap-analysis","ice-breakers","incident-postmortem","journey-mapping-kit","kanban-board","lean-coffee","network-of-teams","org-chart","pi-planning","prioritization","prioritization-experiment","product-roadmap","product-vision-board","rice","sailboat-retro","service-blueprint","simple-retrospective","sprint-planning","sticky-note-pack","swimlanes","team-formation-guide","timeline","timeline-workflow","user-story-map","workflow","vision-board","venn-diagram","storyboard","action-plan","root-cause-analysis","executive-summary","stakeholder-mapping","annual-calendar-2025-2026","health-monitor","okr-planning","swot-analysis","poker-planning","fishbone-diagram","risk-assessment","bounded-context","hopes-and-fears","swimlane-vertical"]},"locale":{"type":"string","description":"If templateKey is provided, locale will decide which language the template will be created with. If locale is omitted, the user's locale will be used.","enum":["de-DE","cs-CZ","ko-KR","fr-FR","it-IT","ja-JP","nl-NL","nb-NO","da-DK","sv-SE","fi-FI","ru-RU","pl-PL","tr-TR","hu-HU","en-GB","en-US","pt-BR","zh-CN","zh-TW","es-ES"]}}}}},{"connectionName":"confluence-oauth","actionName":"get_whiteboards_by_id","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard to be returned"},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the whiteboard."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the whiteboard, as defined in the `ChildrenResponse` object."},"include-operations":{"type":"boolean","description":"Includes operations associated with this whiteboard in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this whiteboard in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-oauth","actionName":"delete_whiteboards_by_id","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_whiteboards_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_whiteboards_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_whiteboards_by_whiteboard_id_properties_by_property_id","parameters":{"whiteboard-id":{"type":"integer","description":"The ID of the whiteboard for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-oauth","actionName":"put_whiteboards_by_whiteboard_id_properties_by_property_id","parameters":{"whiteboard-id":{"type":"integer","description":"The ID of the whiteboard the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_whiteboards_by_whiteboard_id_properties_by_property_id","parameters":{"whiteboard-id":{"type":"integer","description":"The ID of the whiteboard the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_whiteboards_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_whiteboards_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent whiteboard."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_whiteboards_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_whiteboards_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_databases","parameters":{"private":{"type":"boolean","description":"The database will be private. Only the user who creates this database will have permission to view and edit one."},"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"title":{"type":"string","description":"Title of the database."},"parentId":{"type":"string","description":"The parent content ID of the database."}}}}},{"connectionName":"confluence-oauth","actionName":"get_databases_by_id","parameters":{"id":{"type":"integer","description":"The ID of the database to be returned"},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the database."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the database, as defined in the `ChildrenResponse` object."},"include-operations":{"type":"boolean","description":"Includes operations associated with this database in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this database in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-oauth","actionName":"delete_databases_by_id","parameters":{"id":{"type":"integer","description":"The ID of the database to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_databases_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the database for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_databases_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the database to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_databases_by_database_id_properties_by_property_id","parameters":{"database-id":{"type":"integer","description":"The ID of the database for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-oauth","actionName":"put_databases_by_database_id_properties_by_property_id","parameters":{"database-id":{"type":"integer","description":"The ID of the database the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_databases_by_database_id_properties_by_property_id","parameters":{"database-id":{"type":"integer","description":"The ID of the database the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_databases_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the database for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_databases_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent database."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_databases_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the database."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_databases_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the database."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_embeds","parameters":{"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"title":{"type":"string","description":"Title of the Smart Link in the content tree."},"parentId":{"type":"string","description":"The parent content ID of the Smart Link in the content tree."},"embedUrl":{"type":"string","description":"The URL that the Smart Link in the content tree should be populated with."}}}}},{"connectionName":"confluence-oauth","actionName":"get_embeds_by_id","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree to be returned."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the Smart Link."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the Smart Link, as defined in the `ChildrenResponse` object."},"include-operations":{"type":"boolean","description":"Includes operations associated with this Smart Link in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this Smart Link in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-oauth","actionName":"delete_embeds_by_id","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_embeds_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of Smart Links per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_embeds_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_embeds_by_embed_id_properties_by_property_id","parameters":{"embed-id":{"type":"integer","description":"The ID of the Smart Link in the content tree for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-oauth","actionName":"put_embeds_by_embed_id_properties_by_property_id","parameters":{"embed-id":{"type":"integer","description":"The ID of the Smart Link in the content tree the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_embeds_by_embed_id_properties_by_property_id","parameters":{"embed-id":{"type":"integer","description":"The ID of the Smart Link in the content tree the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_embeds_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_embeds_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent smart link."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_embeds_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the smart link."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_embeds_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_folders","parameters":{"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"title":{"type":"string","description":"Title of the folder."},"parentId":{"type":"string","description":"The parent content ID of the folder."}}}}},{"connectionName":"confluence-oauth","actionName":"get_folders_by_id","parameters":{"id":{"type":"integer","description":"The ID of the folder to be returned."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the folder."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the folder, as defined in the `ChildrenResponse` object."},"include-operations":{"type":"boolean","description":"Includes operations associated with this folder in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this folder in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-oauth","actionName":"delete_folders_by_id","parameters":{"id":{"type":"integer","description":"The ID of the folder to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_folders_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the folder for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_folders_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the folder to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_folders_by_folder_id_properties_by_property_id","parameters":{"folder-id":{"type":"integer","description":"The ID of the folder for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-oauth","actionName":"put_folders_by_folder_id_properties_by_property_id","parameters":{"folder-id":{"type":"integer","description":"The ID of the folder the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_folders_by_folder_id_properties_by_property_id","parameters":{"folder-id":{"type":"integer","description":"The ID of the folder the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_folders_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the folder for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_folders_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent folder."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_folders_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the folder."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_folders_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the folder."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_page_id_versions_by_version_number","parameters":{"page-id":{"type":"integer","description":"The ID of the page for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the page to be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_custom_content_id_versions","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content to be queried for its versions. If you don't know the custom content ID, use Get custom-content by type and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_custom_content_id_versions_by_version_number","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the custom content to be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_spaces","parameters":{"ids":{"type":"array","description":"Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list."},"keys":{"type":"array","description":"Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list."},"type":{"type":"string","description":"Filter the results to spaces based on their type."},"status":{"type":"string","description":"Filter the results to spaces based on their status."},"labels":{"type":"array","description":"Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list."},"favorited-by":{"type":"string","description":"Filter the results to spaces favorited by the user with the specified account ID."},"not-favorited-by":{"type":"string","description":"Filter the results to spaces NOT favorited by the user with the specified account ID."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"description-format":{"type":"string","description":"The content format type to be returned in the `description` field of the response. If available, the representation will be available under a response field of the same name under the `description` field."},"include-icon":{"type":"boolean","description":"If the icon for the space should be fetched or not."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of spaces per result to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_spaces","parameters":{"data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the space to be created."},"key":{"type":"string","description":"The key for the new space. See [Space Keys](https://support.atlassian.com/confluence-cloud/docs/create-a-space/). If the key property is not provided, the alias property is required to be used instead."},"alias":{"type":"string","description":"This field will be used as the new identifier for the space in confluence page URLs. If the alias property is not provided, the key property is required to be used instead. Maximum 255 alphanumeric characters in length."},"description":{"type":"object","description":"The description of the new/updated space. Note, only the 'plain' representation is currently supported.","properties":{"value":{"type":"string","description":"The space description."},"representation":{"type":"string","description":"The format of the description."}}},"roleAssignments":{"type":"array","items":{"description":"The role assignments for the new space. If none are provided, the Default Space Roles are applied. If roles are provided, the space is created with exactly the provided set of roles. A private space is created if only the creator is assigned to a role and it’s the Admin role. At least one Admin role assignment must be specified.","properties":{"principal":{"$ref":"#/components/schemas/Principal"},"roleId":{"type":"string","description":"The role to which the principal is assigned."}}}},"copySpaceAccessConfiguration":{"type":"integer","description":"The id of the space to copy the space access configuration from."},"createPrivateSpace":{"type":"boolean","description":"Whether to create the space as private."}}}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id","parameters":{"id":{"type":"integer","description":"The ID of the space to be returned."},"description-format":{"type":"string","description":"The content format type to be returned in the `description` field of the response. If available, the representation will be available under a response field of the same name under the `description` field."},"include-icon":{"type":"boolean","description":"If the icon for the space should be fetched or not."},"include-operations":{"type":"boolean","description":"Includes operations associated with this space in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes space properties associated with this space in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-permissions":{"type":"boolean","description":"Includes space permissions associated with this space in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-role-assignments":{"type":"boolean","description":"Includes role assignments associated with this space in the response. This parameter is only accepted for EAP sites.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-labels":{"type":"boolean","description":"Includes labels associated with this space in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id_blogposts","parameters":{"id":{"type":"integer","description":"The ID of the space for which blog posts should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"status":{"type":"array","description":"Filter the results to blog posts based on their status. By default, `current` is used."},"title":{"type":"string","description":"Filter the results to blog posts based on their title."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of blog posts per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the space for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id_content_labels","parameters":{"id":{"type":"integer","description":"The ID of the space for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id_custom_content","parameters":{"id":{"type":"integer","description":"The ID of the space for which custom content should be returned."},"type":{"type":"string","description":"The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the space for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id_pages","parameters":{"id":{"type":"integer","description":"The ID of the space for which pages should be returned."},"depth":{"type":"string","description":"Filter the results to pages at the root level of the space or to all pages in the space."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"status":{"type":"array","description":"Filter the results to pages based on their status. By default, `current` and `archived` are used."},"title":{"type":"string","description":"Filter the results to pages based on their title."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_space_id_properties","parameters":{"space-id":{"type":"integer","description":"The ID of the space for which space properties should be returned."},"key":{"type":"string","description":"The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_spaces_by_space_id_properties","parameters":{"space-id":{"type":"integer","description":"The ID of the space for which space properties should be returned."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the space property"},"value":{"description":"Value of the space property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_space_id_properties_by_property_id","parameters":{"space-id":{"type":"integer","description":"The ID of the space the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be retrieved."}}},{"connectionName":"confluence-oauth","actionName":"put_spaces_by_space_id_properties_by_property_id","parameters":{"space-id":{"type":"integer","description":"The ID of the space the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the space property"},"value":{"description":"Value of the space property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_spaces_by_space_id_properties_by_property_id","parameters":{"space-id":{"type":"integer","description":"The ID of the space the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id_permissions","parameters":{"id":{"type":"integer","description":"The ID of the space to be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of assignments to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_space_permissions","parameters":{"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of space permissions to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_space_roles","parameters":{"space-id":{"type":"string","description":"The space ID for which to filter available space roles; if empty, return all available space roles for the tenant."},"role-type":{"type":"string","description":"The space role type to filter results by."},"principal-id":{"type":"string","description":"The principal ID to filter results by. If specified, a principal-type must also be specified. Paired with a `principal-type` of `ACCESS_CLASS`, valid values include [`anonymous-users`, `jsm-project-admins`, `authenticated-users`, `all-licensed-users`, `all-product-admins`]"},"principal-type":{"type":"string","description":"The principal type to filter results by. If specified, a principal-id must also be specified."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of space roles to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_space_roles","parameters":{"data":{"type":"object","required":{"0":"name","1":"description","2":"spacePermissions"},"properties":{"name":{"type":"string","description":"Name of the space role"},"description":{"type":"string","description":"Description for the space role"},"spacePermissions":{"type":"array","items":{"type":"string"},"description":"The ids of the space permissions associated with the space role"}}}}},{"connectionName":"confluence-oauth","actionName":"get_space_roles_by_id","parameters":{"id":{"type":"integer","description":"The ID of the space role to retrieve."}}},{"connectionName":"confluence-oauth","actionName":"put_space_roles_by_id","parameters":{"id":{"type":"string","description":"Id of the space role"},"data":{"type":"object","required":{"0":"name","1":"description","2":"spacePermissions"},"properties":{"name":{"type":"string","description":"Name of the space role"},"description":{"type":"string","description":"Description for the space role"},"spacePermissions":{"type":"array","items":{"type":"string"},"description":"The ids of the space permissions associated with the space role"},"anonymousReassignmentRoleId":{"type":"string","description":"If space anonymous access is assigned to the role being modified, the Id of a role to migrate those assignments to can be specified. Anonymous access role assignments left unchanged if unspecified."},"guestReassignmentRoleId":{"type":"string","description":"If guests are assigned to the role being modified, the Id of a role to migrate those assignments to can be specified. Guest role assignments left unchanged if unspecified."}}}}},{"connectionName":"confluence-oauth","actionName":"delete_space_roles_by_id","parameters":{"id":{"type":"string","description":"Id of the space role"}}},{"connectionName":"confluence-oauth","actionName":"get_space_role_mode","parameters":{}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id_role_assignments","parameters":{"id":{"type":"integer","description":"The ID of the space for which to retrieve assignments."},"role-id":{"type":"string","description":"Filters the returned role assignments to the provided role ID."},"role-type":{"type":"string","description":"Filters the returned role assignments to the provided role type."},"principal-id":{"type":"string","description":"Filters the returned role assignments to the provided principal id. If specified, a principal-type must also be specified. Paired with a `principal-type` of `ACCESS_CLASS`, valid values include [`anonymous-users`, `jsm-project-admins`, `authenticated-users`, `all-licensed-users`, `all-product-admins`]"},"principal-type":{"type":"string","description":"Filters the returned role assignments to the provided principal type. If specified, a principal-id must also be specified."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of space roles to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_spaces_by_id_role_assignments","parameters":{"id":{"type":"integer","description":"The ID of the space for which to retrieve assignments."},"data":{"type":"array","items":{"required":["principal"],"properties":{"principal":{"$ref":"#/components/schemas/Principal"},"roleId":{"type":"string","description":"The role to which the principal is assigned."}}}}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_footer_comments","parameters":{"id":{"type":"integer","description":"The ID of the page for which footer comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"status":{"type":"array","description":"Filter the footer comment being retrieved by its status."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_inline_comments","parameters":{"id":{"type":"integer","description":"The ID of the page for which inline comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"status":{"type":"array","description":"Filter the inline comment being retrieved by its status."},"resolution-status":{"type":"array","description":"Filter the inline comment being retrieved by its resolution status."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of inline comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_footer_comments","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which footer comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"status":{"type":"array","description":"Filter the footer comment being retrieved by its status."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_inline_comments","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which inline comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"status":{"type":"array","description":"Filter the inline comment being retrieved by its status."},"resolution-status":{"type":"array","description":"Filter the inline comment being retrieved by its resolution status."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of inline comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_footer_comments","parameters":{"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_footer_comments","parameters":{"data":{"type":"object","properties":{"blogPostId":{"type":"string","description":"ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply."},"pageId":{"type":"string","description":"ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply."},"parentCommentId":{"type":"string","description":"ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment."},"attachmentId":{"type":"string","description":"ID of the attachment, if intending to create a comment against an attachment."},"customContentId":{"type":"string","description":"ID of the custom content, if intending to create a comment against a custom content."},"body":{"oneOf":[{"$ref":"#/components/schemas/CommentBodyWrite"},{"$ref":"#/components/schemas/CommentNestedBodyWrite"}]}}}}},{"connectionName":"confluence-oauth","actionName":"get_footer_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this footer comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this footer comment in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-likes":{"type":"boolean","description":"Includes likes associated with this footer comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this footer comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this footer comment in the response.\nBy default this is included and can be omitted by setting the value to `false`."}}},{"connectionName":"confluence-oauth","actionName":"put_footer_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."},"data":{"allOf":{"0":{"type":"object","properties":{"version":{"type":"object","properties":{"number":{"type":"integer","description":"Number of new version. Should be 1 higher than current version of the comment."},"message":{"type":"string","description":"Optional message store for the new version."}}},"body":{"oneOf":[{"$ref":"#/components/schemas/CommentBodyWrite"},{"$ref":"#/components/schemas/CommentNestedBodyWrite"}]}}},"1":{"type":"object","properties":{"_links":{"type":"object","properties":{"base":{"type":"string","description":"Base url of the Confluence site."}}}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_footer_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."}}},{"connectionName":"confluence-oauth","actionName":"get_footer_comments_by_id_children","parameters":{"id":{"type":"integer","description":"The ID of the parent comment for which footer comment children should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_footer_comments_by_id_likes_count","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which like count should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_footer_comments_by_id_likes_users","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which like count should be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of account IDs per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_footer_comments_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_footer_comments_by_id_versions","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which versions should be returned"},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_footer_comments_by_id_versions_by_version_number","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the footer comment to be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_inline_comments","parameters":{"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_inline_comments","parameters":{"data":{"type":"object","properties":{"blogPostId":{"type":"string","description":"ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply."},"pageId":{"type":"string","description":"ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply."},"parentCommentId":{"type":"string","description":"ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment."},"body":{"oneOf":[{"$ref":"#/components/schemas/CommentBodyWrite"},{"$ref":"#/components/schemas/CommentNestedBodyWrite"}]},"inlineCommentProperties":{"type":"object","description":"Object describing the text to highlight on the page/blog post. Only applicable for top level inline comments (not replies) and required in that case.","properties":{"textSelection":{"type":"string","description":"The text to highlight"},"textSelectionMatchCount":{"type":"integer","description":"The number of matches for the selected text on the page (should be strictly greater than textSelectionMatchIndex)"},"textSelectionMatchIndex":{"type":"integer","description":"The match index to highlight. This is zero-based. E.g. if you have 3 occurrences of \"hello world\" on a page \nand you want to highlight the second occurrence, you should pass 1 for textSelectionMatchIndex and 3 for textSelectionMatchCount."}}}}}}},{"connectionName":"confluence-oauth","actionName":"get_inline_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this inline comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this inline comment in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-likes":{"type":"boolean","description":"Includes likes associated with this inline comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this inline comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this inline comment in the response.\nBy default this is included and can be omitted by setting the value to `false`."}}},{"connectionName":"confluence-oauth","actionName":"put_inline_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."},"data":{"type":"object","properties":{"version":{"type":"object","properties":{"number":{"type":"integer","description":"Number of new version. Should be 1 higher than current version of the comment."},"message":{"type":"string","description":"Optional message store for the new version."}}},"body":{"oneOf":[{"$ref":"#/components/schemas/CommentBodyWrite"},{"$ref":"#/components/schemas/CommentNestedBodyWrite"}]},"resolved":{"type":"boolean","description":"Resolved state of the comment. Set to true to resolve the comment, set to false to reopen it. If\nmatching the existing state (i.e. true -> resolved or false -> open/reopened) , no change will occur. A dangling\ncomment cannot be updated."}}}}},{"connectionName":"confluence-oauth","actionName":"delete_inline_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_inline_comments_by_id_children","parameters":{"id":{"type":"integer","description":"The ID of the parent comment for which inline comment children should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_inline_comments_by_id_likes_count","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which like count should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_inline_comments_by_id_likes_users","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which like count should be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of account IDs per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_inline_comments_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which operations should be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_inline_comments_by_id_versions","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which versions should be returned"},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_inline_comments_by_id_versions_by_version_number","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the inline comment to be returned."}}},{"connectionName":"confluence-oauth","actionName":"get_comments_by_comment_id_properties","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_comments_by_comment_id_properties","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-oauth","actionName":"get_comments_by_comment_id_properties_by_property_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-oauth","actionName":"put_comments_by_comment_id_properties_by_property_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-oauth","actionName":"delete_comments_by_comment_id_properties_by_property_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_tasks","parameters":{"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"include-blank-tasks":{"type":"boolean","description":"Specifies whether to include blank tasks in the response. Defaults to `true`."},"status":{"type":"string","description":"Filters on the status of the task."},"task-id":{"type":"array","description":"Filters on task ID. Multiple IDs can be specified."},"space-id":{"type":"array","description":"Filters on the space ID of the task. Multiple IDs can be specified."},"page-id":{"type":"array","description":"Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction."},"blogpost-id":{"type":"array","description":"Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction."},"created-by":{"type":"array","description":"Filters on the Account ID of the user who created this task. Multiple IDs can be specified."},"assigned-to":{"type":"array","description":"Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified."},"completed-by":{"type":"array","description":"Filters on the Account ID of the user who completed this task. Multiple IDs can be specified."},"created-at-from":{"type":"integer","description":"Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds."},"created-at-to":{"type":"integer","description":"Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds."},"due-at-from":{"type":"integer","description":"Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds."},"due-at-to":{"type":"integer","description":"Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds."},"completed-at-from":{"type":"integer","description":"Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds."},"completed-at-to":{"type":"integer","description":"Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of tasks per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_tasks_by_id","parameters":{"id":{"type":"integer","description":"The ID of the task to be returned. If you don't know the task ID, use Get tasks and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."}}},{"connectionName":"confluence-oauth","actionName":"put_tasks_by_id","parameters":{"id":{"type":"integer","description":"The ID of the task to be updated. If you don't know the task ID, use Get tasks and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"data":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"ID of the task."},"localId":{"type":"string","description":"Local ID of the task. This ID is local to the corresponding page or blog post."},"spaceId":{"type":"string","description":"ID of the space the task is in."},"pageId":{"type":"string","description":"ID of the page the task is in."},"blogPostId":{"type":"string","description":"ID of the blog post the task is in."},"status":{"enum":["complete","incomplete"],"type":"string","description":"Status of the task."},"createdBy":{"type":"string","description":"Account ID of the user who created this task."},"assignedTo":{"type":"string","description":"Account ID of the user to whom this task is assigned."},"completedBy":{"type":"string","description":"Account ID of the user who completed this task."},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the task was created. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."},"updatedAt":{"type":"string","format":"date-time","description":"Date and time when the task was updated. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."},"dueAt":{"type":"string","format":"date-time","description":"Date and time when the task is due. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."},"completedAt":{"type":"string","format":"date-time","description":"Date and time when the task was completed. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."}}}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_children","parameters":{"id":{"type":"integer","description":"The ID of the parent page. If you don't know the page ID, use Get pages and filter the results."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_custom_content_by_id_children","parameters":{"id":{"type":"integer","description":"The ID of the parent custom content. If you don't know the custom content ID, use Get custom-content and filter the results."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent page."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the page."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, call this endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the page."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-oauth","actionName":"post_users_bulk","parameters":{"data":{"type":"object","required":["accountIds"],"properties":{"accountIds":{"nullable":false,"description":"List of accountIds to retrieve user info for.","type":"array","minItems":1,"maxItems":250,"items":{"type":"string"}}}}}},{"connectionName":"confluence-oauth","actionName":"post_user_access_check_access_by_email","parameters":{"data":{"type":"object","required":["emails"],"properties":{"emails":{"nullable":false,"description":"List of emails to check access to site.","type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}}}},{"connectionName":"confluence-oauth","actionName":"post_user_access_invite_by_email","parameters":{"data":{"type":"object","required":["emails"],"properties":{"emails":{"nullable":false,"description":"List of emails to check access to site.","type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}}}},{"connectionName":"confluence-oauth","actionName":"get_data_policies_metadata","parameters":{}},{"connectionName":"confluence-oauth","actionName":"get_data_policies_spaces","parameters":{"ids":{"type":"array","description":"Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list."},"keys":{"type":"array","description":"Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of spaces per result to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-oauth","actionName":"get_classification_levels","parameters":{}},{"connectionName":"confluence-oauth","actionName":"get_spaces_by_id_classification_level_default","parameters":{"id":{"type":"integer","description":"The ID of the space for which default classification level should be returned."}}},{"connectionName":"confluence-oauth","actionName":"put_spaces_by_id_classification_level_default","parameters":{"id":{"type":"integer","description":"The ID of the space for which default classification level should be updated."},"data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the classification level."}}}}},{"connectionName":"confluence-oauth","actionName":"delete_spaces_by_id_classification_level_default","parameters":{"id":{"type":"integer","description":"The ID of the space for which default classification level should be deleted."}}},{"connectionName":"confluence-oauth","actionName":"get_pages_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the page for which classification level should be returned."},"status":{"type":"string","description":"Status of page from which classification level will fetched."}}},{"connectionName":"confluence-oauth","actionName":"put_pages_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the page for which classification level should be updated."},"data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The ID of the classification level."},"status":{"enum":["current","draft"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-oauth","actionName":"post_pages_by_id_classification_level_reset","parameters":{"id":{"type":"integer","description":"The ID of the page for which classification level should be updated."},"data":{"type":"object","required":["status"],"properties":{"status":{"enum":["current","draft"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-oauth","actionName":"get_blogposts_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which classification level should be returned."},"status":{"type":"string","description":"Status of blog post from which classification level will fetched."}}},{"connectionName":"confluence-oauth","actionName":"put_blogposts_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which classification level should be updated."},"data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The ID of the classification level."},"status":{"enum":["current","draft"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-oauth","actionName":"post_blogposts_by_id_classification_level_reset","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which classification level should be updated."},"data":{"type":"object","required":["status"],"properties":{"status":{"enum":["current","draft"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-oauth","actionName":"get_whiteboards_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which classification level should be returned."}}},{"connectionName":"confluence-oauth","actionName":"put_whiteboards_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which classification level should be updated."},"data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The ID of the classification level."},"status":{"enum":["current"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-oauth","actionName":"post_whiteboards_by_id_classification_level_reset","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which classification level should be updated."},"data":{"type":"object","required":["status"],"properties":{"status":{"enum":["current"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-oauth","actionName":"get_databases_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the database for which classification level should be returned."}}},{"connectionName":"confluence-oauth","actionName":"put_databases_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the database for which classification level should be updated."},"data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The ID of the classification level."},"status":{"enum":["current"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-oauth","actionName":"post_databases_by_id_classification_level_reset","parameters":{"id":{"type":"integer","description":"The ID of the database for which classification level should be updated."},"data":{"type":"object","required":["status"],"properties":{"status":{"enum":["current"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-oauth","actionName":"get_app_properties_by_property_key","parameters":{"propertyKey":{"type":"string","description":"The key of the property"}}},{"connectionName":"confluence-oauth","actionName":"put_app_properties_by_property_key","parameters":{"propertyKey":{"type":"string","description":"The key of the property"},"data":{"type":"object","example":{"name":"Forge app","darkMode":true,"version":"1.0.0","buildNumber":7}}}},{"connectionName":"confluence-oauth","actionName":"delete_app_properties_by_property_key","parameters":{"propertyKey":{"type":"string","description":"The key of the property"}}}],"slug":"confluence-oauth","created_at":"2025-09-25T18:49:39.439Z"},{"id":"confluence-token","name":"Confluence (API Token)","description":"Create and manage content in Confluence using API token authentication.","logo_url":"https://assets.abstra.cloud/connectors/logos/confluence.svg","category":[],"triggers":[],"actions":[{"connectionName":"confluence-token","actionName":"get_admin_key","parameters":{}},{"connectionName":"confluence-token","actionName":"post_admin_key","parameters":{"data":{"type":"object","properties":{"durationInMinutes":{"type":"integer","format":"int32","description":"The requested duration of admin key access in minutes, up to a maximum of 60 minutes, after which the issued admin key will automatically expire.","example":60}}}}},{"connectionName":"confluence-token","actionName":"delete_admin_key","parameters":{}},{"connectionName":"confluence-token","actionName":"get_attachments","parameters":{"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"status":{"type":"array","description":"Filter the results to attachments based on their status. By default, `current` and `archived` are used."},"mediaType":{"type":"string","description":"Filters on the mediaType of attachments. Only one may be specified."},"filename":{"type":"string","description":"Filters on the file-name of attachments. Only one may be specified."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_attachments_by_id","parameters":{"id":{"type":"string","description":"The ID of the attachment to be returned. If you don't know the attachment's ID, use Get attachments for page/blogpost/custom content."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-labels":{"type":"boolean","description":"Includes labels associated with this attachment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this attachment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this attachment in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this attachment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this attachment in the response.\nBy default this is included and can be omitted by setting the value to `false`."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the attachment."}}},{"connectionName":"confluence-token","actionName":"delete_attachments_by_id","parameters":{"id":{"type":"integer","description":"The ID of the attachment to be deleted."},"purge":{"type":"boolean","description":"If attempting to purge the attachment."}}},{"connectionName":"confluence-token","actionName":"get_attachments_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the attachment for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_attachments_by_id_operations","parameters":{"id":{"type":"string","description":"The ID of the attachment for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_attachments_by_attachment_id_properties","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_attachments_by_attachment_id_properties","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-token","actionName":"get_attachments_by_attachment_id_properties_by_property_id","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property to be returned"}}},{"connectionName":"confluence-token","actionName":"put_attachments_by_attachment_id_properties_by_property_id","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_attachments_by_attachment_id_properties_by_property_id","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_attachments_by_id_versions","parameters":{"id":{"type":"string","description":"The ID of the attachment to be queried for its versions. If you don't know the attachment ID, use Get attachments and filter the results."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_attachments_by_attachment_id_versions_by_version_number","parameters":{"attachment-id":{"type":"string","description":"The ID of the attachment for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the attachment to be returned."}}},{"connectionName":"confluence-token","actionName":"get_attachments_by_id_footer_comments","parameters":{"id":{"type":"string","description":"The ID of the attachment for which comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"version":{"type":"integer","description":"Version number of the attachment to retrieve comments for. If no version provided, retrieves comments for the latest version."}}},{"connectionName":"confluence-token","actionName":"get_blogposts","parameters":{"id":{"type":"array","description":"Filter the results based on blog post ids. Multiple blog post ids can be specified as a comma-separated list."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"status":{"type":"array","description":"Filter the results to blog posts based on their status. By default, `current` is used."},"title":{"type":"string","description":"Filter the results to blog posts based on their title."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of blog posts per result to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_blogposts","parameters":{"private":{"type":"boolean","description":"The blog post will be private. Only the user who creates this blog post will have permission to view and edit one."},"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space"},"status":{"enum":["current","draft"],"type":"string","description":"The status of the blog post, specifies if the blog post will be created as a new blog post or a draft"},"title":{"type":"string","description":"Title of the blog post, required if creating non-draft."},"body":{"oneOf":[{"$ref":"#/components/schemas/BlogPostBodyWrite"},{"$ref":"#/components/schemas/BlogPostNestedBodyWrite"}]},"createdAt":{"type":"string","description":"Created date of the blog post in the format of \"yyyy-MM-ddTHH:mm:ss.SSSZ\"."}}}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id","parameters":{"id":{"type":"integer","description":"The ID of the blog post to be returned. If you don't know the blog post ID, use Get blog posts and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"get-draft":{"type":"boolean","description":"Retrieve the draft version of this blog post."},"status":{"type":"array","description":"Filter the blog post being retrieved by its status."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-labels":{"type":"boolean","description":"Includes labels associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this blog post in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-likes":{"type":"boolean","description":"Includes likes associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this blog post in the response.\nBy default this is included and can be omitted by setting the value to `false`."},"include-favorited-by-current-user-status":{"type":"boolean","description":"Includes whether this blog post has been favorited by the current user."},"include-webresources":{"type":"boolean","description":"Includes web resources that can be used to render blog post content on a client."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the blog post."}}},{"connectionName":"confluence-token","actionName":"put_blogposts_by_id","parameters":{"id":{"type":"integer","description":"The ID of the blog post to be updated. If you don't know the blog post ID, use Get Blog Posts and filter the results."},"data":{"type":"object","required":["id","status","title","body","version"],"properties":{"id":{"type":"string","description":"Id of the blog post."},"status":{"enum":["current","draft"],"type":"string","description":"The updated status of the blog post.\n\nNote, if you change the status of a blog post from 'current' to 'draft' and it has an existing draft, the existing draft will be deleted in favor of the updated draft.\nAdditionally, this endpoint can be used to restore a 'trashed' or 'deleted' blog post to 'current' status. For restoration, blog post contents will not be updated and only the blog post status will be changed."},"title":{"type":"string","description":"Title of the blog post."},"spaceId":{"type":"string","description":"ID of the containing space.\n\nThis currently **does not support moving the blog post to a different space**."},"body":{"oneOf":[{"$ref":"#/components/schemas/BlogPostBodyWrite"},{"$ref":"#/components/schemas/BlogPostNestedBodyWrite"}]},"version":{"type":"object","properties":{"number":{"format":"int32","type":"integer","description":"The new version number of the updated blog post. \nSet this to the current version number plus one, unless you are updating the status to 'draft' which requires a version number of 1.\n\nIf you don't know the current version number, use Get blog post by id."},"message":{"type":"string","description":"An optional message to be stored with the version."}}},"createdAt":{"type":"string","description":"Created date of the blog post in the format of \"yyyy-MM-ddTHH:mm:ss.SSSZ\"."}}}}},{"connectionName":"confluence-token","actionName":"delete_blogposts_by_id","parameters":{"id":{"type":"integer","description":"The ID of the blog post to be deleted."},"purge":{"type":"boolean","description":"If attempting to purge the blog post."},"draft":{"type":"boolean","description":"If attempting to delete a blog post that is a draft."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_attachments","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which attachments should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"status":{"type":"array","description":"Filter the results to attachments based on their status. By default, `current` and `archived` are used."},"mediaType":{"type":"string","description":"Filters on the mediaType of attachments. Only one may be specified."},"filename":{"type":"string","description":"Filters on the file-name of attachments. Only one may be specified."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_custom_content","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which custom content should be returned."},"type":{"type":"string","description":"The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_likes_count","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which like count should be returned."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_likes_users","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which account IDs should be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of account IDs per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_blogpost_id_properties","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_blogposts_by_blogpost_id_properties","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_blogpost_id_properties_by_property_id","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the property being requested"}}},{"connectionName":"confluence-token","actionName":"put_blogposts_by_blogpost_id_properties_by_property_id","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_blogposts_by_blogpost_id_properties_by_property_id","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_versions","parameters":{"id":{"type":"integer","description":"The ID of the blog post to be queried for its versions. If you don't know the blog post ID, use Get blog posts and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_blogpost_id_versions_by_version_number","parameters":{"blogpost-id":{"type":"integer","description":"The ID of the blog post for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the blog post to be returned."}}},{"connectionName":"confluence-token","actionName":"post_content_convert_ids_to_types","parameters":{"data":{"type":"object","required":["contentIds"],"properties":{"contentIds":{"description":"The content ids to convert. They may be provided as strings or numbers.","type":"array","maxItems":100,"items":{"anyOf":[{"type":"string"},{"type":"number"}]}}}}}},{"connectionName":"confluence-token","actionName":"get_custom_content","parameters":{"type":{"type":"string","description":"The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content."},"id":{"type":"array","description":"Filter the results based on custom content ids. Multiple custom content ids can be specified as a comma-separated list."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."}}},{"connectionName":"confluence-token","actionName":"post_custom_content","parameters":{"data":{"type":"object","required":["body","title","type"],"properties":{"type":{"type":"string","description":"Type of custom content."},"status":{"enum":["current","draft"],"type":"string","description":"The status of the custom content. Defaults to `current` when status not provided."},"spaceId":{"type":"string","description":"ID of the containing space."},"pageId":{"type":"string","description":"ID of the containing page."},"blogPostId":{"type":"string","description":"ID of the containing Blog Post."},"customContentId":{"type":"string","description":"ID of the containing custom content."},"title":{"type":"string","description":"Title of the custom content."},"body":{"oneOf":[{"$ref":"#/components/schemas/CustomContentBodyWrite"},{"$ref":"#/components/schemas/CustomContentNestedBodyWrite"}]}}}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_id","parameters":{"id":{"type":"integer","description":"The ID of the custom content to be returned. If you don't know the custom content ID, use Get Custom Content by Type and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-labels":{"type":"boolean","description":"Includes labels associated with this custom content in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this custom content in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this custom content in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this custom content in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this custom content in the response.\nBy default this is included and can be omitted by setting the value to `false`."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the custom content."}}},{"connectionName":"confluence-token","actionName":"put_custom_content_by_id","parameters":{"id":{"type":"integer","description":"The ID of the custom content to be updated. If you don't know the custom content ID, use Get Custom Content by Type and filter the results."},"data":{"type":"object","required":["body","id","status","title","type","version"],"properties":{"id":{"type":"string","description":"Id of custom content."},"type":{"type":"string","description":"Type of custom content."},"status":{"enum":["current"],"type":"string","description":"The status of the custom content."},"spaceId":{"type":"string","description":"ID of the containing space (must be the same as the spaceId of the space the custom content was created in)."},"pageId":{"type":"string","description":"ID of the containing page."},"blogPostId":{"type":"string","description":"ID of the containing Blog Post."},"customContentId":{"type":"string","description":"ID of the containing custom content."},"title":{"type":"string","description":"Title of the custom content."},"body":{"oneOf":[{"$ref":"#/components/schemas/CustomContentBodyWrite"},{"$ref":"#/components/schemas/CustomContentNestedBodyWrite"}]},"version":{"type":"object","properties":{"number":{"format":"int32","type":"integer","description":"The version number, must be incremented by one."},"message":{"type":"string","description":"An optional message to be stored with the version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_custom_content_by_id","parameters":{"id":{"type":"integer","description":"The ID of the custom content to be deleted."},"purge":{"type":"boolean","description":"If attempting to purge the custom content."}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_id_attachments","parameters":{"id":{"type":"integer","description":"The ID of the custom content for which attachments should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"status":{"type":"array","description":"Filter the results to attachments based on their status. By default, `current` and `archived` are used."},"mediaType":{"type":"string","description":"Filters on the mediaType of attachments. Only one may be specified."},"filename":{"type":"string","description":"Filters on the file-name of attachments. Only one may be specified."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_id_footer_comments","parameters":{"id":{"type":"integer","description":"The ID of the custom content for which comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the custom content for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the custom content for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_custom_content_id_properties","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_custom_content_by_custom_content_id_properties","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_custom_content_id_properties_by_property_id","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-token","actionName":"put_custom_content_by_custom_content_id_properties_by_property_id","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_custom_content_by_custom_content_id_properties_by_property_id","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_labels","parameters":{"label-id":{"type":"array","description":"Filters on label ID. Multiple IDs can be specified as a comma-separated list."},"prefix":{"type":"array","description":"Filters on label prefix. Multiple IDs can be specified as a comma-separated list."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_labels_by_id_attachments","parameters":{"id":{"type":"integer","description":"The ID of the label for which attachments should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_labels_by_id_blogposts","parameters":{"id":{"type":"integer","description":"The ID of the label for which blog posts should be returned."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of blog posts per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_labels_by_id_pages","parameters":{"id":{"type":"integer","description":"The ID of the label for which pages should be returned."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_pages","parameters":{"id":{"type":"array","description":"Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list."},"space-id":{"type":"array","description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"status":{"type":"array","description":"Filter the results to pages based on their status. By default, `current` and `archived` are used."},"title":{"type":"string","description":"Filter the results to pages based on their title."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"subtype":{"type":"string","description":"Filter the results to pages based on their subtype."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_pages","parameters":{"embedded":{"type":"boolean","description":"Tag the content as embedded and content will be created in NCS."},"private":{"type":"boolean","description":"The page will be private. Only the user who creates this page will have permission to view and edit one."},"root-level":{"type":"boolean","description":"The page will be created at the root level of the space (outside the space homepage tree). If true, then a \nvalue may not be supplied for the `parentId` body parameter."},"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"status":{"enum":["current","draft"],"type":"string","description":"The status of the page, published or draft."},"title":{"type":"string","description":"Title of the page, required if page status is not draft."},"parentId":{"type":"string","description":"The parent content ID of the page. If the `root-level` query parameter is set to false and a value is \nnot supplied for this parameter, then the space homepage's ID will be used. If the `root-level` query \nparameter is set to true, then a value may not be supplied for this parameter."},"body":{"oneOf":[{"$ref":"#/components/schemas/PageBodyWrite"},{"$ref":"#/components/schemas/PageNestedBodyWrite"}]},"subtype":{"enum":["live"],"type":"string","description":"The subtype of the page. Provide the subtype live to create a live doc or no subtype to create a page."}}}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id","parameters":{"id":{"type":"integer","description":"The ID of the page to be returned. If you don't know the page ID, use Get pages and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"get-draft":{"type":"boolean","description":"Retrieve the draft version of this page."},"status":{"type":"array","description":"Filter the page being retrieved by its status."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-labels":{"type":"boolean","description":"Includes labels associated with this page in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this page in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this page in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-likes":{"type":"boolean","description":"Includes likes associated with this page in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this page in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this page in the response.\nBy default this is included and can be omitted by setting the value to `false`."},"include-favorited-by-current-user-status":{"type":"boolean","description":"Includes whether this page has been favorited by the current user."},"include-webresources":{"type":"boolean","description":"Includes web resources that can be used to render page content on a client."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the page."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the page, as defined in the `ChildrenResponse` object."}}},{"connectionName":"confluence-token","actionName":"put_pages_by_id","parameters":{"id":{"type":"integer","description":"The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results."},"data":{"type":"object","required":["id","status","title","body","version"],"properties":{"id":{"type":"string","description":"Id of the page."},"status":{"enum":["current","draft"],"type":"string","description":"The updated status of the page.\n\nNote, if you change the status of a page from 'current' to 'draft' and it has an existing draft, the existing draft will be deleted in favor of the updated draft.\nAdditionally, this endpoint can be used to restore a 'trashed' or 'deleted' page to 'current' status. For restoration, page contents will not be updated and only the page status will be changed."},"title":{"type":"string","description":"Title of the page."},"spaceId":{"format":"string","description":"ID of the containing space.\n\nThis currently **does not support moving the page to a different space**."},"parentId":{"format":"string","description":"ID of the parent content.\n\nThis allows the page to be moved under a different parent within the same space."},"ownerId":{"format":"string","description":"Account ID of the page owner.\n\nThis allows page ownership to be transferred to another user."},"body":{"oneOf":[{"$ref":"#/components/schemas/PageBodyWrite"},{"$ref":"#/components/schemas/PageNestedBodyWrite"}]},"version":{"type":"object","properties":{"number":{"format":"int32","type":"integer","description":"The new version of the updated page. \nSet this to the current version number plus one, unless you are updating the status to 'draft' which requires a version number of 1.\n\nIf you don't know the current version number, use Get page by id."},"message":{"type":"string","description":"An optional message to be stored with the version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_pages_by_id","parameters":{"id":{"type":"integer","description":"The ID of the page to be deleted."},"purge":{"type":"boolean","description":"If attempting to purge the page."},"draft":{"type":"boolean","description":"If attempting to delete a page that is a draft."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_attachments","parameters":{"id":{"type":"integer","description":"The ID of the page for which attachments should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"status":{"type":"array","description":"Filter the results to attachments based on their status. By default, `current` and `archived` are used."},"mediaType":{"type":"string","description":"Filters on the mediaType of attachments. Only one may be specified."},"filename":{"type":"string","description":"Filters on the file-name of attachments. Only one may be specified."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_custom_content","parameters":{"id":{"type":"integer","description":"The ID of the page for which custom content should be returned."},"type":{"type":"string","description":"The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the page for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_likes_count","parameters":{"id":{"type":"integer","description":"The ID of the page for which like count should be returned."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_likes_users","parameters":{"id":{"type":"integer","description":"The ID of the page for which like count should be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of account IDs per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the page for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_page_id_properties","parameters":{"page-id":{"type":"integer","description":"The ID of the page for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_pages_by_page_id_properties","parameters":{"page-id":{"type":"integer","description":"The ID of the page to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-token","actionName":"get_pages_by_page_id_properties_by_property_id","parameters":{"page-id":{"type":"integer","description":"The ID of the page for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-token","actionName":"put_pages_by_page_id_properties_by_property_id","parameters":{"page-id":{"type":"integer","description":"The ID of the page the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_pages_by_page_id_properties_by_property_id","parameters":{"page-id":{"type":"integer","description":"The ID of the page the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"post_pages_by_id_redact","parameters":{"id":{"type":"integer","description":"The ID of the page to redact content from."},"data":{"type":"object","required":["createdAt","cleanHistory"],"properties":{"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the content was last updated."},"cleanHistory":{"type":"boolean","description":"Whether to clean up previous versions containing the redaction. When true, historical versions of the content that contain the redacted text will be squashed."},"body":{"type":"object","properties":{"redactions":{"type":"array","items":{"$ref":"#/components/schemas/Redaction"}}}},"title":{"type":"object","properties":{"redactions":{"type":"array","items":{"$ref":"#/components/schemas/Redaction"}}}}}}}},{"connectionName":"confluence-token","actionName":"post_blogposts_by_id_redact","parameters":{"id":{"type":"integer","description":"The ID of the blog post to redact content from."},"data":{"type":"object","required":["createdAt","cleanHistory"],"properties":{"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the content was last updated."},"cleanHistory":{"type":"boolean","description":"Whether to clean up previous versions containing the redaction. When true, historical versions of the content that contain the redacted text will be squashed."},"body":{"type":"object","properties":{"redactions":{"type":"array","items":{"$ref":"#/components/schemas/Redaction"}}}},"title":{"type":"object","properties":{"redactions":{"type":"array","items":{"$ref":"#/components/schemas/Redaction"}}}}}}}},{"connectionName":"confluence-token","actionName":"put_pages_by_id_title","parameters":{"id":{"type":"integer","description":"The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results"},"data":{"type":"object","required":["status","title"],"properties":{"status":{"enum":["current","draft"],"type":"string","description":"The status of the page, current or draft."},"title":{"type":"string","description":"The updated title for the page"}}}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_versions","parameters":{"id":{"type":"integer","description":"The ID of the page to be queried for its versions. If you don't know the page ID, use Get pages and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"post_whiteboards","parameters":{"private":{"type":"boolean","description":"The whiteboard will be private. Only the user who creates this whiteboard will have permission to view and edit one."},"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"title":{"type":"string","description":"Title of the whiteboard."},"parentId":{"type":"string","description":"The parent content ID of the whiteboard."},"templateKey":{"type":"string","description":"Providing a template key will add that template to the new whiteboard.","enum":["2x2-prioritization","4ls-retro","annual-calendar","brainwriting","concept-map","crazy-8s","daily-sync","disruptive-brainstorm","dot-voting","elevator-pitch","flow-chart","gap-analysis","ice-breakers","incident-postmortem","journey-mapping-kit","kanban-board","lean-coffee","network-of-teams","org-chart","pi-planning","prioritization","prioritization-experiment","product-roadmap","product-vision-board","rice","sailboat-retro","service-blueprint","simple-retrospective","sprint-planning","sticky-note-pack","swimlanes","team-formation-guide","timeline","timeline-workflow","user-story-map","workflow","vision-board","venn-diagram","storyboard","action-plan","root-cause-analysis","executive-summary","stakeholder-mapping","annual-calendar-2025-2026","health-monitor","okr-planning","swot-analysis","poker-planning","fishbone-diagram","risk-assessment","bounded-context","hopes-and-fears","swimlane-vertical"]},"locale":{"type":"string","description":"If templateKey is provided, locale will decide which language the template will be created with. If locale is omitted, the user's locale will be used.","enum":["de-DE","cs-CZ","ko-KR","fr-FR","it-IT","ja-JP","nl-NL","nb-NO","da-DK","sv-SE","fi-FI","ru-RU","pl-PL","tr-TR","hu-HU","en-GB","en-US","pt-BR","zh-CN","zh-TW","es-ES"]}}}}},{"connectionName":"confluence-token","actionName":"get_whiteboards_by_id","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard to be returned"},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the whiteboard."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the whiteboard, as defined in the `ChildrenResponse` object."},"include-operations":{"type":"boolean","description":"Includes operations associated with this whiteboard in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this whiteboard in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-token","actionName":"delete_whiteboards_by_id","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_whiteboards_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_whiteboards_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-token","actionName":"get_whiteboards_by_whiteboard_id_properties_by_property_id","parameters":{"whiteboard-id":{"type":"integer","description":"The ID of the whiteboard for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-token","actionName":"put_whiteboards_by_whiteboard_id_properties_by_property_id","parameters":{"whiteboard-id":{"type":"integer","description":"The ID of the whiteboard the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_whiteboards_by_whiteboard_id_properties_by_property_id","parameters":{"whiteboard-id":{"type":"integer","description":"The ID of the whiteboard the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_whiteboards_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_whiteboards_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent whiteboard."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_whiteboards_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-token","actionName":"get_whiteboards_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_databases","parameters":{"private":{"type":"boolean","description":"The database will be private. Only the user who creates this database will have permission to view and edit one."},"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"title":{"type":"string","description":"Title of the database."},"parentId":{"type":"string","description":"The parent content ID of the database."}}}}},{"connectionName":"confluence-token","actionName":"get_databases_by_id","parameters":{"id":{"type":"integer","description":"The ID of the database to be returned"},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the database."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the database, as defined in the `ChildrenResponse` object."},"include-operations":{"type":"boolean","description":"Includes operations associated with this database in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this database in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-token","actionName":"delete_databases_by_id","parameters":{"id":{"type":"integer","description":"The ID of the database to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_databases_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the database for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_databases_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the database to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-token","actionName":"get_databases_by_database_id_properties_by_property_id","parameters":{"database-id":{"type":"integer","description":"The ID of the database for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-token","actionName":"put_databases_by_database_id_properties_by_property_id","parameters":{"database-id":{"type":"integer","description":"The ID of the database the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_databases_by_database_id_properties_by_property_id","parameters":{"database-id":{"type":"integer","description":"The ID of the database the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_databases_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the database for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_databases_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent database."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_databases_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the database."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-token","actionName":"get_databases_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the database."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_embeds","parameters":{"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"title":{"type":"string","description":"Title of the Smart Link in the content tree."},"parentId":{"type":"string","description":"The parent content ID of the Smart Link in the content tree."},"embedUrl":{"type":"string","description":"The URL that the Smart Link in the content tree should be populated with."}}}}},{"connectionName":"confluence-token","actionName":"get_embeds_by_id","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree to be returned."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the Smart Link."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the Smart Link, as defined in the `ChildrenResponse` object."},"include-operations":{"type":"boolean","description":"Includes operations associated with this Smart Link in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this Smart Link in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-token","actionName":"delete_embeds_by_id","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_embeds_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of Smart Links per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_embeds_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-token","actionName":"get_embeds_by_embed_id_properties_by_property_id","parameters":{"embed-id":{"type":"integer","description":"The ID of the Smart Link in the content tree for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-token","actionName":"put_embeds_by_embed_id_properties_by_property_id","parameters":{"embed-id":{"type":"integer","description":"The ID of the Smart Link in the content tree the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_embeds_by_embed_id_properties_by_property_id","parameters":{"embed-id":{"type":"integer","description":"The ID of the Smart Link in the content tree the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_embeds_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_embeds_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent smart link."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_embeds_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the smart link."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-token","actionName":"get_embeds_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the Smart Link in the content tree."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_folders","parameters":{"data":{"type":"object","required":["spaceId"],"properties":{"spaceId":{"type":"string","description":"ID of the space."},"title":{"type":"string","description":"Title of the folder."},"parentId":{"type":"string","description":"The parent content ID of the folder."}}}}},{"connectionName":"confluence-token","actionName":"get_folders_by_id","parameters":{"id":{"type":"integer","description":"The ID of the folder to be returned."},"include-collaborators":{"type":"boolean","description":"Includes collaborators on the folder."},"include-direct-children":{"type":"boolean","description":"Includes direct children of the folder, as defined in the `ChildrenResponse` object."},"include-operations":{"type":"boolean","description":"Includes operations associated with this folder in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this folder in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-token","actionName":"delete_folders_by_id","parameters":{"id":{"type":"integer","description":"The ID of the folder to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_folders_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the folder for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_folders_by_id_properties","parameters":{"id":{"type":"integer","description":"The ID of the folder to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-token","actionName":"get_folders_by_folder_id_properties_by_property_id","parameters":{"folder-id":{"type":"integer","description":"The ID of the folder for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-token","actionName":"put_folders_by_folder_id_properties_by_property_id","parameters":{"folder-id":{"type":"integer","description":"The ID of the folder the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_folders_by_folder_id_properties_by_property_id","parameters":{"folder-id":{"type":"integer","description":"The ID of the folder the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_folders_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the folder for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_folders_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent folder."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_folders_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the folder."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-token","actionName":"get_folders_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the folder."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_page_id_versions_by_version_number","parameters":{"page-id":{"type":"integer","description":"The ID of the page for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the page to be returned."}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_custom_content_id_versions","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content to be queried for its versions. If you don't know the custom content ID, use Get custom-content by type and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_custom_content_id_versions_by_version_number","parameters":{"custom-content-id":{"type":"integer","description":"The ID of the custom content for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the custom content to be returned."}}},{"connectionName":"confluence-token","actionName":"get_spaces","parameters":{"ids":{"type":"array","description":"Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list."},"keys":{"type":"array","description":"Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list."},"type":{"type":"string","description":"Filter the results to spaces based on their type."},"status":{"type":"string","description":"Filter the results to spaces based on their status."},"labels":{"type":"array","description":"Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list."},"favorited-by":{"type":"string","description":"Filter the results to spaces favorited by the user with the specified account ID."},"not-favorited-by":{"type":"string","description":"Filter the results to spaces NOT favorited by the user with the specified account ID."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"description-format":{"type":"string","description":"The content format type to be returned in the `description` field of the response. If available, the representation will be available under a response field of the same name under the `description` field."},"include-icon":{"type":"boolean","description":"If the icon for the space should be fetched or not."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of spaces per result to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_spaces","parameters":{"data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the space to be created."},"key":{"type":"string","description":"The key for the new space. See [Space Keys](https://support.atlassian.com/confluence-cloud/docs/create-a-space/). If the key property is not provided, the alias property is required to be used instead."},"alias":{"type":"string","description":"This field will be used as the new identifier for the space in confluence page URLs. If the alias property is not provided, the key property is required to be used instead. Maximum 255 alphanumeric characters in length."},"description":{"type":"object","description":"The description of the new/updated space. Note, only the 'plain' representation is currently supported.","properties":{"value":{"type":"string","description":"The space description."},"representation":{"type":"string","description":"The format of the description."}}},"roleAssignments":{"type":"array","items":{"description":"The role assignments for the new space. If none are provided, the Default Space Roles are applied. If roles are provided, the space is created with exactly the provided set of roles. A private space is created if only the creator is assigned to a role and it’s the Admin role. At least one Admin role assignment must be specified.","properties":{"principal":{"$ref":"#/components/schemas/Principal"},"roleId":{"type":"string","description":"The role to which the principal is assigned."}}}},"copySpaceAccessConfiguration":{"type":"integer","description":"The id of the space to copy the space access configuration from."},"createPrivateSpace":{"type":"boolean","description":"Whether to create the space as private."}}}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id","parameters":{"id":{"type":"integer","description":"The ID of the space to be returned."},"description-format":{"type":"string","description":"The content format type to be returned in the `description` field of the response. If available, the representation will be available under a response field of the same name under the `description` field."},"include-icon":{"type":"boolean","description":"If the icon for the space should be fetched or not."},"include-operations":{"type":"boolean","description":"Includes operations associated with this space in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-properties":{"type":"boolean","description":"Includes space properties associated with this space in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-permissions":{"type":"boolean","description":"Includes space permissions associated with this space in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-role-assignments":{"type":"boolean","description":"Includes role assignments associated with this space in the response. This parameter is only accepted for EAP sites.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-labels":{"type":"boolean","description":"Includes labels associated with this space in the response.\nThe number of results will be limited to 50 and sorted in the default sort order.\nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id_blogposts","parameters":{"id":{"type":"integer","description":"The ID of the space for which blog posts should be returned."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"status":{"type":"array","description":"Filter the results to blog posts based on their status. By default, `current` is used."},"title":{"type":"string","description":"Filter the results to blog posts based on their title."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of blog posts per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id_labels","parameters":{"id":{"type":"integer","description":"The ID of the space for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id_content_labels","parameters":{"id":{"type":"integer","description":"The ID of the space for which labels should be returned."},"prefix":{"type":"string","description":"Filter the results to labels based on their prefix."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id_custom_content","parameters":{"id":{"type":"integer","description":"The ID of the space for which custom content should be returned."},"type":{"type":"string","description":"The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.\n\nNote: If the custom content body type is `storage`, the `storage` and `atlas_doc_format` body formats are able to be returned. If the custom content body type is `raw`, only the `raw` body format is able to be returned."}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the space for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id_pages","parameters":{"id":{"type":"integer","description":"The ID of the space for which pages should be returned."},"depth":{"type":"string","description":"Filter the results to pages at the root level of the space or to all pages in the space."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"status":{"type":"array","description":"Filter the results to pages based on their status. By default, `current` and `archived` are used."},"title":{"type":"string","description":"Filter the results to pages based on their title."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_space_id_properties","parameters":{"space-id":{"type":"integer","description":"The ID of the space for which space properties should be returned."},"key":{"type":"string","description":"The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_spaces_by_space_id_properties","parameters":{"space-id":{"type":"integer","description":"The ID of the space for which space properties should be returned."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the space property"},"value":{"description":"Value of the space property."}}}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_space_id_properties_by_property_id","parameters":{"space-id":{"type":"integer","description":"The ID of the space the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be retrieved."}}},{"connectionName":"confluence-token","actionName":"put_spaces_by_space_id_properties_by_property_id","parameters":{"space-id":{"type":"integer","description":"The ID of the space the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the space property"},"value":{"description":"Value of the space property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_spaces_by_space_id_properties_by_property_id","parameters":{"space-id":{"type":"integer","description":"The ID of the space the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id_permissions","parameters":{"id":{"type":"integer","description":"The ID of the space to be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of assignments to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_space_permissions","parameters":{"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of space permissions to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_space_roles","parameters":{"space-id":{"type":"string","description":"The space ID for which to filter available space roles; if empty, return all available space roles for the tenant."},"role-type":{"type":"string","description":"The space role type to filter results by."},"principal-id":{"type":"string","description":"The principal ID to filter results by. If specified, a principal-type must also be specified. Paired with a `principal-type` of `ACCESS_CLASS`, valid values include [`anonymous-users`, `jsm-project-admins`, `authenticated-users`, `all-licensed-users`, `all-product-admins`]"},"principal-type":{"type":"string","description":"The principal type to filter results by. If specified, a principal-id must also be specified."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of space roles to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_space_roles","parameters":{"data":{"type":"object","required":{"0":"name","1":"description","2":"spacePermissions"},"properties":{"name":{"type":"string","description":"Name of the space role"},"description":{"type":"string","description":"Description for the space role"},"spacePermissions":{"type":"array","items":{"type":"string"},"description":"The ids of the space permissions associated with the space role"}}}}},{"connectionName":"confluence-token","actionName":"get_space_roles_by_id","parameters":{"id":{"type":"integer","description":"The ID of the space role to retrieve."}}},{"connectionName":"confluence-token","actionName":"put_space_roles_by_id","parameters":{"id":{"type":"string","description":"Id of the space role"},"data":{"type":"object","required":{"0":"name","1":"description","2":"spacePermissions"},"properties":{"name":{"type":"string","description":"Name of the space role"},"description":{"type":"string","description":"Description for the space role"},"spacePermissions":{"type":"array","items":{"type":"string"},"description":"The ids of the space permissions associated with the space role"},"anonymousReassignmentRoleId":{"type":"string","description":"If space anonymous access is assigned to the role being modified, the Id of a role to migrate those assignments to can be specified. Anonymous access role assignments left unchanged if unspecified."},"guestReassignmentRoleId":{"type":"string","description":"If guests are assigned to the role being modified, the Id of a role to migrate those assignments to can be specified. Guest role assignments left unchanged if unspecified."}}}}},{"connectionName":"confluence-token","actionName":"delete_space_roles_by_id","parameters":{"id":{"type":"string","description":"Id of the space role"}}},{"connectionName":"confluence-token","actionName":"get_space_role_mode","parameters":{}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id_role_assignments","parameters":{"id":{"type":"integer","description":"The ID of the space for which to retrieve assignments."},"role-id":{"type":"string","description":"Filters the returned role assignments to the provided role ID."},"role-type":{"type":"string","description":"Filters the returned role assignments to the provided role type."},"principal-id":{"type":"string","description":"Filters the returned role assignments to the provided principal id. If specified, a principal-type must also be specified. Paired with a `principal-type` of `ACCESS_CLASS`, valid values include [`anonymous-users`, `jsm-project-admins`, `authenticated-users`, `all-licensed-users`, `all-product-admins`]"},"principal-type":{"type":"string","description":"Filters the returned role assignments to the provided principal type. If specified, a principal-id must also be specified."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of space roles to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_spaces_by_id_role_assignments","parameters":{"id":{"type":"integer","description":"The ID of the space for which to retrieve assignments."},"data":{"type":"array","items":{"required":["principal"],"properties":{"principal":{"$ref":"#/components/schemas/Principal"},"roleId":{"type":"string","description":"The role to which the principal is assigned."}}}}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_footer_comments","parameters":{"id":{"type":"integer","description":"The ID of the page for which footer comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"status":{"type":"array","description":"Filter the footer comment being retrieved by its status."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_inline_comments","parameters":{"id":{"type":"integer","description":"The ID of the page for which inline comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"status":{"type":"array","description":"Filter the inline comment being retrieved by its status."},"resolution-status":{"type":"array","description":"Filter the inline comment being retrieved by its resolution status."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of inline comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_footer_comments","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which footer comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"status":{"type":"array","description":"Filter the footer comment being retrieved by its status."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_inline_comments","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which inline comments should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"status":{"type":"array","description":"Filter the inline comment being retrieved by its status."},"resolution-status":{"type":"array","description":"Filter the inline comment being retrieved by its resolution status."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of inline comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_footer_comments","parameters":{"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_footer_comments","parameters":{"data":{"type":"object","properties":{"blogPostId":{"type":"string","description":"ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply."},"pageId":{"type":"string","description":"ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply."},"parentCommentId":{"type":"string","description":"ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment."},"attachmentId":{"type":"string","description":"ID of the attachment, if intending to create a comment against an attachment."},"customContentId":{"type":"string","description":"ID of the custom content, if intending to create a comment against a custom content."},"body":{"oneOf":[{"$ref":"#/components/schemas/CommentBodyWrite"},{"$ref":"#/components/schemas/CommentNestedBodyWrite"}]}}}}},{"connectionName":"confluence-token","actionName":"get_footer_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this footer comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this footer comment in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-likes":{"type":"boolean","description":"Includes likes associated with this footer comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this footer comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this footer comment in the response.\nBy default this is included and can be omitted by setting the value to `false`."}}},{"connectionName":"confluence-token","actionName":"put_footer_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."},"data":{"allOf":{"0":{"type":"object","properties":{"version":{"type":"object","properties":{"number":{"type":"integer","description":"Number of new version. Should be 1 higher than current version of the comment."},"message":{"type":"string","description":"Optional message store for the new version."}}},"body":{"oneOf":[{"$ref":"#/components/schemas/CommentBodyWrite"},{"$ref":"#/components/schemas/CommentNestedBodyWrite"}]}}},"1":{"type":"object","properties":{"_links":{"type":"object","properties":{"base":{"type":"string","description":"Base url of the Confluence site."}}}}}}}}},{"connectionName":"confluence-token","actionName":"delete_footer_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."}}},{"connectionName":"confluence-token","actionName":"get_footer_comments_by_id_children","parameters":{"id":{"type":"integer","description":"The ID of the parent comment for which footer comment children should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_footer_comments_by_id_likes_count","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which like count should be returned."}}},{"connectionName":"confluence-token","actionName":"get_footer_comments_by_id_likes_users","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which like count should be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of account IDs per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_footer_comments_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_footer_comments_by_id_versions","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which versions should be returned"},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_footer_comments_by_id_versions_by_version_number","parameters":{"id":{"type":"integer","description":"The ID of the footer comment for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the footer comment to be returned."}}},{"connectionName":"confluence-token","actionName":"get_inline_comments","parameters":{"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_inline_comments","parameters":{"data":{"type":"object","properties":{"blogPostId":{"type":"string","description":"ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply."},"pageId":{"type":"string","description":"ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply."},"parentCommentId":{"type":"string","description":"ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment."},"body":{"oneOf":[{"$ref":"#/components/schemas/CommentBodyWrite"},{"$ref":"#/components/schemas/CommentNestedBodyWrite"}]},"inlineCommentProperties":{"type":"object","description":"Object describing the text to highlight on the page/blog post. Only applicable for top level inline comments (not replies) and required in that case.","properties":{"textSelection":{"type":"string","description":"The text to highlight"},"textSelectionMatchCount":{"type":"integer","description":"The number of matches for the selected text on the page (should be strictly greater than textSelectionMatchIndex)"},"textSelectionMatchIndex":{"type":"integer","description":"The match index to highlight. This is zero-based. E.g. if you have 3 occurrences of \"hello world\" on a page \nand you want to highlight the second occurrence, you should pass 1 for textSelectionMatchIndex and 3 for textSelectionMatchCount."}}}}}}},{"connectionName":"confluence-token","actionName":"get_inline_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"version":{"type":"integer","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."},"include-properties":{"type":"boolean","description":"Includes content properties associated with this inline comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-operations":{"type":"boolean","description":"Includes operations associated with this inline comment in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-likes":{"type":"boolean","description":"Includes likes associated with this inline comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-versions":{"type":"boolean","description":"Includes versions associated with this inline comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."},"include-version":{"type":"boolean","description":"Includes the current version associated with this inline comment in the response.\nBy default this is included and can be omitted by setting the value to `false`."}}},{"connectionName":"confluence-token","actionName":"put_inline_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be retrieved."},"data":{"type":"object","properties":{"version":{"type":"object","properties":{"number":{"type":"integer","description":"Number of new version. Should be 1 higher than current version of the comment."},"message":{"type":"string","description":"Optional message store for the new version."}}},"body":{"oneOf":[{"$ref":"#/components/schemas/CommentBodyWrite"},{"$ref":"#/components/schemas/CommentNestedBodyWrite"}]},"resolved":{"type":"boolean","description":"Resolved state of the comment. Set to true to resolve the comment, set to false to reopen it. If\nmatching the existing state (i.e. true -> resolved or false -> open/reopened) , no change will occur. A dangling\ncomment cannot be updated."}}}}},{"connectionName":"confluence-token","actionName":"delete_inline_comments_by_comment_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_inline_comments_by_id_children","parameters":{"id":{"type":"integer","description":"The ID of the parent comment for which inline comment children should be returned."},"body-format":{"type":"string","description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_inline_comments_by_id_likes_count","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which like count should be returned."}}},{"connectionName":"confluence-token","actionName":"get_inline_comments_by_id_likes_users","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which like count should be returned."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of account IDs per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_inline_comments_by_id_operations","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which operations should be returned."}}},{"connectionName":"confluence-token","actionName":"get_inline_comments_by_id_versions","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which versions should be returned"},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_inline_comments_by_id_versions_by_version_number","parameters":{"id":{"type":"integer","description":"The ID of the inline comment for which version details should be returned."},"version-number":{"type":"integer","description":"The version number of the inline comment to be returned."}}},{"connectionName":"confluence-token","actionName":"get_comments_by_comment_id_properties","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment for which content properties should be returned."},"key":{"type":"string","description":"Filters the response to return a specific content property with matching key (case sensitive)."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"post_comments_by_comment_id_properties","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment to create a property for."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."}}}}},{"connectionName":"confluence-token","actionName":"get_comments_by_comment_id_properties_by_property_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment for which content properties should be returned."},"property-id":{"type":"integer","description":"The ID of the content property being requested."}}},{"connectionName":"confluence-token","actionName":"put_comments_by_comment_id_properties_by_property_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be updated."},"data":{"type":"object","properties":{"key":{"type":"string","description":"Key of the content property"},"value":{"description":"Value of the content property."},"version":{"type":"object","description":"New version number and associated message","properties":{"number":{"type":"integer","format":"int32","description":"Version number of the new version. Should be 1 more than the current version number."},"message":{"type":"string","description":"Message to be associated with the new version."}}}}}}},{"connectionName":"confluence-token","actionName":"delete_comments_by_comment_id_properties_by_property_id","parameters":{"comment-id":{"type":"integer","description":"The ID of the comment the property belongs to."},"property-id":{"type":"integer","description":"The ID of the property to be deleted."}}},{"connectionName":"confluence-token","actionName":"get_tasks","parameters":{"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"include-blank-tasks":{"type":"boolean","description":"Specifies whether to include blank tasks in the response. Defaults to `true`."},"status":{"type":"string","description":"Filters on the status of the task."},"task-id":{"type":"array","description":"Filters on task ID. Multiple IDs can be specified."},"space-id":{"type":"array","description":"Filters on the space ID of the task. Multiple IDs can be specified."},"page-id":{"type":"array","description":"Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction."},"blogpost-id":{"type":"array","description":"Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction."},"created-by":{"type":"array","description":"Filters on the Account ID of the user who created this task. Multiple IDs can be specified."},"assigned-to":{"type":"array","description":"Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified."},"completed-by":{"type":"array","description":"Filters on the Account ID of the user who completed this task. Multiple IDs can be specified."},"created-at-from":{"type":"integer","description":"Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds."},"created-at-to":{"type":"integer","description":"Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds."},"due-at-from":{"type":"integer","description":"Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds."},"due-at-to":{"type":"integer","description":"Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds."},"completed-at-from":{"type":"integer","description":"Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds."},"completed-at-to":{"type":"integer","description":"Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of tasks per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_tasks_by_id","parameters":{"id":{"type":"integer","description":"The ID of the task to be returned. If you don't know the task ID, use Get tasks and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."}}},{"connectionName":"confluence-token","actionName":"put_tasks_by_id","parameters":{"id":{"type":"integer","description":"The ID of the task to be updated. If you don't know the task ID, use Get tasks and filter the results."},"body-format":{"type":"string","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field."},"data":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"ID of the task."},"localId":{"type":"string","description":"Local ID of the task. This ID is local to the corresponding page or blog post."},"spaceId":{"type":"string","description":"ID of the space the task is in."},"pageId":{"type":"string","description":"ID of the page the task is in."},"blogPostId":{"type":"string","description":"ID of the blog post the task is in."},"status":{"enum":["complete","incomplete"],"type":"string","description":"Status of the task."},"createdBy":{"type":"string","description":"Account ID of the user who created this task."},"assignedTo":{"type":"string","description":"Account ID of the user to whom this task is assigned."},"completedBy":{"type":"string","description":"Account ID of the user who completed this task."},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the task was created. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."},"updatedAt":{"type":"string","format":"date-time","description":"Date and time when the task was updated. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."},"dueAt":{"type":"string","format":"date-time","description":"Date and time when the task is due. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."},"completedAt":{"type":"string","format":"date-time","description":"Date and time when the task was completed. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."}}}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_children","parameters":{"id":{"type":"integer","description":"The ID of the parent page. If you don't know the page ID, use Get pages and filter the results."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_custom_content_by_id_children","parameters":{"id":{"type":"integer","description":"The ID of the parent custom content. If you don't know the custom content ID, use Get custom-content and filter the results."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_direct_children","parameters":{"id":{"type":"integer","description":"The ID of the parent page."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."},"sort":{"type":"string","description":"Used to sort the result by a particular field."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_ancestors","parameters":{"id":{"type":"integer","description":"The ID of the page."},"limit":{"type":"integer","description":"Maximum number of pages per result to return. If more results exist, call this endpoint with the highest ancestor's ID to fetch the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_descendants","parameters":{"id":{"type":"integer","description":"The ID of the page."},"limit":{"type":"integer","description":"Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results."},"depth":{"type":"integer","description":"Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."}}},{"connectionName":"confluence-token","actionName":"post_users_bulk","parameters":{"data":{"type":"object","required":["accountIds"],"properties":{"accountIds":{"nullable":false,"description":"List of accountIds to retrieve user info for.","type":"array","minItems":1,"maxItems":250,"items":{"type":"string"}}}}}},{"connectionName":"confluence-token","actionName":"post_user_access_check_access_by_email","parameters":{"data":{"type":"object","required":["emails"],"properties":{"emails":{"nullable":false,"description":"List of emails to check access to site.","type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}}}},{"connectionName":"confluence-token","actionName":"post_user_access_invite_by_email","parameters":{"data":{"type":"object","required":["emails"],"properties":{"emails":{"nullable":false,"description":"List of emails to check access to site.","type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}}}},{"connectionName":"confluence-token","actionName":"get_data_policies_metadata","parameters":{}},{"connectionName":"confluence-token","actionName":"get_data_policies_spaces","parameters":{"ids":{"type":"array","description":"Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list."},"keys":{"type":"array","description":"Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list."},"sort":{"type":"string","description":"Used to sort the result by a particular field."},"cursor":{"type":"string","description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."},"limit":{"type":"integer","description":"Maximum number of spaces per result to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."}}},{"connectionName":"confluence-token","actionName":"get_classification_levels","parameters":{}},{"connectionName":"confluence-token","actionName":"get_spaces_by_id_classification_level_default","parameters":{"id":{"type":"integer","description":"The ID of the space for which default classification level should be returned."}}},{"connectionName":"confluence-token","actionName":"put_spaces_by_id_classification_level_default","parameters":{"id":{"type":"integer","description":"The ID of the space for which default classification level should be updated."},"data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the classification level."}}}}},{"connectionName":"confluence-token","actionName":"delete_spaces_by_id_classification_level_default","parameters":{"id":{"type":"integer","description":"The ID of the space for which default classification level should be deleted."}}},{"connectionName":"confluence-token","actionName":"get_pages_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the page for which classification level should be returned."},"status":{"type":"string","description":"Status of page from which classification level will fetched."}}},{"connectionName":"confluence-token","actionName":"put_pages_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the page for which classification level should be updated."},"data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The ID of the classification level."},"status":{"enum":["current","draft"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-token","actionName":"post_pages_by_id_classification_level_reset","parameters":{"id":{"type":"integer","description":"The ID of the page for which classification level should be updated."},"data":{"type":"object","required":["status"],"properties":{"status":{"enum":["current","draft"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-token","actionName":"get_blogposts_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which classification level should be returned."},"status":{"type":"string","description":"Status of blog post from which classification level will fetched."}}},{"connectionName":"confluence-token","actionName":"put_blogposts_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which classification level should be updated."},"data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The ID of the classification level."},"status":{"enum":["current","draft"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-token","actionName":"post_blogposts_by_id_classification_level_reset","parameters":{"id":{"type":"integer","description":"The ID of the blog post for which classification level should be updated."},"data":{"type":"object","required":["status"],"properties":{"status":{"enum":["current","draft"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-token","actionName":"get_whiteboards_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which classification level should be returned."}}},{"connectionName":"confluence-token","actionName":"put_whiteboards_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which classification level should be updated."},"data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The ID of the classification level."},"status":{"enum":["current"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-token","actionName":"post_whiteboards_by_id_classification_level_reset","parameters":{"id":{"type":"integer","description":"The ID of the whiteboard for which classification level should be updated."},"data":{"type":"object","required":["status"],"properties":{"status":{"enum":["current"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-token","actionName":"get_databases_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the database for which classification level should be returned."}}},{"connectionName":"confluence-token","actionName":"put_databases_by_id_classification_level","parameters":{"id":{"type":"integer","description":"The ID of the database for which classification level should be updated."},"data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The ID of the classification level."},"status":{"enum":["current"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-token","actionName":"post_databases_by_id_classification_level_reset","parameters":{"id":{"type":"integer","description":"The ID of the database for which classification level should be updated."},"data":{"type":"object","required":["status"],"properties":{"status":{"enum":["current"],"type":"string","description":"Status of the content."}}}}},{"connectionName":"confluence-token","actionName":"get_app_properties_by_property_key","parameters":{"propertyKey":{"type":"string","description":"The key of the property"}}},{"connectionName":"confluence-token","actionName":"put_app_properties_by_property_key","parameters":{"propertyKey":{"type":"string","description":"The key of the property"},"data":{"type":"object","example":{"name":"Forge app","darkMode":true,"version":"1.0.0","buildNumber":7}}}},{"connectionName":"confluence-token","actionName":"delete_app_properties_by_property_key","parameters":{"propertyKey":{"type":"string","description":"The key of the property"}}}],"slug":"confluence-token","created_at":"2025-09-25T18:49:39.466Z"},{"id":"databricks-account","name":"Databricks Account","description":"Connect to your Databricks Account to manage workspaces, users, and account-level settings.","logo_url":"https://assets.abstra.cloud/connectors/logos/databricks.png","category":[],"triggers":[],"actions":[{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_credentials","parameters":{}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_credentials","parameters":{}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_credentials","parameters":{"data":{"type":"object","required":["credentials_name","aws_credentials"],"properties":{"aws_credentials":{"$ref":"#/components/schemas/provisioning.CreateCredentialAwsCredentials","x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateCredentialAwsCredentials","x-databricks-legacy-name":"CreateCredentialAwsCredentials","x-databricks-stable-name":"CreateCredentialAwsCredentials"},"credentials_name":{"description":"The human-readable name of the credential configuration object.","type":"string","x-databricks-api-version":"legacy","minLength":4,"maxLength":256,"example":"credential_1"}},"x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateCredentialRequest","x-databricks-legacy-name":"CreateCredentialRequest","x-databricks-stable-name":"CreateCredentialRequest"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_credentials_by_credentials_id","parameters":{"credentials_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_credentials_by_credentials_id","parameters":{"credentials_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_credentials_by_credentials_id","parameters":{"credentials_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_customer_managed_keys","parameters":{}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_customer_managed_keys","parameters":{}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_customer_managed_keys","parameters":{"data":{"type":"object","required":["use_cases"],"properties":{"aws_key_info":{"$ref":"#/components/schemas/provisioning.CreateAwsKeyInfo","x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-cloud-required":"aws","x-databricks-sdk-name":"CreateAwsKeyInfo","x-databricks-legacy-name":"CreateAwsKeyInfo","x-databricks-stable-name":"CreateAwsKeyInfo"},"use_cases":{"description":"The cases that the key can be used for.","type":"array","items":{"$ref":"#/components/schemas/provisioning.KeyUseCase","x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"KeyUseCase","x-databricks-legacy-name":"KeyUseCase","x-databricks-stable-name":"KeyUseCase"},"x-databricks-api-version":"legacy","example":["MANAGED_SERVICES","STORAGE"]}},"x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateCustomerManagedKeyRequest","x-databricks-legacy-name":"CreateCustomerManagedKeyRequest","x-databricks-stable-name":"CreateCustomerManagedKeyRequest"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_customer_managed_keys_by_customer_managed_key_id","parameters":{"customer_managed_key_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_customer_managed_keys_by_customer_managed_key_id","parameters":{"customer_managed_key_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_customer_managed_keys_by_customer_managed_key_id","parameters":{"customer_managed_key_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_dashboard","parameters":{"workspace_id":{"type":"integer","description":"The workspace ID of the workspace in which the usage dashboard is created."},"dashboard_type":{"type":"string","description":"Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage dashboard shows usage data for all workspaces in the account."}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_dashboard","parameters":{"data":{"type":"object","properties":{"dashboard_type":{"description":"Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage dashboard shows usage data for all workspaces in the account.","$ref":"#/components/schemas/billing.UsageDashboardType","x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-schema-id":"buiapiserver.CreateBillingUsageDashboard.dashboard_type","x-databricks-sdk-name":"UsageDashboardType","x-databricks-legacy-name":"UsageDashboardType","x-databricks-stable-name":"UsageDashboardType"},"workspace_id":{"description":"The workspace ID of the workspace in which the usage dashboard is created.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"buiapiserver.CreateBillingUsageDashboard.workspace_id"}},"x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateBillingUsageDashboardRequest","x-databricks-legacy-name":"CreateBillingUsageDashboardRequest","x-databricks-stable-name":"CreateBillingUsageDashboardRequest"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_federation_policies","parameters":{"page_size":{"type":"integer"},"page_token":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_federation_policies","parameters":{"policy_id":{"type":"string","description":"The identifier for the federation policy. The identifier must contain only lowercase\nalphanumeric characters, numbers, hyphens, and slashes. If unspecified, the id will be\nassigned by Databricks."},"data":{"type":"object","properties":{"create_time":{"description":"Creation time of the federation policy.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"description":{"description":"Description of the federation policy.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.description","example":"My federation policy description."},"name":{"description":"Resource name for the federation policy. Example values include\n`accounts//federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts//servicePrincipals//federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.name"},"oidc_policy":{"$ref":"#/components/schemas/oauth2.OidcFederationPolicy","x-databricks-package-name":"oauth2","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.oidc_policy","x-databricks-sdk-name":"OidcFederationPolicy","x-databricks-legacy-name":"OidcFederationPolicy","x-databricks-stable-name":"OidcFederationPolicy"},"policy_id":{"description":"The ID of the federation policy. Output only.","type":"string","x-databricks-field-behaviors":["OPTIONAL","OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.policy_id"},"service_principal_id":{"description":"The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.","type":"integer","format":"int64","x-databricks-field-behaviors":["OPTIONAL","OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.service_principal_id"},"uid":{"description":"Unique, immutable id of the federation policy.","x-databricks-computed":true,"type":"string","format":"uuid","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.uid"},"update_time":{"description":"Last update time of the federation policy.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"FederationPolicy","x-databricks-legacy-name":"FederationPolicy","x-databricks-stable-name":"FederationPolicy"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_federation_policies_by_policy_id","parameters":{"policy_id":{"type":"string","description":"The identifier for the federation policy."}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_federation_policies_by_policy_id","parameters":{"policy_id":{"type":"string","description":"The identifier for the federation policy."},"update_mask":{"type":"string","description":"The field mask specifies which fields of the policy to update. To specify multiple fields\nin the field mask, use comma as the separator (no space). The special value '*' indicates\nthat all fields should be updated (full replacement). If unspecified, all fields that are\nset in the policy provided in the update request will overwrite the corresponding fields\nin the existing policy. Example value: 'description,oidc_policy.audiences'."},"data":{"type":"object","properties":{"create_time":{"description":"Creation time of the federation policy.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"description":{"description":"Description of the federation policy.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.description","example":"My federation policy description."},"name":{"description":"Resource name for the federation policy. Example values include\n`accounts//federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts//servicePrincipals//federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.name"},"oidc_policy":{"$ref":"#/components/schemas/oauth2.OidcFederationPolicy","x-databricks-package-name":"oauth2","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.oidc_policy","x-databricks-sdk-name":"OidcFederationPolicy","x-databricks-legacy-name":"OidcFederationPolicy","x-databricks-stable-name":"OidcFederationPolicy"},"policy_id":{"description":"The ID of the federation policy. Output only.","type":"string","x-databricks-field-behaviors":["OPTIONAL","OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.policy_id"},"service_principal_id":{"description":"The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.","type":"integer","format":"int64","x-databricks-field-behaviors":["OPTIONAL","OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.service_principal_id"},"uid":{"description":"Unique, immutable id of the federation policy.","x-databricks-computed":true,"type":"string","format":"uuid","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.uid"},"update_time":{"description":"Last update time of the federation policy.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"FederationPolicy","x-databricks-legacy-name":"FederationPolicy","x-databricks-stable-name":"FederationPolicy"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_federation_policies_by_policy_id","parameters":{"policy_id":{"type":"string","description":"The identifier for the federation policy."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_ip_access_lists","parameters":{}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_ip_access_lists","parameters":{"data":{"description":"Details required to configure a block list or allow list.","type":"object","required":["label","list_type"],"properties":{"ip_addresses":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.CreateIpAccessList.ip_addresses.array_value","example":"192.168.100.0/22"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.CreateIpAccessList.ip_addresses"},"label":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.CreateIpAccessList.label","example":"Office VPN"},"list_type":{"$ref":"#/components/schemas/settings.list_type","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.CreateIpAccessList.list_type","x-databricks-sdk-name":"list_type","x-databricks-legacy-name":"list_type","x-databricks-stable-name":"list_type"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateIPAccessList","x-databricks-legacy-name":"CreateIPAccessList","x-databricks-stable-name":"CreateIPAccessList"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_ip_access_lists_by_ip_access_list_id","parameters":{"ip_access_list_id":{"type":"string","description":"The ID for the corresponding IP access list"}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_ip_access_lists_by_ip_access_list_id","parameters":{"ip_access_list_id":{"type":"string","description":"The ID for the corresponding IP access list"},"data":{"description":"Details required to replace an IP access list.","type":"object","required":["label","list_type","enabled"],"properties":{"enabled":{"description":"Specifies whether this IP access list is enabled.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.ReplaceIpAccessList.enabled"},"ip_addresses":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.ReplaceIpAccessList.ip_addresses.array_value","example":"192.168.100.0/22"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.ReplaceIpAccessList.ip_addresses"},"label":{"description":"Label for the IP access list. This **cannot** be empty.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.ReplaceIpAccessList.label","example":"Office VPN"},"list_type":{"$ref":"#/components/schemas/settings.list_type","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.ReplaceIpAccessList.list_type","x-databricks-sdk-name":"list_type","x-databricks-legacy-name":"list_type","x-databricks-stable-name":"list_type"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ReplaceIPAccessList","x-databricks-legacy-name":"ReplaceIPAccessList","x-databricks-stable-name":"ReplaceIPAccessList"}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_ip_access_lists_by_ip_access_list_id","parameters":{"ip_access_list_id":{"type":"string","description":"The ID for the corresponding IP access list"},"data":{"description":"Details required to update an IP access list.","type":"object","properties":{"enabled":{"description":"Specifies whether this IP access list is enabled.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.UpdateIpAccessList.enabled"},"ip_addresses":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.UpdateIpAccessList.ip_addresses.array_value","example":"192.168.100.0/22"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.UpdateIpAccessList.ip_addresses"},"label":{"description":"Label for the IP access list. This **cannot** be empty.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.UpdateIpAccessList.label","example":"Office VPN"},"list_type":{"$ref":"#/components/schemas/settings.list_type","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsipaccesslist.UpdateIpAccessList.list_type","x-databricks-sdk-name":"list_type","x-databricks-legacy-name":"list_type","x-databricks-stable-name":"list_type"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateIPAccessList","x-databricks-legacy-name":"UpdateIPAccessList","x-databricks-stable-name":"UpdateIPAccessList"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_ip_access_lists_by_ip_access_list_id","parameters":{"ip_access_list_id":{"type":"string","description":"The ID for the corresponding IP access list"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_log_delivery","parameters":{"credentials_id":{"type":"string","description":"The Credentials id to filter the search results with"},"storage_configuration_id":{"type":"string","description":"The Storage Configuration id to filter the search results with"},"status":{"type":"string","description":"The log delivery status to filter the search results with"},"page_token":{"type":"string","description":"A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page.\nRequests first page if absent."}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_log_delivery","parameters":{"data":{"description":"*\nProperties of the new log delivery configuration.","type":"object","required":["log_delivery_configuration"],"properties":{"log_delivery_configuration":{"$ref":"#/components/schemas/billing.CreateLogDeliveryConfigurationParams","x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-schema-id":"buiapiserver.CreateLogDeliveryConfiguration.log_delivery_configuration","x-databricks-sdk-name":"CreateLogDeliveryConfigurationParams","x-databricks-legacy-name":"CreateLogDeliveryConfigurationParams","x-databricks-stable-name":"CreateLogDeliveryConfigurationParams"}},"x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"WrappedCreateLogDeliveryConfiguration","x-databricks-legacy-name":"WrappedCreateLogDeliveryConfiguration","x-databricks-stable-name":"WrappedCreateLogDeliveryConfiguration"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_log_delivery_by_log_delivery_configuration_id","parameters":{"log_delivery_configuration_id":{"type":"string","description":"The log delivery configuration id of customer"}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_log_delivery_by_log_delivery_configuration_id","parameters":{"log_delivery_configuration_id":{"type":"string","description":"The log delivery configuration id of customer"},"data":{"description":"*\nUpdate Log Delivery Configuration","type":"object","required":["status"],"properties":{"status":{"description":"Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.","$ref":"#/components/schemas/billing.LogDeliveryConfigStatus","x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-schema-id":"buiapiserver.UpdateLogDeliveryConfiguration.status","x-databricks-sdk-name":"LogDeliveryConfigStatus","x-databricks-legacy-name":"LogDeliveryConfigStatus","x-databricks-stable-name":"LogDeliveryConfigStatus"}},"x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateLogDeliveryConfigurationStatusRequest","x-databricks-legacy-name":"UpdateLogDeliveryConfigurationStatusRequest","x-databricks-stable-name":"UpdateLogDeliveryConfigurationStatusRequest"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_metastores","parameters":{}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_metastores","parameters":{}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_metastores","parameters":{"data":{"type":"object","properties":{"metastore_info":{"$ref":"#/components/schemas/catalog.CreateMetastore","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateMetastore","x-databricks-legacy-name":"CreateMetastore","x-databricks-stable-name":"CreateMetastore"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AccountsCreateMetastore","x-databricks-legacy-name":"AccountsCreateMetastore","x-databricks-stable-name":"AccountsCreateMetastore"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_metastores_by_metastore_id","parameters":{"metastore_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_metastores_by_metastore_id","parameters":{"metastore_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_metastores_by_metastore_id","parameters":{"metastore_id":{"type":"string"},"data":{"type":"object","properties":{"metastore_info":{"$ref":"#/components/schemas/catalog.UpdateMetastore","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"UpdateMetastore","x-databricks-legacy-name":"UpdateMetastore","x-databricks-stable-name":"UpdateMetastore"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AccountsUpdateMetastore","x-databricks-legacy-name":"AccountsUpdateMetastore","x-databricks-stable-name":"AccountsUpdateMetastore"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_metastores_by_metastore_id","parameters":{"metastore_id":{"type":"string"},"force":{"type":"boolean","description":"Force deletion even if the metastore is not empty. Default is false."}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials","parameters":{"metastore_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials","parameters":{"metastore_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials","parameters":{"metastore_id":{"type":"string"},"data":{"type":"object","properties":{"credential_info":{"$ref":"#/components/schemas/catalog.CreateStorageCredential","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateStorageCredential","x-databricks-legacy-name":"CreateStorageCredential","x-databricks-stable-name":"CreateStorageCredential"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AccountsCreateStorageCredential","x-databricks-legacy-name":"AccountsCreateStorageCredential","x-databricks-stable-name":"AccountsCreateStorageCredential"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials_by_storage_credential_name","parameters":{"metastore_id":{"type":"string"},"storage_credential_name":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials_by_storage_credential_name","parameters":{"metastore_id":{"type":"string"},"storage_credential_name":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials_by_storage_credential_name","parameters":{"metastore_id":{"type":"string"},"storage_credential_name":{"type":"string"},"data":{"type":"object","properties":{"credential_info":{"$ref":"#/components/schemas/catalog.UpdateStorageCredential","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"UpdateStorageCredential","x-databricks-legacy-name":"UpdateStorageCredential","x-databricks-stable-name":"UpdateStorageCredential"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AccountsUpdateStorageCredential","x-databricks-legacy-name":"AccountsUpdateStorageCredential","x-databricks-stable-name":"AccountsUpdateStorageCredential"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_metastores_by_metastore_id_storage_credentials_by_storage_credential_name","parameters":{"metastore_id":{"type":"string"},"storage_credential_name":{"type":"string"},"force":{"type":"boolean","description":"Force deletion even if the Storage Credential is not empty. Default is false."}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_metastores_by_metastore_id_workspaces","parameters":{"metastore_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_metastores_by_metastore_id_workspaces","parameters":{"metastore_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_network_connectivity_configs","parameters":{"page_token":{"type":"string","description":"Pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_network_connectivity_configs","parameters":{"data":{"description":"Properties of the new network connectivity configuration.","type":"object","required":["name","region"],"properties":{"name":{"description":"The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens,\nand underscores. The length must be between 3 and 30 characters. The name must match the regular\nexpression ^[0-9a-zA-Z-_]{3,30}$","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountslakenetmanager.CustomerFacingNetworkConnectivityConfig.name","example":"my-example-ncc"},"region":{"description":"The region for the network connectivity configuration.\nOnly workspaces in the same region can be attached to the network connectivity configuration.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountslakenetmanager.CustomerFacingNetworkConnectivityConfig.region"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateNetworkConnectivityConfiguration","x-databricks-legacy-name":"CreateNetworkConnectivityConfiguration","x-databricks-stable-name":"CreateNetworkConnectivityConfiguration"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id","parameters":{"network_connectivity_config_id":{"type":"string","description":"Your Network Connectivity Configuration ID."}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id","parameters":{"network_connectivity_config_id":{"type":"string","description":"Your Network Connectivity Configuration ID."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rules","parameters":{"network_connectivity_config_id":{"type":"string","description":"Your Network Connectvity Configuration ID."},"page_token":{"type":"string","description":"Pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rules","parameters":{"network_connectivity_config_id":{"type":"string","description":"Your Network Connectivity Configuration ID."},"data":{"description":"Properties of the new private endpoint rule.\nNote that for private endpoints towards a VPC endpoint service behind a customer-managed VPC endpoint service,\nyou must approve the endpoint in AWS console after initialization.","type":"object","properties":{"domain_names":{"description":"Only used by private endpoints towards a VPC endpoint service behind a customer-managed VPC endpoint service.\n\nThe target AWS resource FQDNs accessible via the VPC endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired domain_names is provided.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.accountslakenetmanager.NccPrivateEndpointRule.domain_names.array_value","example":"my-example.exampledomain.com"},"x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-schema-id":"accountslakenetmanager.NccPrivateEndpointRule.domain_names"},"endpoint_service":{"description":"The full target AWS endpoint service name that connects to the destination resources of the private endpoint.","type":"string","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-schema-id":"accountslakenetmanager.NccPrivateEndpointRule.endpoint_service","example":"com.amazonaws.vpce.us-east-1.vpce-svc-123abcc1298abc123"},"resource_names":{"description":"Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.accountslakenetmanager.NccPrivateEndpointRule.resource_names.array_value","example":"mybucket1"},"x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"accountslakenetmanager.NccPrivateEndpointRule.resource_names"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-cloud":"aws","x-databricks-sdk-name":"CreatePrivateEndpointRule","x-databricks-legacy-name":"CreatePrivateEndpointRule","x-databricks-stable-name":"CreatePrivateEndpointRule"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rules_by_private_endpoint_rule_id","parameters":{"network_connectivity_config_id":{"type":"string","description":"Your Network Connectvity Configuration ID."},"private_endpoint_rule_id":{"type":"string","description":"Your private endpoint rule ID."}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rules_by_private_endpoint_rule_id","parameters":{"network_connectivity_config_id":{"type":"string","description":"The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object."},"private_endpoint_rule_id":{"type":"string","description":"Your private endpoint rule ID."},"update_mask":{"type":"string"},"data":{"description":"Properties of the new private endpoint rule.\nNote that for private endpoints towards a VPC endpoint service behind a customer-managed VPC endpoint service,\nyou must approve the endpoint in AWS console after initialization.","type":"object","properties":{"domain_names":{"description":"Only used by private endpoints towards a VPC endpoint service behind a customer-managed VPC endpoint service.\n\nThe target AWS resource FQDNs accessible via the VPC endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired domain_names is provided.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.accountslakenetmanager.NccPrivateEndpointRule.domain_names.array_value","example":"my-example.exampledomain.com"},"x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-schema-id":"accountslakenetmanager.NccPrivateEndpointRule.domain_names"},"enabled":{"description":"Only used by private endpoints towards an AWS S3 service.\n\nUpdate this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"accountslakenetmanager.NccPrivateEndpointRule.enabled","example":true},"resource_names":{"description":"Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.accountslakenetmanager.NccPrivateEndpointRule.resource_names.array_value","example":"mybucket1"},"x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"accountslakenetmanager.NccPrivateEndpointRule.resource_names"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-cloud":"aws","x-databricks-sdk-name":"UpdatePrivateEndpointRule","x-databricks-legacy-name":"UpdatePrivateEndpointRule","x-databricks-stable-name":"UpdatePrivateEndpointRule"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_network_connectivity_configs_by_network_connectivity_config_id_private_endpoint_rules_by_private_endpoint_rule_id","parameters":{"network_connectivity_config_id":{"type":"string","description":"Your Network Connectvity Configuration ID."},"private_endpoint_rule_id":{"type":"string","description":"Your private endpoint rule ID."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_network_policies","parameters":{"page_token":{"type":"string","description":"Pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_network_policies","parameters":{"data":{"type":"object","properties":{"account_id":{"description":"The associated account ID for this Network Policy object.","type":"string","format":"uuid","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"accountslakenetmanager.AccountNetworkPolicy.account_id","example":"123e4567-e89b-12d3-a456-426614174000"},"egress":{"description":"The network policies applying for egress traffic.","$ref":"#/components/schemas/settings.NetworkPolicyEgress","x-databricks-package-name":"settings","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"accountslakenetmanager.AccountNetworkPolicy.egress","x-databricks-sdk-name":"NetworkPolicyEgress","x-databricks-legacy-name":"NetworkPolicyEgress","x-databricks-stable-name":"NetworkPolicyEgress"},"network_policy_id":{"description":"The unique identifier for the network policy.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","pattern":"^[a-zA-Z0-9_.-]{1,32}$","x-databricks-schema-id":"accountslakenetmanager.AccountNetworkPolicy.network_policy_id","example":"example-policy-name"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"AccountNetworkPolicy","x-databricks-legacy-name":"AccountNetworkPolicy","x-databricks-stable-name":"AccountNetworkPolicy"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_network_policies_by_network_policy_id","parameters":{"network_policy_id":{"type":"string","description":"The unique identifier of the network policy to retrieve."}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_network_policies_by_network_policy_id","parameters":{"network_policy_id":{"type":"string","description":"The unique identifier for the network policy."},"data":{"type":"object","properties":{"account_id":{"description":"The associated account ID for this Network Policy object.","type":"string","format":"uuid","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"accountslakenetmanager.AccountNetworkPolicy.account_id","example":"123e4567-e89b-12d3-a456-426614174000"},"egress":{"description":"The network policies applying for egress traffic.","$ref":"#/components/schemas/settings.NetworkPolicyEgress","x-databricks-package-name":"settings","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"accountslakenetmanager.AccountNetworkPolicy.egress","x-databricks-sdk-name":"NetworkPolicyEgress","x-databricks-legacy-name":"NetworkPolicyEgress","x-databricks-stable-name":"NetworkPolicyEgress"},"network_policy_id":{"description":"The unique identifier for the network policy.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","pattern":"^[a-zA-Z0-9_.-]{1,32}$","x-databricks-schema-id":"accountslakenetmanager.AccountNetworkPolicy.network_policy_id","example":"example-policy-name"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"AccountNetworkPolicy","x-databricks-legacy-name":"AccountNetworkPolicy","x-databricks-stable-name":"AccountNetworkPolicy"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_network_policies_by_network_policy_id","parameters":{"network_policy_id":{"type":"string","description":"The unique identifier of the network policy to delete."}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_networks","parameters":{}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_networks","parameters":{}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_networks","parameters":{"data":{"type":"object","required":["network_name"],"properties":{"network_name":{"description":"The human-readable name of the network configuration.","type":"string","x-databricks-api-version":"legacy","minLength":4,"maxLength":256},"security_group_ids":{"description":"IDs of one to five security groups associated with this network. Security group IDs **cannot** be used in multiple network configurations.","type":"array","items":{"description":"ID of security groups associated with this network. Security group IDs *cannot** be used in multiple network configurations.","type":"string","x-databricks-api-version":"legacy"},"x-databricks-api-version":"legacy","x-databricks-cloud":"aws","minLength":1,"maxLength":5},"subnet_ids":{"description":"IDs of at least two subnets associated with this network. Subnet IDs **cannot** be used in multiple network configurations.","type":"array","items":{"description":"ID of subnet associated with this network. Subnet IDs **cannot** be used in multiple network configurations.","type":"string","x-databricks-api-version":"legacy"},"x-databricks-api-version":"legacy","x-databricks-cloud":"aws","minLength":2},"vpc_endpoints":{"$ref":"#/components/schemas/provisioning.NetworkVpcEndpoints","x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"NetworkVpcEndpoints","x-databricks-legacy-name":"NetworkVpcEndpoints","x-databricks-stable-name":"NetworkVpcEndpoints"},"vpc_id":{"description":"The ID of the VPC associated with this network. VPC IDs can be used in multiple network configurations.","type":"string","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"}},"x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateNetworkRequest","x-databricks-legacy-name":"CreateNetworkRequest","x-databricks-stable-name":"CreateNetworkRequest"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_networks_by_network_id","parameters":{"network_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_networks_by_network_id","parameters":{"network_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_networks_by_network_id","parameters":{"network_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_oauth2_custom_app_integrations","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"},"include_creator_username":{"type":"boolean"}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_oauth2_custom_app_integrations","parameters":{"data":{"type":"object","properties":{"confidential":{"description":"This field indicates whether an OAuth client secret is required to authenticate this client.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateCustomOAuthAppIntegration.confidential","default":false},"name":{"description":"Name of the custom OAuth app","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateCustomOAuthAppIntegration.name"},"redirect_urls":{"description":"List of OAuth redirect urls","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateCustomOAuthAppIntegration.redirect_urls.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateCustomOAuthAppIntegration.redirect_urls"},"scopes":{"description":"OAuth scopes granted to the application.\nSupported scopes: all-apis, sql, offline_access, openid, profile, email.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateCustomOAuthAppIntegration.scopes.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateCustomOAuthAppIntegration.scopes"},"token_access_policy":{"description":"Token access policy","$ref":"#/components/schemas/oauth2.TokenAccessPolicy","x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateCustomOAuthAppIntegration.token_access_policy","x-databricks-sdk-name":"TokenAccessPolicy","x-databricks-legacy-name":"TokenAccessPolicy","x-databricks-stable-name":"TokenAccessPolicy"},"user_authorized_scopes":{"description":"Scopes that will need to be consented by end user to mint the access token. If the user does\nnot authorize the access token will not be minted.\nMust be a subset of scopes.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateCustomOAuthAppIntegration.user_authorized_scopes.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateCustomOAuthAppIntegration.user_authorized_scopes"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateCustomAppIntegration","x-databricks-legacy-name":"CreateCustomAppIntegration","x-databricks-stable-name":"CreateCustomAppIntegration"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_oauth2_custom_app_integrations_by_integration_id","parameters":{"integration_id":{"type":"string","description":"The OAuth app integration ID."}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_oauth2_custom_app_integrations_by_integration_id","parameters":{"integration_id":{"type":"string"},"data":{"type":"object","properties":{"redirect_urls":{"description":"List of OAuth redirect urls to be updated in the custom OAuth app integration","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.UpdateCustomOAuthAppIntegration.redirect_urls.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.UpdateCustomOAuthAppIntegration.redirect_urls"},"scopes":{"description":"List of OAuth scopes to be updated in the custom OAuth app integration, similar to redirect URIs this will fully\nreplace the existing values instead of appending","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.UpdateCustomOAuthAppIntegration.scopes.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.UpdateCustomOAuthAppIntegration.scopes"},"token_access_policy":{"description":"Token access policy to be updated in the custom OAuth app integration","$ref":"#/components/schemas/oauth2.TokenAccessPolicy","x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.UpdateCustomOAuthAppIntegration.token_access_policy","x-databricks-sdk-name":"TokenAccessPolicy","x-databricks-legacy-name":"TokenAccessPolicy","x-databricks-stable-name":"TokenAccessPolicy"},"user_authorized_scopes":{"description":"Scopes that will need to be consented by end user to mint the access token. If the user does\nnot authorize the access token will not be minted.\nMust be a subset of scopes.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.UpdateCustomOAuthAppIntegration.user_authorized_scopes.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.UpdateCustomOAuthAppIntegration.user_authorized_scopes"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateCustomAppIntegration","x-databricks-legacy-name":"UpdateCustomAppIntegration","x-databricks-stable-name":"UpdateCustomAppIntegration"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_oauth2_custom_app_integrations_by_integration_id","parameters":{"integration_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_oauth2_published_app_integrations","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_oauth2_published_app_integrations","parameters":{"data":{"type":"object","properties":{"app_id":{"description":"App id of the OAuth published app integration.\nFor example power-bi, tableau-deskop","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreatePublishedOAuthAppIntegration.app_id"},"token_access_policy":{"description":"Token access policy","$ref":"#/components/schemas/oauth2.TokenAccessPolicy","x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreatePublishedOAuthAppIntegration.token_access_policy","x-databricks-sdk-name":"TokenAccessPolicy","x-databricks-legacy-name":"TokenAccessPolicy","x-databricks-stable-name":"TokenAccessPolicy"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreatePublishedAppIntegration","x-databricks-legacy-name":"CreatePublishedAppIntegration","x-databricks-stable-name":"CreatePublishedAppIntegration"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_oauth2_published_app_integrations_by_integration_id","parameters":{"integration_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_oauth2_published_app_integrations_by_integration_id","parameters":{"integration_id":{"type":"string"},"data":{"type":"object","properties":{"token_access_policy":{"description":"Token access policy to be updated in the published OAuth app integration","$ref":"#/components/schemas/oauth2.TokenAccessPolicy","x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.UpdatePublishedOAuthAppIntegration.token_access_policy","x-databricks-sdk-name":"TokenAccessPolicy","x-databricks-legacy-name":"TokenAccessPolicy","x-databricks-stable-name":"TokenAccessPolicy"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdatePublishedAppIntegration","x-databricks-legacy-name":"UpdatePublishedAppIntegration","x-databricks-stable-name":"UpdatePublishedAppIntegration"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_oauth2_published_app_integrations_by_integration_id","parameters":{"integration_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_oauth2_published_apps","parameters":{"page_token":{"type":"string","description":"A token that can be used to get the next page of results."},"page_size":{"type":"integer","description":"The max number of OAuth published apps to return in one page."}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_private_access_settings","parameters":{}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_private_access_settings","parameters":{}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_private_access_settings","parameters":{"data":{"type":"object","required":["private_access_settings_name","region"],"properties":{"allowed_vpc_endpoint_ids":{"description":"An array of Databricks VPC endpoint IDs. This is the Databricks ID that is returned when registering the VPC endpoint configuration in your Databricks account. This is not the ID of the VPC endpoint in AWS.\n\nOnly used when `private_access_level` is set to `ENDPOINT`. This is an allow list of VPC endpoints that in your account that can connect to your workspace over AWS PrivateLink.\n\nIf hybrid access to your workspace is enabled by setting `public_access_enabled` to `true`, this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see [IP access lists](https://docs.databricks.com/security/network/ip-access-list.html).","type":"array","items":{"type":"string","format":"uuid","x-databricks-api-version":"legacy"},"x-databricks-api-version":"legacy"},"private_access_level":{"$ref":"#/components/schemas/provisioning.PrivateAccessLevel","x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"PrivateAccessLevel","x-databricks-legacy-name":"PrivateAccessLevel","x-databricks-stable-name":"PrivateAccessLevel"},"private_access_settings_name":{"description":"The human-readable name of the private access settings object.","type":"string","x-databricks-api-version":"legacy","minLength":4,"maxLength":256},"public_access_enabled":{"description":"Determines if the workspace can be accessed over public internet. For fully private workspaces, you can optionally specify `false`, but only if you implement both the front-end and the back-end PrivateLink connections. Otherwise, specify `true`, which means that public access is enabled.","type":"boolean","x-databricks-api-version":"legacy","default":false},"region":{"description":"The AWS region for workspaces attached to this private access settings object. This must be a [region that Databricks supports for PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/regions.html).","type":"string","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"}},"x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreatePrivateAccessSettingsRequest","x-databricks-legacy-name":"CreatePrivateAccessSettingsRequest","x-databricks-stable-name":"CreatePrivateAccessSettingsRequest"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_private_access_settings_by_private_access_settings_id","parameters":{"private_access_settings_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_private_access_settings_by_private_access_settings_id","parameters":{"private_access_settings_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_private_access_settings_by_private_access_settings_id","parameters":{"private_access_settings_id":{"type":"string"},"data":{"type":"object","required":["private_access_settings_name","region"],"properties":{"allowed_vpc_endpoint_ids":{"description":"An array of Databricks VPC endpoint IDs. This is the Databricks ID that is returned when registering the VPC endpoint configuration in your Databricks account. This is not the ID of the VPC endpoint in AWS.\n\nOnly used when `private_access_level` is set to `ENDPOINT`. This is an allow list of VPC endpoints that in your account that can connect to your workspace over AWS PrivateLink.\n\nIf hybrid access to your workspace is enabled by setting `public_access_enabled` to `true`, this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see [IP access lists](https://docs.databricks.com/security/network/ip-access-list.html).","type":"array","items":{"type":"string","format":"uuid","x-databricks-api-version":"legacy"},"x-databricks-api-version":"legacy"},"private_access_level":{"$ref":"#/components/schemas/provisioning.PrivateAccessLevel","x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"PrivateAccessLevel","x-databricks-legacy-name":"PrivateAccessLevel","x-databricks-stable-name":"PrivateAccessLevel"},"private_access_settings_name":{"description":"The human-readable name of the private access settings object.","type":"string","x-databricks-api-version":"legacy","minLength":4,"maxLength":256},"public_access_enabled":{"description":"Determines if the workspace can be accessed over public internet. For fully private workspaces, you can optionally specify `false`, but only if you implement both the front-end and the back-end PrivateLink connections. Otherwise, specify `true`, which means that public access is enabled.","type":"boolean","x-databricks-api-version":"legacy","default":false},"region":{"description":"The AWS region for workspaces attached to this private access settings object. This must be a [region that Databricks supports for PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/regions.html).","type":"string","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"}},"x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ReplacePrivateAccessSettingsRequest","x-databricks-legacy-name":"ReplacePrivateAccessSettingsRequest","x-databricks-stable-name":"ReplacePrivateAccessSettingsRequest"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_private_access_settings_by_private_access_settings_id","parameters":{"private_access_settings_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_scim_v2_groups","parameters":{"filter":{"type":"string","description":"Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions."},"attributes":{"type":"string","description":"Comma-separated list of attributes to return in response."},"excludedAttributes":{"type":"string","description":"Comma-separated list of attributes to exclude in response."},"startIndex":{"type":"integer","description":"Specifies the index of the first result. First item is number 1."},"count":{"type":"integer","description":"Desired number of results per page. Default is 10000."},"sortBy":{"type":"string","description":"Attribute to sort the results."},"sortOrder":{"type":"string","description":"The order to sort the results."}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_scim_v2_groups","parameters":{"data":{"type":"object","properties":{"displayName":{"description":"String that represents a human-readable group name","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iamaccounts.Group.display_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"externalId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iamaccounts.Group.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"id":{"description":"Databricks group ID","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.Group.id"},"members":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.Group.members.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.Group.members"},"roles":{"description":"Indicates if the group has the admin role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.Group.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.Group.roles"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Group","x-databricks-legacy-name":"Group","x-databricks-stable-name":"Group"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_scim_v2_groups_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a group in the Databricks account."}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_scim_v2_groups_by_id","parameters":{"id":{"type":"string","description":"Databricks group ID"},"data":{"type":"object","properties":{"displayName":{"description":"String that represents a human-readable group name","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iamaccounts.Group.display_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"externalId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iamaccounts.Group.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"id":{"description":"Databricks group ID","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.Group.id"},"members":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.Group.members.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.Group.members"},"roles":{"description":"Indicates if the group has the admin role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.Group.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.Group.roles"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Group","x-databricks-legacy-name":"Group","x-databricks-stable-name":"Group"}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_scim_v2_groups_by_id","parameters":{"id":{"type":"string","description":"Unique ID in the Databricks workspace."},"data":{"type":"object","properties":{"Operations":{"type":"array","items":{"$ref":"#/components/schemas/iam.Patch","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.PartialUpdate.operations.array_value","x-databricks-sdk-name":"Patch","x-databricks-legacy-name":"Patch","x-databricks-stable-name":"Patch"},"x-databricks-api-version":"legacy","x-databricks-proto-name":"operations","x-databricks-schema-id":"iamaccounts.PartialUpdate.operations","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"schemas":{"description":"The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].","type":"array","items":{"$ref":"#/components/schemas/iam.PatchSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.PartialUpdate.schemas.array_value","x-databricks-sdk-name":"PatchSchema","x-databricks-legacy-name":"PatchSchema","x-databricks-stable-name":"PatchSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.PartialUpdate.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PartialUpdate","x-databricks-legacy-name":"PartialUpdate","x-databricks-stable-name":"PartialUpdate"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_scim_v2_groups_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a group in the Databricks account."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_scim_v2_service_principals","parameters":{"attributes":{"type":"string","description":"Comma-separated list of attributes to return in response."},"count":{"type":"integer","description":"Desired number of results per page. Default is 10000."},"excludedAttributes":{"type":"string","description":"Comma-separated list of attributes to exclude in response."},"filter":{"type":"string","description":"Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions."},"sortBy":{"type":"string","description":"Attribute to sort the results."},"sortOrder":{"type":"string","description":"The order to sort the results."},"startIndex":{"type":"integer","description":"Specifies the index of the first result. First item is number 1."}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_scim_v2_service_principals","parameters":{"data":{"type":"object","properties":{"active":{"description":"If this user is active","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.ServicePrincipal.active"},"applicationId":{"description":"UUID relating to the service principal","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-proto-name":"application_id","x-databricks-schema-id":"iamaccounts.ServicePrincipal.application_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"displayName":{"description":"String that represents a concatenation of given and family names.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iamaccounts.ServicePrincipal.display_name","example":"etl-service","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"externalId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iamaccounts.ServicePrincipal.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"id":{"description":"Databricks service principal ID.","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.ServicePrincipal.id"},"roles":{"description":"Indicates if the group has the admin role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.ServicePrincipal.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.ServicePrincipal.roles"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ServicePrincipal","x-databricks-legacy-name":"ServicePrincipal","x-databricks-stable-name":"ServicePrincipal"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_scim_v2_service_principals_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a service principal in the Databricks account."}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_scim_v2_service_principals_by_id","parameters":{"id":{"type":"string","description":"Databricks service principal ID."},"data":{"type":"object","properties":{"active":{"description":"If this user is active","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.ServicePrincipal.active"},"applicationId":{"description":"UUID relating to the service principal","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-proto-name":"application_id","x-databricks-schema-id":"iamaccounts.ServicePrincipal.application_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"displayName":{"description":"String that represents a concatenation of given and family names.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iamaccounts.ServicePrincipal.display_name","example":"etl-service","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"externalId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iamaccounts.ServicePrincipal.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"id":{"description":"Databricks service principal ID.","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.ServicePrincipal.id"},"roles":{"description":"Indicates if the group has the admin role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.ServicePrincipal.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.ServicePrincipal.roles"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ServicePrincipal","x-databricks-legacy-name":"ServicePrincipal","x-databricks-stable-name":"ServicePrincipal"}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_scim_v2_service_principals_by_id","parameters":{"id":{"type":"string","description":"Unique ID in the Databricks workspace."},"data":{"type":"object","properties":{"Operations":{"type":"array","items":{"$ref":"#/components/schemas/iam.Patch","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.PartialUpdate.operations.array_value","x-databricks-sdk-name":"Patch","x-databricks-legacy-name":"Patch","x-databricks-stable-name":"Patch"},"x-databricks-api-version":"legacy","x-databricks-proto-name":"operations","x-databricks-schema-id":"iamaccounts.PartialUpdate.operations","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"schemas":{"description":"The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].","type":"array","items":{"$ref":"#/components/schemas/iam.PatchSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.PartialUpdate.schemas.array_value","x-databricks-sdk-name":"PatchSchema","x-databricks-legacy-name":"PatchSchema","x-databricks-stable-name":"PatchSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.PartialUpdate.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PartialUpdate","x-databricks-legacy-name":"PartialUpdate","x-databricks-stable-name":"PartialUpdate"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_scim_v2_service_principals_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a service principal in the Databricks account."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_scim_v2_users","parameters":{"attributes":{"type":"string","description":"Comma-separated list of attributes to return in response."},"count":{"type":"integer","description":"Desired number of results per page. Default is 10000."},"excludedAttributes":{"type":"string","description":"Comma-separated list of attributes to exclude in response."},"filter":{"type":"string","description":"Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions."},"sortBy":{"type":"string","description":"Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`."},"sortOrder":{"type":"string","description":"The order to sort the results."},"startIndex":{"type":"integer","description":"Specifies the index of the first result. First item is number 1."}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_scim_v2_users","parameters":{"data":{"type":"object","properties":{"active":{"description":"If this user is active","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.active"},"displayName":{"description":"String that represents a concatenation of given and family names. For example `John Smith`.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iamaccounts.User.display_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"emails":{"description":"All the emails associated with the Databricks user.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.User.emails.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.emails"},"externalId":{"description":"External ID is not currently supported. It is reserved for future use.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iamaccounts.User.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"id":{"description":"Databricks user ID.","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.id"},"name":{"$ref":"#/components/schemas/iam.Name","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.name","x-databricks-sdk-name":"Name","x-databricks-legacy-name":"Name","x-databricks-stable-name":"Name"},"roles":{"description":"Indicates if the group has the admin role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.User.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.roles"},"userName":{"description":"Email address of the Databricks user.","type":"string","format":"email","x-databricks-api-version":"legacy","x-databricks-proto-name":"user_name","x-databricks-schema-id":"iamaccounts.User.user_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"User","x-databricks-legacy-name":"User","x-databricks-stable-name":"User"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_scim_v2_users_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a user in the Databricks account."},"attributes":{"type":"string","description":"Comma-separated list of attributes to return in response."},"count":{"type":"integer","description":"Desired number of results per page. Default is 10000."},"excludedAttributes":{"type":"string","description":"Comma-separated list of attributes to exclude in response."},"filter":{"type":"string","description":"Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions."},"sortBy":{"type":"string","description":"Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`."},"sortOrder":{"type":"string","description":"The order to sort the results."},"startIndex":{"type":"integer","description":"Specifies the index of the first result. First item is number 1."}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_scim_v2_users_by_id","parameters":{"id":{"type":"string","description":"Databricks user ID."},"data":{"type":"object","properties":{"active":{"description":"If this user is active","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.active"},"displayName":{"description":"String that represents a concatenation of given and family names. For example `John Smith`.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iamaccounts.User.display_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"emails":{"description":"All the emails associated with the Databricks user.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.User.emails.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.emails"},"externalId":{"description":"External ID is not currently supported. It is reserved for future use.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iamaccounts.User.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"id":{"description":"Databricks user ID.","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.id"},"name":{"$ref":"#/components/schemas/iam.Name","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.name","x-databricks-sdk-name":"Name","x-databricks-legacy-name":"Name","x-databricks-stable-name":"Name"},"roles":{"description":"Indicates if the group has the admin role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.User.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.User.roles"},"userName":{"description":"Email address of the Databricks user.","type":"string","format":"email","x-databricks-api-version":"legacy","x-databricks-proto-name":"user_name","x-databricks-schema-id":"iamaccounts.User.user_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"User","x-databricks-legacy-name":"User","x-databricks-stable-name":"User"}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_scim_v2_users_by_id","parameters":{"id":{"type":"string","description":"Unique ID in the Databricks workspace."},"data":{"type":"object","properties":{"Operations":{"type":"array","items":{"$ref":"#/components/schemas/iam.Patch","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.PartialUpdate.operations.array_value","x-databricks-sdk-name":"Patch","x-databricks-legacy-name":"Patch","x-databricks-stable-name":"Patch"},"x-databricks-api-version":"legacy","x-databricks-proto-name":"operations","x-databricks-schema-id":"iamaccounts.PartialUpdate.operations","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"schemas":{"description":"The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].","type":"array","items":{"$ref":"#/components/schemas/iam.PatchSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iamaccounts.PartialUpdate.schemas.array_value","x-databricks-sdk-name":"PatchSchema","x-databricks-legacy-name":"PatchSchema","x-databricks-stable-name":"PatchSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iamaccounts.PartialUpdate.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PartialUpdate","x-databricks-legacy-name":"PartialUpdate","x-databricks-stable-name":"PartialUpdate"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_scim_v2_users_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a user in the Databricks account."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_credentials_secrets","parameters":{"service_principal_id":{"type":"string","description":"The service principal ID."},"page_token":{"type":"string","description":"An opaque page token which was the `next_page_token` in the response of the previous request to list the secrets for this service principal. Provide this token to retrieve the next page of secret entries.\nWhen providing a `page_token`, all other parameters provided to the request must match the previous request.\nTo list all of the secrets for a service principal, it is necessary to continue requesting pages of entries until the response contains no `next_page_token`. Note that the number of entries returned must not be used to determine when the listing is complete."},"page_size":{"type":"integer"}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_credentials_secrets","parameters":{"service_principal_id":{"type":"string","description":"The service principal ID."},"data":{"type":"object","properties":{"lifetime":{"description":"The lifetime of the secret in seconds. If this parameter is not provided, the secret will have a default lifetime of 730 days (63072000s).","type":"string","format":"duration","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateServicePrincipalSecret.lifetime","x-databricks-well-known-type":"google.protobuf.Duration","example":"31536000s"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateServicePrincipalSecretRequest","x-databricks-legacy-name":"CreateServicePrincipalSecretRequest","x-databricks-stable-name":"CreateServicePrincipalSecretRequest"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_credentials_secrets_by_secret_id","parameters":{"service_principal_id":{"type":"string","description":"The service principal ID."},"secret_id":{"type":"string","description":"The secret ID."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policies","parameters":{"service_principal_id":{"type":"integer","description":"The service principal id for the federation policy."},"page_size":{"type":"integer"},"page_token":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policies","parameters":{"service_principal_id":{"type":"integer","description":"The service principal id for the federation policy."},"policy_id":{"type":"string","description":"The identifier for the federation policy. The identifier must contain only lowercase\nalphanumeric characters, numbers, hyphens, and slashes. If unspecified, the id will be\nassigned by Databricks."},"data":{"type":"object","properties":{"create_time":{"description":"Creation time of the federation policy.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"description":{"description":"Description of the federation policy.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.description","example":"My federation policy description."},"name":{"description":"Resource name for the federation policy. Example values include\n`accounts//federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts//servicePrincipals//federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.name"},"oidc_policy":{"$ref":"#/components/schemas/oauth2.OidcFederationPolicy","x-databricks-package-name":"oauth2","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.oidc_policy","x-databricks-sdk-name":"OidcFederationPolicy","x-databricks-legacy-name":"OidcFederationPolicy","x-databricks-stable-name":"OidcFederationPolicy"},"policy_id":{"description":"The ID of the federation policy. Output only.","type":"string","x-databricks-field-behaviors":["OPTIONAL","OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.policy_id"},"service_principal_id":{"description":"The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.","type":"integer","format":"int64","x-databricks-field-behaviors":["OPTIONAL","OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.service_principal_id"},"uid":{"description":"Unique, immutable id of the federation policy.","x-databricks-computed":true,"type":"string","format":"uuid","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.uid"},"update_time":{"description":"Last update time of the federation policy.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"FederationPolicy","x-databricks-legacy-name":"FederationPolicy","x-databricks-stable-name":"FederationPolicy"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policies_by_policy_id","parameters":{"service_principal_id":{"type":"integer","description":"The service principal id for the federation policy."},"policy_id":{"type":"string","description":"The identifier for the federation policy."}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policies_by_policy_id","parameters":{"service_principal_id":{"type":"integer","description":"The service principal id for the federation policy."},"policy_id":{"type":"string","description":"The identifier for the federation policy."},"update_mask":{"type":"string","description":"The field mask specifies which fields of the policy to update. To specify multiple fields\nin the field mask, use comma as the separator (no space). The special value '*' indicates\nthat all fields should be updated (full replacement). If unspecified, all fields that are\nset in the policy provided in the update request will overwrite the corresponding fields\nin the existing policy. Example value: 'description,oidc_policy.audiences'."},"data":{"type":"object","properties":{"create_time":{"description":"Creation time of the federation policy.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"description":{"description":"Description of the federation policy.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.description","example":"My federation policy description."},"name":{"description":"Resource name for the federation policy. Example values include\n`accounts//federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts//servicePrincipals//federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.name"},"oidc_policy":{"$ref":"#/components/schemas/oauth2.OidcFederationPolicy","x-databricks-package-name":"oauth2","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.oidc_policy","x-databricks-sdk-name":"OidcFederationPolicy","x-databricks-legacy-name":"OidcFederationPolicy","x-databricks-stable-name":"OidcFederationPolicy"},"policy_id":{"description":"The ID of the federation policy. Output only.","type":"string","x-databricks-field-behaviors":["OPTIONAL","OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.policy_id"},"service_principal_id":{"description":"The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.","type":"integer","format":"int64","x-databricks-field-behaviors":["OPTIONAL","OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.service_principal_id"},"uid":{"description":"Unique, immutable id of the federation policy.","x-databricks-computed":true,"type":"string","format":"uuid","x-databricks-field-behaviors":["OUTPUT_ONLY","IMMUTABLE"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.uid"},"update_time":{"description":"Last update time of the federation policy.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"common.authentication.federationpolicy.proto.FederationPolicy.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"FederationPolicy","x-databricks-legacy-name":"FederationPolicy","x-databricks-stable-name":"FederationPolicy"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_service_principals_by_service_principal_id_federation_policies_by_policy_id","parameters":{"service_principal_id":{"type":"integer","description":"The service principal id for the federation policy."},"policy_id":{"type":"string","description":"The identifier for the federation policy."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_settings_types_disable_legacy_features_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_settings_types_disable_legacy_features_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicAccountSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicAccountSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.DisableLegacyFeatures","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicAccountSettingRequest.setting","x-databricks-sdk-name":"DisableLegacyFeatures","x-databricks-legacy-name":"DisableLegacyFeatures","x-databricks-stable-name":"DisableLegacyFeatures"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateDisableLegacyFeaturesRequest","x-databricks-legacy-name":"UpdateDisableLegacyFeaturesRequest","x-databricks-stable-name":"UpdateDisableLegacyFeaturesRequest"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_settings_types_disable_legacy_features_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_settings_types_shield_csp_enablement_ac_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_settings_types_shield_csp_enablement_ac_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicAccountSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicAccountSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.CspEnablementAccountSetting","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicAccountSettingRequest.setting","x-databricks-sdk-name":"CspEnablementAccountSetting","x-databricks-legacy-name":"CspEnablementAccountSetting","x-databricks-stable-name":"CspEnablementAccountSetting"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateCspEnablementAccountSettingRequest","x-databricks-legacy-name":"UpdateCspEnablementAccountSettingRequest","x-databricks-stable-name":"UpdateCspEnablementAccountSettingRequest"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_settings_types_shield_esm_enablement_ac_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_settings_types_shield_esm_enablement_ac_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicAccountSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicAccountSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.EsmEnablementAccountSetting","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicAccountSettingRequest.setting","x-databricks-sdk-name":"EsmEnablementAccountSetting","x-databricks-legacy-name":"EsmEnablementAccountSetting","x-databricks-stable-name":"EsmEnablementAccountSetting"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateEsmEnablementAccountSettingRequest","x-databricks-legacy-name":"UpdateEsmEnablementAccountSettingRequest","x-databricks-stable-name":"UpdateEsmEnablementAccountSettingRequest"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_storage_configurations","parameters":{}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_storage_configurations","parameters":{}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_storage_configurations","parameters":{"data":{"type":"object","required":["storage_configuration_name","root_bucket_info"],"properties":{"root_bucket_info":{"$ref":"#/components/schemas/provisioning.RootBucketInfo","x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RootBucketInfo","x-databricks-legacy-name":"RootBucketInfo","x-databricks-stable-name":"RootBucketInfo"},"storage_configuration_name":{"description":"The human-readable name of the storage configuration.","type":"string","x-databricks-api-version":"legacy","minLength":4,"maxLength":256,"example":"storage_conf_1"}},"x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateStorageConfigurationRequest","x-databricks-legacy-name":"CreateStorageConfigurationRequest","x-databricks-stable-name":"CreateStorageConfigurationRequest"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_storage_configurations_by_storage_configuration_id","parameters":{"storage_configuration_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_storage_configurations_by_storage_configuration_id","parameters":{"storage_configuration_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_storage_configurations_by_storage_configuration_id","parameters":{"storage_configuration_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_usage_download","parameters":{"start_month":{"type":"string","description":"Format specification for month in the format `YYYY-MM`. This is\nused to specify billable usage `start_month` and `end_month`\nproperties. **Note**: Billable usage logs are unavailable before\nMarch 2019 (`2019-03`)."},"end_month":{"type":"string","description":"Format: `YYYY-MM`. Last month to return billable usage logs for.\nThis field is required."},"personal_data":{"type":"boolean","description":"Specify whether to include personally identifiable information in\nthe billable usage logs, for example the email addresses of cluster\ncreators. Handle this information with care. Defaults to false."}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_vpc_endpoints","parameters":{}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_vpc_endpoints","parameters":{}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_vpc_endpoints","parameters":{"data":{"type":"object","required":["vpc_endpoint_name"],"properties":{"aws_vpc_endpoint_id":{"description":"The ID of the VPC endpoint object in AWS.","type":"string","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"region":{"description":"The AWS region in which this VPC endpoint object exists.","type":"string","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"vpc_endpoint_name":{"description":"The human-readable name of the storage configuration.","type":"string","x-databricks-api-version":"legacy","minLength":4,"maxLength":256}},"x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-sdk-name":"CreateVPCEndpointRequest","x-databricks-legacy-name":"CreateVPCEndpointRequest","x-databricks-stable-name":"CreateVPCEndpointRequest"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_vpc_endpoints_by_vpc_endpoint_id","parameters":{"vpc_endpoint_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_vpc_endpoints_by_vpc_endpoint_id","parameters":{"vpc_endpoint_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_vpc_endpoints_by_vpc_endpoint_id","parameters":{"vpc_endpoint_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_workspaces","parameters":{}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_workspaces","parameters":{}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_workspaces","parameters":{"data":{"type":"object","required":["workspace_name"],"properties":{"aws_region":{"description":"The AWS region of the workspace's data plane.","type":"string","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-cloud-required":"aws","example":"us-west-2"},"credentials_id":{"description":"ID of the workspace's credential configuration object.","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-cloud-required":"aws","example":"ccc64f28-ebdc-4c89-add9-5dcb6d7727d8"},"custom_tags":{"description":"The custom tags key-value pairing that is attached to this workspace.\nThe key-value pair is a string of utf-8 characters.\nThe value can be an empty string, with maximum length of 255 characters.\nThe key can be of maximum length of 127 characters, and cannot be empty.\n","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy"},"x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"deployment_name":{"description":"The deployment name defines part of the subdomain for the workspace. The workspace URL for the web application and REST APIs is `.cloud.databricks.com`. For example, if the deployment name is `abcsales`, your workspace URL will be `https://abcsales.cloud.databricks.com`. Hyphens are allowed. This property supports only the set of characters that are allowed in a subdomain.\n\nTo set this value, you must have a deployment name prefix. Contact your Databricks account team to add an account deployment name prefix to your account.\n\nWorkspace deployment names follow the account prefix and a hyphen. For example, if your account's deployment prefix is `acme` and the workspace deployment name is `workspace-1`, the JSON response for the `deployment_name` field becomes `acme-workspace-1`. The workspace URL would be `acme-workspace-1.cloud.databricks.com`.\n\nYou can also set the `deployment_name` to the reserved keyword `EMPTY` if you want the deployment name to only include the deployment prefix. For example, if your account's deployment prefix is `acme` and the workspace deployment name is `EMPTY`, the `deployment_name` becomes `acme` only and the workspace URL is `acme.cloud.databricks.com`.\n\nThis value must be unique across all non-deleted deployments across all AWS regions.\n\nIf a new workspace omits this property, the server generates a unique deployment name for you with the pattern `dbc-xxxxxxxx-xxxx`.","type":"string","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","pattern":"^(([a-z0-9][a-z0-9-]*[a-z0-9])|([a-z0-9]))|(EMPTY)$","example":"workspace_1"},"managed_services_customer_managed_key_id":{"description":"The ID of the workspace's managed services encryption key configuration object. This is used to help protect and control access to the workspace's notebooks, secrets, Databricks SQL queries, and query history. The provided key configuration object property `use_cases` must contain `MANAGED_SERVICES`.","type":"string","format":"uuid","x-databricks-api-version":"legacy","example":"849b3d6b-e68e-468d-b3e5-deb08b03c56d"},"network_id":{"description":"The ID of the workspace's network configuration object. To use [AWS PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html), this field is required.\n","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","example":"fd0cc5bc-683c-47e9-b15e-144d7744a496"},"pricing_tier":{"$ref":"#/components/schemas/provisioning.PricingTier","x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"PricingTier","x-databricks-legacy-name":"PricingTier","x-databricks-stable-name":"PricingTier"},"private_access_settings_id":{"description":"ID of the workspace's private access settings object. Only used for PrivateLink. This ID must be specified for customers using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.\n\nBefore configuring PrivateLink, read the [Databricks article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).\",\n","type":"string","format":"uuid","x-databricks-api-version":"legacy"},"storage_configuration_id":{"description":"The ID of the workspace's storage configuration object.","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-cloud-required":"aws","example":"b43a6064-04c1-4e1c-88b6-d91e5b136b13"},"storage_customer_managed_key_id":{"description":"The ID of the workspace's storage encryption key configuration object. This is used to encrypt the workspace's root S3 bucket (root DBFS and system data) and, optionally, cluster EBS volumes. The provided key configuration object property `use_cases` must contain `STORAGE`.","type":"string","format":"uuid","x-databricks-api-version":"legacy"},"workspace_name":{"description":"The workspace's human-readable name.","type":"string","x-databricks-api-version":"legacy"}},"x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateWorkspaceRequest","x-databricks-legacy-name":"CreateWorkspaceRequest","x-databricks-stable-name":"CreateWorkspaceRequest"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_workspaces_by_workspace_id","parameters":{"workspace_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_workspaces_by_workspace_id","parameters":{"workspace_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"patch_api_2_0_accounts_by_account_id_workspaces_by_workspace_id","parameters":{"workspace_id":{"type":"string"},"data":{"type":"object","properties":{"aws_region":{"description":"The AWS region of the workspace's data plane (for example, `us-west-2`). This parameter is available only for updating failed workspaces.","type":"string","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","example":"us-west-2"},"credentials_id":{"description":"ID of the workspace's credential configuration object. This parameter is available for updating both failed and running workspaces.","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"custom_tags":{"description":"The custom tags key-value pairing that is attached to this workspace.\nThe key-value pair is a string of utf-8 characters.\nThe value can be an empty string, with maximum length of 255 characters.\nThe key can be of maximum length of 127 characters, and cannot be empty.\n","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy"},"x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"managed_services_customer_managed_key_id":{"description":"The ID of the workspace's managed services encryption key configuration object. This parameter is available only for updating failed workspaces.","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"network_connectivity_config_id":{"description":"The ID of the network connectivity configuration to attach to this workspace.","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","example":"390afeb4-1111-2222-af33-ca3965c04068"},"network_id":{"description":"The ID of the workspace's network configuration object. Used only if you already use a customer-managed VPC. For failed workspaces only, you can switch from a Databricks-managed VPC to a customer-managed VPC by updating the workspace to add a network configuration ID.","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"private_access_settings_id":{"description":"The ID of the workspace's private access settings configuration object. This parameter is available only for updating failed workspaces.","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"storage_configuration_id":{"description":"The ID of the workspace's storage configuration object. This parameter is available only for updating failed workspaces.","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"storage_customer_managed_key_id":{"description":"The ID of the key configuration object for workspace storage. This parameter is available for updating both failed and running workspaces.","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"}},"x-databricks-package-name":"provisioning","x-databricks-api-version":"legacy","x-databricks-not-cloud":"gcp","x-databricks-sdk-name":"UpdateWorkspaceRequest","x-databricks-legacy-name":"UpdateWorkspaceRequest","x-databricks-stable-name":"UpdateWorkspaceRequest"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_workspaces_by_workspace_id","parameters":{"workspace_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastore","parameters":{"workspace_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastore","parameters":{"workspace_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"parameters_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastores_by_metastore_id","parameters":{"workspace_id":{"type":"string"},"metastore_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastores_by_metastore_id","parameters":{"workspace_id":{"type":"string"},"metastore_id":{"type":"string"},"data":{"type":"object","properties":{"metastore_assignment":{"$ref":"#/components/schemas/catalog.CreateMetastoreAssignment","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateMetastoreAssignment","x-databricks-legacy-name":"CreateMetastoreAssignment","x-databricks-stable-name":"CreateMetastoreAssignment"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AccountsCreateMetastoreAssignment","x-databricks-legacy-name":"AccountsCreateMetastoreAssignment","x-databricks-stable-name":"AccountsCreateMetastoreAssignment"}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastores_by_metastore_id","parameters":{"workspace_id":{"type":"string"},"metastore_id":{"type":"string"},"data":{"type":"object","properties":{"metastore_assignment":{"$ref":"#/components/schemas/catalog.UpdateMetastoreAssignment","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"UpdateMetastoreAssignment","x-databricks-legacy-name":"UpdateMetastoreAssignment","x-databricks-stable-name":"UpdateMetastoreAssignment"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AccountsUpdateMetastoreAssignment","x-databricks-legacy-name":"AccountsUpdateMetastoreAssignment","x-databricks-stable-name":"AccountsUpdateMetastoreAssignment"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_metastores_by_metastore_id","parameters":{"workspace_id":{"type":"string"},"metastore_id":{"type":"string"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_network","parameters":{"workspace_id":{"type":"integer","description":"The workspace ID."}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_network","parameters":{"workspace_id":{"type":"integer","description":"The workspace ID."},"data":{"type":"object","properties":{"network_policy_id":{"description":"The network policy ID to apply to the workspace. This controls the network access rules\nfor all serverless compute resources in the workspace. Each workspace can only be\nlinked to one policy at a time. If no policy is explicitly assigned,\nthe workspace will use 'default-policy'.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"accountslakenetmanager.WorkspaceNetworkOption.network_policy_id","example":"my-network-policy"},"workspace_id":{"description":"The workspace ID.","type":"integer","format":"int64","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"accountslakenetmanager.WorkspaceNetworkOption.workspace_id","example":1234567890}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"WorkspaceNetworkOption","x-databricks-legacy-name":"WorkspaceNetworkOption","x-databricks-stable-name":"WorkspaceNetworkOption"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_permissionassignments","parameters":{"workspace_id":{"type":"integer","description":"The workspace ID for the account."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_permissionassignments_permissions","parameters":{"workspace_id":{"type":"integer","description":"The workspace ID."}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_permissionassignments_principals_by_principal_id","parameters":{"workspace_id":{"type":"integer","description":"The workspace ID."},"principal_id":{"type":"integer","description":"The ID of the user, service principal, or group."},"data":{"type":"object","properties":{"permissions":{"description":"Array of permissions assignments to update on the workspace.\nValid values are \"USER\" and \"ADMIN\" (case-sensitive).\nIf both \"USER\" and \"ADMIN\" are provided, \"ADMIN\" takes precedence.\nOther values will be ignored.\nNote that excluding this field, or providing unsupported values, will have the same effect as providing an empty list, which will result in the deletion of all permissions for the principal.","type":"array","items":{"$ref":"#/components/schemas/iam.WorkspacePermission","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.permissionassignment.UpdateWorkspacePermissionAssignment.permissions.array_value","x-databricks-sdk-name":"WorkspacePermission","x-databricks-legacy-name":"WorkspacePermission","x-databricks-stable-name":"WorkspacePermission"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.permissionassignment.UpdateWorkspacePermissionAssignment.permissions"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateWorkspaceAssignments","x-databricks-legacy-name":"UpdateWorkspaceAssignments","x-databricks-stable-name":"UpdateWorkspaceAssignments"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_0_accounts_by_account_id_workspaces_by_workspace_id_permissionassignments_principals_by_principal_id","parameters":{"workspace_id":{"type":"integer","description":"The workspace ID for the account."},"principal_id":{"type":"integer","description":"The ID of the user, service principal, or group."}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_identity_accounts_by_account_id_groups_resolve_by_external_id","parameters":{"data":{"description":"Request message for resolving a group with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the group's groupname, and inherited parent groups.","type":"object","required":["external_id"],"properties":{"external_id":{"description":"Required. The external ID of the group in the customer's IdP.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.v2.ResolveGroupRequest.external_id"}},"x-databricks-package-name":"iamv2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ResolveGroupRequest","x-databricks-legacy-name":"ResolveGroupRequest","x-databricks-stable-name":"ResolveGroupRequest"}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_identity_accounts_by_account_id_service_principals_resolve_by_external_id","parameters":{"data":{"description":"Request message for resolving a service principal with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the service principal's displayname, status, and inherited parent groups.","type":"object","required":["external_id"],"properties":{"external_id":{"description":"Required. The external ID of the service principal in the customer's IdP.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.v2.ResolveServicePrincipalRequest.external_id"}},"x-databricks-package-name":"iamv2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ResolveServicePrincipalRequest","x-databricks-legacy-name":"ResolveServicePrincipalRequest","x-databricks-stable-name":"ResolveServicePrincipalRequest"}}},{"connectionName":"databricks-account","actionName":"post_api_2_0_identity_accounts_by_account_id_users_resolve_by_external_id","parameters":{"data":{"description":"Request message for resolving a user with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the user's displayname, status, and inherited parent groups.","type":"object","required":["external_id"],"properties":{"external_id":{"description":"Required. The external ID of the user in the customer's IdP.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.v2.ResolveUserRequest.external_id"}},"x-databricks-package-name":"iamv2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ResolveUserRequest","x-databricks-legacy-name":"ResolveUserRequest","x-databricks-stable-name":"ResolveUserRequest"}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_identity_accounts_by_account_id_workspaces_by_workspace_id_workspace_access_details_by_principal_id","parameters":{"workspace_id":{"type":"integer","description":"Required. The workspace ID for which the access details are being requested."},"principal_id":{"type":"integer","description":"Required. The internal ID of the principal (user/sp/group) for which the access details are being requested."},"view":{"type":"string","description":"Controls what fields are returned."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_preview_accounts_by_account_id_access_control_assignable_roles","parameters":{"resource":{"type":"string","description":"The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/` | A resource name for the account.\n`resource=accounts//groups/` | A resource name for the group.\n`resource=accounts//servicePrincipals/` | A resource name for the service principal."}}},{"connectionName":"databricks-account","actionName":"get_api_2_0_preview_accounts_by_account_id_access_control_rule_sets","parameters":{"name":{"type":"string","description":"The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts//ruleSets/default` | A name for a rule set on the account.\n`name=accounts//groups//ruleSets/default` | A name for a rule set on the group.\n`name=accounts//servicePrincipals//ruleSets/default` | A name for a rule set on the service principal."},"etag":{"type":"string","description":"Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -> modify -> write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated."}}},{"connectionName":"databricks-account","actionName":"put_api_2_0_preview_accounts_by_account_id_access_control_rule_sets","parameters":{"data":{"type":"object","required":["name","rule_set"],"properties":{"name":{"description":"Name of the rule set.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsaccesscontrol.external.UpdateRuleSetRequest.name"},"rule_set":{"$ref":"#/components/schemas/iam.RuleSetUpdateRequest","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsaccesscontrol.external.UpdateRuleSetRequest.rule_set","x-databricks-sdk-name":"RuleSetUpdateRequest","x-databricks-legacy-name":"RuleSetUpdateRequest","x-databricks-stable-name":"RuleSetUpdateRequest"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateRuleSetRequest","x-databricks-legacy-name":"UpdateRuleSetRequest","x-databricks-stable-name":"UpdateRuleSetRequest"}}},{"connectionName":"databricks-account","actionName":"get_api_2_1_accounts_by_account_id_budget_policies","parameters":{"page_size":{"type":"integer","description":"The maximum number of budget policies to return.\nIf unspecified, at most 100 budget policies will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000."},"page_token":{"type":"string","description":"A page token, received from a previous `ListServerlessPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match\nthe call that provided the page token."},"filter_by":{"type":"object","description":"A filter to apply to the list of policies."},"sort_spec":{"type":"object","description":"The sort specification."}}},{"connectionName":"databricks-account","actionName":"post_api_2_1_accounts_by_account_id_budget_policies","parameters":{"data":{"description":"A request to create a BudgetPolicy.","type":"object","properties":{"policy":{"description":"The policy to create. `policy_id` needs to be empty as it will be generated\n`policy_name` must be provided, custom_tags may need to be provided\ndepending on the cloud provider. All other fields are optional.","$ref":"#/components/schemas/billing.BudgetPolicy","x-databricks-package-name":"billing","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"budgetpolicy.CreateBudgetPolicyRequest.policy","x-databricks-sdk-name":"BudgetPolicy","x-databricks-legacy-name":"BudgetPolicy","x-databricks-stable-name":"BudgetPolicy"},"request_id":{"description":"A unique identifier for this request. Restricted to 36 ASCII characters.\nA random UUID is recommended.\nThis request is only idempotent if a `request_id` is provided.","type":"string","format":"^[\\w.-]+$","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","minLength":36,"maxLength":36,"x-databricks-schema-id":"budgetpolicy.CreateBudgetPolicyRequest.request_id"}},"x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateBudgetPolicyRequest","x-databricks-legacy-name":"CreateBudgetPolicyRequest","x-databricks-stable-name":"CreateBudgetPolicyRequest"}}},{"connectionName":"databricks-account","actionName":"get_api_2_1_accounts_by_account_id_budget_policies_by_policy_id","parameters":{"policy_id":{"type":"string","description":"The Id of the policy."}}},{"connectionName":"databricks-account","actionName":"patch_api_2_1_accounts_by_account_id_budget_policies_by_policy_id","parameters":{"policy_id":{"type":"string","description":"The Id of the policy. This field is generated by Databricks and globally unique."},"limit_config":{"type":"object","description":"DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy"},"data":{"description":"Contains the BudgetPolicy details.","type":"object","properties":{"binding_workspace_ids":{"description":"List of workspaces that this budget policy will be exclusively bound to.\nAn empty binding implies that this budget policy is open to any workspace in the account.","type":"array","items":{"type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.budgetpolicy.BudgetPolicy.binding_workspace_ids.array_value"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"budgetpolicy.BudgetPolicy.binding_workspace_ids"},"custom_tags":{"description":"A list of tags defined by the customer. At most 20 entries are allowed per policy.","type":"array","items":{"$ref":"#/components/schemas/compute.CustomPolicyTag","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.budgetpolicy.BudgetPolicy.custom_tags.array_value","x-databricks-sdk-name":"CustomPolicyTag","x-databricks-legacy-name":"CustomPolicyTag","x-databricks-stable-name":"CustomPolicyTag"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"budgetpolicy.BudgetPolicy.custom_tags"},"policy_id":{"description":"The Id of the policy. This field is generated by Databricks and globally unique.","x-databricks-computed":true,"type":"string","format":"^[\\w.-]+$","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","minLength":36,"maxLength":36,"x-databricks-schema-id":"budgetpolicy.BudgetPolicy.policy_id"},"policy_name":{"description":"The name of the policy.\n- Must be unique among active policies.\n- Can contain only characters from the ISO 8859-1 (latin1) set.\n- Can't start with reserved keywords such as `databricks:default-policy`.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","minLength":1,"maxLength":127,"x-databricks-schema-id":"budgetpolicy.BudgetPolicy.policy_name"}},"x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"BudgetPolicy","x-databricks-legacy-name":"BudgetPolicy","x-databricks-stable-name":"BudgetPolicy"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_1_accounts_by_account_id_budget_policies_by_policy_id","parameters":{"policy_id":{"type":"string","description":"The Id of the policy."}}},{"connectionName":"databricks-account","actionName":"get_api_2_1_accounts_by_account_id_budgets","parameters":{"page_token":{"type":"string","description":"A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page.\nRequests first page if absent."}}},{"connectionName":"databricks-account","actionName":"post_api_2_1_accounts_by_account_id_budgets","parameters":{"data":{"type":"object","required":["budget"],"properties":{"budget":{"description":"Properties of the new budget configuration.","$ref":"#/components/schemas/billing.CreateBudgetConfigurationBudget","x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-schema-id":"buiapiserver.CreateBudgetConfiguration.budget","x-databricks-sdk-name":"CreateBudgetConfigurationBudget","x-databricks-legacy-name":"CreateBudgetConfigurationBudget","x-databricks-stable-name":"CreateBudgetConfigurationBudget"}},"x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateBudgetConfigurationRequest","x-databricks-legacy-name":"CreateBudgetConfigurationRequest","x-databricks-stable-name":"CreateBudgetConfigurationRequest"}}},{"connectionName":"databricks-account","actionName":"get_api_2_1_accounts_by_account_id_budgets_by_budget_id","parameters":{"budget_id":{"type":"string","description":"The budget configuration ID"}}},{"connectionName":"databricks-account","actionName":"put_api_2_1_accounts_by_account_id_budgets_by_budget_id","parameters":{"budget_id":{"type":"string","description":"The Databricks budget configuration ID."},"data":{"type":"object","required":["budget"],"properties":{"budget":{"description":"The updated budget. This will overwrite the budget specified by the budget ID.","$ref":"#/components/schemas/billing.UpdateBudgetConfigurationBudget","x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-schema-id":"buiapiserver.UpdateBudgetConfiguration.budget","x-databricks-sdk-name":"UpdateBudgetConfigurationBudget","x-databricks-legacy-name":"UpdateBudgetConfigurationBudget","x-databricks-stable-name":"UpdateBudgetConfigurationBudget"}},"x-databricks-package-name":"billing","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateBudgetConfigurationRequest","x-databricks-legacy-name":"UpdateBudgetConfigurationRequest","x-databricks-stable-name":"UpdateBudgetConfigurationRequest"}}},{"connectionName":"databricks-account","actionName":"delete_api_2_1_accounts_by_account_id_budgets_by_budget_id","parameters":{"budget_id":{"type":"string","description":"The Databricks budget configuration ID."}}}],"slug":"databricks-account","created_at":"2025-09-25T18:49:39.461Z"},{"id":"databricks-workspace","name":"Databricks Workspace","description":"Connect to your Databricks Workspace to manage clusters, jobs, and notebooks.","logo_url":"https://assets.abstra.cloud/connectors/logos/databricks.png","category":[],"triggers":[],"actions":[{"connectionName":"databricks-workspace","actionName":"post_api_1_2_commands_cancel","parameters":{"data":{"type":"object","properties":{"clusterId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"cluster_id","x-databricks-schema-id":"dataplanerouter.commandexecution.CancelCommandRequest.cluster_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"commandId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"command_id","x-databricks-schema-id":"dataplanerouter.commandexecution.CancelCommandRequest.command_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"contextId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"context_id","x-databricks-schema-id":"dataplanerouter.commandexecution.CancelCommandRequest.context_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CancelCommand","x-databricks-legacy-name":"CancelCommand","x-databricks-stable-name":"CancelCommand"}}},{"connectionName":"databricks-workspace","actionName":"post_api_1_2_commands_execute","parameters":{"data":{"type":"object","properties":{"clusterId":{"description":"Running cluster id","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"cluster_id","x-databricks-schema-id":"dataplanerouter.commandexecution.ExecuteCommandRequest.cluster_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"command":{"description":"Executable code","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"command","x-databricks-schema-id":"dataplanerouter.commandexecution.ExecuteCommandRequest.command","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"contextId":{"description":"Running context id","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"context_id","x-databricks-schema-id":"dataplanerouter.commandexecution.ExecuteCommandRequest.context_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"language":{"$ref":"#/components/schemas/compute.Language","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"dataplanerouter.commandexecution.ExecuteCommandRequest.language","x-databricks-sdk-name":"Language","x-databricks-legacy-name":"Language","x-databricks-stable-name":"Language"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Command","x-databricks-legacy-name":"Command","x-databricks-stable-name":"Command"}}},{"connectionName":"databricks-workspace","actionName":"get_api_1_2_commands_status","parameters":{"clusterId":{"type":"string"},"contextId":{"type":"string"},"commandId":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_1_2_contexts_create","parameters":{"data":{"type":"object","properties":{"clusterId":{"description":"Running cluster id","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"cluster_id","x-databricks-schema-id":"dataplanerouter.commandexecution.CreateContextRequest.cluster_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"language":{"$ref":"#/components/schemas/compute.Language","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"dataplanerouter.commandexecution.CreateContextRequest.language","x-databricks-sdk-name":"Language","x-databricks-legacy-name":"Language","x-databricks-stable-name":"Language"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateContext","x-databricks-legacy-name":"CreateContext","x-databricks-stable-name":"CreateContext"}}},{"connectionName":"databricks-workspace","actionName":"post_api_1_2_contexts_destroy","parameters":{"data":{"type":"object","required":["clusterId","contextId"],"properties":{"clusterId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"cluster_id","x-databricks-schema-id":"dataplanerouter.commandexecution.DestroyContextRequest.cluster_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"contextId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"context_id","x-databricks-schema-id":"dataplanerouter.commandexecution.DestroyContextRequest.context_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DestroyContext","x-databricks-legacy-name":"DestroyContext","x-databricks-stable-name":"DestroyContext"}}},{"connectionName":"databricks-workspace","actionName":"get_api_1_2_contexts_status","parameters":{"clusterId":{"type":"string"},"contextId":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_accounts_service_principals_by_service_principal_id_credentials_secrets","parameters":{"service_principal_id":{"type":"string","description":"The service principal ID."},"page_token":{"type":"string","description":"An opaque page token which was the `next_page_token` in the response of the previous request to list the secrets for this service principal. Provide this token to retrieve the next page of secret entries.\nWhen providing a `page_token`, all other parameters provided to the request must match the previous request.\nTo list all of the secrets for a service principal, it is necessary to continue requesting pages of entries until the response contains no `next_page_token`. Note that the number of entries returned must not be used to determine when the listing is complete."},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_accounts_service_principals_by_service_principal_id_credentials_secrets","parameters":{"service_principal_id":{"type":"string","description":"The service principal ID."},"data":{"type":"object","properties":{"lifetime":{"description":"The lifetime of the secret in seconds. If this parameter is not provided, the secret will have a default lifetime of 730 days (63072000s).","type":"string","format":"duration","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.CreateServicePrincipalSecret.lifetime","x-databricks-well-known-type":"google.protobuf.Duration","example":"31536000s"}},"x-databricks-package-name":"oauth2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateServicePrincipalSecretRequest","x-databricks-legacy-name":"CreateServicePrincipalSecretRequest","x-databricks-stable-name":"CreateServicePrincipalSecretRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_accounts_service_principals_by_service_principal_id_credentials_secrets_by_secret_id","parameters":{"service_principal_id":{"type":"string","description":"The service principal ID."},"secret_id":{"type":"string","description":"The secret ID."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_alerts","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_alerts","parameters":{"data":{"type":"object","properties":{"create_time":{"description":"The timestamp indicating when the alert was created.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"custom_description":{"description":"Custom description for the alert. support mustache template.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.custom_description"},"custom_summary":{"description":"Custom summary for the alert. support mustache template.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.custom_summary"},"display_name":{"description":"The display name of the alert.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-name":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.display_name","example":"Example alert"},"effective_run_as":{"description":"The actual identity that will be used to execute the alert.\nThis is an output-only field that shows the resolved run-as identity after applying\npermissions and defaults.","$ref":"#/components/schemas/sql.AlertV2RunAs","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.effective_run_as","x-databricks-sdk-name":"AlertV2RunAs","x-databricks-legacy-name":"AlertV2RunAs","x-databricks-stable-name":"AlertV2RunAs"},"evaluation":{"$ref":"#/components/schemas/sql.AlertV2Evaluation","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.evaluation","x-databricks-sdk-name":"AlertV2Evaluation","x-databricks-legacy-name":"AlertV2Evaluation","x-databricks-stable-name":"AlertV2Evaluation"},"id":{"description":"UUID identifying the alert.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-id":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.id","example":"fe25e731-92f2-4838-9fb2-1ca364320a3d"},"lifecycle_state":{"description":"Indicates whether the query is trashed.","$ref":"#/components/schemas/sql.LifecycleState","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.lifecycle_state","x-databricks-sdk-name":"LifecycleState","x-databricks-legacy-name":"LifecycleState","x-databricks-stable-name":"LifecycleState"},"owner_user_name":{"description":"The owner's username. This field is set to \"Unavailable\" if the user has been deleted.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.owner_user_name","example":"user@acme.com"},"parent_path":{"description":"The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.parent_path","example":"/Users/user@acme.com"},"query_text":{"description":"Text of the query to be run.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.query_text","example":"SELECT 1"},"run_as":{"description":"Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user.","$ref":"#/components/schemas/sql.AlertV2RunAs","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.run_as","x-databricks-sdk-name":"AlertV2RunAs","x-databricks-legacy-name":"AlertV2RunAs","x-databricks-stable-name":"AlertV2RunAs"},"run_as_user_name":{"description":"The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.run_as_user_name","example":"user@acme.com"},"schedule":{"$ref":"#/components/schemas/sql.CronSchedule","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.schedule","x-databricks-sdk-name":"CronSchedule","x-databricks-legacy-name":"CronSchedule","x-databricks-stable-name":"CronSchedule"},"update_time":{"description":"The timestamp indicating when the alert was updated.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"warehouse_id":{"description":"ID of the SQL warehouse attached to the alert.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.warehouse_id","example":"a7066a8ef796be84"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"AlertV2","x-databricks-legacy-name":"AlertV2","x-databricks-stable-name":"AlertV2"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_alerts_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_alerts_by_id","parameters":{"id":{"type":"string","description":"UUID identifying the alert."},"update_mask":{"type":"string"},"data":{"type":"object","properties":{"create_time":{"description":"The timestamp indicating when the alert was created.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"custom_description":{"description":"Custom description for the alert. support mustache template.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.custom_description"},"custom_summary":{"description":"Custom summary for the alert. support mustache template.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.custom_summary"},"display_name":{"description":"The display name of the alert.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-name":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.display_name","example":"Example alert"},"effective_run_as":{"description":"The actual identity that will be used to execute the alert.\nThis is an output-only field that shows the resolved run-as identity after applying\npermissions and defaults.","$ref":"#/components/schemas/sql.AlertV2RunAs","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.effective_run_as","x-databricks-sdk-name":"AlertV2RunAs","x-databricks-legacy-name":"AlertV2RunAs","x-databricks-stable-name":"AlertV2RunAs"},"evaluation":{"$ref":"#/components/schemas/sql.AlertV2Evaluation","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.evaluation","x-databricks-sdk-name":"AlertV2Evaluation","x-databricks-legacy-name":"AlertV2Evaluation","x-databricks-stable-name":"AlertV2Evaluation"},"id":{"description":"UUID identifying the alert.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-id":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.id","example":"fe25e731-92f2-4838-9fb2-1ca364320a3d"},"lifecycle_state":{"description":"Indicates whether the query is trashed.","$ref":"#/components/schemas/sql.LifecycleState","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.lifecycle_state","x-databricks-sdk-name":"LifecycleState","x-databricks-legacy-name":"LifecycleState","x-databricks-stable-name":"LifecycleState"},"owner_user_name":{"description":"The owner's username. This field is set to \"Unavailable\" if the user has been deleted.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.owner_user_name","example":"user@acme.com"},"parent_path":{"description":"The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.parent_path","example":"/Users/user@acme.com"},"query_text":{"description":"Text of the query to be run.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.query_text","example":"SELECT 1"},"run_as":{"description":"Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user.","$ref":"#/components/schemas/sql.AlertV2RunAs","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.run_as","x-databricks-sdk-name":"AlertV2RunAs","x-databricks-legacy-name":"AlertV2RunAs","x-databricks-stable-name":"AlertV2RunAs"},"run_as_user_name":{"description":"The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.run_as_user_name","example":"user@acme.com"},"schedule":{"$ref":"#/components/schemas/sql.CronSchedule","x-databricks-package-name":"sql","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.schedule","x-databricks-sdk-name":"CronSchedule","x-databricks-legacy-name":"CronSchedule","x-databricks-stable-name":"CronSchedule"},"update_time":{"description":"The timestamp indicating when the alert was updated.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"redashv2.alertsv2.external.Alert.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"warehouse_id":{"description":"ID of the SQL warehouse attached to the alert.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.alertsv2.external.Alert.warehouse_id","example":"a7066a8ef796be84"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"AlertV2","x-databricks-legacy-name":"AlertV2","x-databricks-stable-name":"AlertV2"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_alerts_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_apps","parameters":{"page_token":{"type":"string","description":"Pagination token to go to the next page of apps. Requests first page if absent."},"page_size":{"type":"integer","description":"Upper bound for items returned."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_apps","parameters":{"no_compute":{"type":"boolean","description":"If true, the app will not be started after creation."},"data":{"type":"object","required":["name"],"properties":{"active_deployment":{"description":"The active deployment of the app. A deployment is considered active when it has been deployed\nto the app compute.","$ref":"#/components/schemas/apps.AppDeployment","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.active_deployment","x-databricks-sdk-name":"AppDeployment","x-databricks-legacy-name":"AppDeployment","x-databricks-stable-name":"AppDeployment"},"app_status":{"$ref":"#/components/schemas/apps.ApplicationStatus","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.app_status","x-databricks-sdk-name":"ApplicationStatus","x-databricks-legacy-name":"ApplicationStatus","x-databricks-stable-name":"ApplicationStatus"},"budget_policy_id":{"type":"string","format":"uuid","x-databricks-api-version":"legacy","minLength":36,"maxLength":36,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.budget_policy_id"},"compute_status":{"$ref":"#/components/schemas/apps.ComputeStatus","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.compute_status","x-databricks-sdk-name":"ComputeStatus","x-databricks-legacy-name":"ComputeStatus","x-databricks-stable-name":"ComputeStatus"},"create_time":{"description":"The creation time of the app. Formatted timestamp in ISO 6801.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"creator":{"description":"The email of the user that created the app.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.creator","example":"user@test.com"},"default_source_code_path":{"description":"The default workspace file system path of the source code from which app deployment are\ncreated. This field tracks the workspace source code path of the last active deployment.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.default_source_code_path","example":"/Workspace/user@test.com/my_custom_app"},"description":{"description":"The description of the app.","type":"string","x-databricks-api-version":"legacy","maxLength":500,"x-databricks-schema-id":"appsv1.App.description","example":"My app description."},"effective_budget_policy_id":{"x-databricks-computed":true,"type":"string","format":"uuid","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.effective_budget_policy_id"},"effective_user_api_scopes":{"description":"The effective api scopes granted to the user access token.","x-databricks-computed":true,"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.appsv1.App.effective_user_api_scopes.array_value"},"x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.effective_user_api_scopes"},"id":{"description":"The unique identifier of the app.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.id"},"name":{"description":"The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.","type":"string","x-databricks-api-version":"legacy","minLength":2,"maxLength":30,"x-databricks-schema-id":"appsv1.App.name","example":"my-custom-app"},"oauth2_app_client_id":{"x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.oauth2_app_client_id"},"oauth2_app_integration_id":{"x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.oauth2_app_integration_id"},"pending_deployment":{"description":"The pending deployment of the app. A deployment is considered pending when it is being prepared\nfor deployment to the app compute.","$ref":"#/components/schemas/apps.AppDeployment","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.pending_deployment","x-databricks-sdk-name":"AppDeployment","x-databricks-legacy-name":"AppDeployment","x-databricks-stable-name":"AppDeployment"},"resources":{"description":"Resources for the app.","type":"array","items":{"$ref":"#/components/schemas/apps.AppResource","x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.appsv1.App.resources.array_value","x-databricks-sdk-name":"AppResource","x-databricks-legacy-name":"AppResource","x-databricks-stable-name":"AppResource"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"appsv1.App.resources"},"service_principal_client_id":{"x-databricks-computed":true,"type":"string","format":"uuid","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.service_principal_client_id"},"service_principal_id":{"x-databricks-computed":true,"type":"integer","format":"int64","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.service_principal_id"},"service_principal_name":{"x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.service_principal_name"},"update_time":{"description":"The update time of the app. Formatted timestamp in ISO 6801.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"updater":{"description":"The email of the user that last updated the app.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.updater","example":"user@test.com"},"url":{"description":"The URL of the app once it is deployed.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.url","example":"my-custom-app-123.cloud.databricksapps.com"},"user_api_scopes":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.appsv1.App.user_api_scopes.array_value"},"x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.user_api_scopes"}},"x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"App","x-databricks-legacy-name":"App","x-databricks-stable-name":"App"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_apps_by_app_name_deployments","parameters":{"app_name":{"type":"string","description":"The name of the app."},"page_token":{"type":"string","description":"Pagination token to go to the next page of apps. Requests first page if absent."},"page_size":{"type":"integer","description":"Upper bound for items returned."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_apps_by_app_name_deployments","parameters":{"app_name":{"type":"string","description":"The name of the app."},"data":{"type":"object","properties":{"create_time":{"description":"The creation time of the deployment. Formatted timestamp in ISO 6801.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.AppDeployment.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"creator":{"description":"The email of the user creates the deployment.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.AppDeployment.creator","example":"user@test.com"},"deployment_artifacts":{"description":"The deployment artifacts for an app.","$ref":"#/components/schemas/apps.AppDeploymentArtifacts","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.AppDeployment.deployment_artifacts","x-databricks-sdk-name":"AppDeploymentArtifacts","x-databricks-legacy-name":"AppDeploymentArtifacts","x-databricks-stable-name":"AppDeploymentArtifacts"},"deployment_id":{"description":"The unique id of the deployment.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"appsv1.AppDeployment.deployment_id","example":"01ef0bda89f21f08a8351f41e4a9b948"},"mode":{"description":"The mode of which the deployment will manage the source code.","$ref":"#/components/schemas/apps.AppDeploymentMode","x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-schema-id":"appsv1.AppDeployment.mode","x-databricks-sdk-name":"AppDeploymentMode","x-databricks-legacy-name":"AppDeploymentMode","x-databricks-stable-name":"AppDeploymentMode"},"source_code_path":{"description":"The workspace file system path of the source code used to create the app deployment. This is different from\n`deployment_artifacts.source_code_path`, which is the path used by the deployed app. The former refers\nto the original source code location of the app in the workspace during deployment creation, whereas\nthe latter provides a system generated stable snapshotted source code path used by the deployment.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"appsv1.AppDeployment.source_code_path","example":"/Workspace/user@test.com/my_custom_app"},"status":{"description":"Status and status message of the deployment","$ref":"#/components/schemas/apps.AppDeploymentStatus","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.AppDeployment.status","x-databricks-sdk-name":"AppDeploymentStatus","x-databricks-legacy-name":"AppDeploymentStatus","x-databricks-stable-name":"AppDeploymentStatus"},"update_time":{"description":"The update time of the deployment. Formatted timestamp in ISO 6801.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.AppDeployment.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"}},"x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"AppDeployment","x-databricks-legacy-name":"AppDeployment","x-databricks-stable-name":"AppDeployment"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_apps_by_app_name_deployments_by_deployment_id","parameters":{"app_name":{"type":"string","description":"The name of the app."},"deployment_id":{"type":"string","description":"The unique id of the deployment."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_apps_by_name","parameters":{"name":{"type":"string","description":"The name of the app."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_apps_by_name","parameters":{"name":{"type":"string","description":"The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace."},"data":{"type":"object","required":["name"],"properties":{"active_deployment":{"description":"The active deployment of the app. A deployment is considered active when it has been deployed\nto the app compute.","$ref":"#/components/schemas/apps.AppDeployment","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.active_deployment","x-databricks-sdk-name":"AppDeployment","x-databricks-legacy-name":"AppDeployment","x-databricks-stable-name":"AppDeployment"},"app_status":{"$ref":"#/components/schemas/apps.ApplicationStatus","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.app_status","x-databricks-sdk-name":"ApplicationStatus","x-databricks-legacy-name":"ApplicationStatus","x-databricks-stable-name":"ApplicationStatus"},"budget_policy_id":{"type":"string","format":"uuid","x-databricks-api-version":"legacy","minLength":36,"maxLength":36,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.budget_policy_id"},"compute_status":{"$ref":"#/components/schemas/apps.ComputeStatus","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.compute_status","x-databricks-sdk-name":"ComputeStatus","x-databricks-legacy-name":"ComputeStatus","x-databricks-stable-name":"ComputeStatus"},"create_time":{"description":"The creation time of the app. Formatted timestamp in ISO 6801.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"creator":{"description":"The email of the user that created the app.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.creator","example":"user@test.com"},"default_source_code_path":{"description":"The default workspace file system path of the source code from which app deployment are\ncreated. This field tracks the workspace source code path of the last active deployment.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.default_source_code_path","example":"/Workspace/user@test.com/my_custom_app"},"description":{"description":"The description of the app.","type":"string","x-databricks-api-version":"legacy","maxLength":500,"x-databricks-schema-id":"appsv1.App.description","example":"My app description."},"effective_budget_policy_id":{"x-databricks-computed":true,"type":"string","format":"uuid","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.effective_budget_policy_id"},"effective_user_api_scopes":{"description":"The effective api scopes granted to the user access token.","x-databricks-computed":true,"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.appsv1.App.effective_user_api_scopes.array_value"},"x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.effective_user_api_scopes"},"id":{"description":"The unique identifier of the app.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.id"},"name":{"description":"The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.","type":"string","x-databricks-api-version":"legacy","minLength":2,"maxLength":30,"x-databricks-schema-id":"appsv1.App.name","example":"my-custom-app"},"oauth2_app_client_id":{"x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.oauth2_app_client_id"},"oauth2_app_integration_id":{"x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.oauth2_app_integration_id"},"pending_deployment":{"description":"The pending deployment of the app. A deployment is considered pending when it is being prepared\nfor deployment to the app compute.","$ref":"#/components/schemas/apps.AppDeployment","x-databricks-computed":true,"x-databricks-package-name":"apps","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.pending_deployment","x-databricks-sdk-name":"AppDeployment","x-databricks-legacy-name":"AppDeployment","x-databricks-stable-name":"AppDeployment"},"resources":{"description":"Resources for the app.","type":"array","items":{"$ref":"#/components/schemas/apps.AppResource","x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.appsv1.App.resources.array_value","x-databricks-sdk-name":"AppResource","x-databricks-legacy-name":"AppResource","x-databricks-stable-name":"AppResource"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"appsv1.App.resources"},"service_principal_client_id":{"x-databricks-computed":true,"type":"string","format":"uuid","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.service_principal_client_id"},"service_principal_id":{"x-databricks-computed":true,"type":"integer","format":"int64","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.service_principal_id"},"service_principal_name":{"x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.service_principal_name"},"update_time":{"description":"The update time of the app. Formatted timestamp in ISO 6801.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"updater":{"description":"The email of the user that last updated the app.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.updater","example":"user@test.com"},"url":{"description":"The URL of the app once it is deployed.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"appsv1.App.url","example":"my-custom-app-123.cloud.databricksapps.com"},"user_api_scopes":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.appsv1.App.user_api_scopes.array_value"},"x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"appsv1.App.user_api_scopes"}},"x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"App","x-databricks-legacy-name":"App","x-databricks-stable-name":"App"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_apps_by_name","parameters":{"name":{"type":"string","description":"The name of the app."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_apps_by_name_start","parameters":{"name":{"type":"string","description":"The name of the app."},"data":{"type":"object","x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"StartAppRequest","x-databricks-legacy-name":"StartAppRequest","x-databricks-stable-name":"StartAppRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_apps_by_name_stop","parameters":{"name":{"type":"string","description":"The name of the app."},"data":{"type":"object","x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"StopAppRequest","x-databricks-legacy-name":"StopAppRequest","x-databricks-stable-name":"StopAppRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_clean_rooms","parameters":{"page_size":{"type":"integer","description":"Maximum number of clean rooms to return (i.e., the page length). Defaults to 100."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_clean_rooms","parameters":{"data":{"type":"object","properties":{"access_restricted":{"description":"Whether clean room access is restricted due to [CSP](https://docs.databricks.com/en/security/privacy/security-profile.html)","$ref":"#/components/schemas/cleanrooms.CleanRoomAccessRestricted","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoom.access_restricted","x-databricks-sdk-name":"CleanRoomAccessRestricted","x-databricks-legacy-name":"CleanRoomAccessRestricted","x-databricks-stable-name":"CleanRoomAccessRestricted"},"comment":{"type":"string","x-databricks-api-version":"legacy","maxLength":1000,"x-databricks-schema-id":"cleanroom.CleanRoom.comment","example":"This is a clean room for demo"},"created_at":{"description":"When the clean room was created, in epoch milliseconds.","type":"integer","format":"int64","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoom.created_at","example":1716424663321},"local_collaborator_alias":{"description":"The alias of the collaborator tied to the local clean room.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoom.local_collaborator_alias","example":"creator"},"name":{"description":"The name of the clean room.\nIt should follow [UC securable naming requirements](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements).","type":"string","x-databricks-field-behaviors":["IMMUTABLE"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoom.name","example":"test-clean-room1"},"output_catalog":{"description":"Output catalog of the clean room. It is an output only field. Output catalog is manipulated\nusing the separate CreateCleanRoomOutputCatalog API.","$ref":"#/components/schemas/cleanrooms.CleanRoomOutputCatalog","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoom.output_catalog","x-databricks-sdk-name":"CleanRoomOutputCatalog","x-databricks-legacy-name":"CleanRoomOutputCatalog","x-databricks-stable-name":"CleanRoomOutputCatalog"},"owner":{"description":"This is the Databricks username of the owner of the local clean room securable for permission management.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoom.owner","example":"alice@example.com"},"remote_detailed_info":{"description":"Central clean room details. During creation, users need to specify\ncloud_vendor, region, and collaborators.global_metastore_id.\nThis field will not be filled in the ListCleanRooms call.","$ref":"#/components/schemas/cleanrooms.CleanRoomRemoteDetail","x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoom.remote_detailed_info","x-databricks-sdk-name":"CleanRoomRemoteDetail","x-databricks-legacy-name":"CleanRoomRemoteDetail","x-databricks-stable-name":"CleanRoomRemoteDetail"},"status":{"description":"Clean room status.","$ref":"#/components/schemas/cleanrooms.CleanRoomStatusEnum","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoom.status","x-databricks-sdk-name":"CleanRoomStatusEnum","x-databricks-legacy-name":"CleanRoomStatusEnum","x-databricks-stable-name":"CleanRoomStatusEnum"},"updated_at":{"description":"When the clean room was last updated, in epoch milliseconds.","type":"integer","format":"int64","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoom.updated_at","example":1716424663321}},"x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CleanRoom","x-databricks-legacy-name":"CleanRoom","x-databricks-stable-name":"CleanRoom"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_clean_rooms_by_clean_room_name_assets","parameters":{"clean_room_name":{"type":"string","description":"Name of the clean room."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_clean_rooms_by_clean_room_name_assets","parameters":{"clean_room_name":{"type":"string","description":"The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses."},"data":{"description":"Metadata of the clean room asset","type":"object","required":["name","asset_type"],"properties":{"added_at":{"description":"When the asset is added to the clean room, in epoch milliseconds.","type":"integer","format":"int64","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomAsset.added_at","example":1716424663321},"asset_type":{"description":"The type of the asset.","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetAssetType","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.asset_type","x-databricks-sdk-name":"CleanRoomAssetAssetType","x-databricks-legacy-name":"CleanRoomAssetAssetType","x-databricks-stable-name":"CleanRoomAssetAssetType"},"clean_room_name":{"description":"The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.clean_room_name","example":"test-clean-room1"},"foreign_table":{"description":"Foreign table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetForeignTable","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.foreign_table","x-databricks-sdk-name":"CleanRoomAssetForeignTable","x-databricks-legacy-name":"CleanRoomAssetForeignTable","x-databricks-stable-name":"CleanRoomAssetForeignTable"},"foreign_table_local_details":{"description":"Local details for a foreign that are only available to its owner.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetForeignTableLocalDetails","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.foreign_table_local_details","x-databricks-sdk-name":"CleanRoomAssetForeignTableLocalDetails","x-databricks-legacy-name":"CleanRoomAssetForeignTableLocalDetails","x-databricks-stable-name":"CleanRoomAssetForeignTableLocalDetails"},"name":{"description":"A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.name","example":"creator.sales.products"},"notebook":{"description":"Notebook details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **NOTEBOOK_FILE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetNotebook","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.notebook","x-databricks-sdk-name":"CleanRoomAssetNotebook","x-databricks-legacy-name":"CleanRoomAssetNotebook","x-databricks-stable-name":"CleanRoomAssetNotebook"},"owner_collaborator_alias":{"description":"The alias of the collaborator who owns this asset","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomAsset.owner_collaborator_alias","example":"creator"},"status":{"description":"Status of the asset","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetStatusEnum","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomAsset.status","x-databricks-sdk-name":"CleanRoomAssetStatusEnum","x-databricks-legacy-name":"CleanRoomAssetStatusEnum","x-databricks-stable-name":"CleanRoomAssetStatusEnum"},"table":{"description":"Table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **TABLE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetTable","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.table","x-databricks-sdk-name":"CleanRoomAssetTable","x-databricks-legacy-name":"CleanRoomAssetTable","x-databricks-stable-name":"CleanRoomAssetTable"},"table_local_details":{"description":"Local details for a table that are only available to its owner.\nPresent if and only if **asset_type** is **TABLE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetTableLocalDetails","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.table_local_details","x-databricks-sdk-name":"CleanRoomAssetTableLocalDetails","x-databricks-legacy-name":"CleanRoomAssetTableLocalDetails","x-databricks-stable-name":"CleanRoomAssetTableLocalDetails"},"view":{"description":"View details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **VIEW**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetView","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.view","x-databricks-sdk-name":"CleanRoomAssetView","x-databricks-legacy-name":"CleanRoomAssetView","x-databricks-stable-name":"CleanRoomAssetView"},"view_local_details":{"description":"Local details for a view that are only available to its owner.\nPresent if and only if **asset_type** is **VIEW**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetViewLocalDetails","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.view_local_details","x-databricks-sdk-name":"CleanRoomAssetViewLocalDetails","x-databricks-legacy-name":"CleanRoomAssetViewLocalDetails","x-databricks-stable-name":"CleanRoomAssetViewLocalDetails"},"volume_local_details":{"description":"Local details for a volume that are only available to its owner.\nPresent if and only if **asset_type** is **VOLUME**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetVolumeLocalDetails","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.volume_local_details","x-databricks-sdk-name":"CleanRoomAssetVolumeLocalDetails","x-databricks-legacy-name":"CleanRoomAssetVolumeLocalDetails","x-databricks-stable-name":"CleanRoomAssetVolumeLocalDetails"}},"x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CleanRoomAsset","x-databricks-legacy-name":"CleanRoomAsset","x-databricks-stable-name":"CleanRoomAsset"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_clean_rooms_by_clean_room_name_assets_by_asset_type_by_name","parameters":{"clean_room_name":{"type":"string","description":"Name of the clean room."},"asset_type":{"type":"string","description":"The type of the asset."},"name":{"type":"string","description":"The fully qualified name of the asset, it is same as the name field in CleanRoomAsset."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_clean_rooms_by_clean_room_name_assets_by_asset_type_by_name","parameters":{"clean_room_name":{"type":"string","description":"Name of the clean room."},"asset_type":{"type":"string","description":"The type of the asset."},"name":{"type":"string","description":"A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name."},"data":{"description":"Metadata of the clean room asset","type":"object","required":["name","asset_type"],"properties":{"added_at":{"description":"When the asset is added to the clean room, in epoch milliseconds.","type":"integer","format":"int64","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomAsset.added_at","example":1716424663321},"asset_type":{"description":"The type of the asset.","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetAssetType","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.asset_type","x-databricks-sdk-name":"CleanRoomAssetAssetType","x-databricks-legacy-name":"CleanRoomAssetAssetType","x-databricks-stable-name":"CleanRoomAssetAssetType"},"clean_room_name":{"description":"The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.clean_room_name","example":"test-clean-room1"},"foreign_table":{"description":"Foreign table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetForeignTable","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.foreign_table","x-databricks-sdk-name":"CleanRoomAssetForeignTable","x-databricks-legacy-name":"CleanRoomAssetForeignTable","x-databricks-stable-name":"CleanRoomAssetForeignTable"},"foreign_table_local_details":{"description":"Local details for a foreign that are only available to its owner.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetForeignTableLocalDetails","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.foreign_table_local_details","x-databricks-sdk-name":"CleanRoomAssetForeignTableLocalDetails","x-databricks-legacy-name":"CleanRoomAssetForeignTableLocalDetails","x-databricks-stable-name":"CleanRoomAssetForeignTableLocalDetails"},"name":{"description":"A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.name","example":"creator.sales.products"},"notebook":{"description":"Notebook details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **NOTEBOOK_FILE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetNotebook","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.notebook","x-databricks-sdk-name":"CleanRoomAssetNotebook","x-databricks-legacy-name":"CleanRoomAssetNotebook","x-databricks-stable-name":"CleanRoomAssetNotebook"},"owner_collaborator_alias":{"description":"The alias of the collaborator who owns this asset","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomAsset.owner_collaborator_alias","example":"creator"},"status":{"description":"Status of the asset","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetStatusEnum","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomAsset.status","x-databricks-sdk-name":"CleanRoomAssetStatusEnum","x-databricks-legacy-name":"CleanRoomAssetStatusEnum","x-databricks-stable-name":"CleanRoomAssetStatusEnum"},"table":{"description":"Table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **TABLE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetTable","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.table","x-databricks-sdk-name":"CleanRoomAssetTable","x-databricks-legacy-name":"CleanRoomAssetTable","x-databricks-stable-name":"CleanRoomAssetTable"},"table_local_details":{"description":"Local details for a table that are only available to its owner.\nPresent if and only if **asset_type** is **TABLE**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetTableLocalDetails","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.table_local_details","x-databricks-sdk-name":"CleanRoomAssetTableLocalDetails","x-databricks-legacy-name":"CleanRoomAssetTableLocalDetails","x-databricks-stable-name":"CleanRoomAssetTableLocalDetails"},"view":{"description":"View details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **VIEW**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetView","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.view","x-databricks-sdk-name":"CleanRoomAssetView","x-databricks-legacy-name":"CleanRoomAssetView","x-databricks-stable-name":"CleanRoomAssetView"},"view_local_details":{"description":"Local details for a view that are only available to its owner.\nPresent if and only if **asset_type** is **VIEW**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetViewLocalDetails","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.view_local_details","x-databricks-sdk-name":"CleanRoomAssetViewLocalDetails","x-databricks-legacy-name":"CleanRoomAssetViewLocalDetails","x-databricks-stable-name":"CleanRoomAssetViewLocalDetails"},"volume_local_details":{"description":"Local details for a volume that are only available to its owner.\nPresent if and only if **asset_type** is **VOLUME**","$ref":"#/components/schemas/cleanrooms.CleanRoomAssetVolumeLocalDetails","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAsset.volume_local_details","x-databricks-sdk-name":"CleanRoomAssetVolumeLocalDetails","x-databricks-legacy-name":"CleanRoomAssetVolumeLocalDetails","x-databricks-stable-name":"CleanRoomAssetVolumeLocalDetails"}},"x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CleanRoomAsset","x-databricks-legacy-name":"CleanRoomAsset","x-databricks-stable-name":"CleanRoomAsset"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_clean_rooms_by_clean_room_name_assets_by_asset_type_by_name","parameters":{"clean_room_name":{"type":"string","description":"Name of the clean room."},"asset_type":{"type":"string","description":"The type of the asset."},"name":{"type":"string","description":"The fully qualified name of the asset, it is same as the name field in CleanRoomAsset."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_clean_rooms_by_clean_room_name_assets_by_asset_type_by_name_reviews","parameters":{"clean_room_name":{"type":"string","description":"Name of the clean room"},"asset_type":{"type":"string","description":"Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS."},"name":{"type":"string","description":"Name of the asset"},"data":{"type":"object","properties":{"notebook_review":{"$ref":"#/components/schemas/cleanrooms.NotebookVersionReview","x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CreateCleanRoomAssetReviewRequest.notebook_review","x-databricks-sdk-name":"NotebookVersionReview","x-databricks-legacy-name":"NotebookVersionReview","x-databricks-stable-name":"NotebookVersionReview"}},"x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateCleanRoomAssetReviewRequest","x-databricks-legacy-name":"CreateCleanRoomAssetReviewRequest","x-databricks-stable-name":"CreateCleanRoomAssetReviewRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_clean_rooms_by_clean_room_name_assets_by_asset_type_by_name_revisions","parameters":{"clean_room_name":{"type":"string","description":"Name of the clean room."},"asset_type":{"type":"string","description":"Asset type. Only NOTEBOOK_FILE is supported."},"name":{"type":"string","description":"Name of the asset."},"page_size":{"type":"integer","description":"Maximum number of asset revisions to return. Defaults to 10."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on the previous query."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_clean_rooms_by_clean_room_name_assets_by_asset_type_by_name_revisions_by_etag","parameters":{"clean_room_name":{"type":"string","description":"Name of the clean room."},"asset_type":{"type":"string","description":"Asset type. Only NOTEBOOK_FILE is supported."},"name":{"type":"string","description":"Name of the asset."},"etag":{"type":"string","description":"Revision etag to fetch. If not provided, the latest revision will be returned."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_clean_rooms_by_clean_room_name_auto_approval_rules","parameters":{"clean_room_name":{"type":"string"},"page_size":{"type":"integer","description":"Maximum number of auto-approval rules to return. Defaults to 100."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_clean_rooms_by_clean_room_name_auto_approval_rules","parameters":{"clean_room_name":{"type":"string","description":"The name of the clean room this auto-approval rule belongs to."},"data":{"type":"object","required":["auto_approval_rule"],"properties":{"auto_approval_rule":{"$ref":"#/components/schemas/cleanrooms.CleanRoomAutoApprovalRule","x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CreateCleanRoomAutoApprovalRuleRequest.auto_approval_rule","x-databricks-sdk-name":"CleanRoomAutoApprovalRule","x-databricks-legacy-name":"CleanRoomAutoApprovalRule","x-databricks-stable-name":"CleanRoomAutoApprovalRule"}},"x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateCleanRoomAutoApprovalRuleRequest","x-databricks-legacy-name":"CreateCleanRoomAutoApprovalRuleRequest","x-databricks-stable-name":"CreateCleanRoomAutoApprovalRuleRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_clean_rooms_by_clean_room_name_auto_approval_rules_by_rule_id","parameters":{"clean_room_name":{"type":"string"},"rule_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_clean_rooms_by_clean_room_name_auto_approval_rules_by_rule_id","parameters":{"clean_room_name":{"type":"string","description":"The name of the clean room this auto-approval rule belongs to."},"rule_id":{"type":"string","description":"A generated UUID identifying the rule."},"data":{"type":"object","properties":{"author_collaborator_alias":{"description":"Collaborator alias of the author covered by the rule.\nOnly one of `author_collaborator_alias` and `author_scope` can be set.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAutoApprovalRule.author_collaborator_alias"},"author_scope":{"description":"Scope of authors covered by the rule.\nOnly one of `author_collaborator_alias` and `author_scope` can be set.","$ref":"#/components/schemas/cleanrooms.CleanRoomAutoApprovalRuleAuthorScope","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAutoApprovalRule.author_scope","x-databricks-sdk-name":"CleanRoomAutoApprovalRuleAuthorScope","x-databricks-legacy-name":"CleanRoomAutoApprovalRuleAuthorScope","x-databricks-stable-name":"CleanRoomAutoApprovalRuleAuthorScope"},"clean_room_name":{"description":"The name of the clean room this auto-approval rule belongs to.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAutoApprovalRule.clean_room_name"},"created_at":{"description":"Timestamp of when the rule was created, in epoch milliseconds.","type":"integer","format":"int64","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomAutoApprovalRule.created_at"},"rule_id":{"description":"A generated UUID identifying the rule.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomAutoApprovalRule.rule_id"},"rule_owner_collaborator_alias":{"description":"The owner of the rule to whom the rule applies.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomAutoApprovalRule.rule_owner_collaborator_alias"},"runner_collaborator_alias":{"description":"Collaborator alias of the runner covered by the rule.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomAutoApprovalRule.runner_collaborator_alias"}},"x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CleanRoomAutoApprovalRule","x-databricks-legacy-name":"CleanRoomAutoApprovalRule","x-databricks-stable-name":"CleanRoomAutoApprovalRule"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_clean_rooms_by_clean_room_name_auto_approval_rules_by_rule_id","parameters":{"clean_room_name":{"type":"string"},"rule_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_clean_rooms_by_clean_room_name_output_catalogs","parameters":{"clean_room_name":{"type":"string","description":"Name of the clean room."},"data":{"type":"object","properties":{"catalog_name":{"description":"The name of the output catalog in UC.\nIt should follow [UC securable naming requirements](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements).\nThe field will always exist if status is CREATED.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.CleanRoomOutputCatalog.catalog_name"},"status":{"$ref":"#/components/schemas/cleanrooms.CleanRoomOutputCatalogOutputCatalogStatus","x-databricks-package-name":"cleanrooms","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"cleanroom.CleanRoomOutputCatalog.status","x-databricks-sdk-name":"CleanRoomOutputCatalogOutputCatalogStatus","x-databricks-legacy-name":"CleanRoomOutputCatalogOutputCatalogStatus","x-databricks-stable-name":"CleanRoomOutputCatalogOutputCatalogStatus"}},"x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CleanRoomOutputCatalog","x-databricks-legacy-name":"CleanRoomOutputCatalog","x-databricks-stable-name":"CleanRoomOutputCatalog"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_clean_rooms_by_clean_room_name_runs","parameters":{"clean_room_name":{"type":"string","description":"Name of the clean room."},"notebook_name":{"type":"string","description":"Notebook name"},"page_size":{"type":"integer","description":"The maximum number of task runs to return. Currently ignored - all runs will be returned."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_clean_rooms_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_clean_rooms_by_name","parameters":{"name":{"type":"string","description":"Name of the clean room."},"data":{"type":"object","properties":{"clean_room":{"$ref":"#/components/schemas/cleanrooms.CleanRoom","x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-schema-id":"cleanroom.UpdateCleanRoomRequest.clean_room","x-databricks-sdk-name":"CleanRoom","x-databricks-legacy-name":"CleanRoom","x-databricks-stable-name":"CleanRoom"}},"x-databricks-package-name":"cleanrooms","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateCleanRoomRequest","x-databricks-legacy-name":"UpdateCleanRoomRequest","x-databricks-stable-name":"UpdateCleanRoomRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_clean_rooms_by_name","parameters":{"name":{"type":"string","description":"Name of the clean room."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_database_catalogs","parameters":{"data":{"type":"object","required":["name","database_instance_name","database_name"],"properties":{"create_database_if_not_exists":{"type":"boolean","x-databricks-field-behaviors":["INPUT_ONLY","OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseCatalog.create_database_if_not_exists"},"database_instance_name":{"description":"The name of the DatabaseInstance housing the database.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseCatalog.database_instance_name"},"database_name":{"description":"The name of the database (in a instance) associated with the catalog.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseCatalog.database_name"},"name":{"description":"The name of the catalog in UC.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseCatalog.name"},"uid":{"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseCatalog.uid"}},"x-databricks-package-name":"database","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DatabaseCatalog","x-databricks-legacy-name":"DatabaseCatalog","x-databricks-stable-name":"DatabaseCatalog"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_database_catalogs_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_database_catalogs_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_database_credentials","parameters":{"data":{"description":"Generates a credential that can be used to access database instances","type":"object","properties":{"claims":{"description":"The returned token will be scoped to the union of instance_names and instances containing\nthe specified UC tables, so instance_names is allowed to be empty.","type":"array","items":{"$ref":"#/components/schemas/database.RequestedClaims","x-databricks-package-name":"database","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.brickstore.scheduler.GenerateDatabaseCredentialRequest.claims.array_value","x-databricks-sdk-name":"RequestedClaims","x-databricks-legacy-name":"RequestedClaims","x-databricks-stable-name":"RequestedClaims"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.GenerateDatabaseCredentialRequest.claims"},"instance_names":{"description":"Instances to which the token will be scoped.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.brickstore.scheduler.GenerateDatabaseCredentialRequest.instance_names.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.GenerateDatabaseCredentialRequest.instance_names"},"request_id":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.GenerateDatabaseCredentialRequest.request_id"}},"x-databricks-package-name":"database","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"GenerateDatabaseCredentialRequest","x-databricks-legacy-name":"GenerateDatabaseCredentialRequest","x-databricks-stable-name":"GenerateDatabaseCredentialRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_database_instances","parameters":{"page_token":{"type":"string","description":"Pagination token to go to the next page of Database Instances. Requests first page if absent."},"page_size":{"type":"integer","description":"Upper bound for items returned."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_database_instances","parameters":{"data":{"description":"A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.","type":"object","required":["name"],"properties":{"capacity":{"description":"The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.capacity"},"child_instance_refs":{"description":"The refs of the child instances. This is only available if the instance is\nparent instance.","type":"array","items":{"$ref":"#/components/schemas/database.DatabaseInstanceRef","x-databricks-package-name":"database","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.brickstore.scheduler.DatabaseInstance.child_instance_refs.array_value","x-databricks-sdk-name":"DatabaseInstanceRef","x-databricks-legacy-name":"DatabaseInstanceRef","x-databricks-stable-name":"DatabaseInstanceRef"},"x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.child_instance_refs"},"creation_time":{"description":"The timestamp when the instance was created.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.creation_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"creator":{"description":"The email of the creator of the instance.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.creator"},"effective_enable_pg_native_login":{"description":"xref AIP-129. `enable_pg_native_login` is owned by the client, while `effective_enable_pg_native_login` is owned by the server.\n`enable_pg_native_login` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_enable_pg_native_login` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"boolean","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_enable_pg_native_login"},"effective_enable_readable_secondaries":{"description":"xref AIP-129. `enable_readable_secondaries` is owned by the client, while `effective_enable_readable_secondaries` is owned by the server.\n`enable_readable_secondaries` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_enable_readable_secondaries` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"boolean","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_enable_readable_secondaries"},"effective_node_count":{"description":"xref AIP-129. `node_count` is owned by the client, while `effective_node_count` is owned by the server.\n`node_count` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_node_count` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"integer","format":"int32","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_node_count"},"effective_retention_window_in_days":{"description":"xref AIP-129. `retention_window_in_days` is owned by the client, while `effective_retention_window_in_days` is owned by the server.\n`retention_window_in_days` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_retention_window_in_days` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"integer","format":"int32","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_retention_window_in_days"},"effective_stopped":{"description":"xref AIP-129. `stopped` is owned by the client, while `effective_stopped` is owned by the server.\n`stopped` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_stopped` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"boolean","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_stopped"},"enable_pg_native_login":{"description":"Whether the instance has PG native password login enabled. Defaults to true.","type":"boolean","x-databricks-field-behaviors":["OPTIONAL","INPUT_ONLY"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.enable_pg_native_login"},"enable_readable_secondaries":{"description":"Whether to enable secondaries to serve read-only traffic. Defaults to false.","type":"boolean","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.enable_readable_secondaries"},"name":{"description":"The name of the instance. This is the unique identifier for the instance.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.name"},"node_count":{"description":"The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries.","type":"integer","format":"int32","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.node_count"},"parent_instance_ref":{"description":"The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.","$ref":"#/components/schemas/database.DatabaseInstanceRef","x-databricks-package-name":"database","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.parent_instance_ref","x-databricks-sdk-name":"DatabaseInstanceRef","x-databricks-legacy-name":"DatabaseInstanceRef","x-databricks-stable-name":"DatabaseInstanceRef"},"pg_version":{"description":"The version of Postgres running on the instance.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.pg_version"},"read_only_dns":{"description":"The DNS endpoint to connect to the instance for read only access. This is only available if\nenable_readable_secondaries is true.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.read_only_dns"},"read_write_dns":{"description":"The DNS endpoint to connect to the instance for read+write access.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.read_write_dns"},"retention_window_in_days":{"description":"The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days.","type":"integer","format":"int32","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.retention_window_in_days"},"state":{"description":"The current state of the instance.","$ref":"#/components/schemas/database.DatabaseInstanceState","x-databricks-package-name":"database","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.state","x-databricks-sdk-name":"DatabaseInstanceState","x-databricks-legacy-name":"DatabaseInstanceState","x-databricks-stable-name":"DatabaseInstanceState"},"stopped":{"description":"Whether the instance is stopped.","type":"boolean","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.stopped"},"uid":{"description":"An immutable UUID identifier for the instance.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.uid"}},"x-databricks-package-name":"database","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DatabaseInstance","x-databricks-legacy-name":"DatabaseInstance","x-databricks-stable-name":"DatabaseInstance"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_database_instances_by_name","parameters":{"name":{"type":"string","description":"Name of the cluster to get."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_database_instances_by_name","parameters":{"name":{"type":"string","description":"The name of the instance. This is the unique identifier for the instance."},"update_mask":{"type":"string","description":"The list of fields to update. If unspecified, all fields will be updated when possible. To wipe out custom_tags,\nspecify custom_tags in the update_mask with an empty custom_tags map."},"data":{"description":"A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.","type":"object","required":["name"],"properties":{"capacity":{"description":"The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.capacity"},"child_instance_refs":{"description":"The refs of the child instances. This is only available if the instance is\nparent instance.","type":"array","items":{"$ref":"#/components/schemas/database.DatabaseInstanceRef","x-databricks-package-name":"database","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.brickstore.scheduler.DatabaseInstance.child_instance_refs.array_value","x-databricks-sdk-name":"DatabaseInstanceRef","x-databricks-legacy-name":"DatabaseInstanceRef","x-databricks-stable-name":"DatabaseInstanceRef"},"x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.child_instance_refs"},"creation_time":{"description":"The timestamp when the instance was created.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.creation_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"creator":{"description":"The email of the creator of the instance.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.creator"},"effective_enable_pg_native_login":{"description":"xref AIP-129. `enable_pg_native_login` is owned by the client, while `effective_enable_pg_native_login` is owned by the server.\n`enable_pg_native_login` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_enable_pg_native_login` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"boolean","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_enable_pg_native_login"},"effective_enable_readable_secondaries":{"description":"xref AIP-129. `enable_readable_secondaries` is owned by the client, while `effective_enable_readable_secondaries` is owned by the server.\n`enable_readable_secondaries` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_enable_readable_secondaries` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"boolean","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_enable_readable_secondaries"},"effective_node_count":{"description":"xref AIP-129. `node_count` is owned by the client, while `effective_node_count` is owned by the server.\n`node_count` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_node_count` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"integer","format":"int32","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_node_count"},"effective_retention_window_in_days":{"description":"xref AIP-129. `retention_window_in_days` is owned by the client, while `effective_retention_window_in_days` is owned by the server.\n`retention_window_in_days` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_retention_window_in_days` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"integer","format":"int32","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_retention_window_in_days"},"effective_stopped":{"description":"xref AIP-129. `stopped` is owned by the client, while `effective_stopped` is owned by the server.\n`stopped` will only be set in Create/Update response messages if and only if the user provides the field via the request.\n`effective_stopped` on the other hand will always bet set in all response messages (Create/Update/Get/List).","type":"boolean","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.effective_stopped"},"enable_pg_native_login":{"description":"Whether the instance has PG native password login enabled. Defaults to true.","type":"boolean","x-databricks-field-behaviors":["OPTIONAL","INPUT_ONLY"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.enable_pg_native_login"},"enable_readable_secondaries":{"description":"Whether to enable secondaries to serve read-only traffic. Defaults to false.","type":"boolean","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.enable_readable_secondaries"},"name":{"description":"The name of the instance. This is the unique identifier for the instance.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.name"},"node_count":{"description":"The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries.","type":"integer","format":"int32","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.node_count"},"parent_instance_ref":{"description":"The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.","$ref":"#/components/schemas/database.DatabaseInstanceRef","x-databricks-package-name":"database","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.parent_instance_ref","x-databricks-sdk-name":"DatabaseInstanceRef","x-databricks-legacy-name":"DatabaseInstanceRef","x-databricks-stable-name":"DatabaseInstanceRef"},"pg_version":{"description":"The version of Postgres running on the instance.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.pg_version"},"read_only_dns":{"description":"The DNS endpoint to connect to the instance for read only access. This is only available if\nenable_readable_secondaries is true.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.read_only_dns"},"read_write_dns":{"description":"The DNS endpoint to connect to the instance for read+write access.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.read_write_dns"},"retention_window_in_days":{"description":"The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days.","type":"integer","format":"int32","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.retention_window_in_days"},"state":{"description":"The current state of the instance.","$ref":"#/components/schemas/database.DatabaseInstanceState","x-databricks-package-name":"database","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.state","x-databricks-sdk-name":"DatabaseInstanceState","x-databricks-legacy-name":"DatabaseInstanceState","x-databricks-stable-name":"DatabaseInstanceState"},"stopped":{"description":"Whether the instance is stopped.","type":"boolean","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.stopped"},"uid":{"description":"An immutable UUID identifier for the instance.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.DatabaseInstance.uid"}},"x-databricks-package-name":"database","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DatabaseInstance","x-databricks-legacy-name":"DatabaseInstance","x-databricks-stable-name":"DatabaseInstance"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_database_instances_by_name","parameters":{"name":{"type":"string","description":"Name of the instance to delete."},"force":{"type":"boolean","description":"By default, a instance cannot be deleted if it has descendant instances created via PITR. If\nthis flag is specified as true, all descendent instances will be deleted as well."},"purge":{"type":"boolean","description":"Note purge=false is in development. If false, the database instance is soft deleted (implementation pending).\nSoft deleted instances behave as if they are deleted, and cannot be used for CRUD operations nor connected to.\nHowever they can be undeleted by calling the undelete API for a limited time (implementation pending).\nIf true, the database instance is hard deleted and cannot be undeleted.\nFor the time being, setting this value to true is required to delete an instance (soft delete is not yet supported)."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_database_instances_find_by_uid","parameters":{"uid":{"type":"string","description":"UID of the cluster to get."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_database_synced_tables","parameters":{"data":{"description":"Next field marker: 14","type":"object","required":["name"],"properties":{"data_synchronization_status":{"description":"Synced Table data synchronization status","$ref":"#/components/schemas/database.SyncedTableStatus","x-databricks-package-name":"database","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.SyncedDatabaseTable.data_synchronization_status","x-databricks-sdk-name":"SyncedTableStatus","x-databricks-legacy-name":"SyncedTableStatus","x-databricks-stable-name":"SyncedTableStatus"},"database_instance_name":{"description":"Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).","type":"string","x-databricks-field-behaviors":["OPTIONAL","INPUT_ONLY"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.SyncedDatabaseTable.database_instance_name"},"effective_database_instance_name":{"description":"The name of the database instance that this table is registered to. This field is always returned, and for\ntables inside database catalogs is inferred database instance associated with the catalog.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.SyncedDatabaseTable.effective_database_instance_name"},"effective_logical_database_name":{"description":"The name of the logical database that this table is registered to.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.SyncedDatabaseTable.effective_logical_database_name"},"logical_database_name":{"description":"Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the `create_database_objects_is_missing` field in `spec`.","type":"string","x-databricks-field-behaviors":["OPTIONAL","INPUT_ONLY"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.SyncedDatabaseTable.logical_database_name"},"name":{"description":"Full three-part (catalog, schema, table) name of the table.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.SyncedDatabaseTable.name"},"spec":{"$ref":"#/components/schemas/database.SyncedTableSpec","x-databricks-package-name":"database","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.SyncedDatabaseTable.spec","x-databricks-sdk-name":"SyncedTableSpec","x-databricks-legacy-name":"SyncedTableSpec","x-databricks-stable-name":"SyncedTableSpec"},"unity_catalog_provisioning_state":{"description":"The provisioning state of the synced table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously).","$ref":"#/components/schemas/database.ProvisioningInfoState","x-databricks-package-name":"database","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.SyncedDatabaseTable.unity_catalog_provisioning_state","x-databricks-sdk-name":"ProvisioningInfoState","x-databricks-legacy-name":"ProvisioningInfoState","x-databricks-stable-name":"ProvisioningInfoState"}},"x-databricks-package-name":"database","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SyncedDatabaseTable","x-databricks-legacy-name":"SyncedDatabaseTable","x-databricks-stable-name":"SyncedDatabaseTable"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_database_synced_tables_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_database_synced_tables_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_database_tables","parameters":{"data":{"description":"Next field marker: 13","type":"object","required":["name"],"properties":{"database_instance_name":{"description":"Name of the target database instance. This is required when creating database tables in standard catalogs.\nThis is optional when creating database tables in registered catalogs. If this field is specified\nwhen creating database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseTable.database_instance_name"},"logical_database_name":{"description":"Target Postgres database object (logical database) name for this table.\n\nWhen creating a table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseTable.logical_database_name"},"name":{"description":"Full three-part (catalog, schema, table) name of the table.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.DatabaseTable.name"}},"x-databricks-package-name":"database","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DatabaseTable","x-databricks-legacy-name":"DatabaseTable","x-databricks-stable-name":"DatabaseTable"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_database_tables_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_database_tables_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_dbfs_add_block","parameters":{"data":{"type":"object","required":["handle","data"],"properties":{"data":{"description":"The base64-encoded data to append to the stream. This has a limit of 1 MB.","type":"string","format":"string","x-databricks-api-version":"legacy","x-databricks-base64":true,"x-databricks-schema-id":"dbfs.AddBlock.data"},"handle":{"description":"The handle on an open stream.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.AddBlock.handle"}},"x-databricks-package-name":"files","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"AddBlock","x-databricks-legacy-name":"AddBlock","x-databricks-stable-name":"AddBlock"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_dbfs_close","parameters":{"data":{"type":"object","required":["handle"],"properties":{"handle":{"description":"The handle on an open stream.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.Close.handle"}},"x-databricks-package-name":"files","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Close","x-databricks-legacy-name":"Close","x-databricks-stable-name":"Close"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_dbfs_create","parameters":{"data":{"type":"object","required":["path"],"properties":{"overwrite":{"description":"The flag that specifies whether to overwrite existing file/files.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.Create.overwrite","default":false},"path":{"description":"The path of the new file. The path should be the absolute DBFS path.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.Create.path","example":"/mnt/foo"}},"x-databricks-package-name":"files","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Create","x-databricks-legacy-name":"Create","x-databricks-stable-name":"Create"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_dbfs_delete","parameters":{"data":{"type":"object","required":["path"],"properties":{"path":{"description":"The path of the file or directory to delete. The path should be the absolute DBFS path.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.Delete.path","example":"/mnt/foo"},"recursive":{"description":"Whether or not to recursively delete the directory's contents. Deleting empty directories can be done without providing the recursive flag.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.Delete.recursive","default":false}},"x-databricks-package-name":"files","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Delete","x-databricks-legacy-name":"Delete","x-databricks-stable-name":"Delete"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_dbfs_get_status","parameters":{"path":{"type":"string","description":"The path of the file or directory. The path should be the absolute DBFS path."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_dbfs_list","parameters":{"path":{"type":"string","description":"The path of the file or directory. The path should be the absolute DBFS path."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_dbfs_mkdirs","parameters":{"data":{"type":"object","required":["path"],"properties":{"path":{"description":"The path of the new directory. The path should be the absolute DBFS path.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.MkDirs.path","example":"/mnt/foo"}},"x-databricks-package-name":"files","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"MkDirs","x-databricks-legacy-name":"MkDirs","x-databricks-stable-name":"MkDirs"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_dbfs_move","parameters":{"data":{"type":"object","required":["source_path","destination_path"],"properties":{"destination_path":{"description":"The destination path of the file or directory. The path should be the absolute DBFS path.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.Move.destination_path","example":"/mnt/bar"},"source_path":{"description":"The source path of the file or directory. The path should be the absolute DBFS path.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.Move.source_path","example":"/mnt/foo"}},"x-databricks-package-name":"files","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Move","x-databricks-legacy-name":"Move","x-databricks-stable-name":"Move"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_dbfs_put","parameters":{"data":{"type":"object","required":["path"],"properties":{"contents":{"description":"This parameter might be absent, and instead a posted file will be used.","type":"string","format":"string","x-databricks-api-version":"legacy","x-databricks-base64":true,"x-databricks-schema-id":"dbfs.Put.contents"},"overwrite":{"description":"The flag that specifies whether to overwrite existing file/files.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.Put.overwrite","default":false},"path":{"description":"The path of the new file. The path should be the absolute DBFS path.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"dbfs.Put.path","example":"/mnt/foo"}},"x-databricks-package-name":"files","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Put","x-databricks-legacy-name":"Put","x-databricks-stable-name":"Put"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_dbfs_read","parameters":{"path":{"type":"string","description":"The path of the file to read. The path should be the absolute DBFS path."},"offset":{"type":"integer","description":"The offset to read from in bytes."},"length":{"type":"integer","description":"The number of bytes to read starting from the offset. This has a limit of 1 MB, and a default\nvalue of 0.5 MB."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_fs_directoriesby_directory_path","parameters":{"directory_path":{"type":"string","description":"The absolute path of a directory."},"page_size":{"type":"integer","description":"The maximum number of directory entries to return. The response may contain fewer\nentries. If the response contains a `next_page_token`, there may be more entries,\neven if fewer than `page_size` entries are in the response.\n\nWe recommend not to set this value unless you are intentionally listing less than\nthe complete directory contents.\n\nIf unspecified, at most 1000 directory entries will be returned.\nThe maximum value is 1000. Values above 1000 will be coerced to 1000."},"page_token":{"type":"string","description":"An opaque page token which was the `next_page_token` in the response of the previous\nrequest to list the contents of this directory. Provide this token to retrieve the\nnext page of directory entries.\nWhen providing a `page_token`, all other parameters provided to the request must match\nthe previous request.\nTo list all of the entries in a directory, it is necessary to continue requesting\npages of entries until the response contains no `next_page_token`. Note that the\nnumber of entries returned must not be used to determine when the listing is complete."}}},{"connectionName":"databricks-workspace","actionName":"head_api_2_0_fs_directoriesby_directory_path","parameters":{"directory_path":{"type":"string","description":"The absolute path of a directory."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_fs_directoriesby_directory_path","parameters":{"directory_path":{"type":"string","description":"The absolute path of a directory."}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_fs_directoriesby_directory_path","parameters":{"directory_path":{"type":"string","description":"The absolute path of a directory."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_fs_filesby_file_path","parameters":{"file_path":{"type":"string","description":"The absolute path of the file."},"Range":{"type":"string","description":"The range of bytes to retrieve.\nThe range is inclusive and zero-based, see\n[RFC 9110](https://datatracker.ietf.org/doc/html/rfc9110#name-range) for further details."},"If-Unmodified-Since":{"type":"string","description":"Download the file only if it has not been modified since the specified timestamp.\nIf it has, a 412 Precondition Failed error will be returned.\nSee [RFC 9110](https://datatracker.ietf.org/doc/html/rfc9110#name-if-unmodified-since) for further details."}}},{"connectionName":"databricks-workspace","actionName":"head_api_2_0_fs_filesby_file_path","parameters":{"file_path":{"type":"string","description":"The absolute path of the file."},"Range":{"type":"string","description":"The range of bytes to retrieve.\nThe range is inclusive and zero-based, see\n[RFC 9110](https://datatracker.ietf.org/doc/html/rfc9110#name-range) for further details."},"If-Unmodified-Since":{"type":"string","description":"Download the file only if it has not been modified since the specified timestamp.\nIf it has, a 412 Precondition Failed error will be returned.\nSee [RFC 9110](https://datatracker.ietf.org/doc/html/rfc9110#name-if-unmodified-since) for further details."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_fs_filesby_file_path","parameters":{"file_path":{"type":"string","description":"The absolute path of the file."},"overwrite":{"type":"boolean","description":"If true or unspecified, an existing file will be overwritten. If false, an error will be returned if the path points to an existing file."}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_fs_filesby_file_path","parameters":{"file_path":{"type":"string","description":"The absolute path of the file."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_genie_spaces","parameters":{"page_size":{"type":"integer","description":"Maximum number of spaces to return per page"},"page_token":{"type":"string","description":"Pagination token for getting the next page of results"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_genie_spaces_by_space_id","parameters":{"space_id":{"type":"string","description":"The ID associated with the Genie space"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_genie_spaces_by_space_id","parameters":{"space_id":{"type":"string","description":"The ID associated with the Genie space to be sent to the trash."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_genie_spaces_by_space_id_conversations","parameters":{"space_id":{"type":"string","description":"The ID of the Genie space to retrieve conversations from."},"page_size":{"type":"integer","description":"Maximum number of conversations to return per page"},"page_token":{"type":"string","description":"Token to get the next page of results"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_genie_spaces_by_space_id_conversations_by_conversation_id","parameters":{"space_id":{"type":"string","description":"The ID associated with the Genie space where the conversation is located."},"conversation_id":{"type":"string","description":"The ID of the conversation to delete."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_genie_spaces_by_space_id_conversations_by_conversation_id_messages","parameters":{"space_id":{"type":"string","description":"The ID associated with the Genie space where the conversation is started."},"conversation_id":{"type":"string","description":"The ID associated with the conversation."},"data":{"type":"object","required":["content"],"properties":{"content":{"description":"User message content.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"datarooms.GenieCreateConversationMessageRequest.content","example":"Biggest open opportunities"}},"x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"GenieCreateConversationMessageRequest","x-databricks-legacy-name":"GenieCreateConversationMessageRequest","x-databricks-stable-name":"GenieCreateConversationMessageRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_genie_spaces_by_space_id_conversations_by_conversation_id_messages_by_message_id","parameters":{"space_id":{"type":"string","description":"The ID associated with the Genie space where the target conversation is located."},"conversation_id":{"type":"string","description":"The ID associated with the target conversation."},"message_id":{"type":"string","description":"The ID associated with the target message from the identified conversation."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_genie_spaces_by_space_id_conversations_by_conversation_id_messages_by_message_id_attachments_by_attachment_id_execute_query","parameters":{"space_id":{"type":"string","description":"Genie space ID"},"conversation_id":{"type":"string","description":"Conversation ID"},"message_id":{"type":"string","description":"Message ID"},"attachment_id":{"type":"string","description":"Attachment ID"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_genie_spaces_by_space_id_conversations_by_conversation_id_messages_by_message_id_attachments_by_attachment_id_query_result","parameters":{"space_id":{"type":"string","description":"Genie space ID"},"conversation_id":{"type":"string","description":"Conversation ID"},"message_id":{"type":"string","description":"Message ID"},"attachment_id":{"type":"string","description":"Attachment ID"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_genie_spaces_by_space_id_start_conversation","parameters":{"space_id":{"type":"string","description":"The ID associated with the Genie space where you want to start a conversation."},"data":{"type":"object","required":["content"],"properties":{"content":{"description":"The text of the message that starts the conversation.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"datarooms.GenieStartConversationMessageRequest.content","example":"Biggest open opportunities"}},"x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"GenieStartConversationMessageRequest","x-databricks-legacy-name":"GenieStartConversationMessageRequest","x-databricks-stable-name":"GenieStartConversationMessageRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_git_credentials","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_git_credentials","parameters":{"data":{"type":"object","required":["git_provider"],"properties":{"git_provider":{"description":"Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices`, `gitHubEnterprise`, `bitbucketServer`,\n`gitLabEnterpriseEdition` and `awsCodeCommit`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"credentials.CreateCredentials.git_provider","example":"gitHub"},"git_username":{"description":"The username or email provided with your Git provider account, depending on which provider you\nare using. For GitHub, GitHub Enterprise Server, or Azure DevOps Services, either email or\nusername may be used. For GitLab, GitLab Enterprise Edition, email must be used. For\nAWS CodeCommit, BitBucket or BitBucket Server, username must be used. For all other providers\nplease see your provider's Personal Access Token authentication documentation to see what\nis supported.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"credentials.CreateCredentials.git_username","example":"testuser"},"is_default_for_provider":{"description":"if the credential is the default for the given provider","type":"boolean","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"credentials.CreateCredentials.is_default_for_provider","example":false},"name":{"description":"the name of the git credential, used for identification and ease of lookup","type":"string","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"credentials.CreateCredentials.name","example":"My GitHub PAT"},"personal_access_token":{"description":"The personal access token used to authenticate to the corresponding Git provider.\nFor certain providers, support may exist for other types of scoped access tokens.\n[Learn more](https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html).","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"credentials.CreateCredentials.personal_access_token","example":"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"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateCredentialsRequest","x-databricks-legacy-name":"CreateCredentialsRequest","x-databricks-stable-name":"CreateCredentialsRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_git_credentials_by_credential_id","parameters":{"credential_id":{"type":"integer","description":"The ID for the corresponding credential to access."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_git_credentials_by_credential_id","parameters":{"credential_id":{"type":"integer","description":"The ID for the corresponding credential to access."},"data":{"type":"object","required":["git_provider"],"properties":{"git_provider":{"description":"Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices`, `gitHubEnterprise`, `bitbucketServer`,\n`gitLabEnterpriseEdition` and `awsCodeCommit`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"credentials.UpdateCredentials.git_provider","example":"gitHub"},"git_username":{"description":"The username or email provided with your Git provider account, depending on which provider you\nare using. For GitHub, GitHub Enterprise Server, or Azure DevOps Services, either email or\nusername may be used. For GitLab, GitLab Enterprise Edition, email must be used. For\nAWS CodeCommit, BitBucket or BitBucket Server, username must be used. For all other providers\nplease see your provider's Personal Access Token authentication documentation to see what\nis supported.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"credentials.UpdateCredentials.git_username","example":"testuser"},"is_default_for_provider":{"description":"if the credential is the default for the given provider","type":"boolean","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"credentials.UpdateCredentials.is_default_for_provider","example":false},"name":{"description":"the name of the git credential, used for identification and ease of lookup","type":"string","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"credentials.UpdateCredentials.name","example":"My GitHub PAT"},"personal_access_token":{"description":"The personal access token used to authenticate to the corresponding Git provider.\nFor certain providers, support may exist for other types of scoped access tokens.\n[Learn more](https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html).","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"credentials.UpdateCredentials.personal_access_token","example":"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"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateCredentialsRequest","x-databricks-legacy-name":"UpdateCredentialsRequest","x-databricks-stable-name":"UpdateCredentialsRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_git_credentials_by_credential_id","parameters":{"credential_id":{"type":"integer","description":"The ID for the corresponding credential to access."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_global_init_scripts","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_global_init_scripts","parameters":{"data":{"type":"object","required":["name","script"],"properties":{"enabled":{"description":"Specifies whether the script is enabled. The script runs only if enabled.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.CreateGlobalInitScript.enabled","default":false,"example":false},"name":{"description":"The name of the script","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9_\\-\\. ]*$","x-databricks-schema-id":"cluster.CreateGlobalInitScript.name","example":"My example script name"},"position":{"description":"The position of a global init script, where 0 represents the first script to run, 1 is the second script to run, in ascending order.\n\nIf you omit the numeric position for a new global init script, it defaults to last position. It will run after all current scripts.\nSetting any value greater than the position of the last script is equivalent to the last position. Example: Take three existing scripts with positions 0, 1, and 2. Any position of (3) or greater puts the script in the last position.\nIf an explicit position value conflicts with an existing script value, your request succeeds, but the original script at that position and all later scripts have their positions incremented by 1.","type":"integer","format":"integer","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.CreateGlobalInitScript.position","example":0},"script":{"description":"The Base64-encoded content of the script.","type":"string","format":"byte","x-databricks-api-version":"legacy","x-databricks-base64":true,"x-databricks-schema-id":"cluster.CreateGlobalInitScript.script","example":"ZWNobyBoZWxsbw=="}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"GlobalInitScriptCreateRequest","x-databricks-legacy-name":"GlobalInitScriptCreateRequest","x-databricks-stable-name":"GlobalInitScriptCreateRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_global_init_scripts_by_script_id","parameters":{"script_id":{"type":"string","description":"The ID of the global init script."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_global_init_scripts_by_script_id","parameters":{"script_id":{"type":"string","description":"The ID of the global init script."},"data":{"type":"object","required":["name","script"],"properties":{"enabled":{"description":"Specifies whether the script is enabled. The script runs only if enabled.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.UpdateGlobalInitScript.enabled","example":false},"name":{"description":"The name of the script","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9_\\-\\. ]*$","x-databricks-schema-id":"cluster.UpdateGlobalInitScript.name","example":"My example script name"},"position":{"description":"The position of a script, where 0 represents the first script to run,\n1 is the second script to run, in ascending order.\nTo move the script to run first, set its position to 0.\n\nTo move the script to the end, set its position to any value\ngreater or equal to the position of the last script.\nExample, three existing scripts with positions 0, 1, and 2.\nAny position value of 2 or greater puts the script in the last position (2).\n\nIf an explicit position value conflicts with an existing script, your request succeeds,\nbut the original script at that position and all later scripts have their positions\nincremented by 1.","type":"integer","format":"integer","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.UpdateGlobalInitScript.position","example":0},"script":{"description":"The Base64-encoded content of the script.","type":"string","format":"byte","x-databricks-api-version":"legacy","x-databricks-base64":true,"x-databricks-schema-id":"cluster.UpdateGlobalInitScript.script","example":"ZWNobyBoZWxsbw=="}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"GlobalInitScriptUpdateRequest","x-databricks-legacy-name":"GlobalInitScriptUpdateRequest","x-databricks-stable-name":"GlobalInitScriptUpdateRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_global_init_scripts_by_script_id","parameters":{"script_id":{"type":"string","description":"The ID of the global init script."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_identity_groups_resolve_by_external_id","parameters":{"data":{"description":"Request message for resolving a group with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the group's groupname, and inherited parent groups.","type":"object","required":["external_id"],"properties":{"external_id":{"description":"Required. The external ID of the group in the customer's IdP.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.v2.ResolveGroupProxyRequest.external_id"}},"x-databricks-package-name":"iamv2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ResolveGroupProxyRequest","x-databricks-legacy-name":"ResolveGroupProxyRequest","x-databricks-stable-name":"ResolveGroupProxyRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_identity_service_principals_resolve_by_external_id","parameters":{"data":{"description":"Request message for resolving a service principal with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the service principal's displayname, status, and inherited parent groups.","type":"object","required":["external_id"],"properties":{"external_id":{"description":"Required. The external ID of the service principal in the customer's IdP.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.v2.ResolveServicePrincipalProxyRequest.external_id"}},"x-databricks-package-name":"iamv2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ResolveServicePrincipalProxyRequest","x-databricks-legacy-name":"ResolveServicePrincipalProxyRequest","x-databricks-stable-name":"ResolveServicePrincipalProxyRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_identity_users_resolve_by_external_id","parameters":{"data":{"description":"Request message for resolving a user with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the user's displayname, status, and inherited parent groups.","type":"object","required":["external_id"],"properties":{"external_id":{"description":"Required. The external ID of the user in the customer's IdP.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.v2.ResolveUserProxyRequest.external_id"}},"x-databricks-package-name":"iamv2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ResolveUserProxyRequest","x-databricks-legacy-name":"ResolveUserProxyRequest","x-databricks-stable-name":"ResolveUserProxyRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_identity_workspace_access_details_by_principal_id","parameters":{"principal_id":{"type":"integer","description":"Required. The internal ID of the principal (user/sp/group) for which the access details are being requested."},"view":{"type":"string","description":"Controls what fields are returned."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_instance_pools_create","parameters":{"data":{"type":"object","required":["instance_pool_name","node_type_id"],"properties":{"aws_attributes":{"description":"Attributes related to instance pools running on Amazon Web Services.\nIf not specified at pool creation, a set of default values will be used.","$ref":"#/components/schemas/compute.InstancePoolAwsAttributes","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.aws_attributes","x-databricks-sdk-name":"InstancePoolAwsAttributes","x-databricks-legacy-name":"InstancePoolAwsAttributes","x-databricks-stable-name":"InstancePoolAwsAttributes"},"custom_tags":{"description":"Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags","type":"object","additionalProperties":{"description":"The value of the tag. The value length must be less than or equal to 255 UTF-8 characters.\nFor a list of all restrictions, see the AWS docs here:\nhttp://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterTag.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.custom_tags"},"disk_spec":{"description":"Defines the specification of the disks that will be attached to all spark containers.","$ref":"#/components/schemas/compute.DiskSpec","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.disk_spec","x-databricks-sdk-name":"DiskSpec","x-databricks-legacy-name":"DiskSpec","x-databricks-stable-name":"DiskSpec"},"enable_elastic_disk":{"description":"Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire\nadditional disk space when its Spark workers are running low on disk space. In AWS, this\nfeature requires specific AWS permissions to function correctly - refer to the User Guide for\nmore details.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.enable_elastic_disk"},"idle_instance_autotermination_minutes":{"description":"Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.idle_instance_autotermination_minutes","example":30},"instance_pool_name":{"description":"Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolAttributes.instance_pool_name","example":"my-pool"},"max_capacity":{"description":"Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolAttributes.max_capacity","example":200},"min_idle_instances":{"description":"Minimum number of idle instances to keep in the instance pool","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolAttributes.min_idle_instances","example":5},"node_type_id":{"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.node_type_id"},"preloaded_docker_images":{"description":"Custom Docker Image BYOC","type":"array","items":{"$ref":"#/components/schemas/compute.DockerImage","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.preloaded_docker_images.array_value","x-databricks-sdk-name":"DockerImage","x-databricks-legacy-name":"DockerImage","x-databricks-stable-name":"DockerImage"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.preloaded_docker_images"},"preloaded_spark_versions":{"description":"A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started\nwith the preloaded Spark version will start faster. A list of available Spark versions\ncan be retrieved by using the :method:clusters/sparkVersions API call.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.preloaded_spark_versions.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.preloaded_spark_versions"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateInstancePool","x-databricks-legacy-name":"CreateInstancePool","x-databricks-stable-name":"CreateInstancePool"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_instance_pools_delete","parameters":{"data":{"type":"object","required":["instance_pool_id"],"properties":{"instance_pool_id":{"description":"The instance pool to be terminated.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.DeleteInstancePool.instance_pool_id","example":"1234-567890-fetch12-pool-A3BcdEFg"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteInstancePool","x-databricks-legacy-name":"DeleteInstancePool","x-databricks-stable-name":"DeleteInstancePool"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_instance_pools_edit","parameters":{"data":{"type":"object","required":["instance_pool_id","instance_pool_name","node_type_id"],"properties":{"custom_tags":{"description":"Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags","type":"object","additionalProperties":{"description":"The value of the tag. The value length must be less than or equal to 255 UTF-8 characters.\nFor a list of all restrictions, see the AWS docs here:\nhttp://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterTag.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.custom_tags"},"idle_instance_autotermination_minutes":{"description":"Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.idle_instance_autotermination_minutes","example":30},"instance_pool_id":{"description":"Instance pool ID","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.EditInstancePool.instance_pool_id","example":"1234-567890-fetch12-pool-A3BcdEFg"},"instance_pool_name":{"description":"Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolAttributes.instance_pool_name","example":"my-pool"},"max_capacity":{"description":"Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolAttributes.max_capacity","example":200},"min_idle_instances":{"description":"Minimum number of idle instances to keep in the instance pool","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolAttributes.min_idle_instances","example":5},"node_type_id":{"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.InstancePoolClusterAttributes.node_type_id"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EditInstancePool","x-databricks-legacy-name":"EditInstancePool","x-databricks-stable-name":"EditInstancePool"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_instance_pools_get","parameters":{"instance_pool_id":{"type":"string","description":"The canonical unique identifier for the instance pool."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_instance_pools_list","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_instance_profiles_add","parameters":{"data":{"type":"object","required":["instance_profile_arn"],"properties":{"iam_role_arn":{"description":"The AWS IAM role ARN of the role associated with the instance profile.\nThis field is required if your role name and instance profile name do\nnot match and you want to use the instance profile with\n[Databricks SQL Serverless](https://docs.databricks.com/sql/admin/serverless.html).\n\nOtherwise, this field is optional.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"instanceProfiles.InstanceProfile.iam_role_arn","example":"arn:aws:iam:::role/"},"instance_profile_arn":{"description":"The AWS ARN of the instance profile to register with Databricks. This field is required.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"instanceProfiles.InstanceProfile.instance_profile_arn","example":"arn:aws:iam:::instance-profile/"},"is_meta_instance_profile":{"description":"Boolean flag indicating whether the instance profile should only be used in credential\npassthrough scenarios. If true, it means the instance profile contains an meta IAM role\nwhich could assume a wide range of roles. Therefore it should always be used with\nauthorization.\nThis field is optional, the default value is `false`.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"instanceProfiles.InstanceProfile.is_meta_instance_profile","default":false},"skip_validation":{"description":"By default, Databricks validates that it has sufficient permissions to launch\ninstances with the instance profile. This validation uses AWS dry-run mode for\nthe RunInstances API. If validation fails with an error message that does not\nindicate an IAM related permission issue,\n(e.g. “Your requested instance type is not supported in your requested availability zone”),\nyou can pass this flag to skip the validation and forcibly add the instance profile.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"instanceProfiles.AddInstanceProfile.skip_validation","default":false}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"AddInstanceProfile","x-databricks-legacy-name":"AddInstanceProfile","x-databricks-stable-name":"AddInstanceProfile"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_instance_profiles_edit","parameters":{"data":{"type":"object","required":["instance_profile_arn"],"properties":{"iam_role_arn":{"description":"The AWS IAM role ARN of the role associated with the instance profile.\nThis field is required if your role name and instance profile name do\nnot match and you want to use the instance profile with\n[Databricks SQL Serverless](https://docs.databricks.com/sql/admin/serverless.html).\n\nOtherwise, this field is optional.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"instanceProfiles.InstanceProfile.iam_role_arn","example":"arn:aws:iam:::role/"},"instance_profile_arn":{"description":"The AWS ARN of the instance profile to register with Databricks. This field is required.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"instanceProfiles.InstanceProfile.instance_profile_arn","example":"arn:aws:iam:::instance-profile/"},"is_meta_instance_profile":{"description":"Boolean flag indicating whether the instance profile should only be used in credential\npassthrough scenarios. If true, it means the instance profile contains an meta IAM role\nwhich could assume a wide range of roles. Therefore it should always be used with\nauthorization.\nThis field is optional, the default value is `false`.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"instanceProfiles.InstanceProfile.is_meta_instance_profile","default":false}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"InstanceProfile","x-databricks-legacy-name":"InstanceProfile","x-databricks-stable-name":"InstanceProfile"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_instance_profiles_list","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_instance_profiles_remove","parameters":{"data":{"type":"object","required":["instance_profile_arn"],"properties":{"instance_profile_arn":{"description":"The ARN of the instance profile to remove. This field is required.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"instanceProfiles.RemoveInstanceProfile.instance_profile_arn","example":"arn:aws:iam:::instance-profile/"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RemoveInstanceProfile","x-databricks-legacy-name":"RemoveInstanceProfile","x-databricks-stable-name":"RemoveInstanceProfile"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_ip_access_lists","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_ip_access_lists","parameters":{"data":{"description":"Details required to configure a block list or allow list.","type":"object","required":["label","list_type"],"properties":{"ip_addresses":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.CreateIpAccessList.ip_addresses.array_value","example":"192.168.100.0/22"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.CreateIpAccessList.ip_addresses"},"label":{"description":"Label for the IP access list. This **cannot** be empty.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.CreateIpAccessList.label","example":"Office VPN"},"list_type":{"$ref":"#/components/schemas/settings.list_type","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.CreateIpAccessList.list_type","x-databricks-sdk-name":"list_type","x-databricks-legacy-name":"list_type","x-databricks-stable-name":"list_type"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateIPAccessList","x-databricks-legacy-name":"CreateIPAccessList","x-databricks-stable-name":"CreateIPAccessList"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_ip_access_lists_by_ip_access_list_id","parameters":{"ip_access_list_id":{"type":"string","description":"The ID for the corresponding IP access list"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_ip_access_lists_by_ip_access_list_id","parameters":{"ip_access_list_id":{"type":"string","description":"The ID for the corresponding IP access list"},"data":{"description":"Details required to replace an IP access list.","type":"object","required":["label","list_type","enabled"],"properties":{"enabled":{"description":"Specifies whether this IP access list is enabled.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.ReplaceIpAccessList.enabled"},"ip_addresses":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.ReplaceIpAccessList.ip_addresses.array_value","example":"192.168.100.0/22"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.ReplaceIpAccessList.ip_addresses"},"label":{"description":"Label for the IP access list. This **cannot** be empty.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.ReplaceIpAccessList.label","example":"Office VPN"},"list_type":{"$ref":"#/components/schemas/settings.list_type","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.ReplaceIpAccessList.list_type","x-databricks-sdk-name":"list_type","x-databricks-legacy-name":"list_type","x-databricks-stable-name":"list_type"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ReplaceIPAccessList","x-databricks-legacy-name":"ReplaceIPAccessList","x-databricks-stable-name":"ReplaceIPAccessList"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_ip_access_lists_by_ip_access_list_id","parameters":{"ip_access_list_id":{"type":"string","description":"The ID for the corresponding IP access list"},"data":{"description":"Details required to update an IP access list.","type":"object","properties":{"enabled":{"description":"Specifies whether this IP access list is enabled.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.UpdateIpAccessList.enabled"},"ip_addresses":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.UpdateIpAccessList.ip_addresses.array_value","example":"192.168.100.0/22"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.UpdateIpAccessList.ip_addresses"},"label":{"description":"Label for the IP access list. This **cannot** be empty.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.UpdateIpAccessList.label","example":"Office VPN"},"list_type":{"$ref":"#/components/schemas/settings.list_type","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"ipaccesslist.UpdateIpAccessList.list_type","x-databricks-sdk-name":"list_type","x-databricks-legacy-name":"list_type","x-databricks-stable-name":"list_type"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateIPAccessList","x-databricks-legacy-name":"UpdateIPAccessList","x-databricks-stable-name":"UpdateIPAccessList"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_ip_access_lists_by_ip_access_list_id","parameters":{"ip_access_list_id":{"type":"string","description":"The ID for the corresponding IP access list"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lakeview_dashboards","parameters":{"page_size":{"type":"integer","description":"The number of dashboards to return per page."},"page_token":{"type":"string","description":"A page token, received from a previous `ListDashboards` call.\nThis token can be used to retrieve the subsequent page."},"show_trashed":{"type":"boolean","description":"The flag to include dashboards located in the trash.\nIf unspecified, only active dashboards will be returned."},"view":{"type":"string","description":"`DASHBOARD_VIEW_BASIC`only includes summary metadata from the dashboard."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_lakeview_dashboards","parameters":{"data":{"type":"object","properties":{"create_time":{"description":"The timestamp of when the dashboard was created.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"dashboard_id":{"description":"UUID identifying the dashboard.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.dashboard_id","example":"04aab30f99ea444490c10c85852f216c"},"display_name":{"description":"The display name of the dashboard.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.display_name","example":"Monthly Traffic Report"},"etag":{"description":"The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard\nhas not been modified since the last read.\nThis field is excluded in List Dashboards responses.","x-databricks-computed":true,"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.etag","example":"80611980"},"lifecycle_state":{"description":"The state of the dashboard resource. Used for tracking trashed status.","$ref":"#/components/schemas/dashboards.LifecycleState","x-databricks-computed":true,"x-databricks-package-name":"dashboards","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.lifecycle_state","x-databricks-sdk-name":"LifecycleState","x-databricks-legacy-name":"LifecycleState","x-databricks-stable-name":"LifecycleState"},"parent_path":{"description":"The workspace path of the folder containing the dashboard. Includes leading slash and no\ntrailing slash.\nThis field is excluded in List Dashboards responses.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["IMMUTABLE"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.parent_path","example":"/path/to/dir"},"path":{"description":"The workspace path of the dashboard asset, including the file name.\nExported dashboards always have the file extension `.lvdash.json`.\nThis field is excluded in List Dashboards responses.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.path","example":"/path/to/dir/Monthly Traffic Report.lvdash.json"},"serialized_dashboard":{"description":"The contents of the dashboard in serialized string form.\nThis field is excluded in List Dashboards responses.\nUse the [get dashboard API](https://docs.databricks.com/api/workspace/lakeview/get)\nto retrieve an example response, which includes the `serialized_dashboard` field.\nThis field provides the structure of the JSON string that represents the dashboard's\nlayout and components.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.serialized_dashboard","example":"{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}"},"update_time":{"description":"The timestamp of when the dashboard was last updated by the user.\nThis field is excluded in List Dashboards responses.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"warehouse_id":{"description":"The warehouse ID used to run the dashboard.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.warehouse_id","example":"47bb1c472649e711"}},"x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Dashboard","x-databricks-legacy-name":"Dashboard","x-databricks-stable-name":"Dashboard"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_lakeview_dashboards_migrate","parameters":{"data":{"type":"object","required":["source_dashboard_id"],"properties":{"display_name":{"description":"Display name for the new Lakeview dashboard.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.services.api.MigrateDashboardRequest.display_name","example":"Monthly Traffic Report"},"parent_path":{"description":"The workspace path of the folder to contain the migrated Lakeview dashboard.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.services.api.MigrateDashboardRequest.parent_path","example":"/path/to/dir"},"source_dashboard_id":{"description":"UUID of the dashboard to be migrated.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.services.api.MigrateDashboardRequest.source_dashboard_id","example":"4e443c27-9f61-4f2e-a12d-ea5668460bf1"},"update_parameter_syntax":{"description":"Flag to indicate if mustache parameter syntax ({{ param }}) should be auto-updated\nto named syntax (:param) when converting datasets in the dashboard.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.services.api.MigrateDashboardRequest.update_parameter_syntax","default":true}},"x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"MigrateDashboardRequest","x-databricks-legacy-name":"MigrateDashboardRequest","x-databricks-stable-name":"MigrateDashboardRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lakeview_dashboards_by_dashboard_id","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_lakeview_dashboards_by_dashboard_id","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard."},"data":{"type":"object","properties":{"create_time":{"description":"The timestamp of when the dashboard was created.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"dashboard_id":{"description":"UUID identifying the dashboard.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.dashboard_id","example":"04aab30f99ea444490c10c85852f216c"},"display_name":{"description":"The display name of the dashboard.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.display_name","example":"Monthly Traffic Report"},"etag":{"description":"The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard\nhas not been modified since the last read.\nThis field is excluded in List Dashboards responses.","x-databricks-computed":true,"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.etag","example":"80611980"},"lifecycle_state":{"description":"The state of the dashboard resource. Used for tracking trashed status.","$ref":"#/components/schemas/dashboards.LifecycleState","x-databricks-computed":true,"x-databricks-package-name":"dashboards","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.lifecycle_state","x-databricks-sdk-name":"LifecycleState","x-databricks-legacy-name":"LifecycleState","x-databricks-stable-name":"LifecycleState"},"parent_path":{"description":"The workspace path of the folder containing the dashboard. Includes leading slash and no\ntrailing slash.\nThis field is excluded in List Dashboards responses.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["IMMUTABLE"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.parent_path","example":"/path/to/dir"},"path":{"description":"The workspace path of the dashboard asset, including the file name.\nExported dashboards always have the file extension `.lvdash.json`.\nThis field is excluded in List Dashboards responses.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.path","example":"/path/to/dir/Monthly Traffic Report.lvdash.json"},"serialized_dashboard":{"description":"The contents of the dashboard in serialized string form.\nThis field is excluded in List Dashboards responses.\nUse the [get dashboard API](https://docs.databricks.com/api/workspace/lakeview/get)\nto retrieve an example response, which includes the `serialized_dashboard` field.\nThis field provides the structure of the JSON string that represents the dashboard's\nlayout and components.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.serialized_dashboard","example":"{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}"},"update_time":{"description":"The timestamp of when the dashboard was last updated by the user.\nThis field is excluded in List Dashboards responses.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Dashboard.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"warehouse_id":{"description":"The warehouse ID used to run the dashboard.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Dashboard.warehouse_id","example":"47bb1c472649e711"}},"x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Dashboard","x-databricks-legacy-name":"Dashboard","x-databricks-stable-name":"Dashboard"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_lakeview_dashboards_by_dashboard_id","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lakeview_dashboards_by_dashboard_id_published","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the published dashboard."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_lakeview_dashboards_by_dashboard_id_published","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard to be published."},"data":{"type":"object","properties":{"embed_credentials":{"description":"Flag to indicate if the publisher's credentials should be embedded in the\npublished dashboard. These embedded credentials will be used to execute the\npublished dashboard's queries.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.services.api.PublishDashboardRequest.embed_credentials","default":true},"warehouse_id":{"description":"The ID of the warehouse that can be used to override the warehouse which\nwas set in the draft.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.services.api.PublishDashboardRequest.warehouse_id"}},"x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PublishRequest","x-databricks-legacy-name":"PublishRequest","x-databricks-stable-name":"PublishRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_lakeview_dashboards_by_dashboard_id_published","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the published dashboard."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lakeview_dashboards_by_dashboard_id_published_tokeninfo","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the published dashboard."},"external_value":{"type":"string","description":"Provided external value to be included in the custom claim."},"external_viewer_id":{"type":"string","description":"Provided external viewer id to be included in the custom claim."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lakeview_dashboards_by_dashboard_id_schedules","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard to which the schedules belongs."},"page_size":{"type":"integer","description":"The number of schedules to return per page."},"page_token":{"type":"string","description":"A page token, received from a previous `ListSchedules` call.\nUse this to retrieve the subsequent page."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_lakeview_dashboards_by_dashboard_id_schedules","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard to which the schedule belongs."},"data":{"type":"object","required":["cron_schedule"],"properties":{"create_time":{"description":"A timestamp indicating when the schedule was created.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"cron_schedule":{"description":"The cron expression describing the frequency of the periodic refresh for this schedule.","$ref":"#/components/schemas/dashboards.CronSchedule","x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Schedule.cron_schedule","x-databricks-sdk-name":"CronSchedule","x-databricks-legacy-name":"CronSchedule","x-databricks-stable-name":"CronSchedule"},"dashboard_id":{"description":"UUID identifying the dashboard to which the schedule belongs.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.dashboard_id","example":"04aab30f99ea444490c10c85852f216c"},"display_name":{"description":"The display name for schedule.","type":"string","x-databricks-api-version":"legacy","maxLength":255,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.display_name","example":"Monthly Traffic Report Snapshot"},"etag":{"description":"The etag for the schedule. Must be left empty on create, must be provided on updates to ensure\nthat the schedule has not been modified since the last read, and can be optionally provided on delete.","x-databricks-computed":true,"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Schedule.etag","example":"80611980"},"pause_status":{"description":"The status indicates whether this schedule is paused or not.","$ref":"#/components/schemas/dashboards.SchedulePauseStatus","x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Schedule.pause_status","x-databricks-sdk-name":"SchedulePauseStatus","x-databricks-legacy-name":"SchedulePauseStatus","x-databricks-stable-name":"SchedulePauseStatus","default":"UNPAUSED"},"schedule_id":{"description":"UUID identifying the schedule.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.schedule_id","example":"01ef0cb45e2a1da4a61950e9b8789ce9"},"update_time":{"description":"A timestamp indicating when the schedule was last updated.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"warehouse_id":{"description":"The warehouse id to run the dashboard with for the schedule.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Schedule.warehouse_id","example":"47bb1c472649e711"}},"x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Schedule","x-databricks-legacy-name":"Schedule","x-databricks-stable-name":"Schedule"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lakeview_dashboards_by_dashboard_id_schedules_by_schedule_id","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard to which the schedule belongs."},"schedule_id":{"type":"string","description":"UUID identifying the schedule."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_lakeview_dashboards_by_dashboard_id_schedules_by_schedule_id","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard to which the schedule belongs."},"schedule_id":{"type":"string","description":"UUID identifying the schedule."},"data":{"type":"object","required":["cron_schedule"],"properties":{"create_time":{"description":"A timestamp indicating when the schedule was created.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"cron_schedule":{"description":"The cron expression describing the frequency of the periodic refresh for this schedule.","$ref":"#/components/schemas/dashboards.CronSchedule","x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Schedule.cron_schedule","x-databricks-sdk-name":"CronSchedule","x-databricks-legacy-name":"CronSchedule","x-databricks-stable-name":"CronSchedule"},"dashboard_id":{"description":"UUID identifying the dashboard to which the schedule belongs.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.dashboard_id","example":"04aab30f99ea444490c10c85852f216c"},"display_name":{"description":"The display name for schedule.","type":"string","x-databricks-api-version":"legacy","maxLength":255,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.display_name","example":"Monthly Traffic Report Snapshot"},"etag":{"description":"The etag for the schedule. Must be left empty on create, must be provided on updates to ensure\nthat the schedule has not been modified since the last read, and can be optionally provided on delete.","x-databricks-computed":true,"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Schedule.etag","example":"80611980"},"pause_status":{"description":"The status indicates whether this schedule is paused or not.","$ref":"#/components/schemas/dashboards.SchedulePauseStatus","x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Schedule.pause_status","x-databricks-sdk-name":"SchedulePauseStatus","x-databricks-legacy-name":"SchedulePauseStatus","x-databricks-stable-name":"SchedulePauseStatus","default":"UNPAUSED"},"schedule_id":{"description":"UUID identifying the schedule.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.schedule_id","example":"01ef0cb45e2a1da4a61950e9b8789ce9"},"update_time":{"description":"A timestamp indicating when the schedule was last updated.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Schedule.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"warehouse_id":{"description":"The warehouse id to run the dashboard with for the schedule.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Schedule.warehouse_id","example":"47bb1c472649e711"}},"x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Schedule","x-databricks-legacy-name":"Schedule","x-databricks-stable-name":"Schedule"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_lakeview_dashboards_by_dashboard_id_schedules_by_schedule_id","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard to which the schedule belongs."},"schedule_id":{"type":"string","description":"UUID identifying the schedule."},"etag":{"type":"string","description":"The etag for the schedule. Optionally, it can be provided to verify that the schedule has not\nbeen modified from its last retrieval."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lakeview_dashboards_by_dashboard_id_schedules_by_schedule_id_subscriptions","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard which the subscriptions belongs."},"schedule_id":{"type":"string","description":"UUID identifying the schedule which the subscriptions belongs."},"page_size":{"type":"integer","description":"The number of subscriptions to return per page."},"page_token":{"type":"string","description":"A page token, received from a previous `ListSubscriptions` call.\nUse this to retrieve the subsequent page."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_lakeview_dashboards_by_dashboard_id_schedules_by_schedule_id_subscriptions","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard to which the subscription belongs."},"schedule_id":{"type":"string","description":"UUID identifying the schedule to which the subscription belongs."},"data":{"type":"object","required":["subscriber"],"properties":{"create_time":{"description":"A timestamp indicating when the subscription was created.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Subscription.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"created_by_user_id":{"description":"UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule.","x-databricks-computed":true,"type":"integer","format":"int64","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Subscription.created_by_user_id","example":"3294322584244938"},"dashboard_id":{"description":"UUID identifying the dashboard to which the subscription belongs.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Subscription.dashboard_id","example":"04aab30f99ea444490c10c85852f216c"},"etag":{"description":"The etag for the subscription. Must be left empty on create, can be optionally provided on delete\nto ensure that the subscription has not been deleted since the last read.","x-databricks-computed":true,"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Subscription.etag","example":"80611980"},"schedule_id":{"description":"UUID identifying the schedule to which the subscription belongs.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Subscription.schedule_id","example":"01ef0cb45e2a1da4a61950e9b8789ce9"},"subscriber":{"description":"Subscriber details for users and destinations to be added as subscribers to the schedule.","$ref":"#/components/schemas/dashboards.Subscriber","x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-schema-id":"lakeviewconfig.external.Subscription.subscriber","x-databricks-sdk-name":"Subscriber","x-databricks-legacy-name":"Subscriber","x-databricks-stable-name":"Subscriber"},"subscription_id":{"description":"UUID identifying the subscription.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Subscription.subscription_id","example":"01ee9e6f2a2c1a8d9273d3c3e852fc2b"},"update_time":{"description":"A timestamp indicating when the subscription was last updated.","x-databricks-computed":true,"type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"lakeviewconfig.external.Subscription.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"}},"x-databricks-package-name":"dashboards","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Subscription","x-databricks-legacy-name":"Subscription","x-databricks-stable-name":"Subscription"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lakeview_dashboards_by_dashboard_id_schedules_by_schedule_id_subscriptions_by_subscription_id","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard which the subscription belongs."},"schedule_id":{"type":"string","description":"UUID identifying the schedule which the subscription belongs."},"subscription_id":{"type":"string","description":"UUID identifying the subscription."}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_lakeview_dashboards_by_dashboard_id_schedules_by_schedule_id_subscriptions_by_subscription_id","parameters":{"dashboard_id":{"type":"string","description":"UUID identifying the dashboard which the subscription belongs."},"schedule_id":{"type":"string","description":"UUID identifying the schedule which the subscription belongs."},"subscription_id":{"type":"string","description":"UUID identifying the subscription."},"etag":{"type":"string","description":"The etag for the subscription. Can be optionally provided to ensure that the subscription has not been\nmodified since the last read."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_libraries_all_cluster_statuses","parameters":{}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_libraries_cluster_status","parameters":{"cluster_id":{"type":"string","description":"Unique identifier of the cluster whose status should be retrieved."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_libraries_install","parameters":{"data":{"type":"object","required":["cluster_id","libraries"],"properties":{"cluster_id":{"description":"Unique identifier for the cluster on which to install these libraries.","type":"string","format":"cluster_id","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedLibraries.InstallLibraries.cluster_id"},"libraries":{"description":"The libraries to install.","type":"array","items":{"$ref":"#/components/schemas/compute.Library","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedLibraries.InstallLibraries.libraries.array_value","x-databricks-sdk-name":"Library","x-databricks-legacy-name":"Library","x-databricks-stable-name":"Library"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedLibraries.InstallLibraries.libraries"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"InstallLibraries","x-databricks-legacy-name":"InstallLibraries","x-databricks-stable-name":"InstallLibraries"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_libraries_uninstall","parameters":{"data":{"type":"object","required":["cluster_id","libraries"],"properties":{"cluster_id":{"description":"Unique identifier for the cluster on which to uninstall these libraries.","type":"string","format":"cluster_id","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedLibraries.UninstallLibraries.cluster_id"},"libraries":{"description":"The libraries to uninstall.","type":"array","items":{"$ref":"#/components/schemas/compute.Library","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedLibraries.UninstallLibraries.libraries.array_value","x-databricks-sdk-name":"Library","x-databricks-legacy-name":"Library","x-databricks-stable-name":"Library"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedLibraries.UninstallLibraries.libraries"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UninstallLibraries","x-databricks-legacy-name":"UninstallLibraries","x-databricks-stable-name":"UninstallLibraries"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lineage_tracking_external_lineage","parameters":{"object_info":{"type":"object","description":"The object to query external lineage relationships for.\nSince this field is a query parameter, please flatten the nested fields. For example, if the object is a table, the query parameter should look like:\n`object_info.table.name=main.sales.customers`"},"lineage_direction":{"type":"string","description":"The lineage direction to filter on."},"page_size":{"type":"integer","description":"Specifies the maximum number of external lineage relationships to return in a single response.\nThe value must be less than or equal to 1000."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_lineage_tracking_external_lineage","parameters":{"data":{"type":"object","required":["source","target"],"properties":{"columns":{"description":"List of column relationships between source and target objects.","type":"array","items":{"$ref":"#/components/schemas/catalog.ColumnRelationship","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.columns.array_value","x-databricks-sdk-name":"ColumnRelationship","x-databricks-legacy-name":"ColumnRelationship","x-databricks-stable-name":"ColumnRelationship"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.columns"},"id":{"description":"Unique identifier of the external lineage relationship.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-id":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.id","example":"12345678-abcd-4ef5-9012-3456789abcdf"},"properties":{"description":"Key-value properties associated with the external lineage relationship.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.PropertiesEntry.value"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.properties"},"source":{"description":"Source object of the external lineage relationship.","$ref":"#/components/schemas/catalog.ExternalLineageObject","x-databricks-package-name":"catalog","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.source","x-databricks-sdk-name":"ExternalLineageObject","x-databricks-legacy-name":"ExternalLineageObject","x-databricks-stable-name":"ExternalLineageObject"},"target":{"description":"Target object of the external lineage relationship.","$ref":"#/components/schemas/catalog.ExternalLineageObject","x-databricks-package-name":"catalog","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.target","x-databricks-sdk-name":"ExternalLineageObject","x-databricks-legacy-name":"ExternalLineageObject","x-databricks-stable-name":"ExternalLineageObject"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateRequestExternalLineage","x-databricks-legacy-name":"CreateRequestExternalLineage","x-databricks-stable-name":"CreateRequestExternalLineage"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_lineage_tracking_external_lineage","parameters":{"update_mask":{"type":"string"},"data":{"type":"object","required":["source","target"],"properties":{"columns":{"description":"List of column relationships between source and target objects.","type":"array","items":{"$ref":"#/components/schemas/catalog.ColumnRelationship","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.columns.array_value","x-databricks-sdk-name":"ColumnRelationship","x-databricks-legacy-name":"ColumnRelationship","x-databricks-stable-name":"ColumnRelationship"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.columns"},"id":{"description":"Unique identifier of the external lineage relationship.","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-id":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.id","example":"12345678-abcd-4ef5-9012-3456789abcdf"},"properties":{"description":"Key-value properties associated with the external lineage relationship.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.PropertiesEntry.value"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.properties"},"source":{"description":"Source object of the external lineage relationship.","$ref":"#/components/schemas/catalog.ExternalLineageObject","x-databricks-package-name":"catalog","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.source","x-databricks-sdk-name":"ExternalLineageObject","x-databricks-legacy-name":"ExternalLineageObject","x-databricks-stable-name":"ExternalLineageObject"},"target":{"description":"Target object of the external lineage relationship.","$ref":"#/components/schemas/catalog.ExternalLineageObject","x-databricks-package-name":"catalog","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalLineageRelationship.target","x-databricks-sdk-name":"ExternalLineageObject","x-databricks-legacy-name":"ExternalLineageObject","x-databricks-stable-name":"ExternalLineageObject"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateRequestExternalLineage","x-databricks-legacy-name":"UpdateRequestExternalLineage","x-databricks-stable-name":"UpdateRequestExternalLineage"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_lineage_tracking_external_lineage","parameters":{"external_lineage_relationship":{"type":"object"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lineage_tracking_external_metadata","parameters":{"page_size":{"type":"integer","description":"Specifies the maximum number of external metadata objects to return in a single response.\nThe value must be less than or equal to 1000."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_lineage_tracking_external_metadata","parameters":{"data":{"type":"object","required":["name","system_type","entity_type"],"properties":{"columns":{"description":"List of columns associated with the external metadata object.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.columns.array_value"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.columns","example":["type","message","details","date","time"]},"create_time":{"description":"Time at which this external metadata object was created.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"created_by":{"description":"Username of external metadata object creator.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.created_by"},"description":{"description":"User-provided free-form text description.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.description","example":"A stream of security related events in the critical services."},"entity_type":{"description":"Type of entity within the external system.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.entity_type","example":"Topic"},"id":{"description":"Unique identifier of the external metadata object.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-id":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.id","example":"12345678-abcd-4ef5-9012-3456789abcdf"},"metastore_id":{"description":"Unique identifier of parent metastore.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.metastore_id"},"name":{"description":"Name of the external metadata object.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-name":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.name","example":"security_events_stream"},"owner":{"description":"Owner of the external metadata object.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.owner","example":"data-team@company.com"},"properties":{"description":"A map of key-value properties attached to the external metadata object.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.PropertiesEntry.value"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.properties","example":{"compression.enabled":"true","compression.format":"zstd","topic":"prod.security.events.raw"}},"system_type":{"description":"Type of external system.","$ref":"#/components/schemas/catalog.SystemType","x-databricks-package-name":"catalog","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.system_type","x-databricks-sdk-name":"SystemType","x-databricks-legacy-name":"SystemType","x-databricks-stable-name":"SystemType"},"update_time":{"description":"Time at which this external metadata object was last modified.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"updated_by":{"description":"Username of user who last modified external metadata object.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.updated_by"},"url":{"description":"URL associated with the external metadata object.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.url","example":"https://kafka.com/12345"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ExternalMetadata","x-databricks-legacy-name":"ExternalMetadata","x-databricks-stable-name":"ExternalMetadata"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_lineage_tracking_external_metadata_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_lineage_tracking_external_metadata_by_name","parameters":{"name":{"type":"string","description":"Name of the external metadata object."},"update_mask":{"type":"string"},"data":{"type":"object","required":["name","system_type","entity_type"],"properties":{"columns":{"description":"List of columns associated with the external metadata object.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.columns.array_value"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.columns","example":["type","message","details","date","time"]},"create_time":{"description":"Time at which this external metadata object was created.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.create_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"created_by":{"description":"Username of external metadata object creator.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.created_by"},"description":{"description":"User-provided free-form text description.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.description","example":"A stream of security related events in the critical services."},"entity_type":{"description":"Type of entity within the external system.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.entity_type","example":"Topic"},"id":{"description":"Unique identifier of the external metadata object.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-id":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.id","example":"12345678-abcd-4ef5-9012-3456789abcdf"},"metastore_id":{"description":"Unique identifier of parent metastore.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.metastore_id"},"name":{"description":"Name of the external metadata object.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-name":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.name","example":"security_events_stream"},"owner":{"description":"Owner of the external metadata object.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.owner","example":"data-team@company.com"},"properties":{"description":"A map of key-value properties attached to the external metadata object.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.PropertiesEntry.value"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.properties","example":{"compression.enabled":"true","compression.format":"zstd","topic":"prod.security.events.raw"}},"system_type":{"description":"Type of external system.","$ref":"#/components/schemas/catalog.SystemType","x-databricks-package-name":"catalog","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.system_type","x-databricks-sdk-name":"SystemType","x-databricks-legacy-name":"SystemType","x-databricks-stable-name":"SystemType"},"update_time":{"description":"Time at which this external metadata object was last modified.","type":"string","format":"date-time","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.update_time","x-databricks-well-known-type":"google.protobuf.Timestamp"},"updated_by":{"description":"Username of user who last modified external metadata object.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.updated_by"},"url":{"description":"URL associated with the external metadata object.","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"metadatalineageapiserver.ExternalMetadata.url","example":"https://kafka.com/12345"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ExternalMetadata","x-databricks-legacy-name":"ExternalMetadata","x-databricks-stable-name":"ExternalMetadata"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_lineage_tracking_external_metadata_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_exchange_exchanges","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_marketplace_exchange_exchanges","parameters":{"data":{"type":"object","required":["exchange"],"properties":{"exchange":{"$ref":"#/components/schemas/marketplace.Exchange","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreateExchangeRequest.exchange","x-databricks-sdk-name":"Exchange","x-databricks-legacy-name":"Exchange","x-databricks-stable-name":"Exchange"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateExchangeRequest","x-databricks-legacy-name":"CreateExchangeRequest","x-databricks-stable-name":"CreateExchangeRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_exchange_exchanges_for_listing","parameters":{"listing_id":{"type":"string"},"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_marketplace_exchange_exchanges_for_listing","parameters":{"data":{"type":"object","required":["listing_id","exchange_id"],"properties":{"exchange_id":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.AddExchangeForListingRequest.exchange_id"},"listing_id":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.AddExchangeForListingRequest.listing_id"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"AddExchangeForListingRequest","x-databricks-legacy-name":"AddExchangeForListingRequest","x-databricks-stable-name":"AddExchangeForListingRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_marketplace_exchange_exchanges_for_listing_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_exchange_exchanges_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_marketplace_exchange_exchanges_by_id","parameters":{"id":{"type":"string"},"data":{"type":"object","required":["exchange"],"properties":{"exchange":{"$ref":"#/components/schemas/marketplace.Exchange","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdateExchangeRequest.exchange","x-databricks-sdk-name":"Exchange","x-databricks-legacy-name":"Exchange","x-databricks-stable-name":"Exchange"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateExchangeRequest","x-databricks-legacy-name":"UpdateExchangeRequest","x-databricks-stable-name":"UpdateExchangeRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_marketplace_exchange_exchanges_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_exchange_filters","parameters":{"exchange_id":{"type":"string"},"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_marketplace_exchange_filters","parameters":{"data":{"type":"object","required":["filter"],"properties":{"filter":{"$ref":"#/components/schemas/marketplace.ExchangeFilter","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreateExchangeFilterRequest.filter","x-databricks-sdk-name":"ExchangeFilter","x-databricks-legacy-name":"ExchangeFilter","x-databricks-stable-name":"ExchangeFilter"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateExchangeFilterRequest","x-databricks-legacy-name":"CreateExchangeFilterRequest","x-databricks-stable-name":"CreateExchangeFilterRequest"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_marketplace_exchange_filters_by_id","parameters":{"id":{"type":"string"},"data":{"type":"object","required":["filter"],"properties":{"filter":{"$ref":"#/components/schemas/marketplace.ExchangeFilter","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdateExchangeFilterRequest.filter","x-databricks-sdk-name":"ExchangeFilter","x-databricks-legacy-name":"ExchangeFilter","x-databricks-stable-name":"ExchangeFilter"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateExchangeFilterRequest","x-databricks-legacy-name":"UpdateExchangeFilterRequest","x-databricks-stable-name":"UpdateExchangeFilterRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_marketplace_exchange_filters_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_exchange_listings_for_exchange","parameters":{"exchange_id":{"type":"string"},"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_provider_analytics_dashboard","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_marketplace_provider_analytics_dashboard","parameters":{}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_provider_analytics_dashboard_latest","parameters":{}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_marketplace_provider_analytics_dashboard_by_id","parameters":{"id":{"type":"string","description":"id is immutable property and can't be updated."},"data":{"type":"object","properties":{"version":{"description":"this is the version of the dashboard template we want to update our user to\ncurrent expectation is that it should be equal to latest version of the dashboard template","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdateProviderAnalyticsDashboard.version"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateProviderAnalyticsDashboardRequest","x-databricks-legacy-name":"UpdateProviderAnalyticsDashboardRequest","x-databricks-stable-name":"UpdateProviderAnalyticsDashboardRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_provider_files","parameters":{"file_parent":{"type":"object"},"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_marketplace_provider_files","parameters":{"data":{"type":"object","required":["file_parent","marketplace_file_type","mime_type"],"properties":{"display_name":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreateFile.display_name"},"file_parent":{"$ref":"#/components/schemas/marketplace.FileParent","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreateFile.file_parent","x-databricks-sdk-name":"FileParent","x-databricks-legacy-name":"FileParent","x-databricks-stable-name":"FileParent"},"marketplace_file_type":{"$ref":"#/components/schemas/marketplace.MarketplaceFileType","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreateFile.marketplace_file_type","x-databricks-sdk-name":"MarketplaceFileType","x-databricks-legacy-name":"MarketplaceFileType","x-databricks-stable-name":"MarketplaceFileType"},"mime_type":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreateFile.mime_type"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateFileRequest","x-databricks-legacy-name":"CreateFileRequest","x-databricks-stable-name":"CreateFileRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_provider_files_by_file_id","parameters":{"file_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_marketplace_provider_files_by_file_id","parameters":{"file_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_marketplace_provider_listing","parameters":{"data":{"type":"object","required":["listing"],"properties":{"listing":{"$ref":"#/components/schemas/marketplace.Listing","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreateListing.listing","x-databricks-sdk-name":"Listing","x-databricks-legacy-name":"Listing","x-databricks-stable-name":"Listing"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateListingRequest","x-databricks-legacy-name":"CreateListingRequest","x-databricks-stable-name":"CreateListingRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_provider_listings","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_provider_listings_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_marketplace_provider_listings_by_id","parameters":{"id":{"type":"string"},"data":{"type":"object","required":["listing"],"properties":{"listing":{"$ref":"#/components/schemas/marketplace.Listing","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdateListing.listing","x-databricks-sdk-name":"Listing","x-databricks-legacy-name":"Listing","x-databricks-stable-name":"Listing"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateListingRequest","x-databricks-legacy-name":"UpdateListingRequest","x-databricks-stable-name":"UpdateListingRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_marketplace_provider_listings_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_marketplace_provider_listings_by_listing_id_personalization_requests_by_request_id_request_status","parameters":{"listing_id":{"type":"string"},"request_id":{"type":"string"},"data":{"type":"object","required":["status"],"properties":{"reason":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdatePersonalizationRequestStatus.reason"},"share":{"$ref":"#/components/schemas/marketplace.ShareInfo","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdatePersonalizationRequestStatus.share","x-databricks-sdk-name":"ShareInfo","x-databricks-legacy-name":"ShareInfo","x-databricks-stable-name":"ShareInfo"},"status":{"$ref":"#/components/schemas/marketplace.PersonalizationRequestStatus","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdatePersonalizationRequestStatus.status","x-databricks-sdk-name":"PersonalizationRequestStatus","x-databricks-legacy-name":"PersonalizationRequestStatus","x-databricks-stable-name":"PersonalizationRequestStatus"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdatePersonalizationRequestRequest","x-databricks-legacy-name":"UpdatePersonalizationRequestRequest","x-databricks-stable-name":"UpdatePersonalizationRequestRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_provider_personalization_requests","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_marketplace_provider_provider","parameters":{"data":{"type":"object","required":["provider"],"properties":{"provider":{"$ref":"#/components/schemas/marketplace.ProviderInfo","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreateProvider.provider","x-databricks-sdk-name":"ProviderInfo","x-databricks-legacy-name":"ProviderInfo","x-databricks-stable-name":"ProviderInfo"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateProviderRequest","x-databricks-legacy-name":"CreateProviderRequest","x-databricks-stable-name":"CreateProviderRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_provider_providers","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_marketplace_provider_providers_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_marketplace_provider_providers_by_id","parameters":{"id":{"type":"string"},"data":{"type":"object","required":["provider"],"properties":{"provider":{"$ref":"#/components/schemas/marketplace.ProviderInfo","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdateProvider.provider","x-databricks-sdk-name":"ProviderInfo","x-databricks-legacy-name":"ProviderInfo","x-databricks-stable-name":"ProviderInfo"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateProviderRequest","x-databricks-legacy-name":"UpdateProviderRequest","x-databricks-stable-name":"UpdateProviderRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_marketplace_provider_providers_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_artifacts_list","parameters":{"run_id":{"type":"string","description":"ID of the run whose artifacts to list. Must be provided."},"run_uuid":{"type":"string","description":"[Deprecated, use `run_id` instead] ID of the run whose artifacts to list. This field will\nbe removed in a future MLflow version."},"path":{"type":"string","description":"Filter artifacts matching this path (a relative path from the root artifact directory)."},"page_token":{"type":"string","description":"The token indicating the page of artifact results to fetch. `page_token` is not supported when listing artifacts in UC\nVolumes. A maximum of 1000 artifacts will be retrieved for UC Volumes. Please call\n`/api/2.0/fs/directories{directory_path}` for listing artifacts in UC Volumes, which supports pagination. See [List\ndirectory contents | Files API](/api/workspace/files/listdirectorycontents)."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_comments_create","parameters":{"data":{"description":"Details required to create a comment on a model version.","type":"object","required":["name","version","comment"],"properties":{"comment":{"description":"User-provided comment on the action.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":65535,"x-databricks-schema-id":"mlflow.CreateComment.comment","example":"This version is great!"},"name":{"description":"Name of the model.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":100,"x-databricks-schema-id":"mlflow.CreateComment.name","example":"search_ads_model"},"version":{"description":"Version of the model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateComment.version","example":"1"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateComment","x-databricks-legacy-name":"CreateComment","x-databricks-stable-name":"CreateComment"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_mlflow_comments_delete","parameters":{"id":{"type":"string","description":"Unique identifier of an activity"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_mlflow_comments_update","parameters":{"data":{"description":"Details required to edit a comment on a model version.","type":"object","required":["id","comment"],"properties":{"comment":{"description":"User-provided comment on the action.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":65535,"x-databricks-schema-id":"mlflow.UpdateComment.comment","example":"This version is great!"},"id":{"description":"Unique identifier of an activity","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateComment.id","example":"6fc74c92704341aaa49e74dcc6031057"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateComment","x-databricks-legacy-name":"UpdateComment","x-databricks-stable-name":"UpdateComment"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_databricks_model_versions_transition_stage","parameters":{"data":{"description":"Details required to transition a model version's stage.","type":"object","required":["name","version","stage","archive_existing_versions"],"properties":{"archive_existing_versions":{"description":"Specifies whether to archive all current model versions in the target stage.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.TransitionModelVersionStageDatabricks.archive_existing_versions","example":true},"comment":{"description":"User-provided comment on the action.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":65535,"x-databricks-schema-id":"mlflow.TransitionModelVersionStageDatabricks.comment","example":"This version is great!"},"name":{"description":"Name of the model.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":100,"x-databricks-schema-id":"mlflow.TransitionModelVersionStageDatabricks.name","example":"search_ads_model"},"stage":{"description":"Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.TransitionModelVersionStageDatabricks.stage"},"version":{"description":"Version of the model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.TransitionModelVersionStageDatabricks.version","example":"1"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"TransitionModelVersionStageDatabricks","x-databricks-legacy-name":"TransitionModelVersionStageDatabricks","x-databricks-stable-name":"TransitionModelVersionStageDatabricks"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_databricks_registered_models_get","parameters":{"name":{"type":"string","description":"Registered model unique name identifier."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_databricks_runs_delete_runs","parameters":{"data":{"type":"object","required":["experiment_id","max_timestamp_millis"],"properties":{"experiment_id":{"description":"The ID of the experiment containing the runs to delete.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.DeleteRuns.experiment_id"},"max_runs":{"description":"An optional positive integer indicating the maximum number of runs to delete. The maximum allowed value for\nmax_runs is 10000.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.DeleteRuns.max_runs"},"max_timestamp_millis":{"description":"The maximum creation timestamp in milliseconds since the UNIX epoch for deleting runs. Only runs created prior to\nor at this timestamp are deleted.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.DeleteRuns.max_timestamp_millis"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteRuns","x-databricks-legacy-name":"DeleteRuns","x-databricks-stable-name":"DeleteRuns"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_databricks_runs_restore_runs","parameters":{"data":{"type":"object","required":["experiment_id","min_timestamp_millis"],"properties":{"experiment_id":{"description":"The ID of the experiment containing the runs to restore.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.RestoreRuns.experiment_id"},"max_runs":{"description":"An optional positive integer indicating the maximum number of runs to restore. The maximum allowed value for\nmax_runs is 10000.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.RestoreRuns.max_runs"},"min_timestamp_millis":{"description":"The minimum deletion timestamp in milliseconds since the UNIX epoch for restoring runs. Only runs deleted no\nearlier than this timestamp are restored.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.RestoreRuns.min_timestamp_millis"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RestoreRuns","x-databricks-legacy-name":"RestoreRuns","x-databricks-stable-name":"RestoreRuns"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_experiments_create","parameters":{"data":{"type":"object","required":["name"],"properties":{"artifact_location":{"description":"Location where all artifacts for the experiment are stored.\nIf not provided, the remote server will select an appropriate default.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateExperiment.artifact_location"},"name":{"description":"Experiment name.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateExperiment.name"},"tags":{"description":"A collection of tags to set on the experiment. Maximum tag size and number of tags per request\ndepends on the storage backend. All storage backends are guaranteed to support tag keys up\nto 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also\nguaranteed to support up to 20 tags per request.","type":"array","items":{"$ref":"#/components/schemas/ml.ExperimentTag","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateExperiment.tags.array_value","x-databricks-sdk-name":"ExperimentTag","x-databricks-legacy-name":"ExperimentTag","x-databricks-stable-name":"ExperimentTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateExperiment.tags"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateExperiment","x-databricks-legacy-name":"CreateExperiment","x-databricks-stable-name":"CreateExperiment"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_experiments_delete","parameters":{"data":{"type":"object","required":["experiment_id"],"properties":{"experiment_id":{"description":"ID of the associated experiment.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.DeleteExperiment.experiment_id"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteExperiment","x-databricks-legacy-name":"DeleteExperiment","x-databricks-stable-name":"DeleteExperiment"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_experiments_get","parameters":{"experiment_id":{"type":"string","description":"ID of the associated experiment."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_experiments_get_by_name","parameters":{"experiment_name":{"type":"string","description":"Name of the associated experiment."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_experiments_list","parameters":{"view_type":{"type":"string","description":"Qualifier for type of experiments to be returned.\nIf unspecified, return only active experiments."},"max_results":{"type":"integer","description":"Maximum number of experiments desired.\nIf `max_results` is unspecified, return all experiments.\nIf `max_results` is too large, it'll be automatically capped at 1000.\nCallers of this endpoint are encouraged to pass max_results explicitly and leverage\npage_token to iterate through experiments."},"page_token":{"type":"string","description":"Token indicating the page of experiments to fetch"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_experiments_restore","parameters":{"data":{"type":"object","required":["experiment_id"],"properties":{"experiment_id":{"description":"ID of the associated experiment.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.RestoreExperiment.experiment_id"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RestoreExperiment","x-databricks-legacy-name":"RestoreExperiment","x-databricks-stable-name":"RestoreExperiment"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_experiments_search","parameters":{"data":{"type":"object","properties":{"filter":{"description":"String representing a SQL filter condition (e.g. \"name ILIKE 'my-experiment%'\")","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchExperiments.filter"},"max_results":{"description":"Maximum number of experiments desired. Max threshold is 3000.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchExperiments.max_results"},"order_by":{"description":"List of columns for ordering search results, which can include experiment name and last updated\ntimestamp with an optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by experiment id DESC.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchExperiments.order_by.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchExperiments.order_by"},"page_token":{"description":"Token indicating the page of experiments to fetch","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchExperiments.page_token"},"view_type":{"description":"Qualifier for type of experiments to be returned.\nIf unspecified, return only active experiments.","$ref":"#/components/schemas/ml.ViewType","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchExperiments.view_type","x-databricks-sdk-name":"ViewType","x-databricks-legacy-name":"ViewType","x-databricks-stable-name":"ViewType"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SearchExperiments","x-databricks-legacy-name":"SearchExperiments","x-databricks-stable-name":"SearchExperiments"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_experiments_set_experiment_tag","parameters":{"data":{"type":"object","required":["experiment_id","key","value"],"properties":{"experiment_id":{"description":"ID of the experiment under which to log the tag. Must be provided.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetExperimentTag.experiment_id"},"key":{"description":"Name of the tag. Keys up to 250 bytes in size are supported.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetExperimentTag.key"},"value":{"description":"String value of the tag being logged. Values up to 64KB in size are supported.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetExperimentTag.value"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SetExperimentTag","x-databricks-legacy-name":"SetExperimentTag","x-databricks-stable-name":"SetExperimentTag"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_experiments_update","parameters":{"data":{"type":"object","required":["experiment_id"],"properties":{"experiment_id":{"description":"ID of the associated experiment.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateExperiment.experiment_id"},"new_name":{"description":"If provided, the experiment's name is changed to the new name. The new name must be unique.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateExperiment.new_name"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateExperiment","x-databricks-legacy-name":"UpdateExperiment","x-databricks-stable-name":"UpdateExperiment"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_logged_models","parameters":{"data":{"type":"object","required":["experiment_id"],"properties":{"experiment_id":{"description":"The ID of the experiment that owns the model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateLoggedModel.experiment_id"},"model_type":{"description":"The type of the model, such as ``\"Agent\"``, ``\"Classifier\"``, ``\"LLM\"``.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateLoggedModel.model_type"},"name":{"description":"The name of the model (optional). If not specified one will be generated.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateLoggedModel.name"},"params":{"description":"Parameters attached to the model.","type":"array","items":{"$ref":"#/components/schemas/ml.LoggedModelParameter","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateLoggedModel.params.array_value","x-databricks-sdk-name":"LoggedModelParameter","x-databricks-legacy-name":"LoggedModelParameter","x-databricks-stable-name":"LoggedModelParameter"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateLoggedModel.params"},"source_run_id":{"description":"The ID of the run that created the model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateLoggedModel.source_run_id"},"tags":{"description":"Tags attached to the model.","type":"array","items":{"$ref":"#/components/schemas/ml.LoggedModelTag","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateLoggedModel.tags.array_value","x-databricks-sdk-name":"LoggedModelTag","x-databricks-legacy-name":"LoggedModelTag","x-databricks-stable-name":"LoggedModelTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateLoggedModel.tags"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateLoggedModelRequest","x-databricks-legacy-name":"CreateLoggedModelRequest","x-databricks-stable-name":"CreateLoggedModelRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_logged_models_search","parameters":{"data":{"type":"object","properties":{"datasets":{"description":"List of datasets on which to apply the metrics filter clauses.\nFor example, a filter with `metrics.accuracy > 0.9` and dataset info with name \"test_dataset\"\nmeans we will return all logged models with accuracy > 0.9 on the test_dataset.\nMetric values from ANY dataset matching the criteria are considered.\nIf no datasets are specified, then metrics across all datasets are considered in the filter.","type":"array","items":{"$ref":"#/components/schemas/ml.SearchLoggedModelsDataset","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchLoggedModels.datasets.array_value","x-databricks-sdk-name":"SearchLoggedModelsDataset","x-databricks-legacy-name":"SearchLoggedModelsDataset","x-databricks-stable-name":"SearchLoggedModelsDataset"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchLoggedModels.datasets"},"experiment_ids":{"description":"The IDs of the experiments in which to search for logged models.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchLoggedModels.experiment_ids.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchLoggedModels.experiment_ids"},"filter":{"description":"A filter expression over logged model info and data that allows returning a subset of\nlogged models. The syntax is a subset of SQL that supports AND'ing together binary operations.\n\nExample: ``params.alpha < 0.3 AND metrics.accuracy > 0.9``.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchLoggedModels.filter"},"max_results":{"description":"The maximum number of Logged Models to return. The maximum limit is 50.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchLoggedModels.max_results","default":50},"order_by":{"description":"The list of columns for ordering the results, with additional fields for sorting criteria.","type":"array","items":{"$ref":"#/components/schemas/ml.SearchLoggedModelsOrderBy","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchLoggedModels.order_by.array_value","x-databricks-sdk-name":"SearchLoggedModelsOrderBy","x-databricks-legacy-name":"SearchLoggedModelsOrderBy","x-databricks-stable-name":"SearchLoggedModelsOrderBy"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchLoggedModels.order_by"},"page_token":{"description":"The token indicating the page of logged models to fetch.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchLoggedModels.page_token"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SearchLoggedModelsRequest","x-databricks-legacy-name":"SearchLoggedModelsRequest","x-databricks-stable-name":"SearchLoggedModelsRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_logged_models_by_model_id","parameters":{"model_id":{"type":"string","description":"The ID of the logged model to retrieve."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_mlflow_logged_models_by_model_id","parameters":{"model_id":{"type":"string","description":"The ID of the logged model to finalize."},"data":{"type":"object","required":["status"],"properties":{"status":{"description":"Whether or not the model is ready for use. ``\"LOGGED_MODEL_UPLOAD_FAILED\"`` indicates that something went wrong\nwhen logging the model weights / agent code.","$ref":"#/components/schemas/ml.LoggedModelStatus","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.FinalizeLoggedModel.status","x-databricks-sdk-name":"LoggedModelStatus","x-databricks-legacy-name":"LoggedModelStatus","x-databricks-stable-name":"LoggedModelStatus"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"FinalizeLoggedModelRequest","x-databricks-legacy-name":"FinalizeLoggedModelRequest","x-databricks-stable-name":"FinalizeLoggedModelRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_mlflow_logged_models_by_model_id","parameters":{"model_id":{"type":"string","description":"The ID of the logged model to delete."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_logged_models_by_model_id_params","parameters":{"model_id":{"type":"string","description":"The ID of the logged model to log params for."},"data":{"type":"object","properties":{"params":{"description":"Parameters to attach to the model.","type":"array","items":{"$ref":"#/components/schemas/ml.LoggedModelParameter","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogLoggedModelParamsRequest.params.array_value","x-databricks-sdk-name":"LoggedModelParameter","x-databricks-legacy-name":"LoggedModelParameter","x-databricks-stable-name":"LoggedModelParameter"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogLoggedModelParamsRequest.params"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"LogLoggedModelParamsRequest","x-databricks-legacy-name":"LogLoggedModelParamsRequest","x-databricks-stable-name":"LogLoggedModelParamsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_mlflow_logged_models_by_model_id_tags","parameters":{"model_id":{"type":"string","description":"The ID of the logged model to set the tags on."},"data":{"type":"object","properties":{"tags":{"description":"The tags to set on the logged model.","type":"array","items":{"$ref":"#/components/schemas/ml.LoggedModelTag","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetLoggedModelTags.tags.array_value","x-databricks-sdk-name":"LoggedModelTag","x-databricks-legacy-name":"LoggedModelTag","x-databricks-stable-name":"LoggedModelTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetLoggedModelTags.tags"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SetLoggedModelTagsRequest","x-databricks-legacy-name":"SetLoggedModelTagsRequest","x-databricks-stable-name":"SetLoggedModelTagsRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_mlflow_logged_models_by_model_id_tags_by_tag_key","parameters":{"model_id":{"type":"string","description":"The ID of the logged model to delete the tag from."},"tag_key":{"type":"string","description":"The tag key."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_metrics_get_history","parameters":{"run_id":{"type":"string","description":"ID of the run from which to fetch metric values. Must be provided."},"run_uuid":{"type":"string","description":"[Deprecated, use `run_id` instead] ID of the run from which to fetch metric values. This field\nwill be removed in a future MLflow version."},"metric_key":{"type":"string","description":"Name of the metric."},"page_token":{"type":"string","description":"Token indicating the page of metric histories to fetch."},"max_results":{"type":"integer","description":"Maximum number of Metric records to return per paginated request. Default is set to 25,000. If set higher than\n25,000, a request Exception will be raised."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_model_versions_create","parameters":{"data":{"type":"object","required":["name","source"],"properties":{"description":{"description":"Optional description for model version.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateModelVersion.description"},"name":{"description":"Register model under this name","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateModelVersion.name"},"run_id":{"description":"MLflow run ID for correlation, if `source` was generated by an experiment run in\nMLflow tracking server","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateModelVersion.run_id"},"run_link":{"description":"MLflow run link - this is the exact link of the run that generated this model version,\npotentially hosted at another instance of MLflow.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateModelVersion.run_link"},"source":{"description":"URI indicating the location of the model artifacts.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateModelVersion.source"},"tags":{"description":"Additional metadata for model version.","type":"array","items":{"$ref":"#/components/schemas/ml.ModelVersionTag","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateModelVersion.tags.array_value","x-databricks-sdk-name":"ModelVersionTag","x-databricks-legacy-name":"ModelVersionTag","x-databricks-stable-name":"ModelVersionTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateModelVersion.tags"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateModelVersionRequest","x-databricks-legacy-name":"CreateModelVersionRequest","x-databricks-stable-name":"CreateModelVersionRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_mlflow_model_versions_delete","parameters":{"name":{"type":"string","description":"Name of the registered model"},"version":{"type":"string","description":"Model version number"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_mlflow_model_versions_delete_tag","parameters":{"name":{"type":"string","description":"Name of the registered model that the tag was logged under."},"version":{"type":"string","description":"Model version number that the tag was logged under."},"key":{"type":"string","description":"Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_model_versions_get","parameters":{"name":{"type":"string","description":"Name of the registered model"},"version":{"type":"string","description":"Model version number"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_model_versions_get_download_uri","parameters":{"name":{"type":"string","description":"Name of the registered model"},"version":{"type":"string","description":"Model version number"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_model_versions_search","parameters":{"filter":{"type":"string","description":"String filter condition, like \"name='my-model-name'\". Must be a single boolean condition,\nwith string values wrapped in single quotes."},"max_results":{"type":"integer","description":"Maximum number of models desired. Max threshold is 10K."},"order_by":{"type":"array","description":"List of columns to be ordered by including model name, version, stage with an\noptional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by\nversion DESC."},"page_token":{"type":"string","description":"Pagination token to go to next page based on previous search query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_model_versions_set_tag","parameters":{"data":{"type":"object","required":["name","version","key","value"],"properties":{"key":{"description":"Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetModelVersionTag.key"},"name":{"description":"Unique name of the model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetModelVersionTag.name"},"value":{"description":"String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetModelVersionTag.value"},"version":{"description":"Model version number.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetModelVersionTag.version"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SetModelVersionTagRequest","x-databricks-legacy-name":"SetModelVersionTagRequest","x-databricks-stable-name":"SetModelVersionTagRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_mlflow_model_versions_update","parameters":{"data":{"type":"object","required":["name","version"],"properties":{"description":{"description":"If provided, updates the description for this `registered_model`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateModelVersion.description"},"name":{"description":"Name of the registered model","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateModelVersion.name"},"version":{"description":"Model version number","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateModelVersion.version"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateModelVersionRequest","x-databricks-legacy-name":"UpdateModelVersionRequest","x-databricks-stable-name":"UpdateModelVersionRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_registered_models_create","parameters":{"data":{"type":"object","required":["name"],"properties":{"description":{"description":"Optional description for registered model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegisteredModel.description"},"name":{"description":"Register models under this name","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegisteredModel.name"},"tags":{"description":"Additional metadata for registered model.","type":"array","items":{"$ref":"#/components/schemas/ml.ModelTag","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegisteredModel.tags.array_value","x-databricks-sdk-name":"ModelTag","x-databricks-legacy-name":"ModelTag","x-databricks-stable-name":"ModelTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegisteredModel.tags"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateModelRequest","x-databricks-legacy-name":"CreateModelRequest","x-databricks-stable-name":"CreateModelRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_mlflow_registered_models_delete","parameters":{"name":{"type":"string","description":"Registered model unique name identifier."}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_mlflow_registered_models_delete_tag","parameters":{"name":{"type":"string","description":"Name of the registered model that the tag was logged under."},"key":{"type":"string","description":"Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_registered_models_get_latest_versions","parameters":{"data":{"type":"object","required":["name"],"properties":{"name":{"description":"Registered model unique name identifier.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.GetLatestVersions.name"},"stages":{"description":"List of stages.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.GetLatestVersions.stages.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.GetLatestVersions.stages"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"GetLatestVersionsRequest","x-databricks-legacy-name":"GetLatestVersionsRequest","x-databricks-stable-name":"GetLatestVersionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_registered_models_list","parameters":{"max_results":{"type":"integer","description":"Maximum number of registered models desired. Max threshold is 1000."},"page_token":{"type":"string","description":"Pagination token to go to the next page based on a previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_registered_models_rename","parameters":{"data":{"type":"object","required":["name"],"properties":{"name":{"description":"Registered model unique name identifier.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.RenameRegisteredModel.name"},"new_name":{"description":"If provided, updates the name for this `registered_model`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.RenameRegisteredModel.new_name"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RenameModelRequest","x-databricks-legacy-name":"RenameModelRequest","x-databricks-stable-name":"RenameModelRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_registered_models_search","parameters":{"filter":{"type":"string","description":"String filter condition, like \"name LIKE 'my-model-name'\".\nInterpreted in the backend automatically as \"name LIKE '%my-model-name%'\".\nSingle boolean condition, with string values wrapped in single quotes."},"max_results":{"type":"integer","description":"Maximum number of models desired. Default is 100. Max threshold is 1000."},"order_by":{"type":"array","description":"List of columns for ordering search results, which can include model name and last updated\ntimestamp with an optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by model name ASC."},"page_token":{"type":"string","description":"Pagination token to go to the next page based on a previous search query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_registered_models_set_tag","parameters":{"data":{"type":"object","required":["name","key","value"],"properties":{"key":{"description":"Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetRegisteredModelTag.key"},"name":{"description":"Unique name of the model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetRegisteredModelTag.name"},"value":{"description":"String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetRegisteredModelTag.value"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SetModelTagRequest","x-databricks-legacy-name":"SetModelTagRequest","x-databricks-stable-name":"SetModelTagRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_mlflow_registered_models_update","parameters":{"data":{"type":"object","required":["name"],"properties":{"description":{"description":"If provided, updates the description for this `registered_model`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRegisteredModel.description"},"name":{"description":"Registered model unique name identifier.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRegisteredModel.name"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateModelRequest","x-databricks-legacy-name":"UpdateModelRequest","x-databricks-stable-name":"UpdateModelRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_registry_webhooks_create","parameters":{"data":{"description":"Details required to create a registry webhook.","type":"object","required":["events"],"properties":{"description":{"description":"User-specified description for the webhook.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegistryWebhook.description","example":"Webhook for comment creation"},"events":{"description":"Events that can trigger a registry webhook:\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.","type":"array","items":{"$ref":"#/components/schemas/ml.RegistryWebhookEvent","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegistryWebhook.events.array_value","x-databricks-sdk-name":"RegistryWebhookEvent","x-databricks-legacy-name":"RegistryWebhookEvent","x-databricks-stable-name":"RegistryWebhookEvent"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegistryWebhook.events","example":["MODEL_VERSION_CREATED","MODEL_VERSION_TRANSITIONED_TO_STAGING","COMMENT_CREATED"]},"http_url_spec":{"description":"External HTTPS URL called on event trigger (by using a POST request).","$ref":"#/components/schemas/ml.HttpUrlSpec","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegistryWebhook.http_url_spec","x-databricks-sdk-name":"HttpUrlSpec","x-databricks-legacy-name":"HttpUrlSpec","x-databricks-stable-name":"HttpUrlSpec"},"job_spec":{"description":"ID of the job that the webhook runs.","$ref":"#/components/schemas/ml.JobSpec","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegistryWebhook.job_spec","x-databricks-sdk-name":"JobSpec","x-databricks-legacy-name":"JobSpec","x-databricks-stable-name":"JobSpec"},"model_name":{"description":"If model name is not specified, a registry-wide webhook is created that listens for the specified events across all versions of all registered models.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegistryWebhook.model_name","example":"registered-model-1"},"status":{"description":"Enable or disable triggering the webhook, or put the webhook into test mode. The default is `ACTIVE`:\n* `ACTIVE`: Webhook is triggered when an associated event happens.\n\n* `DISABLED`: Webhook is not triggered.\n\n* `TEST_MODE`: Webhook can be triggered through the test endpoint, but is not triggered on a real event.","$ref":"#/components/schemas/ml.RegistryWebhookStatus","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRegistryWebhook.status","x-databricks-sdk-name":"RegistryWebhookStatus","x-databricks-legacy-name":"RegistryWebhookStatus","x-databricks-stable-name":"RegistryWebhookStatus","default":"ACTIVE"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateRegistryWebhook","x-databricks-legacy-name":"CreateRegistryWebhook","x-databricks-stable-name":"CreateRegistryWebhook"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_mlflow_registry_webhooks_delete","parameters":{"id":{"type":"string","description":"Webhook ID required to delete a registry webhook."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_registry_webhooks_list","parameters":{"model_name":{"type":"string","description":"Registered model name\nIf not specified, all webhooks associated with the specified events are listed, regardless of their associated model."},"events":{"type":"array","description":"Events that trigger the webhook.\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.\n\nIf `events` is specified, any webhook with one or more of the specified trigger events is included in the output.\nIf `events` is not specified, webhooks of all event types are included in the output."},"page_token":{"type":"string","description":"Token indicating the page of artifact results to fetch"},"max_results":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_registry_webhooks_test","parameters":{"data":{"description":"Details required to test a registry webhook.","type":"object","required":["id"],"properties":{"event":{"description":"If `event` is specified, the test trigger uses the specified event. If `event` is not specified, the test trigger uses a randomly chosen event associated with the webhook.","$ref":"#/components/schemas/ml.RegistryWebhookEvent","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.TestRegistryWebhook.event","x-databricks-sdk-name":"RegistryWebhookEvent","x-databricks-legacy-name":"RegistryWebhookEvent","x-databricks-stable-name":"RegistryWebhookEvent"},"id":{"description":"Webhook ID","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.TestRegistryWebhook.id","example":"124323"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"TestRegistryWebhookRequest","x-databricks-legacy-name":"TestRegistryWebhookRequest","x-databricks-stable-name":"TestRegistryWebhookRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_mlflow_registry_webhooks_update","parameters":{"data":{"description":"Details required to update a registry webhook. Only the fields that need to be updated should be specified, and both `http_url_spec` and `job_spec` should not be specified in the same request.","type":"object","required":["id"],"properties":{"description":{"description":"User-specified description for the webhook.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRegistryWebhook.description","example":"Webhook for comment creation"},"events":{"description":"Events that can trigger a registry webhook:\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.","type":"array","items":{"$ref":"#/components/schemas/ml.RegistryWebhookEvent","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRegistryWebhook.events.array_value","x-databricks-sdk-name":"RegistryWebhookEvent","x-databricks-legacy-name":"RegistryWebhookEvent","x-databricks-stable-name":"RegistryWebhookEvent"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRegistryWebhook.events","example":["MODEL_VERSION_CREATED","MODEL_VERSION_TRANSITIONED_TO_STAGING","COMMENT_CREATED"]},"http_url_spec":{"$ref":"#/components/schemas/ml.HttpUrlSpec","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRegistryWebhook.http_url_spec","x-databricks-sdk-name":"HttpUrlSpec","x-databricks-legacy-name":"HttpUrlSpec","x-databricks-stable-name":"HttpUrlSpec"},"id":{"description":"Webhook ID","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRegistryWebhook.id","example":"124323"},"job_spec":{"$ref":"#/components/schemas/ml.JobSpec","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRegistryWebhook.job_spec","x-databricks-sdk-name":"JobSpec","x-databricks-legacy-name":"JobSpec","x-databricks-stable-name":"JobSpec"},"status":{"$ref":"#/components/schemas/ml.RegistryWebhookStatus","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRegistryWebhook.status","x-databricks-sdk-name":"RegistryWebhookStatus","x-databricks-legacy-name":"RegistryWebhookStatus","x-databricks-stable-name":"RegistryWebhookStatus"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateRegistryWebhook","x-databricks-legacy-name":"UpdateRegistryWebhook","x-databricks-stable-name":"UpdateRegistryWebhook"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_create","parameters":{"data":{"type":"object","properties":{"experiment_id":{"description":"ID of the associated experiment.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRun.experiment_id"},"run_name":{"description":"The name of the run.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRun.run_name"},"start_time":{"description":"Unix timestamp in milliseconds of when the run started.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRun.start_time"},"tags":{"description":"Additional metadata for run.","type":"array","items":{"$ref":"#/components/schemas/ml.RunTag","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRun.tags.array_value","x-databricks-sdk-name":"RunTag","x-databricks-legacy-name":"RunTag","x-databricks-stable-name":"RunTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateRun.tags"},"user_id":{"description":"ID of the user executing the run.\nThis field is deprecated as of MLflow 1.0, and will be removed in a future\nMLflow release. Use 'mlflow.user' tag instead.","type":"string","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"mlflow.CreateRun.user_id"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateRun","x-databricks-legacy-name":"CreateRun","x-databricks-stable-name":"CreateRun"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_delete","parameters":{"data":{"type":"object","required":["run_id"],"properties":{"run_id":{"description":"ID of the run to delete.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.DeleteRun.run_id"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteRun","x-databricks-legacy-name":"DeleteRun","x-databricks-stable-name":"DeleteRun"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_delete_tag","parameters":{"data":{"type":"object","required":["run_id","key"],"properties":{"key":{"description":"Name of the tag. Maximum size is 255 bytes. Must be provided.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.DeleteTag.key"},"run_id":{"description":"ID of the run that the tag was logged under. Must be provided.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.DeleteTag.run_id"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteTag","x-databricks-legacy-name":"DeleteTag","x-databricks-stable-name":"DeleteTag"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_runs_get","parameters":{"run_id":{"type":"string","description":"ID of the run to fetch. Must be provided."},"run_uuid":{"type":"string","description":"[Deprecated, use `run_id` instead] ID of the run to fetch. This field will\nbe removed in a future MLflow version."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_log_batch","parameters":{"data":{"type":"object","properties":{"metrics":{"description":"Metrics to log. A single request can contain up to 1000 metrics, and up to 1000\nmetrics, params, and tags in total.","type":"array","items":{"$ref":"#/components/schemas/ml.Metric","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogBatch.metrics.array_value","x-databricks-sdk-name":"Metric","x-databricks-legacy-name":"Metric","x-databricks-stable-name":"Metric"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogBatch.metrics"},"params":{"description":"Params to log. A single request can contain up to 100 params, and up to 1000\nmetrics, params, and tags in total.","type":"array","items":{"$ref":"#/components/schemas/ml.Param","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogBatch.params.array_value","x-databricks-sdk-name":"Param","x-databricks-legacy-name":"Param","x-databricks-stable-name":"Param"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogBatch.params"},"run_id":{"description":"ID of the run to log under","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogBatch.run_id"},"tags":{"description":"Tags to log. A single request can contain up to 100 tags, and up to 1000\nmetrics, params, and tags in total.","type":"array","items":{"$ref":"#/components/schemas/ml.RunTag","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogBatch.tags.array_value","x-databricks-sdk-name":"RunTag","x-databricks-legacy-name":"RunTag","x-databricks-stable-name":"RunTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogBatch.tags"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"LogBatch","x-databricks-legacy-name":"LogBatch","x-databricks-stable-name":"LogBatch","example":{"metrics":[{"key":"mae","timestamp":1552550804,"value":2.5},{"key":"rmse","timestamp":1552550804,"value":2.7}],"params":[{"key":"model_class","value":"LogisticRegression"}],"run_id":"2a14ed5c6a87499199e0106c3501eab8"}}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_log_inputs","parameters":{"data":{"type":"object","required":["run_id"],"properties":{"datasets":{"description":"Dataset inputs","type":"array","items":{"$ref":"#/components/schemas/ml.DatasetInput","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogInputs.datasets.array_value","x-databricks-sdk-name":"DatasetInput","x-databricks-legacy-name":"DatasetInput","x-databricks-stable-name":"DatasetInput"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogInputs.datasets"},"models":{"description":"Model inputs","type":"array","items":{"$ref":"#/components/schemas/ml.ModelInput","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogInputs.models.array_value","x-databricks-sdk-name":"ModelInput","x-databricks-legacy-name":"ModelInput","x-databricks-stable-name":"ModelInput"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogInputs.models"},"run_id":{"description":"ID of the run to log under","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogInputs.run_id"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"LogInputs","x-databricks-legacy-name":"LogInputs","x-databricks-stable-name":"LogInputs"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_log_metric","parameters":{"data":{"type":"object","required":["key","value","timestamp"],"properties":{"dataset_digest":{"description":"Dataset digest of the dataset associated with the metric,\ne.g. an md5 hash of the dataset that uniquely identifies it\nwithin datasets of the same name.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogMetric.dataset_digest"},"dataset_name":{"description":"The name of the dataset associated with the metric.\nE.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3”","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogMetric.dataset_name"},"key":{"description":"Name of the metric.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogMetric.key"},"model_id":{"description":"ID of the logged model associated with the metric, if applicable","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogMetric.model_id"},"run_id":{"description":"ID of the run under which to log the metric. Must be provided.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogMetric.run_id"},"run_uuid":{"description":"[Deprecated, use `run_id` instead] ID of the run under which to log the metric. This field will\nbe removed in a future MLflow version.","type":"string","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"mlflow.LogMetric.run_uuid"},"step":{"description":"Step at which to log the metric","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogMetric.step","default":0},"timestamp":{"description":"Unix timestamp in milliseconds at the time metric was logged.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogMetric.timestamp"},"value":{"description":"Double value of the metric being logged.","type":"number","format":"double","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogMetric.value"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"LogMetric","x-databricks-legacy-name":"LogMetric","x-databricks-stable-name":"LogMetric"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_log_model","parameters":{"data":{"type":"object","properties":{"model_json":{"description":"MLmodel file in json format.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogModel.model_json"},"run_id":{"description":"ID of the run to log under","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogModel.run_id"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"LogModel","x-databricks-legacy-name":"LogModel","x-databricks-stable-name":"LogModel"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_log_parameter","parameters":{"data":{"type":"object","required":["key","value"],"properties":{"key":{"description":"Name of the param. Maximum size is 255 bytes.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogParam.key"},"run_id":{"description":"ID of the run under which to log the param. Must be provided.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogParam.run_id"},"run_uuid":{"description":"[Deprecated, use `run_id` instead] ID of the run under which to log the param. This field will\nbe removed in a future MLflow version.","type":"string","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"mlflow.LogParam.run_uuid"},"value":{"description":"String value of the param being logged. Maximum size is 500 bytes.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogParam.value"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"LogParam","x-databricks-legacy-name":"LogParam","x-databricks-stable-name":"LogParam"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_outputs","parameters":{"data":{"type":"object","required":["run_id"],"properties":{"models":{"description":"The model outputs from the Run.","type":"array","items":{"$ref":"#/components/schemas/ml.ModelOutput","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogOutputs.models.array_value","x-databricks-sdk-name":"ModelOutput","x-databricks-legacy-name":"ModelOutput","x-databricks-stable-name":"ModelOutput"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogOutputs.models"},"run_id":{"description":"The ID of the Run from which to log outputs.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.LogOutputs.run_id"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"LogOutputsRequest","x-databricks-legacy-name":"LogOutputsRequest","x-databricks-stable-name":"LogOutputsRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_restore","parameters":{"data":{"type":"object","required":["run_id"],"properties":{"run_id":{"description":"ID of the run to restore.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.RestoreRun.run_id"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RestoreRun","x-databricks-legacy-name":"RestoreRun","x-databricks-stable-name":"RestoreRun"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_search","parameters":{"data":{"type":"object","properties":{"experiment_ids":{"description":"List of experiment IDs to search over.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchRuns.experiment_ids.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchRuns.experiment_ids"},"filter":{"description":"A filter expression over params, metrics, and tags, that allows returning a subset of\nruns. The syntax is a subset of SQL that supports ANDing together binary operations\nbetween a param, metric, or tag and a constant.\n\nExample: `metrics.rmse < 1 and params.model_class = 'LogisticRegression'`\n\nYou can select columns with special characters (hyphen, space, period, etc.) by using double quotes:\n`metrics.\"model class\" = 'LinearRegression' and tags.\"user-name\" = 'Tomas'`\n\nSupported operators are `=`, `!=`, `>`, `>=`, `<`, and `<=`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchRuns.filter"},"max_results":{"description":"Maximum number of runs desired. Max threshold is 50000","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchRuns.max_results","default":1000},"order_by":{"description":"List of columns to be ordered by, including attributes, params, metrics, and tags with an\noptional `\"DESC\"` or `\"ASC\"` annotation, where `\"ASC\"` is the default.\nExample: `[\"params.input DESC\", \"metrics.alpha ASC\", \"metrics.rmse\"]`.\nTiebreaks are done by start_time `DESC` followed by `run_id` for runs with the same start time\n(and this is the default ordering criterion if order_by is not provided).","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchRuns.order_by.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchRuns.order_by"},"page_token":{"description":"Token for the current page of runs.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchRuns.page_token"},"run_view_type":{"description":"Whether to display only active, only deleted, or all runs.\nDefaults to only active runs.","$ref":"#/components/schemas/ml.ViewType","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SearchRuns.run_view_type","x-databricks-sdk-name":"ViewType","x-databricks-legacy-name":"ViewType","x-databricks-stable-name":"ViewType","default":"ACTIVE_ONLY"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SearchRuns","x-databricks-legacy-name":"SearchRuns","x-databricks-stable-name":"SearchRuns"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_set_tag","parameters":{"data":{"type":"object","required":["key","value"],"properties":{"key":{"description":"Name of the tag. Keys up to 250 bytes in size are supported.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetTag.key"},"run_id":{"description":"ID of the run under which to log the tag. Must be provided.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetTag.run_id"},"run_uuid":{"description":"[Deprecated, use `run_id` instead] ID of the run under which to log the tag. This field will\nbe removed in a future MLflow version.","type":"string","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"mlflow.SetTag.run_uuid"},"value":{"description":"String value of the tag being logged. Values up to 64KB in size are supported.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.SetTag.value"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SetTag","x-databricks-legacy-name":"SetTag","x-databricks-stable-name":"SetTag"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_runs_update","parameters":{"data":{"type":"object","properties":{"end_time":{"description":"Unix timestamp in milliseconds of when the run ended.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRun.end_time"},"run_id":{"description":"ID of the run to update. Must be provided.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRun.run_id"},"run_name":{"description":"Updated name of the run.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRun.run_name"},"run_uuid":{"description":"[Deprecated, use `run_id` instead] ID of the run to update. This field will\nbe removed in a future MLflow version.","type":"string","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"mlflow.UpdateRun.run_uuid"},"status":{"description":"Updated status of the run.","$ref":"#/components/schemas/ml.UpdateRunStatus","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.UpdateRun.status","x-databricks-sdk-name":"UpdateRunStatus","x-databricks-legacy-name":"UpdateRunStatus","x-databricks-stable-name":"UpdateRunStatus"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateRun","x-databricks-legacy-name":"UpdateRun","x-databricks-stable-name":"UpdateRun"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_transition_requests_approve","parameters":{"data":{"description":"Details required to identify and approve a model version stage transition request.","type":"object","required":["name","version","stage","archive_existing_versions"],"properties":{"archive_existing_versions":{"description":"Specifies whether to archive all current model versions in the target stage.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.ApproveTransitionRequest.archive_existing_versions","example":true},"comment":{"description":"User-provided comment on the action.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":65535,"x-databricks-schema-id":"mlflow.ApproveTransitionRequest.comment","example":"This version is great!"},"name":{"description":"Name of the model.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":100,"x-databricks-schema-id":"mlflow.ApproveTransitionRequest.name","example":"search_ads_model"},"stage":{"description":"Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.ApproveTransitionRequest.stage"},"version":{"description":"Version of the model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.ApproveTransitionRequest.version","example":"1"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ApproveTransitionRequest","x-databricks-legacy-name":"ApproveTransitionRequest","x-databricks-stable-name":"ApproveTransitionRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_transition_requests_create","parameters":{"data":{"description":"Details required to create a model version stage transition request.","type":"object","required":["name","version","stage"],"properties":{"comment":{"description":"User-provided comment on the action.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":65535,"x-databricks-schema-id":"mlflow.CreateTransitionRequest.comment","example":"This version is great!"},"name":{"description":"Name of the model.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":100,"x-databricks-schema-id":"mlflow.CreateTransitionRequest.name","example":"search_ads_model"},"stage":{"description":"Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateTransitionRequest.stage"},"version":{"description":"Version of the model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.CreateTransitionRequest.version","example":"1"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateTransitionRequest","x-databricks-legacy-name":"CreateTransitionRequest","x-databricks-stable-name":"CreateTransitionRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_mlflow_transition_requests_delete","parameters":{"name":{"type":"string","description":"Name of the model."},"version":{"type":"string","description":"Version of the model."},"stage":{"type":"string","description":"Target stage of the transition request. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage."},"creator":{"type":"string","description":"Username of the user who created this request. Of the transition requests matching the specified details, only the one transition created by this user will be deleted."},"comment":{"type":"string","description":"User-provided comment on the action."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_mlflow_transition_requests_list","parameters":{"name":{"type":"string","description":"Name of the registered model."},"version":{"type":"string","description":"Version of the model."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_mlflow_transition_requests_reject","parameters":{"data":{"description":"Details required to identify and reject a model version stage transition request.","type":"object","required":["name","version","stage"],"properties":{"comment":{"description":"User-provided comment on the action.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":65535,"x-databricks-schema-id":"mlflow.RejectTransitionRequest.comment","example":"This version is great!"},"name":{"description":"Name of the model.","type":"string","x-databricks-api-version":"legacy","minLength":1,"maxLength":100,"x-databricks-schema-id":"mlflow.RejectTransitionRequest.name","example":"search_ads_model"},"stage":{"description":"Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.RejectTransitionRequest.stage"},"version":{"description":"Version of the model.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"mlflow.RejectTransitionRequest.version","example":"1"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RejectTransitionRequest","x-databricks-legacy-name":"RejectTransitionRequest","x-databricks-stable-name":"RejectTransitionRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_notification_destinations","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_notification_destinations","parameters":{"data":{"type":"object","properties":{"config":{"description":"The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.","$ref":"#/components/schemas/settings.Config","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"webhooknotifications.external.CreateNotificationDestinationRequest.config","x-databricks-sdk-name":"Config","x-databricks-legacy-name":"Config","x-databricks-stable-name":"Config"},"display_name":{"description":"The display name for the notification destination.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"webhooknotifications.external.CreateNotificationDestinationRequest.display_name"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateNotificationDestinationRequest","x-databricks-legacy-name":"CreateNotificationDestinationRequest","x-databricks-stable-name":"CreateNotificationDestinationRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_notification_destinations_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_notification_destinations_by_id","parameters":{"id":{"type":"string","description":"UUID identifying notification destination."},"data":{"type":"object","properties":{"config":{"description":"The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.","$ref":"#/components/schemas/settings.Config","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"webhooknotifications.external.UpdateNotificationDestinationRequest.config","x-databricks-sdk-name":"Config","x-databricks-legacy-name":"Config","x-databricks-stable-name":"Config"},"display_name":{"description":"The display name for the notification destination.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"webhooknotifications.external.UpdateNotificationDestinationRequest.display_name"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateNotificationDestinationRequest","x-databricks-legacy-name":"UpdateNotificationDestinationRequest","x-databricks-stable-name":"UpdateNotificationDestinationRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_notification_destinations_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_online_tables","parameters":{"data":{"description":"Online Table information.","type":"object","properties":{"name":{"description":"Full three-part (catalog, schema, table) name of the table.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.OnlineTable.name"},"spec":{"description":"Specification of the online table.","$ref":"#/components/schemas/catalog.OnlineTableSpec","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickstore.scheduler.OnlineTable.spec","x-databricks-sdk-name":"OnlineTableSpec","x-databricks-legacy-name":"OnlineTableSpec","x-databricks-stable-name":"OnlineTableSpec"},"status":{"description":"Online Table data synchronization status","$ref":"#/components/schemas/catalog.OnlineTableStatus","x-databricks-computed":true,"x-databricks-package-name":"catalog","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.OnlineTable.status","x-databricks-sdk-name":"OnlineTableStatus","x-databricks-legacy-name":"OnlineTableStatus","x-databricks-stable-name":"OnlineTableStatus"},"table_serving_url":{"description":"Data serving REST API URL for this table","x-databricks-computed":true,"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.OnlineTable.table_serving_url"},"unity_catalog_provisioning_state":{"description":"The provisioning state of the online table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously).","$ref":"#/components/schemas/catalog.ProvisioningInfoState","x-databricks-computed":true,"x-databricks-package-name":"catalog","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"brickstore.scheduler.OnlineTable.unity_catalog_provisioning_state","x-databricks-sdk-name":"ProvisioningInfoState","x-databricks-legacy-name":"ProvisioningInfoState","x-databricks-stable-name":"ProvisioningInfoState"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"OnlineTable","x-databricks-legacy-name":"OnlineTable","x-databricks-stable-name":"OnlineTable"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_online_tables_by_name","parameters":{"name":{"type":"string","description":"Full three-part (catalog, schema, table) name of the table."}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_online_tables_by_name","parameters":{"name":{"type":"string","description":"Full three-part (catalog, schema, table) name of the table."}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_apps_by_app_name","parameters":{"app_name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_apps_by_app_name","parameters":{"app_name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_apps_by_app_name","parameters":{"app_name":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/apps.AppAccessControlRequest","x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AppAccessControlRequest","x-databricks-legacy-name":"AppAccessControlRequest","x-databricks-stable-name":"AppAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AppPermissionsRequest","x-databricks-legacy-name":"AppPermissionsRequest","x-databricks-stable-name":"AppPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_apps_by_app_name","parameters":{"app_name":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/apps.AppAccessControlRequest","x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AppAccessControlRequest","x-databricks-legacy-name":"AppAccessControlRequest","x-databricks-stable-name":"AppAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"apps","x-databricks-api-version":"legacy","x-databricks-sdk-name":"AppPermissionsRequest","x-databricks-legacy-name":"AppPermissionsRequest","x-databricks-stable-name":"AppPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_apps_by_app_name_permission_levels","parameters":{"app_name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_apps_by_app_name_permission_levels","parameters":{"app_name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_authorization_passwords","parameters":{}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_authorization_passwords","parameters":{"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/iam.PasswordAccessControlRequest","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.PasswordPermissionsRequest.access_control_list.array_value","x-databricks-sdk-name":"PasswordAccessControlRequest","x-databricks-legacy-name":"PasswordAccessControlRequest","x-databricks-stable-name":"PasswordAccessControlRequest"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.PasswordPermissionsRequest.access_control_list"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PasswordPermissionsRequest","x-databricks-legacy-name":"PasswordPermissionsRequest","x-databricks-stable-name":"PasswordPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_authorization_passwords","parameters":{"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/iam.PasswordAccessControlRequest","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.PasswordPermissionsRequest.access_control_list.array_value","x-databricks-sdk-name":"PasswordAccessControlRequest","x-databricks-legacy-name":"PasswordAccessControlRequest","x-databricks-stable-name":"PasswordAccessControlRequest"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.PasswordPermissionsRequest.access_control_list"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PasswordPermissionsRequest","x-databricks-legacy-name":"PasswordPermissionsRequest","x-databricks-stable-name":"PasswordPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_authorization_passwords_permission_levels","parameters":{}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_authorization_tokens","parameters":{}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_authorization_tokens","parameters":{"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/settings.TokenAccessControlRequest","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-sdk-name":"TokenAccessControlRequest","x-databricks-legacy-name":"TokenAccessControlRequest","x-databricks-stable-name":"TokenAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-sdk-name":"TokenPermissionsRequest","x-databricks-legacy-name":"TokenPermissionsRequest","x-databricks-stable-name":"TokenPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_authorization_tokens","parameters":{"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/settings.TokenAccessControlRequest","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-sdk-name":"TokenAccessControlRequest","x-databricks-legacy-name":"TokenAccessControlRequest","x-databricks-stable-name":"TokenAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-sdk-name":"TokenPermissionsRequest","x-databricks-legacy-name":"TokenPermissionsRequest","x-databricks-stable-name":"TokenPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_authorization_tokens_permission_levels","parameters":{}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_cluster_policies_by_cluster_policy_id","parameters":{"cluster_policy_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_cluster_policies_by_cluster_policy_id","parameters":{"cluster_policy_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_cluster_policies_by_cluster_policy_id","parameters":{"cluster_policy_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/compute.ClusterPolicyAccessControlRequest","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ClusterPolicyAccessControlRequest","x-databricks-legacy-name":"ClusterPolicyAccessControlRequest","x-databricks-stable-name":"ClusterPolicyAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ClusterPolicyPermissionsRequest","x-databricks-legacy-name":"ClusterPolicyPermissionsRequest","x-databricks-stable-name":"ClusterPolicyPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_cluster_policies_by_cluster_policy_id","parameters":{"cluster_policy_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/compute.ClusterPolicyAccessControlRequest","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ClusterPolicyAccessControlRequest","x-databricks-legacy-name":"ClusterPolicyAccessControlRequest","x-databricks-stable-name":"ClusterPolicyAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ClusterPolicyPermissionsRequest","x-databricks-legacy-name":"ClusterPolicyPermissionsRequest","x-databricks-stable-name":"ClusterPolicyPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_cluster_policies_by_cluster_policy_id_permission_levels","parameters":{"cluster_policy_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_cluster_policies_by_cluster_policy_id_permission_levels","parameters":{"cluster_policy_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_clusters_by_cluster_id","parameters":{"cluster_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_clusters_by_cluster_id","parameters":{"cluster_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_clusters_by_cluster_id","parameters":{"cluster_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/compute.ClusterAccessControlRequest","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ClusterAccessControlRequest","x-databricks-legacy-name":"ClusterAccessControlRequest","x-databricks-stable-name":"ClusterAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ClusterPermissionsRequest","x-databricks-legacy-name":"ClusterPermissionsRequest","x-databricks-stable-name":"ClusterPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_clusters_by_cluster_id","parameters":{"cluster_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/compute.ClusterAccessControlRequest","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ClusterAccessControlRequest","x-databricks-legacy-name":"ClusterAccessControlRequest","x-databricks-stable-name":"ClusterAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ClusterPermissionsRequest","x-databricks-legacy-name":"ClusterPermissionsRequest","x-databricks-stable-name":"ClusterPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_clusters_by_cluster_id_permission_levels","parameters":{"cluster_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_clusters_by_cluster_id_permission_levels","parameters":{"cluster_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_experiments_by_experiment_id","parameters":{"experiment_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_experiments_by_experiment_id","parameters":{"experiment_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_experiments_by_experiment_id","parameters":{"experiment_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/ml.ExperimentAccessControlRequest","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ExperimentAccessControlRequest","x-databricks-legacy-name":"ExperimentAccessControlRequest","x-databricks-stable-name":"ExperimentAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ExperimentPermissionsRequest","x-databricks-legacy-name":"ExperimentPermissionsRequest","x-databricks-stable-name":"ExperimentPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_experiments_by_experiment_id","parameters":{"experiment_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/ml.ExperimentAccessControlRequest","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ExperimentAccessControlRequest","x-databricks-legacy-name":"ExperimentAccessControlRequest","x-databricks-stable-name":"ExperimentAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ExperimentPermissionsRequest","x-databricks-legacy-name":"ExperimentPermissionsRequest","x-databricks-stable-name":"ExperimentPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_experiments_by_experiment_id_permission_levels","parameters":{"experiment_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_experiments_by_experiment_id_permission_levels","parameters":{"experiment_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_instance_pools_by_instance_pool_id","parameters":{"instance_pool_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_instance_pools_by_instance_pool_id","parameters":{"instance_pool_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_instance_pools_by_instance_pool_id","parameters":{"instance_pool_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/compute.InstancePoolAccessControlRequest","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"InstancePoolAccessControlRequest","x-databricks-legacy-name":"InstancePoolAccessControlRequest","x-databricks-stable-name":"InstancePoolAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"InstancePoolPermissionsRequest","x-databricks-legacy-name":"InstancePoolPermissionsRequest","x-databricks-stable-name":"InstancePoolPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_instance_pools_by_instance_pool_id","parameters":{"instance_pool_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/compute.InstancePoolAccessControlRequest","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"InstancePoolAccessControlRequest","x-databricks-legacy-name":"InstancePoolAccessControlRequest","x-databricks-stable-name":"InstancePoolAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-sdk-name":"InstancePoolPermissionsRequest","x-databricks-legacy-name":"InstancePoolPermissionsRequest","x-databricks-stable-name":"InstancePoolPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_instance_pools_by_instance_pool_id_permission_levels","parameters":{"instance_pool_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_instance_pools_by_instance_pool_id_permission_levels","parameters":{"instance_pool_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_jobs_by_job_id","parameters":{"job_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_jobs_by_job_id","parameters":{"job_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_jobs_by_job_id","parameters":{"job_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/jobs.JobAccessControlRequest","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-sdk-name":"JobAccessControlRequest","x-databricks-legacy-name":"JobAccessControlRequest","x-databricks-stable-name":"JobAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-sdk-name":"JobPermissionsRequest","x-databricks-legacy-name":"JobPermissionsRequest","x-databricks-stable-name":"JobPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_jobs_by_job_id","parameters":{"job_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/jobs.JobAccessControlRequest","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-sdk-name":"JobAccessControlRequest","x-databricks-legacy-name":"JobAccessControlRequest","x-databricks-stable-name":"JobAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-sdk-name":"JobPermissionsRequest","x-databricks-legacy-name":"JobPermissionsRequest","x-databricks-stable-name":"JobPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_jobs_by_job_id_permission_levels","parameters":{"job_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_jobs_by_job_id_permission_levels","parameters":{"job_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_pipelines_by_pipeline_id","parameters":{"pipeline_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_pipelines_by_pipeline_id","parameters":{"pipeline_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_pipelines_by_pipeline_id","parameters":{"pipeline_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/pipelines.PipelineAccessControlRequest","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-sdk-name":"PipelineAccessControlRequest","x-databricks-legacy-name":"PipelineAccessControlRequest","x-databricks-stable-name":"PipelineAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-sdk-name":"PipelinePermissionsRequest","x-databricks-legacy-name":"PipelinePermissionsRequest","x-databricks-stable-name":"PipelinePermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_pipelines_by_pipeline_id","parameters":{"pipeline_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/pipelines.PipelineAccessControlRequest","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-sdk-name":"PipelineAccessControlRequest","x-databricks-legacy-name":"PipelineAccessControlRequest","x-databricks-stable-name":"PipelineAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-sdk-name":"PipelinePermissionsRequest","x-databricks-legacy-name":"PipelinePermissionsRequest","x-databricks-stable-name":"PipelinePermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_pipelines_by_pipeline_id_permission_levels","parameters":{"pipeline_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_pipelines_by_pipeline_id_permission_levels","parameters":{"pipeline_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_registered_models_by_registered_model_id","parameters":{"registered_model_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_registered_models_by_registered_model_id","parameters":{"registered_model_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_registered_models_by_registered_model_id","parameters":{"registered_model_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/ml.RegisteredModelAccessControlRequest","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RegisteredModelAccessControlRequest","x-databricks-legacy-name":"RegisteredModelAccessControlRequest","x-databricks-stable-name":"RegisteredModelAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RegisteredModelPermissionsRequest","x-databricks-legacy-name":"RegisteredModelPermissionsRequest","x-databricks-stable-name":"RegisteredModelPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_registered_models_by_registered_model_id","parameters":{"registered_model_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/ml.RegisteredModelAccessControlRequest","x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RegisteredModelAccessControlRequest","x-databricks-legacy-name":"RegisteredModelAccessControlRequest","x-databricks-stable-name":"RegisteredModelAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"ml","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RegisteredModelPermissionsRequest","x-databricks-legacy-name":"RegisteredModelPermissionsRequest","x-databricks-stable-name":"RegisteredModelPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_registered_models_by_registered_model_id_permission_levels","parameters":{"registered_model_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_registered_models_by_registered_model_id_permission_levels","parameters":{"registered_model_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_repos_by_repo_id","parameters":{"repo_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_repos_by_repo_id","parameters":{"repo_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_repos_by_repo_id","parameters":{"repo_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/workspace.RepoAccessControlRequest","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RepoAccessControlRequest","x-databricks-legacy-name":"RepoAccessControlRequest","x-databricks-stable-name":"RepoAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RepoPermissionsRequest","x-databricks-legacy-name":"RepoPermissionsRequest","x-databricks-stable-name":"RepoPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_repos_by_repo_id","parameters":{"repo_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/workspace.RepoAccessControlRequest","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RepoAccessControlRequest","x-databricks-legacy-name":"RepoAccessControlRequest","x-databricks-stable-name":"RepoAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RepoPermissionsRequest","x-databricks-legacy-name":"RepoPermissionsRequest","x-databricks-stable-name":"RepoPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_repos_by_repo_id_permission_levels","parameters":{"repo_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_repos_by_repo_id_permission_levels","parameters":{"repo_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_serving_endpoints_by_serving_endpoint_id","parameters":{"serving_endpoint_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_serving_endpoints_by_serving_endpoint_id","parameters":{"serving_endpoint_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_serving_endpoints_by_serving_endpoint_id","parameters":{"serving_endpoint_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/serving.ServingEndpointAccessControlRequest","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ServingEndpointAccessControlRequest","x-databricks-legacy-name":"ServingEndpointAccessControlRequest","x-databricks-stable-name":"ServingEndpointAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ServingEndpointPermissionsRequest","x-databricks-legacy-name":"ServingEndpointPermissionsRequest","x-databricks-stable-name":"ServingEndpointPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_serving_endpoints_by_serving_endpoint_id","parameters":{"serving_endpoint_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/serving.ServingEndpointAccessControlRequest","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ServingEndpointAccessControlRequest","x-databricks-legacy-name":"ServingEndpointAccessControlRequest","x-databricks-stable-name":"ServingEndpointAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ServingEndpointPermissionsRequest","x-databricks-legacy-name":"ServingEndpointPermissionsRequest","x-databricks-stable-name":"ServingEndpointPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_serving_endpoints_by_serving_endpoint_id_permission_levels","parameters":{"serving_endpoint_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_serving_endpoints_by_serving_endpoint_id_permission_levels","parameters":{"serving_endpoint_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_warehouses_by_warehouse_id","parameters":{"warehouse_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_warehouses_by_warehouse_id","parameters":{"warehouse_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_warehouses_by_warehouse_id","parameters":{"warehouse_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/sql.WarehouseAccessControlRequest","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"WarehouseAccessControlRequest","x-databricks-legacy-name":"WarehouseAccessControlRequest","x-databricks-stable-name":"WarehouseAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"WarehousePermissionsRequest","x-databricks-legacy-name":"WarehousePermissionsRequest","x-databricks-stable-name":"WarehousePermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_warehouses_by_warehouse_id","parameters":{"warehouse_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/sql.WarehouseAccessControlRequest","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"WarehouseAccessControlRequest","x-databricks-legacy-name":"WarehouseAccessControlRequest","x-databricks-stable-name":"WarehouseAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"WarehousePermissionsRequest","x-databricks-legacy-name":"WarehousePermissionsRequest","x-databricks-stable-name":"WarehousePermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_warehouses_by_warehouse_id_permission_levels","parameters":{"warehouse_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_warehouses_by_warehouse_id_permission_levels","parameters":{"warehouse_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_by_request_object_type_by_request_object_id","parameters":{"request_object_type":{"type":"string","description":"The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses."},"request_object_id":{"type":"string","description":"The id of the request object."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_by_request_object_type_by_request_object_id","parameters":{"request_object_type":{"type":"string","description":"The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses."},"request_object_id":{"type":"string","description":"The id of the request object."},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/iam.AccessControlRequest","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"permissions.PermissionsRequest.access_control_list.array_value","x-databricks-sdk-name":"AccessControlRequest","x-databricks-legacy-name":"AccessControlRequest","x-databricks-stable-name":"AccessControlRequest"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"permissions.PermissionsRequest.access_control_list"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SetObjectPermissions","x-databricks-legacy-name":"SetObjectPermissions","x-databricks-stable-name":"SetObjectPermissions"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_by_request_object_type_by_request_object_id","parameters":{"request_object_type":{"type":"string","description":"The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses."},"request_object_id":{"type":"string","description":"The id of the request object."},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/iam.AccessControlRequest","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"permissions.PermissionsRequest.access_control_list.array_value","x-databricks-sdk-name":"AccessControlRequest","x-databricks-legacy-name":"AccessControlRequest","x-databricks-stable-name":"AccessControlRequest"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"permissions.PermissionsRequest.access_control_list"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateObjectPermissions","x-databricks-legacy-name":"UpdateObjectPermissions","x-databricks-stable-name":"UpdateObjectPermissions"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_by_request_object_type_by_request_object_id_permission_levels","parameters":{"request_object_type":{"type":"string","description":"The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses."},"request_object_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_by_workspace_object_type_by_workspace_object_id","parameters":{"workspace_object_type":{"type":"string"},"workspace_object_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_by_workspace_object_type_by_workspace_object_id","parameters":{"workspace_object_type":{"type":"string"},"workspace_object_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_permissions_by_workspace_object_type_by_workspace_object_id","parameters":{"workspace_object_type":{"type":"string"},"workspace_object_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/workspace.WorkspaceObjectAccessControlRequest","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-sdk-name":"WorkspaceObjectAccessControlRequest","x-databricks-legacy-name":"WorkspaceObjectAccessControlRequest","x-databricks-stable-name":"WorkspaceObjectAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-sdk-name":"WorkspaceObjectPermissionsRequest","x-databricks-legacy-name":"WorkspaceObjectPermissionsRequest","x-databricks-stable-name":"WorkspaceObjectPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_permissions_by_workspace_object_type_by_workspace_object_id","parameters":{"workspace_object_type":{"type":"string"},"workspace_object_id":{"type":"string"},"data":{"type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/workspace.WorkspaceObjectAccessControlRequest","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-sdk-name":"WorkspaceObjectAccessControlRequest","x-databricks-legacy-name":"WorkspaceObjectAccessControlRequest","x-databricks-stable-name":"WorkspaceObjectAccessControlRequest"},"x-databricks-api-version":"legacy"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-sdk-name":"WorkspaceObjectPermissionsRequest","x-databricks-legacy-name":"WorkspaceObjectPermissionsRequest","x-databricks-stable-name":"WorkspaceObjectPermissionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_permissions_by_workspace_object_type_by_workspace_object_id_permission_levels","parameters":{"workspace_object_type":{"type":"string"},"workspace_object_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_permissions_by_workspace_object_type_by_workspace_object_id_permission_levels","parameters":{"workspace_object_type":{"type":"string"},"workspace_object_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_pipelines","parameters":{"page_token":{"type":"string","description":"Page token returned by previous call"},"max_results":{"type":"integer","description":"The maximum number of entries to return in a single page. The system may\nreturn fewer than max_results events in a response, even if there are\nmore events available. This field is optional. The default value is 25.\nThe maximum value is 100. An error is returned if the value of max_results\nis greater than 100."},"order_by":{"type":"array","description":"A list of strings specifying the order of results.\nSupported order_by fields are id and name. The default is id asc.\nThis field is optional."},"filter":{"type":"string","description":"Select a subset of results based on the specified criteria.\nThe supported filters are:\n\n* `notebook=''` to select pipelines that reference the provided notebook path.\n* `name LIKE '[pattern]'` to select pipelines with a name that matches pattern.\nWildcards are supported, for example: `name LIKE '%shopping%'`\n\nComposite filters are not supported. This field is optional."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_pipelines","parameters":{"data":{"type":"object","properties":{"allow_duplicate_names":{"description":"If false, deployment will fail if name conflicts with that of another pipeline.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.CreatePipeline.allow_duplicate_names","default":"false"},"catalog":{"description":"A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.catalog"},"channel":{"description":"DLT Release Channel that specifies which version to use.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.channel"},"clusters":{"description":"Cluster settings for this pipeline deployment.","type":"array","items":{"$ref":"#/components/schemas/pipelines.PipelineCluster","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.clusters.array_value","x-databricks-sdk-name":"PipelineCluster","x-databricks-legacy-name":"PipelineCluster","x-databricks-stable-name":"PipelineCluster"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.clusters"},"configuration":{"description":"String-String configuration for this pipeline execution.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.common.KeyValue.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.configuration"},"continuous":{"description":"Whether the pipeline is continuous or triggered. This replaces `trigger`.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.continuous"},"deployment":{"description":"Deployment type of this pipeline.","$ref":"#/components/schemas/pipelines.PipelineDeployment","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.deployment","x-databricks-sdk-name":"PipelineDeployment","x-databricks-legacy-name":"PipelineDeployment","x-databricks-stable-name":"PipelineDeployment"},"development":{"description":"Whether the pipeline is in Development mode. Defaults to false.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.development"},"dry_run":{"type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.CreatePipeline.dry_run"},"edition":{"description":"Pipeline product edition.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.edition"},"environment":{"description":"Environment specification for this pipeline used to install dependencies.","$ref":"#/components/schemas/pipelines.PipelinesEnvironment","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_BETA","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"deltapipelines.PipelineSpec.environment","x-databricks-sdk-name":"PipelinesEnvironment","x-databricks-legacy-name":"PipelinesEnvironment","x-databricks-stable-name":"PipelinesEnvironment"},"event_log":{"description":"Event log configuration for this pipeline","$ref":"#/components/schemas/pipelines.EventLogSpec","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.event_log","x-databricks-sdk-name":"EventLogSpec","x-databricks-legacy-name":"EventLogSpec","x-databricks-stable-name":"EventLogSpec"},"filters":{"description":"Filters on which Pipeline packages to include in the deployed graph.","$ref":"#/components/schemas/pipelines.Filters","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.filters","x-databricks-sdk-name":"Filters","x-databricks-legacy-name":"Filters","x-databricks-stable-name":"Filters"},"id":{"description":"Unique identifier for this pipeline.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.id"},"ingestion_definition":{"description":"The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.","$ref":"#/components/schemas/pipelines.IngestionPipelineDefinition","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"deltapipelines.PipelineSpec.ingestion_definition","x-databricks-sdk-name":"IngestionPipelineDefinition","x-databricks-legacy-name":"IngestionPipelineDefinition","x-databricks-stable-name":"IngestionPipelineDefinition"},"libraries":{"description":"Libraries or code needed by this deployment.","type":"array","items":{"$ref":"#/components/schemas/pipelines.PipelineLibrary","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.libraries.array_value","x-databricks-sdk-name":"PipelineLibrary","x-databricks-legacy-name":"PipelineLibrary","x-databricks-stable-name":"PipelineLibrary"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.libraries"},"name":{"description":"Friendly identifier for this pipeline.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.name"},"notifications":{"description":"List of notification settings for this pipeline.","type":"array","items":{"$ref":"#/components/schemas/pipelines.Notifications","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.notifications.array_value","x-databricks-sdk-name":"Notifications","x-databricks-legacy-name":"Notifications","x-databricks-stable-name":"Notifications"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.notifications"},"photon":{"description":"Whether Photon is enabled for this pipeline.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.photon"},"root_path":{"description":"Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.","type":"string","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_BETA","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"deltapipelines.PipelineSpec.root_path","example":"/Workspace/Users/user.name/my-pipeline"},"schema":{"description":"The default schema (database) where tables are read from or published to.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.schema"},"serverless":{"description":"Whether serverless compute is enabled for this pipeline.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.serverless"},"storage":{"description":"DBFS root directory for storing checkpoints and tables.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.storage"},"tags":{"description":"A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.","type":"object","additionalProperties":{"description":"Optional value to be associated with the provided key.\nIf the value is not provided, the key serves as the sole identifier of this key-value pair and the values is assumed to be an empty string.","type":"string","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"deltapipelines.PipelineTag.value"},"x-databricks-api-version":"legacy","x-databricks-launch-stage":"GA","x-databricks-schema-id":"deltapipelines.PipelineSpec.tags","default":{}},"target":{"description":"Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.","type":"string","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"deltapipelines.PipelineSpec.target"},"trigger":{"description":"Which pipeline trigger to use. Deprecated: Use `continuous` instead.","$ref":"#/components/schemas/pipelines.PipelineTrigger","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"deltapipelines.PipelineSpec.trigger","x-databricks-sdk-name":"PipelineTrigger","x-databricks-legacy-name":"PipelineTrigger","x-databricks-stable-name":"PipelineTrigger"}},"x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreatePipeline","x-databricks-legacy-name":"CreatePipeline","x-databricks-stable-name":"CreatePipeline"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_pipelines_by_pipeline_id","parameters":{"pipeline_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_pipelines_by_pipeline_id","parameters":{"pipeline_id":{"type":"string","description":"Unique identifier for this pipeline."},"data":{"type":"object","properties":{"allow_duplicate_names":{"description":"If false, deployment will fail if name has changed and conflicts the name of another pipeline.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.EditPipeline.allow_duplicate_names","default":"false"},"catalog":{"description":"A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.catalog"},"channel":{"description":"DLT Release Channel that specifies which version to use.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.channel"},"clusters":{"description":"Cluster settings for this pipeline deployment.","type":"array","items":{"$ref":"#/components/schemas/pipelines.PipelineCluster","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.clusters.array_value","x-databricks-sdk-name":"PipelineCluster","x-databricks-legacy-name":"PipelineCluster","x-databricks-stable-name":"PipelineCluster"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.clusters"},"configuration":{"description":"String-String configuration for this pipeline execution.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.common.KeyValue.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.configuration"},"continuous":{"description":"Whether the pipeline is continuous or triggered. This replaces `trigger`.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.continuous"},"deployment":{"description":"Deployment type of this pipeline.","$ref":"#/components/schemas/pipelines.PipelineDeployment","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.deployment","x-databricks-sdk-name":"PipelineDeployment","x-databricks-legacy-name":"PipelineDeployment","x-databricks-stable-name":"PipelineDeployment"},"development":{"description":"Whether the pipeline is in Development mode. Defaults to false.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.development"},"edition":{"description":"Pipeline product edition.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.edition"},"environment":{"description":"Environment specification for this pipeline used to install dependencies.","$ref":"#/components/schemas/pipelines.PipelinesEnvironment","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_BETA","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"deltapipelines.PipelineSpec.environment","x-databricks-sdk-name":"PipelinesEnvironment","x-databricks-legacy-name":"PipelinesEnvironment","x-databricks-stable-name":"PipelinesEnvironment"},"event_log":{"description":"Event log configuration for this pipeline","$ref":"#/components/schemas/pipelines.EventLogSpec","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.event_log","x-databricks-sdk-name":"EventLogSpec","x-databricks-legacy-name":"EventLogSpec","x-databricks-stable-name":"EventLogSpec"},"expected_last_modified":{"description":"If present, the last-modified time of the pipeline settings before the edit.\nIf the settings were modified after that time, then the request will fail with\na conflict.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.EditPipeline.expected_last_modified"},"filters":{"description":"Filters on which Pipeline packages to include in the deployed graph.","$ref":"#/components/schemas/pipelines.Filters","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.filters","x-databricks-sdk-name":"Filters","x-databricks-legacy-name":"Filters","x-databricks-stable-name":"Filters"},"id":{"description":"Unique identifier for this pipeline.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.id"},"ingestion_definition":{"description":"The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.","$ref":"#/components/schemas/pipelines.IngestionPipelineDefinition","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"deltapipelines.PipelineSpec.ingestion_definition","x-databricks-sdk-name":"IngestionPipelineDefinition","x-databricks-legacy-name":"IngestionPipelineDefinition","x-databricks-stable-name":"IngestionPipelineDefinition"},"libraries":{"description":"Libraries or code needed by this deployment.","type":"array","items":{"$ref":"#/components/schemas/pipelines.PipelineLibrary","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.libraries.array_value","x-databricks-sdk-name":"PipelineLibrary","x-databricks-legacy-name":"PipelineLibrary","x-databricks-stable-name":"PipelineLibrary"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.libraries"},"name":{"description":"Friendly identifier for this pipeline.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.name"},"notifications":{"description":"List of notification settings for this pipeline.","type":"array","items":{"$ref":"#/components/schemas/pipelines.Notifications","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.notifications.array_value","x-databricks-sdk-name":"Notifications","x-databricks-legacy-name":"Notifications","x-databricks-stable-name":"Notifications"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.notifications"},"photon":{"description":"Whether Photon is enabled for this pipeline.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.photon"},"root_path":{"description":"Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.","type":"string","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_BETA","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"deltapipelines.PipelineSpec.root_path","example":"/Workspace/Users/user.name/my-pipeline"},"schema":{"description":"The default schema (database) where tables are read from or published to.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.schema"},"serverless":{"description":"Whether serverless compute is enabled for this pipeline.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.serverless"},"storage":{"description":"DBFS root directory for storing checkpoints and tables.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.PipelineSpec.storage"},"tags":{"description":"A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.","type":"object","additionalProperties":{"description":"Optional value to be associated with the provided key.\nIf the value is not provided, the key serves as the sole identifier of this key-value pair and the values is assumed to be an empty string.","type":"string","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"deltapipelines.PipelineTag.value"},"x-databricks-api-version":"legacy","x-databricks-launch-stage":"GA","x-databricks-schema-id":"deltapipelines.PipelineSpec.tags","default":{}},"target":{"description":"Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.","type":"string","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"deltapipelines.PipelineSpec.target"},"trigger":{"description":"Which pipeline trigger to use. Deprecated: Use `continuous` instead.","$ref":"#/components/schemas/pipelines.PipelineTrigger","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"deltapipelines.PipelineSpec.trigger","x-databricks-sdk-name":"PipelineTrigger","x-databricks-legacy-name":"PipelineTrigger","x-databricks-stable-name":"PipelineTrigger"}},"x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EditPipeline","x-databricks-legacy-name":"EditPipeline","x-databricks-stable-name":"EditPipeline"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_pipelines_by_pipeline_id","parameters":{"pipeline_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_pipelines_by_pipeline_id_events","parameters":{"pipeline_id":{"type":"string","description":"The pipeline to return events for."},"page_token":{"type":"string","description":"Page token returned by previous call. This field is mutually\nexclusive with all fields in this request except max_results. An error is\nreturned if any fields other than max_results are set when this field is set."},"max_results":{"type":"integer","description":"Max number of entries to return in a single page. The system may return\nfewer than max_results events in a response, even if there are more events\navailable."},"order_by":{"type":"array","description":"A string indicating a sort order by timestamp for the results, for example, [\"timestamp asc\"].\nThe sort order can be ascending or descending. By default, events are returned\nin descending order by timestamp."},"filter":{"type":"string","description":"Criteria to select a subset of results, expressed using a SQL-like syntax.\nThe supported filters are:\n1. level='INFO' (or WARN or ERROR)\n2. level in ('INFO', 'WARN')\n3. id='[event-id]'\n4. timestamp > 'TIMESTAMP' (or >=,<,<=,=)\n\nComposite expressions are supported, for example: level in ('ERROR', 'WARN')\nAND timestamp> '2021-07-22T06:37:33.083Z'"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_pipelines_by_pipeline_id_stop","parameters":{"pipeline_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_pipelines_by_pipeline_id_updates","parameters":{"pipeline_id":{"type":"string","description":"The pipeline to return updates for."},"page_token":{"type":"string","description":"Page token returned by previous call"},"max_results":{"type":"integer","description":"Max number of entries to return in a single page."},"until_update_id":{"type":"string","description":"If present, returns updates until and including this update_id."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_pipelines_by_pipeline_id_updates","parameters":{"pipeline_id":{"type":"string"},"data":{"type":"object","properties":{"cause":{"$ref":"#/components/schemas/pipelines.StartUpdateCause","x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.StartUpdate.cause","x-databricks-sdk-name":"StartUpdateCause","x-databricks-legacy-name":"StartUpdateCause","x-databricks-stable-name":"StartUpdateCause"},"full_refresh":{"description":"If true, this update will reset all tables before running.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.StartUpdate.full_refresh"},"full_refresh_selection":{"description":"A list of tables to update with fullRefresh. If both refresh_selection and\nfull_refresh_selection are empty, this is a full graph update. Full Refresh on a table means\nthat the states of the table will be reset before the refresh.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.StartUpdate.full_refresh_selection.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.StartUpdate.full_refresh_selection"},"refresh_selection":{"description":"A list of tables to update without fullRefresh. If both refresh_selection and\nfull_refresh_selection are empty, this is a full graph update. Full Refresh on a table means\nthat the states of the table will be reset before the refresh.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.StartUpdate.refresh_selection.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.StartUpdate.refresh_selection"},"validate_only":{"description":"If true, this update only validates the correctness of pipeline source code but does not materialize or publish any datasets.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"deltapipelines.StartUpdate.validate_only"}},"x-databricks-package-name":"pipelines","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"StartUpdate","x-databricks-legacy-name":"StartUpdate","x-databricks-stable-name":"StartUpdate"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_pipelines_by_pipeline_id_updates_by_update_id","parameters":{"pipeline_id":{"type":"string","description":"The ID of the pipeline."},"update_id":{"type":"string","description":"The ID of the update."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_policies_clusters_create","parameters":{"data":{"type":"object","properties":{"definition":{"description":"Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).","type":"string","format":"JSON","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.definition","example":{"custom_tags.test_tag":{"type":"fixed","value":"test_value"}}},"description":{"description":"Additional human-readable description of the cluster policy.","type":"string","x-databricks-api-version":"legacy","maxLength":1000,"x-databricks-schema-id":"cluster.PolicyOwnAttributes.description"},"libraries":{"description":"A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.","type":"array","items":{"$ref":"#/components/schemas/compute.Library","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.libraries.array_value","x-databricks-sdk-name":"Library","x-databricks-legacy-name":"Library","x-databricks-stable-name":"Library"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.libraries"},"max_clusters_per_user":{"description":"Max number of clusters per user that can be active using this policy. If not present, there is no max limit.","type":"integer","format":"int64","x-databricks-api-version":"legacy","minimum":1,"x-databricks-schema-id":"cluster.PolicyOwnAttributes.max_clusters_per_user"},"name":{"description":"Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100\ncharacters.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.name"},"policy_family_definition_overrides":{"description":"Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).\nThe JSON document must be passed as a string and cannot be embedded in the requests.\n\nYou can use this to customize the policy definition inherited from the policy family.\nPolicy rules specified here are merged into the inherited policy definition.","type":"string","format":"JSON","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.policy_family_definition_overrides","example":{"custom_tags.test_tag":{"type":"fixed","value":"test_value"}}},"policy_family_id":{"description":"ID of the policy family. The cluster policy's policy definition inherits the policy\nfamily's policy definition.\n\nCannot be used with `definition`. Use `policy_family_definition_overrides` instead to\ncustomize the policy definition.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.policy_family_id"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreatePolicy","x-databricks-legacy-name":"CreatePolicy","x-databricks-stable-name":"CreatePolicy"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_policies_clusters_delete","parameters":{"data":{"type":"object","required":["policy_id"],"properties":{"policy_id":{"description":"The ID of the policy to delete.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.DeletePolicy.policy_id"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeletePolicy","x-databricks-legacy-name":"DeletePolicy","x-databricks-stable-name":"DeletePolicy"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_policies_clusters_edit","parameters":{"data":{"type":"object","required":["policy_id"],"properties":{"definition":{"description":"Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).","type":"string","format":"JSON","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.definition","example":{"custom_tags.test_tag":{"type":"fixed","value":"test_value"}}},"description":{"description":"Additional human-readable description of the cluster policy.","type":"string","x-databricks-api-version":"legacy","maxLength":1000,"x-databricks-schema-id":"cluster.PolicyOwnAttributes.description"},"libraries":{"description":"A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.","type":"array","items":{"$ref":"#/components/schemas/compute.Library","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.libraries.array_value","x-databricks-sdk-name":"Library","x-databricks-legacy-name":"Library","x-databricks-stable-name":"Library"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.libraries"},"max_clusters_per_user":{"description":"Max number of clusters per user that can be active using this policy. If not present, there is no max limit.","type":"integer","format":"int64","x-databricks-api-version":"legacy","minimum":1,"x-databricks-schema-id":"cluster.PolicyOwnAttributes.max_clusters_per_user"},"name":{"description":"Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100\ncharacters.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.name"},"policy_family_definition_overrides":{"description":"Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).\nThe JSON document must be passed as a string and cannot be embedded in the requests.\n\nYou can use this to customize the policy definition inherited from the policy family.\nPolicy rules specified here are merged into the inherited policy definition.","type":"string","format":"JSON","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.policy_family_definition_overrides","example":{"custom_tags.test_tag":{"type":"fixed","value":"test_value"}}},"policy_family_id":{"description":"ID of the policy family. The cluster policy's policy definition inherits the policy\nfamily's policy definition.\n\nCannot be used with `definition`. Use `policy_family_definition_overrides` instead to\ncustomize the policy definition.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PolicyOwnAttributes.policy_family_id"},"policy_id":{"description":"The ID of the policy to update.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.EditPolicy.policy_id"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EditPolicy","x-databricks-legacy-name":"EditPolicy","x-databricks-stable-name":"EditPolicy"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_policies_clusters_enforce_compliance","parameters":{"data":{"type":"object","required":["cluster_id"],"properties":{"cluster_id":{"description":"The ID of the cluster you want to enforce policy compliance on.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.EnforcePolicyComplianceForCluster.cluster_id"},"validate_only":{"description":"If set, previews the changes that would be made to a cluster\nto enforce compliance but does not update the cluster.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.EnforcePolicyComplianceForCluster.validate_only","default":false}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EnforceClusterComplianceRequest","x-databricks-legacy-name":"EnforceClusterComplianceRequest","x-databricks-stable-name":"EnforceClusterComplianceRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_policies_clusters_get","parameters":{"policy_id":{"type":"string","description":"Canonical unique identifier for the Cluster Policy."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_policies_clusters_get_compliance","parameters":{"cluster_id":{"type":"string","description":"The ID of the cluster to get the compliance status"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_policies_clusters_list","parameters":{"sort_order":{"type":"string","description":"The order in which the policies get listed.\n* `DESC` - Sort result list in descending order.\n* `ASC` - Sort result list in ascending order."},"sort_column":{"type":"string","description":"The cluster policy attribute to sort by.\n* `POLICY_CREATION_TIME` - Sort result list by policy creation time.\n* `POLICY_NAME` - Sort result list by policy name."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_policies_clusters_list_compliance","parameters":{"policy_id":{"type":"string","description":"Canonical unique identifier for the cluster policy."},"page_token":{"type":"string","description":"A page token that can be used to navigate to the next page or previous page as\nreturned by `next_page_token` or `prev_page_token`."},"page_size":{"type":"integer","description":"Use this field to specify the maximum number of results to be returned by the server.\nThe server may further constrain the maximum number of results returned in a\nsingle page."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_policies_jobs_enforce_compliance","parameters":{"data":{"type":"object","required":["job_id"],"properties":{"job_id":{"description":"The ID of the job you want to enforce policy compliance on.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.EnforcePolicyComplianceForJob.job_id"},"validate_only":{"description":"If set, previews changes made to the job to comply with its policy, but\ndoes not update the job.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.EnforcePolicyComplianceForJob.validate_only","default":false}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EnforcePolicyComplianceRequest","x-databricks-legacy-name":"EnforcePolicyComplianceRequest","x-databricks-stable-name":"EnforcePolicyComplianceRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_policies_jobs_get_compliance","parameters":{"job_id":{"type":"integer","description":"The ID of the job whose compliance status you are requesting."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_policies_jobs_list_compliance","parameters":{"policy_id":{"type":"string","description":"Canonical unique identifier for the cluster policy."},"page_token":{"type":"string","description":"A page token that can be used to navigate to the next page or previous page as\nreturned by `next_page_token` or `prev_page_token`."},"page_size":{"type":"integer","description":"Use this field to specify the maximum number of results to be returned by the server.\nThe server may further constrain the maximum number of results returned in a\nsingle page."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_policy_families","parameters":{"max_results":{"type":"integer","description":"Maximum number of policy families to return."},"page_token":{"type":"string","description":"A token that can be used to get the next page of results."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_policy_families_by_policy_family_id","parameters":{"policy_family_id":{"type":"string","description":"The family ID about which to retrieve information."},"version":{"type":"integer","description":"The version number for the family to fetch. Defaults to the latest version."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_accounts_access_control_assignable_roles","parameters":{"resource":{"type":"string","description":"The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/` | A resource name for the account.\n`resource=accounts//groups/` | A resource name for the group.\n`resource=accounts//servicePrincipals/` | A resource name for the service principal."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_accounts_access_control_rule_sets","parameters":{"name":{"type":"string","description":"The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts//ruleSets/default` | A name for a rule set on the account.\n`name=accounts//groups//ruleSets/default` | A name for a rule set on the group.\n`name=accounts//servicePrincipals//ruleSets/default` | A name for a rule set on the service principal."},"etag":{"type":"string","description":"Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -> modify -> write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_preview_accounts_access_control_rule_sets","parameters":{"data":{"type":"object","required":["name","rule_set"],"properties":{"name":{"description":"Name of the rule set.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsaccesscontrol.external.UpdateRuleSetRequest.name"},"rule_set":{"$ref":"#/components/schemas/iam.RuleSetUpdateRequest","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"accountsaccesscontrol.external.UpdateRuleSetRequest.rule_set","x-databricks-sdk-name":"RuleSetUpdateRequest","x-databricks-legacy-name":"RuleSetUpdateRequest","x-databricks-stable-name":"RuleSetUpdateRequest"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateRuleSetRequest","x-databricks-legacy-name":"UpdateRuleSetRequest","x-databricks-stable-name":"UpdateRuleSetRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_scim_v2_groups","parameters":{"filter":{"type":"string","description":"Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions."},"attributes":{"type":"string","description":"Comma-separated list of attributes to return in response."},"excludedAttributes":{"type":"string","description":"Comma-separated list of attributes to exclude in response."},"startIndex":{"type":"integer","description":"Specifies the index of the first result. First item is number 1."},"count":{"type":"integer","description":"Desired number of results per page."},"sortBy":{"type":"string","description":"Attribute to sort the results."},"sortOrder":{"type":"string","description":"The order to sort the results."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_scim_v2_groups","parameters":{"data":{"type":"object","properties":{"displayName":{"description":"String that represents a human-readable group name","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iam.Group.display_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"entitlements":{"description":"Entitlements assigned to the group. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.entitlements.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.entitlements"},"externalId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iam.Group.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"groups":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.groups.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.groups"},"id":{"description":"Databricks group ID","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.id"},"members":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.members.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.members"},"roles":{"description":"Corresponds to AWS instance profile/arn role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.roles"},"schemas":{"description":"The schema of the group.","type":"array","items":{"$ref":"#/components/schemas/iam.GroupSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.schemas.array_value","x-databricks-sdk-name":"GroupSchema","x-databricks-legacy-name":"GroupSchema","x-databricks-stable-name":"GroupSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Group","x-databricks-legacy-name":"Group","x-databricks-stable-name":"Group"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_scim_v2_groups_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a group in the Databricks workspace."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_preview_scim_v2_groups_by_id","parameters":{"id":{"type":"string","description":"Databricks group ID"},"data":{"type":"object","properties":{"displayName":{"description":"String that represents a human-readable group name","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iam.Group.display_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"entitlements":{"description":"Entitlements assigned to the group. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.entitlements.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.entitlements"},"externalId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iam.Group.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"groups":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.groups.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.groups"},"id":{"description":"Databricks group ID","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.id"},"members":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.members.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.members"},"roles":{"description":"Corresponds to AWS instance profile/arn role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.roles"},"schemas":{"description":"The schema of the group.","type":"array","items":{"$ref":"#/components/schemas/iam.GroupSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.Group.schemas.array_value","x-databricks-sdk-name":"GroupSchema","x-databricks-legacy-name":"GroupSchema","x-databricks-stable-name":"GroupSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.Group.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Group","x-databricks-legacy-name":"Group","x-databricks-stable-name":"Group"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_preview_scim_v2_groups_by_id","parameters":{"id":{"type":"string","description":"Unique ID in the Databricks workspace."},"data":{"type":"object","properties":{"Operations":{"type":"array","items":{"$ref":"#/components/schemas/iam.Patch","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.PartialUpdate.operations.array_value","x-databricks-sdk-name":"Patch","x-databricks-legacy-name":"Patch","x-databricks-stable-name":"Patch"},"x-databricks-api-version":"legacy","x-databricks-proto-name":"operations","x-databricks-schema-id":"iam.PartialUpdate.operations","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"schemas":{"description":"The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].","type":"array","items":{"$ref":"#/components/schemas/iam.PatchSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.PartialUpdate.schemas.array_value","x-databricks-sdk-name":"PatchSchema","x-databricks-legacy-name":"PatchSchema","x-databricks-stable-name":"PatchSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.PartialUpdate.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PartialUpdate","x-databricks-legacy-name":"PartialUpdate","x-databricks-stable-name":"PartialUpdate"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_preview_scim_v2_groups_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a group in the Databricks workspace."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_scim_v2_me","parameters":{}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_scim_v2_service_principals","parameters":{"attributes":{"type":"string","description":"Comma-separated list of attributes to return in response."},"count":{"type":"integer","description":"Desired number of results per page."},"excludedAttributes":{"type":"string","description":"Comma-separated list of attributes to exclude in response."},"filter":{"type":"string","description":"Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions."},"sortBy":{"type":"string","description":"Attribute to sort the results."},"sortOrder":{"type":"string","description":"The order to sort the results."},"startIndex":{"type":"integer","description":"Specifies the index of the first result. First item is number 1."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_scim_v2_service_principals","parameters":{"data":{"type":"object","properties":{"active":{"description":"If this user is active","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.active"},"applicationId":{"description":"UUID relating to the service principal","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-proto-name":"application_id","x-databricks-schema-id":"iam.ServicePrincipal.application_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"displayName":{"description":"String that represents a concatenation of given and family names.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iam.ServicePrincipal.display_name","example":"etl-service","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"entitlements":{"description":"Entitlements assigned to the service principal. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.ServicePrincipal.entitlements.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.entitlements"},"externalId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iam.ServicePrincipal.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"groups":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.ServicePrincipal.groups.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.groups"},"id":{"description":"Databricks service principal ID.","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.id"},"roles":{"description":"Corresponds to AWS instance profile/arn role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.ServicePrincipal.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.roles"},"schemas":{"description":"The schema of the List response.","type":"array","items":{"$ref":"#/components/schemas/iam.ServicePrincipalSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.ServicePrincipal.schemas.array_value","x-databricks-sdk-name":"ServicePrincipalSchema","x-databricks-legacy-name":"ServicePrincipalSchema","x-databricks-stable-name":"ServicePrincipalSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ServicePrincipal","x-databricks-legacy-name":"ServicePrincipal","x-databricks-stable-name":"ServicePrincipal"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_scim_v2_service_principals_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a service principal in the Databricks workspace."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_preview_scim_v2_service_principals_by_id","parameters":{"id":{"type":"string","description":"Databricks service principal ID."},"data":{"type":"object","properties":{"active":{"description":"If this user is active","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.active"},"applicationId":{"description":"UUID relating to the service principal","type":"string","format":"uuid","x-databricks-api-version":"legacy","x-databricks-proto-name":"application_id","x-databricks-schema-id":"iam.ServicePrincipal.application_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"displayName":{"description":"String that represents a concatenation of given and family names.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iam.ServicePrincipal.display_name","example":"etl-service","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"entitlements":{"description":"Entitlements assigned to the service principal. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.ServicePrincipal.entitlements.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.entitlements"},"externalId":{"type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iam.ServicePrincipal.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"groups":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.ServicePrincipal.groups.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.groups"},"id":{"description":"Databricks service principal ID.","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.id"},"roles":{"description":"Corresponds to AWS instance profile/arn role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.ServicePrincipal.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.roles"},"schemas":{"description":"The schema of the List response.","type":"array","items":{"$ref":"#/components/schemas/iam.ServicePrincipalSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.ServicePrincipal.schemas.array_value","x-databricks-sdk-name":"ServicePrincipalSchema","x-databricks-legacy-name":"ServicePrincipalSchema","x-databricks-stable-name":"ServicePrincipalSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.ServicePrincipal.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ServicePrincipal","x-databricks-legacy-name":"ServicePrincipal","x-databricks-stable-name":"ServicePrincipal"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_preview_scim_v2_service_principals_by_id","parameters":{"id":{"type":"string","description":"Unique ID in the Databricks workspace."},"data":{"type":"object","properties":{"Operations":{"type":"array","items":{"$ref":"#/components/schemas/iam.Patch","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.PartialUpdate.operations.array_value","x-databricks-sdk-name":"Patch","x-databricks-legacy-name":"Patch","x-databricks-stable-name":"Patch"},"x-databricks-api-version":"legacy","x-databricks-proto-name":"operations","x-databricks-schema-id":"iam.PartialUpdate.operations","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"schemas":{"description":"The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].","type":"array","items":{"$ref":"#/components/schemas/iam.PatchSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.PartialUpdate.schemas.array_value","x-databricks-sdk-name":"PatchSchema","x-databricks-legacy-name":"PatchSchema","x-databricks-stable-name":"PatchSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.PartialUpdate.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PartialUpdate","x-databricks-legacy-name":"PartialUpdate","x-databricks-stable-name":"PartialUpdate"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_preview_scim_v2_service_principals_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a service principal in the Databricks workspace."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_scim_v2_users","parameters":{"attributes":{"type":"string","description":"Comma-separated list of attributes to return in response."},"count":{"type":"integer","description":"Desired number of results per page."},"excludedAttributes":{"type":"string","description":"Comma-separated list of attributes to exclude in response."},"filter":{"type":"string","description":"Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions."},"sortBy":{"type":"string","description":"Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`."},"sortOrder":{"type":"string","description":"The order to sort the results."},"startIndex":{"type":"integer","description":"Specifies the index of the first result. First item is number 1."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_scim_v2_users","parameters":{"data":{"type":"object","properties":{"active":{"description":"If this user is active","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.active"},"displayName":{"description":"String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled](https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation). Use Account SCIM APIs to update `displayName`.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iam.User.display_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"emails":{"description":"All the emails associated with the Databricks user.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.emails.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.emails"},"entitlements":{"description":"Entitlements assigned to the user. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.entitlements.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.entitlements"},"externalId":{"description":"External ID is not currently supported. It is reserved for future use.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iam.User.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"groups":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.groups.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.groups"},"id":{"description":"Databricks user ID.","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.id"},"name":{"$ref":"#/components/schemas/iam.Name","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.name","x-databricks-sdk-name":"Name","x-databricks-legacy-name":"Name","x-databricks-stable-name":"Name"},"roles":{"description":"Corresponds to AWS instance profile/arn role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.roles"},"schemas":{"description":"The schema of the user.","type":"array","items":{"$ref":"#/components/schemas/iam.UserSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.schemas.array_value","x-databricks-sdk-name":"UserSchema","x-databricks-legacy-name":"UserSchema","x-databricks-stable-name":"UserSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.schemas"},"userName":{"description":"Email address of the Databricks user.","type":"string","format":"email","x-databricks-api-version":"legacy","x-databricks-proto-name":"user_name","x-databricks-schema-id":"iam.User.user_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"User","x-databricks-legacy-name":"User","x-databricks-stable-name":"User"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_scim_v2_users_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a user in the Databricks workspace."},"attributes":{"type":"string","description":"Comma-separated list of attributes to return in response."},"count":{"type":"integer","description":"Desired number of results per page."},"excludedAttributes":{"type":"string","description":"Comma-separated list of attributes to exclude in response."},"filter":{"type":"string","description":"Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions."},"sortBy":{"type":"string","description":"Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`."},"sortOrder":{"type":"string","description":"The order to sort the results."},"startIndex":{"type":"integer","description":"Specifies the index of the first result. First item is number 1."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_preview_scim_v2_users_by_id","parameters":{"id":{"type":"string","description":"Databricks user ID."},"data":{"type":"object","properties":{"active":{"description":"If this user is active","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.active"},"displayName":{"description":"String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled](https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation). Use Account SCIM APIs to update `displayName`.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"display_name","x-databricks-schema-id":"iam.User.display_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"emails":{"description":"All the emails associated with the Databricks user.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.emails.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.emails"},"entitlements":{"description":"Entitlements assigned to the user. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.entitlements.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.entitlements"},"externalId":{"description":"External ID is not currently supported. It is reserved for future use.","type":"string","x-databricks-api-version":"legacy","x-databricks-proto-name":"external_id","x-databricks-schema-id":"iam.User.external_id","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"groups":{"type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.groups.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.groups"},"id":{"description":"Databricks user ID.","type":"string","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.id"},"name":{"$ref":"#/components/schemas/iam.Name","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.name","x-databricks-sdk-name":"Name","x-databricks-legacy-name":"Name","x-databricks-stable-name":"Name"},"roles":{"description":"Corresponds to AWS instance profile/arn role.","type":"array","items":{"$ref":"#/components/schemas/iam.ComplexValue","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.roles.array_value","x-databricks-sdk-name":"ComplexValue","x-databricks-legacy-name":"ComplexValue","x-databricks-stable-name":"ComplexValue"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.roles"},"schemas":{"description":"The schema of the user.","type":"array","items":{"$ref":"#/components/schemas/iam.UserSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.User.schemas.array_value","x-databricks-sdk-name":"UserSchema","x-databricks-legacy-name":"UserSchema","x-databricks-stable-name":"UserSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.User.schemas"},"userName":{"description":"Email address of the Databricks user.","type":"string","format":"email","x-databricks-api-version":"legacy","x-databricks-proto-name":"user_name","x-databricks-schema-id":"iam.User.user_name","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"User","x-databricks-legacy-name":"User","x-databricks-stable-name":"User"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_preview_scim_v2_users_by_id","parameters":{"id":{"type":"string","description":"Unique ID in the Databricks workspace."},"data":{"type":"object","properties":{"Operations":{"type":"array","items":{"$ref":"#/components/schemas/iam.Patch","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.PartialUpdate.operations.array_value","x-databricks-sdk-name":"Patch","x-databricks-legacy-name":"Patch","x-databricks-stable-name":"Patch"},"x-databricks-api-version":"legacy","x-databricks-proto-name":"operations","x-databricks-schema-id":"iam.PartialUpdate.operations","x-databricks-rule-ignores":[{"group":"wire_name","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"schemas":{"description":"The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].","type":"array","items":{"$ref":"#/components/schemas/iam.PatchSchema","x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.iam.PartialUpdate.schemas.array_value","x-databricks-sdk-name":"PatchSchema","x-databricks-legacy-name":"PatchSchema","x-databricks-stable-name":"PatchSchema"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"iam.PartialUpdate.schemas"}},"x-databricks-package-name":"iam","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PartialUpdate","x-databricks-legacy-name":"PartialUpdate","x-databricks-stable-name":"PartialUpdate"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_preview_scim_v2_users_by_id","parameters":{"id":{"type":"string","description":"Unique ID for a user in the Databricks workspace."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_sql_alerts","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_sql_alerts","parameters":{"data":{"type":"object","required":["name","options","query_id"],"properties":{"name":{"description":"Name of the alert.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.CreateAlert.name","example":"Total Trips > 300"},"options":{"description":"Alert configuration options.","$ref":"#/components/schemas/sql.AlertOptions","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.CreateAlert.options","x-databricks-sdk-name":"AlertOptions","x-databricks-legacy-name":"AlertOptions","x-databricks-stable-name":"AlertOptions"},"parent":{"description":"The identifier of the workspace folder containing the object.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.CreateAlert.parent","default":"folders/HOME","example":"folders/2025532471912059"},"query_id":{"description":"Query ID.","type":"string","format":"UUID","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.CreateAlert.query_id","example":"dee5cca8-1c79-4b5e-a711-e7f9d241bdf6"},"rearm":{"description":"Number of seconds after being triggered before the alert rearms itself and can be triggered again. If `null`, alert will never be triggered again.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.CreateAlert.rearm"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateAlert","x-databricks-legacy-name":"CreateAlert","x-databricks-stable-name":"CreateAlert"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_sql_alerts_by_alert_id","parameters":{"alert_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_preview_sql_alerts_by_alert_id","parameters":{"alert_id":{"type":"string"},"data":{"type":"object","required":["name","options","query_id"],"properties":{"name":{"description":"Name of the alert.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.EditAlert.name","example":"Total Trips > 300"},"options":{"description":"Alert configuration options.","$ref":"#/components/schemas/sql.AlertOptions","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.EditAlert.options","x-databricks-sdk-name":"AlertOptions","x-databricks-legacy-name":"AlertOptions","x-databricks-stable-name":"AlertOptions"},"query_id":{"description":"Query ID.","type":"string","format":"UUID","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.EditAlert.query_id","example":"dee5cca8-1c79-4b5e-a711-e7f9d241bdf6"},"rearm":{"description":"Number of seconds after being triggered before the alert rearms itself and can be triggered again. If `null`, alert will never be triggered again.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.EditAlert.rearm"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EditAlert","x-databricks-legacy-name":"EditAlert","x-databricks-stable-name":"EditAlert"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_preview_sql_alerts_by_alert_id","parameters":{"alert_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_sql_dashboards","parameters":{"order":{"type":"string","description":"Name of dashboard attribute to order by."},"page":{"type":"integer","description":"Page number to retrieve."},"page_size":{"type":"integer","description":"Number of dashboards to return per page."},"q":{"type":"string","description":"Full text search term."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_sql_dashboards_trash_by_dashboard_id","parameters":{"dashboard_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_sql_dashboards_by_dashboard_id","parameters":{"dashboard_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_sql_dashboards_by_dashboard_id","parameters":{"dashboard_id":{"type":"string"},"data":{"type":"object","properties":{"name":{"description":"The title of this dashboard that appears in list views and at the top of the dashboard page.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.DashboardEditContent.name","example":"Sales Dashboard"},"run_as_role":{"description":"Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)","$ref":"#/components/schemas/sql.RunAsRole","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.DashboardEditContent.run_as_role","x-databricks-sdk-name":"RunAsRole","x-databricks-legacy-name":"RunAsRole","x-databricks-stable-name":"RunAsRole"},"tags":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.redash.DashboardEditContent.tags.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.DashboardEditContent.tags"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DashboardEditContent","x-databricks-legacy-name":"DashboardEditContent","x-databricks-stable-name":"DashboardEditContent"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_preview_sql_dashboards_by_dashboard_id","parameters":{"dashboard_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_sql_data_sources","parameters":{}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_sql_permissions_by_object_type_by_object_id","parameters":{"objectType":{"type":"string","description":"The type of object permissions to check."},"objectId":{"type":"string","description":"Object ID. An ACL is returned for the object with this UUID."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_sql_permissions_by_object_type_by_object_id","parameters":{"objectType":{"type":"string","description":"The type of object permission to set."},"objectId":{"type":"string","description":"Object ID. The ACL for the object with this UUID is overwritten by this request's POST content."},"data":{"description":"Set object ACL","type":"object","properties":{"access_control_list":{"type":"array","items":{"$ref":"#/components/schemas/sql.AccessControl","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.redash.SetRequest.access_control_list.array_value","x-databricks-sdk-name":"AccessControl","x-databricks-legacy-name":"AccessControl","x-databricks-stable-name":"AccessControl"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.SetRequest.access_control_list"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SetRequest","x-databricks-legacy-name":"SetRequest","x-databricks-stable-name":"SetRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_sql_permissions_by_object_type_by_object_id_transfer","parameters":{"objectType":{"type":"string","description":"The type of object on which to change ownership."},"objectId":{"type":"object","description":"The ID of the object on which to change ownership."},"data":{"type":"object","properties":{"new_owner":{"description":"Email address for the new owner, who must exist in the workspace.","type":"string","format":"email","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.TransferOwnershipRequest.new_owner"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"TransferOwnershipRequest","x-databricks-legacy-name":"TransferOwnershipRequest","x-databricks-stable-name":"TransferOwnershipRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_sql_queries","parameters":{"order":{"type":"string","description":"Name of query attribute to order by. Default sort order is ascending. Append a dash (`-`) to order descending instead.\n\n- `name`: The name of the query.\n\n- `created_at`: The timestamp the query was created.\n\n- `runtime`: The time it took to run this query. This is blank for parameterized queries. A blank value is treated as the highest value for sorting.\n\n- `executed_at`: The timestamp when the query was last run.\n\n- `created_by`: The user name of the user that created the query."},"page":{"type":"integer","description":"Page number to retrieve."},"page_size":{"type":"integer","description":"Number of queries to return per page."},"q":{"type":"string","description":"Full text search term"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_sql_queries","parameters":{"data":{"type":"object","properties":{"data_source_id":{"description":"Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. [Learn more](https://docs.databricks.com/api/workspace/datasources/list)","type":"string","format":"UUID","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryPostContent.data_source_id","example":"0c205e24-5db2-4940-adb1-fb13c7ce960b"},"description":{"description":"General description that conveys additional information about this query such as usage notes.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryPostContent.description","example":"Summarizes total order dollars for customers in the Europe/Asia region."},"name":{"description":"The title of this query that appears in list views, widget headings, and on the query page.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryPostContent.name","example":"Orders by month by customer"},"options":{"description":"Exclusively used for storing a list parameter definitions. A parameter is an object with `title`, `name`, `type`, and `value` properties. The `value` field here is the default value. It can be overridden at runtime.","x-databricks-any":true,"x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryPostContent.options","example":{"parameters":[{"name":"param","title":"customer","type":"text","value":"acme"}]},"x-databricks-rule-ignores":[{"group":"any","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"parent":{"description":"The identifier of the workspace folder containing the object.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryPostContent.parent","default":"folders/HOME","example":"folders/2025532471912059"},"query":{"description":"The text of the query to be run.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryPostContent.query","example":"SELECT field FROM table WHERE field = {{ param }}"},"run_as_role":{"description":"Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)","$ref":"#/components/schemas/sql.RunAsRole","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryPostContent.run_as_role","x-databricks-sdk-name":"RunAsRole","x-databricks-legacy-name":"RunAsRole","x-databricks-stable-name":"RunAsRole"},"tags":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.redash.QueryPostContent.tags.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryPostContent.tags"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"QueryPostContent","x-databricks-legacy-name":"QueryPostContent","x-databricks-stable-name":"QueryPostContent"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_sql_queries_trash_by_query_id","parameters":{"query_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_preview_sql_queries_by_query_id","parameters":{"query_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_preview_sql_queries_by_query_id","parameters":{"query_id":{"type":"string"},"data":{"type":"object","properties":{"data_source_id":{"description":"Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. [Learn more](https://docs.databricks.com/api/workspace/datasources/list)","type":"string","format":"UUID","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryEditContent.data_source_id","example":"0c205e24-5db2-4940-adb1-fb13c7ce960b"},"description":{"description":"General description that conveys additional information about this query such as usage notes.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryEditContent.description","example":"Summarizes total order dollars for customers in the Europe/Asia region."},"name":{"description":"The title of this query that appears in list views, widget headings, and on the query page.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryEditContent.name","example":"Orders by month by customer"},"options":{"description":"Exclusively used for storing a list parameter definitions. A parameter is an object with `title`, `name`, `type`, and `value` properties. The `value` field here is the default value. It can be overridden at runtime.","x-databricks-any":true,"x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryEditContent.options","example":{"parameters":[{"name":"param","title":"customer","type":"text","value":"acme"}]},"x-databricks-rule-ignores":[{"group":"any","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]},"query":{"description":"The text of the query to be run.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryEditContent.query","example":"SELECT field FROM table WHERE field = {{ param }}"},"run_as_role":{"description":"Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)","$ref":"#/components/schemas/sql.RunAsRole","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryEditContent.run_as_role","x-databricks-sdk-name":"RunAsRole","x-databricks-legacy-name":"RunAsRole","x-databricks-stable-name":"RunAsRole"},"tags":{"type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.redash.QueryEditContent.tags.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"redash.QueryEditContent.tags"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"QueryEditContent","x-databricks-legacy-name":"QueryEditContent","x-databricks-stable-name":"QueryEditContent"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_preview_sql_queries_by_query_id","parameters":{"query_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_quality_monitors","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_quality_monitors","parameters":{"data":{"type":"object","required":["object_type","object_id"],"properties":{"anomaly_detection_config":{"$ref":"#/components/schemas/qualitymonitorv2.AnomalyDetectionConfig","x-databricks-package-name":"QualityMonitor.v2","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"datamonitoring.QualityMonitor.anomaly_detection_config","x-databricks-sdk-name":"AnomalyDetectionConfig","x-databricks-legacy-name":"AnomalyDetectionConfig","x-databricks-stable-name":"AnomalyDetectionConfig"},"object_id":{"description":"The uuid of the request object. For example, schema id.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"datamonitoring.QualityMonitor.object_id"},"object_type":{"description":"The type of the monitored object. Can be one of the following: schema.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"datamonitoring.QualityMonitor.object_type","example":"schema"}},"x-databricks-package-name":"qualitymonitorv2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"QualityMonitor","x-databricks-legacy-name":"QualityMonitor","x-databricks-stable-name":"QualityMonitor"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_quality_monitors_by_object_type_by_object_id","parameters":{"object_type":{"type":"string","description":"The type of the monitored object. Can be one of the following: schema."},"object_id":{"type":"string","description":"The uuid of the request object. For example, schema id."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_quality_monitors_by_object_type_by_object_id","parameters":{"object_type":{"type":"string","description":"The type of the monitored object. Can be one of the following: schema."},"object_id":{"type":"string","description":"The uuid of the request object. For example, schema id."},"data":{"type":"object","required":["object_type","object_id"],"properties":{"anomaly_detection_config":{"$ref":"#/components/schemas/qualitymonitorv2.AnomalyDetectionConfig","x-databricks-package-name":"QualityMonitor.v2","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"datamonitoring.QualityMonitor.anomaly_detection_config","x-databricks-sdk-name":"AnomalyDetectionConfig","x-databricks-legacy-name":"AnomalyDetectionConfig","x-databricks-stable-name":"AnomalyDetectionConfig"},"object_id":{"description":"The uuid of the request object. For example, schema id.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"datamonitoring.QualityMonitor.object_id"},"object_type":{"description":"The type of the monitored object. Can be one of the following: schema.","type":"string","x-databricks-field-behaviors":["REQUIRED"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"datamonitoring.QualityMonitor.object_type","example":"schema"}},"x-databricks-package-name":"qualitymonitorv2","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"QualityMonitor","x-databricks-legacy-name":"QualityMonitor","x-databricks-stable-name":"QualityMonitor"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_quality_monitors_by_object_type_by_object_id","parameters":{"object_type":{"type":"string","description":"The type of the monitored object. Can be one of the following: schema."},"object_id":{"type":"string","description":"The uuid of the request object. For example, schema id."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_repos","parameters":{"path_prefix":{"type":"string","description":"Filters repos that have paths starting with the given path prefix.\nIf not provided or when provided an effectively empty prefix (`/` or `/Workspace`)\nGit folders (repos) from `/Workspace/Repos` will be served."},"next_page_token":{"type":"string","description":"Token used to get the next page of results. If not specified, returns the first page of\nresults as well as a next page token if there are more results."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_repos","parameters":{"data":{"type":"object","required":["url","provider"],"properties":{"path":{"description":"Desired path for the repo in the workspace. Almost any path in the workspace can be chosen.\nIf repo is created in `/Repos`, path must be in the format `/Repos/{folder}/{repo-name}`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"projects.CreateRepo.path","example":"/Users/user@company.com/testrepo"},"provider":{"description":"Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices`, `gitHubEnterprise`, `bitbucketServer`,\n`gitLabEnterpriseEdition` and `awsCodeCommit`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"projects.CreateRepo.provider","example":"gitHub"},"sparse_checkout":{"description":"If specified, the repo will be created with sparse checkout enabled. You cannot enable/disable\nsparse checkout after the repo is created.","$ref":"#/components/schemas/workspace.SparseCheckout","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-schema-id":"projects.CreateRepo.sparse_checkout","x-databricks-sdk-name":"SparseCheckout","x-databricks-legacy-name":"SparseCheckout","x-databricks-stable-name":"SparseCheckout"},"url":{"description":"URL of the Git repository to be linked.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"projects.CreateRepo.url","example":"https://github.com/databricks/cli.git"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateRepoRequest","x-databricks-legacy-name":"CreateRepoRequest","x-databricks-stable-name":"CreateRepoRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_repos_by_repo_id","parameters":{"repo_id":{"type":"integer","description":"ID of the Git folder (repo) object in the workspace."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_repos_by_repo_id","parameters":{"repo_id":{"type":"integer","description":"ID of the Git folder (repo) object in the workspace."},"data":{"type":"object","properties":{"branch":{"description":"Branch that the local version of the repo is checked out to.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"projects.UpdateRepo.branch","example":"main"},"sparse_checkout":{"description":"If specified, update the sparse checkout settings. The update will fail if sparse checkout is\nnot enabled for the repo.","$ref":"#/components/schemas/workspace.SparseCheckoutUpdate","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-schema-id":"projects.UpdateRepo.sparse_checkout","x-databricks-sdk-name":"SparseCheckoutUpdate","x-databricks-legacy-name":"SparseCheckoutUpdate","x-databricks-stable-name":"SparseCheckoutUpdate"},"tag":{"description":"Tag that the local version of the repo is checked out to. Updating the repo to a tag puts\nthe repo in a detached HEAD state. Before committing new changes, you must update the repo to\na branch instead of the detached HEAD.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"projects.UpdateRepo.tag","example":"v1.0"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateRepoRequest","x-databricks-legacy-name":"UpdateRepoRequest","x-databricks-stable-name":"UpdateRepoRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_repos_by_repo_id","parameters":{"repo_id":{"type":"integer","description":"The ID for the corresponding repo to delete."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_secrets_acls_delete","parameters":{"data":{"type":"object","required":["scope","principal"],"properties":{"principal":{"description":"The principal to remove an existing ACL from.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.DeleteAcl.principal"},"scope":{"description":"The name of the scope to remove permissions from.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.DeleteAcl.scope"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteAcl","x-databricks-legacy-name":"DeleteAcl","x-databricks-stable-name":"DeleteAcl"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_secrets_acls_get","parameters":{"scope":{"type":"string","description":"The name of the scope to fetch ACL information from."},"principal":{"type":"string","description":"The principal to fetch ACL information for."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_secrets_acls_list","parameters":{"scope":{"type":"string","description":"The name of the scope to fetch ACL information from."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_secrets_acls_put","parameters":{"data":{"type":"object","required":["scope","principal","permission"],"properties":{"permission":{"description":"The permission level applied to the principal.","$ref":"#/components/schemas/workspace.AclPermission","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.AclItem.permission","x-databricks-sdk-name":"AclPermission","x-databricks-legacy-name":"AclPermission","x-databricks-stable-name":"AclPermission"},"principal":{"description":"The principal in which the permission is applied.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.AclItem.principal"},"scope":{"description":"The name of the scope to apply permissions to.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.PutAcl.scope"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PutAcl","x-databricks-legacy-name":"PutAcl","x-databricks-stable-name":"PutAcl"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_secrets_delete","parameters":{"data":{"type":"object","required":["scope","key"],"properties":{"key":{"description":"Name of the secret to delete.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.DeleteSecret.key"},"scope":{"description":"The name of the scope that contains the secret to delete.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.DeleteSecret.scope"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteSecret","x-databricks-legacy-name":"DeleteSecret","x-databricks-stable-name":"DeleteSecret"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_secrets_get","parameters":{"scope":{"type":"string","description":"The name of the scope that contains the secret."},"key":{"type":"string","description":"Name of the secret to fetch value information."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_secrets_list","parameters":{"scope":{"type":"string","description":"The name of the scope to list secrets within."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_secrets_put","parameters":{"data":{"type":"object","required":["scope","key"],"properties":{"bytes_value":{"description":"If specified, value will be stored as bytes.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.PutSecret.bytes_value"},"key":{"description":"A unique name to identify the secret.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.PutSecret.key"},"scope":{"description":"The name of the scope to which the secret will be associated with.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.PutSecret.scope"},"string_value":{"description":"If specified, note that the value will be stored in UTF-8 (MB4) form.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.PutSecret.string_value"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PutSecret","x-databricks-legacy-name":"PutSecret","x-databricks-stable-name":"PutSecret"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_secrets_scopes_create","parameters":{"data":{"type":"object","required":["scope"],"properties":{"initial_manage_principal":{"description":"The principal that is initially granted ``MANAGE`` permission to the created scope.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.CreateScope.initial_manage_principal"},"scope":{"description":"Scope name requested by the user. Scope names are unique.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.CreateScope.scope"},"scope_backend_type":{"description":"The backend type the scope will be created with. If not specified, will default to ``DATABRICKS``","$ref":"#/components/schemas/workspace.ScopeBackendType","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.CreateScope.scope_backend_type","x-databricks-sdk-name":"ScopeBackendType","x-databricks-legacy-name":"ScopeBackendType","x-databricks-stable-name":"ScopeBackendType"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateScope","x-databricks-legacy-name":"CreateScope","x-databricks-stable-name":"CreateScope"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_secrets_scopes_delete","parameters":{"data":{"type":"object","required":["scope"],"properties":{"scope":{"description":"Name of the scope to delete.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"secret.DeleteScope.scope"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteScope","x-databricks-legacy-name":"DeleteScope","x-databricks-stable-name":"DeleteScope"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_secrets_scopes_list","parameters":{}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_serving_endpoints","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_serving_endpoints","parameters":{"data":{"type":"object","required":["name"],"properties":{"ai_gateway":{"description":"The AI Gateway configuration for the serving endpoint. NOTE: External model, provisioned throughput, and pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.","$ref":"#/components/schemas/serving.AiGatewayConfig","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.ai_gateway","x-databricks-sdk-name":"AiGatewayConfig","x-databricks-legacy-name":"AiGatewayConfig","x-databricks-stable-name":"AiGatewayConfig"},"budget_policy_id":{"description":"The budget policy to be applied to the serving endpoint.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.budget_policy_id"},"config":{"description":"The core config of the serving endpoint.","$ref":"#/components/schemas/serving.EndpointCoreConfigInput","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.config","x-databricks-sdk-name":"EndpointCoreConfigInput","x-databricks-legacy-name":"EndpointCoreConfigInput","x-databricks-stable-name":"EndpointCoreConfigInput"},"description":{"type":"string","x-databricks-api-version":"legacy","maxLength":1000,"x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.description"},"email_notifications":{"description":"Email notification settings.","$ref":"#/components/schemas/serving.EmailNotifications","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.email_notifications","x-databricks-sdk-name":"EmailNotifications","x-databricks-legacy-name":"EmailNotifications","x-databricks-stable-name":"EmailNotifications"},"name":{"description":"The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.name","example":"feed-ads"},"rate_limits":{"description":"Rate limits to be applied to the serving endpoint. NOTE: this field is deprecated, please use AI Gateway to manage rate limits.","type":"array","items":{"$ref":"#/components/schemas/serving.RateLimit","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.rate_limits.array_value","x-databricks-sdk-name":"RateLimit","x-databricks-legacy-name":"RateLimit","x-databricks-stable-name":"RateLimit"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.rate_limits"},"route_optimized":{"description":"Enable route optimization for the serving endpoint.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.route_optimized","example":true},"tags":{"description":"Tags to be attached to the serving endpoint and automatically propagated to billing logs.","type":"array","items":{"$ref":"#/components/schemas/serving.EndpointTag","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.tags.array_value","x-databricks-sdk-name":"EndpointTag","x-databricks-legacy-name":"EndpointTag","x-databricks-stable-name":"EndpointTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreateInferenceEndpoint.tags"}},"x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateServingEndpoint","x-databricks-legacy-name":"CreateServingEndpoint","x-databricks-stable-name":"CreateServingEndpoint"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_serving_endpoints_pt","parameters":{"data":{"type":"object","required":["name","config"],"properties":{"ai_gateway":{"description":"The AI Gateway configuration for the serving endpoint.","$ref":"#/components/schemas/serving.AiGatewayConfig","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreatePtEndpoint.ai_gateway","x-databricks-sdk-name":"AiGatewayConfig","x-databricks-legacy-name":"AiGatewayConfig","x-databricks-stable-name":"AiGatewayConfig"},"budget_policy_id":{"description":"The budget policy associated with the endpoint.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreatePtEndpoint.budget_policy_id"},"config":{"description":"The core config of the serving endpoint.","$ref":"#/components/schemas/serving.PtEndpointCoreConfig","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreatePtEndpoint.config","x-databricks-sdk-name":"PtEndpointCoreConfig","x-databricks-legacy-name":"PtEndpointCoreConfig","x-databricks-stable-name":"PtEndpointCoreConfig"},"email_notifications":{"description":"Email notification settings.","$ref":"#/components/schemas/serving.EmailNotifications","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreatePtEndpoint.email_notifications","x-databricks-sdk-name":"EmailNotifications","x-databricks-legacy-name":"EmailNotifications","x-databricks-stable-name":"EmailNotifications"},"name":{"description":"The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreatePtEndpoint.name","example":"feed-ads"},"tags":{"description":"Tags to be attached to the serving endpoint and automatically propagated to billing logs.","type":"array","items":{"$ref":"#/components/schemas/serving.EndpointTag","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreatePtEndpoint.tags.array_value","x-databricks-sdk-name":"EndpointTag","x-databricks-legacy-name":"EndpointTag","x-databricks-stable-name":"EndpointTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.CreatePtEndpoint.tags"}},"x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreatePtEndpointRequest","x-databricks-legacy-name":"CreatePtEndpointRequest","x-databricks-stable-name":"CreatePtEndpointRequest"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_serving_endpoints_pt_by_name_config","parameters":{"name":{"type":"string","description":"The name of the pt endpoint to update. This field is required."},"data":{"type":"object","required":["config"],"properties":{"config":{"$ref":"#/components/schemas/serving.PtEndpointCoreConfig","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.PutPtEndpointConfig.config","x-databricks-sdk-name":"PtEndpointCoreConfig","x-databricks-legacy-name":"PtEndpointCoreConfig","x-databricks-stable-name":"PtEndpointCoreConfig"}},"x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateProvisionedThroughputEndpointConfigRequest","x-databricks-legacy-name":"UpdateProvisionedThroughputEndpointConfigRequest","x-databricks-stable-name":"UpdateProvisionedThroughputEndpointConfigRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_serving_endpoints_by_name","parameters":{"name":{"type":"string","description":"The name of the serving endpoint. This field is required."}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_serving_endpoints_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_serving_endpoints_by_name_ai_gateway","parameters":{"name":{"type":"string","description":"The name of the serving endpoint whose AI Gateway is being updated. This field is required."},"data":{"type":"object","properties":{"fallback_config":{"description":"Configuration for traffic fallback which auto fallbacks to other served entities if the request to a served\nentity fails with certain error codes, to increase availability.","$ref":"#/components/schemas/serving.FallbackConfig","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"aigatewayapi.AiGatewayConfig.fallback_config","x-databricks-sdk-name":"FallbackConfig","x-databricks-legacy-name":"FallbackConfig","x-databricks-stable-name":"FallbackConfig"},"guardrails":{"description":"Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.","$ref":"#/components/schemas/serving.AiGatewayGuardrails","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"aigatewayapi.AiGatewayConfig.guardrails","x-databricks-sdk-name":"AiGatewayGuardrails","x-databricks-legacy-name":"AiGatewayGuardrails","x-databricks-stable-name":"AiGatewayGuardrails"},"inference_table_config":{"description":"Configuration for payload logging using inference tables.\nUse these tables to monitor and audit data being sent to and received from model APIs and to improve model quality.","$ref":"#/components/schemas/serving.AiGatewayInferenceTableConfig","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"aigatewayapi.AiGatewayConfig.inference_table_config","x-databricks-sdk-name":"AiGatewayInferenceTableConfig","x-databricks-legacy-name":"AiGatewayInferenceTableConfig","x-databricks-stable-name":"AiGatewayInferenceTableConfig"},"rate_limits":{"description":"Configuration for rate limits which can be set to limit endpoint traffic.","type":"array","items":{"$ref":"#/components/schemas/serving.AiGatewayRateLimit","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.aigatewayapi.AiGatewayConfig.rate_limits.array_value","x-databricks-sdk-name":"AiGatewayRateLimit","x-databricks-legacy-name":"AiGatewayRateLimit","x-databricks-stable-name":"AiGatewayRateLimit"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"aigatewayapi.AiGatewayConfig.rate_limits"},"usage_tracking_config":{"description":"Configuration to enable usage tracking using system tables.\nThese tables allow you to monitor operational usage on endpoints and their associated costs.","$ref":"#/components/schemas/serving.AiGatewayUsageTrackingConfig","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"aigatewayapi.AiGatewayConfig.usage_tracking_config","x-databricks-sdk-name":"AiGatewayUsageTrackingConfig","x-databricks-legacy-name":"AiGatewayUsageTrackingConfig","x-databricks-stable-name":"AiGatewayUsageTrackingConfig"}},"x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PutAiGatewayRequest","x-databricks-legacy-name":"PutAiGatewayRequest","x-databricks-stable-name":"PutAiGatewayRequest"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_serving_endpoints_by_name_config","parameters":{"name":{"type":"string","description":"The name of the serving endpoint to update. This field is required."},"data":{"type":"object","properties":{"auto_capture_config":{"description":"Configuration for Inference Tables which automatically logs requests and responses to Unity Catalog.\nNote: this field is deprecated for creating new provisioned throughput endpoints,\nor updating existing provisioned throughput endpoints that never have inference table configured;\nin these cases please use AI Gateway to manage inference tables.","$ref":"#/components/schemas/serving.AutoCaptureConfigInput","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.EndpointCoreConfig.auto_capture_config","x-databricks-sdk-name":"AutoCaptureConfigInput","x-databricks-legacy-name":"AutoCaptureConfigInput","x-databricks-stable-name":"AutoCaptureConfigInput"},"served_entities":{"description":"The list of served entities under the serving endpoint config.","type":"array","items":{"$ref":"#/components/schemas/serving.ServedEntityInput","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.EndpointCoreConfig.served_entities.array_value","x-databricks-sdk-name":"ServedEntityInput","x-databricks-legacy-name":"ServedEntityInput","x-databricks-stable-name":"ServedEntityInput"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.EndpointCoreConfig.served_entities"},"served_models":{"description":"(Deprecated, use served_entities instead) The list of served models under the serving endpoint config.","type":"array","items":{"$ref":"#/components/schemas/serving.ServedModelInput","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.EndpointCoreConfig.served_models.array_value","x-databricks-sdk-name":"ServedModelInput","x-databricks-legacy-name":"ServedModelInput","x-databricks-stable-name":"ServedModelInput"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.EndpointCoreConfig.served_models"},"traffic_config":{"description":"The traffic configuration associated with the serving endpoint config.","$ref":"#/components/schemas/serving.TrafficConfig","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.EndpointCoreConfig.traffic_config","x-databricks-sdk-name":"TrafficConfig","x-databricks-legacy-name":"TrafficConfig","x-databricks-stable-name":"TrafficConfig"}},"x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EndpointCoreConfigInput","x-databricks-legacy-name":"EndpointCoreConfigInput","x-databricks-stable-name":"EndpointCoreConfigInput"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_serving_endpoints_by_name_metrics","parameters":{"name":{"type":"string","description":"The name of the serving endpoint to retrieve metrics for. This field is required."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_serving_endpoints_by_name_openapi","parameters":{"name":{"type":"string","description":"The name of the serving endpoint that the served model belongs to. This field is required."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_serving_endpoints_by_name_rate_limits","parameters":{"name":{"type":"string","description":"The name of the serving endpoint whose rate limits are being updated. This field is required."},"data":{"type":"object","properties":{"rate_limits":{"description":"The list of endpoint rate limits.","type":"array","items":{"$ref":"#/components/schemas/serving.RateLimit","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.PutInferenceEndpointRateLimits.rate_limits.array_value","x-databricks-sdk-name":"RateLimit","x-databricks-legacy-name":"RateLimit","x-databricks-stable-name":"RateLimit"},"x-databricks-api-version":"legacy","x-databricks-launch-stage":"PUBLIC_PREVIEW","x-databricks-preview":"PUBLIC","x-databricks-schema-id":"modelservingapi.PutInferenceEndpointRateLimits.rate_limits"}},"x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PutRequest","x-databricks-legacy-name":"PutRequest","x-databricks-stable-name":"PutRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_serving_endpoints_by_name_served_models_by_served_model_name_build_logs","parameters":{"name":{"type":"string","description":"The name of the serving endpoint that the served model belongs to. This field is required."},"served_model_name":{"type":"string","description":"The name of the served model that build logs will be retrieved for. This field is required."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_serving_endpoints_by_name_served_models_by_served_model_name_logs","parameters":{"name":{"type":"string","description":"The name of the serving endpoint that the served model belongs to. This field is required."},"served_model_name":{"type":"string","description":"The name of the served model that logs will be retrieved for. This field is required."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_serving_endpoints_by_name_tags","parameters":{"name":{"type":"string","description":"The name of the serving endpoint who's tags to patch. This field is required."},"data":{"type":"object","properties":{"add_tags":{"description":"List of endpoint tags to add","type":"array","items":{"$ref":"#/components/schemas/serving.EndpointTag","x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.PatchInferenceEndpointTags.add_tags.array_value","x-databricks-sdk-name":"EndpointTag","x-databricks-legacy-name":"EndpointTag","x-databricks-stable-name":"EndpointTag"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.PatchInferenceEndpointTags.add_tags"},"delete_tags":{"description":"List of tag keys to delete","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.PatchInferenceEndpointTags.delete_tags.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"modelservingapi.PatchInferenceEndpointTags.delete_tags"}},"x-databricks-package-name":"serving","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PatchServingEndpointTags","x-databricks-legacy-name":"PatchServingEndpointTags","x-databricks-stable-name":"PatchServingEndpointTags"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_aibi_dash_embed_ws_acc_policy_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_aibi_dash_embed_ws_acc_policy_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.AibiDashboardEmbeddingAccessPolicySetting","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"AibiDashboardEmbeddingAccessPolicySetting","x-databricks-legacy-name":"AibiDashboardEmbeddingAccessPolicySetting","x-databricks-stable-name":"AibiDashboardEmbeddingAccessPolicySetting"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateAibiDashboardEmbeddingAccessPolicySettingRequest","x-databricks-legacy-name":"UpdateAibiDashboardEmbeddingAccessPolicySettingRequest","x-databricks-stable-name":"UpdateAibiDashboardEmbeddingAccessPolicySettingRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_settings_types_aibi_dash_embed_ws_acc_policy_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_aibi_dash_embed_ws_apprvd_domains_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_aibi_dash_embed_ws_apprvd_domains_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.AibiDashboardEmbeddingApprovedDomainsSetting","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"AibiDashboardEmbeddingApprovedDomainsSetting","x-databricks-legacy-name":"AibiDashboardEmbeddingApprovedDomainsSetting","x-databricks-stable-name":"AibiDashboardEmbeddingApprovedDomainsSetting"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest","x-databricks-legacy-name":"UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest","x-databricks-stable-name":"UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_settings_types_aibi_dash_embed_ws_apprvd_domains_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_automatic_cluster_update_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_automatic_cluster_update_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.AutomaticClusterUpdateSetting","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"AutomaticClusterUpdateSetting","x-databricks-legacy-name":"AutomaticClusterUpdateSetting","x-databricks-stable-name":"AutomaticClusterUpdateSetting"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateAutomaticClusterUpdateSettingRequest","x-databricks-legacy-name":"UpdateAutomaticClusterUpdateSettingRequest","x-databricks-stable-name":"UpdateAutomaticClusterUpdateSettingRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_dashboard_email_subscriptions_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_dashboard_email_subscriptions_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.DashboardEmailSubscriptions","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"DashboardEmailSubscriptions","x-databricks-legacy-name":"DashboardEmailSubscriptions","x-databricks-stable-name":"DashboardEmailSubscriptions"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateDashboardEmailSubscriptionsRequest","x-databricks-legacy-name":"UpdateDashboardEmailSubscriptionsRequest","x-databricks-stable-name":"UpdateDashboardEmailSubscriptionsRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_settings_types_dashboard_email_subscriptions_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_default_namespace_ws_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_default_namespace_ws_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.DefaultNamespaceSetting","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"DefaultNamespaceSetting","x-databricks-legacy-name":"DefaultNamespaceSetting","x-databricks-stable-name":"DefaultNamespaceSetting"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateDefaultNamespaceSettingRequest","x-databricks-legacy-name":"UpdateDefaultNamespaceSettingRequest","x-databricks-stable-name":"UpdateDefaultNamespaceSettingRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_settings_types_default_namespace_ws_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_disable_legacy_access_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_disable_legacy_access_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.DisableLegacyAccess","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"DisableLegacyAccess","x-databricks-legacy-name":"DisableLegacyAccess","x-databricks-stable-name":"DisableLegacyAccess"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateDisableLegacyAccessRequest","x-databricks-legacy-name":"UpdateDisableLegacyAccessRequest","x-databricks-stable-name":"UpdateDisableLegacyAccessRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_settings_types_disable_legacy_access_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_disable_legacy_dbfs_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_disable_legacy_dbfs_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.DisableLegacyDbfs","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"DisableLegacyDbfs","x-databricks-legacy-name":"DisableLegacyDbfs","x-databricks-stable-name":"DisableLegacyDbfs"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateDisableLegacyDbfsRequest","x-databricks-legacy-name":"UpdateDisableLegacyDbfsRequest","x-databricks-stable-name":"UpdateDisableLegacyDbfsRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_settings_types_disable_legacy_dbfs_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_enable_export_notebook_names_default","parameters":{}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_enable_export_notebook_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchEnableExportNotebookRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchEnableExportNotebookRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.EnableExportNotebook","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchEnableExportNotebookRequest.setting","x-databricks-sdk-name":"EnableExportNotebook","x-databricks-legacy-name":"EnableExportNotebook","x-databricks-stable-name":"EnableExportNotebook"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateEnableExportNotebookRequest","x-databricks-legacy-name":"UpdateEnableExportNotebookRequest","x-databricks-stable-name":"UpdateEnableExportNotebookRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_enable_notebook_table_clipboard_names_default","parameters":{}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_enable_notebook_table_clipboard_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchEnableNotebookTableClipboardRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchEnableNotebookTableClipboardRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.EnableNotebookTableClipboard","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchEnableNotebookTableClipboardRequest.setting","x-databricks-sdk-name":"EnableNotebookTableClipboard","x-databricks-legacy-name":"EnableNotebookTableClipboard","x-databricks-stable-name":"EnableNotebookTableClipboard"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateEnableNotebookTableClipboardRequest","x-databricks-legacy-name":"UpdateEnableNotebookTableClipboardRequest","x-databricks-stable-name":"UpdateEnableNotebookTableClipboardRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_enable_results_downloading_names_default","parameters":{}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_enable_results_downloading_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchEnableResultsDownloadingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchEnableResultsDownloadingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.EnableResultsDownloading","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchEnableResultsDownloadingRequest.setting","x-databricks-sdk-name":"EnableResultsDownloading","x-databricks-legacy-name":"EnableResultsDownloading","x-databricks-stable-name":"EnableResultsDownloading"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateEnableResultsDownloadingRequest","x-databricks-legacy-name":"UpdateEnableResultsDownloadingRequest","x-databricks-stable-name":"UpdateEnableResultsDownloadingRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_restrict_workspace_admins_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_restrict_workspace_admins_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.RestrictWorkspaceAdminsSetting","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"RestrictWorkspaceAdminsSetting","x-databricks-legacy-name":"RestrictWorkspaceAdminsSetting","x-databricks-stable-name":"RestrictWorkspaceAdminsSetting"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateRestrictWorkspaceAdminsSettingRequest","x-databricks-legacy-name":"UpdateRestrictWorkspaceAdminsSettingRequest","x-databricks-stable-name":"UpdateRestrictWorkspaceAdminsSettingRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_settings_types_restrict_workspace_admins_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_shield_csp_enablement_ws_db_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_shield_csp_enablement_ws_db_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.ComplianceSecurityProfileSetting","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"ComplianceSecurityProfileSetting","x-databricks-legacy-name":"ComplianceSecurityProfileSetting","x-databricks-stable-name":"ComplianceSecurityProfileSetting"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateComplianceSecurityProfileSettingRequest","x-databricks-legacy-name":"UpdateComplianceSecurityProfileSettingRequest","x-databricks-stable-name":"UpdateComplianceSecurityProfileSettingRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_shield_esm_enablement_ws_db_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_shield_esm_enablement_ws_db_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.EnhancedSecurityMonitoringSetting","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"EnhancedSecurityMonitoringSetting","x-databricks-legacy-name":"EnhancedSecurityMonitoringSetting","x-databricks-stable-name":"EnhancedSecurityMonitoringSetting"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateEnhancedSecurityMonitoringSettingRequest","x-databricks-legacy-name":"UpdateEnhancedSecurityMonitoringSettingRequest","x-databricks-stable-name":"UpdateEnhancedSecurityMonitoringSettingRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_settings_types_sql_results_download_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_settings_types_sql_results_download_names_default","parameters":{"data":{"description":"Details required to update a setting.","type":"object","required":["allow_missing","setting","field_mask"],"properties":{"allow_missing":{"description":"This should always be set to true for Settings API. Added for AIP compliance.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.allow_missing"},"field_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.field_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"},"setting":{"$ref":"#/components/schemas/settings.SqlResultsDownload","x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-schema-id":"settingspolicyservice.external.PatchPublicWorkspaceSettingRequest.setting","x-databricks-sdk-name":"SqlResultsDownload","x-databricks-legacy-name":"SqlResultsDownload","x-databricks-stable-name":"SqlResultsDownload"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateSqlResultsDownloadRequest","x-databricks-legacy-name":"UpdateSqlResultsDownloadRequest","x-databricks-stable-name":"UpdateSqlResultsDownloadRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_settings_types_sql_results_download_names_default","parameters":{"etag":{"type":"string","description":"etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read ->\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_alerts","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_sql_alerts","parameters":{"data":{"type":"object","properties":{"alert":{"$ref":"#/components/schemas/sql.CreateAlertRequestAlert","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.CreateAlertRequest.alert","x-databricks-sdk-name":"CreateAlertRequestAlert","x-databricks-legacy-name":"CreateAlertRequestAlert","x-databricks-stable-name":"CreateAlertRequestAlert"},"auto_resolve_display_name":{"description":"If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.CreateAlertRequest.auto_resolve_display_name","default":true}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateAlertRequest","x-databricks-legacy-name":"CreateAlertRequest","x-databricks-stable-name":"CreateAlertRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_alerts_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_sql_alerts_by_id","parameters":{"id":{"type":"string"},"data":{"type":"object","required":["update_mask"],"properties":{"alert":{"$ref":"#/components/schemas/sql.UpdateAlertRequestAlert","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.UpdateAlertRequest.alert","x-databricks-sdk-name":"UpdateAlertRequestAlert","x-databricks-legacy-name":"UpdateAlertRequestAlert","x-databricks-stable-name":"UpdateAlertRequestAlert"},"auto_resolve_display_name":{"description":"If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.UpdateAlertRequest.auto_resolve_display_name","default":true},"update_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.UpdateAlertRequest.update_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateAlertRequest","x-databricks-legacy-name":"UpdateAlertRequest","x-databricks-stable-name":"UpdateAlertRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_sql_alerts_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_config_warehouses","parameters":{}},{"connectionName":"databricks-workspace","actionName":"put_api_2_0_sql_config_warehouses","parameters":{"data":{"type":"object","properties":{"channel":{"description":"Optional: Channel selection details","$ref":"#/components/schemas/sql.Channel","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"Channel","x-databricks-legacy-name":"Channel","x-databricks-stable-name":"Channel"},"config_param":{"description":"Deprecated: Use sql_configuration_parameters","$ref":"#/components/schemas/sql.RepeatedEndpointConfPairs","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-sdk-name":"RepeatedEndpointConfPairs","x-databricks-legacy-name":"RepeatedEndpointConfPairs","x-databricks-stable-name":"RepeatedEndpointConfPairs"},"data_access_config":{"description":"Spark confs for external hive metastore configuration\nJSON serialized size must be less than <= 512K","type":"array","items":{"$ref":"#/components/schemas/sql.EndpointConfPair","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"EndpointConfPair","x-databricks-legacy-name":"EndpointConfPair","x-databricks-stable-name":"EndpointConfPair"},"x-databricks-api-version":"legacy"},"enabled_warehouse_types":{"description":"List of Warehouse Types allowed in this workspace (limits allowed value of the\ntype field in CreateWarehouse and EditWarehouse).\nNote: Some types cannot be disabled, they don't need to be specified\n in SetWorkspaceWarehouseConfig.\nNote: Disabling a type may cause existing warehouses to be converted to another type.\nUsed by frontend to save specific type availability in the warehouse create and edit form UI.","type":"array","items":{"$ref":"#/components/schemas/sql.WarehouseTypePair","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"WarehouseTypePair","x-databricks-legacy-name":"WarehouseTypePair","x-databricks-stable-name":"WarehouseTypePair"},"x-databricks-api-version":"legacy"},"global_param":{"description":"Deprecated: Use sql_configuration_parameters","$ref":"#/components/schemas/sql.RepeatedEndpointConfPairs","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-sdk-name":"RepeatedEndpointConfPairs","x-databricks-legacy-name":"RepeatedEndpointConfPairs","x-databricks-stable-name":"RepeatedEndpointConfPairs"},"google_service_account":{"description":"GCP only: Google Service Account used to pass to cluster to access Google Cloud Storage","type":"string","x-databricks-api-version":"legacy"},"instance_profile_arn":{"description":"AWS Only: Instance profile used to pass IAM role to the cluster","type":"string","x-databricks-api-version":"legacy"},"security_policy":{"description":"Security policy for warehouses","$ref":"#/components/schemas/sql.SetWorkspaceWarehouseConfigRequestSecurityPolicy","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"SetWorkspaceWarehouseConfigRequestSecurityPolicy","x-databricks-legacy-name":"SetWorkspaceWarehouseConfigRequestSecurityPolicy","x-databricks-stable-name":"SetWorkspaceWarehouseConfigRequestSecurityPolicy"},"sql_configuration_parameters":{"description":"SQL configuration parameters","$ref":"#/components/schemas/sql.RepeatedEndpointConfPairs","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"RepeatedEndpointConfPairs","x-databricks-legacy-name":"RepeatedEndpointConfPairs","x-databricks-stable-name":"RepeatedEndpointConfPairs"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"SetWorkspaceWarehouseConfigRequest","x-databricks-legacy-name":"SetWorkspaceWarehouseConfigRequest","x-databricks-stable-name":"SetWorkspaceWarehouseConfigRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_history_queries","parameters":{"filter_by":{"type":"object","description":"An optional filter object to limit query history results. Accepts parameters such as user IDs, endpoint IDs, and statuses to narrow the returned data.\nIn a URL, the parameters of this filter are specified with dot notation. For example: `filter_by.statement_ids`."},"max_results":{"type":"integer","description":"Limit the number of results returned in one page. Must be less than 1000 and the default is 100."},"page_token":{"type":"string","description":"A token that can be used to get the next page of results. The token can contains characters that need to be encoded before using it in a URL.\nFor example, the character '+' needs to be replaced by %2B. This field is optional."},"include_metrics":{"type":"boolean","description":"Whether to include the query metrics with each query.\nOnly use this for a small subset of queries (max_results).\nDefaults to false."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_queries","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_sql_queries","parameters":{"data":{"type":"object","properties":{"auto_resolve_display_name":{"description":"If true, automatically resolve query display name conflicts. Otherwise, fail the request if the query's display name conflicts with an existing query's display name.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.CreateQueryRequest.auto_resolve_display_name","default":true},"query":{"$ref":"#/components/schemas/sql.CreateQueryRequestQuery","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.CreateQueryRequest.query","x-databricks-sdk-name":"CreateQueryRequestQuery","x-databricks-legacy-name":"CreateQueryRequestQuery","x-databricks-stable-name":"CreateQueryRequestQuery"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateQueryRequest","x-databricks-legacy-name":"CreateQueryRequest","x-databricks-stable-name":"CreateQueryRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_queries_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_sql_queries_by_id","parameters":{"id":{"type":"string"},"data":{"type":"object","required":["update_mask"],"properties":{"auto_resolve_display_name":{"description":"If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.UpdateQueryRequest.auto_resolve_display_name","default":true},"query":{"$ref":"#/components/schemas/sql.UpdateQueryRequestQuery","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.UpdateQueryRequest.query","x-databricks-sdk-name":"UpdateQueryRequestQuery","x-databricks-legacy-name":"UpdateQueryRequestQuery","x-databricks-stable-name":"UpdateQueryRequestQuery"},"update_mask":{"description":"The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"redashv2.external.UpdateQueryRequest.update_mask","x-databricks-well-known-type":"google.protobuf.FieldMask"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateQueryRequest","x-databricks-legacy-name":"UpdateQueryRequest","x-databricks-stable-name":"UpdateQueryRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_sql_queries_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_sql_statements","parameters":{"data":{"type":"object","required":["statement","warehouse_id"],"properties":{"byte_limit":{"description":"Applies the given byte limit to the statement's result size. Byte counts are based on\ninternal data representations and might not match the final size in the requested\n`format`. If the result was truncated due to the byte limit, then `truncated` in the response is set to `true`.\nWhen using `EXTERNAL_LINKS` disposition, a default `byte_limit` of 100 GiB\nis applied if `byte_limit` is not explcitly set.\n","type":"integer","format":"int64","x-databricks-api-version":"legacy"},"catalog":{"description":"Sets default catalog for statement execution, similar to [`USE CATALOG`](https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-catalog.html) in SQL.\n","type":"string","x-databricks-api-version":"legacy"},"disposition":{"$ref":"#/components/schemas/sql.Disposition","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"Disposition","x-databricks-legacy-name":"Disposition","x-databricks-stable-name":"Disposition"},"format":{"description":"Statement execution supports three result formats: `JSON_ARRAY` (default), `ARROW_STREAM`, and `CSV`.\n\nImportant: The formats `ARROW_STREAM` and `CSV` are supported only with `EXTERNAL_LINKS` disposition.\n`JSON_ARRAY` is supported in `INLINE` and `EXTERNAL_LINKS` disposition.\n\nWhen specifying `format=JSON_ARRAY`, result data will be formatted as an array of arrays of values, where each\nvalue is either the *string representation* of a value, or `null`.\nFor example, the output of `SELECT concat('id-', id) AS strCol, id AS intCol, null AS nullCol FROM range(3)` would look like this:\n\n```\n[\n [ \"id-1\", \"1\", null ],\n [ \"id-2\", \"2\", null ],\n [ \"id-3\", \"3\", null ],\n]\n```\n\nWhen specifying `format=JSON_ARRAY` and `disposition=EXTERNAL_LINKS`, each chunk in the result contains compact\nJSON with no indentation or extra whitespace.\n\nWhen specifying `format=ARROW_STREAM` and `disposition=EXTERNAL_LINKS`, each chunk in the result will be formatted as Apache Arrow Stream. See\nthe [Apache Arrow streaming format](https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format).\n\nWhen specifying `format=CSV` and `disposition=EXTERNAL_LINKS`, each chunk in the result will be a CSV according\nto [RFC 4180](https://www.rfc-editor.org/rfc/rfc4180) standard.\nAll the columns values will have *string representation* similar to the `JSON_ARRAY` format, and `null` values will be encoded as “null”.\nOnly the first chunk in the result would contain a header row with column names.\nFor example, the output of `SELECT concat('id-', id) AS strCol, id AS intCol, null as nullCol FROM range(3)` would look like this:\n\n```\nstrCol,intCol,nullCol\nid-1,1,null\nid-2,2,null\nid-3,3,null\n```\n","$ref":"#/components/schemas/sql.Format","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"Format","x-databricks-legacy-name":"Format","x-databricks-stable-name":"Format","default":"JSON_ARRAY"},"on_wait_timeout":{"description":"When `wait_timeout > 0s`, the call will block up to the specified time. If the statement execution doesn't\nfinish within this time, `on_wait_timeout` determines whether the execution should continue or be canceled.\nWhen set to `CONTINUE`, the statement execution continues asynchronously and the call returns a statement ID\nwhich can be used for polling with :method:statementexecution/getStatement. When set to `CANCEL`,\nthe statement execution is canceled and the call returns with a `CANCELED` state.\n","$ref":"#/components/schemas/sql.ExecuteStatementRequestOnWaitTimeout","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ExecuteStatementRequestOnWaitTimeout","x-databricks-legacy-name":"ExecuteStatementRequestOnWaitTimeout","x-databricks-stable-name":"ExecuteStatementRequestOnWaitTimeout"},"parameters":{"description":"A list of parameters to pass into a SQL statement containing parameter markers. A\nparameter consists of a name, a value, and optionally a type. To represent a NULL\nvalue, the `value` field may be omitted or set to `null` explicitly. If the `type` field\nis omitted, the value is interpreted as a string.\n\nIf the type is given, parameters will be checked for type correctness according\nto the given type. A value is correct if the provided string can be converted to\nthe requested type using the `cast` function. The exact semantics are described in\nthe section [`cast` function](https://docs.databricks.com/sql/language-manual/functions/cast.html) of the SQL language reference.\n\nFor example, the following statement contains two parameters, `my_name` and `my_date`:\n\n SELECT * FROM my_table WHERE name = :my_name AND date = :my_date\n\nThe parameters can be passed in the request body as follows:\n\n {\n ...,\n \"statement\": \"SELECT * FROM my_table WHERE name = :my_name AND date = :my_date\",\n \"parameters\": [\n { \"name\": \"my_name\", \"value\": \"the name\" },\n { \"name\": \"my_date\", \"value\": \"2020-01-01\", \"type\": \"DATE\" }\n ]\n }\n\nCurrently, positional parameters denoted by a `?` marker are not supported by the\nDatabricks SQL Statement Execution API.\n\nAlso see the section [Parameter markers](https://docs.databricks.com/sql/language-manual/sql-ref-parameter-marker.html) of the SQL language reference.\n","type":"array","items":{"$ref":"#/components/schemas/sql.StatementParameterListItem","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"StatementParameterListItem","x-databricks-legacy-name":"StatementParameterListItem","x-databricks-stable-name":"StatementParameterListItem"},"x-databricks-api-version":"legacy"},"row_limit":{"description":"Applies the given row limit to the statement's result set, but unlike the `LIMIT` clause in SQL,\nit also sets the `truncated` field in the response to indicate whether the result was trimmed due to the limit or not.\n","type":"integer","format":"int64","x-databricks-api-version":"legacy"},"schema":{"description":"Sets default schema for statement execution, similar to [`USE SCHEMA`](https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-schema.html) in SQL.\n","type":"string","x-databricks-api-version":"legacy"},"statement":{"description":"The SQL statement to execute. The statement can optionally be parameterized, see `parameters`. The maximum query text size is 16 MiB.","type":"string","x-databricks-api-version":"legacy","example":"SELECT * FROM range(10)"},"wait_timeout":{"description":"The time in seconds the call will wait for the statement's result set as `Ns`, where `N` can be set to 0 or\nto a value between 5 and 50.\n\nWhen set to `0s`, the statement will execute in asynchronous mode and the call will not\nwait for the execution to finish. In this case, the call returns\ndirectly with `PENDING` state and a statement ID which can be used for polling\nwith :method:statementexecution/getStatement.\n\nWhen set between 5 and 50 seconds, the call will behave\nsynchronously up to this timeout and wait for the statement execution to finish. If the execution\nfinishes within this time, the call returns immediately with a manifest and result data\n(or a `FAILED` state in case of an execution error). If the statement takes longer to execute,\n`on_wait_timeout` determines what should happen after the timeout is reached.\n","type":"string","x-databricks-api-version":"legacy","default":"10s"},"warehouse_id":{"description":"Warehouse upon which to execute a statement. See also [What are SQL warehouses?](https://docs.databricks.com/sql/admin/warehouse-type.html)\n","type":"string","x-databricks-api-version":"legacy"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"ExecuteStatementRequest","x-databricks-legacy-name":"ExecuteStatementRequest","x-databricks-stable-name":"ExecuteStatementRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_sql_statements_by_statement_id","parameters":{"statement_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_statements_by_statement_id","parameters":{"statement_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_sql_statements_by_statement_id_cancel","parameters":{"statement_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_sql_statements_by_statement_id_cancel","parameters":{"statement_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_0_sql_statements_by_statement_id_result_chunks_by_chunk_index","parameters":{"statement_id":{"type":"string"},"chunk_index":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_statements_by_statement_id_result_chunks_by_chunk_index","parameters":{"statement_id":{"type":"string"},"chunk_index":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_warehouses","parameters":{"run_as_user_id":{"type":"integer","description":"Service Principal which will be used to fetch the list of warehouses.\nIf not specified, the user from the session header is used."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_sql_warehouses","parameters":{"data":{"type":"object","properties":{"auto_stop_mins":{"description":"The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before\nit is automatically stopped.\n\nSupported values:\n - Must be >= 0 mins for serverless warehouses\n - Must be == 0 or >= 10 mins for non-serverless warehouses\n - 0 indicates no autostop.\n\nDefaults to 120 mins","type":"integer","format":"int32","x-databricks-api-version":"legacy","default":"120"},"channel":{"description":"Channel Details","$ref":"#/components/schemas/sql.Channel","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"Channel","x-databricks-legacy-name":"Channel","x-databricks-stable-name":"Channel"},"cluster_size":{"description":"Size of the clusters allocated for this warehouse.\nIncreasing the size of a spark cluster allows you to run larger queries on it.\nIf you want to increase the number of concurrent queries, please tune max_num_clusters.\n\nSupported values:\n - 2X-Small\n - X-Small\n - Small\n - Medium\n - Large\n - X-Large\n - 2X-Large\n - 3X-Large\n - 4X-Large\n","type":"string","x-databricks-api-version":"legacy"},"creator_name":{"description":"warehouse creator name","type":"string","x-databricks-api-version":"legacy"},"enable_photon":{"description":"Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to false.","type":"boolean","x-databricks-api-version":"legacy"},"enable_serverless_compute":{"description":"Configures whether the warehouse should use serverless compute.\nDatabricks strongly recommends that you always explicitly set this field.\nIf this value is `true` explicitly or through the default, you **must** also set `warehouse_type`\nfield to `pro` (the default if this field is `true`).\nIf omitted, the default is false for most workspaces.\nHowever, if this workspace used the SQL Warehouses API to create a warehouse between September 1, 2022 and April 30, 2023,\nthe default remains the previous behavior which is default to true if the workspace is enabled for serverless and\nfits the requirements for serverless SQL warehouses. To avoid ambiguity, especially for organizations with\nmany workspaces, Databricks recommends that you always set this field. If your account needs updated\n[terms of use](https://docs.databricks.com/sql/admin/serverless.html#accept-terms), workspace admins are prompted in\nthe Databricks SQL UI.\nA workspace must meet the [requirements](https://docs.databricks.com/sql/admin/serverless.html#requirements)\nand might require an update to its instance profile role\nto [add a trust relationship](https://docs.databricks.com/sql/admin/serverless.html#aws-instance-profile-setup).\n","type":"boolean","x-databricks-api-version":"legacy","x-databricks-cloud":"aws"},"instance_profile_arn":{"description":"Deprecated. Instance profile used to pass IAM role to the cluster","type":"string","x-databricks-api-version":"legacy","deprecated":true},"max_num_clusters":{"description":"Maximum number of clusters that the autoscaler will create to handle concurrent queries.\n\nSupported values:\n - Must be >= min_num_clusters\n - Must be <= 30.\n\nDefaults to min_clusters if unset.","type":"integer","format":"int32","x-databricks-api-version":"legacy"},"min_num_clusters":{"description":"Minimum number of available clusters that will be maintained for this SQL warehouse.\nIncreasing this will ensure that a larger number of clusters are always running and therefore may reduce\nthe cold start time for new queries. This is similar to reserved vs. revocable cores in a resource manager.\n\nSupported values:\n - Must be > 0\n - Must be <= min(max_num_clusters, 30)\n\nDefaults to 1","type":"integer","format":"int32","x-databricks-api-version":"legacy","default":"1"},"name":{"description":"Logical name for the cluster.\n\nSupported values:\n - Must be unique within an org.\n - Must be less than 100 characters.","type":"string","x-databricks-api-version":"legacy"},"spot_instance_policy":{"$ref":"#/components/schemas/sql.SpotInstancePolicy","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"SpotInstancePolicy","x-databricks-legacy-name":"SpotInstancePolicy","x-databricks-stable-name":"SpotInstancePolicy"},"tags":{"description":"A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n - Number of tags < 45.","$ref":"#/components/schemas/sql.EndpointTags","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"EndpointTags","x-databricks-legacy-name":"EndpointTags","x-databricks-stable-name":"EndpointTags"},"warehouse_type":{"$ref":"#/components/schemas/sql.CreateWarehouseRequestWarehouseType","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateWarehouseRequestWarehouseType","x-databricks-legacy-name":"CreateWarehouseRequestWarehouseType","x-databricks-stable-name":"CreateWarehouseRequestWarehouseType"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateWarehouseRequest","x-databricks-legacy-name":"CreateWarehouseRequest","x-databricks-stable-name":"CreateWarehouseRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_sql_warehouses_by_id","parameters":{"id":{"type":"string","description":"Required. Id of the SQL warehouse."}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_sql_warehouses_by_id","parameters":{"id":{"type":"string","description":"Required. Id of the SQL warehouse."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_sql_warehouses_by_id_edit","parameters":{"id":{"type":"string","description":"Required. Id of the warehouse to configure."},"data":{"type":"object","properties":{"auto_stop_mins":{"description":"The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before\nit is automatically stopped.\n\nSupported values:\n - Must be == 0 or >= 10 mins\n - 0 indicates no autostop.\n\nDefaults to 120 mins","type":"integer","format":"int32","x-databricks-api-version":"legacy","default":"120"},"channel":{"description":"Channel Details","$ref":"#/components/schemas/sql.Channel","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"Channel","x-databricks-legacy-name":"Channel","x-databricks-stable-name":"Channel"},"cluster_size":{"description":"Size of the clusters allocated for this warehouse.\nIncreasing the size of a spark cluster allows you to run larger queries on it.\nIf you want to increase the number of concurrent queries, please tune max_num_clusters.\n\nSupported values:\n- 2X-Small\n- X-Small\n- Small\n- Medium\n- Large\n- X-Large\n- 2X-Large\n- 3X-Large\n- 4X-Large","type":"string","x-databricks-api-version":"legacy"},"creator_name":{"description":"warehouse creator name","type":"string","x-databricks-api-version":"legacy"},"enable_photon":{"description":"Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to false.","type":"boolean","x-databricks-api-version":"legacy"},"enable_serverless_compute":{"description":"Configures whether the warehouse should use serverless compute.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-not-cloud":"gcp"},"instance_profile_arn":{"description":"Deprecated. Instance profile used to pass IAM role to the cluster","type":"string","x-databricks-api-version":"legacy","deprecated":true},"max_num_clusters":{"description":"Maximum number of clusters that the autoscaler will create to handle concurrent queries.\n\nSupported values:\n - Must be >= min_num_clusters\n - Must be <= 30.\n\nDefaults to min_clusters if unset.","type":"integer","format":"int32","x-databricks-api-version":"legacy"},"min_num_clusters":{"description":"Minimum number of available clusters that will be maintained for this SQL warehouse.\nIncreasing this will ensure that a larger number of clusters are always running and therefore may reduce\nthe cold start time for new queries. This is similar to reserved vs. revocable cores in a resource manager.\n\nSupported values:\n - Must be > 0\n - Must be <= min(max_num_clusters, 30)\n\nDefaults to 1","type":"integer","format":"int32","x-databricks-api-version":"legacy","default":"1"},"name":{"description":"Logical name for the cluster.\n\nSupported values:\n - Must be unique within an org.\n - Must be less than 100 characters.","type":"string","x-databricks-api-version":"legacy"},"spot_instance_policy":{"$ref":"#/components/schemas/sql.SpotInstancePolicy","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"SpotInstancePolicy","x-databricks-legacy-name":"SpotInstancePolicy","x-databricks-stable-name":"SpotInstancePolicy"},"tags":{"description":"A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n - Number of tags < 45.","$ref":"#/components/schemas/sql.EndpointTags","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"EndpointTags","x-databricks-legacy-name":"EndpointTags","x-databricks-stable-name":"EndpointTags"},"warehouse_type":{"$ref":"#/components/schemas/sql.EditWarehouseRequestWarehouseType","x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"EditWarehouseRequestWarehouseType","x-databricks-legacy-name":"EditWarehouseRequestWarehouseType","x-databricks-stable-name":"EditWarehouseRequestWarehouseType"}},"x-databricks-package-name":"sql","x-databricks-api-version":"legacy","x-databricks-sdk-name":"EditWarehouseRequest","x-databricks-legacy-name":"EditWarehouseRequest","x-databricks-stable-name":"EditWarehouseRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_sql_warehouses_by_id_start","parameters":{"id":{"type":"string","description":"Required. Id of the SQL warehouse."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_sql_warehouses_by_id_stop","parameters":{"id":{"type":"string","description":"Required. Id of the SQL warehouse."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_token_management_on_behalf_of_tokens","parameters":{"data":{"description":"Configuration details for creating on-behalf tokens.","type":"object","required":["application_id"],"properties":{"application_id":{"description":"Application ID of the service principal.","type":"string","format":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"tokenmanagement.CreateOnBehalfOfToken.application_id","example":"6f5ccf28-d83a-4957-9bfb-5bbfac551410"},"comment":{"description":"Comment that describes the purpose of the token.","type":"string","format":"string","x-databricks-api-version":"legacy","x-databricks-not-cloud":"azure","x-databricks-schema-id":"tokenmanagement.CreateOnBehalfOfToken.comment","example":"This is for the ABC department automation scripts."},"lifetime_seconds":{"description":"The number of seconds before the token expires.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"tokenmanagement.CreateOnBehalfOfToken.lifetime_seconds","example":3600}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateOboTokenRequest","x-databricks-legacy-name":"CreateOboTokenRequest","x-databricks-stable-name":"CreateOboTokenRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_token_management_tokens","parameters":{"created_by_id":{"type":"integer","description":"User ID of the user that created the token."},"created_by_username":{"type":"string","description":"Username of the user that created the token."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_token_management_tokens_by_token_id","parameters":{"token_id":{"type":"string","description":"The ID of the token to get."}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_token_management_tokens_by_token_id","parameters":{"token_id":{"type":"string","description":"The ID of the token to revoke."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_token_create","parameters":{"data":{"type":"object","properties":{"comment":{"description":"Optional description to attach to the token.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"token.CreateToken.comment"},"lifetime_seconds":{"description":"The lifetime of the token, in seconds.\n\nIf the lifetime is not specified, this token remains valid indefinitely.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"token.CreateToken.lifetime_seconds"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateTokenRequest","x-databricks-legacy-name":"CreateTokenRequest","x-databricks-stable-name":"CreateTokenRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_token_delete","parameters":{"data":{"type":"object","required":["token_id"],"properties":{"token_id":{"description":"The ID of the token to be revoked.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"token.RevokeToken.token_id"}},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RevokeTokenRequest","x-databricks-legacy-name":"RevokeTokenRequest","x-databricks-stable-name":"RevokeTokenRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_token_list","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_unity_catalog_temporary_path_credentials","parameters":{"data":{"type":"object","required":["url","operation"],"properties":{"dry_run":{"description":"Optional. When set to true, the service will not validate that the generated\ncredentials can perform write operations, therefore no new paths will be created\nand the response will not contain valid credentials. Defaults to false.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.GenerateTemporaryPathCredential.dry_run"},"operation":{"description":"The operation being performed on the path.","$ref":"#/components/schemas/catalog.PathOperation","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.GenerateTemporaryPathCredential.operation","x-databricks-sdk-name":"PathOperation","x-databricks-legacy-name":"PathOperation","x-databricks-stable-name":"PathOperation"},"url":{"description":"URL for path-based access.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.GenerateTemporaryPathCredential.url"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"GenerateTemporaryPathCredentialRequest","x-databricks-legacy-name":"GenerateTemporaryPathCredentialRequest","x-databricks-stable-name":"GenerateTemporaryPathCredentialRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_unity_catalog_temporary_table_credentials","parameters":{"data":{"type":"object","properties":{"operation":{"description":"The operation performed against the table data, either READ or READ_WRITE. If READ_WRITE is specified,\nthe credentials returned will have write permissions, otherwise, it will be read only.","$ref":"#/components/schemas/catalog.TableOperation","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.GenerateTemporaryTableCredential.operation","x-databricks-sdk-name":"TableOperation","x-databricks-legacy-name":"TableOperation","x-databricks-stable-name":"TableOperation"},"table_id":{"description":"UUID of the table to read or write.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.GenerateTemporaryTableCredential.table_id"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"GenerateTemporaryTableCredentialRequest","x-databricks-legacy-name":"GenerateTemporaryTableCredentialRequest","x-databricks-stable-name":"GenerateTemporaryTableCredentialRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_vector_search_endpoints","parameters":{"page_token":{"type":"string","description":"Token for pagination"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_vector_search_endpoints","parameters":{"data":{"type":"object","required":["name","endpoint_type"],"properties":{"endpoint_type":{"description":"Type of endpoint","$ref":"#/components/schemas/vectorsearch.EndpointType","x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.CreateEndpointRequest.endpoint_type","x-databricks-sdk-name":"EndpointType","x-databricks-legacy-name":"EndpointType","x-databricks-stable-name":"EndpointType"},"name":{"description":"Name of the vector search endpoint","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.CreateEndpointRequest.name","example":"docs-endpoint"}},"x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateEndpoint","x-databricks-legacy-name":"CreateEndpoint","x-databricks-stable-name":"CreateEndpoint"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_vector_search_endpoints_by_endpoint_name","parameters":{"endpoint_name":{"type":"string","description":"Name of the endpoint"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_vector_search_endpoints_by_endpoint_name","parameters":{"endpoint_name":{"type":"string","description":"Name of the vector search endpoint"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_vector_search_endpoints_by_endpoint_name_budget_policy","parameters":{"endpoint_name":{"type":"string","description":"Name of the vector search endpoint"},"data":{"type":"object","required":["budget_policy_id"],"properties":{"budget_policy_id":{"description":"The budget policy id to be applied\n(hima-sheth) TODO: remove this once we've migrated to usage policies","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.PatchEndpointBudgetPolicyRequest.budget_policy_id","example":"8b0444ff-8b60-48b0-9d31-e391f6126e0f"}},"x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PatchEndpointBudgetPolicyRequest","x-databricks-legacy-name":"PatchEndpointBudgetPolicyRequest","x-databricks-stable-name":"PatchEndpointBudgetPolicyRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_vector_search_indexes","parameters":{"endpoint_name":{"type":"string","description":"Name of the endpoint"},"page_token":{"type":"string","description":"Token for pagination"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_vector_search_indexes","parameters":{"data":{"type":"object","required":["name","endpoint_name","primary_key","index_type"],"properties":{"delta_sync_index_spec":{"description":"Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`.","$ref":"#/components/schemas/vectorsearch.DeltaSyncVectorIndexSpecRequest","x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.CreateVectorIndexRequest.delta_sync_index_spec","x-databricks-sdk-name":"DeltaSyncVectorIndexSpecRequest","x-databricks-legacy-name":"DeltaSyncVectorIndexSpecRequest","x-databricks-stable-name":"DeltaSyncVectorIndexSpecRequest"},"direct_access_index_spec":{"description":"Specification for Direct Vector Access Index. Required if `index_type` is `DIRECT_ACCESS`.","$ref":"#/components/schemas/vectorsearch.DirectAccessVectorIndexSpec","x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.CreateVectorIndexRequest.direct_access_index_spec","x-databricks-sdk-name":"DirectAccessVectorIndexSpec","x-databricks-legacy-name":"DirectAccessVectorIndexSpec","x-databricks-stable-name":"DirectAccessVectorIndexSpec"},"endpoint_name":{"description":"Name of the endpoint to be used for serving the index","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.CreateVectorIndexRequest.endpoint_name"},"index_type":{"$ref":"#/components/schemas/vectorsearch.VectorIndexType","x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.CreateVectorIndexRequest.index_type","x-databricks-sdk-name":"VectorIndexType","x-databricks-legacy-name":"VectorIndexType","x-databricks-stable-name":"VectorIndexType"},"name":{"description":"Name of the index","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.CreateVectorIndexRequest.name"},"primary_key":{"description":"Primary key of the index","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.CreateVectorIndexRequest.primary_key"}},"x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateVectorIndexRequest","x-databricks-legacy-name":"CreateVectorIndexRequest","x-databricks-stable-name":"CreateVectorIndexRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_vector_search_indexes_by_index_name","parameters":{"index_name":{"type":"string","description":"Name of the index"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_vector_search_indexes_by_index_name","parameters":{"index_name":{"type":"string","description":"Name of the index"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_0_vector_search_indexes_by_index_name_delete_data","parameters":{"index_name":{"type":"string","description":"Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index."},"primary_keys":{"type":"array","description":"List of primary keys for the data to be deleted."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_vector_search_indexes_by_index_name_query","parameters":{"index_name":{"type":"string","description":"Name of the vector index to query."},"data":{"type":"object","required":["columns"],"properties":{"columns":{"description":"List of column names to include in the response.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.brickindexscheduler.QueryVectorIndexRequest.columns.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.QueryVectorIndexRequest.columns"},"filters_json":{"description":"JSON string representing query filters.\n\nExample filters:\n\n- `{\"id <\": 5}`: Filter for id less than 5.\n- `{\"id >\": 5}`: Filter for id greater than 5.\n- `{\"id <=\": 5}`: Filter for id less than equal to 5.\n- `{\"id >=\": 5}`: Filter for id greater than equal to 5.\n- `{\"id\": 5}`: Filter for id equal to 5.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.QueryVectorIndexRequest.filters_json"},"num_results":{"description":"Number of results to return. Defaults to 10.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.QueryVectorIndexRequest.num_results"},"query_text":{"description":"Query text. Required for Delta Sync Index using model endpoint.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.QueryVectorIndexRequest.query_text"},"query_type":{"description":"The query type to use. Choices are `ANN` and `HYBRID`. Defaults to `ANN`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.QueryVectorIndexRequest.query_type"},"query_vector":{"description":"Query vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors.","type":"array","items":{"type":"number","format":"double","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.brickindexscheduler.QueryVectorIndexRequest.query_vector.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.QueryVectorIndexRequest.query_vector"},"score_threshold":{"description":"Threshold for the approximate nearest neighbor search. Defaults to 0.0.","type":"number","format":"double","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.QueryVectorIndexRequest.score_threshold"}},"x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"QueryVectorIndexRequest","x-databricks-legacy-name":"QueryVectorIndexRequest","x-databricks-stable-name":"QueryVectorIndexRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_vector_search_indexes_by_index_name_query_next_page","parameters":{"index_name":{"type":"string","description":"Name of the vector index to query."},"data":{"description":"Request payload for getting next page of results.","type":"object","properties":{"endpoint_name":{"description":"Name of the endpoint.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.QueryVectorIndexNextPageRequest.endpoint_name"},"page_token":{"description":"Page token returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` API.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.QueryVectorIndexNextPageRequest.page_token"}},"x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"QueryVectorIndexNextPageRequest","x-databricks-legacy-name":"QueryVectorIndexNextPageRequest","x-databricks-stable-name":"QueryVectorIndexNextPageRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_vector_search_indexes_by_index_name_scan","parameters":{"index_name":{"type":"string","description":"Name of the vector index to scan."},"data":{"type":"object","properties":{"last_primary_key":{"description":"Primary key of the last entry returned in the previous scan.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.ScanVectorIndexRequest.last_primary_key"},"num_results":{"description":"Number of results to return. Defaults to 10.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.ScanVectorIndexRequest.num_results"}},"x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ScanVectorIndexRequest","x-databricks-legacy-name":"ScanVectorIndexRequest","x-databricks-stable-name":"ScanVectorIndexRequest"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_vector_search_indexes_by_index_name_sync","parameters":{"index_name":{"type":"string","description":"Name of the vector index to synchronize. Must be a Delta Sync Index."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_vector_search_indexes_by_index_name_upsert_data","parameters":{"index_name":{"type":"string","description":"Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index."},"data":{"type":"object","required":["inputs_json"],"properties":{"inputs_json":{"description":"JSON string representing the data to be upserted.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"brickindexscheduler.UpsertDataVectorIndexRequest.inputs_json"}},"x-databricks-package-name":"vectorsearch","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpsertDataVectorIndexRequest","x-databricks-legacy-name":"UpsertDataVectorIndexRequest","x-databricks-stable-name":"UpsertDataVectorIndexRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_workspace_conf","parameters":{"keys":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_0_workspace_conf","parameters":{"data":{"type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"aclmanager.workspaceconf.WorkspaceConf.value"},"x-databricks-package-name":"settings","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-schema-id":"settings.WorkspaceConf","x-databricks-sdk-name":"WorkspaceConf","x-databricks-legacy-name":"WorkspaceConf","x-databricks-stable-name":"WorkspaceConf","x-databricks-rule-ignores":[{"group":"map","ruleIgnoreCategory":"DEPRECATED_FEATURE"}]}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_workspace_delete","parameters":{"data":{"type":"object","required":["path"],"properties":{"path":{"description":"The absolute path of the notebook or directory.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"workspace.Delete.path"},"recursive":{"description":"The flag that specifies whether to delete the object recursively. It is `false` by default.\nPlease note this deleting directory is not atomic. If it fails in the middle, some of objects\nunder this directory may be deleted and cannot be undone.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"workspace.Delete.recursive","default":false}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Delete","x-databricks-legacy-name":"Delete","x-databricks-stable-name":"Delete"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_workspace_export","parameters":{"path":{"type":"string","description":"The absolute path of the object or directory. Exporting a directory is only supported for the `DBC`, `SOURCE`, and `AUTO` format."},"format":{"type":"string","description":"This specifies the format of the exported file. By default, this is `SOURCE`.\n\nThe value is case sensitive.\n\n- `SOURCE`: The notebook is exported as source code. Directory exports will not include non-notebook entries.\n- `HTML`: The notebook is exported as an HTML file.\n- `JUPYTER`: The notebook is exported as a Jupyter/IPython Notebook file.\n- `DBC`: The notebook is exported in Databricks archive format. Directory exports will not include non-notebook entries.\n- `R_MARKDOWN`: The notebook is exported to R Markdown format.\n- `AUTO`: The object or directory is exported depending on the objects type. Directory exports will include notebooks and workspace files."},"direct_download":{"type":"boolean","description":"Flag to enable direct download. If it is `true`, the response is the exported file itself.\nOtherwise, by default, the response contains content in the form of a base64 encoded string."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_workspace_get_status","parameters":{"path":{"type":"string","description":"The absolute path of the notebook or directory."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_workspace_import","parameters":{"data":{"type":"object","required":["path"],"properties":{"content":{"description":"The base64-encoded content. This has a limit of 10 MB.\n\nIf the limit (10MB) is exceeded, exception with error code **MAX_NOTEBOOK_SIZE_EXCEEDED** is thrown.\nThis parameter might be absent, and instead a posted file is used.","type":"string","format":"string","x-databricks-api-version":"legacy","x-databricks-base64":true,"x-databricks-schema-id":"workspace.Import.content"},"format":{"description":"This specifies the format of the file to be imported.\n\nThe value is case sensitive.\n\n- `AUTO`: The item is imported depending on an analysis of the item's extension and\nthe header content provided in the request. If the item is imported as a notebook,\nthen the item's extension is automatically removed.\n- `SOURCE`: The notebook or directory is imported as source code.\n- `HTML`: The notebook is imported as an HTML file.\n- `JUPYTER`: The notebook is imported as a Jupyter/IPython Notebook file.\n- `DBC`: The notebook is imported in Databricks archive format. Required for directories.\n- `R_MARKDOWN`: The notebook is imported from R Markdown format.","$ref":"#/components/schemas/workspace.ImportFormat","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-schema-id":"workspace.Import.format","x-databricks-sdk-name":"ImportFormat","x-databricks-legacy-name":"ImportFormat","x-databricks-stable-name":"ImportFormat","default":"SOURCE"},"language":{"description":"The language of the object. This value is set only if the object type is `NOTEBOOK`.","$ref":"#/components/schemas/workspace.Language","x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-schema-id":"workspace.Import.language","x-databricks-sdk-name":"Language","x-databricks-legacy-name":"Language","x-databricks-stable-name":"Language"},"overwrite":{"description":"The flag that specifies whether to overwrite existing object. It is `false` by default.\nFor `DBC` format, `overwrite` is not supported since it may contain a directory.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"workspace.Import.overwrite","default":false},"path":{"description":"The absolute path of the object or directory. Importing a directory is only supported for the `DBC` and `SOURCE` formats.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"workspace.Import.path"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Import","x-databricks-legacy-name":"Import","x-databricks-stable-name":"Import"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_0_workspace_list","parameters":{"path":{"type":"string","description":"The absolute path of the notebook or directory."},"notebooks_modified_after":{"type":"integer","description":"UTC timestamp in milliseconds"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_0_workspace_mkdirs","parameters":{"data":{"type":"object","required":["path"],"properties":{"path":{"description":"The absolute path of the directory. If the parent directories do not exist, it will also create them.\nIf the directory already exists, this command will do nothing and succeed.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"workspace.Mkdirs.path"}},"x-databricks-package-name":"workspace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"Mkdirs","x-databricks-legacy-name":"Mkdirs","x-databricks-stable-name":"Mkdirs"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_change_owner","parameters":{"data":{"type":"object","required":["cluster_id","owner_username"],"properties":{"cluster_id":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ChangeClusterOwner.cluster_id"},"owner_username":{"description":"New owner of the cluster_id after this RPC.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ChangeClusterOwner.owner_username"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ChangeClusterOwner","x-databricks-legacy-name":"ChangeClusterOwner","x-databricks-stable-name":"ChangeClusterOwner"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_create","parameters":{"data":{"type":"object","required":["spark_version"],"properties":{"apply_policy_default_values":{"description":"When set to true, fixed and default values from the policy will be used for fields that are omitted.\nWhen set to false, only fixed values from the policy will be applied.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.CreateCluster.apply_policy_default_values","default":false},"autoscale":{"description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.","$ref":"#/components/schemas/compute.AutoScale","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterSize.autoscale","x-databricks-sdk-name":"AutoScale","x-databricks-legacy-name":"AutoScale","x-databricks-stable-name":"AutoScale"},"autotermination_minutes":{"description":"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.autotermination_minutes"},"aws_attributes":{"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.","$ref":"#/components/schemas/compute.AwsAttributes","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-schema-id":"cluster.ClusterAttributes.aws_attributes","x-databricks-sdk-name":"AwsAttributes","x-databricks-legacy-name":"AwsAttributes","x-databricks-stable-name":"AwsAttributes"},"clone_from":{"description":"When specified, this clones libraries from a source cluster during the creation of a new cluster.","$ref":"#/components/schemas/compute.CloneCluster","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.CreateCluster.clone_from","x-databricks-sdk-name":"CloneCluster","x-databricks-legacy-name":"CloneCluster","x-databricks-stable-name":"CloneCluster"},"cluster_log_conf":{"description":"The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.","$ref":"#/components/schemas/compute.ClusterLogConf","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.cluster_log_conf","x-databricks-sdk-name":"ClusterLogConf","x-databricks-legacy-name":"ClusterLogConf","x-databricks-stable-name":"ClusterLogConf"},"cluster_name":{"description":"Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.cluster_name"},"custom_tags":{"description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags","type":"object","additionalProperties":{"description":"The value of the tag. The value length must be less than or equal to 255 UTF-8 characters.\nFor a list of all restrictions, see the AWS docs here:\nhttp://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterTag.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.custom_tags"},"data_security_mode":{"$ref":"#/components/schemas/compute.DataSecurityMode","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.data_security_mode","x-databricks-sdk-name":"DataSecurityMode","x-databricks-legacy-name":"DataSecurityMode","x-databricks-stable-name":"DataSecurityMode"},"docker_image":{"description":"Custom docker image BYOC","$ref":"#/components/schemas/compute.DockerImage","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-not-cloud":"gcp","x-databricks-schema-id":"cluster.ClusterAttributes.docker_image","x-databricks-sdk-name":"DockerImage","x-databricks-legacy-name":"DockerImage","x-databricks-stable-name":"DockerImage"},"driver_instance_pool_id":{"description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.driver_instance_pool_id"},"driver_node_type_id":{"description":"The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.driver_node_type_id"},"enable_elastic_disk":{"description":"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\npermissions to function correctly - refer to the User Guide for more details.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.enable_elastic_disk"},"enable_local_disk_encryption":{"description":"Whether to enable LUKS on cluster VMs' local disks","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.enable_local_disk_encryption"},"init_scripts":{"description":"The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `//init_scripts`.","type":"array","items":{"$ref":"#/components/schemas/compute.InitScriptInfo","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.init_scripts.array_value","x-databricks-sdk-name":"InitScriptInfo","x-databricks-legacy-name":"InitScriptInfo","x-databricks-stable-name":"InitScriptInfo"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.init_scripts"},"instance_pool_id":{"description":"The optional ID of the instance pool to which the cluster belongs.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.instance_pool_id"},"is_single_node":{"description":"This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.is_single_node"},"kind":{"$ref":"#/components/schemas/compute.kind","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.kind","x-databricks-sdk-name":"kind","x-databricks-legacy-name":"kind","x-databricks-stable-name":"kind"},"node_type_id":{"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.node_type_id"},"num_workers":{"description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterSize.num_workers"},"policy_id":{"description":"The ID of the cluster policy used to create the cluster if applicable.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.policy_id"},"runtime_engine":{"description":"Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.","$ref":"#/components/schemas/compute.RuntimeEngine","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.runtime_engine","x-databricks-sdk-name":"RuntimeEngine","x-databricks-legacy-name":"RuntimeEngine","x-databricks-stable-name":"RuntimeEngine"},"single_user_name":{"description":"Single user name if data_security_mode is `SINGLE_USER`","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.single_user_name"},"spark_conf":{"description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.SparkConfPair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.spark_conf"},"spark_env_vars":{"description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.SparkEnvPair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.spark_env_vars"},"spark_version":{"description":"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.spark_version"},"ssh_public_keys":{"description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.ssh_public_keys.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.ssh_public_keys"},"use_ml_runtime":{"description":"This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.use_ml_runtime"},"workload_type":{"$ref":"#/components/schemas/compute.WorkloadType","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.workload_type","x-databricks-sdk-name":"WorkloadType","x-databricks-legacy-name":"WorkloadType","x-databricks-stable-name":"WorkloadType"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateCluster","x-databricks-legacy-name":"CreateCluster","x-databricks-stable-name":"CreateCluster"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_delete","parameters":{"data":{"type":"object","required":["cluster_id"],"properties":{"cluster_id":{"description":"The cluster to be terminated.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.DeleteCluster.cluster_id","example":"1234-567890-frays123"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteCluster","x-databricks-legacy-name":"DeleteCluster","x-databricks-stable-name":"DeleteCluster"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_edit","parameters":{"data":{"type":"object","required":["cluster_id","spark_version"],"properties":{"apply_policy_default_values":{"description":"When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.EditCluster.apply_policy_default_values","default":false},"autoscale":{"description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.","$ref":"#/components/schemas/compute.AutoScale","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterSize.autoscale","x-databricks-sdk-name":"AutoScale","x-databricks-legacy-name":"AutoScale","x-databricks-stable-name":"AutoScale"},"autotermination_minutes":{"description":"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.autotermination_minutes"},"aws_attributes":{"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.","$ref":"#/components/schemas/compute.AwsAttributes","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-schema-id":"cluster.ClusterAttributes.aws_attributes","x-databricks-sdk-name":"AwsAttributes","x-databricks-legacy-name":"AwsAttributes","x-databricks-stable-name":"AwsAttributes"},"cluster_id":{"description":"ID of the cluster","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.EditCluster.cluster_id"},"cluster_log_conf":{"description":"The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.","$ref":"#/components/schemas/compute.ClusterLogConf","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.cluster_log_conf","x-databricks-sdk-name":"ClusterLogConf","x-databricks-legacy-name":"ClusterLogConf","x-databricks-stable-name":"ClusterLogConf"},"cluster_name":{"description":"Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.cluster_name"},"custom_tags":{"description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags","type":"object","additionalProperties":{"description":"The value of the tag. The value length must be less than or equal to 255 UTF-8 characters.\nFor a list of all restrictions, see the AWS docs here:\nhttp://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterTag.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.custom_tags"},"data_security_mode":{"$ref":"#/components/schemas/compute.DataSecurityMode","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.data_security_mode","x-databricks-sdk-name":"DataSecurityMode","x-databricks-legacy-name":"DataSecurityMode","x-databricks-stable-name":"DataSecurityMode"},"docker_image":{"description":"Custom docker image BYOC","$ref":"#/components/schemas/compute.DockerImage","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-not-cloud":"gcp","x-databricks-schema-id":"cluster.ClusterAttributes.docker_image","x-databricks-sdk-name":"DockerImage","x-databricks-legacy-name":"DockerImage","x-databricks-stable-name":"DockerImage"},"driver_instance_pool_id":{"description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.driver_instance_pool_id"},"driver_node_type_id":{"description":"The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.driver_node_type_id"},"enable_elastic_disk":{"description":"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\npermissions to function correctly - refer to the User Guide for more details.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.enable_elastic_disk"},"enable_local_disk_encryption":{"description":"Whether to enable LUKS on cluster VMs' local disks","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.enable_local_disk_encryption"},"init_scripts":{"description":"The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `//init_scripts`.","type":"array","items":{"$ref":"#/components/schemas/compute.InitScriptInfo","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.init_scripts.array_value","x-databricks-sdk-name":"InitScriptInfo","x-databricks-legacy-name":"InitScriptInfo","x-databricks-stable-name":"InitScriptInfo"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.init_scripts"},"instance_pool_id":{"description":"The optional ID of the instance pool to which the cluster belongs.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.instance_pool_id"},"is_single_node":{"description":"This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.is_single_node"},"kind":{"$ref":"#/components/schemas/compute.kind","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.kind","x-databricks-sdk-name":"kind","x-databricks-legacy-name":"kind","x-databricks-stable-name":"kind"},"node_type_id":{"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.node_type_id"},"num_workers":{"description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterSize.num_workers"},"policy_id":{"description":"The ID of the cluster policy used to create the cluster if applicable.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.policy_id"},"runtime_engine":{"description":"Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.","$ref":"#/components/schemas/compute.RuntimeEngine","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.runtime_engine","x-databricks-sdk-name":"RuntimeEngine","x-databricks-legacy-name":"RuntimeEngine","x-databricks-stable-name":"RuntimeEngine"},"single_user_name":{"description":"Single user name if data_security_mode is `SINGLE_USER`","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.single_user_name"},"spark_conf":{"description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.SparkConfPair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.spark_conf"},"spark_env_vars":{"description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.SparkEnvPair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.spark_env_vars"},"spark_version":{"description":"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.spark_version"},"ssh_public_keys":{"description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.ssh_public_keys.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.ssh_public_keys"},"use_ml_runtime":{"description":"This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.use_ml_runtime"},"workload_type":{"$ref":"#/components/schemas/compute.WorkloadType","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterAttributes.workload_type","x-databricks-sdk-name":"WorkloadType","x-databricks-legacy-name":"WorkloadType","x-databricks-stable-name":"WorkloadType"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EditCluster","x-databricks-legacy-name":"EditCluster","x-databricks-stable-name":"EditCluster"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_events","parameters":{"data":{"type":"object","required":["cluster_id"],"properties":{"cluster_id":{"description":"The ID of the cluster to retrieve events about.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.GetEvents.cluster_id","example":"1234-567890-reef123"},"end_time":{"description":"The end time in epoch milliseconds.\nIf empty, returns events up to the current time.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.GetEvents.end_time","example":1619485200000},"event_types":{"description":"An optional set of event types to filter on.\nIf empty, all event types are returned.","type":"array","items":{"$ref":"#/components/schemas/compute.EventType","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.GetEvents.event_types.array_value","x-databricks-sdk-name":"EventType","x-databricks-legacy-name":"EventType","x-databricks-stable-name":"EventType"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.GetEvents.event_types"},"limit":{"description":"Deprecated: use page_token in combination with page_size instead.\n\nThe maximum number of events to include in a page of events.\nDefaults to 50, and maximum allowed value is 500.","type":"integer","format":"int64","x-databricks-api-version":"legacy","deprecated":true,"maximum":500,"x-databricks-schema-id":"cluster.GetEvents.limit","default":50},"offset":{"description":"Deprecated: use page_token in combination with page_size instead.\n\nThe offset in the result set. Defaults to 0 (no offset). When an offset is specified\nand the results are requested in descending order, the end_time field is required.","type":"integer","format":"int64","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"cluster.GetEvents.offset","example":5},"order":{"description":"The order to list events in; either \"ASC\" or \"DESC\". Defaults to \"DESC\".","$ref":"#/components/schemas/compute.GetEventsOrder","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.GetEvents.order","x-databricks-sdk-name":"GetEventsOrder","x-databricks-legacy-name":"GetEventsOrder","x-databricks-stable-name":"GetEventsOrder","default":"DESC"},"page_size":{"description":"The maximum number of events to include in a page of events.\nThe server may further constrain the maximum number of results returned in a single page.\nIf the page_size is empty or 0, the server will decide the number of results to be returned.\nThe field has to be in the range [0,500]. If the value is outside the range, the server enforces 0 or 500.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.GetEvents.page_size","default":50},"page_token":{"description":"Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of events respectively.\nIf page_token is empty, the first page is returned.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.GetEvents.page_token","default":""},"start_time":{"description":"The start time in epoch milliseconds.\nIf empty, returns events starting from the beginning of time.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.GetEvents.start_time","example":1617238800000}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"GetEvents","x-databricks-legacy-name":"GetEvents","x-databricks-stable-name":"GetEvents"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_clusters_get","parameters":{"cluster_id":{"type":"string","description":"The cluster about which to retrieve information."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_clusters_list","parameters":{"filter_by":{"type":"object","description":"Filters to apply to the list of clusters."},"page_token":{"type":"string","description":"Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of clusters respectively."},"page_size":{"type":"integer","description":"Use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page."},"sort_by":{"type":"object","description":"Sort the list of clusters by a specific criteria."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_clusters_list_node_types","parameters":{}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_clusters_list_zones","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_permanent_delete","parameters":{"data":{"type":"object","required":["cluster_id"],"properties":{"cluster_id":{"description":"The cluster to be deleted.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PermanentDeleteCluster.cluster_id","example":"1202-211320-brick1"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PermanentDeleteCluster","x-databricks-legacy-name":"PermanentDeleteCluster","x-databricks-stable-name":"PermanentDeleteCluster"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_pin","parameters":{"data":{"type":"object","required":["cluster_id"],"properties":{"cluster_id":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.PinCluster.cluster_id","example":"1234-567890-reef123"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"PinCluster","x-databricks-legacy-name":"PinCluster","x-databricks-stable-name":"PinCluster"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_resize","parameters":{"data":{"type":"object","required":["cluster_id"],"properties":{"autoscale":{"description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.","$ref":"#/components/schemas/compute.AutoScale","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterSize.autoscale","x-databricks-sdk-name":"AutoScale","x-databricks-legacy-name":"AutoScale","x-databricks-stable-name":"AutoScale"},"cluster_id":{"description":"The cluster to be resized.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ResizeCluster.cluster_id"},"num_workers":{"description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.ClusterSize.num_workers"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ResizeCluster","x-databricks-legacy-name":"ResizeCluster","x-databricks-stable-name":"ResizeCluster"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_restart","parameters":{"data":{"type":"object","required":["cluster_id"],"properties":{"cluster_id":{"description":"The cluster to be started.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.RestartCluster.cluster_id"},"restart_user":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.RestartCluster.restart_user"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RestartCluster","x-databricks-legacy-name":"RestartCluster","x-databricks-stable-name":"RestartCluster"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_clusters_spark_versions","parameters":{}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_start","parameters":{"data":{"type":"object","required":["cluster_id"],"properties":{"cluster_id":{"description":"The cluster to be started.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.StartCluster.cluster_id","example":"1202-211320-brick1"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"StartCluster","x-databricks-legacy-name":"StartCluster","x-databricks-stable-name":"StartCluster"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_unpin","parameters":{"data":{"type":"object","required":["cluster_id"],"properties":{"cluster_id":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.UnpinCluster.cluster_id","example":"1234-567890-reef123"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UnpinCluster","x-databricks-legacy-name":"UnpinCluster","x-databricks-stable-name":"UnpinCluster"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_clusters_update","parameters":{"data":{"type":"object","required":["cluster_id","update_mask"],"properties":{"cluster":{"description":"The cluster to be updated.","$ref":"#/components/schemas/compute.UpdateClusterResource","x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.UpdateCluster.cluster","x-databricks-sdk-name":"UpdateClusterResource","x-databricks-legacy-name":"UpdateClusterResource","x-databricks-stable-name":"UpdateClusterResource"},"cluster_id":{"description":"ID of the cluster.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.UpdateCluster.cluster_id"},"update_mask":{"description":"Used to specify which cluster attributes and size fields to update. See https://google.aip.dev/161 for more details.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"cluster.UpdateCluster.update_mask","x-databricks-well-known-type":"google.protobuf.FieldMask","example":"num_workers,spark_version,spark_conf"}},"x-databricks-package-name":"compute","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateCluster","x-databricks-legacy-name":"UpdateCluster","x-databricks-stable-name":"UpdateCluster"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_data_sharing_providers_by_provider_name_shares_by_share_name","parameters":{"provider_name":{"type":"string","description":"The name of the provider who owns the share."},"share_name":{"type":"string","description":"The name of the share."},"table_max_results":{"type":"integer","description":"Maximum number of tables to return."},"function_max_results":{"type":"integer","description":"Maximum number of functions to return."},"volume_max_results":{"type":"integer","description":"Maximum number of volumes to return."},"notebook_max_results":{"type":"integer","description":"Maximum number of notebooks to return."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_create","parameters":{"data":{"type":"object","properties":{"access_control_list":{"description":"List of permissions to set on the job.","type":"array","items":{"$ref":"#/components/schemas/jobs.JobAccessControlRequest","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.CreateJob21.access_control_list.array_value","x-databricks-sdk-name":"JobAccessControlRequest","x-databricks-legacy-name":"JobAccessControlRequest","x-databricks-stable-name":"JobAccessControlRequest"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.CreateJob21.access_control_list"},"continuous":{"description":"An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of `schedule` and `continuous` can be used.","$ref":"#/components/schemas/jobs.Continuous21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.continuous","x-databricks-sdk-name":"Continuous21","x-databricks-legacy-name":"Continuous21","x-databricks-stable-name":"Continuous21"},"deployment":{"description":"Deployment information for jobs managed by external sources.","$ref":"#/components/schemas/jobs.JobDeployment21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.deployment","x-databricks-sdk-name":"JobDeployment21","x-databricks-legacy-name":"JobDeployment21","x-databricks-stable-name":"JobDeployment21"},"description":{"description":"An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.","type":"string","x-databricks-api-version":"legacy","maxLength":27700,"x-databricks-schema-id":"jobs.JobSettings21.description","example":"This job contain multiple tasks that are required to produce the weekly shark sightings report."},"disable_auto_optimization":{"description":"An option to disable auto optimization in serverless","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobRetryPolicy21.disable_auto_optimization","default":false,"example":true},"edit_mode":{"description":"Edit mode of the job.\n\n* `UI_LOCKED`: The job is in a locked UI state and cannot be modified.\n* `EDITABLE`: The job is in an editable state and can be modified.","$ref":"#/components/schemas/jobs.JobEditMode21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.edit_mode","x-databricks-sdk-name":"JobEditMode21","x-databricks-legacy-name":"JobEditMode21","x-databricks-stable-name":"JobEditMode21"},"email_notifications":{"description":"An optional set of email addresses that is notified when runs of this job begin or complete as well as when this job is deleted.","$ref":"#/components/schemas/jobs.JobEmailNotifications21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.email_notifications","x-databricks-sdk-name":"JobEmailNotifications21","x-databricks-legacy-name":"JobEmailNotifications21","x-databricks-stable-name":"JobEmailNotifications21","default":{}},"environments":{"description":"A list of task execution environment specifications that can be referenced by serverless tasks of this job.\nAn environment is required to be present for serverless tasks.\nFor serverless notebook tasks, the environment is accessible in the notebook environment panel.\nFor other serverless tasks, the task environment is required to be specified using environment_key in the task settings.","type":"array","items":{"$ref":"#/components/schemas/jobs.JobEnvironment21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.environments.array_value","x-databricks-sdk-name":"JobEnvironment21","x-databricks-legacy-name":"JobEnvironment21","x-databricks-stable-name":"JobEnvironment21"},"x-databricks-terraform":{"alias":"environment"},"x-databricks-api-version":"legacy","maxItems":10,"x-databricks-launch-stage":"GA","x-databricks-schema-id":"jobs.JobSettings21.environments"},"format":{"description":"Used to tell what is the format of the job. This field is ignored in Create/Update/Reset calls. When using the Jobs API 2.1 this value is always set to `\"MULTI_TASK\"`.","$ref":"#/components/schemas/jobs.Format21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.JobSettings21.format","x-databricks-sdk-name":"Format21","x-databricks-legacy-name":"Format21","x-databricks-stable-name":"Format21","example":"MULTI_TASK"},"git_source":{"description":"An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.","$ref":"#/components/schemas/jobs.GitSource21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.git_source","x-databricks-sdk-name":"GitSource21","x-databricks-legacy-name":"GitSource21","x-databricks-stable-name":"GitSource21"},"health":{"$ref":"#/components/schemas/jobs.JobsHealthRules21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.health","x-databricks-sdk-name":"JobsHealthRules21","x-databricks-legacy-name":"JobsHealthRules21","x-databricks-stable-name":"JobsHealthRules21"},"job_clusters":{"description":"A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings.","type":"array","items":{"$ref":"#/components/schemas/jobs.JobCluster21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.job_clusters.array_value","x-databricks-sdk-name":"JobCluster21","x-databricks-legacy-name":"JobCluster21","x-databricks-stable-name":"JobCluster21"},"x-databricks-terraform":{"alias":"job_cluster"},"x-databricks-api-version":"legacy","maxItems":100,"x-databricks-schema-id":"jobs.JobSettings21.job_clusters","example":[{"job_cluster_key":"auto_scaling_cluster","new_cluster":{"autoscale":{"max_workers":16,"min_workers":2},"node_type_id":null,"spark_conf":{"spark.speculation":true},"spark_version":"7.3.x-scala2.12"}}]},"max_concurrent_runs":{"description":"An optional maximum allowed number of concurrent runs of the job.\nSet this value if you want to be able to execute multiple runs of the same job concurrently.\nThis is useful for example if you trigger your job on a frequent schedule and want to allow consecutive runs to overlap with each other, or if you want to trigger multiple runs which differ by their input parameters.\nThis setting affects only new runs. For example, suppose the job’s concurrency is 4 and there are 4 concurrent active runs. Then setting the concurrency to 3 won’t kill any of the active runs.\nHowever, from then on, new runs are skipped unless there are fewer than 3 active runs.\nThis value cannot exceed 1000. Setting this value to `0` causes all new runs to be skipped.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.max_concurrent_runs","default":1,"example":10},"max_retries":{"description":"An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with the `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The value `-1` means to retry indefinitely and the value `0` means to never retry.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobRetryPolicy21.max_retries","default":0,"example":10},"min_retry_interval_millis":{"description":"An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobRetryPolicy21.min_retry_interval_millis","example":2000},"name":{"description":"An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding.","type":"string","x-databricks-api-version":"legacy","maxLength":4096,"x-databricks-schema-id":"jobs.JobSettings21.name","default":"Untitled","example":"A multitask job"},"notification_settings":{"description":"Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this job.","$ref":"#/components/schemas/jobs.JobNotificationSettings21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.notification_settings","x-databricks-sdk-name":"JobNotificationSettings21","x-databricks-legacy-name":"JobNotificationSettings21","x-databricks-stable-name":"JobNotificationSettings21","default":{}},"parameters":{"description":"Job-level parameter definitions","type":"array","items":{"$ref":"#/components/schemas/jobs.JobParameterDefinition21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.parameters.array_value","x-databricks-sdk-name":"JobParameterDefinition21","x-databricks-legacy-name":"JobParameterDefinition21","x-databricks-stable-name":"JobParameterDefinition21"},"x-databricks-terraform":{"alias":"parameter"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.parameters"},"performance_target":{"description":"The performance mode on a serverless job. This field determines the level of compute performance or cost-efficiency for the run.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.","$ref":"#/components/schemas/jobs.PerformanceTarget21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.performance_target","x-databricks-sdk-name":"PerformanceTarget21","x-databricks-legacy-name":"PerformanceTarget21","x-databricks-stable-name":"PerformanceTarget21","default":"PERFORMANCE_OPTIMIZED"},"queue":{"description":"The queue settings of the job.","$ref":"#/components/schemas/jobs.QueueSettings21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.queue","x-databricks-sdk-name":"QueueSettings21","x-databricks-legacy-name":"QueueSettings21","x-databricks-stable-name":"QueueSettings21"},"retry_on_timeout":{"description":"An optional policy to specify whether to retry a job when it times out. The default behavior\nis to not retry on timeout.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobRetryPolicy21.retry_on_timeout","default":false,"example":true},"run_as":{"$ref":"#/components/schemas/jobs.JobRunAs21","x-databricks-package-name":"jobs","x-databricks-field-behaviors":["INPUT_ONLY"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.run_as","x-databricks-sdk-name":"JobRunAs21","x-databricks-legacy-name":"JobRunAs21","x-databricks-stable-name":"JobRunAs21"},"schedule":{"description":"An optional periodic schedule for this job. The default behavior is that the job only runs when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.","$ref":"#/components/schemas/jobs.CronSchedule21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.schedule","x-databricks-sdk-name":"CronSchedule21","x-databricks-legacy-name":"CronSchedule21","x-databricks-stable-name":"CronSchedule21"},"tags":{"description":"A map of tags associated with the job. These are forwarded to the cluster as cluster tags for jobs clusters, and are subject to the same limitations as cluster tags. A maximum of 25 tags can be added to the job.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobTag21.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.tags","default":{},"example":{"cost-center":"engineering","team":"jobs"}},"tasks":{"description":"A list of task specifications to be executed by this job.\nIf more than 100 tasks are available, you can paginate through them using :method:jobs/get. Use the `next_page_token` field at the object root to determine if more results are available.","type":"array","items":{"$ref":"#/components/schemas/jobs.Task21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.tasks.array_value","x-databricks-sdk-name":"Task21","x-databricks-legacy-name":"Task21","x-databricks-stable-name":"Task21"},"x-databricks-terraform":{"alias":"task"},"x-databricks-api-version":"legacy","maxItems":100,"x-databricks-schema-id":"jobs.JobSettings21.tasks","example":[{"depends_on":[],"description":"Extracts session data from events","existing_cluster_id":"0923-164208-meows279","libraries":[{"jar":"dbfs:/mnt/databricks/Sessionize.jar"}],"max_retries":3,"min_retry_interval_millis":2000,"retry_on_timeout":false,"spark_jar_task":{"main_class_name":"com.databricks.Sessionize","parameters":["--data","dbfs:/path/to/data.json"]},"task_key":"Sessionize","timeout_seconds":86400},{"depends_on":[],"description":"Ingests order data","job_cluster_key":"auto_scaling_cluster","libraries":[{"jar":"dbfs:/mnt/databricks/OrderIngest.jar"}],"max_retries":3,"min_retry_interval_millis":2000,"retry_on_timeout":false,"spark_jar_task":{"main_class_name":"com.databricks.OrdersIngest","parameters":["--data","dbfs:/path/to/order-data.json"]},"task_key":"Orders_Ingest","timeout_seconds":86400},{"depends_on":[{"task_key":"Orders_Ingest"},{"task_key":"Sessionize"}],"description":"Matches orders with user sessions","max_retries":3,"min_retry_interval_millis":2000,"new_cluster":{"autoscale":{"max_workers":16,"min_workers":2},"node_type_id":null,"spark_conf":{"spark.speculation":true},"spark_version":"7.3.x-scala2.12"},"notebook_task":{"base_parameters":{"age":"35","name":"John Doe"},"notebook_path":"/Users/user.name@databricks.com/Match"},"retry_on_timeout":false,"run_if":"ALL_SUCCESS","task_key":"Match","timeout_seconds":86400}]},"timeout_seconds":{"description":"An optional timeout applied to each run of this job. A value of `0` means no timeout.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.timeout_seconds","default":0,"example":86400},"trigger":{"description":"A configuration to trigger a run when certain conditions are met. The default behavior is that the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.","$ref":"#/components/schemas/jobs.TriggerSettings21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.trigger","x-databricks-sdk-name":"TriggerSettings21","x-databricks-legacy-name":"TriggerSettings21","x-databricks-stable-name":"TriggerSettings21"},"webhook_notifications":{"description":"A collection of system notification IDs to notify when runs of this job begin or complete.","$ref":"#/components/schemas/jobs.WebhookNotifications21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.JobSettings21.webhook_notifications","x-databricks-sdk-name":"WebhookNotifications21","x-databricks-legacy-name":"WebhookNotifications21","x-databricks-stable-name":"WebhookNotifications21","default":{}}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateJob21","x-databricks-legacy-name":"CreateJob21","x-databricks-stable-name":"CreateJob21"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_delete","parameters":{"data":{"type":"object","required":["job_id"],"properties":{"job_id":{"description":"The canonical identifier of the job to delete. This field is required.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.DeleteJob21.job_id","example":11223344}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteJob21","x-databricks-legacy-name":"DeleteJob21","x-databricks-stable-name":"DeleteJob21"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_jobs_get","parameters":{"job_id":{"type":"integer","description":"The canonical identifier of the job to retrieve information about. This field is required."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_jobs_list","parameters":{"offset":{"type":"integer","description":"The offset of the first job to return, relative to the most recently created job.\nDeprecated since June 2023. Use `page_token` to iterate through the pages instead."},"limit":{"type":"integer","description":"The number of jobs to return. This value must be greater than 0 and less or equal to 100. The default value is 20."},"expand_tasks":{"type":"boolean","description":"Whether to include task and cluster details in the response."},"name":{"type":"string","description":"A filter on the list based on the exact (case insensitive) job name."},"page_token":{"type":"string","description":"Use `next_page_token` or `prev_page_token` returned from the previous request to list the next or previous page of jobs respectively."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_reset","parameters":{"data":{"type":"object","required":["job_id","new_settings"],"properties":{"job_id":{"description":"The canonical identifier of the job to reset. This field is required.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ResetJob21.job_id","example":11223344},"new_settings":{"description":"The new settings of the job. These settings completely replace the old settings.\n\nChanges to the field `JobBaseSettings.timeout_seconds` are applied to active runs. Changes to other fields are applied to future runs only.","$ref":"#/components/schemas/jobs.JobSettings21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ResetJob21.new_settings","x-databricks-sdk-name":"JobSettings21","x-databricks-legacy-name":"JobSettings21","x-databricks-stable-name":"JobSettings21"}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"ResetJob21","x-databricks-legacy-name":"ResetJob21","x-databricks-stable-name":"ResetJob21"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_run_now","parameters":{"data":{"type":"object","required":["job_id"],"properties":{"dbt_commands":{"description":"An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.dbt_commands.array_value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.dbt_commands","example":["dbt deps","dbt seed","dbt run"]},"idempotency_token":{"description":"An optional token to guarantee the idempotency of job run requests. If a run with the provided token already exists,\nthe request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted,\nan error is returned.\n\nIf you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly one run\nis launched with that idempotency token.\n\nThis token must have at most 64 characters.\n\nFor more information, see [How to ensure idempotency for jobs](https://kb.databricks.com/jobs/jobs-idempotency.html).","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunNow21.idempotency_token","example":"8f018174-4792-40d5-bcbc-3e6a527352c8"},"jar_params":{"description":"A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.jar_params.array_value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.jar_params","example":["john","doe","35"]},"job_id":{"description":"The ID of the job to be executed","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunNow21.job_id","example":11223344},"job_parameters":{"description":"Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ParamPair21.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunNow21.job_parameters"},"notebook_params":{"description":"A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ParamPair21.value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.notebook_params","example":{"age":"35","name":"john doe"}},"only":{"description":"A list of task keys to run inside of the job. If this field is not provided, all tasks in the job will be run.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunNow21.only.array_value","example":"notebook_task_1"},"x-databricks-api-version":"legacy","x-databricks-launch-stage":"GA","x-databricks-schema-id":"jobs.RunNow21.only"},"performance_target":{"description":"The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.","$ref":"#/components/schemas/jobs.PerformanceTarget21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunNow21.performance_target","x-databricks-sdk-name":"PerformanceTarget21","x-databricks-legacy-name":"PerformanceTarget21","x-databricks-stable-name":"PerformanceTarget21"},"pipeline_params":{"description":"Controls whether the pipeline should perform a full refresh","$ref":"#/components/schemas/jobs.PipelineParams21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.pipeline_params","x-databricks-sdk-name":"PipelineParams21","x-databricks-legacy-name":"PipelineParams21","x-databricks-stable-name":"PipelineParams21"},"python_named_params":{"type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ParamPair21.value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.python_named_params","example":{"data":"dbfs:/path/to/data.json","name":"task"}},"python_params":{"description":"A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.python_params.array_value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.python_params","example":["john doe","35"]},"queue":{"description":"The queue settings of the run.","$ref":"#/components/schemas/jobs.QueueSettings21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunNow21.queue","x-databricks-sdk-name":"QueueSettings21","x-databricks-legacy-name":"QueueSettings21","x-databricks-stable-name":"QueueSettings21"},"spark_submit_params":{"description":"A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.spark_submit_params.array_value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.spark_submit_params","example":["--class","org.apache.spark.examples.SparkPi"]},"sql_params":{"description":"A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ParamPair21.value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-not-cloud":"gcp","x-databricks-schema-id":"jobs.RunParameters21.sql_params","example":{"age":"35","name":"john doe"}}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RunNow21","x-databricks-legacy-name":"RunNow21","x-databricks-stable-name":"RunNow21"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_runs_cancel","parameters":{"data":{"type":"object","required":["run_id"],"properties":{"run_id":{"description":"This field is required.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.CancelRun21.run_id","example":455644833}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CancelRun21","x-databricks-legacy-name":"CancelRun21","x-databricks-stable-name":"CancelRun21"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_runs_cancel_all","parameters":{"data":{"type":"object","properties":{"all_queued_runs":{"description":"Optional boolean parameter to cancel all queued runs. If no job_id is provided, all queued runs in the workspace are canceled.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.CancelAllRuns21.all_queued_runs","default":false,"example":false},"job_id":{"description":"The canonical identifier of the job to cancel all runs of.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.CancelAllRuns21.job_id","example":11223344}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CancelAllRuns21","x-databricks-legacy-name":"CancelAllRuns21","x-databricks-stable-name":"CancelAllRuns21"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_runs_delete","parameters":{"data":{"type":"object","required":["run_id"],"properties":{"run_id":{"description":"ID of the run to delete.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.DeleteRun21.run_id","example":455644833}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"DeleteRun21","x-databricks-legacy-name":"DeleteRun21","x-databricks-stable-name":"DeleteRun21"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_jobs_runs_export","parameters":{"run_id":{"type":"integer","description":"The canonical identifier for the run. This field is required."},"views_to_export":{"type":"string","description":"Which views to export (CODE, DASHBOARDS, or ALL). Defaults to CODE."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_jobs_runs_get","parameters":{"run_id":{"type":"integer","description":"The canonical identifier of the run for which to retrieve the metadata.\nThis field is required."},"include_history":{"type":"boolean","description":"Whether to include the repair history in the response."},"include_resolved_values":{"type":"boolean","description":"Whether to include resolved parameter values in the response."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_jobs_runs_get_output","parameters":{"run_id":{"type":"integer","description":"The canonical identifier for the run."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_jobs_runs_list","parameters":{"job_id":{"type":"integer","description":"The job for which to list runs. If omitted, the Jobs service lists runs from all jobs."},"active_only":{"type":"boolean","description":"If active_only is `true`, only active runs are included in the results; otherwise,\nlists both active and completed runs. An active run is a run in the `QUEUED`, `PENDING`,\n`RUNNING`, or `TERMINATING`. This field cannot be `true` when completed_only is `true`."},"completed_only":{"type":"boolean","description":"If completed_only is `true`, only completed runs are included in the results;\notherwise, lists both active and completed runs. This field cannot be `true` when\nactive_only is `true`."},"offset":{"type":"integer","description":"The offset of the first run to return, relative to the most recent run.\nDeprecated since June 2023. Use `page_token` to iterate through the pages instead."},"limit":{"type":"integer","description":"The number of runs to return. This value must be greater than 0 and less than 25.\nThe default value is 20. If a request specifies a limit of 0, the service instead\nuses the maximum limit."},"run_type":{"type":"string","description":"The type of runs to return. For a description of run types, see :method:jobs/getRun."},"expand_tasks":{"type":"boolean","description":"Whether to include task and cluster details in the response."},"start_time_from":{"type":"integer","description":"Show runs that started _at or after_ this value. The value must be a UTC timestamp\nin milliseconds. Can be combined with _start_time_to_ to filter by a time range."},"start_time_to":{"type":"integer","description":"Show runs that started _at or before_ this value. The value must be a UTC timestamp\nin milliseconds. Can be combined with _start_time_from_ to filter by a time range."},"page_token":{"type":"string","description":"Use `next_page_token` or `prev_page_token` returned from the previous request to list the next or previous page of runs respectively."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_runs_repair","parameters":{"data":{"type":"object","required":["run_id"],"properties":{"dbt_commands":{"description":"An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.dbt_commands.array_value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.dbt_commands","example":["dbt deps","dbt seed","dbt run"]},"jar_params":{"description":"A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.jar_params.array_value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.jar_params","example":["john","doe","35"]},"job_parameters":{"description":"Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ParamPair21.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RepairRun21.job_parameters"},"latest_repair_id":{"description":"The ID of the latest repair. This parameter is not required when repairing a run for the first time, but must be provided on subsequent requests to repair the same run.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RepairRun21.latest_repair_id","example":734650698524280},"notebook_params":{"description":"A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ParamPair21.value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.notebook_params","example":{"age":"35","name":"john doe"}},"performance_target":{"description":"The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.","$ref":"#/components/schemas/jobs.PerformanceTarget21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RepairRun21.performance_target","x-databricks-sdk-name":"PerformanceTarget21","x-databricks-legacy-name":"PerformanceTarget21","x-databricks-stable-name":"PerformanceTarget21"},"pipeline_params":{"description":"Controls whether the pipeline should perform a full refresh","$ref":"#/components/schemas/jobs.PipelineParams21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.pipeline_params","x-databricks-sdk-name":"PipelineParams21","x-databricks-legacy-name":"PipelineParams21","x-databricks-stable-name":"PipelineParams21"},"python_named_params":{"type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ParamPair21.value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.python_named_params","example":{"data":"dbfs:/path/to/data.json","name":"task"}},"python_params":{"description":"A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.python_params.array_value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.python_params","example":["john doe","35"]},"rerun_all_failed_tasks":{"description":"If true, repair all failed tasks. Only one of `rerun_tasks` or `rerun_all_failed_tasks` can be used.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RepairRun21.rerun_all_failed_tasks","default":false},"rerun_dependent_tasks":{"description":"If true, repair all tasks that depend on the tasks in `rerun_tasks`, even if they were previously successful. Can be also used in combination with `rerun_all_failed_tasks`.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RepairRun21.rerun_dependent_tasks","default":false},"rerun_tasks":{"description":"The task keys of the task runs to repair.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RepairRun21.rerun_tasks.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RepairRun21.rerun_tasks","example":["task0","task1"]},"run_id":{"description":"The job run ID of the run to repair. The run must not be in progress.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RepairRun21.run_id","example":455644833},"spark_submit_params":{"description":"A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunParameters21.spark_submit_params.array_value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-schema-id":"jobs.RunParameters21.spark_submit_params","example":["--class","org.apache.spark.examples.SparkPi"]},"sql_params":{"description":"A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.ParamPair21.value"},"x-databricks-api-version":"legacy","deprecated":true,"x-databricks-not-cloud":"gcp","x-databricks-schema-id":"jobs.RunParameters21.sql_params","example":{"age":"35","name":"john doe"}}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"RepairRun21","x-databricks-legacy-name":"RepairRun21","x-databricks-stable-name":"RepairRun21"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_runs_submit","parameters":{"data":{"type":"object","properties":{"access_control_list":{"description":"List of permissions to set on the job.","type":"array","items":{"$ref":"#/components/schemas/jobs.JobAccessControlRequest","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.SubmitRun21.access_control_list.array_value","x-databricks-sdk-name":"JobAccessControlRequest","x-databricks-legacy-name":"JobAccessControlRequest","x-databricks-stable-name":"JobAccessControlRequest"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.SubmitRun21.access_control_list"},"email_notifications":{"description":"An optional set of email addresses notified when the run begins or completes.","$ref":"#/components/schemas/jobs.JobEmailNotifications21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.email_notifications","x-databricks-sdk-name":"JobEmailNotifications21","x-databricks-legacy-name":"JobEmailNotifications21","x-databricks-stable-name":"JobEmailNotifications21","default":{}},"environments":{"description":"A list of task execution environment specifications that can be referenced by tasks of this run.","type":"array","items":{"$ref":"#/components/schemas/jobs.JobEnvironment21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.environments.array_value","x-databricks-sdk-name":"JobEnvironment21","x-databricks-legacy-name":"JobEnvironment21","x-databricks-stable-name":"JobEnvironment21"},"x-databricks-api-version":"legacy","maxItems":10,"x-databricks-schema-id":"jobs.RunSettings21.environments"},"git_source":{"description":"An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.","$ref":"#/components/schemas/jobs.GitSource21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.git_source","x-databricks-sdk-name":"GitSource21","x-databricks-legacy-name":"GitSource21","x-databricks-stable-name":"GitSource21"},"health":{"$ref":"#/components/schemas/jobs.JobsHealthRules21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.health","x-databricks-sdk-name":"JobsHealthRules21","x-databricks-legacy-name":"JobsHealthRules21","x-databricks-stable-name":"JobsHealthRules21"},"idempotency_token":{"description":"An optional token that can be used to guarantee the idempotency of job run requests. If a run with the provided token already exists,\nthe request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted,\nan error is returned.\n\nIf you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly\none run is launched with that idempotency token.\n\nThis token must have at most 64 characters.\n\nFor more information, see [How to ensure idempotency for jobs](https://kb.databricks.com/jobs/jobs-idempotency.html).","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.idempotency_token","example":"8f018174-4792-40d5-bcbc-3e6a527352c8"},"notification_settings":{"description":"Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this run.","$ref":"#/components/schemas/jobs.JobNotificationSettings21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.notification_settings","x-databricks-sdk-name":"JobNotificationSettings21","x-databricks-legacy-name":"JobNotificationSettings21","x-databricks-stable-name":"JobNotificationSettings21","default":{}},"queue":{"description":"The queue settings of the one-time run.","$ref":"#/components/schemas/jobs.QueueSettings21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.SubmitRun21.queue","x-databricks-sdk-name":"QueueSettings21","x-databricks-legacy-name":"QueueSettings21","x-databricks-stable-name":"QueueSettings21"},"run_as":{"description":"Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who submits the request.","$ref":"#/components/schemas/jobs.JobRunAs21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.SubmitRun21.run_as","x-databricks-sdk-name":"JobRunAs21","x-databricks-legacy-name":"JobRunAs21","x-databricks-stable-name":"JobRunAs21"},"run_name":{"description":"An optional name for the run. The default value is `Untitled`.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.run_name","default":"Untitled","example":"A multitask job run"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/jobs.SubmitTask21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.tasks.array_value","x-databricks-sdk-name":"SubmitTask21","x-databricks-legacy-name":"SubmitTask21","x-databricks-stable-name":"SubmitTask21"},"x-databricks-api-version":"legacy","maxItems":100,"x-databricks-schema-id":"jobs.RunSettings21.tasks","example":[{"depends_on":[],"description":"Extracts session data from events","existing_cluster_id":"0923-164208-meows279","libraries":[{"jar":"dbfs:/mnt/databricks/Sessionize.jar"}],"min_retry_interval_millis":2000,"retry_on_timeout":false,"spark_jar_task":{"main_class_name":"com.databricks.Sessionize","parameters":["--data","dbfs:/path/to/data.json"]},"task_key":"Sessionize","timeout_seconds":86400},{"depends_on":[],"description":"Ingests order data","existing_cluster_id":"0923-164208-meows279","libraries":[{"jar":"dbfs:/mnt/databricks/OrderIngest.jar"}],"spark_jar_task":{"main_class_name":"com.databricks.OrdersIngest","parameters":["--data","dbfs:/path/to/order-data.json"]},"task_key":"Orders_Ingest","timeout_seconds":86400},{"depends_on":[{"task_key":"Orders_Ingest"},{"task_key":"Sessionize"}],"description":"Matches orders with user sessions","new_cluster":{"autoscale":{"max_workers":16,"min_workers":2},"node_type_id":null,"spark_conf":{"spark.speculation":true},"spark_version":"7.3.x-scala2.12"},"notebook_task":{"base_parameters":{"age":"35","name":"John Doe"},"notebook_path":"/Users/user.name@databricks.com/Match"},"retry_on_timeout":false,"run_if":"ALL_SUCCESS","task_key":"Match","timeout_seconds":86400}]},"timeout_seconds":{"description":"An optional timeout applied to each run of this job. A value of `0` means no timeout.","type":"integer","format":"int32","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.timeout_seconds","default":0,"example":86400},"webhook_notifications":{"description":"A collection of system notification IDs to notify when the run begins or completes.","$ref":"#/components/schemas/jobs.WebhookNotifications21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.RunSettings21.webhook_notifications","x-databricks-sdk-name":"WebhookNotifications21","x-databricks-legacy-name":"WebhookNotifications21","x-databricks-stable-name":"WebhookNotifications21","default":{}}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SubmitRun21","x-databricks-legacy-name":"SubmitRun21","x-databricks-stable-name":"SubmitRun21"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_jobs_update","parameters":{"data":{"type":"object","required":["job_id"],"properties":{"fields_to_remove":{"description":"Remove top-level fields in the job settings. Removing nested fields is not supported, except for tasks and job clusters (`tasks/task_1`). This field is optional.","type":"array","items":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.UpdateJob21.fields_to_remove.array_value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.UpdateJob21.fields_to_remove","example":["libraries","schedule","tasks/task_1","job_clusters/Default"]},"job_id":{"description":"The canonical identifier of the job to update. This field is required.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.UpdateJob21.job_id","example":11223344},"new_settings":{"description":"The new settings for the job.\n\nTop-level fields specified in `new_settings` are completely replaced, except for arrays which are merged. That is, new and existing entries are completely replaced based on the respective key fields, i.e. `task_key` or `job_cluster_key`, while previous entries are kept.\n\nPartially updating nested fields is not supported.\n\nChanges to the field `JobSettings.timeout_seconds` are applied to active runs. Changes to other fields are applied to future runs only.","$ref":"#/components/schemas/jobs.JobSettings21","x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-schema-id":"jobs.UpdateJob21.new_settings","x-databricks-sdk-name":"JobSettings21","x-databricks-legacy-name":"JobSettings21","x-databricks-stable-name":"JobSettings21"}},"x-databricks-package-name":"jobs","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateJob21","x-databricks-legacy-name":"UpdateJob21","x-databricks-stable-name":"UpdateJob21"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_installations","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_listings","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"},"assets":{"type":"array","description":"Matches any of the following asset types"},"categories":{"type":"array","description":"Matches any of the following categories"},"tags":{"type":"array","description":"Matches any of the following tags"},"is_free":{"type":"boolean","description":"Filters each listing based on if it is free."},"is_private_exchange":{"type":"boolean","description":"Filters each listing based on if it is a private exchange."},"is_staff_pick":{"type":"boolean","description":"Filters each listing based on whether it is a staff pick."},"provider_ids":{"type":"array","description":"Matches any of the following provider ids"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_listings_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_listings_by_listing_id_content","parameters":{"listing_id":{"type":"string"},"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_listings_by_listing_id_fulfillments","parameters":{"listing_id":{"type":"string"},"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_listings_by_listing_id_installations","parameters":{"listing_id":{"type":"string"},"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_marketplace_consumer_listings_by_listing_id_installations","parameters":{"listing_id":{"type":"string"},"data":{"type":"object","properties":{"accepted_consumer_terms":{"$ref":"#/components/schemas/marketplace.ConsumerTerms","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.InstallListing.accepted_consumer_terms","x-databricks-sdk-name":"ConsumerTerms","x-databricks-legacy-name":"ConsumerTerms","x-databricks-stable-name":"ConsumerTerms"},"catalog_name":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.InstallListing.catalog_name"},"recipient_type":{"$ref":"#/components/schemas/marketplace.DeltaSharingRecipientType","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.InstallListing.recipient_type","x-databricks-sdk-name":"DeltaSharingRecipientType","x-databricks-legacy-name":"DeltaSharingRecipientType","x-databricks-stable-name":"DeltaSharingRecipientType"},"repo_detail":{"description":"for git repo installations","$ref":"#/components/schemas/marketplace.RepoInstallation","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.InstallListing.repo_detail","x-databricks-sdk-name":"RepoInstallation","x-databricks-legacy-name":"RepoInstallation","x-databricks-stable-name":"RepoInstallation"},"share_name":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.InstallListing.share_name"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateInstallationRequest","x-databricks-legacy-name":"CreateInstallationRequest","x-databricks-stable-name":"CreateInstallationRequest"}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_1_marketplace_consumer_listings_by_listing_id_installations_by_installation_id","parameters":{"listing_id":{"type":"string"},"installation_id":{"type":"string"},"data":{"type":"object","required":["installation"],"properties":{"installation":{"$ref":"#/components/schemas/marketplace.InstallationDetail","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdateInstallationDetail.installation","x-databricks-sdk-name":"InstallationDetail","x-databricks-legacy-name":"InstallationDetail","x-databricks-stable-name":"InstallationDetail"},"rotate_token":{"type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.UpdateInstallationDetail.rotate_token"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateInstallationRequest","x-databricks-legacy-name":"UpdateInstallationRequest","x-databricks-stable-name":"UpdateInstallationRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_marketplace_consumer_listings_by_listing_id_installations_by_installation_id","parameters":{"listing_id":{"type":"string"},"installation_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_listings_by_listing_id_personalization_requests","parameters":{"listing_id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_marketplace_consumer_listings_by_listing_id_personalization_requests","parameters":{"listing_id":{"type":"string"},"data":{"description":"Data request messages\nalso creates a lead (maybe)","type":"object","required":["intended_use","accepted_consumer_terms"],"properties":{"accepted_consumer_terms":{"$ref":"#/components/schemas/marketplace.ConsumerTerms","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreatePersonalizationRequest.accepted_consumer_terms","x-databricks-sdk-name":"ConsumerTerms","x-databricks-legacy-name":"ConsumerTerms","x-databricks-stable-name":"ConsumerTerms"},"comment":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreatePersonalizationRequest.comment"},"company":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreatePersonalizationRequest.company"},"first_name":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreatePersonalizationRequest.first_name"},"intended_use":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreatePersonalizationRequest.intended_use"},"is_from_lighthouse":{"type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreatePersonalizationRequest.is_from_lighthouse"},"last_name":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreatePersonalizationRequest.last_name"},"recipient_type":{"$ref":"#/components/schemas/marketplace.DeltaSharingRecipientType","x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-schema-id":"marketplace.CreatePersonalizationRequest.recipient_type","x-databricks-sdk-name":"DeltaSharingRecipientType","x-databricks-legacy-name":"DeltaSharingRecipientType","x-databricks-stable-name":"DeltaSharingRecipientType"}},"x-databricks-package-name":"marketplace","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreatePersonalizationRequest","x-databricks-legacy-name":"CreatePersonalizationRequest","x-databricks-stable-name":"CreatePersonalizationRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_listings_batch_get","parameters":{"ids":{"type":"array"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_personalization_requests","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_providers","parameters":{"page_token":{"type":"string"},"page_size":{"type":"integer"},"is_featured":{"type":"boolean"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_providers_by_id","parameters":{"id":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_providers_batch_get","parameters":{"ids":{"type":"array"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_marketplace_consumer_search_listings","parameters":{"query":{"type":"string","description":"Fuzzy matches query"},"is_free":{"type":"boolean"},"is_private_exchange":{"type":"boolean"},"provider_ids":{"type":"array","description":"Matches any of the following provider ids"},"categories":{"type":"array","description":"Matches any of the following categories"},"assets":{"type":"array","description":"Matches any of the following asset types"},"page_token":{"type":"string"},"page_size":{"type":"integer"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_tag_policies","parameters":{"page_size":{"type":"integer","description":"The maximum number of results to return in this request. Fewer results may be returned than requested. If\nunspecified or set to 0, this defaults to 1000. The maximum value is 1000; values above 1000 will be coerced down\nto 1000."},"page_token":{"type":"string","description":"An optional page token received from a previous list tag policies call."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_tag_policies","parameters":{"data":{"type":"object","required":["tag_key"],"properties":{"description":{"type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","maxLength":256,"x-databricks-schema-id":"tags.policies.TagPolicy.description","example":"Identifies the sensitivity level of the data for compliance purposes."},"id":{"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"tags.policies.TagPolicy.id"},"tag_key":{"type":"string","x-databricks-field-behaviors":["REQUIRED","IMMUTABLE"],"x-databricks-api-version":"legacy","minLength":1,"maxLength":256,"x-databricks-schema-id":"tags.policies.TagPolicy.tag_key","example":"sensitivity_level"},"values":{"type":"array","items":{"$ref":"#/components/schemas/tags.Value","x-databricks-package-name":"tags","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.tags.policies.TagPolicy.values.array_value","x-databricks-sdk-name":"Value","x-databricks-legacy-name":"Value","x-databricks-stable-name":"Value"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","maxItems":50,"x-databricks-schema-id":"tags.policies.TagPolicy.values","example":[{"name":"public"},{"name":"confidential"}]}},"x-databricks-package-name":"tags","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"TagPolicy","x-databricks-legacy-name":"TagPolicy","x-databricks-stable-name":"TagPolicy"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_tag_policies_by_tag_key","parameters":{"tag_key":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_1_tag_policies_by_tag_key","parameters":{"tag_key":{"type":"string"},"update_mask":{"type":"string"},"data":{"type":"object","required":["tag_key"],"properties":{"description":{"type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","maxLength":256,"x-databricks-schema-id":"tags.policies.TagPolicy.description","example":"Identifies the sensitivity level of the data for compliance purposes."},"id":{"type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"tags.policies.TagPolicy.id"},"tag_key":{"type":"string","x-databricks-field-behaviors":["REQUIRED","IMMUTABLE"],"x-databricks-api-version":"legacy","minLength":1,"maxLength":256,"x-databricks-schema-id":"tags.policies.TagPolicy.tag_key","example":"sensitivity_level"},"values":{"type":"array","items":{"$ref":"#/components/schemas/tags.Value","x-databricks-package-name":"tags","x-databricks-api-version":"legacy","x-databricks-schema-id":"databricks.tags.policies.TagPolicy.values.array_value","x-databricks-sdk-name":"Value","x-databricks-legacy-name":"Value","x-databricks-stable-name":"Value"},"x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","maxItems":50,"x-databricks-schema-id":"tags.policies.TagPolicy.values","example":[{"name":"public"},{"name":"confidential"}]}},"x-databricks-package-name":"tags","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"TagPolicy","x-databricks-legacy-name":"TagPolicy","x-databricks-stable-name":"TagPolicy"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_tag_policies_by_tag_key","parameters":{"tag_key":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_artifact_allowlists_by_artifact_type","parameters":{"artifact_type":{"type":"string","description":"The artifact type of the allowlist."}}},{"connectionName":"databricks-workspace","actionName":"put_api_2_1_unity_catalog_artifact_allowlists_by_artifact_type","parameters":{"artifact_type":{"type":"string","description":"The artifact type of the allowlist."},"data":{"type":"object","required":["artifact_matchers"],"properties":{"artifact_matchers":{"description":"A list of allowed artifact match patterns.","type":"array","items":{"$ref":"#/components/schemas/catalog.ArtifactMatcher","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ArtifactAllowlistInfo.artifact_matchers.array_value","x-databricks-sdk-name":"ArtifactMatcher","x-databricks-legacy-name":"ArtifactMatcher","x-databricks-stable-name":"ArtifactMatcher"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ArtifactAllowlistInfo.artifact_matchers"},"created_at":{"description":"Time at which this artifact allowlist was set, in epoch milliseconds.","type":"integer","format":"int64","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"managedcatalog.ArtifactAllowlistInfo.created_at"},"created_by":{"description":"Username of the user who set the artifact allowlist.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"managedcatalog.ArtifactAllowlistInfo.created_by"},"metastore_id":{"description":"Unique identifier of parent metastore.","type":"string","x-databricks-field-behaviors":["OUTPUT_ONLY"],"x-databricks-api-version":"legacy","readOnly":true,"x-databricks-schema-id":"managedcatalog.ArtifactAllowlistInfo.metastore_id"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"SetArtifactAllowlist","x-databricks-legacy-name":"SetArtifactAllowlist","x-databricks-stable-name":"SetArtifactAllowlist"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_bindings_by_securable_type_by_securable_name","parameters":{"securable_type":{"type":"string","description":"The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location)."},"securable_name":{"type":"string","description":"The name of the securable."},"max_results":{"type":"integer","description":"Maximum number of workspace bindings to return.\n- When set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- When set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the workspace bindings are returned (not recommended)."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_1_unity_catalog_bindings_by_securable_type_by_securable_name","parameters":{"securable_type":{"type":"string","description":"The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location)."},"securable_name":{"type":"string","description":"The name of the securable."},"data":{"type":"object","properties":{"add":{"description":"List of workspace bindings.","type":"array","items":{"$ref":"#/components/schemas/catalog.workspaceBinding","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateWorkspaceBindings.add.array_value","x-databricks-sdk-name":"workspaceBinding","x-databricks-legacy-name":"workspaceBinding","x-databricks-stable-name":"workspaceBinding"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateWorkspaceBindings.add"},"remove":{"description":"List of workspace bindings.","type":"array","items":{"$ref":"#/components/schemas/catalog.workspaceBinding","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateWorkspaceBindings.remove.array_value","x-databricks-sdk-name":"workspaceBinding","x-databricks-legacy-name":"workspaceBinding","x-databricks-stable-name":"workspaceBinding"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateWorkspaceBindings.remove"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"updateWorkspaceBindingsParameters","x-databricks-legacy-name":"updateWorkspaceBindingsParameters","x-databricks-stable-name":"updateWorkspaceBindingsParameters"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_catalogs","parameters":{"include_browse":{"type":"boolean","description":"Whether to include catalogs in the response for which the principal can only access selective metadata for"},"max_results":{"type":"integer","description":"Maximum number of catalogs to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid catalogs are returned (not recommended).\n- Note: The number of returned catalogs might be less than the specified max_results size, even zero.\nThe only definitive indication that no further catalogs can be fetched is when the next_page_token is unset from the response."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_unity_catalog_catalogs","parameters":{"data":{"type":"object","required":["name"],"properties":{"comment":{"description":"User-provided free-form text description.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.comment"},"connection_name":{"description":"The name of the connection to an external data source.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.connection_name"},"name":{"description":"Name of catalog.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.name"},"options":{"description":"A map of key-value properties attached to the securable.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StringKeyValuePair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.OptionsKVPairs.options"},"properties":{"description":"A map of key-value properties attached to the securable.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StringKeyValuePair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.PropertiesKVPairs.properties"},"provider_name":{"description":"The name of delta sharing provider.\n\nA Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.provider_name"},"share_name":{"description":"The name of the share under the share provider.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.share_name"},"storage_root":{"description":"Storage root URL for managed tables within catalog.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.storage_root"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateCatalog","x-databricks-legacy-name":"CreateCatalog","x-databricks-stable-name":"CreateCatalog"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_catalogs_by_name","parameters":{"name":{"type":"string","description":"The name of the catalog."},"include_browse":{"type":"boolean","description":"Whether to include catalogs in the response for which the principal can only access selective metadata for"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_1_unity_catalog_catalogs_by_name","parameters":{"name":{"type":"string","description":"The name of the catalog."},"data":{"type":"object","properties":{"comment":{"description":"User-provided free-form text description.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.comment"},"enable_predictive_optimization":{"description":"Whether predictive optimization should be enabled for this object and objects under it.","$ref":"#/components/schemas/catalog.EnablePredictiveOptimization","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.enable_predictive_optimization","x-databricks-sdk-name":"EnablePredictiveOptimization","x-databricks-legacy-name":"EnablePredictiveOptimization","x-databricks-stable-name":"EnablePredictiveOptimization"},"isolation_mode":{"description":"Whether the current securable is accessible from all workspaces or a specific set of workspaces.","$ref":"#/components/schemas/catalog.CatalogIsolationMode","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.isolation_mode","x-databricks-sdk-name":"CatalogIsolationMode","x-databricks-legacy-name":"CatalogIsolationMode","x-databricks-stable-name":"CatalogIsolationMode"},"new_name":{"description":"New name for the catalog.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateCatalog.new_name"},"options":{"description":"A map of key-value properties attached to the securable.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StringKeyValuePair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.OptionsKVPairs.options"},"owner":{"description":"Username of current owner of catalog.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CatalogInfo.owner"},"properties":{"description":"A map of key-value properties attached to the securable.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StringKeyValuePair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.PropertiesKVPairs.properties"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateCatalog","x-databricks-legacy-name":"UpdateCatalog","x-databricks-stable-name":"UpdateCatalog"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_unity_catalog_catalogs_by_name","parameters":{"name":{"type":"string","description":"The name of the catalog."},"force":{"type":"boolean","description":"Force deletion even if the catalog is not empty."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_connections","parameters":{"max_results":{"type":"integer","description":"Maximum number of connections to return.\n- If not set, all connections are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;"},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_unity_catalog_connections","parameters":{"data":{"type":"object","required":["name","connection_type","options"],"properties":{"comment":{"description":"User-provided free-form text description.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.connection.ConnectionInfo.comment"},"connection_type":{"description":"The type of connection.","$ref":"#/components/schemas/catalog.ConnectionType","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.connection.ConnectionInfo.connection_type","x-databricks-sdk-name":"ConnectionType","x-databricks-legacy-name":"ConnectionType","x-databricks-stable-name":"ConnectionType"},"name":{"description":"Name of the connection.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.connection.ConnectionInfo.name"},"options":{"description":"A map of key-value properties attached to the securable.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StringKeyValuePair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.OptionsKVPairs.options"},"properties":{"description":"A map of key-value properties attached to the securable.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StringKeyValuePair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.PropertiesKVPairs.properties"},"read_only":{"description":"If the connection is read only.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.connection.ConnectionInfo.read_only"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateConnection","x-databricks-legacy-name":"CreateConnection","x-databricks-stable-name":"CreateConnection"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_connections_by_name","parameters":{"name":{"type":"string","description":"Name of the connection."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_1_unity_catalog_connections_by_name","parameters":{"name":{"type":"string","description":"Name of the connection."},"data":{"type":"object","required":["options"],"properties":{"new_name":{"description":"New name for the connection.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.connection.UpdateConnection.new_name"},"options":{"description":"A map of key-value properties attached to the securable.","type":"object","additionalProperties":{"type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StringKeyValuePair.value"},"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.OptionsKVPairs.options"},"owner":{"description":"Username of current owner of the connection.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.connection.ConnectionInfo.owner"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateConnection","x-databricks-legacy-name":"UpdateConnection","x-databricks-stable-name":"UpdateConnection"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_unity_catalog_connections_by_name","parameters":{"name":{"type":"string","description":"The name of the connection to be deleted."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_unity_catalog_constraints","parameters":{"data":{"type":"object","required":["full_name_arg","constraint"],"properties":{"constraint":{"$ref":"#/components/schemas/catalog.TableConstraint","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CreateTableConstraint.constraint","x-databricks-sdk-name":"TableConstraint","x-databricks-legacy-name":"TableConstraint","x-databricks-stable-name":"TableConstraint"},"full_name_arg":{"description":"The full name of the table referenced by the constraint.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CreateTableConstraint.full_name_arg"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateTableConstraint","x-databricks-legacy-name":"CreateTableConstraint","x-databricks-stable-name":"CreateTableConstraint"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_unity_catalog_constraints_by_full_name","parameters":{"full_name":{"type":"string","description":"Full name of the table referenced by the constraint."},"constraint_name":{"type":"string","description":"The name of the constraint to delete."},"cascade":{"type":"boolean","description":"If true, try deleting all child constraints of the current constraint.\nIf false, reject this operation if the current constraint has any child constraints."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_credentials","parameters":{"max_results":{"type":"integer","description":"Maximum number of credentials to return.\n- If not set, the default max page size is used.\n- When set to a value greater than 0, the page length is the minimum of\nthis value and a server-configured value.\n- When set to 0, the page length is set to a server-configured value\n(recommended).\n- When set to a value less than 0, an invalid parameter error is\nreturned."},"page_token":{"type":"string","description":"Opaque token to retrieve the next page of results."},"purpose":{"type":"string","description":"Return only credentials for the specified purpose."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_unity_catalog_credentials","parameters":{"data":{"type":"object","required":["name"],"properties":{"aws_iam_role":{"description":"The AWS IAM role configuration.","$ref":"#/components/schemas/catalog.AwsIamRole","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.aws_iam_role","x-databricks-sdk-name":"AwsIamRole","x-databricks-legacy-name":"AwsIamRole","x-databricks-stable-name":"AwsIamRole"},"comment":{"description":"Comment associated with the credential.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.comment"},"name":{"description":"The credential name. The name must be unique among storage and service\ncredentials within the metastore.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.name"},"purpose":{"description":"Indicates the purpose of the credential.","$ref":"#/components/schemas/catalog.CredentialPurpose","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.purpose","x-databricks-sdk-name":"CredentialPurpose","x-databricks-legacy-name":"CredentialPurpose","x-databricks-stable-name":"CredentialPurpose"},"read_only":{"description":"Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.read_only"},"skip_validation":{"description":"Optional. Supplying true to this argument skips validation of the created\nset of credentials.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CreateCredential.skip_validation","default":false}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateCredentialRequest","x-databricks-legacy-name":"CreateCredentialRequest","x-databricks-stable-name":"CreateCredentialRequest"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_credentials_by_name_arg","parameters":{"name_arg":{"type":"string","description":"Name of the credential."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_1_unity_catalog_credentials_by_name_arg","parameters":{"name_arg":{"type":"string","description":"Name of the credential."},"data":{"type":"object","properties":{"aws_iam_role":{"description":"The AWS IAM role configuration.","$ref":"#/components/schemas/catalog.AwsIamRole","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-cloud":"aws","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.aws_iam_role","x-databricks-sdk-name":"AwsIamRole","x-databricks-legacy-name":"AwsIamRole","x-databricks-stable-name":"AwsIamRole"},"comment":{"description":"Comment associated with the credential.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.comment"},"force":{"description":"Force an update even if there are dependent services (when purpose is\n**SERVICE**) or dependent external locations and external tables (when\npurpose is **STORAGE**).","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateCredential.force"},"isolation_mode":{"description":"Whether the current securable is accessible from all workspaces or a\nspecific set of workspaces.","$ref":"#/components/schemas/catalog.IsolationMode","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.isolation_mode","x-databricks-sdk-name":"IsolationMode","x-databricks-legacy-name":"IsolationMode","x-databricks-stable-name":"IsolationMode"},"new_name":{"description":"New name of credential.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateCredential.new_name"},"owner":{"description":"Username of current owner of credential.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.owner"},"read_only":{"description":"Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.StorageCredentialInfo.read_only"},"skip_validation":{"description":"Supply true to this argument to skip validation of the updated credential.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateCredential.skip_validation"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateCredentialRequest","x-databricks-legacy-name":"UpdateCredentialRequest","x-databricks-stable-name":"UpdateCredentialRequest"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_unity_catalog_credentials_by_name_arg","parameters":{"name_arg":{"type":"string","description":"Name of the credential."},"force":{"type":"boolean","description":"Force an update even if there are dependent services (when purpose is\n**SERVICE**) or dependent external locations and external tables (when\npurpose is **STORAGE**)."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_current_metastore_assignment","parameters":{}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_effective_permissions_by_securable_type_by_full_name","parameters":{"securable_type":{"type":"string","description":"Type of securable."},"full_name":{"type":"string","description":"Full name of securable."},"principal":{"type":"string","description":"If provided, only the effective permissions for the specified principal (user or group) are returned."},"max_results":{"type":"integer","description":"Specifies the maximum number of privileges to return (page length).\nEvery EffectivePrivilegeAssignment present in a single page response is guaranteed to contain all the effective\nprivileges granted on (or inherited by) the requested Securable for the respective principal.\n\nIf not set, all the effective permissions are returned.\nIf set to\n- lesser than 0: invalid parameter error\n- 0: page length is set to a server configured value\n- lesser than 150 but greater than 0: invalid parameter error (this is to ensure that server is able to return at\nleast one complete EffectivePrivilegeAssignment in a single page response)\n- greater than (or equal to) 150: page length is the minimum of this value and a server configured value"},"page_token":{"type":"string","description":"Opaque token for the next page of results (pagination)."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_unity_catalog_entity_tag_assignments","parameters":{"data":{"description":"Represents a tag assignment to an entity","type":"object","required":["entity_name","tag_key","entity_type"],"properties":{"entity_name":{"description":"The fully qualified name of the entity to which the tag is assigned","type":"string","x-databricks-field-behaviors":["REQUIRED","IMMUTABLE"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.EntityTagAssignment.entity_name"},"entity_type":{"description":"The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes.","type":"string","x-databricks-field-behaviors":["REQUIRED","IMMUTABLE"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.EntityTagAssignment.entity_type"},"tag_key":{"description":"The key of the tag","type":"string","x-databricks-field-behaviors":["REQUIRED","IMMUTABLE"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.EntityTagAssignment.tag_key"},"tag_value":{"description":"The value of the tag","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.EntityTagAssignment.tag_value"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EntityTagAssignment","x-databricks-legacy-name":"EntityTagAssignment","x-databricks-stable-name":"EntityTagAssignment"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_entity_tag_assignments_by_entity_type_by_entity_name_tags","parameters":{"entity_type":{"type":"string","description":"The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes."},"entity_name":{"type":"string","description":"The fully qualified name of the entity to which the tag is assigned"},"max_results":{"type":"integer","description":"Optional. Maximum number of tag assignments to return in a single page"},"page_token":{"type":"string","description":"Optional. Pagination token to retrieve the next page of results"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_entity_tag_assignments_by_entity_type_by_entity_name_tags_by_tag_key","parameters":{"entity_type":{"type":"string","description":"The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes."},"entity_name":{"type":"string","description":"The fully qualified name of the entity to which the tag is assigned"},"tag_key":{"type":"string","description":"Required. The key of the tag"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_1_unity_catalog_entity_tag_assignments_by_entity_type_by_entity_name_tags_by_tag_key","parameters":{"entity_type":{"type":"string","description":"The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes."},"entity_name":{"type":"string","description":"The fully qualified name of the entity to which the tag is assigned"},"tag_key":{"type":"string","description":"The key of the tag"},"update_mask":{"type":"string"},"data":{"description":"Represents a tag assignment to an entity","type":"object","required":["entity_name","tag_key","entity_type"],"properties":{"entity_name":{"description":"The fully qualified name of the entity to which the tag is assigned","type":"string","x-databricks-field-behaviors":["REQUIRED","IMMUTABLE"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.EntityTagAssignment.entity_name"},"entity_type":{"description":"The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes.","type":"string","x-databricks-field-behaviors":["REQUIRED","IMMUTABLE"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.EntityTagAssignment.entity_type"},"tag_key":{"description":"The key of the tag","type":"string","x-databricks-field-behaviors":["REQUIRED","IMMUTABLE"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.EntityTagAssignment.tag_key"},"tag_value":{"description":"The value of the tag","type":"string","x-databricks-field-behaviors":["OPTIONAL"],"x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.EntityTagAssignment.tag_value"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"EntityTagAssignment","x-databricks-legacy-name":"EntityTagAssignment","x-databricks-stable-name":"EntityTagAssignment"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_unity_catalog_entity_tag_assignments_by_entity_type_by_entity_name_tags_by_tag_key","parameters":{"entity_type":{"type":"string","description":"The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes."},"entity_name":{"type":"string","description":"The fully qualified name of the entity to which the tag is assigned"},"tag_key":{"type":"string","description":"Required. The key of the tag to delete"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_external_locations","parameters":{"include_browse":{"type":"boolean","description":"Whether to include external locations in the response for which the principal can only access selective metadata for"},"max_results":{"type":"integer","description":"Maximum number of external locations to return.\nIf not set, all the external locations are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;"},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_unity_catalog_external_locations","parameters":{"data":{"type":"object","required":["name","url","credential_name"],"properties":{"comment":{"description":"User-provided free-form text description.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.comment"},"credential_name":{"description":"Name of the storage credential used with this location.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.credential_name"},"enable_file_events":{"description":"Whether to enable file events on this external location.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.enable_file_events"},"encryption_details":{"$ref":"#/components/schemas/catalog.EncryptionDetails","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.encryption_details","x-databricks-sdk-name":"EncryptionDetails","x-databricks-legacy-name":"EncryptionDetails","x-databricks-stable-name":"EncryptionDetails"},"fallback":{"description":"Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.fallback"},"file_event_queue":{"description":"File event queue settings. If `enable_file_events` is `true`, must be defined and have exactly one of the documented properties.","$ref":"#/components/schemas/catalog.FileEventQueue","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.file_event_queue","x-databricks-sdk-name":"FileEventQueue","x-databricks-legacy-name":"FileEventQueue","x-databricks-stable-name":"FileEventQueue"},"name":{"description":"Name of the external location.","type":"string","x-databricks-api-version":"legacy","x-databricks-name":true,"x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.name"},"read_only":{"description":"Indicates whether the external location is read-only.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.read_only"},"skip_validation":{"description":"Skips validation of the storage credential associated with the external location.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.CreateExternalLocation.skip_validation"},"url":{"description":"Path URL of the external location.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.url"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateExternalLocation","x-databricks-legacy-name":"CreateExternalLocation","x-databricks-stable-name":"CreateExternalLocation"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_external_locations_by_name","parameters":{"name":{"type":"string","description":"Name of the external location."},"include_browse":{"type":"boolean","description":"Whether to include external locations in the response for which the principal can only access selective metadata for"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_1_unity_catalog_external_locations_by_name","parameters":{"name":{"type":"string","description":"Name of the external location."},"data":{"type":"object","properties":{"comment":{"description":"User-provided free-form text description.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.comment"},"credential_name":{"description":"Name of the storage credential used with this location.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.credential_name"},"enable_file_events":{"description":"Whether to enable file events on this external location.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.enable_file_events"},"encryption_details":{"$ref":"#/components/schemas/catalog.EncryptionDetails","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.encryption_details","x-databricks-sdk-name":"EncryptionDetails","x-databricks-legacy-name":"EncryptionDetails","x-databricks-stable-name":"EncryptionDetails"},"fallback":{"description":"Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.fallback"},"file_event_queue":{"description":"File event queue settings. If `enable_file_events` is `true`, must be defined and have exactly one of the documented properties.","$ref":"#/components/schemas/catalog.FileEventQueue","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.file_event_queue","x-databricks-sdk-name":"FileEventQueue","x-databricks-legacy-name":"FileEventQueue","x-databricks-stable-name":"FileEventQueue"},"force":{"description":"Force update even if changing url invalidates dependent external tables or mounts.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateExternalLocation.force"},"isolation_mode":{"$ref":"#/components/schemas/catalog.IsolationMode","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.isolation_mode","x-databricks-sdk-name":"IsolationMode","x-databricks-legacy-name":"IsolationMode","x-databricks-stable-name":"IsolationMode"},"new_name":{"description":"New name for the external location.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateExternalLocation.new_name"},"owner":{"description":"The owner of the external location.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.owner"},"read_only":{"description":"Indicates whether the external location is read-only.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.read_only"},"skip_validation":{"description":"Skips validation of the storage credential associated with the external location.","type":"boolean","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateExternalLocation.skip_validation"},"url":{"description":"Path URL of the external location.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.ExternalLocationInfo.url"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateExternalLocation","x-databricks-legacy-name":"UpdateExternalLocation","x-databricks-stable-name":"UpdateExternalLocation"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_unity_catalog_external_locations_by_name","parameters":{"name":{"type":"string","description":"Name of the external location."},"force":{"type":"boolean","description":"Force deletion even if there are dependent external tables or mounts."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_functions","parameters":{"catalog_name":{"type":"string","description":"Name of parent catalog for functions of interest."},"schema_name":{"type":"string","description":"Parent schema of functions."},"max_results":{"type":"integer","description":"Maximum number of functions to return.\nIf not set, all the functions are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;\n"},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query.\n"},"include_browse":{"type":"boolean","description":"Whether to include functions in the response for which the principal can only access selective metadata for"}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_unity_catalog_functions","parameters":{"data":{"type":"object","required":["function_info"],"properties":{"function_info":{"description":"Partial __FunctionInfo__ specifying the function to be created.","$ref":"#/components/schemas/catalog.CreateFunction","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateFunction","x-databricks-legacy-name":"CreateFunction","x-databricks-stable-name":"CreateFunction"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"CreateFunctionRequest","x-databricks-legacy-name":"CreateFunctionRequest","x-databricks-stable-name":"CreateFunctionRequest"}}},{"connectionName":"databricks-workspace","actionName":"parameters_api_2_1_unity_catalog_functions_by_name","parameters":{"name":{"type":"string"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_functions_by_name","parameters":{"name":{"type":"string"},"include_browse":{"type":"boolean","description":"Whether to include functions in the response for which the principal can only access selective metadata for"}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_1_unity_catalog_functions_by_name","parameters":{"name":{"type":"string"},"data":{"type":"object","properties":{"owner":{"description":"Username of current owner of function.","type":"string","x-databricks-api-version":"legacy"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-sdk-name":"UpdateFunction","x-databricks-legacy-name":"UpdateFunction","x-databricks-stable-name":"UpdateFunction"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_unity_catalog_functions_by_name","parameters":{"name":{"type":"string"},"force":{"type":"boolean","description":"Force deletion even if the function is notempty."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_metastore_summary","parameters":{}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_metastores","parameters":{"max_results":{"type":"integer","description":"Maximum number of metastores to return.\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the metastores are returned (not recommended).\n- Note: The number of returned metastores might be less than the specified max_results size, even zero.\nThe only definitive indication that no further metastores can be fetched is when the next_page_token is unset from the response."},"page_token":{"type":"string","description":"Opaque pagination token to go to next page based on previous query."}}},{"connectionName":"databricks-workspace","actionName":"post_api_2_1_unity_catalog_metastores","parameters":{"data":{"type":"object","required":["name"],"properties":{"name":{"description":"The user-specified name of the metastore.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.MetastoreInfo.name"},"region":{"description":"Cloud region which the metastore serves (e.g., `us-west-2`, `westus`).","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.MetastoreInfo.region"},"storage_root":{"description":"The storage root URL for metastore","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.MetastoreInfo.storage_root"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"CreateMetastore","x-databricks-legacy-name":"CreateMetastore","x-databricks-stable-name":"CreateMetastore"}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_metastores_by_id","parameters":{"id":{"type":"string","description":"Unique ID of the metastore."}}},{"connectionName":"databricks-workspace","actionName":"patch_api_2_1_unity_catalog_metastores_by_id","parameters":{"id":{"type":"string","description":"Unique ID of the metastore."},"data":{"type":"object","properties":{"delta_sharing_organization_name":{"description":"The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.MetastoreInfo.delta_sharing_organization_name"},"delta_sharing_recipient_token_lifetime_in_seconds":{"description":"The lifetime of delta sharing recipient token in seconds.","type":"integer","format":"int64","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.MetastoreInfo.delta_sharing_recipient_token_lifetime_in_seconds"},"delta_sharing_scope":{"description":"The scope of Delta Sharing enabled for the metastore.","$ref":"#/components/schemas/catalog.DeltaSharingScopeEnum","x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.MetastoreInfo.delta_sharing_scope","x-databricks-sdk-name":"DeltaSharingScopeEnum","x-databricks-legacy-name":"DeltaSharingScopeEnum","x-databricks-stable-name":"DeltaSharingScopeEnum"},"new_name":{"description":"New name for the metastore.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.UpdateMetastore.new_name"},"owner":{"description":"The owner of the metastore.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.MetastoreInfo.owner"},"privilege_model_version":{"description":"Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.MetastoreInfo.privilege_model_version"},"storage_root_credential_id":{"description":"UUID of storage credential to access the metastore storage_root.","type":"string","x-databricks-api-version":"legacy","x-databricks-schema-id":"managedcatalog.MetastoreInfo.storage_root_credential_id"}},"x-databricks-package-name":"catalog","x-databricks-api-version":"legacy","x-databricks-generated":true,"x-databricks-sdk-name":"UpdateMetastore","x-databricks-legacy-name":"UpdateMetastore","x-databricks-stable-name":"UpdateMetastore"}}},{"connectionName":"databricks-workspace","actionName":"delete_api_2_1_unity_catalog_metastores_by_id","parameters":{"id":{"type":"string","description":"Unique ID of the metastore."},"force":{"type":"boolean","description":"Force deletion even if the metastore is not empty. Default is false."}}},{"connectionName":"databricks-workspace","actionName":"get_api_2_1_unity_catalog_metastores_by_metastore_id_systemschemas","parameters":{"metastore_id":{"type":"string","description":"The ID for the metastore in which the system schema resides."},"max_results":{"type":"integer","description":"Maximum number of schemas to return.\n- When set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- Whe

Our Integrations