Pasar plantillas de API

En las solicitudes REST, los parámetros _templateKey y _templateId hacen referencia a plantillas que están almacenadas en la base de datos. Dado que se accede a las plantillas por referencia, las solicitudes REST que utilizan plantillas son ligeras y varios usuarios pueden compartir una única plantilla gestionada desde un punto central.

Gestión de plantillas de la base de datos

Puede crear, leer, actualizar y suprimir plantillas de API con tres API. Para obtener información detallada sobre estas API, vea los archivos Javadoc de API.

  • manageApiTemplate
  • getApiTemplateDetails
  • getApiTemplateList

Puede acceder a las API "ApiTemplate" especificando el nombre de recurso api_template en las solicitudes Detail, List, Modify, Create o Delete de REST.

El ejemplo siguiente muestra una solicitud Create de REST para una plantilla de API:
POST https://host:port/contextRoot/restapi/api_template

Después de crear una plantilla en la base de datos, los datos se almacenan en la tabla PLT_API_TEMPLATE:

Entrada Descripción
ORGANIZATION_CODE Identificador de organización que se utiliza en arquitecturas de varios arrendatarios
TEMPLATE_TYPE

00 para una plantilla de API

01 para recurso
API_NAME Nombre de la API o recurso
TEMPLATE_ID Identificador en org+type+name
DESCRIPTION Información de descripción adicional
TEMPLATE_DATA Columna de objeto grande de tipo carácter que contiene la plantilla

Referencia a plantillas

Solicite plantillas específicas en cualquier llamada de API en YFSEnvironment con el método:
public void setApiTemplate(String apiName, String templateFileName)
Para hacer referencia a una plantilla desde la capa REST, utilice un parámetro de consulta que coincida con el formato de templateFileName:
Formato de templateFileName Formato de parámetro de consulta REST
"key:primaryKey" _templateKey=primaryKey
"id:orgCode,templateId" _templateId=orgCode,templateId
Nota: el atributo códigoOrg es opcional y toma de forma predeterminada el valor DEFAULT.