機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

基準に一致する会社/担当者のリストを取得

post

/api/v4/search

値が存在する属性のみを含む会社/担当者の検索結果が表示されます。

サポートされるバージョン:

v4

会社属性の完全なリスト: 会社属性
担当者属性の完全なリスト: 担当者属性

リクエスト

この操作にはリクエスト・パラメータがありません。

サポートされるメディア・タイプ

• application/xml; charset=UTF-8
• application/json; charset=UTF-8

リクエスト本文 - application/json; charset=UTF-8 ()

検索リクエストを保持するSearchRequestエンティティ

XMLの例:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<searchRequest>
	<facetLimit>10</facetLimit>
	<filterFields>
		<name>info.organization_name</name>
		<operator>EQ</operator>
		<value>oracle</value>
	</filterFields>
	<filterFields>
		<name>location.country</name>
		<operator>EQ</operator>
		<value>USA</value>
	</filterFields>
	<filterFields>
		<name>company.ees_total</name>
		<operator>GT</operator>
		<value>100</value>
	</filterFields>
	<filterFields>
		<name>company.sales_volume</name>
		<operator>LTE</operator>
		<value>150000000</value>
	</filterFields>
	<limit>10</limit>
	<objectType>Companies</objectType>
	<offset>0</offset>
	<orderByDirection>DESC</orderByDirection>
	<rangeFilters>
		<name>company.ees_total</name>
		<range>
			<from>2</from>
			<to>1000000</to>
		</range>
	</rangeFilters>
	<defaultFilters>
		<filterName>Defunct</filterName>		
	</defaultFilters>
	<returnAll>false</returnAll>
	<returnFacets>location</returnFacets>
	<returnFacets>company.maj_ind_cg</returnFacets>
	<returnFields>location.country</returnFields>
	<returnFields>location.city</returnFields>
	<returnFields>company.maj_ind_cg</returnFields>
</searchRequest>

JSONの例:

{
	"facetLimit":"10",
	"filterFields":[{
		"name":"info.organization_name",
		"operator":"EQ",
		"value":"oracle"
		},
		{
		"name":"location.country",
		"operator":"EQ",
		"value":"USA"
		},
		{
	 	"name":"company.ees_total",
		"operator":"GT",
	 	"value":"100"           
	},
	{
	 	"name":"company.sales_volume",
		"operator":"LTE",
	 	"value":"150000000"           
	}],
	"limit":"10",
	"objectType":"Companies",
	"offset":"0",
	"orderByDirection":"DESC",
	"rangeFilters":{
		"name":"company.ees_total",
		"range":{
			"from":"2",
			"to":"1000000"
			}
	},
 		"defaultFilters" : [{
 		    "filterName" : "Defunct"
 		 }],
	"returnAll":"false",
	"returnFacets":["location","company.maj_ind_cg"],
	"returnFields":["location.country","location.city","company.maj_ind_cg"]
}
 

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• advancedSearch: object AdvancedSearchFilters
• defaultFilters: array defaultFilters
• exportCount: boolean
• facetLimit: integer (int32)
• filterFields: array filterFields
• filterQuery: string
• limit: integer (int32)
• mapName: string
• objectType: string
  許可された値: [ "Companies", "People" ]
• offset: integer (int32)
• orderBy: string
• orderByDir: string
• orderByDirection: string
  許可された値: [ "ASC", "DESC" ]
• query: string
• radialFilter: object RadialFilter
• rangeFilters: array rangeFilters
• returnAll: boolean
• returnFacetFields: array returnFacetFields
• returnFacets: array returnFacets
• returnFields: array returnFields
• selectedFacets: array selectedFacets

{
    "properties":{
        "advancedSearch":{
            "$ref":"#/components/schemas/AdvancedSearchFilters"
        },
        "defaultFilters":{
            "items":{
            },
            "type":"array"
        },
        "exportCount":{
            "type":"boolean"
        },
        "facetLimit":{
            "format":"int32",
            "type":"integer"
        },
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterQuery":{
            "type":"string"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "mapName":{
            "type":"string"
        },
        "objectType":{
            "$ref":"#/components/schemas/ObjectType"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "orderBy":{
            "type":"string"
        },
        "orderByDir":{
            "type":"string"
        },
        "orderByDirection":{
            "$ref":"#/components/schemas/OrderBy"
        },
        "query":{
            "type":"string"
        },
        "radialFilter":{
            "$ref":"#/components/schemas/RadialFilter"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        },
        "returnAll":{
            "type":"boolean"
        },
        "returnFacetFields":{
            "items":{
                "$ref":"#/components/schemas/FacetFieldInfo"
            },
            "type":"array"
        },
        "returnFacets":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "returnFields":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "selectedFacets":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : AdvancedSearchFilters

タイプ: object

ソースを表示

• advancedFilterQuery: string
• advancedFilters: array advancedFilters

{
    "properties":{
        "advancedFilterQuery":{
            "type":"string"
        },
        "advancedFilters":{
            "items":{
                "$ref":"#/components/schemas/AdvancedSearchFilterSet"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : defaultFilters

タイプ: array

ソースを表示

• Array of:

{
    "items":{
    },
    "type":"array"
}

ネストされたスキーマ : filterFields

タイプ: array

ソースを表示

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : RadialFilter

タイプ: object

ソースを表示

• countryName: string
• isNotNullFlag: boolean
• name: string
• notNullFlag: boolean
• operator: string
  許可された値: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• radius: string
• unit: string
  許可された値: [ "km", "mi" ]
• value: string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "countryName":{
            "type":"string"
        },
        "radius":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/UNIT"
        }
    },
    "type":"object"
}

ネストされたスキーマ : rangeFilters

タイプ: array

ソースを表示

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : returnFacetFields

タイプ: array

ソースを表示

• Array of: object FacetFieldInfo

{
    "items":{
        "$ref":"#/components/schemas/FacetFieldInfo"
    },
    "type":"array"
}

ネストされたスキーマ : returnFacets

タイプ: array

ソースを表示

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

ネストされたスキーマ : returnFields

タイプ: array

ソースを表示

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

ネストされたスキーマ : selectedFacets

タイプ: array

ソースを表示

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : advancedFilters

タイプ: array

ソースを表示

• Array of: object AdvancedSearchFilterSet

{
    "items":{
        "$ref":"#/components/schemas/AdvancedSearchFilterSet"
    },
    "type":"array"
}

ネストされたスキーマ : AdvancedSearchFilterSet

タイプ: object

ソースを表示

• filterFields: array filterFields
• filterSetId: string
• match: string
  許可された値: [ "ALL", "ANY" ]
• rangeFilters: array rangeFilters

{
    "properties":{
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterSetId":{
            "type":"string"
        },
        "match":{
            "$ref":"#/components/schemas/Match"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : filterFields

タイプ: array

ソースを表示

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : rangeFilters

タイプ: array

ソースを表示

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : FilterInfo

タイプ: object

ソースを表示

• isNotNullFlag: boolean
• name: string
• notNullFlag: boolean
• operator: string
  許可された値: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• value: string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        }
    },
    "type":"object"
}

ネストされたスキーマ : RangeFilterInfo

タイプ: object

ソースを表示

• isNotNullFlag: boolean
• name: string
• notNullFlag: boolean
• operator: string
  許可された値: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• range: object Range
• value: string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "range":{
            "$ref":"#/components/schemas/Range"
        }
    },
    "type":"object"
}

ネストされたスキーマ : 範囲

タイプ: object

ソースを表示

• from: string
• to: string

{
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    },
    "type":"object"
}

ネストされたスキーマ : FacetFieldInfo

タイプ: object

ソースを表示

• limit: integer (int32)
• minCount: integer (int32)
• name: string
• offset: integer (int32)
• sortBy: string
  許可された値: [ "count", "index" ]

{
    "properties":{
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "minCount":{
            "format":"int32",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "sortBy":{
            "$ref":"#/components/schemas/SortBy"
        }
    },
    "type":"object"
}

リクエスト本文 - application/xml; charset=UTF-8 ()

検索リクエストを保持するSearchRequestエンティティ

XMLの例:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<searchRequest>
	<facetLimit>10</facetLimit>
	<filterFields>
		<name>info.organization_name</name>
		<operator>EQ</operator>
		<value>oracle</value>
	</filterFields>
	<filterFields>
		<name>location.country</name>
		<operator>EQ</operator>
		<value>USA</value>
	</filterFields>
	<filterFields>
		<name>company.ees_total</name>
		<operator>GT</operator>
		<value>100</value>
	</filterFields>
	<filterFields>
		<name>company.sales_volume</name>
		<operator>LTE</operator>
		<value>150000000</value>
	</filterFields>
	<limit>10</limit>
	<objectType>Companies</objectType>
	<offset>0</offset>
	<orderByDirection>DESC</orderByDirection>
	<rangeFilters>
		<name>company.ees_total</name>
		<range>
			<from>2</from>
			<to>1000000</to>
		</range>
	</rangeFilters>
	<defaultFilters>
		<filterName>Defunct</filterName>		
	</defaultFilters>
	<returnAll>false</returnAll>
	<returnFacets>location</returnFacets>
	<returnFacets>company.maj_ind_cg</returnFacets>
	<returnFields>location.country</returnFields>
	<returnFields>location.city</returnFields>
	<returnFields>company.maj_ind_cg</returnFields>
</searchRequest>

JSONの例:

{
	"facetLimit":"10",
	"filterFields":[{
		"name":"info.organization_name",
		"operator":"EQ",
		"value":"oracle"
		},
		{
		"name":"location.country",
		"operator":"EQ",
		"value":"USA"
		},
		{
	 	"name":"company.ees_total",
		"operator":"GT",
	 	"value":"100"           
	},
	{
	 	"name":"company.sales_volume",
		"operator":"LTE",
	 	"value":"150000000"           
	}],
	"limit":"10",
	"objectType":"Companies",
	"offset":"0",
	"orderByDirection":"DESC",
	"rangeFilters":{
		"name":"company.ees_total",
		"range":{
			"from":"2",
			"to":"1000000"
			}
	},
 		"defaultFilters" : [{
 		    "filterName" : "Defunct"
 		 }],
	"returnAll":"false",
	"returnFacets":["location","company.maj_ind_cg"],
	"returnFields":["location.country","location.city","company.maj_ind_cg"]
}
 

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• advancedSearch: object AdvancedSearchFilters
• defaultFilters: array defaultFilters
• exportCount: boolean
• facetLimit: integer (int32)
• filterFields: array filterFields
• filterQuery: string
• limit: integer (int32)
• mapName: string
• objectType: string
  許可された値: [ "Companies", "People" ]
• offset: integer (int32)
• orderBy: string
• orderByDir: string
• orderByDirection: string
  許可された値: [ "ASC", "DESC" ]
• query: string
• radialFilter: object RadialFilter
• rangeFilters: array rangeFilters
• returnAll: boolean
• returnFacetFields: array returnFacetFields
• returnFacets: array returnFacets
• returnFields: array returnFields
• selectedFacets: array selectedFacets

{
    "properties":{
        "advancedSearch":{
            "$ref":"#/components/schemas/AdvancedSearchFilters"
        },
        "defaultFilters":{
            "items":{
            },
            "type":"array"
        },
        "exportCount":{
            "type":"boolean"
        },
        "facetLimit":{
            "format":"int32",
            "type":"integer"
        },
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterQuery":{
            "type":"string"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "mapName":{
            "type":"string"
        },
        "objectType":{
            "$ref":"#/components/schemas/ObjectType"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "orderBy":{
            "type":"string"
        },
        "orderByDir":{
            "type":"string"
        },
        "orderByDirection":{
            "$ref":"#/components/schemas/OrderBy"
        },
        "query":{
            "type":"string"
        },
        "radialFilter":{
            "$ref":"#/components/schemas/RadialFilter"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        },
        "returnAll":{
            "type":"boolean"
        },
        "returnFacetFields":{
            "items":{
                "$ref":"#/components/schemas/FacetFieldInfo"
            },
            "type":"array"
        },
        "returnFacets":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "returnFields":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "selectedFacets":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : AdvancedSearchFilters

タイプ: object

ソースを表示

• advancedFilterQuery: string
• advancedFilters: array advancedFilters

{
    "properties":{
        "advancedFilterQuery":{
            "type":"string"
        },
        "advancedFilters":{
            "items":{
                "$ref":"#/components/schemas/AdvancedSearchFilterSet"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : defaultFilters

タイプ: array

ソースを表示

• Array of:

{
    "items":{
    },
    "type":"array"
}

ネストされたスキーマ : filterFields

タイプ: array

ソースを表示

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : RadialFilter

タイプ: object

ソースを表示

• countryName: string
• isNotNullFlag: boolean
• name: string
• notNullFlag: boolean
• operator: string
  許可された値: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• radius: string
• unit: string
  許可された値: [ "km", "mi" ]
• value: string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "countryName":{
            "type":"string"
        },
        "radius":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/UNIT"
        }
    },
    "type":"object"
}

ネストされたスキーマ : rangeFilters

タイプ: array

ソースを表示

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : returnFacetFields

タイプ: array

ソースを表示

• Array of: object FacetFieldInfo

{
    "items":{
        "$ref":"#/components/schemas/FacetFieldInfo"
    },
    "type":"array"
}

ネストされたスキーマ : returnFacets

タイプ: array

ソースを表示

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

ネストされたスキーマ : returnFields

タイプ: array

ソースを表示

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

ネストされたスキーマ : selectedFacets

タイプ: array

ソースを表示

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : advancedFilters

タイプ: array

ソースを表示

• Array of: object AdvancedSearchFilterSet

{
    "items":{
        "$ref":"#/components/schemas/AdvancedSearchFilterSet"
    },
    "type":"array"
}

ネストされたスキーマ : AdvancedSearchFilterSet

タイプ: object

ソースを表示

• filterFields: array filterFields
• filterSetId: string
• match: string
  許可された値: [ "ALL", "ANY" ]
• rangeFilters: array rangeFilters

{
    "properties":{
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterSetId":{
            "type":"string"
        },
        "match":{
            "$ref":"#/components/schemas/Match"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : filterFields

タイプ: array

ソースを表示

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : rangeFilters

タイプ: array

ソースを表示

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : FilterInfo

タイプ: object

ソースを表示

• isNotNullFlag: boolean
• name: string
• notNullFlag: boolean
• operator: string
  許可された値: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• value: string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        }
    },
    "type":"object"
}

ネストされたスキーマ : RangeFilterInfo

タイプ: object

ソースを表示

• isNotNullFlag: boolean
• name: string
• notNullFlag: boolean
• operator: string
  許可された値: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• range: object Range
• value: string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "range":{
            "$ref":"#/components/schemas/Range"
        }
    },
    "type":"object"
}

ネストされたスキーマ : 範囲

タイプ: object

ソースを表示

• from: string
• to: string

{
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    },
    "type":"object"
}

ネストされたスキーマ : FacetFieldInfo

タイプ: object

ソースを表示

• limit: integer (int32)
• minCount: integer (int32)
• name: string
• offset: integer (int32)
• sortBy: string
  許可された値: [ "count", "index" ]

{
    "properties":{
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "minCount":{
            "format":"int32",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "sortBy":{
            "$ref":"#/components/schemas/SortBy"
        }
    },
    "type":"object"
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/xml; charset=UTF-8
• application/json; charset=UTF-8

200 レスポンス

成功

本文( )

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• facets: array facets
• parties: array parties
• request: object SearchRequest
• totalHits: integer (int64)

{
    "properties":{
        "facets":{
            "items":{
                "$ref":"#/components/schemas/FacetInfo"
            },
            "type":"array"
        },
        "parties":{
            "items":{
                "type":"object"
            },
            "type":"array"
        },
        "request":{
            "$ref":"#/components/schemas/SearchRequest"
        },
        "totalHits":{
            "format":"int64",
            "type":"integer"
        }
    },
    "type":"object"
}

ネストされたスキーマ : ファセット

タイプ: array

ソースを表示

• Array of: object FacetInfo

{
    "items":{
        "$ref":"#/components/schemas/FacetInfo"
    },
    "type":"array"
}

ネストされたスキーマ : パーティ

タイプ: array

ソースを表示

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":"array"
}

ネストされたスキーマ : SearchRequest

タイプ: object

ソースを表示

• advancedSearch: object AdvancedSearchFilters
• defaultFilters: array defaultFilters
• exportCount: boolean
• facetLimit: integer (int32)
• filterFields: array filterFields
• filterQuery: string
• limit: integer (int32)
• mapName: string
• objectType: string
  許可された値: [ "Companies", "People" ]
• offset: integer (int32)
• orderBy: string
• orderByDir: string
• orderByDirection: string
  許可された値: [ "ASC", "DESC" ]
• query: string
• radialFilter: object RadialFilter
• rangeFilters: array rangeFilters
• returnAll: boolean
• returnFacetFields: array returnFacetFields
• returnFacets: array returnFacets
• returnFields: array returnFields
• selectedFacets: array selectedFacets

{
    "properties":{
        "advancedSearch":{
            "$ref":"#/components/schemas/AdvancedSearchFilters"
        },
        "defaultFilters":{
            "items":{
            },
            "type":"array"
        },
        "exportCount":{
            "type":"boolean"
        },
        "facetLimit":{
            "format":"int32",
            "type":"integer"
        },
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterQuery":{
            "type":"string"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "mapName":{
            "type":"string"
        },
        "objectType":{
            "$ref":"#/components/schemas/ObjectType"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "orderBy":{
            "type":"string"
        },
        "orderByDir":{
            "type":"string"
        },
        "orderByDirection":{
            "$ref":"#/components/schemas/OrderBy"
        },
        "query":{
            "type":"string"
        },
        "radialFilter":{
            "$ref":"#/components/schemas/RadialFilter"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        },
        "returnAll":{
            "type":"boolean"
        },
        "returnFacetFields":{
            "items":{
                "$ref":"#/components/schemas/FacetFieldInfo"
            },
            "type":"array"
        },
        "returnFacets":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "returnFields":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "selectedFacets":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : FacetInfo

タイプ: object

ソースを表示

• attribute: string
• count: integer (int64)
• displayValue: string
• value: string

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "count":{
            "format":"int64",
            "type":"integer"
        },
        "displayValue":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "type":"object"
}

ネストされたスキーマ : アイテム

タイプ: object

ネストされたスキーマ : AdvancedSearchFilters

タイプ: object

ソースを表示

• advancedFilterQuery: string
• advancedFilters: array advancedFilters

{
    "properties":{
        "advancedFilterQuery":{
            "type":"string"
        },
        "advancedFilters":{
            "items":{
                "$ref":"#/components/schemas/AdvancedSearchFilterSet"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : defaultFilters

タイプ: array

ソースを表示

• Array of:

{
    "items":{
    },
    "type":"array"
}

ネストされたスキーマ : filterFields

タイプ: array

ソースを表示

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : RadialFilter

タイプ: object

ソースを表示

• countryName: string
• isNotNullFlag: boolean
• name: string
• notNullFlag: boolean
• operator: string
  許可された値: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• radius: string
• unit: string
  許可された値: [ "km", "mi" ]
• value: string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "countryName":{
            "type":"string"
        },
        "radius":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/UNIT"
        }
    },
    "type":"object"
}

ネストされたスキーマ : rangeFilters

タイプ: array

ソースを表示

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : returnFacetFields

タイプ: array

ソースを表示

• Array of: object FacetFieldInfo

{
    "items":{
        "$ref":"#/components/schemas/FacetFieldInfo"
    },
    "type":"array"
}

ネストされたスキーマ : returnFacets

タイプ: array

ソースを表示

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

ネストされたスキーマ : returnFields

タイプ: array

ソースを表示

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

ネストされたスキーマ : selectedFacets

タイプ: array

ソースを表示

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : advancedFilters

タイプ: array

ソースを表示

• Array of: object AdvancedSearchFilterSet

{
    "items":{
        "$ref":"#/components/schemas/AdvancedSearchFilterSet"
    },
    "type":"array"
}

ネストされたスキーマ : AdvancedSearchFilterSet

タイプ: object

ソースを表示

• filterFields: array filterFields
• filterSetId: string
• match: string
  許可された値: [ "ALL", "ANY" ]
• rangeFilters: array rangeFilters

{
    "properties":{
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterSetId":{
            "type":"string"
        },
        "match":{
            "$ref":"#/components/schemas/Match"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

ネストされたスキーマ : filterFields

タイプ: array

ソースを表示

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : rangeFilters

タイプ: array

ソースを表示

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

ネストされたスキーマ : FilterInfo

タイプ: object

ソースを表示

• isNotNullFlag: boolean
• name: string
• notNullFlag: boolean
• operator: string
  許可された値: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• value: string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        }
    },
    "type":"object"
}

ネストされたスキーマ : RangeFilterInfo

タイプ: object

ソースを表示

• isNotNullFlag: boolean
• name: string
• notNullFlag: boolean
• operator: string
  許可された値: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• range: object Range
• value: string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "range":{
            "$ref":"#/components/schemas/Range"
        }
    },
    "type":"object"
}

ネストされたスキーマ : 範囲

タイプ: object

ソースを表示

• from: string
• to: string

{
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    },
    "type":"object"
}

ネストされたスキーマ : FacetFieldInfo

タイプ: object

ソースを表示

• limit: integer (int32)
• minCount: integer (int32)
• name: string
• offset: integer (int32)
• sortBy: string
  許可された値: [ "count", "index" ]

{
    "properties":{
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "minCount":{
            "format":"int32",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "sortBy":{
            "$ref":"#/components/schemas/SortBy"
        }
    },
    "type":"object"
}

500 レスポンス

リクエスト中に予期しないエラーが発生しました。

本文( )

ルート・スキーマ : スキーマ

タイプ: object

トップに戻る

例:

リクエストの例:

/api/v4/search

SearchRequest JSONオブジェクトの例:

{"objectType":"Companies","query":"oracle","offset":"0","limit":"10","facetLimit":"10"}
{"objectType":"People","offset":"0","limit":"10","facetLimit":"10"}
{"objectType":"Companies","query":"oracle","offset":"0","limit":"10","facetLimit":"10","returnAll":"true"}
{"objectType":"Companies","query":"oracle","offset":"0","limit":"10","facetLimit":"10","returnFields":["location.city", "location.state"]}
{"objectType":"Companies","offset":"0","limit":"10","facetLimit":"10","returnFields":["info.organization_name","location.city", "location.state","company.sales_volume"],"filterFields":[{"name":"location.state","value":"CA"}]}
{"objectType":"People","offset":"0","limit":"10","facetLimit":"0","defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"N"},{"filterName":"Medium Companies","filterValue":"Y"},{"filterName":"Small Companies","filterValue":"Y"},{"filterName":"Defunct","filterValue":"Y"},{"filterName":"Out Of Business","filterValue":"Y"}]}
{"objectType":"People","offset":"0","limit":"10","facetLimit":"0","defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"N"},{"filterName":"Medium Companies","filterValue":"Y"},{"filterName":"Small Companies","filterValue":"Y"},{"filterName":"Defunct","filterValue":"Y"},{"filterName":"Out Of Business","filterValue":"Y"},{"filterName":"Delisted","filterValue":"Y"}]}
{"objectType":"Companies","offset":"0","limit":"10","facetLimit":"0","defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"Y"},{"filterName":"Medium Companies","filterValue":"Y"},{"filterName":"Small Companies","filterValue":"N"},{"filterName":"Defunct","filterValue":"Y"},{"filterName":"Out Of Business","filterValue":"N"}],"rangeFilters":[{"name":"company.sales_volume","range":{"from":"1000000","to":"999999999"}}]}
{"objectType":"People","offset":"0","limit":"10","facetLimit":"5","selectedFacets":[{"name":"person.department", "value":"3" },{"name":"person.department", "value":"10" }],"returnFacetFields":[{"name":"company.status_ind","offset":0,"limit":-1,"minCount":0,"sortBy":"index"},{"name":"person.department","offset":0,"limit":5,"minCount":0,"sortBy":"count"}],"orderBy":"location.state","orderByDir":"DESC"}
{"objectType":"People","offset":"0","limit":"10","selectedFacets":[{ "name":"person.department", "value":"10" },{ "name":"location", "value":"USA" }],"returnFacetFields":[{"name":"location","offset":0,"limit":10,"minCount":0,"sortBy":"count"},{"name":"person.department","offset":0,"limit":5,"minCount":0,"sortBy":"count"},{"name":"companies"}],"orderBy":"location.country","orderByDir":"DESC","rangeFilters":[{"name":"location.postal_code","range":{"from":"30620","to":"80622"}}],"defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"N"}]}
{"objectType":"Companies","limit":"0","offset":"0","selectedFacets":[{ "name":"location", "value":"USA" },{"name":"company.primary_naics_cd","value":"11"}],"returnFacetFields":[{"name":"company.primary_naics_cd","offset":0,"limit":10,"minCount":0,"sortBy":"index"}],"rangeFilters":[{"name":"location.postal_code","range":{"from":"30000","to":"80622"}}]}

レスポンスの例:

 {
 "parties 
 	type=person":[
 {"Id":"Some Id", "Name":"Some Name","Title":"Some Title","Email":"Some Email",...(MORE)}, 
 {"Id":"Some Id", "Name":"Some Name","Title":"Some Title","Email":"Some Email",...(MORE)}]
}
 
 {
 "parties 
 type:company":[
 {" Id":"Some Id", "Name":"Some Company","DUNSNumber":"123456",...(MORE)}
 {" Id":"Some Id", "Name":"Some Company","DUNSNumber":"123456",...(MORE)}] 
 "facets":[
 {"attribute":"some attribute", "value":"value for attribute", "count":"some count"}]
}
 

「トップに戻る」