Defina um esquema da REST API

Especifique a estrutura de dados esperada para solicitações ou respostas em uma REST API definindo um esquema.

Antes de Iniciar

Função necessária: web_service_admin

Por Que e Quando Desempenhar Esta Tarefa

Esquemas são registros que definem a estrutura e o formato de corpos e cabeçalhos de solicitação e resposta para uma REST API no formato OpenAPI 3.0.1. Quando você define um esquema no ServiceNow AI Platform, O esquema é usado para definir a estrutura de solicitações e respostas na REST API associada. Os dados do esquema para as solicitações e respostas são disponibilizados na especificação OpenAPI exportável para a API. Para obter mais informações sobre como exportar especificações OpenAPI, consulte Exporte para especificação OpenAPI.

O procedimento a seguir descreve o processo de definição de esquema manual. Para obter detalhes sobre como gerar automaticamente definições de esquema de solicitação em instâncias que não são de produção, consulte Gerar automaticamente definições de solicitação de API.

Procedimento

1. Crie um Esquema REST de uma das seguintes maneiras.

   Opção	Procedimento
   Navegue por um registro da REST API com script	Navegar até Tudo > Serviços web do sistema > Scripted REST APIs. Selecione um registro da REST API com script. Em Esquemas lista relacionada, selecione Novo .
   Navegue diretamente para um novo registro de Esquema REST	Navegar até Tudo > Filtro e insira sys_ws_schema.form . Em API Selecione ou insira a API a ser associada ao esquema.

2. Em Nome insira um nome para o esquema.
3. Em Esquema defina o tipo de dados e a estrutura do novo esquema usando Formato OpenAPI versão 3.0.1 .
   Por exemplo, a entrada a seguir especifica que o esquema é um objeto que contém um nome. O nome é um tipo de dados de cadeia de caracteres.

   { "type": "object", "properties": { "firstName": { "type": "string" } } }

4. Selecione um Versão da OpenAPI .
5. Em Descrição resuma a estrutura esperada do novo esquema.
6. Selecione Enviar.

O que Fazer Depois

Defina esquemas adicionais conforme necessário. Use os esquemas para especificar a estrutura e o formato esperados em uma solicitação ou resposta REST. Para mais informações, confira Defina uma estrutura de solicitação de recurso de API ou Defina uma estrutura de resposta de recurso de API.