Associate Device ID Profiles in Bulk (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/deviceidprofiles/:deviceid_profile_id/operations

Associate multiple sites to a profile.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

deviceid_profile_id stringrequired

Device ID of the profile ID.

application/json

Body

Details of the Device ID profile and sites to be associated

disabled boolean

Disable the device id profile.

disabled_reason string

Reason to disable the device id profile.

id string

Device ID.

inactive boolean

Device id profile (active or inactive).

inactive_reason string

Reason for profile to be inactive.

name string

Name of the device ID profile.

region string

Profile region.

sites SiteDetails[]required
The device ID site.
Array [
site_id string
The profile site ID.
]
tenant_id stringrequired

Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)

type string

The device ID profile type.

Responses

200

Successful Operation

application/json

Schema

Schema

disabled boolean

Disable the device id profile.

disabled_reason string

Reason to disable the device id profile.

id string

Device ID.

inactive boolean

Device id profile (active or inactive).

inactive_reason string

Reason for profile to be inactive.

name string

Name of the device ID profile.

region string

Profile region.

sites SiteDetails[]required
The device ID site.
Array [
site_id string
The profile site ID.
]
tenant_id stringrequired

Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)

type string

The device ID profile type.

Example (from schema)

{
  "disabled": true,
  "disabled_reason": "string",
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "name": "string",
  "region": "string",
  "sites": [
    {
      "site_id": "string"
    }
  ],
  "tenant_id": "string",
  "type": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "DEVICEID_INVALID_PROFILE_OPERATION"
      },
      {
        "code": "DEVICEID_SITES_MISSING"
      },
      {
        "code": "DEVICEID_DUPLICATE_SITE_DETECTED"
      },
      {
        "code": "DEVICEID_INVALID_DEVICEID_PROFILE"
      },
      {
        "code": "DEVICEID_INVALID_SITE_IDS"
      },
      {
        "code": "DEVICEID_PROFILE_UPDATE_FAILED"
      },
      {
        "code": "DEVICEID_LOCAL_SNMP_DISCOVERY_CANNOT_BE_ENABLE_FOR_DC_SITE"
      }
    ]
  }
}

Loading...