Получить историю отчетов

GET
https://api.digicert.com/reports/v1/report/history

Используйте эту конечную точку для получения сведений обо всех отчетах, создание которых в настоящее время запланировано.

Для успешного ответа этой конечной точки функция библиотеки отчетов должна быть включена в вашей учётная запись.

cURL
curl -X GET \
  'https://www.digicert.com/services/v2/reports/preview/report/history' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
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)
Go
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))
}
NodeJS
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);
});
204 No Content
{
    "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"
        }
    ]
}
400 Invalid offset
{
    "code": "invalid_offset",
    "message": "Offset should be zero or positive integer"
}
400 Invalid limit
{
"code": "invalid_limit",
"message": "Limit should be positive integer"
}
401 Invalid user
{
"code": "user_authentication_error",
"message": "User is not authenticated."
}
403 Forbidden
{
    "code": "user_forbidden",
    "message": "User does not have the required permission."
}
403 Not enabled
{
    "code": "custom_reports_not_enabled",
    "message": "Custom reports is not enabled"
}

Параметры запроса

Имя Обязательный/Необязательный Тип Описание
offset необязательный integer Количество записей для включения в ответ. Должно быть больше 0 или равно 0. По умолчанию: 0.
limit необязательный integer Количество страниц для включения в ответ. По умолчанию: 100.
report_display_name необязательный string Имя отображаемого отчета. Имена отчетов разделяются запятой.
schedule необязательный string Периодичность создания отчетов. Возможные значения: ON_DEMAND, WEEKLY, MONTHLY.
status необязательный string Статус отчета. Все запланированные отчеты — ACTIVE.
report_type необязательный string Тип отчета.
search необязательный string Условие следует использовать в качестве фильтра для поиска. Поддерживается частичный поиск.
sort_by необязательный string Параметр, в соответствии с которым будет осуществляться сортировка. Поддерживаемые параметры сортировки: report_display_name, report_type, schedule, format. Если параметр sort_by не указан, по умолчанию используется report_start_date.
sort_direction необязательный string Может осуществляться в следующем порядке: ASC (по возрастанию) или DESC (по убыванию). По умолчанию: ASC,, если только столбец сортировки и sort_direction содержат данные. В этом случае сортировка будет осуществлять на основе report_start_date (сортировка по умолчанию) в следующем порядке: DESC.

Параметры ответного сообщения

Имя Тип Описание
page object Контейнер
.. total integer Количество отчетов, запланированных для создания.
.. limit integer Количество страниц для включения в ответ. По умолчанию: 100.
.. offset integer Количество записей для включения в ответ. Должно быть больше 0 или равно 0. По умолчанию: 0.
report_history container Контейнер.
.. report_display_name string Имя отображаемого отчета. Имена отчетов разделяются запятой.
.. report_identifier string Идентификатор отчета, отображаемый в ответе Создать отчет API.
.. report_run_identifier string Идентификатор (ID), связанный с созданием отчета. Это значение отображается в Создать отчет API.
.. created_by_user_id string Идентификатор пользователя, связанный лицом, создающим отчет.
.. created_date string Дата создания отчета, включая временную метку в формате: ГГ-ММ-ДД ЧЧ-ММ-СС.
.. created_by_user_name string Имя пользователя Digicert, связанное с созданием отчета.
.. report_type string Тип отчета. См. Список поддерживаемых типов отчетов API для ознакомления с дополнительной информацией.
.. report_type_display_name string Имя, указанное в качестве типа отчета.
.. report_start_date date Начальная дата создания отчета. Формат: ГГ-ММ-ДД.
.. report_end_date date Конечная дата создания отчета. Формат: ГГ-ММ-ДД.
.. schedule string Периодичность создания отчетов. Возможные значения: ON_DEMAND, WEEKLY, MONTHLY.
.. format string Формат отчета Возможное значение этой конечной точки: CSV. Для возврата отчет в формате JSON см. Получить отчет JSON API.
.. status string Статус отчета. Допустимые значения: GENERATING, READY, FAILED, SCHEDULED.
.. manually_triggered boolean Создается ли отчет вручную или системой.