DocumentaciónExperience PlatformGuía de conectores de origen

Configuración de la especificación de origen para orígenes de autoservicio (SDK por lotes)

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Temas:

Creado para:

  • Desarrollador

Las especificaciones de Source contienen información específica de un origen, incluidos los atributos pertenecientes a la categoría de un origen, el estado beta y el icono de catálogo. También contienen información útil, como parámetros de URL, contenido, encabezado y programación. Las especificaciones de Source también describen el esquema de los parámetros necesarios para crear una conexión de origen a partir de una conexión base. El esquema es necesario para crear una conexión de origen.

Consulte el apéndice para ver un ejemplo de una especificación de origen completamente completada.

"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"
      ]
    }
  },
}
Propiedad
Descripción
Ejemplo
sourceSpec.attributes
Contiene información sobre el origen específico de la interfaz de usuario o la API de.
sourceSpec.attributes.uiAttributes
Muestra información sobre el origen específico de la interfaz de usuario.
sourceSpec.attributes.uiAttributes.isBeta
Un atributo booleano que indica si el origen requiere más comentarios de los clientes para agregar a su funcionalidad.
  • true
  • false
sourceSpec.attributes.uiAttributes.category
Define la categoría del origen.
  • advertising
  • crm
  • customer success
  • database
  • ecommerce
  • marketing automation
  • payments
  • protocols
sourceSpec.attributes.uiAttributes.icon
Define el icono utilizado para la renderización del origen en la interfaz de usuario de Platform.
mailchimp-icon.svg
sourceSpec.attributes.uiAttributes.description
Muestra una breve descripción del origen.
sourceSpec.attributes.uiAttributes.label
Muestra la etiqueta que se utilizará para la renderización del origen en la interfaz de usuario de Platform.
sourceSpec.attributes.spec.properties.urlParams
Contiene información sobre la ruta de acceso del recurso de URL, el método y los parámetros de consulta admitidos.
sourceSpec.attributes.spec.properties.urlParams.properties.path
Define la ruta del recurso desde la que se recuperan los datos.
/3.0/reports/${campaignId}/email-activity
sourceSpec.attributes.spec.properties.urlParams.properties.method
Define el método HTTP que se utilizará para realizar la solicitud al recurso para recuperar los datos.
GET, POST
sourceSpec.attributes.spec.properties.urlParams.properties.queryParams
Define los parámetros de consulta admitidos que se pueden utilizar para anexar la dirección URL de origen al realizar una solicitud de obtención de datos. Nota: cualquier valor de parámetro proporcionado por el usuario debe tener el formato de marcador de posición. Por ejemplo: ${USER_PARAMETER}.
"queryParams" : {"key" : "value", "key1" : "value1"} se anexará a la dirección URL de origen como: /?key=value&key1=value1
sourceSpec.attributes.spec.properties.spec.properties.headerParams
Define los encabezados que deben proporcionarse en la solicitud HTTP a la URL de origen al recuperar los datos.
"headerParams" : {"Content-Type" : "application/json", "x-api-key" : "key"}
sourceSpec.attributes.spec.properties.bodyParams
Este atributo se puede configurar para enviar el cuerpo HTTP a través de una solicitud del POST.
sourceSpec.attributes.spec.properties.contentPath
Define el nodo que contiene la lista de elementos que se deben introducir en Platform. Este atributo debe seguir una sintaxis de ruta JSON válida y señalar a una matriz en particular.
Vea la sección recursos adicionales para ver un ejemplo del recurso contenido en una ruta de contenido.
sourceSpec.attributes.spec.properties.contentPath.path
La ruta que señala a los registros de colección que se van a ingerir en Platform.
$.emails
sourceSpec.attributes.spec.properties.contentPath.skipAttributes
Esta propiedad le permite identificar elementos específicos del recurso identificado en la ruta de contenido que se excluirán de la ingesta.
[total_items]
sourceSpec.attributes.spec.properties.contentPath.keepAttributes
Esta propiedad permite especificar explícitamente los atributos individuales que desea conservar.
[total_items]
sourceSpec.attributes.spec.properties.contentPath.overrideWrapperAttribute
Esta propiedad le permite anular el valor del nombre de atributo especificado en contentPath.
email
sourceSpec.attributes.spec.properties.explodeEntityPath
Esta propiedad permite acoplar dos matrices y transformar los datos de recursos en un recurso de plataforma.
sourceSpec.attributes.spec.properties.explodeEntityPath.path
Ruta de acceso que señala a los registros de colección que desea acoplar.
$.email.activity
sourceSpec.attributes.spec.properties.explodeEntityPath.skipAttributes
Esta propiedad permite identificar elementos específicos del recurso identificado en la ruta de entidad que se excluirán de la ingesta.
[total_items]
sourceSpec.attributes.spec.properties.explodeEntityPath.keepAttributes
Esta propiedad permite especificar explícitamente los atributos individuales que desea conservar.
[total_items]
sourceSpec.attributes.spec.properties.explodeEntityPath.overrideWrapperAttribute
Esta propiedad le permite anular el valor del nombre de atributo especificado en explodeEntityPath.
activity
sourceSpec.attributes.spec.properties.paginationParams
Define los parámetros o campos que se deben proporcionar para obtener un vínculo a la página siguiente desde la respuesta de página actual del usuario o durante la creación de una dirección URL de página siguiente.
sourceSpec.attributes.spec.properties.paginationParams.type
Muestra el tipo de paginación compatible con el origen.
  • OFFSET: este tipo de paginación le permite analizar los resultados especificando un índice desde el que iniciar la matriz resultante y un límite en la cantidad de resultados devueltos.
  • POINTER: este tipo de paginación le permite usar una variable pointer para señalar a un elemento en particular que debe enviarse con una solicitud. La paginación de tipo de puntero requiere una ruta en la carga útil que dirija a la página siguiente.
  • CONTINUATION_TOKEN: este tipo de paginación le permite anexar los parámetros de consulta o encabezado con un token de continuación para recuperar los datos de retorno restantes del origen que no se devolvieron inicialmente debido a un máximo predeterminado.
  • PAGE: este tipo de paginación le permite anexar el parámetro de consulta con un parámetro de paginación para recorrer los datos devueltos por páginas, empezando desde la página cero.
  • NONE: este tipo de paginación se puede usar para orígenes que no admiten ninguno de los tipos de paginación disponibles. El tipo de paginación NONE devuelve todos los datos de respuesta después de una solicitud.
sourceSpec.attributes.spec.properties.paginationParams.limitName
Nombre del límite a través del cual la API puede especificar el número de registros que se recuperarán en una página.
limit o count
sourceSpec.attributes.spec.properties.paginationParams.limitValue
El número de registros que se recuperarán en una página.
limit=10 o count=10
sourceSpec.attributes.spec.properties.paginationParams.offSetName
Nombre del atributo de desplazamiento. Esto es necesario si el tipo de paginación está establecido en offset.
offset
sourceSpec.attributes.spec.properties.paginationParams.pointerPath
Nombre del atributo de puntero. Esto requiere una ruta json al atributo que señalará a la página siguiente. Esto es necesario si el tipo de paginación está establecido en pointer.
pointer
sourceSpec.attributes.spec.properties.scheduleParams
Contiene parámetros que definen los formatos de programación admitidos para el origen. Los parámetros de programación incluyen startTime y endTime, lo que le permite establecer intervalos de tiempo específicos para ejecuciones por lotes, lo que garantiza que no se recuperen los registros recuperados en una ejecución por lotes anterior.
sourceSpec.attributes.spec.properties.scheduleParams.scheduleStartParamName
Define el nombre del parámetro de hora de inicio
since_last_changed
sourceSpec.attributes.spec.properties.scheduleParams.scheduleEndParamName
Define el nombre del parámetro de hora de finalización
before_last_changed
sourceSpec.attributes.spec.properties.scheduleParams.scheduleStartParamFormat
Define el formato admitido para scheduleStartParamName.
yyyy-MM-ddTHH:mm:ssZ
sourceSpec.attributes.spec.properties.scheduleParams.scheduleEndParamFormat
Define el formato admitido para scheduleEndParamName.
yyyy-MM-ddTHH:mm:ssZ
sourceSpec.spec.properties
Define los parámetros proporcionados por el usuario para recuperar los valores de los recursos.
Consulte los recursos adicionales para ver un ejemplo de parámetros introducidos por el usuario para spec.properties.

Recursos adicionales appendix

En las secciones siguientes se proporciona información sobre configuraciones adicionales que puede realizar en sourceSpec, incluida la programación avanzada y los esquemas personalizados.

Ejemplo de ruta de contenido content-path

A continuación se muestra un ejemplo del contenido de la propiedad contentPath en una especificación de conexión MailChimp Members.

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

Ejemplo de entrada de usuario spec.properties user-input

El siguiente es un ejemplo de un(a) spec.properties proporcionado(a) por el usuario que usa una especificación de conexión MailChimp Members.

En este ejemplo, listId se proporciona como parte de urlParams.path. Si necesita recuperar listId de un cliente, también debe definirlo 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."
        }
      }
    }

Ejemplo de especificación de Source source-spec

La siguiente es una especificación de origen completada 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 diferentes tipos de paginación para el origen pagination

A continuación se muestran ejemplos de otros tipos de paginación admitidos por las fuentes de autoservicio (SDK por lotes):

Desplazamiento

Este tipo de paginación le permite analizar los resultados especificando un índice desde el que iniciar la matriz resultante y un límite en la cantidad de resultados devueltos. Por ejemplo:

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
Propiedad Descripción
type El tipo de paginación utilizado para devolver datos.
limitName Nombre del límite a través del cual la API puede especificar el número de registros que se recuperarán en una página.
limitValue El número de registros que se recuperarán en una página.
offSetName Nombre del atributo de desplazamiento. Esto es necesario si el tipo de paginación está establecido en offset.
endConditionName Un valor definido por el usuario que indica la condición que pondrá fin al bucle de paginación en la siguiente solicitud HTTP. Debe proporcionar el nombre del atributo en el que desea colocar la condición final.
endConditionValue El valor del atributo en el que desea colocar la condición final.
Puntero

Este tipo de paginación le permite usar una variable pointer para señalar a un elemento en particular que debe enviarse con una solicitud. La paginación de tipo de puntero requiere una ruta en la carga útil que dirija a la página siguiente. Por ejemplo:

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
Propiedad Descripción
type El tipo de paginación utilizado para devolver datos.
limitName Nombre del límite a través del cual la API puede especificar el número de registros que se recuperarán en una página.
limitValue El número de registros que se recuperarán en una página.
pointerPath Nombre del atributo de puntero. Esto requiere una ruta json al atributo que señalará a la página siguiente.
Token de continuación

Un tipo de token de continuación de paginación devuelve un token de cadena que indica la existencia de más elementos que no se pudieron devolver, debido a un número máximo predeterminado de elementos que se pueden devolver en una sola respuesta.

Un origen que admite el tipo de token de continuación de paginación puede tener un parámetro de paginación similar al siguiente:

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
Propiedad Descripción
type El tipo de paginación utilizado para devolver datos.
continuationTokenPath El valor que debe añadirse a los parámetros de consulta para pasar a la siguiente página de los resultados devueltos.
parameterType La propiedad parameterType define dónde se debe agregar parameterName. El tipo QUERYPARAM le permite anexar su consulta con parameterName. El HEADERPARAM le permite agregar su parameterName a su solicitud de encabezado.
parameterName Nombre del parámetro utilizado para incorporar el token de continuación. El formato es el siguiente: {PARAMETER_NAME}={CONTINUATION_TOKEN}.
delayRequestMillis La propiedad delayRequestMillis de la paginación le permite controlar la velocidad de las solicitudes realizadas al origen. Algunas fuentes pueden tener un límite en la cantidad de solicitudes que se pueden realizar por minuto. Por ejemplo, Zendesk tiene un límite de 100 solicitudes por minuto y definir delayRequestMillis a 850 le permite configurar el origen para realizar llamadas a solo alrededor de 80 solicitudes por minuto, muy por debajo del umbral de 100 solicitudes por minuto.

El siguiente es un ejemplo de una respuesta devuelta mediante el tipo de token de continuación de paginación:

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

El tipo de paginación PAGE le permite recorrer los datos devueltos según el número de páginas a partir de cero. Al utilizar paginación de tipo PAGE, debe proporcionar el número de registros dados en una sola 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
Propiedad Descripción
type El tipo de paginación utilizado para devolver datos.
limitName Nombre del límite a través del cual la API puede especificar el número de registros que se recuperarán en una página.
limitValue El número de registros que se recuperarán en una página.
initialPageIndex (Opcional) El índice de página inicial define el número de página desde el que se iniciará la paginación. Este campo se puede utilizar para orígenes en los que la paginación no comienza desde 0. Si no se proporciona, el índice de página inicial se establecerá de forma predeterminada en 0. Este campo espera un entero.
endPageIndex (Opcional) El índice de página final permite establecer una condición final y detener la paginación. Este campo se puede utilizar cuando las condiciones de finalización predeterminadas para detener la paginación no están disponibles. Este campo también se puede utilizar si el número de páginas que se van a introducir o el último número de página se proporcionan a través del encabezado de respuesta, que es común al utilizar paginación de tipo PAGE. El valor del índice de página final puede ser el último número de página o un valor de expresión de tipo cadena del encabezado de respuesta. Por ejemplo, puede usar headers.x-pagecount para asignar un índice de página final al valor x-pagecount de los encabezados de respuesta. Nota: x-pagecount es un encabezado de respuesta obligatorio para algunos orígenes y contiene el valor número de páginas que se van a ingerir.
pageParamName Nombre del parámetro que debe anexar a los parámetros de consulta para recorrer diferentes páginas de los datos devueltos. Por ejemplo, https://abc.com?pageIndex=1 devolvería la segunda página de la carga útil devuelta de una API.
maximumRequest Número máximo de solicitudes que un origen puede realizar para una ejecución incremental determinada. El límite predeterminado actual es 10000.
Ninguno

El tipo de paginación NONE se puede usar para orígenes que no admiten ninguno de los tipos de paginación disponibles. Las fuentes que utilizan el tipo de paginación de NONE simplemente devuelven todos los registros recuperables cuando se realiza una solicitud de GET.

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

Programación avanzada de orígenes de autoservicio (SDK por lotes)

Configure la programación incremental y de relleno del origen mediante la programación avanzada. La propiedad incremental le permite configurar una programación en la que su origen solo ingestará registros nuevos o modificados, mientras que la propiedad backfill le permite crear una programación para ingerir datos históricos.

Con la programación avanzada, puede utilizar expresiones y funciones específicas del origen para configurar programaciones incrementales y de relleno. En el ejemplo siguiente, el origen Zendesk requiere que la programación incremental tenga el formato type:user updated > {START_TIME} updated < {END_TIME} y el relleno sea 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}"
      }
Propiedad
Descripción
scheduleParams.type
El tipo de programación que utilizará el origen. Establezca este valor en ADVANCE para utilizar el tipo de programación avanzado.
scheduleParams.paramFormat
El formato definido del parámetro de programación. Este valor puede ser el mismo que los valores scheduleStartParamFormat y scheduleEndParamFormat del origen.
scheduleParams.incremental
La consulta incremental del origen. Incremental hace referencia a un método de ingesta en el que solo se incorporan datos nuevos o modificados.
scheduleParams.backfill
La consulta de relleno del origen. El relleno se refiere a un método de ingesta en el que se ingieren datos históricos.

Una vez configurada la programación avanzada, debe hacer referencia a scheduleParams en la sección URL, cuerpo o parámetros de encabezado, según lo que admita el origen en particular. En el ejemplo siguiente, {SCHEDULE_QUERY} es un marcador de posición utilizado para especificar dónde se utilizarán las expresiones de programación incremental y de relleno. En el caso de un origen Zendesk, query se usa en queryParams para especificar la programación avanzada.

"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"
        }
      }

Añada un esquema personalizado para definir los atributos dinámicos del origen

Puede incluir un esquema personalizado en sourceSpec para definir todos los atributos necesarios para el origen, incluidos los atributos dinámicos que pueda necesitar. Puede actualizar la especificación de conexión correspondiente del origen realizando una solicitud del PUT al extremo /connectionSpecs de la API Flow Service, al tiempo que proporciona el esquema personalizado en la sección sourceSpec de la especificación de conexión.

A continuación se muestra un ejemplo de esquema personalizado que puede agregar a la especificación de conexión del origen:

      "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"
                  }
                }
              }
            }
          }
        }
      }

Pasos siguientes

Una vez rellenadas las especificaciones de origen, puede continuar con la configuración de las especificaciones de exploración del origen que desea integrar en Platform. Consulte el documento sobre configuración de las especificaciones de exploración para obtener más información.

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