Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
	"requestType" : "getOrganizationLicenses",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key",
    "excludeProjectOccurrences" : true
}

Response Example (JSON)

Code Block
{
    "libraries": [
        {
            "keyUuid": "e8a0f87f56a58812-e4e0b304-4d9844f7-b582a589-9b45bba9f14e1911ee10757c",
            "keyId": 72104923 1,
            "filename": "contentcommons-dispositionbeanutils-01.58.30.tgzjar",
            "type": "javascript/Node.jsJava",
            "languagesresolvedType": "javascript/Node.jsJava",
            "description": "Create and parse Content-Disposition headerBeanUtils provides an easy-to-use but flexible wrapper around reflection and introspection.",
            "references": {
                "url": "httpshttp://registrycommons.npmjsapache.org/content-disposition/-/content-disposition-0.5.3.tgzbeanutils/",
                "issueUrl": "http://issues.apache.org/jira/browse/BEANUTILS",
                "homePagepomUrl": "https://github.com/jshttp/content-disposition#readmerepo.maven.apache.org/maven2/commons-beanutils/commons-beanutils/1.8.0/commons-beanutils-1.8.0.pom",
                "genericPackageIndexscmUrl": "httpshttp://wwwsvn.npmjsapache.org/package/content-dispositionviewvc/commons/proper/beanutils/trunk/"
            },
            "directDependency": false true,
            "projects": [
                {
                    "projectName": "Demo Data",
                    "projectToken": "5715a92ea3d345d29512481363d8f9751b87c8fb50c44c46a44e81e90e7407e6"
                }
            ],
            "sha1": "e130caf7e7279087c5616c2007d0485698984fbd0c651d5103c649c12b20d53731643e5fffceb536",
            "name": "content-dispositionCommons BeanUtils",
            "artifactId": "content-disposition-0.5.3.tgzcommons-beanutils",
            "version": "01.58.30",
            "groupId": "contentcommons-dispositionbeanutils",
            "licenses": [
                {
                    "name": "MITApache 2.0",
                    "spdxName": "MITApache-2.0",
                    "url": "http://www.opensource.org/licenses/MITApache-2.0",
                    "references": [
                        {
                            "referenceType": "NPM (details available in Node Package Manager)POM file",
                            "reference": "https://indexrepo.maven.whitesourcesoftwareapache.comorg/grimaven2/app/reader/resource/content/asString/db68c4d9-eadd-4253-b225-414430934c92commons-beanutils/commons-beanutils/1.8.0/commons-beanutils-1.8.0.pom"
                        },
                        {
                            "referenceType
                    ]
                }
            ],
            "copyrightReferences": [
                {
                    "copyright": "Copyright 2000-2008 The Apache Software Foundation",
                    "startYear": "2000",
                    "endYear": "NPM (details available in Node Package Manager)2008",
                                                "referenceauthor": "https://index.whitesourcesoftware.comThe Apache Software Foundation",
                    "textUrl": "/gri/app/reader/resource/content/asString/68640e55d549e4e9-d246ab82-495d4409-a376b19d-9921d18084d7225c3e097be5"
                        },
                        ...........
                }
            ]
        }
    ]
}

Back to top.

Product

Get libraries and their licenses for a specific product.

...

Code Block
{
	"requestType" : "getProductLicenses",
    "userKey": "user_key", 
	"productToken" : "product_token",
 	"excludeProjectOccurrences" : false
}

Response Example (JSON)

Code Block
{
    "libraries": [
        {
            "keyUuid": "7adc8fca56a58812-33f8b304-4a3744f7-b179a589-a1bfb3b266991911ee10757c",
            "keyId": 542406 1,
            "filename": "thorcommons-beanutils-01.198.10.gemjar",
            "type": "RubyJava",
            "languagesresolvedType": "RubyJava",
            "description": "Thor is a toolkit for building powerful commandBeanUtils provides an easy-to-line interfacesuse but flexible wrapper around reflection and introspection.",
            "references": {
                "url": "httpshttp://rubygemscommons.apache.org/gems/thor-0.19.1.gembeanutils/",
                "homePageissueUrl": "http://whatisthor.com/issues.apache.org/jira/browse/BEANUTILS",
                "genericPackageIndexpomUrl": "https://rubygemsrepo.maven.apache.org/gemsmaven2/thor/versions/0.19.1"
            },
            "directDependency": falsecommons-beanutils/commons-beanutils/1.8.0/commons-beanutils-1.8.0.pom",
                "scmUrl": "http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/"
            },
            "directDependency": true,
            "projects": [
                {
                    "projectName": "GH_cloudify-cliDemo Data",
                    "projectToken": "7d254ee8e3ba4f9b88bec55f8e95b07af98452e381d5478fa7b9a30ef47e71dd5715a92ea3d345d29512481363d8f9751b87c8fb50c44c46a44e81e90e7407e6"
                }
            ],
            "sha1": "57d118b7ce6d51be06faab84c4ad5709977e098f0c651d5103c649c12b20d53731643e5fffceb536",
            "name": "thorCommons BeanUtils",
            "artifactId": "thor-0.19.1.gemcommons-beanutils",
            "version": "01.198.10",
            "groupId": "thorcommons-beanutils",
            "licenses": [
                {
                    "name": "MITApache 2.0",
                    "spdxName": "MITApache-2.0",
                    "url": "http://www.opensource.org/licenses/MITApache-2.0",
                    "references": [
                        {
                            "referenceType": "RubyGems (details available in Ruby community’s gem hosting service)POM file",
                            "reference": "https://indexrepo.maven.whitesourcesoftwareapache.comorg/grimaven2/app/reader/resource/content/asString/8be8ce33-c57d-4ebc-ba7c-52be21c56c09commons-beanutils/commons-beanutils/1.8.0/commons-beanutils-1.8.0.pom"
                        }
                    ]
                }
            ],
                        {
                            "referenceType            "copyrightReferences": "RubyGems (details available in Ruby community’s gem hosting service)[
                {
                    "copyright": "Copyright 2000-2008 The Apache Software Foundation",
                    "startYear": "2000",
                    "endYear": "2008",
                                                "referenceauthor": "https://index.whitesourcesoftware.com/The Apache Software Foundation",
                    "textUrl": "/gri/app/reader/resource/content/asString/43734334d549e4e9-bd0bab82-49e84409-9be9b19d-446c15204ac1225c3e097be5"
                                        }
                                ]
                        }
                ],
            ...........
}

 Back to top.

Project

Get libraries and their licenses for a specific project.

...

Response Example (JSON)

Code Block
{
    "libraries" :  [
	        {
            "keyUuid": "991af093-4fae-4683-aef6-5f033df9b6d3",
       "licenses" : [
            "license_name_1",
            "license_name_2", 
            "spdxName":"license_spdx_name"
        ],
        "copyrightReferences": [
            {
            "copyright": "library_copyright_text",
            "startYear": "library_copyright_start_year"
            }
        ],
        "keyUuid": "library_key_uuid",
        "keyId": "library_key_id",
        "filename": "library_file_name",
        "name" : "libarary_name",
        "groupId" : "library_group_id",
        "artifactId" : "library_artifact_id",
        "version" : "library_version",
        "sha1" : "library_sha1",
        "languages": "library_language",
        "references" : {"url":"library_url",
                        "downloadLink":"library_download_link"
                        }
    }
]            "keyId": 246,
            "filename": "xmlpull-1.1.3.1.jar",
            "type": "Java",
            "resolvedType": "Java",
            "references": {
                "url": "http://www.xmlpull.org",
                "issueUrl": "http://www.extreme.indiana.edu/bugzilla/buglist.cgi?product=XmlPull.org",
                "pomUrl": "https://repo.maven.apache.org/maven2/xmlpull/xmlpull/1.1.3.1/xmlpull-1.1.3.1.pom"
            },
            "directDependency": false,
            "projects": [
                {
                    "projectName": "WST_464",
                    "projectToken": "29a15e6d3d7744c09a3b9975e4bd6d702da71f13a0ab434aadd6a27f4db07849"
                }
            ],
            "sha1": "2b8e230d2ab644e4ecaa94db7cdedbc40c805dfa",
            "name": "XML Pull Parsing API",
            "artifactId": "xmlpull",
            "version": "1.1.3.1",
            "groupId": "xmlpull",
            "licenses": [
                {
                    "name": "Public Domain",
                    "url": "http://creativecommons.org/licenses/publicdomain/",
                    "references": [
                        {
                            "referenceType": "POM file",
                            "reference": "https://repo.maven.apache.org/maven2/xmlpull/xmlpull/1.1.3.1/xmlpull-1.1.3.1.pom"
                        }
                    ]
                }
            ],
            "copyrightReferences": []
        }
    ]
}

Back to top.

Get Licenses Histogram

...