order_details

QUERY
https://www.digicert.com/services/v2/reports/query

Используйте данный запрос для получения конкретных данных для всех заказов сертификатов.

Для получения конкретных данных для одного заказа сертификата используйте запрос order_details_by_id.

GraphQL
{
    order_details(valid_till:"2020-10-26",limit:5,sort:["valid_from","DESC"]) {
        id
        common_name
        dns_names
        organization_id
        status
        valid_from
        valid_till
    }
}
200 OK
{
    "data": {
        "order_details": [
            {
                "id": "123456",
                "common_name": "digicert.com",
                "dns_names": null,
                "organization_id": "112233",
                "status": "issued",
                "valid_from": "2019-10-04",
                "valid_till": "2020-10-08"
            },
            {
                "id": "123458",
                "common_name": "dev.digicert.com",
                "dns_names": null,
                "organization_id": "223344",
                "status": "issued",
                "valid_from": "2019-10-03",
                "valid_till": "2020-10-07"
            },
            {
                "id": "123443",
                "common_name": "example.com",
                "dns_names": "sub.example.com,www.example.com",
                "organization_id": "112233",
                "status": "revoked",
                "valid_from": "2019-10-02",
                "valid_till": "2020-10-06"
            },
            {
                "id": "123460",
                "common_name": "example.net",
                "dns_names": "www.example.net",
                "organization_id": "112233",
                "status": "issued",
                "valid_from": "2019-09-30",
                "valid_till": "2020-10-07"
            },
            {
                "id": "123424",
                "common_name": "example.org",
                "dns_names": "test.example.org,monitor.example.org,api.example.org",
                "organization_id": "334455",
                "status": "issued",
                "valid_from": "2019-09-27",
                "valid_till": "2020-10-01"
            }
        ]
    }
}

Аргументы

Включают аргументы запроса для фильтрации, поиска или обработки данных. Несколько аргументов разделяют запятыми. За исключением аргумента сортировки, все аргументы имеют формат ключ:значение (например, status:"issued").

Фильтры

Аргументы фильтров используют для сужения области данных при запросе до указанных значений параметра. Для дальнейшего сужения результатов поиска можно использовать несколько фильтров.

Имя Обязательный/Необязательный Тип Описание
id необязательный int Идентификатор заказа.
status необязательный string Статус заказа.
См. Словарь — Статус заказа
valid_from необязательный string Дата начала срока действия сертификата.
Формат: yyyy-MM-dd
Оператор: >=
valid_till необязательный string Дата окончания срока действия сертификата.
Формат: yyyy-MM-dd
Оператор: <=
container_id необязательный string Идентификатор контейнера.
organization_id необязательный string Идентификатор организации.
product_name_id необязательный string Идентификатор имени продукта.
См. Словарь — Идентификаторы продуктов
serial_number необязательный string Серийный номер сертификата.
signature_hash необязательный string Хэш подписи, используемый для подписания запроса на сертификат.
user_id необязательный string Идентификатор пользователя, разместившего заказ.
date_created необязательный string Дата размещения заказа.
Формат: yyyy-MM-dd HH:mm:ss
Оператор: >=
ca_cert_id необязательный string Идентификатор выпускающего центра сертификации.
common_name необязательный string Имя, защищенное сертификатом.
Используйте % для оператора подобный (например, common_name:"%example.com").
dns_names необязательный string Список дополнительных имен, защищенных сертификатом.
locale необязательный string Региональная настройка заказа.
См. Словарь — Коды региональной настройки
thumbprint необязательный string Отпечаток сертификата.
email необязательный string Письмо с заказом пользователя.

Поиск

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

Имя Обязательный/Необязательный Тип Описание
search необязательный string Поиск по указанным полям содержащейся в них строки.
Используйте % для оператора подобный (например, search:"%example.com").
Поля, по которым производят поиск: id, status, container_id, organization_id, product_name_id, additional_emails, organization_name, product_name, serial_number, user_id, common_name, email

Сортировка и разбивка на страницы

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

Имя Обязательный/Необязательный Тип Описание
сортировка необязательный массив Укажите поле и направление сортировки.
Формат: ["{{field}}","{{direction}}"]
Допустимые значения (поле): valid_till, container_id, organization_id, product_name_id, serial_number, signature_hash, user_id, date_created, ca_cert_id, common_name, dns_names, locale, thumbprint, email
Допустимые значения (направление): ASC, DESC
По умолчанию: ["id","DESC"]
offset необязательный int Начать список с указанного номера для нумерации страниц.
По умолчанию: 0
limit необязательный int Усечь список до указанного номера для нумерации страниц.
Макс.: 1000 (по умолчанию)

Поля

В запрос следует включить как минимум одно поле. Если нет отправленных полей, отображается синтаксическая ошибка.

Если для поля нет данных, отображается значение null.

Имя Тип Описание
account_id string Идентификатор учетной записи, связанный с заказом.
additional_emails string Дополнительные адреса электронной почты в заказе.
agreement_id string Идентификатор согласовавшего CSA.
auto_renew string Укажите, следует ли автоматически продлевать срок действия сертификата.
Допустимые значения: 0 (отключена), 1 (включена)
ca_cert_id string Идентификатор выпускающего центра сертификации.
certificate_tracker_id string Идентификатор сертификата.
common_name string Имя, защищенное сертификатом.
contacts_email string Адрес электронной почты контактного лица организации.
container_id string Идентификатор контейнера заказа.
container_name string Название контейнера заказа.
cost string Стоимость выполнения заказа.
csr string Запрос на подпись сертификата (CSR).
custom_renewal_message string Настраиваемое сообщение, включаемое в уведомления о продлении.
customer_order_id string Идентификатор заказа пользователя.
date_created string Дата размещения заказа.
Формат: yyyy-MM-dd HH:mm:ss
dcv_method string Метод проверки полномочий управления доменом, настроенный для домена.
См. Словарь — Методы DCV
disable_issuance_email string Указывает, следует ли отправлять электронные письма о выдаче.
Допустимые значения: 0 (недействительное), 1 (истинное)
disable_renewal_notifications string Указывает, включены ли уведомления о продлении.
Допустимые значения: 0 (недействительное), 1 (истинное)
dns_names string Список разделенных запятыми дополнительных имен, защищаемый сертификатом.
email string Если сертификат содержит вложенный адрес электронной почты (например, клиентские сертификаты), в ответ получаем адрес электронной почты из сертификата.
firstname string Имя контактного лица организации.
has_duplicates int Указывает, имеются ли дубликаты сертификата.
Допустимые значения: 0 (недействительное), 1 (истинное)
id string Идентификатор заказа.
is_out_of_contract string Контрактный статус заказа.
Допустимые значения: 0 (недействительное), 1 (истинное)
is_renewed string Указывает, продлен ли заказ.
Допустимые значения: 0 (недействительное), 1 (истинное)
issuer_common_name string Понятное для пользователей имя выпускающего центра сертификации.
job_title string Название должности контактного лица организации.
lastname string Фамилия контактного лица организации.
locale string Региональная настройка заказа.
См. Словарь — Коды региональной настройки
метаданные строка Данные настраиваемого поля.
Формат: {{metadata_id}} {{metadata_label}} {{metadata_value}}Разделитель данных: 0x1f
org_addr1 string Адрес организации.
org_addr2 string
organization_city string Город, в котором находится организация.
organization_country string Страна, в которой находится организация.
organization_id string Идентификатор организации для привязки к заказу.
organization_name string Название организации.
organization_state string Штат, в котором находится организация.
organization_unit string Подразделения организации в сертификате.
pay_type string Способ оплаты, используемый для заказа.
Допустимые значения: A (баланс счета учетной записи), C (кредитная карта)
plus_feature string Указывает, включена ли для заказа функция «плюс».
Допустимые значения: 0 (отключена), 1 (включена)
product_id string Идентификатор продукта.
product_name string Отобразить имя продукта.
См. Словарь — Идентификаторы продуктов
product_name_id string Идентификатор имени продукта.
См. Словарь — Идентификаторы продуктов
product_type string Тип продукта.
См. Словарь — Типы продуктов
purchased_dns_names string Количество дополнительных приобретенных альтернативных имен субъектов (SAN).
receipt_id string Идентификатор квитанции.
Renewed string Указывает, продлен ли заказ.
Допустимые значения: FALSE, TRUE
renewed_order_id string Идентификатор предыдущего заказа.
Указывается в ответе, только если заказ является заказом на продление.
serial_number string Серийный номер сертификата.
serversw string Идентификатор серверной платформы.
См. Словарь — Серверные платформы
signature_hash string Хэш подписи, используемый для подписания запроса на сертификат.
status string Статус заказа.
См. Словарь — Статус заказа
telephone string Номер телефона контактного лица организации.
thumbprint string Отпечаток сертификата.
user_assignments string Идентификатор пользователя, присвоенный заказу.
user_email string Адрес электронной почты пользователя, который инициировал запрос на сертификат.
user_first_name string Имя пользователя, который инициировал запрос на сертификат.
user_id string Идентификатор пользователя, разместившего заказ.
user_last_name string Фамилия пользователя, который инициировал запрос на сертификат.
valid_from string Дата начала срока действия сертификата.
Формат: yyyy-MM-dd
valid_till string Дата окончания срока действия сертификата.
Формат: yyyy-MM-dd
validity_years string Срок действия сертификата в годах.

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

Имя Тип Описание
data object Контейнер для выдаваемых в ответ данных запроса.
.. order_details array Перечень объектов заказа, содержащих запрашиваемые поля.
.. .. {{поле}} - Запрошенное поле и значение.
Выдаваемые в ответ на запрос поля, в зависимости от отправленного запроса.