Jump to

• Request
• Response

Get Additional Element Metadata

post

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

Use this (POST) method to retrieve additional meta-data information about 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 such as if it contains additional sub-element children, what are its inter-dependencies between other elements, and so on. A client can be configured to use this metadata for self-describing the characteristics of all elements supported by a given device release to develop an understanding of configuration element dependencies and the flow for which elements need to configured first, second, and so on.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• deviceId: string
• versionId: string

Body ()

Root Schema : elementTypeRequest

Type: object

Show Source

• elementTypePath(optional): string

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

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : elementMetadata

Type: object

Show Source

• attributeMetadatas(optional): array attributeMetadata
• elementTypePath(optional): string
• readOnly(optional): boolean
  Default Value: false
• singleInstance(optional): boolean
  Default Value: false
• subElements(optional): array subElement
• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "elementTypePath":{
            "type":"string"
        },
        "subElements":{
            "type":"array",
            "xml":{
                "name":"subElement",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestSubElement"
            }
        },
        "attributeMetadatas":{
            "type":"array",
            "xml":{
                "name":"attributeMetadata",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestAttributeMetadata"
            }
        },
        "singleInstance":{
            "type":"boolean",
            "default":false
        },
        "readOnly":{
            "type":"boolean",
            "default":false
        }
    },
    "xml":{
        "name":"elementMetadata"
    }
}

Nested Schema : attributeMetadata

Type: array

Show Source

• Array of: object attributeMetadata

{
    "type":"array",
    "xml":{
        "name":"attributeMetadata",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RestAttributeMetadata"
    }
}

Nested Schema : subElement

Type: array

Show Source

• Array of: object subElement

{
    "type":"array",
    "xml":{
        "name":"subElement",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RestSubElement"
    }
}

Nested 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"
    }
}

Nested Schema : subElement

Type: object

Show Source

• elementTypePath(optional): string
• required(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "required":{
            "type":"boolean",
            "default":false
        },
        "elementTypePath":{
            "type":"string"
        }
    },
    "xml":{
        "name":"subElement"
    }
}

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