Получить отчет по идентификатору

GET
https://api.digicert.com/reports/v1/report/{{report_identifier}}

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

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

cURL
curl -X GET \
  'https://www.digicert.com/services/v2/reports/preview/report/{{report_identifier}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
import requests

url = "https://www.digicert.com/services/v1/reports/preview/report/{{report-identifier}}"

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/{{report-identifier}}"
  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/{{report-identifier}}',
  '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);
});
200 OK
{
    "report": {
        "report_display_name": "RPT01",
        "report_identifier": "b80de6e4-f085-4488-a47f-b7b5ea07e05e",
        "created_by_user_id": 10192361,
        "created_by_user_name": "venkat patil",
        "created_date": "2021-01-13 09:43:17",
        "report_metadata": {
            "columns": [
                {
                    "identifier": "account_id"
                },
                {
                    "identifier": "number_of_sans"
                },
                {
                    "identifier": "certificate_id"
                },
                {
                    "identifier": "certificate_validity_days"
                },
                {
                    "identifier": "container_id"
                },
                {
                    "identifier": "container_name"
                }
            ],
            "report_type": "orders"
        },
        "schedule": {
            "frequency": "WEEKLY", //Possible values ON_DEMAND,WEEKLY,MONTHLY
            "weekday_to_run": "WEDNESDAY", // Possible values SUNDAY to SATURDAY, ""
            "weekday_frequency": "", // Possible values FIRST, SECOND, THIRD, FOURTH, LAST, ""
            "run_until": "2021-12-23"
        },
        "next_run_date": "2021-01-20",
         "format": [
            "CSV" // Possible value only CSV
        ],
        "status": "ACTIVE"  // Always ACTIVE
    }
}
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"
}
404 Report not found
{
    "code": "reports_not_found",
    "message": "Report with the given identifier does not exist."
}
404 Page not found
404 page not found

Параметры пути

Имя Обязательный/Необязательный Тип Описание
report-identifier обязательный string Идентификатор отчета, отображаемый в ответе Создать отчет API.

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

Имя Тип Описание
report object Контейнер.
report_display_name string Указанное имя отчета.
.. report_identifier string Идентификатор отчета, отображаемый в ответе Создать отчет API.
.. created_by_user_id string Идентификатор пользователя, связанный лицом, создающим отчет.
.. created_date string Дата создания отчета, включая временную метку в формате: ГГ-ММ-ДД ЧЧ-ММ-СС.
.. created_by_user_name string Имя пользователя, связанное с созданием отчета.
.. report_metadata object Контейнер.
.. .. columns object Типы столбцов, указываемых в отчете.
.. .. .. identifier string Идентификатор столбца, поддерживаемого API библиотеки отчетов. Список всех поддерживаемых столбцов см. в разделе Столбцы API библиотеки отчетов.
.. .. report_type string Тип отчета.
.. schedule object Контейнер.
.. .. frequency string Периодичность создания отчетов. Возможные значения: ON_DEMAND, WEEKLY, MONTHLY. Значения вводятся с учетом регистра клавиатуры.
.. .. weekday_to_run string День недели создания отчета. Возможные значения: SUNDAYSATURDAY. Значения вводятся с учетом регистра клавиатуры.
.. .. weekday_frequency string Количество раз создания отчета в рабочий день. Возможные значения: FIRST, SECOND, THIRD, FOURTH, LAST. Значения вводятся с учетом регистра клавиатуры.
.. .. run_until date Дата завершения создания данного отчета. Формат: ГГ-ММ-ДД.
.. next_run_date date Дата возобновления создания данного отчета. Формат: ГГ-ММ-ДД.
.. format string Формат отчета Возможное значение этой конечной точки: CSV. Для возврата отчет в формате JSON см. Получить отчет JSON API.
.. status string Статус отчета. Все запланированные отчеты — ACTIVE.