swagger: '2.0'
info:
title: "SIFCO_REST_API"
version: "1.0"
description: "La presente documentación busca detallar los métodos que permite ejecutar este **Web Services**, el cual permite consultar el Listado de Campos Definidos por el Administrador del Sistema, como calificadores adicionales para los Clientes registrados en la **Aplicación SIFCO WEB** ."
termsOfService: "https://sifco.org/sobre-nosotros/"
contact:
email: "soporte@sifco.org"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
- http
basePath: /<APPDIR>/rest
tags:
- name: "WSApCamposDefinidosUsuarioLista"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/pAGp"
produces:
- application/json
paths:
/WSApCamposDefinidosUsuarioLista:
post:
tags:
- WSApCamposDefinidosUsuarioLista
operationId: "WSApCamposDefinidosUsuarioLista"
summary: "Listado de Campos Definidos por el Administrador del Sistema"
parameters:
- in: header
name: Content-Type
type: "string"
required: true
default: application/json
- in: header
name: Authorization
type: "string"
required: true
default: OAuth <Access Token>
- in: header
name: GENEXUS-AGENT
type: "string"
required: true
default: SmartDevice Application
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/WSApCamposDefinidosUsuarioListaOutput"
401:
description: "Not Authenticated"
schema:
$ref: "#/definitions/GxJsonError"
404:
description: "Not found"
schema:
$ref: "#/definitions/GxJsonError"
400:
description: "Bad request"
schema:
$ref: "#/definitions/GxJsonError"
500:
description: "Internal server error"
schema:
$ref: "#/definitions/GxJsonError"
security:
- OAuth2: []
ApiKeyAuth1: []
securityDefinitions:
OAuth2:
type: oauth2
flow: password
tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
scopes:
Execute: Permite el metodo tipo GET
Insert: Permite el metodo tipo POST
Update: Permite el metodo tipo PUT
Delete: Permite el metodo tipo DELETE
FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service
ApiKeyAuth1:
type: apiKey
in: header
name: granttype
definitions:
WSApCamposDefinidosUsuarioListaOutput:
properties:
CamposDefinidosUsuarioLista:
description: WSAp Campos Definidos Usuario SDT
type: array
items:
$ref: "#/definitions/WSApCamposDefinidosUsuarioSDT_CampoDefinidoUsuario"
WSApCamposDefinidosUsuarioSDT_CampoDefinidoUsuario:
properties:
CodigoCampo:
description: Código
type: "integer"
format: "int32"
Etiqueta:
description: Etiqueta
type: "string"
Descripcion:
description: Descripción
type: "string"
Tipo:
description: Tipo de Calificador
type: "integer"
format: "int32"
URI:
description: URI
type: "string"
GxJsonError:
properties:
error:
$ref: "#/definitions/GxJsonError.error"
GxJsonError.error:
properties:
code:
description: Codigo de Error
type: "string"
message:
description: Mensaje de Error
type: "string"
x-gx-level: "GxJsonError"
DESCRIPCIÓN.
Este Web Service, permite consultar los Campos Definidos por el Administrador, registrados en la Aplicación SIFCO WEB, los cuales son usados como Calificadores Adicionales, y permiten describir de forma mas detallada al cliente de la Aplicación SIFCO WEB. Ademas de manejar una flexibilidad mayor en la categorización y personalización de los parámetros de los Clientes dentro del Sistema.
Swagger open api macro
swagger: '2.0'
info:
title: "SIFCO_REST_API"
version: "1.0"
termsOfService: "https://sifco.org/sobre-nosotros/"
contact:
email: "soporte@sifco.org"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
- https
- http
basePath: /<APPDIR>/rest
tags:
- name: "WSApCamposDefinidosUsuarioLista"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/pAGp"
produces:
- application/json
paths:
/WSApCamposDefinidosUsuarioLista:
post:
tags:
- WSApCamposDefinidosUsuarioLista
operationId: "WSApCamposDefinidosUsuarioLista"
summary: "Listado de Campos Definidos por el Administrador del Sistema"
parameters:
- in: header
name: Content-Type
type: "string"
required: true
default: application/json
- in: header
name: Authorization
type: "string"
required: true
default: OAuth <Access Token>
- in: header
name: GENEXUS-AGENT
type: "string"
required: true
default: SmartDevice Application
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/WSApCamposDefinidosUsuarioListaOutput"
401:
description: "Not Authenticated"
schema:
$ref: "#/definitions/GxJsonError"
404:
description: "Not found"
schema:
$ref: "#/definitions/GxJsonError"
400:
description: "Bad request"
schema:
$ref: "#/definitions/GxJsonError"
500:
description: "Internal server error"
schema:
$ref: "#/definitions/GxJsonError"
security:
- OAuth2: []
ApiKeyAuth1: []
securityDefinitions:
OAuth2:
type: oauth2
flow: password
tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
scopes:
Execute: Permite el método tipo GET
Insert: Permite el método tipo POST
Update: Permite el método tipo PUT
Delete: Permite el método tipo DELETE
FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
ApiKeyAuth1:
type: apiKey
in: header
name: granttype
definitions:
WSApCamposDefinidosUsuarioListaOutput:
properties:
CamposDefinidosUsuarioLista:
description: WSAp Campos Definidos Usuario SDT
type: array
items:
$ref: "#/definitions/WSApCamposDefinidosUsuarioSDT_CampoDefinidoUsuario"
WSApCamposDefinidosUsuarioSDT_CampoDefinidoUsuario:
properties:
CodigoCampo:
description: Código
type: "integer"
format: "int32"
Etiqueta:
description: Etiqueta
type: "string"
Descripcion:
description: Descripción
type: "string"
Tipo:
description: Tipo de Calificador
type: "integer"
format: "int32"
URI:
description: URI
type: "string"
GxJsonError:
properties:
error:
$ref: "#/definitions/GxJsonError.error"
GxJsonError.error:
properties:
code:
description: Código de Error
type: "string"
message:
description: Mensaje de Error
type: "string"
x-gx-level: "GxJsonError"
EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.
A continuación se muestra una tabla con un ejemplo de una Solicitud y un Respuesta para este Web Service.
METODO POST
Este método para este Web Service en especifico permite Obtenerel Listado de Campos Definidos por el Administrados, registrados en la Aplicación SIFCO WEB
El siguiente ejemplo permite obtener dicho listado de la Aplicación SIFCO WEB.
Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de Mensajes), donde se describe el listado de mensajes que arroja las API’s REST de la Aplicación SIFCO WEB, con su respectiva Descripción.
Note
RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.