Create a New Device

To create a new device, the client must send a POST request to: /aims/rs/scm/v2/Device.

The creation is allowed only if automatic device creation is enabled (see screenshot below – and Setting Miscellaneous Parameters for details).

Otherwise, you must use either the Exchange Manager (see About the Exchange Manager) or ActivID BMS to import new devices into the database.

The possible HTTP status codes returned are:

  • 201: Created

  • 400: Bad Request

  • 401: Unauthorized

  • 403: Forbidden

  • 409: Conflict

Example request:

Copy 
POST /aims/rs/scim/v2/Device HTTP/1.1
Host: cms.mycompany.com
Accept: application/scim+json
Content-Type: application/scim+json
Authorization: Bearer h480djs93hd8
Content-Length: ...

{
  "externalIds": [
    {
      "ATR": "3BD996FF8191FE1FC343323330302D4B4559BA",
      "CUID": "47900503004400045678"
    }
  ],
  "schemas": [
    "urn:hid:scim:api:cms:1.0:Device"
  ]
}

Example response:

Copy 
HTTP/1.1 200 OK
Content-Type: application/scim+json
Location: https://cms.mycompany.com/aims/rs/scim/v2/Device/OP_2.047900503004400045678

{
  "id": "OP_2.047900503004400045678",
  "meta": {
    "created": "2023-03-23T14:14:05.049Z",
    "lastModified": "2023-03-23T14:14:05.049Z",
    "location": "https://cms.mycompany.com/aims/rs/scim/v2/Device/OP_2.047900503004400045678",
    "resourceType": "Device"
  },
  "status": {
    "status": "ON_HOLD",
    "reason": "LOST"
  },
  "externalIds": [
    {
      "CUID": "47900503536900499999",
      "ATR": "3BD996FF8191FE1FC343323330302D4B4559BA"
    }
  ],
  "schemas": [
    "urn:hid:scim:api:cms:1.0:Device"
  ]
}