ProfileMetadata

ProfileMetadata
ProfileMetadata

This data object represents the metadata information of a Profile.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "key": "string",
    "profileTypeName": "string",
    "description": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "messageCatalogKeyPrefix": "string",
        "messageArg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ]
    },
    "sortSpec": [
        {
            "_typeName": "string",
            "policyId": "string",
            "parameter": "string"
        }
    ],
    "profileCategory": "string",
    "profileComponent": "string",
    "operationMessages": [
        {
            "_typeName": "string",
            "operationName": "string",
            "message": {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        }
    ]
}
string
key
Required

Type of the Profile

string
profileTypeName
Optional

Type identifier for the ApplyProfile

ExtendedDescription
description
Optional

Property which describes the profile

array of ProfileMetadataProfileSortSpec
sortSpec
Optional

Property that determines a sorting order for display purposes.

If the list contains more than one sort spec, then the precedence should be determined by the list order (i.e. sort first by the first spec in the list, then sort by the second spec in the list, etc).

string
profileCategory
Optional

Identifies the profile category that this subprofile is a part of.

The value of this string should correspond to the key value of a ProfileCategoryMetadata object's ElementDescription.key in its ProfileCategoryMetadata.id property.

string
profileComponent
Optional

Property indicating that the subprofile described by this ProfileMetadata object is declared in the ProfileComponentMetadata.profileTypeNames of the specified profile component.

The value of this property should correspond to the key value of the ProfileComponentMetadata object's ElementDescription.key in its ProfileComponentMetadata.id property. This property should not be present for subprofiles that are not directly declared in the ProfileComponentMetadata.profileTypeNames property of a ProfileComponentMetadata object.

array of ProfileMetadataProfileOperationMessage
operationMessages
Optional

A list of ProfileOperationMessage for this profile.

Property Of
Returned By