DokumentationExperience PlatformAnvändarhandbok om Source Connectors

Konfigurera källspecifikation för självbetjäningskällor (batch-SDK)

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

Skapat för:

  • Utvecklare

Source-specifikationerna innehåller information som är specifik för en källa, inklusive attribut som gäller en källas kategori, betastatus och katalogikon. De innehåller även användbar information som URL-parametrar, innehåll, rubrik och schema. Source-specifikationerna beskriver också schemat för de parametrar som krävs för att skapa en källanslutning från en basanslutning. Schemat är nödvändigt för att skapa en källanslutning.

I bilagan finns ett exempel på en fullständigt ifylld källspecifikation.

"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"
      ]
    }
  },
}
Egenskap
Beskrivning
Exempel
sourceSpec.attributes
Innehåller information om källan som är specifik för gränssnittet eller API:t.
sourceSpec.attributes.uiAttributes
Visar information om källan som är specifik för användargränssnittet.
sourceSpec.attributes.uiAttributes.isBeta
Ett booleskt attribut som anger om källan kräver mer feedback från kunderna för att lägga till dess funktioner.
  • true
  • false
sourceSpec.attributes.uiAttributes.category
Definierar källans kategori.
  • advertising
  • crm
  • customer success
  • database
  • ecommerce
  • marketing automation
  • payments
  • protocols
sourceSpec.attributes.uiAttributes.icon
Definierar ikonen som används för återgivning av källan i plattformsgränssnittet.
mailchimp-icon.svg
sourceSpec.attributes.uiAttributes.description
Visar en kort beskrivning av källan.
sourceSpec.attributes.uiAttributes.label
Visar den etikett som ska användas för återgivning av källan i plattformsgränssnittet.
sourceSpec.attributes.spec.properties.urlParams
Innehåller information om URL-resursens sökväg, metod och vilka frågeparametrar som stöds.
sourceSpec.attributes.spec.properties.urlParams.properties.path
Definierar resurssökvägen varifrån data ska hämtas.
/3.0/reports/${campaignId}/email-activity
sourceSpec.attributes.spec.properties.urlParams.properties.method
Definierar den HTTP-metod som ska användas för att göra en begäran till resursen om att hämta data.
GET, POST
sourceSpec.attributes.spec.properties.urlParams.properties.queryParams
Definierar de frågeparametrar som stöds och som kan användas för att lägga till käll-URL:en när data hämtas. Obs! Alla användartillhandahållna parametervärden måste formateras som en platshållare. Till exempel: ${USER_PARAMETER}.
"queryParams" : {"key" : "value", "key1" : "value1"} läggs till i käll-URL:en som: /?key=value&key1=value1
sourceSpec.attributes.spec.properties.spec.properties.headerParams
Definierar rubriker som måste anges i HTTP-begäran till käll-URL:en när data hämtas.
"headerParams" : {"Content-Type" : "application/json", "x-api-key" : "key"}
sourceSpec.attributes.spec.properties.bodyParams
Det här attributet kan konfigureras för att skicka HTTP-brödtext via en POST-begäran.
sourceSpec.attributes.spec.properties.contentPath
Definierar noden som innehåller listan med objekt som krävs för att kopplas till plattformen. Attributet ska följa giltig JSON-sökvägssyntax och peka på en viss array.
Visa avsnittet ytterligare resurser för ett exempel på resursen som finns i en innehållssökväg.
sourceSpec.attributes.spec.properties.contentPath.path
Sökvägen som pekar på samlingsposterna som ska importeras till Platform.
$.emails
sourceSpec.attributes.spec.properties.contentPath.skipAttributes
Med den här egenskapen kan du identifiera specifika objekt från den resurs som identifieras i innehållssökvägen som ska uteslutas från kapsling.
[total_items]
sourceSpec.attributes.spec.properties.contentPath.keepAttributes
Med den här egenskapen kan du uttryckligen ange de enskilda attribut som du vill behålla.
[total_items]
sourceSpec.attributes.spec.properties.contentPath.overrideWrapperAttribute
Med den här egenskapen kan du åsidosätta värdet för attributnamnet som du angav i contentPath.
email
sourceSpec.attributes.spec.properties.explodeEntityPath
Med den här egenskapen kan du förenkla två arrayer och omvandla resursdata till en plattformsresurs.
sourceSpec.attributes.spec.properties.explodeEntityPath.path
Sökvägen som pekar på samlingsposterna som du vill förenkla.
$.email.activity
sourceSpec.attributes.spec.properties.explodeEntityPath.skipAttributes
Med den här egenskapen kan du identifiera specifika objekt från den resurs som identifieras i entitetssökvägen som ska uteslutas från inkapsling.
[total_items]
sourceSpec.attributes.spec.properties.explodeEntityPath.keepAttributes
Med den här egenskapen kan du uttryckligen ange de enskilda attribut som du vill behålla.
[total_items]
sourceSpec.attributes.spec.properties.explodeEntityPath.overrideWrapperAttribute
Med den här egenskapen kan du åsidosätta värdet för attributnamnet som du angav i explodeEntityPath.
activity
sourceSpec.attributes.spec.properties.paginationParams
Definierar de parametrar eller fält som måste anges för att få en länk till nästa sida från användarens aktuella sidsvar, eller när en URL för nästa sida skapas.
sourceSpec.attributes.spec.properties.paginationParams.type
Visar vilken typ av sidnumrering som stöds för källan.
  • OFFSET: Med den här sidnumreringstypen kan du analysera resultaten genom att ange ett index från vilken den resulterande arrayen ska startas och en gräns för hur många resultat som returneras.
  • POINTER: Med den här sidnumreringstypen kan du använda en pointer-variabel för att peka på ett visst objekt som behöver skickas med en begäran. Sidnumreringen av pekartypen kräver en sökväg i nyttolasten som pekar på nästa sida.
  • CONTINUATION_TOKEN: Den här sidnumreringstypen gör att du kan lägga till din fråga eller rubrikparametrar med en fortsättningssymbol för att hämta återstående returdata från källan, som inte returnerades från början på grund av ett fördefinierat maxvärde.
  • PAGE: Med den här sidnumreringstypen kan du lägga till frågeparametern med en sidindelningsparameter för att gå igenom returdata för sidor, med början från sidan noll.
  • NONE: Den här sidnumreringstypen kan användas för källor som inte stöder någon av de tillgängliga sidnumreringstyperna. Sidnumreringstypen NONE returnerar hela svarsdata efter en begäran.
sourceSpec.attributes.spec.properties.paginationParams.limitName
Namnet på den gräns genom vilken API:t kan ange antalet poster som ska hämtas på en sida.
limit eller count
sourceSpec.attributes.spec.properties.paginationParams.limitValue
Antalet poster som ska hämtas på en sida.
limit=10 eller count=10
sourceSpec.attributes.spec.properties.paginationParams.offSetName
Förskjutningsattributets namn. Detta krävs om sidnumreringstypen är inställd på offset.
offset
sourceSpec.attributes.spec.properties.paginationParams.pointerPath
Pekarens attributnamn. Detta kräver JSON-sökväg till attributet som pekar på nästa sida. Detta krävs om sidnumreringstypen är inställd på pointer.
pointer
sourceSpec.attributes.spec.properties.scheduleParams
Innehåller parametrar som definierar schemaläggningsformat som stöds för källan. Schemaparametrarna innehåller startTime och endTime, som båda gör att du kan ange specifika tidsintervall för batchkörningar, vilket gör att poster som hämtats i en tidigare batchkörning inte hämtas igen.
sourceSpec.attributes.spec.properties.scheduleParams.scheduleStartParamName
Definierar namnet på starttidsparametern
since_last_changed
sourceSpec.attributes.spec.properties.scheduleParams.scheduleEndParamName
Definierar sluttidsparameterns namn
before_last_changed
sourceSpec.attributes.spec.properties.scheduleParams.scheduleStartParamFormat
Definierar det format som stöds för scheduleStartParamName.
yyyy-MM-ddTHH:mm:ssZ
sourceSpec.attributes.spec.properties.scheduleParams.scheduleEndParamFormat
Definierar det format som stöds för scheduleEndParamName.
yyyy-MM-ddTHH:mm:ssZ
sourceSpec.spec.properties
Definierar de parametrar som användaren anger för att hämta resursvärden.
Se ytterligare resurser för ett exempel på användarinmatade parametrar för spec.properties.

Ytterligare resurser appendix

I följande avsnitt finns information om ytterligare konfigurationer som du kan göra i sourceSpec, inklusive avancerade scheman och anpassade scheman.

Exempel på innehållssökväg content-path

Följande är ett exempel på innehållet i egenskapen contentPath i en MailChimp Members-anslutningsspecifikation.

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

Exempel på användarindata för spec.properties user-input

Följande är ett exempel på en användartillhandahållen spec.properties som använder en MailChimp Members-anslutningsspecifikation.

I det här exemplet tillhandahålls listId som en del av urlParams.path. Om du behöver hämta listId från en kund måste du också definiera den som en del av 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."
        }
      }
    }

Exempel på Source-specifikation source-spec

Följande är en färdig källspecifikation som använder 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."
        }
      }
    }
  }

Konfigurera olika sidnumreringstyper för källan pagination

Nedan följer exempel på andra sidnumreringstyper som stöds av självbetjäningskällor (Batch SDK):

Förskjutning

Med den här sidnumreringstypen kan du tolka resultaten genom att ange ett index från vilken den resulterande arrayen ska startas och en gräns för hur många resultat som returneras. Exempel:

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
Egenskap Beskrivning
type Den typ av sidnumrering som används för att returnera data.
limitName Namnet på den gräns genom vilken API:t kan ange antalet poster som ska hämtas på en sida.
limitValue Antalet poster som ska hämtas på en sida.
offSetName Förskjutningsattributets namn. Detta krävs om sidnumreringstypen är inställd på offset.
endConditionName Ett användardefinierat värde som anger villkoret som avslutar pagineringsslingan i nästa HTTP-begäran. Du måste ange det attributnamn som du vill avsluta villkoret på.
endConditionValue Det attributvärde som du vill placera slutvillkoret på.
Pekare

Med den här sidnumreringstypen kan du använda en pointer-variabel för att peka på ett visst objekt som behöver skickas med en begäran. Sidnumreringen av pekartypen kräver en sökväg i nyttolasten som pekar på nästa sida. Exempel:

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
Egenskap Beskrivning
type Den typ av sidnumrering som används för att returnera data.
limitName Namnet på den gräns genom vilken API:t kan ange antalet poster som ska hämtas på en sida.
limitValue Antalet poster som ska hämtas på en sida.
pointerPath Pekarens attributnamn. Detta kräver JSON-sökväg till attributet som pekar på nästa sida.
Kontinuationstoken

En fortsättningssymbol för numrering returnerar en strängtoken som anger att det finns fler objekt som inte kan returneras på grund av ett fördefinierat maximalt antal objekt som kan returneras i ett enda svar.

En källa som stöder typen fortsättning av token för sidnumrering kan ha en sidnumreringsparameter som liknar:

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
Egenskap Beskrivning
type Den typ av sidnumrering som används för att returnera data.
continuationTokenPath Värdet som måste läggas till i frågeparametrarna för att kunna gå till nästa sida i de returnerade resultaten.
parameterType Egenskapen parameterType definierar var parameterName måste läggas till. Med typen QUERYPARAM kan du lägga till din fråga med parameterName. Med HEADERPARAM kan du lägga till parameterName i din rubrikbegäran.
parameterName Namnet på den parameter som används för att inkludera en fortsättningssymbol. Formatet är följande: {PARAMETER_NAME}={CONTINUATION_TOKEN}.
delayRequestMillis Med egenskapen delayRequestMillis i sidnumreringen kan du styra hur många begäranden som görs till källan. Vissa källor kan ha en gräns för hur många begäranden du kan göra per minut. Zendesk har till exempel en begränsning på 100 begäranden per minut och om du definierar delayRequestMillis till 850 kan du konfigurera källan så att den kan ringa anrop på ungefär 80 begäranden per minut, vilket ligger under tröskelvärdet på 100 begäranden per minut.

Följande är ett exempel på ett svar som returneras med en fortsättningstokentyp för sidnumrering:

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

Med sidnumreringstypen PAGE kan du gå igenom returdata med antalet sidor med början från noll. När du använder sidnumrering av typen PAGE måste du ange antalet poster som anges på en enda sida.

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
Egenskap Beskrivning
type Den typ av sidnumrering som används för att returnera data.
limitName Namnet på den gräns genom vilken API:t kan ange antalet poster som ska hämtas på en sida.
limitValue Antalet poster som ska hämtas på en sida.
initialPageIndex (Valfritt) Det inledande sidindexet definierar det sidnummer från vilket sidnumreringen börjar. Det här fältet kan användas för källor där sidnumreringen inte börjar från 0. Om inget anges används standardvärdet 0 för det inledande sidindexet. Fältet förväntar ett heltal.
endPageIndex (Valfritt) Med hjälp av indexvärdet för slutsidan kan du skapa ett slutvillkor och stoppa sidnumreringen. Det här fältet kan användas när standardslutvillkoren för att stoppa sidnumrering inte är tillgängliga. Det här fältet kan också användas om antalet sidor som ska importeras eller det sista sidnumret anges via svarshuvudet, som är vanligt när PAGE-typnumrering används. Värdet för indexvärdet för slutsidan kan antingen vara det sista sidnumret eller ett strängtypsuttryck från svarshuvudet. Du kan till exempel använda headers.x-pagecount för att tilldela slutsidesindex till värdet x-pagecount från svarshuvuden. Obs!: x-pagecount är ett obligatoriskt svarshuvud för vissa källor och innehåller värdeantalet sidor som ska importeras.
pageParamName Namnet på den parameter som du måste lägga till i frågeparametrar för att kunna gå igenom olika sidor i returdata. https://abc.com?pageIndex=1 skulle till exempel returnera den andra sidan av en API:s returnyttolast.
maximumRequest Det maximala antalet begäranden som en källa kan göra för en given stegvis körning. Den aktuella standardgränsen är 10000.
Ingen

Sidnumreringstypen NONE kan användas för källor som inte stöder någon av de tillgängliga sidnumreringstyperna. Källor som använder sidnumreringstypen NONE returnerar helt enkelt alla hämtningsbara poster när en GET-begäran görs.

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

Avancerad schemaläggning för självbetjäningskällor (batch-SDK)

Konfigurera källans inkrementella schema och schema för efterfyllnad med avancerad schemaläggning. Med egenskapen incremental kan du konfigurera ett schema där källan bara importerar nya eller ändrade poster, medan egenskapen backfill gör att du kan skapa ett schema för att importera historiska data.

Med avancerad schemaläggning kan du använda uttryck och funktioner som är specifika för källan för att konfigurera inkrementella scheman och bakgrundsfyllningsscheman. I exemplet nedan kräver Zendesk-källan att det inkrementella schemat formateras som type:user updated > {START_TIME} updated < {END_TIME} och bakåtfyllnad som 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}"
      }
Egenskap
Beskrivning
scheduleParams.type
Typen av schemaläggning som källan kommer att använda. Ange det här värdet till ADVANCE om du vill använda den avancerade schemaläggningstypen.
scheduleParams.paramFormat
Det definierade formatet för din schemaläggningsparameter. Det här värdet kan vara samma som källans scheduleStartParamFormat- och scheduleEndParamFormat-värden.
scheduleParams.incremental
Den inkrementella frågan för källan. Stegvis innebär en metod för intag där endast nya eller ändrade data har importerats.
scheduleParams.backfill
Källans bakgrundsfyllningsfråga. Backfill avser en ingestionsmetod där historiska data är inmatade.

När du har konfigurerat din avancerade schemaläggning måste du referera till scheduleParams i avsnittet för URL-, brödtext- eller rubrikparametrar, beroende på vad din källa stöder. I exemplet nedan är {SCHEDULE_QUERY} en platshållare som används för att ange var inkrementella schemaläggningsuttryck och schemaläggningsuttryck för bakåtfyllnad ska användas. Om det gäller en Zendesk-källa används query i queryParams för att ange avancerad schemaläggning.

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

Lägg till ett anpassat schema för att definiera källans dynamiska attribut

Du kan inkludera ett anpassat schema i sourceSpec för att definiera alla attribut som krävs för källan, inklusive alla dynamiska attribut som du kan behöva. Du kan uppdatera källans motsvarande anslutningsspecifikation genom att göra en PUT-begäran till /connectionSpecs-slutpunkten i Flow Service API, och samtidigt ange ditt anpassade schema i sourceSpec -avsnittet i anslutningsspecifikationen.

Följande är ett exempel på ett anpassat schema som du kan lägga till i källans anslutningsspecifikation:

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

Nästa steg

När källspecifikationerna är ifyllda kan du fortsätta att konfigurera utforska specifikationerna för den källa som du vill integrera med plattformen. Mer information finns i dokumentet om Konfigurera specifikationer.

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