Retrieve Product

Learn about the comprehensive details of a single product in a system, including its features, custom fields, installation files, and properties like name, code, activation status, trial options, and licensing details. This document also provides metadata.

GET /api/v1/products/{id}/

Retrieve a single product if the requesting manager has access permissions to it.

Responses

200
{
    "id": 1584723961091234,
    "upgrade_from": [],
    "product_features": [
        {
            "id": 171,
            "created_at": "2020-08-26T05:36:46Z",
            "updated_at": "2020-08-26T05:36:46Z",
            "name": "Feature 1",
            "code": "f1",
            "is_deleted": false,
            "feature_type": "activation",
            "max_consumption": 0,
            "allow_overages": false,
            "max_overages": 0,
            "reset_consumption": false,
            "consumption_period": null,
            "metadata": {}
        },
        {
            "id": 172,
            "created_at": "2020-08-26T05:37:14Z",
            "updated_at": "2020-08-26T05:37:14Z",
            "name": "Feature 2",
            "code": "f2",
            "is_deleted": false,
            "feature_type": "consumption",
            "max_consumption": 20,
            "allow_overages": false,
            "max_overages": 0,
            "reset_consumption": false,
            "consumption_period": null,
            "metadata": {}
        }
    ],
    "custom_fields": [
        {
            "id": 51,
            "name": "Some key",
            "data_type": null,
            "default_value": "1234",
            "description": null
        },
        {
            "id": 60,
            "name": "test_name",
            "data_type": null,
            "default_value": "123",
            "description": null
        },
        {
            "id": 61,
            "name": "Key with space",
            "data_type": null,
            "default_value": "123",
            "description": null
        }
    ],
    "installation_files": [
        {
            "id": 733282,
            "created_at": "2020-10-13T09:15:22Z",
            "updated_at": "2020-10-13T09:15:22Z",
            "version": "0.1",
            "full_link": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
            "filename": "dummy.pdf",
            "release_date": "2020-10-09",
            "enabled": true,
            "hash_md5": "",
            "environment": "linux"
        },
        {
            "id": 733283,
            "created_at": "2020-10-13T09:15:52Z",
            "updated_at": "2020-10-13T09:15:52Z",
            "version": "0.2",
            "full_link": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
            "filename": "dummy.pdf",
            "release_date": "2020-10-10",
            "enabled": true,
            "hash_md5": "sonotahash",
            "environment": "linux"
        }
    ],
    "created_at": "2020-07-03T13:05:25Z",
    "updated_at": "2020-07-07T12:35:05Z",
    "product_name": "mch",
    "short_code": "mch",
    "active": true,
    "valid_duration": "",
    "allow_trial": false,
    "trial_days": 0,
    "max_activations": 1,
    "hardware_id_required": false,
    "is_upgrade": false,
    "subscription_duration": "",
    "enable_maintenance_period": false,
    "maintenance_duration": "",
    "is_floating": true,
    "is_floating_cloud": false,
    "floating_users": 12,
    "floating_timeout": 120,
    "default_license_type": "perpetual",
    "is_user_locked": false,
    "is_node_locked": true,
    "max_consumptions": 1,
    "authorization_method": "user",
    "prevent_vm": false,
    "allow_overages": false,
    "max_overages": 0,
    "reset_consumption": false,
    "consumption_period": null,
    "is_archived": false,
    "metadata": {},
    "company": 277
}

Last updated

Was this helpful?