サポート対象の列を一覧表示する

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)
Go
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 についてのすべての応答パラメータのリストは、デジサート レポートライブラリのサポート対象列トピックを参照してください。

名前 タイプ 説明
categories object コンテナ
.. name string レポートの名前。
.. columns object コンテナ
.. .. identifier string レポートライブラリ API がサポートする列識別子。すべてのサポート対象列のリストについては、「レポートライブラリ API 列」 を参照してください。
.. .. display_name string レポートについて指定された表示名。
.. .. field_type string データファイルタイプ:STRING.