PATCH Datasets Dataset Id | vRealize Log Insight API

URI

PATCH

https://{api_host}/api/v1/datasets/{datasetId}

COPY

Path Parameters

string

datasetId

Required

The unique identifier of the data set.

Request Body

datasets.update.request of type(s) application/json

Optional

{
    "name": "updated hostname",
    "description": "updated const description",
    "type": "OR",
    "constraints": [
        {
            "name": "hostname",
            "operator": "IS_NOT",
            "value": "10.10.10.10"
        }
    ]
}

Responses

200

Data set successfully updated.

{
    "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": {
        "type": [
            {
                "errorCode": "com.vmware.loginsight.api.errors.field_value_should_be_one_of",
                "errorMessage": "Value should be one of (OR,AND)",
                "errorParams": [
                    "OR",
                    "AND"
                ]
            }
        ]
    }
}

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

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

404

Data set not found

Returns error of type(s) application/json

{
    "errorMessage": "Specified data set does not exist.",
    "errorCode": "RBAC_DATASETS_ERROR",
    "errorDetails": {
        "errorCode": "com.vmware.loginsight.api.errors.rbac.dataset_does_not_exist"
    }
}

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

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"