Device and Group Activation Recommendation

Note

This recommendation to check status is applicable only for entities created in Profiles.

Before proceeding to, activate a Group or Device in Trimble IoT APIs / configuring a device public key in Bootstrap API, it is recommended to check the status of the creation of Group, Device or Relation appropriately in Profiles API. Validate complete field in status API response in order to prevent unexpected forbidden error during activation.

Profiles Resource Status

Below is a Profiles API request sample to check resource status of a Device, Group or Relation.

Note

REQUEST

POST {ProfilesBaseURL}{requestStatusUrl}

Header

Content-Type: application/json

Authorization: Bearer

Staging ProfilesBaseURL: https://cloud.stage.api.trimblecloud.com/tcloud-profiles-stage/1.0

Sample requestStatusUrl: /api/profiles/requests/26840c50-8549-47ee-ba8a-aa8a21eeb64b

Sample curl

curl --location '{ProfilesBaseURL}{requestStatusUrl}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Access-Token>'

Request Status Url can be obtained from the response of Group/Device/Relation creation.

Sample Profiles API Response of Group/Device/Relation creation

{
    "requestStatusUrl": "/api/profiles/requests/26840c50-8549-47ee-ba8a-aa8a21eeb64b",
    "trn": "trn:profiles:{resources}:01ea8592-16cc-4782-9286-a0ce3f7d03a3",
    "uuid": "01ea8592-16cc-4782-9286-a0ce3f7d03a3"
}

{resources} - represents either groups, devices or relations.

Tip

Response Code 200 OK

Response Body

{
    "trn": "trn:profiles:groups:01ea8592-16cc-4782-9286-a0ce3f7d03a3",
    "complete": true,
    "status": {
        "crud": {
            "status": "COMPLETED"
        },
        "replication": {
            "status": "COMPLETED"
        },
        "search": {
            "status": "COMPLETED"
        },
        "events": {
            "status": "COMPLETED"
        },
        "authz": {
            "status": "COMPLETED"
        }
    }
}

Failure Response

Response Code 200 OK

Response Body

{
    "trn": "trn:profilespt:devices:fc363fbe-330e-47c5-88b0-e96dfd8a2b40",
    "complete": false,
    "status": {
        "crud": {
            "status": "COMPLETED"
        },
        "search": {
            "status": "COMPLETED"
        },
        "authz": {
            "status": "FAILED",
            "message": "Request timed out. Retries exhausted."
        }
    }
}