Get Fields

Get Fields

Gets a list of schema and extracted fields

Request
URI
GET
https://{api_host}//vrlic/api/v1/query/fields
COPY
Query Parameters
string
partitionId
Optional

Indicates the partition id associated with the fields

string
tenantId
Optional

Indicates the tenantId associated with the fields

string
type
Optional

Indicates the schema type tassociated with the fields. For eg. EVENTS

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SchemaFieldsDto of type(s) */* 
{
    "fields": [
        {
            "internalName": "test_extracted_fields_1",
            "id": "test_extracted_fields_1",
            "displayName": "test_extracted_fields_1",
            "fieldType": "string",
            "fieldOrigin": "SYSTEM",
            "partitionIds": [
                "98h417e4-2b61-4200-b6cc-26a399bdf8cf"
            ],
            "contentPackId": "com.vmware.test.4-6"
        },
        {
            "internalName": "test_schema_fields-1",
            "id": "test_schema_fields_1",
            "displayName": "test_schema_fields_1",
            "fieldType": "boolean",
            "fieldOrigin": "SYSTEM",
            "partitionIds": [
                "d55417e4-2b61-4200-b6cc-26a399bdf8cf"
            ],
            "contentPackId": "com.vmware.test.4-6"
        },
        {
            "internalName": "test_extracted_fields_2",
            "id": "test_extracted_fields_2",
            "displayName": "test_extracted_fields_2",
            "fieldType": "LONG",
            "fieldOrigin": "GLOBAL_CONTENT",
            "partitionIds": [
                "uhh417e4-2b61-4200-b6cc-26a399bdf8cf"
            ],
            "contentPackId": "com.vmware.test.4-6"
        },
        {
            "internalName": "test_schema_fields_2",
            "id": "test_schema_fields_2",
            "displayName": "test_schema_fields_2",
            "fieldType": "boolean",
            "fieldOrigin": "GLOBAL_CONTENT",
            "partitionIds": [
                "905417e4-2b61-4200-b6cc-26a399bdf8cf"
            ],
            "contentPackId": "com.vmware.test.4-6"
        },
        {
            "internalName": "ibadmnxw2ltwnv3wc4tffcbdhcbhbchbhy4dimvzgklrrfuyhm3lxl5sxg6djl5zw43lql52hnmhebfhee7y7f",
            "id": "test_extracted_fields_3",
            "displayName": "test_extracted_fields_3",
            "fieldType": "string",
            "fieldOrigin": "SYSTEM",
            "partitionIds": [
                "klh417e4-2b61-4200-b6cc-26a399bdf8cf"
            ],
            "contentPackId": "com.vmware.test.4-6"
        }
    ],
    "schemaFieldsCount": 2,
    "extractedFieldsCount": 3
}
array of Field
fields
Optional

A collection of fields which are a combination of fields found in the data platform schema, and extracted fields imported from content packs or other sources of content

integer As int32 As int32
schemaFieldsCount
Optional

Number of indexed fields in the fields collection.

integer As int32 As int32
extractedFieldsCount
Optional

Number of extracted fields in the fields collection.


On This Page
Fields Operations
GET
Get Fields