Getting a detailed report

Service endpoints

Pilot

https://pilot-certmanager-webservices.websecurity.symantec.com/vswebservices/​reportingws

Production

https://certmanager-webservices.websecurity.symantec.com/vswebservices/​reportingws

Parameters

Table: Detail report request parameters

Name

Data type

Required

Max Length

Description

reportType

Text

Y

32

For a Detail report, the value is detail.

startDate

Date

Y

10

Start date of the report, in MM/DD/YYYY format. The start date and date range can be six years apart, maximum.

endDate

Date

Y

10

End date of the report, in MM/DD/YYYY format. The start date and date range can be six years apart, maximum.

certProductType

Text

N

Takes one of the following values:

  • All. This is the default value.

  • HAServer

  • HAGlobalServer

  • Server

  • GlobalServer

  • IntranetServer

  • IntranetGlobalServer

  • PrivateServer

  • OFXServer

  • GeotrustServer

email

Text

N

240

Filter the report by subscriber contact email address.

domain

Text

N

255

Filter the report by domain name.

organization

Text

N

64

The name of a vetted organization. The default is a report of all organizations.

organizationalUnit

Text

N

64

The name of an organizational unit within the organization.

certStatus

Text

N

64

Takes one of the following values:

  • All. This is the default value. It is also used if you omit this parameter or leave its value empty.

  • Pending

  • Approved

  • Rejected

  • Valid

  • Revoked

  • Deactivated

  • Expired

customizedColumnsOnly

Text

N

1

The value can be Y or N. If the value is Y, the API only returns data from the selected custom columns in the Control Center.

You can retrieve the custom columns using the getCustomizedColumns call. See Getting a units report.

structuredRecord

Text

N

1

The value can be Y or N. If the value is Y, each row of the response contains the information for a particular certificate. If the value is no, the response is organized according to each column in the report.

Sample request (POST)

java
POST https://certmanager-webservices.websecurity.symantec.com/vswebservices/​​reportingws
Content-Type: application/x-www-form-urlencoded
User-Agent: ACME Security Services
Host: certmanager-webservices.websecurity.symantec.com
Content-Length: 68

reportType=detail&startDate=9%2F21%2F2013&endDate=10%2F21%2F2013
&organization=&orgUnit=&certProductType=GlobalServer&certStatus=​
Valid&customizedColumnsOnly=Y&structuredRecord=N

Sample response

The following is a sample of a successful detail report transaction response. Each component in the response is organized by report column (structuredRecord=N). You can also request a report organized by certificate (structuredRecord=Y).

java
{
  "certificateType": [
    "Code Signing for Authenticode",
    "Standard SSL",
    "Code Signing for Authenticode",
    "Code Signing for Java",
    "Standard EV SSL",
  ],
  "status": [
    "Valid",
    "Valid",
    "Valid",
    "Pending",
    "Valid",
  ],
  "commonName": [
    "example.com",
    "1234.company.com",
    "example",
    "5678.example.com",
    "company.com",
   ],
  "organizationalUnit": [
    "myorgunit1",
    "myorgunit2",
    "exampleorgunit1",
    "exampleorgunit2",
    "myorgunit3",
    ],
  "organization": [
    "company",
    "company",
    "company",
    "company",
    "company",
    ],
  "locality": [
    "Mountain View",
    "Mountain View",
    "Mountain View",
    "Mountain View",
    "Mountain View",
    ],
  "state": [
    "California",
    "California",
    "California",
    "California",
    "California",
     ],
  "country": [
    "US",
    "US",
    "US",
    "US",
    "US",
    ],
  "subjectAlternativeNames": [
    "1.company.com",
    "2.company.com",
    "3.company.com",
    "4.company.com",
    "5.company.com",
     ],
  "certificateSerialNumber": [
    "2f9db7fbdd83185642d84082df1f5a5e",
    "32db0f9797fbb3a88c0181e9580b70ac",
    "374aeb7ba66a5cd73ab46b3de117938a",
    "12b1cdb014d7c8a0d9b7c0b8b61a7b76",
    "0376c690974b51876f3b749936a73363",
    ],
  "validityStartDate": [
    "11-SEP-2013",
    "10-SEP-2013",
    "10-SEP-2013",
    "17-SEP-2013",
    "03-OCT-2013",
     ],
  "validityEndDate": [
    "23-JUL-2015",
    "11-SEP-2015",
    "11-SEP-2015",
    "17-SEP-2015",
    "03-OCT-2015",
     ],
  "revocationDate": [
    "N/A",
    "N/A",
    "N/A",
    "N/A",
    "16-SEP-2013"
   ],
  "licenses": [
    1,
    1,
    1,
    1,
    1,
  ],
  "totalUnits": [
    1,
    1,
    1,
    0,
    4,
  ],
  "requestType": [
    "replacement",
    "enrollment",
    "enrollment",
    "enrollment",
    "renewal",
   ],
  "serverType": [
    "Server Type - Netscape",
    "",
    
    "Server Type - Netscape",
    "Server Type - iPlanet",
  ],
  "email": [
    "employee1@company.com",
    "employee2@company.com",
    "employee3@company.com",
    "employee4@company.com",
    "employee5@company.com",
  ],
  "title": [
    "security admin",
    "admin",
    "admin",
    "admin",
    "",
   ],
  "employeeID": [
    "1234",
    "5678",
    "9101",
    "1213",
    "1415",
   ],
  "mailStop": [
    "",
    "",
    "",
    "",
    "",
     ],
  "departmentNumber": [
    "",
    "",
    "",
    "",
    "",
   ],
  "serverIP": [
    "",
    "",
    "",
    "",
    "",
  ],
  "userComment": [
    "",
    "",
    "",
    "",
    "",
  ],
  "assignedTo": [
    "",
    "",
    "",
    "",
    "",
  ],
  "firstName": [
    "John",
    "Jane",
    "John",
    "Jane",
    "John",
  ],
  "lastName": [
    "Doe",
    "Doe",
    "Doe",
    "Doe",
    "Doe",
  ],
  "keyInfo": [
    "RSA 2048-bit",
    "RSA 2048-bit",
    "RSA 2048-bit",
    "RSA 2048-bit",
    "RSA 2048-bit",
],
  "paymentTerm": [
    "1-Year",
    "1-Year",
    "2-Year",
    "2-Year",
    "2-Year",
  ],
  "expressRenewal": [
    "Deactivated",
    "Deactivated",
    "Deactivated",
    "Deactivated",
    "Deactivated",
  ],
  "autoRedeem": [
    "Deactivated",
    "Deactivated",
    "Deactivated",
    "Deactivated",
    "Deactivated",
  ],
  "termRenewalDate": [
    "18-JUL-2013",
    "22-SEP-2013",
    "22-SEP-2013",
    "22-SEP-2013",
    "22-SEP-2013",
  ],
  "signatureAlgorithm": [
    "SHA-1 with RSA Encryption",
    "SHA-1 with RSA Encryption",
    "SHA-1 with RSA Encryption",
    "SHA-1 with RSA Encryption",
    "SHA-1 with RSA Encryption",
  ],
  "numberOfFQDNs": [
    10,
    0,
    0,
    0,
    0,
  ]
}

We use cookies to ensure that we give you the best experience on our website. By using this site, you agree to the Terms of Service.