Create Metadata Entry

Create Metadata Entry

Creates a new entry. This operation is allowed only if the user has at least a read access level to the main entity. Additionally file entries require the user to have the 'Metadata File Entry: Create/Modify' right.

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/entities/{id}/metadata
COPY
Path Parameters
string
id
Required

the URN of the entity the entry is attached to.

string
id
Required

the URN of the entity the entry is attached to.

Request Body
MetadataEntry of type(s) application/json
Optional 
{
    "id": "string",
    "persistent": false,
    "readOnly": false,
    "keyValue": {
        "domain": "string",
        "namespace": "string",
        "key": "string",
        "value": {
            "value": {},
            "type": "string"
        }
    }
}
string
id
Optional

id

boolean
persistent
Optional

Persistent entries can be copied over on some entity operation, for example: | Creating a copy of an Org VDC | Capturing a vApp to a template | Instantiating a catalog item as a VM

boolean
readOnly
Optional

The kind of level of access organizations of the entry's domain have

KeyValue
keyValue
Required

Containins core metadata entry data.

Authentication
This operation uses the following authentication methods.
Responses
201
Returns MetadataEntry of type(s) application/json;version=39.0 
{
    "id": "string",
    "persistent": false,
    "readOnly": false,
    "keyValue": {
        "domain": "string",
        "namespace": "string",
        "key": "string",
        "value": {
            "value": {},
            "type": "string"
        }
    }
}
string
id
Optional

id

boolean
persistent
Optional

Persistent entries can be copied over on some entity operation, for example: | Creating a copy of an Org VDC | Capturing a vApp to a template | Instantiating a catalog item as a VM

boolean
readOnly
Optional

The kind of level of access organizations of the entry's domain have

KeyValue
keyValue
Required

Containins core metadata entry data.


202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

400

Invalid configuration.

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 37.0
On This Page
Defined Entity Operations
POST
Create Metadata Entry
DELETE
Delete Defined Entity
DELETE
Delete Metadata Entry
GET
Get Defined Entities By Entity Type
GET
Get Defined Entities By Entity Type Id
GET
Get Defined Entities By Entity Type No Version Specified
GET
Get Defined Entities By Interface
GET
Get Defined Entities By Interface Id
GET
Get Defined Entity
GET
Get Defined Entity Full Contents
GET
Get Metadata
GET
Get Metadata Entry
GET
Get Metadata File Content
POST
Migrate Defined Entities Of Type
POST
Resolve Defined Entity
PUT
Update Defined Entity
PUT
Update Metadata Entry