Jump to

• Request
• Response

Get Additional Attribute Metadata

post

/rest/{versionId}/configuration/deviceConfigs/{deviceId}/elementTypes/attributeMetadata

Use this (POST) method to retrieve additional meta-data information about a targeted attribute for a targeted configuration element. SDM configuration support is model driven to allow a user to query any attribute supported by a release, and get additional information on that attribute such as what type of values it supports, the range of values, if it is a required attribute, if the attribute is part of a primary or foreign key relationship, and so on. A client can be configured use this metadata to describe the characteristics of all attributes supported by a device release.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• deviceId: string
• versionId: string

Body ()

Root Schema : attributeTypeRequest

Type: object

Show Source

• attributeName(optional): string
• elementTypePath(optional): string

{
    "type":"object",
    "properties":{
        "elementTypePath":{
            "type":"string"
        },
        "attributeName":{
            "type":"string"
        }
    },
    "xml":{
        "name":"attributeTypeRequest"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : attributeMetadata

Type: object

Show Source

• cliName(optional): string
• defaultValue(optional): string
• delimiter(optional): string
• enumeratedValues(optional): array enumeratedValue
• key(optional): boolean
  Default Value: false
• name(optional): string
• referredElementType(optional): string
• referredValues(optional): array referredValue
• regExpPattern(optional): array regExpPatterns
• required(optional): boolean
  Default Value: false
• suggestedValues(optional): array suggestedValue
• validNumericRange(optional): array validNumericRanges
• valueType(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "cliName":{
            "type":"string"
        },
        "valueType":{
            "type":"string"
        },
        "delimiter":{
            "type":"string"
        },
        "defaultValue":{
            "type":"string"
        },
        "referredElementType":{
            "type":"string"
        },
        "suggestedValues":{
            "type":"array",
            "xml":{
                "name":"suggestedValue",
                "wrapped":true
            },
            "items":{
                "type":"string"
            }
        },
        "validNumericRange":{
            "type":"array",
            "xml":{
                "name":"validNumericRanges",
                "wrapped":true
            },
            "items":{
                "type":"string"
            }
        },
        "enumeratedValues":{
            "type":"array",
            "xml":{
                "name":"enumeratedValue",
                "wrapped":true
            },
            "items":{
                "type":"string"
            }
        },
        "regExpPattern":{
            "type":"array",
            "xml":{
                "name":"regExpPatterns",
                "wrapped":true
            },
            "items":{
                "type":"string"
            }
        },
        "referredValues":{
            "type":"array",
            "xml":{
                "name":"referredValue",
                "wrapped":true
            },
            "items":{
                "type":"string"
            }
        },
        "required":{
            "type":"boolean",
            "default":false
        },
        "key":{
            "type":"boolean",
            "default":false
        }
    },
    "xml":{
        "name":"attributeMetadata"
    }
}

Nested Schema : enumeratedValue

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "xml":{
        "name":"enumeratedValue",
        "wrapped":true
    },
    "items":{
        "type":"string"
    }
}

Nested Schema : referredValue

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "xml":{
        "name":"referredValue",
        "wrapped":true
    },
    "items":{
        "type":"string"
    }
}

Nested Schema : regExpPatterns

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "xml":{
        "name":"regExpPatterns",
        "wrapped":true
    },
    "items":{
        "type":"string"
    }
}

Nested Schema : suggestedValue

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "xml":{
        "name":"suggestedValue",
        "wrapped":true
    },
    "items":{
        "type":"string"
    }
}

Nested Schema : validNumericRanges

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "xml":{
        "name":"validNumericRanges",
        "wrapped":true
    },
    "items":{
        "type":"string"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

Back to Top