Transmitindo modelos de API

Nas solicitações REST, os parâmetros _templateKey e _templateId referenciam modelos que são armazenados no banco de dados. Como os modelos são acessados por referência, as solicitações REST que usam modelos são leves, e diversos usuários podem compartilhar um modelo único centralmente gerenciado.

Gerenciando modelos no banco de dados

É possível criar, ler, atualizar e excluir modelos de API com três APIs. Para obter informações detalhadas sobre essas APIs, visualize os arquivos da API Javadoc.

manageApiTemplate
getApiTemplateDetails
getApiTemplateList

É possível acessar as APIs "ApiTemplate" ao especificar o nome do recurso api_template nas solicitações Detalhes de REST, Lista, Modificar, Criar ou Excluir.

O exemplo a seguir mostra uma solicitação Criar REST para um modelo de API:

POST https://host:port/contextRoot/restapi/api_template

Após um modelo ser criado no banco de dados, seus dados são armazenados na tabela PLT_API_TEMPLATE:

Entrada	Descrição
`ORGANIZATION_CODE`	Identificador da organização que é usado em arquiteturas de diversos locatários.
`TEMPLATE_TYPE`	`00` para um modelo de API `01` para Recurso
`API_NAME`	Nome da API ou do Recurso
`TEMPLATE_ID`	Identificador dentro de `org+type+name`
`DESCRIPTION`	Informações extras da descrição
`TEMPLATE_DATA`	Coluna Character Large Object que contém o modelo

Referenciando modelos

Solicite modelos específicos em qualquer chamada de API no YFSEnvironment com o método:

public void setApiTemplate(String apiName, String templateFileName)

Para referenciar um modelo a partir da camada REST, use um parâmetro de consulta que corresponda ao formato do templateFileName:

Formato `templateFileName`	Formato do parâmetro de consulta REST
`"key:primaryKey"`	`_templateKey=primaryKey`
`"id:orgCode,templateId"`	`_templateId=orgCode,templateId`

Nota: O atributo orgCode é opcional e padronizado para DEFAULT.