Listar colunas com suporte

GET

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

Use este ponto de extremidade para listar as colunas com suporte para um tipo de relatório. Para obter o report_type,, use o terminal Listar tipo de relatório

O recurso Biblioteca de relatórios deve estar habilitado em sua conta para que este endpoint responda com sucesso.

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."
}

Parâmetros da solicitação

Parâmetros da resposta

Para obter uma lista de todos os parâmetros de resposta para esta API, consulte o tópico de colunas com suporte da biblioteca de relatórios Digicert.

Nome	Tipo	Descrição
categories	object	Recipiente.
.. name	string	O nome do relatório.
.. columns	object	Recipiente.
.. .. identifier	string	O identificador de coluna compatível com APIs da biblioteca de relatórios. Para obter uma lista de todas as colunas com suporte, consulte Colunas da API da biblioteca de relatórios.
.. .. display_name	string	O nome de exibição especificado para o relatório.
.. .. field_type	string	O tipo de campo de dados: `STRING`.

Parâmetros da solicitação

Parâmetros da resposta

Sobre