Llamada a las API Modify

Acceder a las API Modify con solicitudes PATCH de HTTP. Las API Modify actualizan la información de los recursos existentes.

Las solicitudes Modify de REST utilizan los siguientes tipos de API, en función del Nombre del recurso que se ha especificado:

  • manageName (con Operation=Modify)
  • manageNameHierarchy (con Operation=Modify)
  • modifyName
  • modifyNameHierarchy
  • changeName
  • changeNameHierarchy

Por ejemplo, las solicitudes Modify para las órdenes utilizan changeOrder y las solicitudes Modify para las organizaciones utilizan manageOrganizationHierarchy. Para ver la lista completa de recursos y API, vea los archivos Javadoc de REST.

Formato de solicitud

Utilice el siguiente formato de solicitud HTTP para llamar a las API Modify:

PATCH https://host:port/contextRoot/restapi/Name/id

Nombre es el tipo de recurso que se va a modificar y id es el valor de su clave primaria, NameKey.

El ejemplo siguiente muestra una solicitud para modificar una orden con una OrderKey igual a 12345:
PATCH https://host:port/contextRoot/restapi/order/12345
Puede realizar llamadas Modify con PUT si establece servlet.put.enabled en true en el archivo xapirest.properties.

Crear o modificar

Puede utilizar las API "manage" para actualizar un recurso si existe o para crear el recurso si no existe en una única solicitud de crear o modificar (Create-Or-Modify). Para crear o modificar mediante REST, envíe un PATCH al Nombre de la colección de recursos y pase un documento que describa el recurso en el cuerpo de la solicitud.
PATCH https://host:port/contextRoot/restapi/Name
La característica Create-Or-Modify sólo es compatible con tipos de recursos que utilizan las API "manage". Por ejemplo, los artículos utilizan manageItem y las organizaciones utilizan manageOrganizationHierarchy, de modo que pueda crear o modificar artículos y organizaciones con PATCH. Consulte los archivos Javadoc para ver si un tipo de recurso utiliza las API "manage".