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

PUT udfService/importUserTagDefinition

An operation to create or update User Defined Field definitions.

Since Product Version: 2.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

/webacs/api/v1/op/udfService/importUserTagDefinition

Request Payload Parameters

Attribute Description

definitions Arrow image UDFDefinition[]

Required

A list of User Defined Field Definitions

Response Parameters

Attribute Description

operation String

The name of the operation.

results Arrow image UDFResult[]

List of operation results.

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 Request Payload

https://10.56.58.149/webacs/api/v1/op/udfService/importUserTagDefinition

<?xml version="1.0" ?>
<definitionImport>
  <definitions>
    <definition>
      <description>String value</description>
      <name>String value</name>
    </definition>
    <definition>
      <description>Another string value</description>
      <name>Another string value</name>
    </definition>
  </definitions>
</definitionImport>

Sample JSON Request Payload

https://10.56.58.149/webacs/api/v1/op/udfService/importUserTagDefinition.json

{
  "definitionImport" : {
    "definitions" : {
      "definition" : [{
        "description" : "String value",
        "name" : "String value"
      },
      {
        "description" : "Another string value",
        "name" : "Another string value"
      }]
    }
  }
}

Sample XML Response Payload

https://10.56.58.149/webacs/api/v1/op/udfService/importUserTagDefinition

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v1/op/udfService/importUserTagDefinition" rootUrl="https://10.56.58.149/webacs/api/v1/op">
  <udfOperationResult>
    <operation>String value</operation>
    <results>
      <result>
        <message>String value</message>
        <name>String value</name>
        <status>String value</status>
      </result>
      <result>
        <message>Another string value</message>
        <name>Another string value</name>
        <status>Another string value</status>
      </result>
    </results>
  </udfOperationResult>
</mgmtResponse>

Sample JSON Response Payload

https://10.56.58.149/webacs/api/v1/op/udfService/importUserTagDefinition.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op\/udfService\/importUserTagDefinition",
    "@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op",
    "udfOperationResult" : {
      "operation" : "String value",
      "results" : {
        "result" : [{
          "message" : "String value",
          "name" : "String value",
          "status" : "String value"
        },
        {
          "message" : "Another string value",
          "name" : "Another string value",
          "status" : "Another string value"
        }]
      }
    }
  }
}