Características comuns às funcionalidades do Workflow

PREFIXO DA URL

Todas as URLs das funcionalidades de gestão de eventos do módulo Workflow são precedidas pelo endereço de serviço do módulo Workflow, por exemplo: https://riskmanager.modulo.com/Workflow.Services.Web

Neste documento, esse endereço é identificado por "{WSUrl}".

SOLICITAÇÃO

Todos os objetos são enviados da forma bare (sem codificação) e podem ter o formato JSON ou XML. O tipo deve ser especificado no header Content-Type. Para obter mais detalhes, veja Orientações técnicas -> Content-Type.

RESPOSTA

Todos os objetos retornados são enviados da forma bare (sem codificação) e podem ter o formato JSON ou XML, conforme especificado no header Accept ou Content-Type. Para obter mais detalhes, veja o tópico Orientações técnicas -> Accept.

RESPOSTA DE ERRO

Caso ocorra um erro durante a execução da funcionalidade, será retornado um objeto JSON no seguinte formato:

{

string error;

string error_description;

string error_uri;

string[] error_details;

ApiApplicationError[] app_errors;

}

O objeto ApiApplicationError tem o seguinte formato:

ApiApplicationError

{

string error_code;

string parameter_name;

string[] values;

}

Dependendo do error_code, poderá ser retornado um parameter_name e uma lista de valores. Verifique o significado de cada um na seção Tratamento de erros -> Erros detalhados da API.