Chamando APIs Create

Acesse as APIs Create com as solicitações HTTP POST. As APIs Create inserem novas entradas de recursos no banco de dados.

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

  • manageName (com Operation=Create)
  • manageNameHierarchy (com Operation=Create)
  • createName
  • createNameHierarchy

Por exemplo, solicitações Create para pedidos usam createOrder, e as solicitações Create 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 Create:

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

Name é o tipo de recurso que deseja criar.

O exemplo a seguir mostra uma solicitação Create para um pedido:
POST https://host:port/contextRoot/restapi/order

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".