Overview
This document provides prerequisites and API usage examples for building custom applications using Lattice real-time score and enrich REST APIs.
Note that, Lattice APIs are not guaranteed to be available 24/7. APIs are expected to be down once every two weeks for one hr for scheduled maintenance.
API Rate limiting / Thresholds
Standard quota limit for Score / Enrichment API calls is 1000/hour and 25000/day.
We highly recommend reviewing your application logic for calling Lattice APIs and ensuring Lattice team is aware of the expected volume of daily API calls.
Prerequisite
- The customer has access to https://app.lattice-engines.com/
- Tenant has set up the needed Models
- Tenant has configured Data Cloud attributes for Enrichments use case
- And Client can generate OTP using "Generate Salesforce Access Token"
References
API docs are available at
| Module | Documentation |
|---|---|
| OAuth | https://oauth.lattice-engines.com/swagger-ui.html |
API Usage and Samples
Generate Salesforce Access Token.
This is a One Time Password (OTP), that will be expired after 24 hours of generation. (If you have already generated it, you can skip it.)
Authentication Process
Authenticate and Get Tokens
As part of authentication using OTP, it will generate an Access token and Refresh token for all future API communications. These tokens will be valid for 6 months.
Note: "app_id" is a client-generated string, which uniquely identifies the customer application. So that, when the Lattice API is used at a different application from the same customer, it will not impact the access_token of prior applications. Ex: app_id=web.company.salesapp1
curl --user "lp:" https://oauth.lattice-engines.com/oauth/token -d grant_type=password -d username=<tenantID.tenantID.Production> -d app_id=<hosting>.<tenantID>.<application> -d password=<OTP> |
Response
{"access_token":"a8a7a1c3-de25-4530-9642-5ceb4f71bbcd","token_type":"bearer","refresh_token":"7a2aa402-2b1a-4ee0-a213-cab9af57bde3","expires_in":43199,"scope":"read write"}
|
Use access_token for all future communications with Lattice API.
Refresh Access Token
When access token gets expired, API will throw 401 unauthorized, with an error message of "Access token expired". In that case, the client can use the below API to get a new access token.
curl --user "lp:" https://oauth.lattice-engines.com/oauth/token -d grant_type=refresh_token -d username=<tenantID.tenantID.Production> -d app_id=<hosting>.<tenantID>.<application> -d refresh_token=<7a2aa402-2b1a-4ee0-a213-cab9af57bde3> |
Response
{"access_token":"f132b3c4-57f6-4708-b48b-17ee82281a4a","token_type":"bearer","refresh_token":"7a2aa402-2b1a-4ee0-a213-cab9af57bde3","expires_in":43199,"scope":"read write"}
|
Get Model Details
Get Model Count
If you have many models, you can query for the count and use the pagination to get in batches.
curl -X GET -H "Authorization: Bearer f132b3c4-57f6-4708-b48b-17ee82281a4a" "https://apigw.lattice-engines.com/score/v01/modeldetails/count?considerAllStatus=true" |
Get Model Details
Get model details, which will provide Field Mapping and its input validation expression for required mapping fields.
We Recommend providing data for all Primary Fields when sending a Scoring / Enrichment request
Request
curl -X GET -H "Authorization: Bearer f132b3c4-57f6-4708-b48b-17ee82281a4a" "https://apigw.lattice-engines.com/score/v01/modeldetails?considerAllStatus=true&offset=0&maximum=4" |
Response
[
{
"model": {
"modelId": "ms__7767be0b-1a6e-406e-aef9-85d633571481",
"name": "DBFinal",
"type": "CONTACT"
},
"status": "Active",
"fields": {
"modelId": "ms__7767be0b-1a6e-406e-aef9-85d633571481",
"fields": [
{
"fieldName": "Email",
"fieldType": "STRING",
"displayName": "Email",
"isRequiredForScoring": true,
"isPrimary": true
},
{
"fieldName": "Id",
"fieldType": "STRING",
"displayName": "Id",
"isRequiredForScoring": true,
"isPrimary": true
}
]
},
"lastModifiedTimestamp": "2016-09-01T20:53:37+0000"
},
{
"model": {
"modelId": "ms__a7507c99-5d3e-47bc-9527-fca12059bab3",
"name": "EnterpriseMajors",
"type": "ACCOUNT"
},
"status": "Active",
"fields": {
"modelId": "ms__a7507c99-5d3e-47bc-9527-fca12059bab3",
"fields": [
{
"fieldName": "Website",
"fieldType": "STRING",
"displayName": "Website",
"isRequiredForScoring": true,
"isPrimary": true
},
{
"fieldName": "Country",
"fieldType": "STRING",
"displayName": "Country",
"isRequiredForScoring": false,
"isPrimary": true
},
{
"fieldName": "Id",
"fieldType": "STRING",
"displayName": "Id",
"isRequiredForScoring": true,
"isPrimary": true
}
]
},
"lastModifiedTimestamp": "2017-01-26T22:12:28+0000"
}
]
|
Models field mapping
Try to map as many inputs as possible for Models input fields, before making a scoring request.
Enrichment fields Metadata
The customer can retrieve metadata for all enrichment fields that were configured on Lattice data cloud.
Request
curl -X GET -H "Authorization: bearer f132b3c4-57f6-4708-b48b-17ee82281a4a" "https://apigw.lattice-engines.com/score/v01/enrichment?onlySelectedAttributes=true" |
Response
[
{
"DisplayName": "State",
"FieldName": "LDC_State",
"FieldNameInTarget": "LDC_State",
"FieldType": "NVARCHAR(MAX)",
"FieldJavaType": "String",
"CustomerColumnName": null,
"DataSource": null,
"Description": "The name of the state/province where the business is physically located, generally, in the local language. Available globally. Blank-filled when not available..",
"IsSelected": true,
"IsPremium": false,
"Category": "Firmographics",
"Subcategory": "Other",
"IsInternal": false,
"FundamentalType": "ALPHA",
"AttributeFlagsMap": null,
"ImportanceOrdering": 40
},
{
"DisplayName": "Employee Range",
"FieldName": "LE_EMPLOYEE_RANGE",
"FieldNameInTarget": "LE_EMPLOYEE_RANGE",
"FieldType": "NVARCHAR(MAX)",
"FieldJavaType": "String",
"CustomerColumnName": null,
"DataSource": null,
"Description": "Employee Range of domestic ultimate business, which is the highest level parent for the corporate within the country. Available Globally.",
"IsSelected": true,
"IsPremium": false,
"Category": "Firmographics",
"Subcategory": "Other",
"IsInternal": false,
"FundamentalType": "ENUM",
"AttributeFlagsMap": null,
"ImportanceOrdering": 80
},
{
"DisplayName": "Revenue Range",
"FieldName": "LE_REVENUE_RANGE",
"FieldNameInTarget": "LE_REVENUE_RANGE",
"FieldType": "NVARCHAR(MAX)",
"FieldJavaType": "String",
"CustomerColumnName": null,
"DataSource": null,
"Description": "Revenue Range of domestic ultimate business, which is the highest level parent for the corporate within the country. Available Globally.",
"IsSelected": true,
"IsPremium": false,
"Category": "Firmographics",
"Subcategory": "Other",
"IsInternal": false,
"FundamentalType": "ENUM",
"AttributeFlagsMap": null,
"ImportanceOrdering": 90
},
{
"DisplayName": "Has Citrix GoToMeeting",
"FieldName": "TechIndicator_CitrixGoToMeeting",
"FieldNameInTarget": "TechIndicator_CitrixGoToMeeting",
"FieldType": "NVARCHAR(MAX)",
"FieldJavaType": "String",
"CustomerColumnName": null,
"DataSource": "HGData_Pivoted_Source",
"Description": "A domain using technology of Citrix GoToMeeting behind firewall",
"IsSelected": true,
"IsPremium": true,
"Category": "Technology Profile",
"Subcategory": "Collaboration",
"IsInternal": false,
"FundamentalType": "BOOLEAN",
"AttributeFlagsMap": null,
"ImportanceOrdering": 0
},
{
"DisplayName": "Has Cisco WebEx",
"FieldName": "TechIndicator_CiscoWebEx",
"FieldNameInTarget": "TechIndicator_CiscoWebEx",
"FieldType": "NVARCHAR(MAX)",
"FieldJavaType": "String",
"CustomerColumnName": null,
"DataSource": "HGData_Pivoted_Source",
"Description": "A domain using technology of Cisco WebEx behind firewall",
"IsSelected": true,
"IsPremium": true,
"Category": "Technology Profile",
"Subcategory": "Collaboration",
"IsInternal": false,
"FundamentalType": "BOOLEAN",
"AttributeFlagsMap": null,
"ImportanceOrdering": 0
},
{
"DisplayName": "Has SolarWinds (ALL RECORDS)",
"FieldName": "TechIndicator_SolarWinds_ALLRECORDS",
"FieldNameInTarget": "TechIndicator_SolarWinds_ALLRECORDS",
"FieldType": "NVARCHAR(MAX)",
"FieldJavaType": "String",
"CustomerColumnName": null,
"DataSource": null,
"Description": "A domain using technology of SolarWinds (ALL RECORDS) behind firewall",
"IsSelected": true,
"IsPremium": true,
"Category": "Technology Profile",
"Subcategory": "Network Management (Software)",
"IsInternal": false,
"FundamentalType": "BOOLEAN",
"AttributeFlagsMap": null,
"ImportanceOrdering": 0
},
{
"DisplayName": "Has Vidyo",
"FieldName": "TechIndicator_Vidyo",
"FieldNameInTarget": "TechIndicator_Vidyo",
"FieldType": "NVARCHAR(MAX)",
"FieldJavaType": "String",
"CustomerColumnName": null,
"DataSource": null,
"Description": "A domain using technology of Vidyo behind firewall",
"IsSelected": true,
"IsPremium": true,
"Category": "Technology Profile",
"Subcategory": "Online Video Platform (OVP)",
"IsInternal": false,
"FundamentalType": "BOOLEAN",
"AttributeFlagsMap": null,
"ImportanceOrdering": 0
},
{
"DisplayName": "Has ReadyTalk",
"FieldName": "TechIndicator_ReadyTalk",
"FieldNameInTarget": "TechIndicator_ReadyTalk",
"FieldType": "NVARCHAR(MAX)",
"FieldJavaType": "String",
"CustomerColumnName": null,
"DataSource": null,
"Description": "A domain using technology of ReadyTalk behind firewall",
"IsSelected": true,
"IsPremium": true,
"Category": "Technology Profile",
"Subcategory": "Telephony",
"IsInternal": false,
"FundamentalType": "BOOLEAN",
"AttributeFlagsMap": null,
"ImportanceOrdering": 0
},
{
"DisplayName": "Has BrightTALK",
"FieldName": "TechIndicator_BrightTALK",
"FieldNameInTarget": "TechIndicator_BrightTALK",
"FieldType": "NVARCHAR(MAX)",
"FieldJavaType": "String",
"CustomerColumnName": null,
"DataSource": null,
"Description": "Embeddable videos from BrightTALK webinars.",
"IsSelected": true,
"IsPremium": true,
"Category": "Technology Profile",
"Subcategory": "Web & Portal Technology",
"IsInternal": false,
"FundamentalType": "BOOLEAN",
"AttributeFlagsMap": null,
"ImportanceOrdering": 0
}
]
|
Scoring and Enrichment request
Request
curl -X POST \
https://apigw.lattice-engines.com/score/v01/record \
-H 'authorization: Bearer e1039cc1-b743-4cf4-be33-b7e6cc2108ff' \
-H 'content-type: application/json' \
-d '{
"idType": "TestRecord",
"modelId": "ms__d51178e3-7c68-4f22-8503-8beda91f6aa0",
"performEnrichment": false,
"record": {
"Id" : "record-id-001",
"CompanyName": "Google",
"Email": "test@google.com",
"Website" : "google.com",
"Country" : "United States",
"PhoneNumber": "717-851-4849",
"State": "CA"
},
"recordId": "record-id-001"
}'
|
Response
{
"warnings": [],
"timestamp": "2018-01-26T23:29:12.029Z",
"id": "record-id-001",
"latticeID": null,
"score": 85,
"rating": "B",
"classification": null,
"enrichmentAttributeValues": {
"EMPLOYEES_HERE": 250,
"EMPLOYEES_TOTAL": 61814,
"TechIndicator_Zendesk": "No",
"TechIndicator_NitroPDF": "No",
"TechIndicator_LinkedInCompanyProfile": "No"
}
}
|
Lattice API Documentation
Scoring API
{
"swagger": "2.0",
"info": {
"version": "v01",
"title": "Lattice Scoring API"
},
"host": "apigw.lattice-engines.com",
"basePath": "/v01",
"schemes": [
"https"
],
"paths": {
"/enrich/record/{uuid}": {
"post": {
"operationId": "getLeadEnrichmentValues",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "uuid",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "EnrichRequest",
"required": true,
"schema": {
"$ref": "#/definitions/EnrichRequest"
}
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/EnrichResponse"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/enrichment": {
"get": {
"operationId": "getLeadEnrichmentAttributes",
"produces": [
"application/json"
],
"parameters": [
{
"name": "category",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "subcategory",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "attributeDisplayNameFilter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "onlySelectedAttributes",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "max",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/ArrayOfLeadEnrichmentAttribute"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/enrichment/categories": {
"get": {
"operationId": "getLeadEnrichmentCategories",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/ArrayOfEmpty"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/enrichment/count": {
"get": {
"operationId": "getLeadEnrichmentAttributesCount",
"produces": [
"application/json"
],
"parameters": [
{
"name": "subcategory",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "category",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "attributeDisplayNameFilter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "onlySelectedAttributes",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/Empty"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/enrichment/premiumattributeslimitation": {
"get": {
"operationId": "getLeadEnrichmentPremiumAttributesLimitation",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/Empty"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/enrichment/selectedattributes/count": {
"get": {
"operationId": "getLeadEnrichmentSelectedAttributeCount",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/Empty"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/enrichment/selectedpremiumattributes/count": {
"get": {
"operationId": "getLeadEnrichmentSelectedAttributePremiumCount",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/Empty"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/enrichment/subcategories": {
"get": {
"operationId": "getLeadEnrichmentSubcategories",
"produces": [
"application/json"
],
"parameters": [
{
"name": "category",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/Empty"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/modeldetails": {
"get": {
"operationId": "getPaginatedModels",
"produces": [
"application/json"
],
"parameters": [
{
"name": "start",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "maximum",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "considerAllStatus",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "offset",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "tenantIdentifier",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/ArrayOfModelDetail"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/modeldetails/count": {
"get": {
"operationId": "getModelCount",
"produces": [
"application/json"
],
"parameters": [
{
"name": "start",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "considerAllStatus",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "tenantIdentifier",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/Empty"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/models/types/{type}": {
"get": {
"operationId": "getActiveModels",
"produces": [
"application/json"
],
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/ArrayOfModel"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/models/{modelId}/fields": {
"get": {
"operationId": "getModelFields",
"produces": [
"application/json"
],
"parameters": [
{
"name": "modelId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/Fields"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/record": {
"post": {
"operationId": "scorePercentileRecord",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "ScoreRequest",
"required": true,
"schema": {
"$ref": "#/definitions/ScoreRequest"
}
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/ScoreResponse"
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/record/debug": {
"post": {
"operationId": "scoreProbabilityRecord",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "ScoreRequest",
"required": true,
"schema": {
"$ref": "#/definitions/ScoreRequest"
}
}
],
"responses": {
"200": {
"description": "200 response",
"schema": {
"$ref": "#/definitions/ScoreResponse"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
},
"securityDefinitions": {
"api_key": {
"type": "apiKey",
"name": "x-api-key",
"in": "header"
}
},
"definitions": {
"ArrayOfEmpty": {
"type": "array",
"items": {
"$ref": "#/definitions/Empty"
}
},
"EnrichResponseMetadata": {
"type": "object",
"required": [
"requestId",
"timestamp"
],
"properties": {
"warnings": {
"type": "array",
"description": "Warnings",
"items": {
"$ref": "#/definitions/Warning"
}
},
"timestamp": {
"type": "string",
"description": "The UTC timestamp of this score in ISO8601 format"
},
"requestId": {
"type": "string",
"description": "The unique id associated to the request"
}
}
},
"Warning": {
"type": "object",
"properties": {
"warning": {
"type": "string"
},
"warning_description": {
"type": "string"
}
}
},
"ArrayOfLeadEnrichmentAttribute": {
"type": "array",
"items": {
"$ref": "#/definitions/LeadEnrichmentAttribute"
}
},
"EnrichResponse": {
"type": "object",
"properties": {
"enrich_response_metadata": {
"$ref": "#/definitions/EnrichResponseMetadata"
}
}
},
"ScoreRequest": {
"type": "object",
"required": [
"modelId",
"record"
],
"properties": {
"recordId": {
"type": "string",
"description": "Record ID"
},
"idType": {
"type": "string",
"description": "Type of record ID"
},
"modelId": {
"type": "string"
},
"source": {
"type": "string",
"description": "Name of the source system that originated this score request."
},
"performEnrichment": {
"type": "boolean",
"description": "Should perform enrichment or not"
},
"rule": {
"type": "string",
"description": "Name of the rule that initiated this score request"
},
"record": {
"type": "object",
"description": "A record is represented as a JSON Object; ie. { \"field1\" : value1, \"field2\" : value2, .......}. At the minimum, in case of lead type model, make sure to specify 'Email' field and for non-lead type model specify either 'Website' or 'Domain' fields. If these fields are not specified then specify both 'CompanyName' and 'State' fields",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"LeadEnrichmentAttribute": {
"type": "object",
"properties": {
"DisplayName": {
"type": "string"
},
"FieldName": {
"type": "string"
},
"FieldNameInTarget": {
"type": "string"
},
"FieldType": {
"type": "string"
},
"FieldJavaType": {
"type": "string"
},
"ColumnId": {
"type": "string"
},
"JavaClass": {
"type": "string"
},
"CustomerColumnName": {
"type": "string"
},
"DataSource": {
"type": "string"
},
"Description": {
"type": "string"
},
"IsSelected": {
"type": "boolean"
},
"IsPremium": {
"type": "boolean"
},
"Category": {
"type": "string"
},
"Subcategory": {
"type": "string"
},
"IsInternal": {
"type": "boolean"
},
"AttributeFlagsMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/JsonNode"
}
},
"ImportanceOrdering": {
"type": "integer",
"format": "int32"
},
"FundamentalType": {
"type": "string"
}
}
},
"JsonNode": {
"type": "object",
"properties": {
"array": {
"type": "boolean"
},
"null": {
"type": "boolean"
},
"number": {
"type": "boolean"
},
"int": {
"type": "boolean"
},
"object": {
"type": "boolean"
},
"valueNode": {
"type": "boolean"
},
"containerNode": {
"type": "boolean"
},
"missingNode": {
"type": "boolean"
},
"pojo": {
"type": "boolean"
},
"integralNumber": {
"type": "boolean"
},
"floatingPointNumber": {
"type": "boolean"
},
"short": {
"type": "boolean"
},
"long": {
"type": "boolean"
},
"double": {
"type": "boolean"
},
"bigDecimal": {
"type": "boolean"
},
"bigInteger": {
"type": "boolean"
},
"textual": {
"type": "boolean"
},
"boolean": {
"type": "boolean"
},
"binary": {
"type": "boolean"
},
"nodeType": {
"type": "string",
"enum": [
"ARRAY",
"BINARY",
"BOOLEAN",
"MISSING",
"NULL",
"NUMBER",
"OBJECT",
"POJO",
"STRING"
]
},
"float": {
"type": "boolean"
}
}
},
"ScoreResponse": {
"type": "object",
"required": [
"id",
"latticeID",
"timestamp"
],
"properties": {
"warnings": {
"type": "array",
"description": "Warnings",
"items": {
"$ref": "#/definitions/Warning"
}
},
"timestamp": {
"type": "string",
"description": "The UTC timestamp of this score in ISO8601 format"
},
"id": {
"type": "string",
"description": "Record ID"
},
"latticeID": {
"type": "string",
"description": "Lattice ID for record"
},
"score": {
"type": "integer",
"format": "int32",
"description": "Score"
},
"rating": {
"type": "string",
"description": "Bucket Information Based on Score"
},
"classification": {
"type": "string",
"description": "Classification"
},
"enrichmentAttributeValues": {
"type": "object",
"description": "Enrichment attribute values",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"Field": {
"type": "object",
"required": [
"fieldName",
"fieldType"
],
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field"
},
"fieldType": {
"type": "string",
"description": "Data type of the field",
"enum": [
"BOOLEAN",
"INTEGER",
"FLOAT",
"LONG",
"STRING"
]
},
"displayName": {
"type": "string",
"description": "Display name of the field"
},
"isPrimary": {
"type": "boolean"
}
}
},
"Empty": {
"type": "object",
"title": "Empty Schema"
},
"Fields": {
"type": "object",
"required": [
"fields",
"modelId",
"validationExpression"
],
"properties": {
"modelId": {
"type": "string",
"description": "Unique model id"
},
"fields": {
"type": "array",
"description": "List of field",
"items": {
"$ref": "#/definitions/Field"
}
},
"validationExpression": {
"type": "string",
"description": "Validation Expression"
}
}
},
"ArrayOfModel": {
"type": "array",
"items": {
"$ref": "#/definitions/Model"
}
},
"Model": {
"type": "object",
"required": [
"modelId",
"type"
],
"properties": {
"modelId": {
"type": "string",
"description": "Unique model id"
},
"name": {
"type": "string",
"description": "User customizable model name"
},
"type": {
"type": "string",
"description": "Model Type",
"enum": [
"account",
"contact"
]
}
}
},
"ModelDetail": {
"type": "object",
"properties": {
"model": {
"description": "Model",
"$ref": "#/definitions/Model"
},
"status": {
"type": "string",
"description": "Model status enum (Active, Deactive, Deleted)",
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"fields": {
"description": "Model fields",
"$ref": "#/definitions/Fields"
},
"lastModifiedTimestamp": {
"type": "string",
"description": "Last modified timestamp in ISO8601 format "
}
}
},
"ArrayOfModelDetail": {
"type": "array",
"items": {
"$ref": "#/definitions/ModelDetail"
}
},
"EnrichRequest": {
"type": "object",
"required": [
"Domain"
],
"properties": {
"Domain": {
"type": "string",
"description": "Domain"
},
"Company": {
"type": "string",
"description": "Company"
},
"State": {
"type": "string",
"description": "State"
},
"Country": {
"type": "string",
"description": "Country"
},
"source": {
"type": "string",
"description": "Name of the source system that originated this score request."
},
"DUNS": {
"type": "string",
"description": "DUNS"
}
}
}
}
}
|
Comments
0 comments
Please sign in to leave a comment.