Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET UserDefinedFieldDefinition

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Provides a view of the User Defined Field Definitions of the system

Since Product Version: 2.2

Resource URL

/webacs/api/v1/data/UserDefinedFieldDefinition

Response Parameters

Type Attribute Name Description

String

description

The description of the user defined field

String

instanceUuid

This is a uuid for this instance.

String

name

The name of the user defined field. The name is case insensitive and should be unique

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Payload

https://172.25.123.114/webacs/api/v1/data/UserDefinedFieldDefinition/15

<?xml version="1.0" ?>
<queryResponse type="UserDefinedFieldDefinition" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/UserDefinedFieldDefinition/15" rootUrl="https://172.25.123.114/webacs/api/v1/data">
  <entity dtoType="userDefinedFieldDefinitionDTO" type="UserDefinedFieldDefinition" url="https://172.25.123.114/webacs/api/v1/data/UserDefinedFieldDefinition/15">
    <userDefinedFieldDefinitionDTO displayName="String value" id="15" uuid="String value">
      <description>String value</description>
      <name>String value</name>
    </userDefinedFieldDefinitionDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.25.123.114/webacs/api/v1/data/UserDefinedFieldDefinition/15.json

{
  "queryResponse" : {
    "@type" : "UserDefinedFieldDefinition",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/UserDefinedFieldDefinition\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "userDefinedFieldDefinitionDTO",
      "@type" : "UserDefinedFieldDefinition",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/UserDefinedFieldDefinition\/15",
      "userDefinedFieldDefinitionDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "description" : "String value",
        "name" : "String value"
      }
    }
  }
}