このエンドポイントを使用して、レポートを作成します。
このエンドポイントが正常に応答するには、レポートライブラリ機能がお使いのアカウントで有効になっている必要があります。
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 to SATURDAY .値は、ケースセンシティブです。このパラメータは、frequency を ON_DEMAND として指定する場合、必要ではありません。
|
.. weekday_frequency | 必須 | string |
レポートを生成する月の指定週。可能な値:FIRST ,SECOND ,THIRD ,FOURTH ,LAST . 値は、ケースセンシティブです。
|
.. run_until | 任意 | date | このレポート生成を停止する日付。形式:YY-MM-DD.値を指定しない場合、レポート作成は停止しません。 |
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 | レポート表示名が記載された作成成功メッセージ。 |