FrameAppWS

<back to all web services

DefinicionProcedimientoRQ

Requires Authentication
The following routes are available for this service:
All Verbs/Utilidades/Procedimientos/Definicion
"use strict";
export class IdentificadoresFunciones {
    /** @param {{AliasFuncion?:string,NombreFuncion?:string,Descripcion?:string,TipoRespuesta?:string,Background?:string,UsuarioCreo?:string,FechaCreacion?:string,Consecutivo?:number,TipoExport?:string,Ayuda?:string,Endpoint?:string,ConsumeAPI?:string,APIRest?:string,PropiedadRest?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AliasFuncion;
    /** @type {string} */
    NombreFuncion;
    /** @type {string} */
    Descripcion;
    /** @type {string} */
    TipoRespuesta;
    /** @type {string} */
    Background;
    /** @type {string} */
    UsuarioCreo;
    /** @type {string} */
    FechaCreacion;
    /** @type {number} */
    Consecutivo;
    /** @type {string} */
    TipoExport;
    /** @type {string} */
    Ayuda;
    /** @type {string} */
    Endpoint;
    /** @type {string} */
    ConsumeAPI;
    /** @type {string} */
    APIRest;
    /** @type {string} */
    PropiedadRest;
}
export class DefinicionParametro {
    /** @param {{Direccion?:string,IdVista?:number,TipoDato?:string,NombreParametro?:string,Alias?:string,Ayuda?:string,DatosLookup?:{ [index:string]: Object; }[],CampoTexto?:string,CampoValor?:string,Version?:string,Obligatorio?:boolean,ValorDefecto?:string,Visible?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Direccion;
    /** @type {?number} */
    IdVista;
    /** @type {string} */
    TipoDato;
    /** @type {string} */
    NombreParametro;
    /** @type {string} */
    Alias;
    /** @type {string} */
    Ayuda;
    /** @type {{ [index:string]: Object; }[]} */
    DatosLookup;
    /** @type {string} */
    CampoTexto;
    /** @type {string} */
    CampoValor;
    /** @type {string} */
    Version;
    /** @type {boolean} */
    Obligatorio;
    /** @type {string} */
    ValorDefecto;
    /** @type {boolean} */
    Visible;
}
export class PermisosFunciones {
    /** @param {{CodigoSistema?:number,CodigoEmpresa?:number,AliasFuncion?:string,Usuario?:string,UsuarioCreo?:string,FechaCreacion?:string,IP?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CodigoSistema;
    /** @type {number} */
    CodigoEmpresa;
    /** @type {string} */
    AliasFuncion;
    /** @type {string} */
    Usuario;
    /** @type {string} */
    UsuarioCreo;
    /** @type {string} */
    FechaCreacion;
    /** @type {string} */
    IP;
}
export class UltimoEstado {
    /** @param {{CodigoEjecucion?:number,Estado?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CodigoEjecucion;
    /** @type {string} */
    Estado;
}
export class DefinicionProcedimientoRS {
    /** @param {{Procedimiento?:IdentificadoresFunciones,Parametros?:DefinicionParametro[],Permisos?:PermisosFunciones[],UltimoEstado?:UltimoEstado,Error?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IdentificadoresFunciones} */
    Procedimiento;
    /** @type {DefinicionParametro[]} */
    Parametros;
    /** @type {PermisosFunciones[]} */
    Permisos;
    /** @type {UltimoEstado} */
    UltimoEstado;
    /** @type {string} */
    Error;
}
export class VersionLookup {
    /** @param {{CodLookup?:number,Version?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CodLookup;
    /** @type {string} */
    Version;
}
/** @typedef {'ES'|'PT'|'EN'} */
export var Lenguajes;
(function (Lenguajes) {
    Lenguajes["ES"] = "ES"
    Lenguajes["PT"] = "PT"
    Lenguajes["EN"] = "EN"
})(Lenguajes || (Lenguajes = {}));
export class DefinicionProcedimientoRQ {
    /** @param {{Consecutivo?:number,VersionesLookupCliente?:VersionLookup[],DatosLookups?:boolean,Lenguaje?:Lenguajes}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Consecutivo;
    /** @type {VersionLookup[]} */
    VersionesLookupCliente;
    /** @type {boolean} */
    DatosLookups;
    /** @type {Lenguajes} */
    Lenguaje;
}

JavaScript DefinicionProcedimientoRQ DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Utilidades/Procedimientos/Definicion HTTP/1.1 
Host: soluser-recaudo.sgsas.co 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Consecutivo":0,"VersionesLookupCliente":[{"CodLookup":0,"Version":"String"}],"DatosLookups":false,"Lenguaje":"ES"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Procedimiento":{"AliasFuncion":"String","NombreFuncion":"String","Descripcion":"String","TipoRespuesta":"String","Background":"String","UsuarioCreo":"String","FechaCreacion":null,"Consecutivo":0,"TipoExport":"String","Ayuda":"String","Endpoint":"String","ConsumeAPI":"String","APIRest":"String","PropiedadRest":"String"},"Parametros":[{"Direccion":"String","IdVista":0,"TipoDato":"String","NombreParametro":"String","Alias":"String","Ayuda":"String","DatosLookup":[{"String":{}}],"CampoTexto":"String","CampoValor":"String","Version":"String","Obligatorio":false,"ValorDefecto":"String","Visible":false}],"Permisos":[{"CodigoSistema":0,"CodigoEmpresa":0,"AliasFuncion":"String","Usuario":"String","UsuarioCreo":"String","FechaCreacion":null,"IP":"String"}],"UltimoEstado":{"CodigoEjecucion":0,"Estado":"String"},"Error":"String"}