DocumentaçãoExperience PlatformGuia dos conectores de origem

Configurar especificação de origem para Origens de Autoatendimento (SDK em Lote)

Last update: Tue Oct 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Developer

As especificações de origem contêm informações específicas de uma origem, incluindo atributos pertencentes à categoria de uma origem, status beta e ícone de catálogo. Eles também contêm informações úteis, como parâmetros de URL, conteúdo, cabeçalho e agendamento. As especificações de origem também descrevem o esquema dos parâmetros necessários para criar uma conexão de origem a partir de uma conexão de base. O esquema é necessário para criar uma conexão de origem.

Consulte a apêndice para obter um exemplo de uma especificação de origem totalmente preenchida.

"sourceSpec": {
  "attributes": {
    "uiAttributes": {
      "isSource": true,
      "isPreview": true,
      "isBeta": true,
      "category": {
        "key": "protocols"
      },
      "icon": {
        "key": "genericRestIcon"
      },
      "description": {
        "key": "genericRestDescription"
      },
      "label": {
        "key": "genericRestLabel"
      }
    },
    "spec": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "type": "object",
      "description": "Defines static and user input parameters to fetch resource values.",
      "properties": {
        "urlParams": {
          "type": "object",
          "properties": {
            "host": {
              "type": "string",
              "description": "Enter resource url host path.",
              "example": "https://{domain}.api.mailchimp.com"
            },
            "path": {
              "type": "string",
              "description": "Enter resource path",
              "example": "/3.0/reports/campaignId/email-activity"
            },
            "method": {
              "type": "string",
              "description": "HTTP method type.",
              "enum": [
                "GET",
                "POST"
              ]
            },
            "queryParams": {
              "type": "object",
              "description": "The query parameters in json format",
            }
          },
          "required": [
            "host",
            "path",
            "method"
          ]
        },
        "headerParams": {
          "type": "object",
          "description": "The header parameters in json format",
        },
        "contentPath": {
          "type": "object",
          "description": "The parameters required for main collection content.",
          "properties": {
            "path": {
              "description": "The path to the main content.",
              "type": "string",
              "example": "$.emails"
            },
            "skipAttributes": {
              "type": "array",
              "description": "The list of attributes that needs to be skipped while fattening the array.",
              "example": "[total_items]",
              "items": {
                "type": "string"
              }
            },
            "keepAttributes": {
              "type": "array",
              "description": "The list of attributes that needs to be kept while fattening the array.",
              "example": "[total_items]",
              "items": {
                "type": "string"
              }
            },
            "overrideWrapperAttribute": {
              "type": "string",
              "description": "The new name to be used for the root content path node.",
              "example": "email"
            }
          },
          "required": [
            "path"
          ]
        },
        "explodeEntityPath": {
          "type": "object",
          "description": "The parameters required for the sub-array content.",
          "properties": {
            "path": {
              "description": "The path to the sub-array content.",
              "type": "string",
              "example": "$.email.activity"
            },
            "skipAttributes": {
              "type": "array",
              "description": "The list of attributes that needs to be skipped while fattening sub-array.",
              "example": "[total_items]",
              "items": {
                "type": "string"
              }
            },
            "keepAttributes": {
              "type": "array",
              "description": "The list of attributes that needs to be kept while fattening the sub-array.",
              "example": "[total_items]",
              "items": {
                "type": "string"
              }
            },
            "overrideWrapperAttribute": {
              "type": "string",
              "description": "The new name to be used for the  root content path node.",
              "example": "activity"
            }
          },
          "required": [
            "path"
          ]
        },
        "paginationParams": {
          "type": "object",
          "description": "The parameters required to fetch data using pagination.",
          "properties": {
            "type": {
              "description": "The pagination fetch type.",
              "type": "string",
              "enum": [
                "OFFSET",
                "POINTER"
              ]
            },
            "limitName": {
              "type": "string",
              "description": "The limit property name",
              "example": "limit or count"
            },
            "limitValue": {
              "type": "integer",
              "description": "The number of records to fetch per page.",
              "example": "limit=10 or count=10"
            },
            "offsetName": {
              "type": "string",
              "description": "The offset property name",
              "example": "offset"
            },
            "pointerPath": {
              "type": "string",
              "description": "The path to pointer property",
              "example": "$.paging.next"
            }
          },
          "required": [
            "type",
            "limitName",
            "limitValue"
          ]
        },
        "scheduleParams": {
          "type": "object",
          "description": "The parameters required to fetch data for batch schedule.",
          "properties": {
            "scheduleStartParamName": {
              "type": "string",
              "description": "The order property name to get the order by date."
            },
            "scheduleEndParamName": {
              "type": "string",
              "description": "The order property name to get the order by date."
            },
            "scheduleStartParamFormat": {
              "type": "string",
              "description": "The order property name to get the order by date.",
              "example": "yyyy-MM-ddTHH:mm:ssZ"
            },
            "scheduleEndParamFormat": {
              "type": "string",
              "description": "The order property name to get the order by date.",
              "example": "yyyy-MM-ddTHH:mm:ssZ"
            }
          },
          "required": [
            "scheduleStartParamName",
            "scheduleEndParamName"
          ]
        }
      },
      "required": [
        "urlParams",
        "contentPath",
        "paginationParams",
        "scheduleParams"
      ]
    }
  },
}
Propriedade
Descrição
Exemplo
sourceSpec.attributes
Contém informações sobre a fonte específica da interface do usuário ou da API.
sourceSpec.attributes.uiAttributes
Exibe informações sobre a origem específica da interface do usuário.
sourceSpec.attributes.uiAttributes.isBeta
Um atributo booleano que indica se a fonte requer mais feedback dos clientes para ser adicionada à funcionalidade.
  • true
  • false
sourceSpec.attributes.uiAttributes.category
Define a categoria da origem.
  • advertising
  • crm
  • customer success
  • database
  • ecommerce
  • marketing automation
  • payments
  • protocols
sourceSpec.attributes.uiAttributes.icon
Define o ícone usado para a renderização da origem na interface do usuário da Platform.
mailchimp-icon.svg
sourceSpec.attributes.uiAttributes.description
Exibe uma breve descrição da origem.
sourceSpec.attributes.uiAttributes.label
Exibe o rótulo a ser usado para a renderização da origem na interface do usuário da Platform.
sourceSpec.attributes.spec.properties.urlParams
Contém informações sobre o caminho de recurso do URL, o método e os parâmetros de consulta compatíveis.
sourceSpec.attributes.spec.properties.urlParams.properties.path
Define o caminho do recurso do qual buscar os dados.
/3.0/reports/${campaignId}/email-activity
sourceSpec.attributes.spec.properties.urlParams.properties.method
Define o método HTTP a ser usado para fazer a solicitação ao recurso para buscar dados.
GET, POST
sourceSpec.attributes.spec.properties.urlParams.properties.queryParams
Define os parâmetros de consulta compatíveis que podem ser usados para anexar o URL de origem ao fazer uma solicitação para buscar dados. Nota: qualquer valor de parâmetro fornecido pelo usuário deve ser formatado como um espaço reservado. Por exemplo: ${USER_PARAMETER}.
"queryParams" : {"key" : "value", "key1" : "value1"} serão anexados ao URL de origem como: /?key=value&key1=value1
sourceSpec.attributes.spec.properties.spec.properties.headerParams
Define cabeçalhos que precisam ser fornecidos na solicitação HTTP para o URL de origem ao buscar dados.
"headerParams" : {"Content-Type" : "application/json", "x-api-key" : "key"}
sourceSpec.attributes.spec.properties.bodyParams
Esse atributo pode ser configurado para enviar o corpo HTTP por meio de uma solicitação POST.
sourceSpec.attributes.spec.properties.contentPath
Define o nó que contém a lista de itens necessários para serem assimilados na Platform. Esse atributo deve seguir a sintaxe de caminho JSON válida e apontar para uma matriz específica.
Exibir o seção recursos adicionais para obter um exemplo do recurso contido em um caminho de conteúdo.
sourceSpec.attributes.spec.properties.contentPath.path
O caminho que aponta para os registros de coleção a serem assimilados na Platform.
$.emails
sourceSpec.attributes.spec.properties.contentPath.skipAttributes
Essa propriedade permite identificar itens específicos do recurso identificado no caminho do conteúdo que devem ser excluídos de serem assimilados.
[total_items]
sourceSpec.attributes.spec.properties.contentPath.keepAttributes
Essa propriedade permite especificar explicitamente os atributos individuais que você deseja manter.
[total_items]
sourceSpec.attributes.spec.properties.contentPath.overrideWrapperAttribute
Essa propriedade permite que você substitua o valor do nome do atributo especificado em contentPath.
email
sourceSpec.attributes.spec.properties.explodeEntityPath
Essa propriedade permite nivelar dois arrays e transformar dados de recursos em recursos da Platform.
sourceSpec.attributes.spec.properties.explodeEntityPath.path
O caminho que aponta para os registros de coleção que você deseja nivelar.
$.email.activity
sourceSpec.attributes.spec.properties.explodeEntityPath.skipAttributes
Essa propriedade permite identificar itens específicos do recurso identificado no caminho da entidade que devem ser excluídos da assimilação.
[total_items]
sourceSpec.attributes.spec.properties.explodeEntityPath.keepAttributes
Essa propriedade permite especificar explicitamente os atributos individuais que você deseja manter.
[total_items]
sourceSpec.attributes.spec.properties.explodeEntityPath.overrideWrapperAttribute
Essa propriedade permite que você substitua o valor do nome do atributo especificado em explodeEntityPath.
activity
sourceSpec.attributes.spec.properties.paginationParams
Define os parâmetros ou campos que devem ser fornecidos para obter um link para a próxima página da resposta da página atual do usuário ou ao criar um URL da próxima página.
sourceSpec.attributes.spec.properties.paginationParams.type
Exibe o tipo de paginação suportada para a sua origem.
  • OFFSET: esse tipo de paginação permite analisar os resultados especificando um índice de onde iniciar a matriz resultante e um limite na quantidade de resultados retornados.
  • POINTER: esse tipo de paginação permite usar um pointer para apontar para um item específico que precisa ser enviado com uma solicitação. A paginação de tipo de ponteiro requer um caminho na carga que aponte para a próxima página.
  • CONTINUATION_TOKEN: esse tipo de paginação permite anexar os parâmetros de consulta ou cabeçalho a um token de continuação para recuperar os dados de retorno restantes da origem, que não foram retornados inicialmente devido a um máximo predeterminado.
  • PAGE: esse tipo de paginação permite anexar seu parâmetro de consulta a um parâmetro de paginação para percorrer os dados de retorno por páginas, começando da página zero.
  • NONE: esse tipo de paginação pode ser usado para origens que não oferecem suporte a nenhum dos tipos de paginação disponíveis. Tipo de paginação NONE retorna todos os dados de resposta após uma solicitação.
sourceSpec.attributes.spec.properties.paginationParams.limitName
O nome do limite pelo qual a API pode especificar o número de registros a serem buscados em uma página.
limit ou count
sourceSpec.attributes.spec.properties.paginationParams.limitValue
O número de registros a serem buscados em uma página.
limit=10 ou count=10
sourceSpec.attributes.spec.properties.paginationParams.offSetName
O nome do atributo offset. Isso é necessário se o tipo de paginação estiver definido como offset.
offset
sourceSpec.attributes.spec.properties.paginationParams.pointerPath
O nome do atributo de ponteiro. Isso requer o caminho json para o atributo que apontará para a próxima página. Isso é necessário se o tipo de paginação estiver definido como pointer.
pointer
sourceSpec.attributes.spec.properties.scheduleParams
Contém parâmetros que definem formatos de agendamento compatíveis com a sua origem. Os parâmetros de agendamento incluem startTime e endTime, ambos permitem definir intervalos de tempo específicos para execuções de lote, o que garante que os registros buscados em uma execução de lote anterior não sejam buscados novamente.
sourceSpec.attributes.spec.properties.scheduleParams.scheduleStartParamName
Define o nome do parâmetro da hora inicial
since_last_changed
sourceSpec.attributes.spec.properties.scheduleParams.scheduleEndParamName
Define o nome do parâmetro da hora final
before_last_changed
sourceSpec.attributes.spec.properties.scheduleParams.scheduleStartParamFormat
Define o formato compatível com o scheduleStartParamName.
yyyy-MM-ddTHH:mm:ssZ
sourceSpec.attributes.spec.properties.scheduleParams.scheduleEndParamFormat
Define o formato compatível com o scheduleEndParamName.
yyyy-MM-ddTHH:mm:ssZ
sourceSpec.spec.properties
Define os parâmetros fornecidos pelo usuário para buscar valores do recurso.
Consulte a recursos adicionais por um exemplo de parâmetros inseridos pelo usuário para spec.properties.

Recursos adicionais appendix

As seções a seguir fornecem informações sobre as configurações adicionais que você pode fazer no sourceSpec, incluindo agendamento avançado e esquemas personalizados.

Exemplo de caminho de conteúdo content-path

Veja a seguir um exemplo do conteúdo de contentPath propriedade em um MailChimp Members especificação de conexão.

"contentPath": {
  "path": "$.members",
  "skipAttributes": [
    "_links",
    "total_items",
    "list_id"
  ],
  "overrideWrapperAttribute": "member"
}

spec.properties exemplo de entrada de usuário user-input

Veja a seguir um exemplo de uma configuração fornecida pelo usuário spec.properties usando um MailChimp Members especificação de conexão.

Neste exemplo, listId é fornecido como parte de urlParams.path. Se precisar recuperar listId de um cliente, você também deve defini-lo como parte de spec.properties.

"urlParams": {
        "path": "/3.0/lists/${listId}/members",
        "method": "GET"
      }
"spec": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "type": "object",
      "description": "Define user input parameters to fetch resource values.",
      "properties": {
        "listId": {
          "type": "string",
          "description": "listId for which members need to fetch."
        }
      }
    }

Exemplo de especificação de origem source-spec

Veja a seguir uma especificação de origem concluída usando MailChimp Members:

  "sourceSpec": {
    "attributes": {
      "uiAttributes": {
        "isSource": true,
        "isPreview": true,
        "isBeta": true,
        "category": {
          "key": "marketingAutomation"
        },
        "icon": {
          "key": "mailchimpMembersIcon"
        },
        "description": {
          "key": "mailchimpMembersDescription"
        },
        "label": {
          "key": "mailchimpMembersLabel"
        }
      },
      "urlParams": {
        "host": "https://{domain}.api.mailchimp.com",
        "path": "/3.0/lists/${listId}/members",
        "method": "GET"
      },
      "contentPath": {
        "path": "$.members",
        "skipAttributes": [
          "_links",
          "total_items",
          "list_id"
        ],
        "overrideWrapperAttribute": "member"
      },
      "paginationParams": {
        "type": "OFFSET",
        "limitName": "count",
        "limitValue": "100",
        "offSetName": "offset"
      },
      "scheduleParams": {
        "scheduleStartParamName": "since_last_changed",
        "scheduleEndParamName": "before_last_changed",
        "scheduleStartParamFormat": "yyyy-MM-ddTHH:mm:ss:fffffffK",
        "scheduleEndParamFormat": "yyyy-MM-ddTHH:mm:ss:fffffffK"
      }
    },
    "spec": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "type": "object",
      "description": "Define user input parameters to fetch resource values.",
      "properties": {
        "listId": {
          "type": "string",
          "description": "listId for which members need to fetch."
        }
      }
    }
  }

Configurar tipos de paginação diferentes para a origem pagination

A seguir estão exemplos de outros tipos de paginação compatíveis com Origens de Autoatendimento (SDK em lote):

Deslocamento

Esse tipo de paginação permite analisar os resultados especificando um índice de onde iniciar o array resultante e um limite para quantos resultados são retornados. Por exemplo:

code language-json 
"paginationParams": {
        "type": "OFFSET",
        "limitName": "limit",
        "limitValue": "4",
        "offSetName": "offset",
        "endConditionName": "$.hasMore",
        "endConditionValue": "Const:false"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
Propriedade Descrição
type O tipo de paginação usado para retornar dados.
limitName O nome do limite pelo qual a API pode especificar o número de registros a serem buscados em uma página.
limitValue O número de registros a serem buscados em uma página.
offSetName O nome do atributo offset. Isso é necessário se o tipo de paginação estiver definido como offset.
endConditionName Um valor definido pelo usuário que indica a condição que encerrará o loop de paginação na próxima solicitação HTTP. Você deve fornecer o nome do atributo no qual deseja colocar a condição final.
endConditionValue O valor do atributo no qual você deseja colocar a condição final.
Ponteiro

Esse tipo de paginação permite usar um pointer para apontar para um item específico que precisa ser enviado com uma solicitação. A paginação de tipo de ponteiro requer um caminho na carga que aponte para a próxima página. Por exemplo:

code language-json 
{
 "type": "POINTER",
 "limitName": "limit",
 "limitValue": 1,
 "pointerPath": "paging.next"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Propriedade Descrição
type O tipo de paginação usado para retornar dados.
limitName O nome do limite pelo qual a API pode especificar o número de registros a serem buscados em uma página.
limitValue O número de registros a serem buscados em uma página.
pointerPath O nome do atributo de ponteiro. Isso requer o caminho json para o atributo que apontará para a próxima página.
Token de continuação

Um tipo de token de continuação de paginação retorna um token de sequência de caracteres que significa a existência de mais itens que não puderam ser retornados, devido a um número máximo predeterminado de itens que podem ser retornados em uma única resposta.

Uma origem que oferece suporte ao tipo de paginação de token de continuação pode ter um parâmetro de paginação semelhante a:

code language-json 
"paginationParams": {
  "type": "CONTINUATION_TOKEN",
  "continuationTokenPath": "$.meta.after_cursor",
  "parameterType": "QUERYPARAM",
  "parameterName": "page[after]",
  "delayRequestMillis": "850"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Propriedade Descrição
type O tipo de paginação usado para retornar dados.
continuationTokenPath O valor que deve ser anexado aos parâmetros de consulta para passar para a próxima página dos resultados retornados.
parameterType A variável parameterType define onde a variável parameterName deve ser adicionado. A variável QUERYPARAM permite anexar sua consulta com a variável parameterName. A variável HEADERPARAM permite adicionar o parameterName à solicitação de cabeçalho.
parameterName O nome do parâmetro usado para incorporar o token de continuação. O formato é o seguinte: {PARAMETER_NAME}={CONTINUATION_TOKEN}.
delayRequestMillis A variável delayRequestMillis A propriedade na paginação permite controlar a taxa de solicitações feitas na origem. Algumas origens podem ter um limite para o número de solicitações que podem ser feitas por minuto. Por exemplo, Zendesk tem um limite de 100 solicitações por minuto e define delayRequestMillis para 850 O permite configurar a origem para fazer chamadas em apenas cerca de 80 solicitações por minuto, bem abaixo do limite de 100 solicitações por minuto.

Este é um exemplo de uma resposta retornada usando o tipo de token de continuação de paginação:

code language-json 
{
  "results": [
    {
      "id": 5624716025745,
      "url": "https://dev.zendesk.com/api/v2/users/5624716025745.json",
      "name": "newinctest@zenaep.com",
      "email": "newinctest@zenaep.com",
      "created_at": "2022-04-22T10:27:30Z",

    }
  ],
  "facets": null,
  "meta": {
    "has_more": false,
    "after_cursor": "eyJmaWVsZCI6ImNyZWF0ZWRfYXQiLCJk",
    "before_cursor": null
  },
  "links": {
    "prev": null,
    "next": "https://dev.zendesk.com/api/v2/search/export.json?filter%5Btype%5D=user&page%5Bafter%5D=eyJmaWVsZCI6"
  }
}
Página

A variável PAGE O tipo de paginação permite percorrer os dados de retorno pelo número de páginas começando de zero. Ao usar PAGE digite pagination, você deve fornecer o número de registros fornecidos em uma única página.

code language-json 
"paginationParams": {
  "type": "PAGE",
  "limitName": "pageSize",
  "limitValue": 100,
  "initialPageIndex": 1,
  "endPageIndex": "headers.x-pagecount",
  "pageParamName": "pageNumber",
  "maximumRequest": 10000
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 layout-auto
Propriedade Descrição
type O tipo de paginação usado para retornar dados.
limitName O nome do limite pelo qual a API pode especificar o número de registros a serem buscados em uma página.
limitValue O número de registros a serem buscados em uma página.
initialPageIndex (Opcional) O índice da página inicial define o número da página a partir da qual a paginação iniciará. Esse campo pode ser usado para fontes nas quais a paginação não começa em 0. Se não for fornecido, o índice da página inicial será padrão de 0. Este campo espera um número inteiro.
endPageIndex (Opcional) O índice da página final permite estabelecer uma condição final e parar a paginação. Esse campo pode ser usado quando as condições finais padrão para interromper a paginação não estiverem disponíveis. Esse campo também pode ser usado se o número de páginas que serão assimiladas ou o número da última página for fornecido por meio do cabeçalho de resposta, que é comum ao usar PAGE digite paginação. O valor do índice da página final pode ser o número da última página ou um valor de expressão do tipo string do cabeçalho de resposta. Por exemplo, você pode usar headers.x-pagecount para atribuir o índice da página final à variável x-pagecount valor dos cabeçalhos de resposta. Nota: x-pagecount é um cabeçalho de resposta obrigatório para algumas fontes e contém o número de valor das páginas que serão assimiladas.
pageParamName O nome do parâmetro que você deve anexar aos parâmetros de consulta para percorrer diferentes páginas dos dados de retorno. Por exemplo, https://abc.com?pageIndex=1 retornaria a segunda página de uma carga de retorno da API.
maximumRequest O número máximo de solicitações que uma origem pode fazer para uma determinada execução incremental. O limite padrão atual é 10000.
None

A variável NONE o tipo de paginação pode ser usado para origens que não oferecem suporte a nenhum dos tipos de paginação disponíveis. Fontes que usam o tipo de paginação de NONE basta retornar todos os registros recuperáveis quando uma solicitação GET for feita.

code language-json 
"paginationParams": {
  "type": "NONE"
}

Programação avançada para Fontes de autoatendimento (SDK em lote)

Configure a programação incremental e de preenchimento retroativo da origem usando a programação avançada. A variável incremental permite configurar um agendamento no qual sua origem assimilará somente registros novos ou modificados, enquanto a variável backfill permite criar um agendamento para assimilar dados históricos.

Com a programação avançada, você pode usar expressões e funções específicas da origem para configurar programações incrementais e de preenchimento retroativo. No exemplo abaixo, a variável Zendesk origem requer que o agendamento incremental seja formatado como type:user updated > {START_TIME} updated < {END_TIME} e preenchimento retroativo como type:user updated < {END_TIME}.

"scheduleParams": {
        "type": "ADVANCE",
        "paramFormat": "yyyy-MM-ddTHH:mm:ssK",
        "incremental": "type:user updated > {START_TIME} updated < {END_TIME}",
        "backfill": "type:user updated < {END_TIME}"
      }
Propriedade
Descrição
scheduleParams.type
O tipo de agendamento que sua origem usará. Defina esse valor como ADVANCE para usar o tipo de agendamento avançado.
scheduleParams.paramFormat
O formato definido do seu parâmetro de agendamento. Esse valor pode ser igual ao da fonte scheduleStartParamFormat e scheduleEndParamFormat valores.
scheduleParams.incremental
O query incremental da sua origem. Incremental refere-se a um método de assimilação em que somente dados novos ou modificados são assimilados.
scheduleParams.backfill
A consulta de preenchimento retroativo da origem. O preenchimento retroativo se refere a um método de assimilação no qual os dados históricos são assimilados.

Depois de configurar o agendamento avançado, consulte o scheduleParams na seção URL, corpo ou parâmetros de cabeçalho, dependendo do que sua fonte específica suporta. No exemplo abaixo, {SCHEDULE_QUERY} é um espaço reservado usado para especificar onde as expressões de agendamento de preenchimento retroativo e incremental serão usadas. No caso de um Zendesk origem, query é usado no queryParams para especificar o agendamento avançado.

"urlParams": {
        "path": "/api/v2/search/export@{if(empty(coalesce(pipeline()?.parameters?.ingestionStart,'')),'?query=type:user&filter[type]=user&','')}",
        "method": "GET",
        "queryParams": {
          "query": "{SCHEDULE_QUERY}",
          "filter[type]": "user"
        }
      }

Adicione um esquema personalizado para definir os atributos dinâmicos de sua fonte

Você pode incluir um esquema personalizado em seu sourceSpec para definir todos os atributos necessários para sua origem, incluindo todos os atributos dinâmicos que você possa precisar. Você pode atualizar a especificação de conexão correspondente da sua origem fazendo uma solicitação PUT para o /connectionSpecs endpoint do Flow Service API, além de fornecer o esquema personalizado no sourceSpec seção da sua especificação de conexão.

Este é um exemplo de um esquema personalizado que você pode adicionar à especificação de conexão da origem:

      "schema": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "organization_id": {
                  "type": "integer",
                  "minimum": -9007199254740992,
                  "maximum": 9007199254740991
                }
                "active": {
                  "type": "boolean"
                },
                "created_at": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "iana_time_zone": {
                  "type": "string"
                },
                "id": {
                  "type": "integer"
                },
                "locale": {
                  "type": "string"
                },
                "locale_id": {
                  "type": "integer"
                },
                "moderator": {
                  "type": "boolean"
                },
                "name": {
                  "type": "string"
                },
                "only_private_comments": {
                  "type": "boolean"
                },
                "report_csv": {
                  "type": "boolean"
                },
                "restricted_agent": {
                  "type": "boolean"
                },
                "result_type": {
                  "type": "string"
                },
                "role": {
                  "type": "integer"
                },
                "shared": {
                  "type": "boolean"
                },
                "shared_agent": {
                  "type": "boolean"
                },
                "suspended": {
                  "type": "boolean"
                },
                "ticket_restriction": {
                  "type": "string"
                },
                "time_zone": {
                  "type": "string"
                },
                "two_factor_auth_enabled": {
                  "type": "boolean"
                },
                "updated_at": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                },
                "verified": {
                  "type": "boolean"
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }

Próximas etapas

Com suas especificações de origem preenchidas, você pode continuar a configurar as especificações de exploração para a origem que deseja integrar à Platform. Consulte o documento sobre configuração das especificações de exploração para obter mais informações.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089