Retrieval of software inventory (v2)

Header

Accept-Language (optional)

Values

en-US (only English is supported)

Negotiates the language of the response. If the header is not specified, the content is returned in the server language.

Header

Content-Type

Values

application/json

Specifies the content type of the response.

Header

Content-Language

Values

en-US

Specifies the language of the response content. If the header is not specified, the content is returned in the server language.

200 – OK

400 – "Bad Request" if a query parameter contains errors or is missing

Indicates whether a component instance's processing has been completed. Value '1' means the processing has been completed. If the value is '0', some information (for example, classification details) may not be available until the next data import is finished. By default, only component instances with completed processing are returned. To return unprocessed component instances, use the 'include_unprocessed' parameter.

• - 1 - The software instance cannot be assigned to any FlexPoint offering nor Cloud Pak because the component is not assigned to any product
• 0 - The software instance is not bundled to any FlexPoint offering nor Cloud Pak
• Other values - Identifier of the FlexPoint offering or CloudPak to which the software instance is assigned

• Empty column - The software instance cannot be assigned to any FlexPoint offering nor Cloud Pak because the component is not assigned to any product
• None - The software instance is not bundled to any FlexPoint offering nor Cloud Pak
• Other values - Name of the FlexPoint offering or Cloud Pak to which the software instance is assigned

• -1 - The software instance is not assigned to any bundle or cannot be assigned because the component is not assigned to any product
• 0 - FlexPoint bundle
• 1 - Cloud Pak bundle

• Empty column - The software instance is not bundled to any FlexPoint offering nor Cloud Pak
• Other values - GUID of the FlexPoint offering or Cloud Pak to which the software instance is assigned

• 0 - No CVEs are matched
• 1 - At least one CVE is matched

<criteria> ::= <left-brace> <boolean-operator> <colon> <left-bracket> 
<criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace>
<boolean-operator> ::= "and" | "or"
<criterion> ::= <criteria> | <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket>
<column> ::= <json-string>
<operator> ::= <json-string>
<value> ::= <json-array> | <json-string> | <json-number> | <json-null>

For more information about operators, see: Common connectors and operators.

URL?criteria={ "or": [ ["product_name", "contains", "BigFix"], 
{ "and": [ ["discovery_start", ">", "2018-10-01T00:00:00+00:00Z"], 
["discovery_start", "<", "2018-10-02T00:00:00+00:00Z"] ] } ] }

For columns that use the date and time values, you can retrieve data also for a period instead of a specific date. To do so, use last or next as <operator>, and then specify the time value in the following convention: PxD/PxW/PxM/PxY, where x is a number in the 1-999 range, and D, W, M, or Y is a designator that represents days, weeks, months, or years respectively.

Example: Retrieve software instances which took part in the license utilization peak. The date and time of the peak is: 2018-10-10T00:00:00+00:00Z. Query searches for the instances that meet the following criteria: product name contains "DB2" AND use the given metric AND discovery start withing the peak.

URL?criteria={ "and": [ ["discovery_start", "<=", "2018-10-10T00:00:00+00:00Z"], 
["discovery_end", ">", "2018-10-10T00:00:00+00:00Z"], ["product_name", "contains", "DB2"], ["metric_id", "=", "5"] ] }

URL?criteria={ "and": [ ["discovery_start", "<", "2018-10-11T00:00:00+00:00Z"], 
["discovery_end", ">=", "2018-10-10T00:00:00+00:00Z"], ["product_name", "contains", "DB2"], ["metric_id", "=", "9"] ] }

URL?criteria={"and":[["discovery_start","last","P7D"]]}

Specify if the response should include unprocessed component instances. When not provided or set to 'false,' only component instances with completed processing are returned.