Elementos de mensagem REST

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 1 min. de leitura
  • Uma mensagem REST de saída é composta por vários elementos, como o endpoint e os métodos HTTP.

    Uma mensagem REST contém os seguintes elementos:
    Tabela 1. Elementos
    Elemento Descrição
    Endpoint O endpoint é o URL dos dados a serem recuperados, atualizados ou excluídos. Cada mensagem REST deve especificar um endpoint.
    Cabeçalhos Os cabeçalhos HTTP em mensagens REST contêm informações sobre a solicitação, como o formato de resposta desejado. Uma mensagem REST pode especificar qualquer número de cabeçalhos.
    Configurações de autenticação As configurações de autenticação incluem o tipo de autenticação a ser usado, como autenticação básica ou OAuth, bem como as credenciais a serem usadas.
    Métodos HTTP Métodos HTTP, como GET, POST ou DELETE, interagem com os dados no endpoint.

    Opcionalmente, você pode substituir a configuração da mensagem REST primária em cada método HTTP, por exemplo, especificando um endpoint, credenciais de autenticação ou cabeçalhos diferentes.

    Os métodos HTTP que enviam conteúdo, como POST, incluem um corpo de mensagem detalhando esse conteúdo.

    Uma mensagem REST pode especificar vários métodos HTTP. Ao enviar uma mensagem REST, como por meio de uma atividade de fluxo de trabalho ou script, você deve especificar qual método HTTP usar.