End Points

In this section, let us discuss the end points in detail.

End of Service

Name Type Description Default Value Required
repository string Repository name “” Yes
vendor String Name of vendor “” No
showsysname boolean Show system names “” No
showplxname boolean Show sysplex names “” No
shownoneos boolean Include non-EOS products “” No
start_date *DateTime

Start date - with format: YYYY-MM-DD, YYYY-

MM-DD HH:MM:SS

 “” No
end_date *DateTime

End date - with format: YYYY-MM-DD, YYYY-

MM-DD HH:MM:SS

 “” No
opsys string Whether to use the GKB or GKU. Empty for None “” Yes
showsysname bool Show system names false No
shownoneos bool Include non-EOS products false No
showplxname bool Show sysplex names false No 
curl pthomu2.prod.hclpnp.com:8889/end_of_service/count?repository=<REPO>&start_date=2024-04-
05&end_date=2024-04-12&opsys=GKB
-X GET -u username:password
curl pthomu2.prod.hclpnp.com:8889/product_inventory/report?repository=<REPO>-X 
GET -u username:password

Products Inventory

Table 1. Parameters
Name Type Description Default Value Required
repository string Repository name “” Yes
vendor string Product vendor “” No
product string Product name “” No
system string System name “” No
product string Product name “” No
show_product_discovery_name boolean Show product discovery name false No
show_subcap_values boolean Show sub cap values false No
show_sysplex_names boolean Show sysplex names false No
show_system_names boolean Show system names false No
show_product_suites_only boolean Show product suites only false No
For example:
curl https://pthomu1.prod.com:8000/api/products/inventory/count?repository=<REPO>
-X GET-u username:password
curl pthomu2.prod.hclpnp.com:8889/product_inventory/report?repository=<REPO>-X 
GET -u username:password

Product Use by Machine

Name Type Description Default Value Required
vendor string Product vendor “” No
product string Product name “” No
machine string Machine name “”
repository string Repository name “” Yes
start_date *DateTime

Start date - with format:

YYYY-MM-DD,

YYYY-MM-DD HH:MM:SS

 “” No
end_date *DateTime

End date - with format:

YYYY-MM-DD,

YYYY-MM-DD HH:MM:SS

 “” No
show_product_discovery_name Boolean Show the product discovery names false No
show_s_s_pid Boolean Show SSPID values false No
show_hardware_partition Boolean Show the hardware partition false No

metrics:

  • LAST_USE_DATE
  • FIRST_USE_DATE
  • MODULE_EVENTS
  • PRODUCT_USE_BY_MONTH
  • USER_ID_COUNT
  • JOB_NAME_COUNT
  • SCRT_MSU

ProductUseBy

MachineMetrics

 Metrics “” No
For example:
curl pthomu2.prod.hclpnp.com:8889/product_use_by_machine/count?repository=<REPO>
-X GET -u username:password
curl pthomu2.prod.hclpnp.com:8889/product_use_by_machine/report?repository=<REPO>
-X GET -u username:password

Product Use by Month

Name Type Description Default Value Required
vendor String Product vendor “” No
product String Product name “” No
system String System name “” No
start_date *DateTime

Start date - with format:

YYYY-MM-DD,

YYYY-MM-DD HH:MM:SS

 “” No
end_date *DateTime

End date - with format:

YYYY-MM-DD,

YYYY-MM-DD HH:MM:SS

 “” No
show_product_discovery_name Boolean Show product discovery name false No
show_s_s_pid Boolean Show SSPID values false No

metrics:

  • MODULE_EVENTS
  • PRODUCT_USE_BY_MONTH
  • USER_ID_COUNT
  • JOB_NAME_COUNT
  • JOB_ACCOUNT_COUNT
  • SCRT_MSU

Product Use By

Machine Metrics

 Metrics “” No
repository String Repository name “” Yes
For example:
curl pthomu2.prod.hclpnp.com:8889/product_use_by_month/count?repository=<REPO>
-X GET -u username:password
curl pthomu2.prod.hclpnp.com:8889/product_use_by_month/report?repository=<REPO>
-X GET -u username:password

Discovered Product Detail

Name Type Description Default Value Required
repository string Repository name “” Yes
start_date string Start date - with format: YYYY-MM “” No
end_date string

Start date - with format: YYYY-MM

 “” No
system string System name “” No
vendor string Vendor name “” No
product_release string Product release name “” No
show_only_zos bool Only show z/OS Products false No
show_only_unx bool Only show UNIX Products false No
show_only_unknown bool Only show UNKNOWN Release false No
exclude_unknown bool Exclude Unknown Releases false No
For example:
curl pthomu2.prod.hclpnp.com:8889/discovered_product_detail/count?repository=<REPO>
-X GET -u username:password
curl pthomu2.prod.hclpnp.com:8889/discovered_product_detail/report?repository=<REPO>
-X GET -u username:password