Endpoint
/api/v2/tenants/{tenantId}/customAttributes/{attributeId}

Deletes the tenant custom attribute.

Path Parameters
tenantId
string

Describes the client ID of the tenant

attributeId
string

Responses

OK

Endpoint
/api/v2/tenants/{tenantId}/customAttributes/{attributeId}

Gets the custom attribute types and respective values.

Path Parameters
tenantId
string

Describes the client ID of the tenant

attributeId
string

Responses

OK

customAttributeValues
array

customAttributeValues.customAttribute
customAttributeValues.description
customAttributeValues.id
customAttributeValues.value
Values of the custom attributes values.
description
string

id
integer

name
string

organization
object

organization.activated
organization.id
organization.name
organization.uniqueId
{
  "customAttributeValues": [
    {
      "description": "desc_custom_attr_from_API_test_1_update_1",
      "id": 396,
      "value": "custom_attr_from_API_test_1_value"
    },
    {
      "description": "custom_attr_from_API_test_2_value_description",
      "id": 399,
      "value": "custom_attr_from_API_test_2_value"
    }
  ],
  "description": "custom_attr_from_API_test_1_update",
  "id": 63,
  "name": "custom_attr_from_API_test_1",
  "organization": {
    "activated": true,
    "id": 93,
    "name": "Brocade Lab",
    "uniqueId": "client_93"
  }
}
Endpoint
/api/v2/tenants/{tenantId}/customAttributes/{attributeId}

Updates the description and adds new values to a custom attribute.

Path Parameters
tenantId
string

Describes the client ID of the tenant

attributeId
string

customAttributeValues
array

customAttributeValues.customAttribute
customAttributeValues.description
customAttributeValues.id
customAttributeValues.value
Values of the custom attributes values.
description
string

id
integer

name
string

organization
object

organization.activated
organization.id
organization.name
organization.uniqueId
{
  "customAttributeValues": [
    {
      "description": "creating first value for tenant update",
      "value": "test_val_1_for_custom_attr_type_for_tenant_1"
    },
    {
      "description": "creating second value for tenant update",
      "value": "test_val_2_for_custom_attr_type_for_tenant_2"
    }
  ],
  "description": "creating custom_type for tenant update"
}

Responses

OK

description
string

id
integer

name
string

{
  "description": "creating custom_type for tenant update",
  "id": 1,
  "name": "custom_attr_type_for_tenant"
}