openapi: 3.2.0
info:
title: Visier Data Out Search API
description: Visier APIs for getting data out of Visier, such as aggregate data and data version information.
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: 22222222.99201.3040
security:
- ApiKeyAuth: []
BearerAuth: []
- ApiKeyAuth: []
CookieAuth: []
- ApiKeyAuth: []
OAuth2Auth: []
tags:
- name: Search
description: 'Search for documents, such as analyses, in Visier.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>'
paths:
/v1alpha/search/simple/document-headers:
get:
tags:
- Search
summary: Perform a simple search for Visier document headers
description: "Perform a simple search for Visier document headers, such as analysis titles. Simple search doesn't support keywords, Boolean expressions, or any other advanced search features.\n Example: `GET /v1alpha/search/simple/document-headers?q=My+Query&limit=10` returns the first 10 document headers that best match the query string `My Query`.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: Search_SimpleSearchDocumentHeaders
parameters:
- name: q
in: query
description: The search query string. The results include document headers that match the search string. Search string is case-insensitive and supports partial matches. Search string must be at least 2 characters up to a maximum of 200 characters.
schema:
type: string
- name: limit
in: query
description: The maximum number of results to return. Defaults to 100.
schema:
type: integer
format: int32
- name: offset
in: query
description: The index to start retrieving results from, also known as offset. Defaults to 0.
schema:
type: integer
format: int32
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.SimpleDocumentHeaderSearchResponseDTO'
/v1alpha/search/visier-objects:
post:
tags:
- Search
summary: Search for Visier objects
description: "Perform a search for Visier objects, such as metrics, dimensions, dimension members, concepts, analytic objects, and properties.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: Search_ContextSearchDocumentHeaders
parameters:
- name: TargetTenantID
in: header
description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
schema:
type: string
- name: ProjectID
in: header
description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.VisierObjectSearchRequestDTO'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.VisierObjectSearchResponseDTO'
components:
schemas:
servicing.DimensionMemberSearchContextDTO:
type: object
properties:
analyticObjectId:
type: string
description: The unique identifier of the analytic object to which the dimension member belongs.
dimensionId:
type: array
items:
type: string
description: A list of unique identifiers representing the dimensions to which the dimension member belongs.
leafMembersOnly:
type: boolean
description: If `true`, the response only includes leaf dimension members. Default is `false`.
servicing.DimensionSearchContextDTO:
type: object
properties:
analyticObjectId:
type: string
description: The unique identifier of the analytic object to which the dimension belongs.
metricId:
type: string
description: The unique identifier of the metric to which the dimension applies.
servicing.VisierObjectSearchRequestDTO:
type: object
properties:
query:
type: array
items:
type: string
description: The search string. You can provide multiple search strings. The results include Visier object headers that match each of the search strings. Search strings are case-insensitive and support partial matches. Search strings must be at least 2 characters up to a maximum of 200 characters.
objectType:
enum:
- UNKNOWN
- METRIC
- DIMENSION
- DIMENSION_MEMBER
- CONCEPT
- ANALYTIC_OBJECT
- PROPERTY
type: string
description: "The type of Visier object to search. Valid values:\n - `METRIC`: Search for metrics that match the search strings.\n - `DIMENSION`: Search for dimensions that match the search strings.\n - `DIMENSION_MEMBER`: Search for dimension members that match the search strings.\n - `CONCEPT`: Search for concepts that match the search strings.\n - `ANALYTIC_OBJECT`: Search for analytic objects that match the search strings.\n - `PROPERTY`: Search for properties that match the search strings."
format: enum
limit:
type: integer
description: The maximum number of results to return. Default and maximum are 100.
format: int32
offset:
type: integer
description: The index to start retrieving results from, also known as offset. Default is 0.
format: int32
mask:
type: string
description: "A comma-separated list of additional fields to include in the response. Valid values:\n - For all objects: `Description`, `Explanation`, `Tags`\n - For `METRIC` search: `analyticObjectId`, `dataStartDate`, `dataEndDate`\n - For `ANALYTIC_OBJECT` search: `objectReferences`, `analyticObjectType`, `dataStartDate`, `dataEndDate`, `propertyIds`\n - For `DIMENSION_MEMBER` search: `path`, `level`, `dimensionId`\n - For `PROPERTY` search: `dataType`\n\n For example, to get descriptions and tags in the response, set `mask=\"Description,Tags\"`."
includeDocumentIdSearch:
type: boolean
description: If `true`, the search includes document IDs. This is not valid for `DIMENSION_MEMBER` object type. Default is `false`. Note that document ID search queries are case-sensitive.
dimensionSearchContext:
allOf:
- $ref: '#/components/schemas/servicing.DimensionSearchContextDTO'
description: Additional context to refine a dimension search.
conceptSearchContext:
allOf:
- $ref: '#/components/schemas/servicing.ConceptSearchContextDTO'
description: Additional context to refine a concept search.
dimensionMemberSearchContext:
allOf:
- $ref: '#/components/schemas/servicing.DimensionMemberSearchContextDTO'
description: Additional context to refine a dimension member search.
propertySearchContext:
allOf:
- $ref: '#/components/schemas/servicing.PropertySearchContextDTO'
description: Additional context to refine a property search.
description: The context search to perform.
servicing.PropertySearchContextDTO:
type: object
properties:
analyticObjectId:
type: string
description: The unique identifier of the analytic object to which the property belongs.
servicing.VisierObjectSearchResultDTO:
type: object
properties:
id:
type: string
description: 'The unique identifier of the Visier object in the search result. For dimension members, the unique identifier is the qualified name: the dimension''s object name and member''s object name separated by a period; for example, `Location.Canada`.'
displayName:
type: string
description: The localized display name of the Visier object in the search result.
matchedField:
type: string
description: The object field that matched the search string.
matchScore:
type: number
description: The quality of the match. Higher scores represent better matches.
format: float
description:
type: string
description: The localized description of the Visier object in the search result. Only included if the `mask` parameter contained `Description`.
explanation:
type: string
description: The localized explanation of the Visier object in the search result. Only included if the `mask` parameter contained `Explanation`.
tags:
type: array
items:
type: string
description: The tags associated with the Visier object in the search result. Only included if the `mask` parameter contained `Tags`.
qualifyingPath:
type: string
description: The path to the Visier object ID, such as the analytic object with which the object is associated. If the path includes multiple objects, they are separated by periods; for example, `Employee.Candidate.Gender`.
metadata:
type: object
description: Additional metadata about the Visier object in the search result. This is included if certain `mask` values are specified in the request. For more information, see the `mask` field description in request object.
servicing.SimpleDocumentHeaderSearchResponseDTO:
type: object
properties:
documentHeaders:
type: array
items:
$ref: '#/components/schemas/servicing.SimpleDocumentHeaderSearchResultDTO'
description: The ordered collection of document header search results. The results are sorted according to their relevance in a descending order.
description: The response body structure for Simple document header search operations.
servicing.SimpleDocumentHeaderSearchResultDTO:
type: object
properties:
displayName:
type: string
description: The display name of the element in the search result.
description:
type: string
description: The `Web Template Framework` representation of the search result element. This commonly displayed alongside the result by search portals.
relevance:
type: number
description: The relevance of the search result and a number between `0` and `100`.
format: double
viewLink:
allOf:
- $ref: '#/components/schemas/servicing.DocumentSearchLinkDTO'
description: Use the `viewLink` to build a web request to view this document.
description: Structure of a single document header search using the Simple search operation.
servicing.VisierObjectSearchResultsDTO:
type: object
properties:
resultsForQuery:
type: array
items:
$ref: '#/components/schemas/servicing.VisierObjectSearchResultDTO'
description: The collection of search results for a specific `query` search string.
servicing.DocumentSearchLinkDTO:
type: object
properties:
href:
type: string
description: The URL pointing to the specific document.
verb:
type: string
description: The verb to use when formulating the web request. This is commonly `GET`.
description: Defines the attributes of a web request to reference documents in the search results.
servicing.ConceptSearchContextDTO:
type: object
properties:
analyticObjectId:
type: string
description: The unique identifier of the analytic object to which the concept belongs.
metricId:
type: string
description: The unique identifier of the metric to which the concept applies.
servicing.VisierObjectSearchResponseDTO:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/servicing.VisierObjectSearchResultsDTO'
description: "The collection of search results for all `query` search strings. Each result corresponds to one query's search results. The entries are in the same order as the `query` search strings. For example, if the request includes two `query` terms, `headcount` and `turnover`, the response contains two entries in the collection, as shown next.\n\n ```\n \"results\": [\n \"resultsForQuery\": [\n {\n id: \"employeeCount\",\n displayName: \"Headcount\",\n matchedField: \"<B>Headcount</B>\",\n matchScore: 198.0\n },\n {\n id: \"employeeRatio\",\n displayName: \"Headcount Ratio\",\n matchedField: \"<B>Headcount</B> Ratio\",\n matchScore: 190.0\n }\n ],\n \"resultsForQuery\": [\n {\n id: \"turnoverRate\",\n displayName: \"Turnover Rate\",\n matchedField: \"<B>Turnover</B> Rate\",\n matchScore: 98.5\n },\n {\n id: \"turnoverCost\",\n displayName: \"Turnover Cost\",\n matchedField: \"Turnover Cost\",\n matchScore: 95.0\n }\n ]\n ]\n ```"
Status:
type: object
properties:
localizedMessage:
type: string
description: Localized error message describing the root cause of the error.
code:
type: string
description: Error classification.
message:
type: string
description: Not used.
rci:
type: string
description: Optional root cause identifier.
userError:
type: boolean
description: Indicates whether the error is a user error.
description: The response structure for errors.
securitySchemes:
CookieAuth:
type: apiKey
name: VisierASIDToken
in: cookie
ApiKeyAuth:
type: apiKey
name: apikey
in: header
BearerAuth:
type: http
scheme: bearer
OAuth2Auth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: /v1/auth/oauth2/authorize
tokenUrl: /v1/auth/oauth2/token
scopes:
read: Grants read access
write: Grants write access
password:
tokenUrl: /v1/auth/oauth2/token
scopes:
read: Grants read access
write: Grants write access
x-tagGroups:
- name: data out
tags:
- DataQuery
- DataVersionExport
- VeeV1
- VeeV2
- Search
- SourceFilesDownload
- Reporting
- DataExportConnectorsAPI