REST V1 (Descontinuado)

Conheça o componente e saiba como utilizá-lo.

O REST V1 foi descontinuado e não é mais atualizado. Consulte as documentações das versões mais recentes da feature: REST V2.

O REST V1 realiza chamadas a endpoints REST a partir de um pipeline.

Parâmetros

Dê uma olhada nas opções de configuração do componente. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Parâmetro	Descrição	Valor Padrão	Tipo de Dado
URL	URL a ser chamada - pode conter os parâmetros seguindo o padrão {:param1}, que serão substituídos pela propriedade correspondente da mensagem de entrada.		String
Content Type	Configura o Content Type e a codificação.		String
Verb	Tipo de chamada do REST (GET, POST e PUT).		String
Account	Conta a ser utilizada pelo componente.		String
Connection Timeout	Tempo de expiração da conexão (em milissegundos).		Integer
Reading Timeout	Tempo máximo para leitura (em milissegundos).		Integer
Stop On Client Error	Se ativada, a opção vai gerar um erro para suspender a execução do pipeline.	False	Boolean
Stop On Server Error	Se ativada, a opção vai gerar um erro para suspender a execução do pipeline.	False	Boolean
Advanced Settings	Configurações avançadas.		Object/Map
Inject JWT	Se ativada, a opção injeta o JWT presente na chamada do pipeline (gerado ou não pelo componente JWT) no header Authorization da chamada REST.	False	Boolean
Read JWT	Se ativada, a opção coloca como resposta o JWT que fica no header Authorization interno, caso exista.	False	Boolean
Raw Mode	Se ativada, a opção recebe ou passa um payload sem ser JSON.	False	Boolean
Allow Insecure Calls To HTTPS Endpoints	Quando ativada, a opção permite que chamadas não seguras a endpoints HTTPS sejam feitas.	False	Boolean
Enable Retries	Quando ativada, a opção permite que sejam feitas novas tentativas.	False	Boolean
Maximum Number Of Retries Before Giving Up	Número máximo de tentativas antes de desistir da chamada.	3	Integer
Time To Wait Before Each Retry	Tempo máximo entre tentativas (em milissegundos).	1000	Integer
Compress Body With GZIP	Quando ativada, a opção permite que o body seja comprimido com GZIP.	False	Boolean

Path Parameter

Exemplo

http://test.com/order/$EXPAND{:id,}

Query Parameter

Exemplo

http://test.com/order$QUERY{page=:page,search=:search}\r\n\t\t\t

Fluxo de Mensagens

Entrada

application/x-www-form-urlencoded

{
	header: {
		"headerA":"valueA",
		"headerB":"valueB"
	},
		url: {
		"urlParam1": "paramValue"
	},
	formData: {
		"field1": "value1",
		"field2": "value2"
	}
}

multipart/form-data

{
	header: {
		"headerA":"valueA",
		"headerB":"valueB"
	},
	url: {
		
	},
	multiPartData: {
		"files": {
		"file_formName" "filename",
		"files_formName[]" ["filename1","filename2"]
	},	"fields": {
		"field1" : "value1",
		"field2" : "value2",
	}
	}
}

O componente espera uma mensagem no seguinte formato:

{
	header: {
	"headerA":"valueA",
	"headerB":"valueB"
	},
	url: {
	"urlParam1": "paramValue"
	},
	body: {
	// message to be sent to the endpoint
	}
}

Saída

• Com sucesso

{
    status: XXX,
    body: {},
    headers: {}
}

• Com erro

{
    error: "error message",
    code: XXX,
    body: {},
    headers: {} 
}

No caso de alguns erros, body e headers estarão indisponíveis.