Chamando APIs Modify

Acesse as APIs Modify com as solicitações HTTP PATCH. As APIs Modify atualizam as informações de recursos existentes.

As solicitações REST Modify usam os seguintes tipos de APIs dependendo do Name do recurso que é especificado:

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

Por exemplo, solicitações Modify para pedidos usam changeOrder, e as solicitações Modify para organizações usam manageOrganizationHierarchy. Para ver a lista completa de recursos e APIs, visualize os arquivos REST Javadoc.

Formato da solicitação

Use o formato de solicitação de HTTP a seguir para chamar APIs Modify:

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

Name é o tipo de recurso a ser modificado, e id é o valor de sua chave primária, NameKey.

O exemplo a seguir mostra uma solicitação para modificar um pedido com um OrderKey igual a 12345:
PATCH https://host:port/contextRoot/restapi/order/12345
É possível fazer chamadas Modify com PUT se configurar servlet.put.enabled para true no arquivo xapirest.properties.

Create-Or-Modify

É possível usar as APIs "manage" para atualizar um recurso se ele existir ou criar o recurso se ele não existir em uma solicitação Create-Or-Modify única. Para Create-Or-Modify através do REST, envie um PATCH para o Name da coleção de recurso e transmita um documento que descreva o recurso no corpo da solicitação.
PATCH https://host:port/contextRoot/restapi/Name
O recurso Create-Or-Modify é compatível apenas com os tipos de recurso que usam APIs "manage". Por exemplo, como os itens usam manageItem e as organizações usam manageOrganizationHierarchy, é possível executar Create-Or-Modify de itens e organizações com PATCH. Consulte os arquivos Javadoc para ver se um tipo de recurso usa APIs "manage".