
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

- Jump To

- v1
- v2
- v3
- v4

### 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 UDFDefinition[] | Required A list of User Defined Field Definitions
Attribute | Description
--- | ---
description String | Required A description of the User Defined Field. The maxium lenght of the description is 255 characters. Extral characters will be trimmed
name String | Required A name of the User Defined Definition. The maximun lenght of the name is 128 characters. Extral characters will be trimmed. The name should be unique. The allowed characters are A-Z,a-z,0-9,_ and -

## Response Parameters

Attribute | Description
--- | ---
operation String | The name of the operation.
results UDFResult[] | List of operation results.
Attribute | Description
--- | ---
message String | The system generated message
name String | The name of the User Defined Field
status String | The status of the operation on this User Defined Field

## 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://172.20.127.108/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://172.20.127.108/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://172.20.127.108/webacs/api/v1/op/udfService/importUserTagDefinition

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v1/op/udfService/importUserTagDefinition.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/udfService\/importUserTagDefinition",
        "@rootUrl" : "https : \/\/172.20.127.108\/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"
            }]
          }
        }
      }
    }

### 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

## Resource URL

/webacs/api/v2/op/udfService/importUserTagDefinition

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
definitions UDFDefinition[] | Required A list of User Defined Field Definitions
Attribute | Description
--- | ---
description String | Required A description of the User Defined Field. The maxium lenght of the description is 255 characters. Extral characters will be trimmed
name String | Required A name of the User Defined Definition. The maximun lenght of the name is 128 characters. Extral characters will be trimmed. The name should be unique. The allowed characters are A-Z,a-z,0-9,_ and -

## Response Parameters

Attribute | Description
--- | ---
operation String | The name of the operation.
results UDFResult[] | List of operation results.
Attribute | Description
--- | ---
message String | The system generated message
name String | The name of the User Defined Field
status String | The status of the operation on this User Defined Field

## 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://172.20.127.108/webacs/api/v2/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://172.20.127.108/webacs/api/v2/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://172.20.127.108/webacs/api/v2/op/udfService/importUserTagDefinition

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/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://172.20.127.108/webacs/api/v2/op/udfService/importUserTagDefinition.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/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"
            } ]
          }
        } ]
      }
    }

### 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

## Resource URL

/webacs/api/v3/op/udfService/importUserTagDefinition

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
definitions UDFDefinition[] | Required A list of User Defined Field Definitions
Attribute | Description
--- | ---
description String | Required A description of the User Defined Field. The maxium lenght of the description is 255 characters. Extral characters will be trimmed
name String | Required A name of the User Defined Definition. The maximun lenght of the name is 128 characters. Extral characters will be trimmed. The name should be unique. The allowed characters are A-Z,a-z,0-9,_ and -

## Response Parameters

Attribute | Description
--- | ---
operation String | The name of the operation.
results UDFResult[] | List of operation results.
Attribute | Description
--- | ---
message String | The system generated message
name String | The name of the User Defined Field
status String | The status of the operation on this User Defined Field

## 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://172.20.127.108/webacs/api/v3/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://172.20.127.108/webacs/api/v3/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://172.20.127.108/webacs/api/v3/op/udfService/importUserTagDefinition

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v3/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://172.20.127.108/webacs/api/v3/op/udfService/importUserTagDefinition.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v3/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"
            } ]
          }
        } ]
      }
    }

### 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

## Resource URL

/webacs/api/v4/op/udfService/importUserTagDefinition

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
definitions UDFDefinition[] | Required A list of User Defined Field Definitions
Attribute | Description
--- | ---
description String | Required A description of the User Defined Field. The maxium lenght of the description is 255 characters. Extral characters will be trimmed
name String | Required A name of the User Defined Definition. The maximun lenght of the name is 128 characters. Extral characters will be trimmed. The name should be unique. The allowed characters are A-Z,a-z,0-9,_ and -

## Response Parameters

Attribute | Description
--- | ---
operation String | The name of the operation.
results UDFResult[] | List of operation results.
Attribute | Description
--- | ---
message String | The system generated message
name String | The name of the User Defined Field
status String | The status of the operation on this User Defined Field

## 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://172.20.127.108/webacs/api/v4/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://172.20.127.108/webacs/api/v4/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://172.20.127.108/webacs/api/v4/op/udfService/importUserTagDefinition

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v4/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://172.20.127.108/webacs/api/v4/op/udfService/importUserTagDefinition.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v4/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"
            } ]
          }
        } ]
      }
    }