Las solicitudes de ejemplo en este tema utilizan la sintaxis Curl para mostrar toda la información que se requiere en una solicitud, como los encabezados, métodos, puntos finales y datos de la solicitud, así como los parámetros obligatorios y opcionales. Además, para cada solicitud, la misma información de encabezado se muestra en un bloque separado para su uso cuando se conecta a la API de Data360 Govern a través de un cliente API.
1. Identificar el OwningAssetUid
Los resultados de las reglas deben estar vinculados a una regla que exista en su sistema. Para relacionar los resultados de las reglas con la regla, debe utilizar el valor del UID de la regla (OwningAssetUid
) en su solicitud.
Puede obtener el valor del UID de una regla navegando hasta la página de detalles de la regla.
2. Publicar los resultados de la regla en Data360 Govern
Utilice el punto de conexión POST /api/v2/metrics/quality/results
para cargar los resultados de calidad de datos a la regla especificada.
Solicitud de ejemplo
En la solicitud debe incluir la siguiente información:
- El
OwningAssetUid
(valor de UID de la regla) que obtuvo en el paso 1 - Los valores resultantes para
PassCount
yFailCount
EffectiveDate
yRunDate
del resultado de la regla, que no puede ser una fecha futura. Debe utilizar el formatoyyyy-MM-dd
para la fecha efectiva y el formatoyyyy-MM-dd HH:mm:ss
para la fecha de ejecución.
Opcionalmente, también puede incluir la siguiente información:
EvaluatedAssetUid
: El valor del UID de un activo técnico o empresarial con el que desea relacionar el resultado de la regla. Si proporciona esta información, el activo no debe estar en estado inactivo y debe tener los permisos necesarios para el activo.ExecutionItemUid
: un valor de UID para identificar la solicitud. Si no proporciona un valor, se generará automáticamente uno y se devolverá en la respuesta. Se necesitará este valor si utiliza el punto de conexión PUT/api/v2/metrics/quality/results
.
En este ejemplo se publican los resultados de calidad de datos de una regla que tiene el siguiente valor UID: 99533c04-142d-48c5-b7e8-f4e02c990085
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '[ \ { \ "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085", \ "EffectiveDate": "2020-04-22", \ "RunDate": "2020-04-22 10:10:20", \ "PassCount": 20, \ "FailCount": 0 \ } \]' 'https://example.data3sixty.com/api/v2/metrics/quality/results'
El siguiente ejemplo muestra la información del encabezado para la misma solicitud para su uso al conectarse a la API de Data360 Govern a través de un cliente API:
POST https://example.data3sixty.com/api/v2/metrics/quality/results HTTP/1.1 Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/json
Cuerpo de la solicitud:
[ { "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085", "EffectiveDate": "2020-04-22", "RunDate": "2020-04-22 10:10:20", "PassCount": 20, "FailCount": 0 }]
Respuesta de ejemplo
[ { "Uid": "02c85456-da74-41ef-905d-6cf2d493dc9e", "ExecutionItemUid": "4b5ef5be-cb43-4ba0-85ac-1fce602aa80c", "Success": true }]
Uid
devuelto en la respuesta (02c85456-da74-41ef-905d-6cf2d493dc9e
) es el UID del resultado de la regla. Puede utilizar este valor con el punto de conexión PUT /api/v2/metrics/quality/results
si desea actualizar algún campo. Consulte Actualización de los resultados de las reglas.Si su solicitud se aprueba correctamente, verá los resultados actualizados de calidad de datos para la regla especificada en la página Reglas de la IU.
Para obtener más información sobre las reglas de calidad de datos, consulte Reglas de calidad.
Actualización de los resultados de las reglas
Una vez que haya cargado el resultado de una regla, puede utilizar el punto de conexión PUT /api/v2/metrics/quality/results
para actualizarlo. Por ejemplo, para relacionar un activo empresarial específico con el resultado de la regla.
1. Identificar el UID del resultado de la regla
El UID del resultado de la regla se devuelve con la respuesta cuando utiliza el punto de conexión /api/v2/metrics/quality/results
de POST. En el ejemplo anterior de este tema, el valor Uid
era 02c85456-da74-41ef-905d-6cf2d493dc9e
.
Si no tiene este valor disponible, puede obtener el valor UID de un resultado de regla navegando hasta la ficha Resultados de las reglas de un activo de regla en la aplicación. Como alternativa, puede utilizar el punto de conexión GET /api/v2/metrics/quality/results
de la siguiente manera:
Solicitud de ejemplo
curl -X GET --header 'Accept: application/json' 'https://example.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085'
El siguiente ejemplo muestra la información del encabezado para la misma solicitud para su uso al conectarse a la API de Data360 Govern a través de un cliente API:
https://documentation-igx.preview.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085 HTTP/1.1 Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/json
Respuesta de ejemplo
{ "pageSize": 250, "pageNum": 1, "total": 2, "items": [ { "ResultUid": "02c85456-da74-41ef-905d-6cf2d493dc9e", "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085", "EvaluatedAssetUid": "00000000-0000-0000-0000-000000000000", "EffectiveDate": "2020-04-22T00:00:00.000Z", "RunDate": "2020-04-22T10:10:20.000Z", "PassCount": 20, "FailCount": 0, "Passed": true }, { "ResultUid": "984bfc0c-bdbe-411e-8482-84b13133a7d3", "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085", "EvaluatedAssetUid": "00000000-0000-0000-0000-000000000000", "EffectiveDate": "2020-04-22T00:00:00.000Z", "RunDate": "2020-04-22T10:10:20.000Z", "PassCount": 20, "FailCount": 0, "Passed": true } ]}
La respuesta incluye el UID del resultado de la regla: "ResultUid": "02c85456-da74-41ef-905d-6cf2d493dc9e"
2. Actualizar el resultado de la regla
En este ejemplo, un activo empresarial con un valor UID de 8dab72ca-5679-4144-8395-b1850ff39278
se agrega al resultado de la regla, este es el valor de EvaluatedAssetUid
. Puede obtener el valor del UID de un activo navegando hasta la página de detalles del activo.
Solicitud de ejemplo
curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '[ \ { \ "Uid": "99533c04-142d-48c5-b7e8-f4e02c990085", \ "EvaluatedAssetUid": "8dab72ca-5679-4144-8395-b1850ff39278", \ } \]' 'https://example.data3sixty.com/api/v2/metrics/quality/results'
El siguiente ejemplo muestra la información del encabezado para la misma solicitud para su uso al conectarse a la API de Data360 Govern a través de un cliente API:
PUT https://example.data3sixty.com/api/v2/metrics/quality/results HTTP/1.1 Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/json
Cuerpo de la solicitud:
[ { "Uid": "02c85456-da74-41ef-905d-6cf2d493dc9e", "EvaluatedAssetUid": "8dab72ca-5679-4144-8395-b1850ff39278" }]
En este ejemplo, el EvaluatedAssetUid
se proporciona en la solicitud PUT. Debe incluir al menos uno de los siguientes cuatro campos opcionales en la solicitud:
EvaluatedAssetUid
RunDate
PassCount
FailCount
Cualquier campo que no proporcione no se actualizará.
Respuesta de ejemplo
[ { "Uid": "02c85456-da74-41ef-905d-6cf2d493dc9e", "ExecutionItemUid": "628b96bb-2964-4485-817e-abfc18ff675f", "Success": true }]
3. Comprobar que se ha actualizado el resultado de la regla
Después de actualizar el resultado de la regla mediante el punto de conexión PUT, puede utilizar de nuevo el punto de conexión GET para verificar que EvaluatedAssetUid
se haya agregado al resultado de la regla. El punto de conexión GET utiliza el UID de la regla (OwningAssetUid) que se obtuvo en el primer paso de este tema.
Solicitud de ejemplo
curl -X GET --header 'Accept: application/json' 'https://example.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085'
El siguiente ejemplo muestra la información del encabezado para la misma solicitud para su uso al conectarse a la API de Data360 Govern a través de un cliente API:
https://documentation-igx.preview.data3sixty.com/api/v2/metrics/quality/results?_owningAssetUid=99533c04-142d-48c5-b7e8-f4e02c990085 HTTP/1.1 Authorization: <API Key>;<API Secret> Content-Type: application/json Accept: application/json
Respuesta de ejemplo
La respuesta muestra que la solicitud PUT se ha realizado correctamente y que EvaluatedAssetUid
(8dab72ca-5679-4144-8395-b1850ff39278
) se ha agregado al resultado de la regla (02c85456-da74-41ef-905d-6cf2d493dc9e
).
{ "pageSize": 250, "pageNum": 1, "total": 2, "items": [ { "ResultUid": "02c85456-da74-41ef-905d-6cf2d493dc9e", "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085", "EvaluatedAssetUid": "8dab72ca-5679-4144-8395-b1850ff39278", "EffectiveDate": "2020-04-22T00:00:00.000Z", "RunDate": "2020-04-22T10:10:20.000Z", "PassCount": 20, "FailCount": 0, "Passed": true }, { "ResultUid": "984bfc0c-bdbe-411e-8482-84b13133a7d3", "OwningAssetUid": "99533c04-142d-48c5-b7e8-f4e02c990085", "EvaluatedAssetUid": "00000000-0000-0000-0000-000000000000", "EffectiveDate": "2020-04-22T00:00:00.000Z", "RunDate": "2020-04-22T10:10:20.000Z", "PassCount": 20, "FailCount": 0, "Passed": true } ]}