Endpoints

This topic describes the IZSAM REST API endpoints.

Authorization Scheme

The API uses RACF services to authorize incoming requests. In each request the Authorization header must conform to the Basic authorization strategy, using the following format:

Authorization: Basic b64Enc

Note:

b64Enc is the b64 encoding of the username and password separated by a column (:)

End of Service Products

This endpoint provides a summary of discovered products that have a known End of Service date. The endpoint is called using an HTTP GET request. Syntax and parameters are provided as follows:

Table 1. Parameters
Name	Type	Description	Required
vendor	String	Name of vendor	No
product_release	String	Name of product release	No
show_system_names	Boolean	Show system names	No
show_sysplex_names	Boolean	Show sysplex names	No
include_non_eos_products	Boolean	Include non EOS products	No
start_date	String	Start date - with format YYYY-MM-DD	No
end_date	String	End date - with format YYYY-MM-DD	No
repository	String	Target repository	Yes

Example:

curl https://pthomu1.prod.com:8000/api/products/end-of-service/
-X GET
-u username:password

Products Inventory

Table 2. Parameters
Name	Type	Description	Required
vendor	String	Product vendor	No
product	String	Product name	No
system	String	System name	No
show_product_discovery_name	Boolean	Show product discovery name	No
show_subcap_values	Boolean	Show sub cap values	No
show_sysplex_names	Boolean	Show sysplex names	No
show_system_names	Boolean	Show system names	No
show_product_suites_only	Boolean	Show product suites only	No
repository	String	Target repository	Yes

Example:

curl https://pthomu1.prod.com:8000/api/products/inventory/
-X GET
-u username:password

Product Use by Machine

This endpoint provides cross reference information of product versions used per Machine. The endpoint is called using an HTTP GET request. Syntax and parameters are provided as follows.

Table 3. Parameters
Name	Type	Description	Required
vendor	String	Vendor of the product	No
product_name	String	Product name	No
start_date	String	Start date - with format YYYY-MM-DD	No
end_date	String	End date - with format YYYY-MM-DD	No
show_product_discovery_names	Boolean	Show the product discovery names	No
show_service_and_support_pid	Boolean	Show the service and support pid	No
show_hardware_partition	Boolean	Show the hardware partition	No
metrics: LAST_USE_DATE FIRST_USE_DATE MODULE_EVENTS PRODUCT_USE USER_ID_COUNT JOB_NAME_COUNT JOB_ACCOUNT_COUNT SCRT_MSU	String	Default value of LAST_USE_DATE	No
repository	String	Target repository	Yes

Example:

curl https://pthomu1.prod.com:8000/api/products/usage/machine/
-X GET
-u username:password

Product Use by Month

This endpoint provides cross reference information of product versions used per Month by System. The endpoint is contacted via an HTTP GET request. Syntax and parameters are provided as follows:

Table 4. Parameters
Name	Type	Description	Required
vendor	String	Vendor name	No
product_name	String	Product name	No
system	String	System name	No
start_date	String	Start date - with format YYYY-MM-DD	No
end_date	String	End date - with format YYYY-MM-DD	No
show_product_discovery_name	Boolean	Show product discovery name	No
show_s_s_pid	Boolean	Show S&S PID	No
metrics: MODULE_EVENTS PRODUCT_USE USER_ID_COUNT JOB_NAME_COUNT JOB_ACCOUNT_COUNT SCRT_MSU	String	Default value of MODULE_EVENTS	No
repository	String	Target repository	Yes