Punto final de API de conversión de esquema a plantilla CSV
El /rpc/csv2schema
punto final en la Schema Registry API permite crear automáticamente un esquema del Modelo de datos de experiencia (XDM) utilizando un archivo CSV como plantilla. Con este punto de conexión, puede crear plantillas para importar campos de esquema por lotes y reducir el trabajo manual de la API o la IU.
Introducción
El /rpc/csv2schema
El punto final forma parte de la variable Schema Registry API. Antes de continuar, consulte la guía de introducción para obtener vínculos a documentación relacionada, una guía para leer las llamadas de API de ejemplo en este documento e información importante sobre los encabezados necesarios para realizar correctamente llamadas a cualquier API de Adobe Experience Platform.
El /rpc/csv2schema
El extremo forma parte de las llamadas a procedimientos remotos (RPC) compatibles con Schema Registry. A diferencia de otros extremos de Schema Registry API, los extremos RPC no requieren encabezados adicionales como Accept
o Content-Type
, y no use un CONTAINER_ID
. En su lugar, deben utilizar la variable /rpc
, como se muestra en las llamadas de API siguientes.
Requisitos del archivo CSV
Para utilizar este punto de conexión, primero debe crear un archivo CSV con los encabezados de columna adecuados y los valores correspondientes. Algunas columnas son obligatorias, mientras que el resto son opcionales. En la tabla siguiente se describen estas columnas y su función en la construcción de esquemas.
isIgnored
true
, indica que el campo no está listo para la carga de API y que se debe ignorar.isCustom
fieldGroupId
fieldGroupName
Opcional para campos personalizados que no amplían los campos estándar existentes. Si se deja en blanco, el sistema asignará automáticamente un nombre.
Necesario para campos estándar o campos personalizados que amplían los grupos de campos estándar, que se utiliza para consultar la variable
fieldGroupId
.fieldPath
fieldGroupName
), establezca el valor en ALL
.displayName
fieldDescription
dataType
If
dataType
se establece en object
, bien properties
o $ref
también debe definirse para la misma fila, pero no para ambas.isRequired
isArray
dataType
.isIdentity
identityNamespace
isIdentity
is trueisPrimaryIdentity
minimum
maximum
enum
[value1,value2,value3]
).stringPattern
format
minLength
maxLength
properties
dataType
se establece en object
y $ref
no está definida. Esto define el cuerpo del objeto como una cadena JSON (por ejemplo, {"myField": {"type": "string"}}
).$ref
dataType
se establece en object
y properties
no está definida. Esto define la variable $id
del objeto al que se hace referencia para el tipo de objeto (por ejemplo, https://ns.adobe.com/xdm/context/person
).comment
isIgnored
se establece en true
, esta columna se utiliza para proporcionar la información de encabezado del esquema.Consulte lo siguiente Plantilla CSV para determinar el formato que debe aplicarse al archivo CSV.
Creación de una carga útil de exportación a partir de un archivo CSV
Una vez configurada la plantilla CSV, puede enviar el archivo al /rpc/csv2schema
y convertirlo en una carga útil de exportación.
Formato de API
POST /rpc/csv2schema
Solicitud
La carga útil de la solicitud debe utilizar datos de formulario como formato. A continuación, se muestran los campos de formulario requeridos.
curl -X POST \
https://platform.adobe.io/data/foundation/schemaregistry/rpc/csv2schema \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-F 'csv-file=@"/Users/userName/Documents/sample-csv-template.csv"' \
-F 'schema-class-id="https://ns.adobe.com/xdm/context/profile"' \
-F 'schema-name="Example Schema"' \
-F 'schema-description="Example schema description."'
csv-file
schema-class-id
$id
del XDM clase que este esquema empleará.schema-name
schema-description
Respuesta
Una respuesta correcta devuelve una carga útil de exportación generada a partir del archivo CSV. La carga útil adopta la forma de una matriz y cada elemento de matriz es un objeto que representa un componente XDM dependiente para el esquema. Seleccione la sección siguiente para ver un ejemplo completo de una carga útil de exportación generada a partir de un archivo CSV.
code language-json |
---|
|
Importar la carga útil del esquema
Después de generar la carga útil de exportación desde el archivo CSV, puede enviar esa carga útil a /rpc/import
extremo para generar el esquema.
Consulte la guía de importar extremo para obtener más información sobre cómo generar esquemas a partir de cargas útiles de exportación.