列出支援的欄

GET

https://api.digicert.com/reports/v1/report/types/{{report_type}}/supported-columns

使用此端點列出支援的報告類型的欄。若要取得 report_type,，請使用「列出報告類型」端點。

若要讓此端點成功回應，您必須在您的帳戶中啟用「報告程式庫」功能。

cURL

curl -X GET \
  'https://www.digicert.com/services/v2/reports/preview/report/types/orders/columns' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'

Python

import requests

url = "https://www.digicert.com/services/v1/reports/preview/report/types/orders/columns"

payload={}
headers = {
  'Content-Type': 'application/json',
  'X-DC-DEVKEY': '{{api_key}}',
}

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

print(response.text)

package main

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

func main() {

  url := "https://www.digicert.com/services/v1/report/types/orders/columns"
  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/report/types/orders/columns',
  '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

{
    "categories": [
        {
            "name": "Order details",
            "columns": [
            {
                    "identifier": "account_id",
                    "display_name": "Account ID",
                    "field_type": "STRING"
                },
                {
                    "identifier": "additional_emails",
                    "display_name": "Additional Emails",
                    "field_type": "STRING"
                },
                {
                    "identifier": "alternative_order_id",
                    "display_name": "Alternative Order ID",
                    "field_type": "STRING"
                },
                 {
                    "identifier": "validity_start_date",
                    "display_name": "Validity Start Date",
                    "field_type": "STRING"
                }
            ]
        }
    ]
}

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 Not found

{
    "code": "report_type_not_found",
    "message": "Report_type not found."
}

要求參數

回應參數

關於此 API 的所有回應參數的清單，請參閱「DigiCert 報告程式庫支援的欄」主題。

名稱	類型	說明
categories	object	容器。
.. name	string	報告的名稱。
.. columns	object	容器。
.. .. identifier	string	報告程式庫 API 支援的欄識別碼。關於所有支援的欄的清單，請參閱報告程式庫 API 欄。
.. .. display_name	string	指定用於報告的顯示名稱。
.. .. field_type	string	資料欄位類型：`STRING`。