POST Datasets
Creates a new data set.
Request
URI
POST
https://{api_host}/api/v2/datasets
COPY
Request Body
datasets.post.request
of type(s)
application/json
Optional
{
"name": "identity constraints",
"description": "id const description",
"constraints": [
{
"name": "id",
"operator": "CONTAINS",
"value": "00000000-0000-0000-0000-000000000001"
}
]
}Responses
201
Creates a new data set
{
"id": "aa4dfe85-382d-487c-875b-7e049867a76d",
"name": "hostname data set",
"description": "id const description",
"type": "AND",
"constraints": [
{
"name": "hostname",
"operator": "IS",
"value": "10.10.10.10"
},
{
"name": "application_name",
"operator": "CONTAINS",
"value": "mailing"
}
]
}
string
id
Required
UUID in string format
string
name
Required
name
string
description
Required
description
string
type
Required
type
Possible values are :
OR,
AND,
array of
object
constraints
Required
constraints
400
Invalid request body
Returns
error
of type(s)
application/json
{
"errorMessage": "Some fields have incorrect values",
"errorCode": "FIELD_ERROR",
"errorDetails": {
"name": [
{
"errorCode": "com.vmware.loginsight.api.errors.field_required",
"errorMessage": "Required value is null"
}
],
"constraints": [
{
"errorCode": "com.vmware.loginsight.api.errors.field_required",
"errorMessage": "Required value is null"
}
]
}
}
string
errorMessage
Required
A message describing the error.
string
errorCode
Optional
A code representing the type of error.
Possible values are :
LIMIT_ERROR,
FIELD_ERROR,
TEST_ERROR,
JSON_FORMAT_ERROR,
LICENSE_ERROR,
VSPHERE_INTEGRATION_ERROR,
VROPS_INTEGRATION_ERROR,
UPGRADE_ERROR,
SEARCH_ERROR,
AGENT_ERROR,
RBAC_COMMON_ERROR,
RBAC_USERS_ERROR,
RBAC_GROUPS_ERROR,
RBAC_ADGROUPS_ERROR,
RBAC_DATASETS_ERROR,
RBAC_VIDM_GROUPS_ERROR,
RBAC_VIDB_GROUPS_ERROR,
SECURITY_ERROR,
DEPLOYMENT_ERROR,
SUPPORT_BUNDLE_ERROR,
LOAD_BALANCER_ERROR,
VIDM_ERROR,
VIDB_ERROR,
QUERY_ERROR,
SSL_CERTIFICATE_ERROR,
PROXY_ERROR,
object
errorDetails
Optional
Dynamic error details, where the field name can vary depending on the request field and error code.
401
Operation doesn't return any data structure
409
Data set already exists.
Returns
error
of type(s)
application/json
{
"errorMessage": "Data set with specified name already exists.",
"errorCode": "RBAC_DATASETS_ERROR",
"errorDetails": {
"errorCode": "com.vmware.loginsight.api.errors.rbac.dataset_with_specified_name_already_exists"
}
}
string
errorMessage
Required
A message describing the error.
string
errorCode
Optional
A code representing the type of error.
Possible values are :
LIMIT_ERROR,
FIELD_ERROR,
TEST_ERROR,
JSON_FORMAT_ERROR,
LICENSE_ERROR,
VSPHERE_INTEGRATION_ERROR,
VROPS_INTEGRATION_ERROR,
UPGRADE_ERROR,
SEARCH_ERROR,
AGENT_ERROR,
RBAC_COMMON_ERROR,
RBAC_USERS_ERROR,
RBAC_GROUPS_ERROR,
RBAC_ADGROUPS_ERROR,
RBAC_DATASETS_ERROR,
RBAC_VIDM_GROUPS_ERROR,
RBAC_VIDB_GROUPS_ERROR,
SECURITY_ERROR,
DEPLOYMENT_ERROR,
SUPPORT_BUNDLE_ERROR,
LOAD_BALANCER_ERROR,
VIDM_ERROR,
VIDB_ERROR,
QUERY_ERROR,
SSL_CERTIFICATE_ERROR,
PROXY_ERROR,
object
errorDetails
Optional
Dynamic error details, where the field name can vary depending on the request field and error code.
440
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v2/datasets