Activate a License

Licenses must be activated to be available for use. Activations generally come through Trimble ID for end users. Below is the manual call to activate the license for the set user.

Licenses must be assigned to an end user or device to be usable.

API Call:

POST {baseurl}/entitlements/activations

Headers

• Accept: application/json
  (This may be automatically added by your development tool. Postman and CURL add this header to all requests by default.)

• Authorization: Bearer {bearer token}
  (Include Trimble Identity OAuth Bearer token for your application. Please see “Get access token” for more information.)

Body:

Base your body on the example request code sample below. This example shows the minimum required request body. See the API definition for parameter details and additional optional parameters.

Example Request Body:

{
  "entitlementId": "aae64080-f686-4b5f-961b-80b9c7e807b5",
  "lineItemId": "07ab924d-4fc6-4d8d-8135-a0bed7876921",
  "activatorId": "testUserId_1597677750510",
  "lineItemActivationAttributes": {
    "attributeGroups": [
      {
        "name": "LOCKING",
        "attributes": [
          {
            "name": "Locking Code",
            "value": "1",
            "readOnly": "false"
          }
        ]
      }
    ]
  }
}

Example Response Body:

{
  "product": {
    "productId": "602",
    "sku": "WSMFREE",
    "name": "WSMFREE",
    "features": [
      {
        "featureId": "308",
        "name": "FEA-WRKSMNGR",
        "version": "1.0",
        "externalId": "FEA-WRKSMNGR",
        "enforcement": {
          "enforcementName": "License Generator",
          "enforcementVersion": "1.0",
          "isEntitlementAsWhole": false
        },
        "licenseModel": {
          "licenseModelId": "2",
          "licenseModelName": "Days based"
        },
        "isExternal": false
      }
    ]
  },
  "accounts": [
    {
      "accountId": "sampleId1597677750507",
      "type": "CUSTOMER",
      "name": "SampleName1597677750507",
      "isPrimary": true
    }
  ],
  "quantity": 1,
  "activationMethod": "FIXED",
  "activationStartDate": {
    "year": 2017,
    "month": 12,
    "day": 15
  },
  "activationId": "c2d27817-f239-48b4-94b0-96fd4b8abacd",
  "entitlementId": "aae64080-f686-4b5f-961b-80b9c7e807b5",
  "lineItemId": "07ab924d-4fc6-4d8d-8135-a0bed7876921",
  "activatorId": "testUserId_1597677750510",
  "isActive": true,
  "activationDate": {
    "year": 2020,
    "month": 8,
    "day": 17
  },
  "expiryDate": {
    "year": 2028,
    "month": 12,
    "day": 14
  },
  "currentState": "ACTIVATED",
  "licenceKeysInfo": [
    {
      "keyGenTechnology": "DEMO",
      "keyFormat": "TEXT",
      "keyType": "NORMAL",
      "keyFileName": "lservrc",
      "keyFileDescription": "",
      "isWWU": "false",
      "licenseKey": "This is Days Based License valid for 30 days. Other Properties:  Enforce Clock Tamper = false Concurrent Users = 5 Locking Code = 1 1597681706163"
    }
  ],
  "lineItemActivationAttributes": {
    "attributeGroups": [
      {
        "name": "LOCKING",
        "attributes": [
          {
            "name": "Locking Code",
            "value": "1",
            "readOnly": false
          }
        ]
      }
    ]
  },
  "trn": "TRN:Activation:36308de3-41e8-4095-882a-e7bf32344970"
}

Response Code

• 201 Created – The license has been successfully activated.

---

This documentation provides a complete overview of how to activate a license using the API call, including headers, body, and example responses.

---