Apêndice do guia da API do registro de esquema

Última atualização: 4 de abril de 2025
  • Tópicos:

Criado para:

  • Desenvolvedor

Este documento fornece informações adicionais relacionadas ao trabalho com a API Schema Registry.

Uso de parâmetros de consulta

O Schema Registry dá suporte ao uso de parâmetros de consulta para página e filtrar resultados ao listar recursos.

NOTE
Ao combinar vários parâmetros de consulta, eles devem ser separados por "E" comercial (&).

Paginação

Os parâmetros de consulta mais comuns para paginação incluem:

ParâmetroDescrição
orderbyClassificar os resultados por uma propriedade específica. Exemplo: orderby=title 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).
limitQuando usado em conjunto com um parâmetro orderby, 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 parâmetro orderby presente.

O parâmetro limit especifica um inteiro positivo (entre 0 e 500) como uma 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 parâmetro start, se fornecido.
startQuando usado em conjunto com um parâmetro orderby, start especifica onde a lista subdefinida de itens deve começar. Este parâmetro não pode ser usado sem um parâmetro orderby presente. Esse valor pode ser obtido do atributo _page.next de uma resposta de lista e usado para acessar a próxima página de resultados. Se o valor _page.next for nulo, então não há 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 campo orderby 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 o parâmetro orderby estiver definido como orderby=name,firstname, o parâmetro start conterá um valor para a propriedade name. 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

Você pode filtrar os resultados usando o parâmetro property, que é usado para aplicar um operador específico em uma determinada propriedade JSON nos recursos recuperados. Os operadores compatíveis incluem:

OperadorDescriçãoExemplo
==Define se a propriedade é igual ao valor fornecido.property=title==test
!=Define se a propriedade não é igual ao valor fornecido.property=title!=test
<Define se a propriedade é menor que o valor fornecido.property=version<5
>Filtra especificando se a propriedade é maior que o valor fornecido.property=version>5
<=Filtra se a propriedade é menor ou igual ao valor fornecido.property=version<=5
>=Filtra se a propriedade é maior ou igual ao valor fornecido.property=version>=5
(Nenhum)Declarar apenas o nome da propriedade retorna somente as entradas nas quais a propriedade existe.property=title
TIP
Você pode usar o parâmetro property 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 a classe XDM Individual Profile.

Modo de compatibilidade

O Experience Data Model (XDM) é uma especificação documentada publicamente, orientada pela Adobe para melhorar a interoperabilidade, a expressividade e o potencial das experiências digitais. O Adobe mantém o código-fonte e as definições formais do XDM em um 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 Experience 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".

XDM padrãoModo de compatibilidade
{
  "xdm:birthDate": {
    "title": "Birth Date",
    "type": "string",
    "format": "date"
  },
  "xdm:birthDayAndMonth": {
    "title": "Birth Date",
    "type": "string",
    "padrão": "[0-1][0-9]-[0-9][0-9]"
  },
  "xdm:birthYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum": 1,
    "maximum": 32767
  }
}


{
  "birthDate": {
    "title": "Birth Date",
    "type": "string",
    "format": "date",
    "meta:xdmField": "xdm:birthDate",
    "meta:xdmType": "date"
  },
  "birthDayAndMonth": {
    "title": "Birth Date",
    "type": "string",
    "padrão": "[0-1][0-9]-[0-9][0-9]",
    "meta:xdmField": "xdm:birthDayAndMonth",
    "meta:xdmType": "string"
  },
  "birthYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum": 1,
    "maximum": 32767,
    "meta:xdmField": "xdm:birthYear",
    "meta:xdmType": "short"
  }
}