PbmCapabilitySchema

PbmCapabilitySchema
PbmCapabilitySchema

Capability Schema information

This structure may be used only with operations rendered under /pbm.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "vendorInfo": {
        "_typeName": "string",
        "vendorUuid": "string",
        "info": {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string",
            "messageCatalogKeyPrefix": "string",
            "messageArg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ]
        }
    },
    "namespaceInfo": {
        "_typeName": "string",
        "version": "string",
        "namespace": "string",
        "info": {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string",
            "messageCatalogKeyPrefix": "string",
            "messageArg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ]
        }
    },
    "lineOfService": {
        "_typeName": "string",
        "lineOfService": "string",
        "name": {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string",
            "messageCatalogKeyPrefix": "string",
            "messageArg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ]
        },
        "description": {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string",
            "messageCatalogKeyPrefix": "string",
            "messageArg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ]
        }
    },
    "capabilityMetadataPerCategory": [
        {
            "_typeName": "string",
            "subCategory": "string",
            "capabilityMetadata": [
                {
                    "_typeName": "string",
                    "id": {
                        "_typeName": "string",
                        "namespace": "string",
                        "id": "string"
                    },
                    "summary": {
                        "_typeName": "string",
                        "label": "string",
                        "summary": "string",
                        "key": "string",
                        "messageCatalogKeyPrefix": "string",
                        "messageArg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ]
                    },
                    "mandatory": false,
                    "hint": false,
                    "keyId": "string",
                    "allowMultipleConstraints": false,
                    "propertyMetadata": [
                        {
                            "_typeName": "string",
                            "id": "string",
                            "summary": {
                                "_typeName": "string",
                                "label": "string",
                                "summary": "string",
                                "key": "string",
                                "messageCatalogKeyPrefix": "string",
                                "messageArg": [
                                    {
                                        "_typeName": "string",
                                        "key": "string",
                                        "value": {
                                            "_typeName": "string"
                                        }
                                    }
                                ]
                            },
                            "mandatory": false,
                            "type": {
                                "_typeName": "string",
                                "typeName": "string"
                            },
                            "defaultValue": {
                                "_typeName": "string"
                            },
                            "allowedValue": {
                                "_typeName": "string"
                            },
                            "requirementsTypeHint": "string"
                        }
                    ]
                }
            ]
        }
    ]
}
vendorInfo
Required

Information about vendor/owner of the capability metadata schema

This structure may be used only with operations rendered under /pbm.

namespaceInfo
Required

Name space information for the capability metadata schema.

NOTE: Name spaces are required to be globally unique across resource types. A same vendor can register multiple name spaces for same resource type or for different resource type, but the schema namespace URL must be unique for each of these cases. A CapabilityMetadata object is uniquely identified based on the namespace it belongs to and it's unique identifier within that namespace.

This structure may be used only with operations rendered under /pbm.

lineOfService
Optional

Describes Line of Service of a capability provider.

This structure may be used only with operations rendered under /pbm.

capabilityMetadataPerCategory
Required

Capability metadata organized by category