REST API - dynamic

Types
vapi
std

vapi std: dynamic ID

The dynamic_ID structure represents an identifier for a resource of an arbitrary type.

Representation:

JSON

{
"id" : "obj-103",
"type" : "string"
}

Attributes:

Name Type Description

Required

Name	Type	Description
Required
type	string	The type of resource being identified (for example `com.acme.Person`). Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.
id	string	The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type. When clients pass a value of this structure as a parameter, the field `type` must contain the actual resource type. When operations return a value of this structure as a result, the field `type` will contain the actual resource type.

type

string

The type of resource being identified (for example com.acme.Person).

Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.

string

The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type.

When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type.