使用此端点创建报告。
必须在帐户中启用报告库功能,该端点才能成功响应。
curl --location --request POST 'https://www.digicert.com/services/v1/reports/preview/report' \
--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":[]
}
}
}
import requests
url = "https://www.digicert.com/services/v1/report"
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("POST", url, headers=headers, data=payload)
print(response.text)
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v1/report"
method := "POST"
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))
}
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://www.digicert.com/services/v1/report',
'headers': {
'Content-Type': 'application/json',
'X-DC-DEVKEY': '{api_key}',
'Cookie': 'visid_incap_1323850=KAk7FceETTODSOcubQ6RxzER+V8AAAAAQUIPAAAAAACT+abPwAMvJuYXiY7OiuId'
},
body: '{\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}'
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
{
"report_identifier": "e62b02f3-97f9-4fa1-9314-f9ecfdcaf5d7",
"message": "Successfully created Custom Report"
}
{
"code": "missing_mandatory_fields",
"message": "Please provide values for mandatory fields"
}
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|display_name has an invalid value|]"
}
{
"code": "report_exists",
"message": "Report already exists"
}
{
"code": "missing_mandatory_fields",
"message": "Please provide values for mandatory fields"
}
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|run_until has an invalid value|]"
}
{
"code": "invalid_date",
"message": "Backdated run_until is not allowed"
}
{
"code": "report_format_inapplicable",
"message": "The given report format is not applicable for the template/report."
}
{
"code": "missing_mandatory_fields",
"message": "Please provide values for mandatory fields"
}
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|format must contain at least 1 item|]"
}
{
"code": "invalid_report_type",
"message": "Invalid report_type specified"
}
{
"code": "invalid_column_identifiers",
"message": "Invalid column identifiers specified"
}
{
"code": "invalid_schedule",
"message": "Provided schedule values are not correct"
}
{
"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"
}
名称 | 请求/选项 | 类型 | 描述 |
---|---|---|---|
display_name | 必填 | string | 显示在报告上的名称。 |
schedule | 必填 | object | 容器。 |
.. frequency | 必填 | string |
创建报告的频率。可能的值:ON_DEMAND, WEEKLY, MONTHLY . 值区分大小写。
|
.. weekday_to_run | 必填 | string |
每周创建报告的日期。可能的值:SUNDAY 至SATURDAY 。值区分大小写。如果frequency 指定为ON_DEMAND ,则不需要该参数。
|
.. weekday_frequency | 必填 | string |
每个月指定生成报告的周次。可能的值: FIRST , SECOND , THIRD , FOURTH , LAST . 值区分大小写。
|
.. run_until | 可选 | date | 停止生成该报告的日期。格式:年-月-日。如果未指定该值,则不停止创建报告。 |
format | 必填 | string |
报告文件类型。可能的值:CSV 和 JSON 。
|
report_metadata | 必填 | object | 容器 |
.. report_type | 必填 | string | 需要创建的报告的类型。 |
.. columns | 必填 | object | 容器。 |
.. .. identifier | 必填 | string | 报告库 API 支持的列标识符。有关所有支持的列的列表,请参阅报告库 API 列。 |
.. filters | 可选 | object | 容器。 |
.. .. filter_identifier | 必填 | string | 在筛选中使用的标识符。有关使用筛选器的信息,请参阅“使用筛选器创建库报告”。 |
.. .. column_identifier | 必填 | string | 指定用于筛选的列标识符。有关使用筛选器的更多信息,请参阅“使用筛选器创建库报告”。 |
.. .. values | 必填 | string/lint | 列中指定用于筛选的标识符。有关使用筛选器的更多信息,请参阅“使用筛选器创建库报告”。 |
.. sources | 可选 | object | 容器。 |
.. .. include_all_sub_accounts | 必填 | boolean |
在创建报告时是否包括所有子帐户。可能的值:TRUE 或FALSE 。
|
.. .. sub_accounts | 必填 | integer | 在创建报告时必须包括的子帐户的 ID。 |
.. .. divisions | 必填 | integer | 在创建报告时需要包括的帐户分区。 |
名称 | 类型 | 描述 |
---|---|---|
.. report_identifier | uuid | 报告 ID。 |
.. message | string | “成功创建”消息,含有报告显示名称。 |