Page History

Info
This page refers to End-user REST API version 1 only. See End-user REST API for links to other versions of the End-user REST API.

The following page lists The following page lists the HTTP operations that need to be performed to successfully query successfully query an LAC license . The client can successfully use the methods described below if the server is configured to support a given combination of methods.

Each web service that a client wishes to interact with has two parts: request parameters and the response, as described below.

using the End-user REST API version 1.

To obtain a To obtain a license for a given Activation Key activation key filtered by its state, use the following request:

Panel
`GET` /`licenses`/*(activation_key)?state=(states)*

where:

The activation_key (string) is your product activation key.
your license order activation key

and

The state (string) indicates a required, comma-separated value, which . The state can be one of the following: activated success, failed, in-_progress.

Note: The order of the states is irrelevant and does not influence the results of the request.

...

Code Block

language	js
firstline	1
linenumbers	true

GET /rest/v1/licenses/25N8D-NC35D-WD01P-8JI4K?state=activatedsuccess,failed HTTP/1.1 
Host: license.x-formation.com
Accept: application/hal+json

Response

The LAC REST API returns standard HTTP response codes as described in the following table.

Status Code	Header Field	Description
200 OK	Allow Cache-Control Content-Encoding Content-Language Content-Length Content-Type Date

The collection

Collection of licenses for a given state.
400 Bad Request	Unsupported license state.
403 Forbidden

The license

License order has been disabled.
404 Not Found	No licenses were found for a given state.

Example responseresponses

Code Block

language	textjs
firstline	1
linenumbers	true

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "_links": {
        "activatedsuccess": [
            {
                "href": "https://license.x-formation.com/rest/v1/licenses/25N8D-NC35D-WD01P-8JI4K/Q1VTVE9NPWE="
            },
            {
                "href": "https://license.x-formation.com/rest/v1/licenses/25N8D-NC35D-WD01P-8JI4K/Q1VTVE9NPWI="
            }
        ],
        "failed": [
            {
                "href": "https://license.x-formation.com/rest/v1/license-errors/25N8D-NC35D-WD01P-8JI4K/Q1VTVE9NPXNkZnNkZnNkZg=="
            }
        ]
    },
    "_embedded": {
        "activatedsuccess": [
            {
                "activationKey": "25N8D-NC35D-WD01P-8JI4K",
                "activationTime": "2014-04-29T11:31:51+00:00",
                "expirationDate": null,
                "maintenanceEndDate": null,
                "hostids": [
                    {
                        "nameRaw": "CUSTOM",
                        "name": "Custom",
                        "value": "a"
                    }
                ],
                "content": "# This license is generated using X-Formation License Activation Center
                            # Generation Time: 2014-04-29 11:31:50 GMT
                            # Activation Key: 25N8D-NC35D-WD01P-8JI4K

                            FEATURE feature-1
                            {
                            VENDOR=X-FORMATION VERSION=1.0
                            KEY=QQkUjKBGw6vPmoNM7cQIeHriCThHSD7psQSp0]YRAibvJbD]hrxC]fiZ1VyAnjb9uJuNivH67TIn7ygcOzO4AUNfVrgQ0oooFlhh \
                                 tapNGT0hc1xe2UdTxxFt2y0S1Zi6uZ[JDpFc27Bjq3AIDSI7br[VrUqYGovQvkGnqwFk9ADKt9lEvTmirWz27FjEg2WIpGh[Qaatc \
                                 te2tEXcIvy[iFH1e]jj18LQcHXnp8ze4zzeHyoGfXeqIL[BdELtQQ6q5oKJ8ACmrfZF2Rh2tKZOWKq4xXs4xmn0XsdRT3QDco2o9d \
                                 ttwtPAh2ABimjNbrlPF8V9sabGw5]GU4poT7rq]pyDjnckbLTZ9z5f]4K[Tbb]Aa7406K8gx4dO6wFITq0NRgmmfFOLSEn6KHdwFf \
                                 tERlqVXGzGjU7R490iA6cc43cnbHom[qMGboDOmIysXreBLgrWJ2wURL97U83njRQaL4qSHXXIVGTSxSvVCoWFcVq3urCHHAMhsaw
                            }",
                "filename": "license_2014_04_29-11_31.lic",
                "_links": {
                    "self": {
                        "href": "https://license.x-formation.com/rest/v1/licenses/25N8D-NC35D-WD01P-8JI4K/Q1VTVE9NPWE="
                    }
                }
            },
            {
                "activationKey": "25N8D-NC35D-WD01P-8JI4K",
                "activationTime": "2014-05-06T13:42:16+00:00",
                "expirationDate": null,
                "maintenanceEndDate": null,
                "hostids": [
                    {
                        "nameRaw": "CUSTOM",
                        "name": "Custom",
                        "value": "b"
                    }
                ],
                "content": "# This license is generated using X-Formation License Activation Center
                            # Generation Time: 2014-04-29 11:31:50 GMT
                            # Activation Key: 25N8D-NC35D-WD01P-8JI4K

                            FEATURE feature-2
                            {
                            VENDOR=X-FORMATION VERSION=1.0
                            KEY=QQkUjKBGw6vPmoNM7cQIeHriCThHSD7psQSp0]YRAibvJbD]hrxC]fiZ1VyAnjb9uJuNivH67TIn7ygcOzO4AUNfVrgQ0oooFlhh \
                                 tapNGT0hc1xe2UdTxxFt2y0S1Zi6uZ[JDpFc27Bjq3AIDSI7br[VrUqYGovQvkGnqwFk9ADKt9lEvTmirWz27FjEg2WIpGh[Qaatc \
                                 te2tEXcIvy[iFH1e]jj18LQcHXnp8ze4zzeHyoGfXeqIL[BdELtQQ6q5oKJ8ACmrfZF2Rh2tKZOWKq4xXs4xmn0XsdRT3QDco2o9d \
                                 ttwtPAh2ABimjNbrlPF8V9sabGw5]GU4poT7rq]pyDjnckbLTZ9z5f]4K[Tbb]Aa7406K8gx4pO6wFITq0NRgmmfFOLSEn6KHdwFf \
                                 tERlqVXGzGjU7R490iA6cc43cnbHom[qMGboDOmIysXreBLgrWJ2wURL97U83njRQaL4qSHXXIVGTSxSvVCoWFcVq3urCHHAMhsaw
                            }",
                "filename": "license_2014_06_05-13_42.lic",
                "_links": {
                    "self": {
                        "href": "https://license.x-formation.com/rest/v1/licenses/25N8D-NC35D-WD01P-8JI4K/Q1VTVE9NPWI="
                    }
                }
            }
        ],
        "failed": [
            {
                "errors": [
                    {
                        "message": "LM-X XML License Generator v4.5.3
                                    Copyright (C) 2002-2013 X-Formation. All rights reserved.

                                    LM-X Error: Unable to parse and load xml file /tmp/lgtmp_id_2/1400064446_139933.in!
                                    LM-X Error: /tmp/lgtmp_id_2/1400064446_139933.in(7): not well-formed (invalid token)!",
                        "creationTime": "2014-05-08T07:17:41+00:00"
                    }
                ],
                "_links": {
                    "self": {
                        "href": "https://license.x-formation.com/rest/v1/license-errors/25N8D-NC35D-WD01P-8JI4K/Q1VTVE9NPXNkZnNkZnNkZg=="
                    }
                }
            }
        ]
    }
}

Code Block

language	js
firstline	1
linenumbers	true

HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
 
{
    "message": "License state value \"abc\" is not valid"
}

Code Block

language	js
firstline	1
linenumbers	true

HTTP/1.1 403 Forbidden
Content-Type: application/hal+json
 
{
    "message": "License order has been disabled."
}

Code Block

language	js
firstline	1
linenumbers	true

HTTP/1.1 404 Not Found
Content-Type: application/hal+json

For more information about HTTP methods, see Supported HTTP methods.

Page tree

Versions Compared

Old Version 6

New Version Current

Key