VerifyReferenceList parity mapping
This guide details the request and response mapping specifications and property parity analysis for migrating from the legacy Backstory Reference List API (VerifyReferenceList) to the modern Chronicle API (VerifyReferenceList).
Protocol and mapping overview
| Feature | Legacy API (VerifyReferenceList) |
Modern Chronicle API (VerifyReferenceList) |
|---|---|---|
| HTTP Method | POST |
POST |
| Permissions | Partner token or legacy API keys | chronicle.googleapis.com/referenceLists.verifyReferenceList |
Request payload field-by-field parity
The modern Chronicle API VerifyReferenceListRequest scopes verification under a target instance and standardizes list item entries into structured messages.
Legacy Field (VerifyReferenceListRequest) |
Modern Field (VerifyReferenceListRequest) |
Field type | Parity & Migration Notes |
|---|---|---|---|
| — | instance (in HTTP path) |
string |
Google Cloud Scoping Context / New Field: Legacy validation was stateless and unconstrained by resource bounds. The modern API requires specifying the target environment instance path: projects/{project}/locations/{location}/instances/{instance_uuid}. |
content_type |
syntax_type |
enum |
Renamed / Value Alignment: Renamed from content_type to syntax_type. Enum value translations:• CONTENT_TYPE_DEFAULT_STRING $\rightarrow$ REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING• REGEX $\rightarrow$ REFERENCE_LIST_SYNTAX_TYPE_REGEX (for regular expressions)• CIDR $\rightarrow$ REFERENCE_LIST_SYNTAX_TYPE_CIDR. Rename to syntaxType in JSON. |
lines |
entries |
repeated string $\rightarrow$ repeated ReferenceListEntry |
Restructured: Legacy flat array of string lines is restructured into a repeated list of ReferenceListEntry messages (entries[].value). |
Nested ReferenceListEntry property mappings
The fields mapping inside individual ReferenceListEntry items is as follows:
Legacy Field (lines[] string item) |
Modern Field (ReferenceListEntry message) |
Field type | Parity & Migration Notes |
|---|---|---|---|
lines[] (Plain text line string) |
value |
string |
Parity Mapped: The individual string line item is encapsulated inside the required value property of each ReferenceListEntry object. |
Response payload field-by-field parity
Both APIs return validation results and line-by-line syntax error arrays.
Legacy Field (VerifyReferenceListResponse) |
Modern Field (VerifyReferenceListResponse) |
Field type | Parity & Migration Notes |
|---|---|---|---|
success |
success |
bool |
Parity Mapped: Boolean flag returning true if the submitted list content passes validation without syntax errors. |
errors |
errors |
repeated ReferenceListError |
Parity Mapped / Restructured: Array of encountered line-level syntax validation errors (mappings evaluated in the following table). |
Nested ReferenceListError property mappings
The fields mapping inside individual ReferenceListError items is as follows:
Legacy Field (ReferenceListLineError) |
Modern Field (ReferenceListError message) |
Field type | Parity & Migration Notes |
|---|---|---|---|
line_number |
line_number |
int32 |
Parity Mapped: 1-indexed line number where the validation error occurred (general list-wide errors are indexed at -1). Rename to lineNumber in JSON. |
error_message |
error_message |
string |
Parity Mapped: Diagnostic text explaining why the syntax or line entry is invalid. Rename to errorMessage in JSON. |
Key differences
- Google Cloud Project Scoping Integration:
- Scoped natively under parent project instance folder bindings (
instancepath parameter).
- Scoped natively under parent project instance folder bindings (
- Payload Restructuring:
- Plain string line arrays in legacy
linesare wrapped inside structuredReferenceListEntrymessages underentries(for example,repeated string$\rightarrow$repeated ReferenceListEntry).
- Plain string line arrays in legacy
- Syntax Type and Field Renaming:
- Legacy
content_typeis renamed tosyntax_typewith clearer enum prefixing (REFERENCE_LIST_SYNTAX_TYPE_*).
- Legacy