Propriedades
| Nome | Tipo | Descrição |
|---|---|---|
| Url | string | A url do recurso. |
| Method | string | O tipo de requisição (por exemplo, GET ou POST). |
| AuthToken | string | Token de autenticação (se a autenticação do serviço externo for necessária). |
| AuthScheme | string | Esquema de autenticação. |
| ThrowExceptionOnFailed | boolean | Especifica se uma exceção deve ser gerada quando o serviço externo retornar um código de erro como status da resposta HTTP. Se definido como False, exceções não serão geradas e o código de status HTTP será armazenado na propriedade Status. Definido como True por padrão. |
| Timeout | number | Tempo limite de resposta, em minutos. Definido como 1 minuto por padrão. Importante! O tempo limite da requisição não pode ser maior que a restrição de tempo de execução do script (600 segundos). |
| ResponseText | string, somente leitura | O resultado da resposta em formato de texto. |
| ResponseType | string, somente leitura | O tipo de resposta da requisição retornado pelo serviço, por exemplo, “application/json”. |
| Status | number | O código de status da resposta HTTP do serviço externo. Se ThrowExceptionOnFailed estiver definido como True, um código de erro gerará uma exceção e a transação será interrompida. O texto da mensagem de erro pode ser visualizado no Skill Monitor. |
Métodos
| Name | Description |
|---|---|
| AppendStringContent(string data, string contentName); | Adiciona uma string multipart/form-data ao corpo da requisição (por padrão, o tipo de conteúdo é definido como application/json com codificação UTF-8). O parâmetro contentName especifica o nome do campo no formato transmitido. |
| AppendStringContent(string data, string contentName, ContentEncoding contentEncoding, string mediaType?); | Adiciona uma string multipart/form-data ao corpo da requisição. Além disso, permite especificar a codificação. Se o tipo de conteúdo não for especificado, ele será definido como “application/json” por padrão. |
| AppendFileContent(DocumentExportResult documentExportResult, string contentName, string mediaType?); | Adiciona dados binários multipart/form-data ao corpo da requisição. O tipo de conteúdo é definido automaticamente com base na extensão do arquivo sendo enviado. Se necessário, o tipo de conteúdo pode ser definido previamente usando o parâmetro opcional mediaType. |
| AppendFileContent(BinaryFile binaryFile, string contentName, string mediaType?); | Adiciona ao corpo da requisição os seguintes dados binários: a imagem de origem importada para a transação ou a imagem contida no campo do tipo Picture. O tipo de conteúdo é definido automaticamente com base na extensão do arquivo sendo importado. Se necessário, o tipo de conteúdo pode ser definido previamente usando o parâmetro opcional mediaType. |
| AppendSourceFileContent(string contentName, string mediaType?); | Adiciona ao corpo da requisição dados binários da imagem de origem importada para a transação. O tipo de conteúdo é definido automaticamente com base na extensão do arquivo sendo importado. Se necessário, o tipo de conteúdo pode ser definido previamente usando o parâmetro opcional mediaType. Importante: este método está obsoleto. Ele terá acesso apenas ao primeiro arquivo da transação. Use o método AppendFileContent() em seu lugar. |
| SetHeader(string name, string value); | Define cabeçalhos HTTP adicionais para a requisição. Este método deve ser chamado para cada nome de cabeçalho. |
| Send(); | Envia a requisição HTTP. |