vRealize 7 REST API - Properties Service documentation or example

[nathan-uk]

The Programming Guide - vRealize Automation 7.0 states there is a "Properties Service" in the REST API, but there is no reference to it in the REST Documentation.

From page 10 of the PDF,  "Properties Service - Manage custom properties, property groups, and property definitions."

Please can anyone confirm if this exists and if there is any documentation or exampes available, im trying to automate the creation of my property definitions

[GrantOrchardVMw]

Here is an example for you:

Method: POST

URI: https://vra.lab.local/properties-service/api/propertydefinitions

JSON:

{"id":"API","tenantId":"vsphere.local","isMultiValued":false,"required":false,"label":"Test","description"

:"Test","orderIndex":1,"displayAdvice":"CHECKBOX","dataTypeTypeId":"BOOLEAN","dataType":{"type":"primitive"

,"typeId":"BOOLEAN"},"facets":{"encrypted":{"type":"constant","value":{"type":"boolean","value":false

}}}}

Expected response: 201

Performing a GET against the same URI will net you something like this:

{

    "links": [],

    "content": [

        {

            "@type": "ContextPropertyDefinition",

            "id": "Test",

            "label": "Test",

            "description": "Test",

            "dataType": {

                "type": "primitive",

                "typeId": "BOOLEAN"

            },

            "isMultiValued": false,

            "displayAdvice": "CHECKBOX",

            "tenantId": "vsphere.local",

            "orderIndex": 1,

            "permissibleValues": null,

            "facets": {

                "encrypted": {

                    "type": "constant",

                    "value": {

                        "type": "boolean",

                        "value": false

                    }

                }

            },

            "createdDate": "2016-01-27T02:50:28.339Z",

            "lastUpdated": "2016-01-27T02:50:28.339Z",

            "version": 0

        },

        {

            "@type": "ContextPropertyDefinition",

            "id": "API",

            "label": "Test",

            "description": "Test",

            "dataType": {

                "type": "primitive",

                "typeId": "BOOLEAN"

            },

            "isMultiValued": false,

            "displayAdvice": "CHECKBOX",

            "tenantId": "vsphere.local",

            "orderIndex": 1,

            "permissibleValues": null,

            "facets": {

                "encrypted": {

                    "type": "constant",

                    "value": {

                        "type": "boolean",

                        "value": false

                    }

                }

            },

            "createdDate": "2016-01-27T02:57:03.484Z",

            "lastUpdated": "2016-01-27T02:57:03.484Z",

            "version": 0

        }

    ],

    "metadata": {

        "size": 20,

        "totalElements": 2,

        "totalPages": 1,

        "number": 1,

        "offset": 0

    }

}

Hope that helps!

Grant

[anandv]

Thank You! this was helpful.

Also refer to this doc for more information on the REST APIs

vRealize Automation 7.0