Modificar informe

PUT
https://api.digicert.com/reports/v1/report/{{report_identifier}}

Use este terminal para modificar una plantilla de informe. Use la respuesta del terminal Crear informe para suministrar el report-identifier .

La función Biblioteca de informes debe estar habilitada en su cuenta para que este terminal responda correctamente.

cURL
curl --location -g --request PUT 'https://www.digicert.com/services/v1/reports/preview/report/{report-indentifier}' \
--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":[]
    }        
    }
}
Python
import requests

url = "https://www.digicert.com/services/v1/report/{report-indentifier}"

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("PUT", url, headers=headers, data=payload)

print(response.text)
Go
package main

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

func main() {

  url := "https://www.digicert.com/services/v1/report/%7Breport-indentifier%7D"
  method := "PUT"

  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))
}
NodeJS
var request = require('request');
var options = {
  'method': 'PUT',
  'url': 'https://www.digicert.com/services/v1/report/{report-indentifier}',
  'headers': {
    'Content-Type': 'application/json',
    'X-DC-DEVKEY': '{api_key}',
    'Cookie': 'visid_incap_1323850=KAk7FceETTODSOcubQ6RxzER+V8AAAAAQUIPAAAAAACT+abPwAMvJuYXiY7OiuId'
  },
  body: JSON.stringify({"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":[]}}})

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
204 No Content
<BLANK>
400 Missing fields
{
"code": "missing_mandatory_fields",
"message": "Please provide values for mandatory fields"
}
400 Invalid request
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|display_name has an invalid value|]"
}
400 Already exists
{ 
   "code": "report_exists", 
   "message": "Report already exists"
}
400 Invalid value
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|run_until has an invalid value|]"
}
400 Invalid date
{
"code": "invalid_date",
"message": "Backdated run_until is not allowed"
}
400 Invalid format
{
"code": "report_format_inapplicable",
"message": "The given report format is not applicable for the template/report."
}
400 Format missing
{
"code": "invalid_request",
"message": "Please provide correct input for fields: [|format must contain at least 1 item|]"
}
400 Invalid type
{
"code": "invalid_report_type",
"message": "Invalid report_type specified"
}
400 Invalid column
{
"code": "invalid_column_identifiers",
"message": "Invalid column identifiers specified"
}
400 Invalid schedule
{
"code": "invalid_schedule",
"message": "Provided schedule values are not correct"
}

Parámetros de la solicitud

Nombre Solicitud/opción Tipo Descripción
display_name obligatorio string El nombre para mostrar especificado para el informe.
schedule obligatorio object Contenedor.
.. frequency obligatorio string La frecuencia de creación de informes. Posibles valores: ON_DEMAND, WEEKLY, MONTHLY. Los valores distinguen mayúsculas de minúsculas.
.. weekday_to_run obligatorio string El día de la semana para crear el informe. Posibles valores: SUNDAY a SATURDAY. Los valores distinguen mayúsculas de minúsculas.
.. weekday_frequency obligatorio string La semana especificada del mes para generar el informe. Posibles valores: FIRST, SECOND, THIRD, FOURTH, LAST. Los valores distinguen mayúsculas de minúsculas.
.. run_until obligatorio string La fecha en que se detiene la generación del informe. Formato: AA-MM-DD.
format obligatorio string El formato del informe. Para este terminal, el posible valor es CSV. Para devolver un informe en JSON, consulte la API obtener informe en JSON.
report_metadata obligatorio object Contenedor.
.. report_type obligatorio string El tipo de informe a modificar.
.. columns obligatorio object Contenedor.
.. .. identifier obligatorio string El identificador de columna admitido por las API de la biblioteca de informes. Para obtener una lista de todas las columnas admitidas, consulte Columnas API de la biblioteca de informes.
.. filters opcional object Contenedor.
.. .. filter_identifier obligatorio string El identificador para uso en el filtro. Para información sobre cómo usar los filtros, consulte Crear informes de biblioteca con filtros.
.. .. coliumn_identifier obligatorio string Los identificadores de columna especificados a usar para filtrar. Para más información sobre cómo usar los filtros, consulte Crear informes de biblioteca con filtros.
.. .. values obligatorio string/lint Los valores especificados en las columnas a usar para filtrar. Para más información sobre cómo usar los filtros, consulte Crear informes de biblioteca con filtros.
.. sources opcional object Contenedor.
.. .. include_all_sub_accounts obligatorio boolean Si incluir o no todas las subcuentas en la creación del informe. Posibles valores: TRUE o FALSE.
.. .. sub_accounts obligatorio integer La Id. de la subcuenta que se debe suministrar para incluirla en la creación del informe.
.. .. divisions obligatorio integer La división de cuenta a incluir en la creación del informe.

Parámetros de la ruta

Nombre Solicitud/opción Tipo Descripción
report-identifier obligatorio uuid Id. de informe mostrada en la respuesta de la API crear informe.