Retrieve license details for a software

Returns all license details associated with a specified software ID

Endpoints

get /dcapi/inventory/viewData/licenseBySW

Copy full URL

Request URL

https://{server-hostname}:8383/dcapi/inventory/viewData/licenseBySW

Scope

Inventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/InventoryMobileAPI.v1+jsonCopied!

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/dcapi/inventory/viewData/licenseBySW \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/inventory/viewData/licenseBySW"))
        .header("Accept", "application/InventoryMobileAPI.v1+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = {
    'Accept': "application/InventoryMobileAPI.v1+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/inventory/viewData/licenseBySW", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/InventoryMobileAPI.v1+json");

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/inventory/viewData/licenseBySW"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/InventoryMobileAPI.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/inventory/viewData/licenseBySW' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

metadataJSON Object

Pagination metadata

Show Sub-Attributes

limitstring

Number of items returned per page

pagestring

Current page number in paginated response

totalRecordsstring

Total number of records matching the query

messageResponseJSON Array

Array of license detail objects

Show Sub-Attributes

JSON Object

Show Sub-Attributes

po_file_namestring

Purchase order file name

license_file_namestring

License file name

edition_namestring

Software edition name

license_ref_number_transformstring

License reference number display value

vendor_transformstring

Vendor display value

po_file_name_transformstring

PO file name display value

software_namestring

Software name

software_versionstring

Software version

invoice_numberstring

Invoice number

managed_sw_idstring

Managed software identifier

license_key_transformstring

License key display value

manufacturer_idstring

Manufacturer identifier

location_transformstring

Location display value

edition_name_transformstring

Edition name display value

licensed_tostring

Licensed to

license_type_transformstring

License type display value

display_namestring

Software display name

license_keystring

License key

license_ref_numberstring

License reference number

purchase_datestring

Purchase date as epoch timestamp

expiry_date_transformstring

Expiry date display value

mapped_resource_count_transformstring

Mapped resource count display value

po_canonical_pathstring

Purchase order canonical file path

invoice_canonical_pathstring

Invoice canonical file path

invoice_file_namestring

Invoice file name

license_name_transformstring

License name display value

license_file_name_transformstring

License file name display value

license_canonical_pathstring

License canonical file path

software_idstring

Software identifier

license_namestring

License name

purchase_date_transformstring

Purchase date display value

po_numberstring

Purchase order number

license_edition_idstring

License edition identifier

vendorstring

Vendor name

license_metric_transformstring

License metric display value

remarks_transformstring

Remarks display value

sw_typestring

Software type code

license_details_idstring

License details identifier

coststring

License cost

license_typestring

License type

expiry_datestring

Expiry date as epoch timestamp

no_of_copiesstring

Number of license copies

manufacturer_namestring

Manufacturer name

no_of_copies_transformstring

Number of copies display value

mapped_resource_countstring

Number of mapped resources

license_idstring

License identifier

invoice_number_transformstring

Invoice number display value

po_number_transformstring

PO number display value

cost_transformstring

Cost display value

invoice_file_name_transformstring

Invoice file name display value

locationstring

Location

license_metricstring

License metric

customer_namestring

Customer name

customer_idstring

Customer identifier

licensed_to_transformstring

Licensed to display value

remarksstring

Remarks

totalPagesstring

Total number of pages

LinksJSON Object

Pagination links

Show Sub-Attributes

nextstring

URL to the next page of results, null if last page

prevstring

URL to the previous page of results, null if first page

statusstring

Response status - success

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codestring

INTERNAL_ERROR - unexpected exception in the service layer

error_descriptionstring

Internal server error message

Possible Response Codes

200HTTP code

500HTTP code

Sample Response: HTTP 200

Licenses for a software

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "po_file_name": "--",
        "license_file_name": "--",
        "edition_name": null,
        "license_ref_number_transform": "--",
        "vendor_transform": "--",
        "po_file_name_transform": "--",
        "software_name": "Sample Software",
        "software_version": "24.05",
        "invoice_number": "--",
        "managed_sw_id": "51",
        "license_key_transform": "--",
        "manufacturer_id": "57",
        "location_transform": "--",
        "edition_name_transform": "--",
        "licensed_to": "--",
        "license_type_transform": "--",
        "display_name": "Sample Software",
        "license_key": "--",
        "license_ref_number": "--",
        "purchase_date": "0",
        "expiry_date_transform": "--",
        "mapped_resource_count_transform": "1",
        "po_canonical_path": "--",
        "invoice_canonical_path": "--",
        "invoice_file_name": "--",
        "license_name_transform": "SampleLicense_001",
        "license_file_name_transform": "--",
        "license_canonical_path": "--",
        "software_id": "51",
        "license_name": "SampleLicense_001",
        "purchase_date_transform": "--",
        "po_number": "--",
        "license_edition_id": null,
        "vendor": "--",
        "license_metric_transform": "--",
        "remarks_transform": "--",
        "sw_type": "1",
        "license_details_id": "1",
        "cost": null,
        "license_type": null,
        "expiry_date": "0",
        "no_of_copies": "5",
        "manufacturer_name": "Sample Manufacturer",
        "no_of_copies_transform": "5",
        "mapped_resource_count": "1",
        "license_id": "1",
        "invoice_number_transform": "--",
        "po_number_transform": "--",
        "cost_transform": "--",
        "invoice_file_name_transform": "--",
        "location": "--",
        "license_metric": null,
        "customer_name": "SampleCustomer",
        "customer_id": "1",
        "licensed_to_transform": "--",
        "remarks": "--"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }

▼ Show full

Sample Response: HTTP 500

Server error

Copied!

  {
    "error_description": "Internal server error",
    "error_code": "INTERNAL_ERROR"
  }

▼ Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.