Изменить отчет

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

Используйте эту конечную точку для изменения шаблона отчета. Используйте ответ из конечной точки «Создать отчет» для ввода report-identifier.

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

cURL 
curl --location -g --request PUT 'https://www.digicert.com/services/v1/reports/preview/report/{report-indentifier}' \
--header 'Content-Type: application/json' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--data-raw {
    "display_name": "Report_1",
    "schedule": {
        "frequency": "MONTHLY ", 
        "weekday_to_run": "TUESDAY", 
        "weekday_frequency": "SECOND",  
        "run_until": "2021-12-24" 
    },
    "format": [
      "CSV"  
    ],
    "report_metadata": {
        "report_type": "orders",
        "columns": [
           {
               "identifier": "account_id"
            },
            {
                "identifier": "number_of_sans"
            },
            {
                "identifier": "certificate_id"
            },
            {
                "identifier": "certificate_validity_days"
            },
            {
                "identifier": "container_id"
            },
            {
                "identifier": "container_name"
            } 
        ],
       "filters":[
        {
        "filter_identifier":"in",
        "column_identifier":"common_name",
        "values":["digiqatest.com"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"organization_name",
        "values":["win the customer, LLC"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"status",
        "values":["issued","pending"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"user_email",
        "values":["dev1@digicert.com"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"product_name",
        "values":["Secure Site Pro SSL","GeoTrust TrueBusiness ID OV","Secure Site OV"]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"order_placed_via",
        "values":["CertCentral","Api"]
        },
        {
        "filter_identifier":"last_30_days",
        "column_identifier":"order_created_date",
        "values":[]
        },
        {
        "filter_identifier":"in",
        "column_identifier":"certificate_id",
        "values":[3292682707,3292682692,3292682697]
        }
    ],
    "sources": {
      "include_all_sub_accounts": true,
      "sub_accounts": [],
      "divisions":[]
    }        
    }
}
Python 
import requests

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

payload="{\r\n    \"display_name\": \"Report_1\",\r\n    \"schedule\": {\r\n        \"frequency\": \"MONTHLY \", \r\n        \"weekday_to_run\": \"TUESDAY\", \r\n        \"weekday_frequency\": \"SECOND\",  \r\n        \"run_until\": \"2021-12-24\" \r\n    },\r\n    \"format\": [\r\n      \"CSV\"  \r\n    ],\r\n    \"report_metadata\": {\r\n        \"report_type\": \"orders\",\r\n        \"columns\": [\r\n           {\r\n               \"identifier\": \"account_id\"\r\n            },\r\n            {\r\n                \"identifier\": \"number_of_sans\"\r\n            },\r\n            {\r\n                \"identifier\": \"certificate_id\"\r\n            },\r\n            {\r\n                \"identifier\": \"certificate_validity_days\"\r\n            },\r\n            {\r\n                \"identifier\": \"container_id\"\r\n            },\r\n            {\r\n                \"identifier\": \"container_name\"\r\n            } \r\n        ],\r\n       \"filters\":[\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"common_name\",\r\n        \"values\":[\"digiqatest.com\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"organization_name\",\r\n        \"values\":[\"win the customer, LLC\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"status\",\r\n        \"values\":[\"issued\",\"pending\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"user_email\",\r\n        \"values\":[\"dev1@digicert.com\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"product_name\",\r\n        \"values\":[\"Secure Site Pro SSL\",\"GeoTrust TrueBusiness ID OV\",\"Secure Site OV\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"order_placed_via\",\r\n        \"values\":[\"CertCentral\",\"Api\"]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"last_30_days\",\r\n        \"column_identifier\":\"order_created_date\",\r\n        \"values\":[]\r\n        },\r\n        {\r\n        \"filter_identifier\":\"in\",\r\n        \"column_identifier\":\"certificate_id\",\r\n        \"values\":[3292682707,3292682692,3292682697]\r\n        }\r\n    ],\r\n    \"sources\": {\r\n      \"include_all_sub_accounts\": true,\r\n      \"sub_accounts\": [],\r\n      \"divisions\":[]\r\n    }        \r\n    }\r\n}"
headers = {
  'Content-Type': 'application/json',
  'X-DC-DEVKEY': '{api_key}',
  'Cookie': 'visid_incap_1323850=KAk7FceETTODSOcubQ6RxzER+V8AAAAAQUIPAAAAAACT+abPwAMvJuYXiY7OiuId'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)
Go 
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://www.digicert.com/services/v1/report/%7Breport-indentifier%7D"
  method := "PUT"

  payload := strings.NewReader(`{`+"
"+`
    "display_name": "Report_1",`+"
"+`
    "schedule": {`+"
"+`
        "frequency": "MONTHLY ", `+"
"+`
        "weekday_to_run": "TUESDAY", `+"
"+`
        "weekday_frequency": "SECOND",  `+"
"+`
        "run_until": "2021-12-24" `+"
"+`
    },`+"
"+`
    "format": [`+"
"+`
      "CSV"  `+"
"+`
    ],`+"
"+`
    "report_metadata": {`+"
"+`
        "report_type": "orders",`+"
"+`
        "columns": [`+"
"+`
           {`+"
"+`
               "identifier": "account_id"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "number_of_sans"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "certificate_id"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "certificate_validity_days"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "container_id"`+"
"+`
            },`+"
"+`
            {`+"
"+`
                "identifier": "container_name"`+"
"+`
            } `+"
"+`
        ],`+"
"+`
       "filters":[`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"common_name",`+"
"+`
        "values":["digiqatest.com"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"organization_name",`+"
"+`
        "values":["win the customer, LLC"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"status",`+"
"+`
        "values":["issued","pending"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"user_email",`+"
"+`
        "values":["dev1@digicert.com"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"product_name",`+"
"+`
        "values":["Secure Site Pro SSL","GeoTrust TrueBusiness ID OV","Secure Site OV"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"order_placed_via",`+"
"+`
        "values":["CertCentral","Api"]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"last_30_days",`+"
"+`
        "column_identifier":"order_created_date",`+"
"+`
        "values":[]`+"
"+`
        },`+"
"+`
        {`+"
"+`
        "filter_identifier":"in",`+"
"+`
        "column_identifier":"certificate_id",`+"
"+`
        "values":[3292682707,3292682692,3292682697]`+"
"+`
        }`+"
"+`
    ],`+"
"+`
    "sources": {`+"
"+`
      "include_all_sub_accounts": true,`+"
"+`
      "sub_accounts": [],`+"
"+`
      "divisions":[]`+"
"+`
    }        `+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-DC-DEVKEY", "{api_key}")
  req.Header.Add("Cookie", "visid_incap_1323850=KAk7FceETTODSOcubQ6RxzER+V8AAAAAQUIPAAAAAACT+abPwAMvJuYXiY7OiuId")

  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': 'PUT',
  'url': 'https://www.digicert.com/services/v1/report/{report-indentifier}',
  'headers': {
    'Content-Type': 'application/json',
    'X-DC-DEVKEY': '{api_key}',
    'Cookie': 'visid_incap_1323850=KAk7FceETTODSOcubQ6RxzER+V8AAAAAQUIPAAAAAACT+abPwAMvJuYXiY7OiuId'
  },
  body: JSON.stringify({"display_name":"Report_1","schedule":{"frequency":"MONTHLY ","weekday_to_run":"TUESDAY","weekday_frequency":"SECOND","run_until":"2021-12-24"},"format":["CSV"],"report_metadata":{"report_type":"orders","columns":[{"identifier":"account_id"},{"identifier":"number_of_sans"},{"identifier":"certificate_id"},{"identifier":"certificate_validity_days"},{"identifier":"container_id"},{"identifier":"container_name"}],"filters":[{"filter_identifier":"in","column_identifier":"common_name","values":["digiqatest.com"]},{"filter_identifier":"in","column_identifier":"organization_name","values":["win the customer, LLC"]},{"filter_identifier":"in","column_identifier":"status","values":["issued","pending"]},{"filter_identifier":"in","column_identifier":"user_email","values":["dev1@digicert.com"]},{"filter_identifier":"in","column_identifier":"product_name","values":["Secure Site Pro SSL","GeoTrust TrueBusiness ID OV","Secure Site OV"]},{"filter_identifier":"in","column_identifier":"order_placed_via","values":["CertCentral","Api"]},{"filter_identifier":"last_30_days","column_identifier":"order_created_date","values":[]},{"filter_identifier":"in","column_identifier":"certificate_id","values":[3292682707,3292682692,3292682697]}],"sources":{"include_all_sub_accounts":true,"sub_accounts":[],"divisions":[]}}})

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
204 No Content 
<BLANK>
400 Missing fields 
{
"code": "missing_mandatory_fields",
"message": "Please provide values for mandatory fields"
}
400 Invalid request 
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|display_name has an invalid value|]"
}
400 Already exists 
{ 
   "code": "report_exists", 
   "message": "Report already exists"
}
400 Invalid value 
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|run_until has an invalid value|]"
}
400 Invalid date 
{
"code": "invalid_date",
"message": "Backdated run_until is not allowed"
}
400 Invalid format 
{
"code": "report_format_inapplicable",
"message": "The given report format is not applicable for the template/report."
}
400 Format missing 
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|format must contain at least 1 item|]"
}
400 Invalid type 
{
"code": "invalid_report_type",
"message": "Invalid report_type specified"
}
400 Invalid column 
{
"code": "invalid_column_identifiers",
"message": "Invalid column identifiers specified"
}
400 Invalid schedule 
{
"code": "invalid_schedule",
"message": "Provided schedule values are not correct"
}

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

Имя Обязательный/Необязательный Тип Описание
display_name обязательный string Указанное отображаемое имя отчета.
schedule обязательный object Контейнер.
.. frequency обязательный string Периодичность создания отчетов. Возможные значения: ON_DEMAND, WEEKLY, MONTHLY. Значения вводятся с учетом регистра клавиатуры.
.. weekday_to_run обязательный string День недели создания отчета. Возможные значения: SUNDAY – SATURDAY. Значения вводятся с учетом регистра клавиатуры.
.. weekday_frequency обязательный string Неделя месяца, заданная для создания отчета. Возможные значения: FIRST, SECOND, THIRD, FOURTH, LAST. Значения вводятся с учетом регистра клавиатуры.
.. run_until обязательный string Дата завершения создания отчета. Формат: ГГ-ММ-ДД.
format обязательный string Формат отчета Возможное значение этой конечной точки: CSV. Для возврата отчет в формате JSON см. Получить отчет JSON API.
report_metadata обязательный object Контейнер.
.. report_type обязательный string Тип подлежащего изменению отчета.
.. columns обязательный object Контейнер.
.. .. identifier обязательный string Идентификатор столбца, поддерживаемого API библиотеки отчетов. Список всех поддерживаемых столбцов см. в разделе Столбцы API библиотеки отчетов.
.. filters необязательный object Контейнер.
.. .. filter_identifier обязательный string Идентификатор для использования при фильтрации. Информацию об использовании фильтров см. в разделе «Создание отчетов библиотеки с фильтрами».
.. .. coliumn_identifier обязательный string Идентификаторы столбцов, указанные для использования при фильтрации. Более подробную информацию об использовании фильтров см. в разделе «Создание отчетов библиотеки с фильтрами».
.. .. values обязательный string/lint Указанные в столбцах значения для использования при фильтрации. Более подробную информацию об использовании фильтров см. в разделе «Создание отчетов библиотеки с фильтрами».
.. sources необязательный object Контейнер.
.. .. include_all_sub_accounts обязательный boolean Следует ли включать все субyчётная запись при создании отчета. Возможные значения: TRUE или FALSE.
.. .. sub_accounts обязательный integer Идентификатор субучётная запись, который необходимо указать для включения его при создании отчета.
.. .. divisions обязательный integer Подразделение субучётная запись, которое необходимо включить при создании отчета.

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

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

О проекте

DigiCert is the world's leading provider of scalable TLS/SSL, IoT and PKI solutions for identity and encryption. The most innovative companies, including 89% of the Fortune 500 and 97 of the 100 top global banks, choose DigiCert for its expertise in identity and encryption for web servers and Internet of Things devices. DigiCert supports TLS and other digital certificates for PKI deployments at any scale through its certificate lifecycle management solution, CertCentral®. The company is recognized for its enterprise-grade certificate management platform, fast and knowledgeable customer support, and market-leading security solutions. For the latest DigiCert news and updates, visit digicert.com or follow @digicert.

©2020 DigiCert, Inc. All rights reserved. DigiCert, its logo and CertCentral are registered trademarks of DigiCert, Inc. Norton and the Checkmark Logo are trademarks of NortonLifeLock Inc. used under license. Other names may be trademarks of their respective owners.