La API de datos de referencia permite acceder a los datos de las soluciones de datos de referencia. Esta API también admite filtros de OData limitados. La API usa el método GET para acceder a los datos.
Solicitud y respuesta
Para acceder a las soluciones de datos de referencia, la estructura de solicitud y respuesta será la siguiente:
Formato de fecha: AAAA-MM-DD
Decimal: Ningún separador de miles y el punto será el separador decimal, por ejemplo, 23232.56
Contrato de datos de solicitud:
La API de datos de referencia no necesita un cuerpo de solicitud.
Para su ejecución, la API de datos de referencia necesita los tres parámetros que se mencionan a continuación:
-
AppName: Nombre de la aplicación donde se crea la solución de datos de referencia.
-
LibraryName: Nombre de la biblioteca donde se crea la solución de datos de referencia.
-
RefSolutionName: Nombre de la solución de datos de referencia a la que se accederá.
El siguiente ejemplo muestra el uso de la API:
Datos de solicitud:
Ejemplo 1
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=refsolution
Ejemplo 2
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068
Ejemplo 3
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068 and Bitfield eq true
Ejemplo 4
{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068 and Bitfield eq true
Contrato de datos de respuesta:
El cuerpo de respuesta dependerá de la solución a la que se acceda.
Datos de respuesta
"@odata.context": "https://cha-en-vst679.wsdt.local:443/svr/api/v1/ReferenceData?AppName=Reference%20Data&LibraryName=Reference%20Data%20Lists&SolutionName=ReferenceiList11Items100", "value": [ { "username": "wsdt\\devuser5", "CreatedOn": "2020-01-21", "empid": 1059, "decimalfield": 666.77, "Bitfield": true }, { "username": "wsdt\\devuser6", "CreatedOn": "2020-01-22", "empid": 1060, "decimalfield": 667.77, "Bitfield": true }, { "username": "wsdt\\devuser7", "CreatedOn": "2020-01-23", "empid": 1061, "decimalfield": 668.77, "Bitfield": true }, { "username": "wsdt\\devuser10", "CreatedOn": "2020-01-26", "empid": 1064, "decimalfield": 671.77, "Bitfield": true }, { "username": "wsdt\\devuser11", "CreatedOn": "2020-01-27", "empid": 1065, "decimalfield": 672.77, "Bitfield": true }....
Respuesta de parámetros no válidos:
Parámetros no válidos
[ { "ErrorCode": "Invalid_data", "Message": "LibraryName, SolutionName or AppName does not exists.", "errorPrameters": null } ]