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 http://host:port/contextRoot/restapi/api_template

La tabla PLT_API_TEMPLATE se utiliza para almacenar la API basada en XML y las plantillas de recursos. La descripción es la siguiente:

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.

El valor de TEMPLATE_TYPE es 00 para almacenar las plantillas de API en la base de datos. Por ejemplo, si desea almacenar una plantilla para la API de getOrderList , debe pasar el atributo TemplateType como 00 en la entrada a la API. Posteriormente, cuando pasa un templateKey o templateId al llamar a la API getOrderList , el sistema busca en la tabla PLT_API_TEMPLATE las plantillas de tipo 00 y, a continuación, utiliza la plantilla.

01 para una plantilla de recurso.

El valor de TEMPLATE_TYPE es 01 para almacenar las plantillas que residen en el directorio "resources" en la base de datos. Por ejemplo, apifactlookup.xml, el XML de plantilla de tema de interfaz de usuario, etc.
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.