Use este terminal para obtener todos los informes actualmente programados para su generación.
La función Biblioteca de informes debe estar habilitada en su cuenta para que este terminal responda correctamente.
curl -X GET \
'https://www.digicert.com/services/v2/reports/preview/report/history' \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}'
import requests
url = "https://www.digicert.com/services/v1/reports/preview/reporth/history"
payload={}
headers = {
'Content-Type': 'application/json',
'X-DC-DEVKEY': {{api_key}},
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v1/reports/preview/report/history"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("X-DC-DEVKEY", {{api_key}})
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://www.digicert.com/services/v1/reports/preview/report/history',
'headers': {
'Content-Type': 'application/json',
'X-DC-DEVKEY': {{api_key}},
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
{
"page": {
"total": 1,
"limit": 1,
"offset": 0
},
"report_history": [
{
"report_display_name": "RPT01",
"report_identifier": "52150de8-3c97-4802-bc18-e419d2c713fc",
"report_run_identifier": "84604797-430a-470a-bb0d-156de649b92c",
"created_by_user_id": 10192344,
"created_by_user_name": "Abhijeeta Mohanty",
"created_date": "2021-01-13 02:15:48",
"report_type": "orders",
"report_type_display_name": "Orders",
"report_start_date": "2021-01-13 09:15:37",
"report_end_date": "2021-01-13 09:15:48",
"schedule": "WEEKLY",
"format": [
"CSV" /
],
"status": "READY"
}
]
}
{
"code": "invalid_offset",
"message": "Offset should be zero or positive integer"
}
{
"code": "invalid_limit",
"message": "Limit should be positive integer"
}
{
"code": "user_authentication_error",
"message": "User is not authenticated."
}
{
"code": "user_forbidden",
"message": "User does not have the required permission."
}
{
"code": "custom_reports_not_enabled",
"message": "Custom reports is not enabled"
}
Nombre | Solicitud/opción | Tipo | Descripción |
---|---|---|---|
offset | opcional | integer | La cantidad de registros a incluir en la respuesta. Debe ser mayor o igual a 0. Valor predeterminado: 0. |
limit | opcional | integer | La cantidad de páginas a incluir en la respuesta. Valor predeterminado: 100. |
report_display_name | opcional | string | El nombre del informe que se muestra. Varios nombres de informes se separan con coma. |
schedule | opcional | string |
La frecuencia de creación de informes. Posibles valores: ON_DEMAND, WEEKLY, MONTHLY .
|
status | opcional | string |
El estado del informe. Todos los informes programados son ACTIVE .
|
report_type | opcional | string | El tipo de informe. |
search | opcional | string | El término a utilizar como filtro de búsqueda. Se admite la búsqueda parcial. |
sort_by | opcional | string |
El parámetro sobre el cuál se hará la ordenación. Parámetros admitidos para la ordenación: report_display_name, report_type, schedule, format . Si no se proporciona ningún parámetro sort_by , el valor predeterminado es report_start_date .
|
sort_direction | opcional | string |
La dirección puede ser ASC (ascendente) o DESC (descendente). El valor predeterminado es ASC , a menos que la columna de orden y sort_direction estén vacías. En este caso, el orden se basará en report_start_date (columna de orden predeterminada) en orden DESC .
|
Nombre | Tipo | Descripción |
---|---|---|
page | object | Contenedor |
.. total | integer | El número de informes programados para su generación. |
.. limit | integer | La cantidad de páginas a incluir en la respuesta. Valor predeterminado: 100. |
.. offset | integer | La cantidad de registros a incluir en la respuesta. Debe ser mayor o igual a 0. Valor predeterminado: 0. |
report_history | container | Contenedor. |
.. report_display_name | string | El nombre del informe que se muestra. Varios nombres de informes se separan con coma. |
.. report_identifier | string | Id. de informe mostrada en la respuesta de la API crear informe. |
.. report_run_identifier | string | La Id. asociada con la generación del informe. Este valor se muestra en la API crear informe. |
.. created_by_user_id | string | La Id. de usuario asociada con la persona que crea el informe. |
.. created_date | string | La fecha de creación del informe, incluida la marca de tiempo en formato: AA-MM-DD HH--MM-SS. |
.. created_by_user_name | string | El nombre de usuario de DigiCert asociado con la creación del informe. |
.. report_type | string | El tipo de informe. Consulte la API Lista de tipos de informes admitidos para obtener más información. |
.. report_type_display_name | string | El nombre especificado como tipo de informe. |
.. report_start_date | date | La fecha de inicio para la creación del informe. Formato: AA-MM-DD. |
.. report_end_date | date | La fecha de finalización para la creación del informe. Formato: AA-MM-DD. |
.. schedule | string |
La frecuencia de creación de informes. Posibles valores: ON_DEMAND, WEEKLY, MONTHLY .
|
.. format | string |
El formato del informe. Para este terminal, el posible valor es CSV . Para devolver un informe en JSON, consulte la API obtener informe en JSON.
|
.. status | string |
El estado del informe. Los valores permitidos son GENERATING, READY, FAILED, SCHEDULED .
|
.. manually_triggered | boolean | Si la generación del informe es manual o si el informe es generado por el sistema. |