Linha Datasul

Árvore de páginas

Métodos Estáticos

Nome

Descrição

Versão Disponível
getPropertyJsonObject

Recupera de acordo com o tipo do dado, o valor de uma propriedade dentro de um JsonObject.

Exemplo

ASSIGN cUser = JsonAPIUtils:getPropertyJsonObject(oJsonInput, "user").

Importante

Caso a propriedade seja um objeto JsonArray, todos os dados são agrupados, transformados em um texto e separados por vírgula.

12.1.21  e superiores
getPropertyJsonArray

Verifica se o array possui uma propriedade no índice informado e, de acordo com o tipo do dado.

Exemplo

ASSIGN cReturn = JsonAPIUtils:getPropertyJsonArray(oJsonArray, iCount).

12.1.23 e superiores
getProperty

Recebe um objeto genérico que será transformado em JsonObject ou JsonArray, de acordo com as informações vindas da chamada,
e devolve uma string com o conteúdo da propriedade indicada pelo nome ou pelo ­índice.

Exemplo

ASSIGN cReturn = JsonAPIUtils:getProperty(oJsonObject, cProperty, ?).

12.1.23 e superiores
getJsonArrayChar

Retorna todos os dados de um objeto JsonArray agrupados, transformados em um texto e separados por vírgula.

Exemplo

ASSIGN cJsonArrayChar = JsonAPIUtils:getJsonArrayChar(oJsonArray).

12.1.21 e superiores
checkJsonIsArray

Verifica se o objeto é um JsonArray ou um JsonObject.

Exemplo

IF JsonAPIUtils:checkJsonIsArray(oJsonInput) THEN DO:

...

END.

12.1.21 e superiores
isJsonObjectEmpty

Verifica se um objeto é nulo ou vazio (sem nenhuma propriedade).

Exemplo

IF JsonAPIUtils:isJsonObjectEmpty(oObj) THEN DO:

...

END.

12.1.2403 e superiores
isJsonArrayEmpty

Verifica se um array é nulo ou vazio (sem nenhum item).

Exemplo

IF JsonAPIUtils:isJsonArrayEmpty(aResult) THEN DO:

...

END.

12.1.2403 e superiores
changeDateToISO

Formata uma data e horário do padrão PROGRESS para uma string dentro do padrão ISO (DATETIME-TZ).

Exemplo

ASSIGN cDateISO = JsonAPIUtils:changeDateToISO(pDate, "08:09:11").

12.1.21 e superiores
changeISOToDate

Converte uma data no formato ISO (string) para uma variável do tipo Date.

Exemplo

ASSIGN pDate = JsonAPIUtils:changeISOToDate(cDateISO).

12.1.21 e superiores
convertLongcharToJsonObject

Converte uma variável LongChar em um objeto JSONObject.

Exemplo

ASSIGN oJsonObject = JsonAPIUtils:convertLongcharToJsonObject(pJsonChar).

12.1.21 e superiores
convertTempTableToJsonObject

Converte uma tabela temporária em um objeto JSONObject.

Exemplo

ASSIGN oJsonObject = JsonAPIUtils:convertTempTableToJsonObject(INPUT TEMP-TABLE RowErrors:HANDLE).

12.1.21 e superiores
convertTempTableToJsonObject

Converte uma tabela temporária em um objeto JSONObject, podendo optar pela omissão dos valores iniciais.

Exemplo

ASSIGN oJsonObject = JsonAPIUtils:convertTempTableToJsonObject(INPUT TEMP-TABLE RowErrors:HANDLE, INPUT YES).

12.1.21 e superiores
convertTempTableToJsonArray

 Converte uma TEMP-TABLE handle para um JSONArray.

Exemplo

Assign oJsonArray = JsonAPIUtils:ConvertTempTableToJsonArray(INPUT TEMP-TABLE RowErrors:HANDLE).

12.1.23 e superiores
convertTempTableToJsonArray

 Converte uma TEMP-TABLE handle para um JSONArray, podendo optar pela omissão dos valores iniciais.

Exemplo

Assign oJsonArray = JsonAPIUtils:ConvertTempTableToJsonArray(INPUT TEMP-TABLE RowErrors:HANDLE, INPUT YES).

12.1.23 e superiores
convertTempTableFirstItemToJsonObject

Converte uma TEMP-TABLE handle para um single JSONObject.

Exemplo

RETURN JsonAPIUtils:convertTempTableFirstItemToJsonObject(INPUT TEMP-TABLE ttDados:HANDLE).

12.1.23 e superiores
convertTempTableFirstItemToJsonObject

Converte uma TEMP-TABLE handle para um single JSONObject, podendo optar pela omissão dos valores iniciais.

Exemplo

RETURN JsonAPIUtils:convertTempTableFirstItemToJsonObject(INPUT TEMP-TABLE ttDados:HANDLE, INPUT YES).

12.1.23 e superiores
convertDataSetToJsonObject

Converte um DATASET handle para um JSONObject.

Exemplo

ASSIGN OJsonObject = JsonAPIUtils:convertDataSetToJsonObject (INPUT hDSImp).

12.1.24 e superiores
convertDataSetToJsonObject

Converte um DATASET handle para um JSONObject, podendo optar pela omissão dos valores iniciais.

Exemplo

ASSIGN OJsonObject = JsonAPIUtils:convertDataSetToJsonObject (INPUT hDSImp, INPUT YES).

12.1.24 e superiores
convertDataSetToJsonArray

Converte um DATASET handle para um JSONArray.

Exemplo

ASSIGN OJSONArray = JsonAPIUtils:convertDataSetToJsonArray (INPUT hDSImp).

12.1.24 e superiores
convertDataSetToJsonArray

Converte um DATASET handle para um JSONArray, podendo optar pela omissão dos valores iniciais.

Exemplo

ASSIGN OJSONArray = JsonAPIUtils:convertDataSetToJsonArray (INPUT hDSImp, INPUT YES).

12.1.24 e superiores
convertDataSetFirstItemToJsonObject

Converte um DATASET handle para um single JSONObject.

Exemplo

ASSIGN OJsonObject = JsonAPIUtils:convertDataSetFirstItemToJsonObject (INPUT hDSImp).

12.1.24 e superiores
convertDataSetFirstItemToJsonObject

Converte o primeiro registro de um DATASET handle para um single JSONObject, podendo optar pela omissão dos valores iniciais.

Exemplo

ASSIGN OJsonObject = JsonAPIUtils:convertDataSetFirstItemToJsonObject (INPUT hDSImp, INPUT YES).

12.1.24 e superiores
getTableExceptFieldsBySerializedFields

Retorna a lista de campos da tabela para a lista de exceção com base no nome serializado do campo separados por ','.

Exemplo

ASSIGN cReturn = JsonAPIUtils:getTableExceptFieldsBySerializedFields(vHandle, vFields).

Importante

Este método também pode ser utilizado com Datasets handles.

12.1.23 e superiores
convertPayloadToTempTableAPI

Transfere as informações recebidas no Payload (JsonObject) para a TempTable da API.

Exemplo

JsonAPIUtils:convertPayloadToTempTableAPI(oPayload, TEMP-TABLE ttCustomer:HANDLE).

12.1.2403 e superiores
convertPayloadToTempTablePersistent

Transfere as informações recebidas no Payload (JsonObject) para a TempTable que será utilizada para persistência (TempTable da BO). Utiliza a TempTable da API para fazer o de-para da propriedade do Json para o campo de tabela.

Exemplo

JsonAPIUtils:convertPayloadToTempTablePersistent(oPayload, TEMP-TABLE ttCustomer:HANDLE, TEMP-TABLE customerPersistent:HANDLE).

12.1.2403 e superiores
jsonDataTypeToAblDataType

Retorna o tipo de dado PROGRESS conforme tipo de dado vindo do JSON.

Exemplo

ASSIGN cAblType = JsonAPIUtils:jsonDataTypeToAblDataType(jsonType).

12.1.23 e superiores
convertAblTypeToHtmlType

Converte o tipo de dado Progress em tipo HTML.

Exemplo

ASSIGN cHtmlType = JsonAPIUtils:convertAblTypeToHtmlType(cAblType).

12.1.23 e superiores
convertToCamelCase

Converte uma string para o padrão CamelCase. Exemplo: "aaa.BBB.ccc" em "aaaBbbCcc".

Exemplo

ASSIGN cKeyCamCase = JsonAPIUtils:convertToCamelCase(cKey).

12.1.23 e superiores
getIdField

Retorna um JSONObject com o ID para ser utilizado nas telas HTML.

Exemplo

ASSIGN oField = JsonAPIUtils:getIdField().

12.1.23 e superiores
uploadFileAppserver

Efetua a geração de um ou mais arquivo(s) físico(s) de acordo com os parâmetros do Upload.

A funcionalidade considera os parâmetros multiPartFile, fileName e content para a geração do arquivo.

Caso o arquivo seja gerado com sucesso, o nome do arquivo será o mesmo do parâmetro fileName e retornado endereço onde o(s) arquivo(s) estão armazenados (pertencente ao diretório temporário do AppServer).

O formato de diretório seguirá um padrão de acordo com o código do usuário, data e hora. 

Exemplo nome do diretório: #super#2020082051097 

Exemplo

DEFINE NEW GLOBAL SHARED VARIABLE v_cod_usuar_corren AS CHARACTER NO-UNDO.

...

DEFINE INPUT PARAMETER jsonInput AS JsonObject  NO-UNDO.

DEFINE VARIABLE cTempDir              AS CHARACTER NO-UNDO.

...

ASSIGN cTempDir = JsonAPIUtils:uploadFileAppserver(INPUT jsonInput, INPUT v_cod_usuar_corren).

12.1.31 e superiores
deleteUploadDirectory

Efetua a eliminação do diretório e todos os seus arquivos pertencente ao mesmo.

Somente será possível eliminar o diretório pertencente ao parâmetro do usuário enviado à função.

Caso o diretório seja corretamente eliminado, retornará um valor lógico true. Se apresentar alguma inconsistência na eliminação, ocorrerá uma exceção Progress.Lang.AppError.

Exemplo: 

  • Parâmetro do diretório: /tmp/#super#20200820532827;
  • Somente será permitido eliminar o diretório acima caso o código do usuário for super.

Exemplo

DEFINE NEW GLOBAL SHARED VARIABLE v_cod_usuar_corren AS CHARACTER NO-UNDO.

...

DEFINE VARIABLE uploadDir    AS CHARACTER NO-UNDO.

DEFINE VARIABLE deleteStatus AS LOGICAL      NO-UNDO.

...

ASSIGN deleteStatus = JsonAPIUtils:deleteUploadDirectory(INPUT uploadDir, INPUT v_cod_usuar_corren).

12.1.31 e superiores
getStackTraceError

Retorna o Stack Trace do Erro.

Exemplo

ASSIGN cStackTraceError = JsonAPIUtils:getStackTraceError(oError).

12.1.2403 e superiores