Apêndice do guia da API do registro de esquema
Este documento fornece informações adicionais relacionadas ao trabalho com o Schema Registry API.
Uso de parâmetros de consulta query
A variável Schema Registry O suporta o uso de parâmetros de consulta para página e filtrar resultados ao listar recursos.
&).Paginação paging
Os parâmetros de consulta mais comuns para paginação incluem:
orderbyorderby=title A classificará os resultados por título em ordem crescente (A-Z). Adicionar um - antes do valor do parâmetro (orderby=-title) classificará os itens por título em ordem decrescente (Z-A).limitorderby parâmetro, limit restringe o número máximo de itens que devem ser retornados para uma determinada solicitação. Este parâmetro não pode ser usado sem um orderby parâmetro presente.A variável
limit parâmetro especifica um número inteiro positivo (entre 0 e 500) como um dica quanto ao número máximo de itens que devem ser retornados. Por exemplo, limit=5 retorna somente cinco recursos na lista. No entanto, esse valor não é estritamente honrado. O tamanho real da resposta pode ser menor ou maior, conforme restringido pela necessidade de fornecer a operação confiável do start parâmetro, se fornecido.startorderby parâmetro, start especifica onde a lista de itens subdefinida deve começar. Este parâmetro não pode ser usado sem um orderby parâmetro presente. Esse valor pode ser obtido do _page.next atributo de uma resposta de lista, e usado para acessar a próxima página de resultados. Se a variável _page.next for nulo, então não haverá página adicional disponível.Normalmente, esse parâmetro é omitido para obter a primeira página de resultados. Depois disso,
start deve ser definido como o valor máximo da propriedade de classificação primária do orderby campo recebido na página anterior. A resposta da API retorna entradas que começam com aquelas que têm uma propriedade de classificação primária de orderby estritamente maior que (para crescente) ou estritamente menor que (para decrescente) o valor especificado.Por exemplo, se a variável
orderby está definido como orderby=name,firstname, o start o parâmetro conteria um valor para o name propriedade. Nesse caso, se você quiser mostrar as próximas 20 entradas de um recurso imediatamente após o nome "Miller", você usaria: ?orderby=name,firstname&start=Miller&limit=20.Filtragem filtering
É possível filtrar os resultados usando o property que é usado para aplicar um operador específico em uma determinada propriedade JSON nos recursos recuperados. Os operadores compatíveis incluem:
==property=title==test!=property=title!=test<property=version<5>property=version>5<=property=version<=5>=property=version>=5property=titleproperty para filtrar grupos de campos de esquema por sua classe compatível. Por exemplo, property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile retorna somente grupos de campos compatíveis com o XDM Individual Profile classe.Modo de compatibilidade compatibility
Experience Data Model O (XDM) é uma especificação documentada publicamente, orientada pela Adobe para melhorar a interoperabilidade, a expressividade e o poder das experiências digitais. O Adobe mantém o código-fonte e as definições formais do XDM em uma projeto de código aberto no GitHub. Essas definições são escritas em Notação padrão XDM, usando JSON-LD (Notação de objeto JavaScript para dados vinculados) e Esquema JSON como a gramática para definir esquemas XDM.
Ao observar as definições formais de XDM no repositório público, é possível observar que o XDM padrão é diferente do que você vê no Adobe Experience Platform. O que você está vendo no Experience Platform é chamado de Modo de compatibilidade e fornece um mapeamento simples entre o XDM padrão e a maneira como é usado no Platform.
Como o modo de compatibilidade funciona
O modo de compatibilidade permite que o modelo XDM JSON-LD funcione com a infraestrutura de dados existente, alterando os valores no XDM padrão e mantendo a semântica igual. Ele usa uma estrutura JSON aninhada, exibindo esquemas em um formato em árvore.
A principal diferença observada entre o XDM padrão e o Modo de compatibilidade é a remoção do prefixo "xdm:" para nomes de campo.
Veja a seguir uma comparação lado a lado que mostra campos relacionados ao aniversário (com atributos de "descrição" removidos) no XDM padrão e no Modo de compatibilidade. Observe que os campos Modo de compatibilidade incluem uma referência ao campo XDM e seu tipo de dados nos atributos "meta:xdmField" e "meta:xdmType".
Por que o modo de compatibilidade é necessário?
A Adobe Experience Platform foi projetada para trabalhar com várias soluções e serviços, cada um com seus próprios desafios e limitações técnicas (por exemplo, como determinadas tecnologias lidam com caracteres especiais). Para superar essas limitações, o Modo de compatibilidade foi desenvolvido.
Mais Experience Platform serviços, incluindo Catalog, Data Lake, e Real-Time Customer Profile use Compatibility Mode em vez do XDM padrão. A variável Schema Registry A API também usa Compatibility Mode, e os exemplos neste documento são todos mostrados usando Compatibility Mode.
Vale a pena saber que ocorre um mapeamento entre o XDM padrão e a forma como ele é operacionalizado no Experience Platform, mas isso não deve afetar o uso que você faz do Platform serviços.
O projeto de código aberto está disponível para você, mas quando se trata de interagir com recursos por meio do Schema Registry, os exemplos de API neste documento fornecem as práticas recomendadas que você deve conhecer e seguir.