Custom attributes (assigned entities)

This endpoint is used to search for the assigned entities by attribute.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/customAttributes/{attributeId}/assignedEntities/search

Sample URLs

https://{api-url}/api/v2/tenants/client_93/customAttributes/10/assignedEntities/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=id:1271+value=custom_attr_from_API_test_2_value
https://{api-url}/api/v2/tenants/msp_92/customAttributes/11/assignedEntities/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=id:1270+value=custom_attr_from_API_test_2_value

Parameters

All parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariablesDescription
idThe attribute ID.
valueCustom attribute value.
sourceFilter with tagSource.

Sample response

{
	"results": [{
			"id": 1271,
			"customAttributeValue": {
				"id": 399,
				"customAttribute": {
					"id": 63,
					"name": "custom_attribute_from_API_test_1",
					"description": "Custom_Attribute_from_API_test_1_Update",
					"organization": {
						"id": 93,
						"uniqueId": "client_93",
						"name": "Brocade Lab",
						"activated": true
					}
				},
				"value": "custom_attribute_from_API_test_2_value",
				"description": "Custom_Attribute_from_API_test_2_value_Description"
			},
			"taggable": {
				"id": "DEV0000015747",
				"name": "sjlptCampusGolden",
				"entityType": "Device",
                                "resourceName":"testDev".
                                "hostName":"testDev",
                                "resourceType":"Desktop",
                                "aliasName" : ""
			},
			"tagSource": "OPSRAMP"
		},
		{
			"id": 1270,
			"customAttributeValue": {
				"id": 399,
				"customAttribute": {
					"id": 63,
					"name": "custom_attribute_from_API_test_1",
					"description": "Custom_Attribute_from_API_test_1_Update",
					"organization": {
						"id": 93,
						"uniqueId": "client_93",
						"name": "Brocade Lab",
						"activated": true
					}
				},
				"value": "custom_attribute_from_API_test_2_value",
				"description": "Custom_Attribute_from_API_test_2_value_Description"
			},
			"taggable": {
				"id": "DEV0000015776",
				"name": "INMON-SFLOW",
				"entityType": "Device",
                                "resourceName":"testDev".
                                "hostName":"testDev",
                                "resourceType":"Desktop",
                                "aliasName" : ""
			},
			"tagSource": "OPSRAMP"
		},
		{
			"id": 1244,
			"customAttributeValue": {
				"id": 396,
				"customAttribute": {
					"id": 63,
					"name": "custom_attribute_from_API_test_1",
					"description": "Custom_Attribute_from_API_test_1_Update",
					"organization": {
						"id": 93,
						"uniqueId": "client_93",
						"name": "Brocade Lab",
						"activated": true
					}
				},
				"value": "custom_attribute_from_API_test_1_value",
				"description": "Desc_Custom_Attribute_from_API_test_1_Update_1"
			},
			"taggable": {
				"id": "SGP-d7657432-3698-4894-a07f-c2ef9aa0789e",
				"name": "Service",
				"entityType": "ServiceGroup"
			},
			"tagSource": "OPSRAMP"
		},
		{
			"id": 1239,
			"customAttributeValue": {
				"id": 396,
				"customAttribute": {
					"id": 63,
					"name": "custom_attribute_from_API_test_1",
					"description": "Custom_Attribute_from_API_test_1_Update",
					"organization": {
						"id": 93,
						"uniqueId": "client_93",
						"name": "Brocade Lab",
						"activated": true
					}
				},
				"value": "custom_attribute_from_API_test_1_value",
				"description": "Desc_Custom_Attribute_from_API_test_1_Update_1"
			},
			"taggable": {
				"id": "DEV0000015767",
				"name": "AD-14",
				"entityType": "Device",
			        "resourceName":"testDev".
                                "hostName":"testDev",
                                "resourceType":"Desktop",
                                "aliasName" : ""
                        },
			"tagSource": "OPSRAMP"
		},
		{
			"id": 1238,
			"customAttributeValue": {
				"id": 396,
				"customAttribute": {
					"id": 63,
					"name": "custom_attribute_from_API_test_1",
					"description": "Custom_Attribute_from_API_test_1_Update",
					"organization": {
						"id": 93,
						"uniqueId": "client_93",
						"name": "Brocade Lab",
						"activated": true
					}
				},
				"value": "custom_attribute_from_API_test_1_value",
				"description": "Desc_Custom_Attribute_from_API_test_1_Update_1"
			},
			"taggable": {
				"id": "SGP-a7657435-3698-3894-b07f-v2ef9aa0789e",
				"name": "Service",
				"entityType": "ServiceGroup"
			},
			"tagSource": "OPSRAMP"
		}
	],
	"totalResults": 5,
	"orderBy": "id",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"nextPageNo": 0,
	"previousPageNo": 0,
	"descendingOrder": true
}