openapi: 3.2.0
info:
title: Visier Analytic Model Analytic Objects V2 API
description: Visier APIs for retrieving and configuring your analytic model in Visier.
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: AnalyticObjectsV2
x-displayName: Analytic Objects V2
description: 'Create, retrieve, update, and delete analytic objects in your analytic model. You can create, update, and delete one or more analytic objects in an API call.
The supported analytic objects are <em>subjects</em> (entities that evolve over time) and <em>events</em> (things that happen to subjects at specific points in time).
<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:
/v2alpha/data/model/analytic-objects:
get:
tags:
- AnalyticObjectsV2
summary: Retrieve a list of analytic objects
description: "Retrieve a list of all analytic objects in your Visier tenant.\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: AnalyticObjectsV2_GetAllAnalyticObjects
parameters:
- name: type
in: query
description: "The type of the analytic object to retrieve. If undefined, retrieves all analytic object types. Valid values:\n - `subject`: Retrieves subject analytic objects.\n - `event`: Retrieves event analytic objects."
schema:
type: array
items:
enum:
- subject
- event
type: string
format: enum
- name: with
in: query
description: "The level of information to retrieve for the analytic object. Valid values:\n - `basic`: Retrieves the analytic object's UUID, object name, and basic information. This is the default.\n - `details`: Retrieves the `basic` details and additional configurations, such as properties, dimensions, and references.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
schema:
type: array
items:
enum:
- basic
- details
- version
type: string
format: enum
- name: objectName
in: query
description: The analytic object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
schema:
type: array
items:
type: string
- name: uuid
in: query
description: The analytic object UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
schema:
type: array
items:
type: string
- 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.
schema:
type: string
format: uuid
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.v2.objectconfiguration.AnalyticObjectResponseDTO'
put:
tags:
- AnalyticObjectsV2
summary: Update analytic objects
description: "Replace existing analytic objects. The response returns whether each analytic object was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition.\n\n In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the analytic object. To partially update an analytic object, see the `PATCH` method.\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: AnalyticObjectsV2_PutAnalyticObjects
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.
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRequestDTO'
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.BulkChangeResponseDTO'
post:
tags:
- AnalyticObjectsV2
summary: Create analytic objects
description: "Create new analytic objects. The response returns whether each analytic object was successfully created or not.\n When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects.\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: AnalyticObjectsV2_CreateAnalyticObjects
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.
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRequestDTO'
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.BulkChangeResponseDTO'
delete:
tags:
- AnalyticObjectsV2
summary: Delete analytic objects
description: "Delete existing analytic objects. The response returns whether each analytic object was successfully deleted or not.\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: AnalyticObjectsV2_DeleteAnalyticObjects
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.
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectDeleteRequestDTO'
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.BulkChangeResponseDTO'
patch:
tags:
- AnalyticObjectsV2
summary: Partially update analytic objects
description: "Make partial changes to existing analytic objects. The response returns whether each analytic object was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition.\n\n Unlike `PUT`, which completely replaces the analytic object definition, use `PATCH` to change specific fields in the analytic object without affecting omitted fields. To replace an analytic object's entire definition, see the `PUT` method.\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: AnalyticObjectsV2_PatchAnalyticObjects
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.
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRequestDTO'
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.BulkChangeResponseDTO'
/v2alpha/data/model/analytic-objects/revert-to-parent:
post:
tags:
- AnalyticObjectsV2
summary: Revert analytic objects to Blueprint
description: "Revert analytic objects to their Blueprint state. The response returns whether each analytic object was successfully reverted or not.\n You can revert tenant override objects to Blueprint. If you execute the revert operation on a:\n - Blueprint object: Nothing happens. The object is inherited from the parent and there is nothing to revert on this tenant.\n - Tenant override object: The object reverts to the Blueprint version or, for administrating tenants who revert an analytic tenant's object, the administrating tenant's object version.\n - Tenant object: The API request fails. The object is unique to your tenant and no Blueprint version exists.\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: AnalyticObjectsV2_RevertAnalyticObjects
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.
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRevertRequestDTO'
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.BulkChangeResponseDTO'
/v2alpha/data/model/analytic-objects/{objectNameOrUuid}:
get:
tags:
- AnalyticObjectsV2
summary: Retrieve an analytic object's details
description: "Retrieve the details of a specific analytic object, such as its properties, dimensions, and references.\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: AnalyticObjectsV2_GetOneAnalyticObject
parameters:
- name: objectNameOrUuid
in: path
description: The object name or UUID of the analytic object to retrieve.
required: true
schema:
type: string
- name: with
in: query
description: "The level of information to retrieve for the analytic object. Valid values:\n - `basic`: Retrieves the analytic object's UUID, object name, and basic information.\n - `details`: Retrieves the `basic` details and additional configurations, such as properties, dimensions, and references. This is the default.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
schema:
type: array
items:
enum:
- basic
- details
- version
type: string
format: enum
- 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.
schema:
type: string
format: uuid
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.v2.objectconfiguration.AnalyticObjectWithContextDTO'
components:
schemas:
servicing.v2.objectconfiguration.LocalOrSharedDimensionListDTO:
type: object
properties:
dimensions:
type: array
items:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.LocalOrSharedDimensionDTO'
description: A list of local (not shared) or shared dimensions.
description: A list of dimensions associated with an analytic object. Dimensions can be local (not shared) or shared.
servicing.v2.objectconfiguration.PropertyDefinitionListDTO:
type: object
properties:
properties:
type: array
items:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyDefinitionDTO'
description: The list of properties.
description: The list of properties.
servicing.v2.objectconfiguration.PropertyDefinitionDTO:
type: object
properties:
uuid:
type: string
description: The UUID identifying the property.
objectName:
type: string
description: The object name of the property.
basicInformation:
allOf:
- $ref: '#/components/schemas/servicing.BasicInformationDTO'
description: Fields that identify and describe the property, such as its display name, description, and explanation.
details:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyTypeDetailsDTO'
description: The property type and its details.
tagList:
allOf:
- $ref: '#/components/schemas/servicing.TagReferenceListDTO'
description: A list of tags assigned to the object.
includeWithVee:
type: boolean
description: If `true`, the object is available in Vee's responses.
versionInformation:
allOf:
- $ref: '#/components/schemas/servicing.VersionInformationDTO'
description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
servicing.SynonymListDTO:
type: object
properties:
synonyms:
type: array
items:
type: string
description: Alternative words or phrases for the object.
description: The object's synonyms.
servicing.v2.objectconfiguration.AnalyticObjectDetailsDTO:
type: object
properties:
subject:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.SubjectDetailsDTO'
description: Information about the subject, such as its caption, default metric, and attributes.
event:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.EventDetailsDTO'
description: Information about the event, such as its subject, default metric, and attributes.
description: Information about the analytic objects.
servicing.SuccessfulChangeDTO:
type: object
properties:
executionContext:
allOf:
- $ref: '#/components/schemas/servicing.ExecutionContextDTO'
description: The tenant and, optionally, project that change was made on.
objectName:
type: string
description: The object name of the object that was changed.
uuid:
type: string
description: The UUID of the object that was changed.
displayName:
type: string
description: The display name of the object that was changed.
servicing.v2.objectconfiguration.PropertyDependencyDTO:
type: object
properties:
analyticObjectName:
type: string
description: The analytic object associated with the dimension. Must be the analytic object's object name; for example, Employee_Experience.
propertyObjectName:
type: string
description: The display name of the property associated with the dimension. Must be the property's qualified name; for example, Candidate.Location.
description: Each analytic object and property associated with the dimension.
servicing.v2.objectconfiguration.SubjectDetailsDTO:
type: object
properties:
conceptionEvent:
type: string
description: The conception event defines the start of the validity interval for a subject.
terminationEvent:
type: string
description: The termination event defines the end of the validity interval for a subject.
instanceCaption:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionDTO'
description: The property that labels members. The instance caption displays the property in Detailed View and makes the subject available in the Compare room.
secondaryCaptionList:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionListDTO'
description: Additional properties for more identification of subject members or event occurrences.
enablePrimaryKeyDimension:
type: boolean
description: If `true`, the subject's primary key or caption can be used as a group by and filter.
enableLargeDimensionSearch:
type: boolean
description: If `true`, you can search for members in a dimension with more than 300,000 members. Default is `false` to help with performance.
defaultMetric:
type: string
description: The default metric associated with an analytic object for system alerts and preventing empty chart states.
dataCategory:
type: string
description: The data category for this analytic object. Options include Tenant (default) and Usage (processes Visier usage information).
includeWithVee:
type: boolean
description: If `true`, the object is available in Vee's responses.
propertyList:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyDefinitionListDTO'
description: The subject's properties, such as employee ID, name, and location.
dimensionList:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.LocalOrSharedDimensionListDTO'
description: The subject's dimensions, such as department, job title, and location.
subjectReferenceList:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.SubjectReferenceListDTO'
description: The analytic object's references.
description: Information about the subject, such as its caption, default metric, and attributes.
servicing.v2.objectconfiguration.AnalyticObjectRevertRequestDTO:
type: object
properties:
analyticObjects:
type: array
items:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRevertWithContextDTO'
description: The analytic objects to revert.
description: The request to revert analytic objects.
servicing.v2.objectconfiguration.AnalyticObjectDeleteWithContextDTO:
type: object
properties:
executionContext:
allOf:
- $ref: '#/components/schemas/servicing.ExecutionContextDTO'
description: The context of the API request, such as the tenant code and project ID.
analyticObject:
allOf:
- $ref: '#/components/schemas/servicing.ObjectIdDTO'
description: Information identifying the analytic object to delete.
description: Information about the analytic object to delete and the context of the API request.
servicing.v2.objectconfiguration.PropertyDependencyListDTO:
type: object
properties:
propertyDependencies:
type: array
items:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyDependencyDTO'
description: Each analytic object and property associated with the dimension.
description: The dimension's associated analytic objects and properties.
servicing.v2.objectconfiguration.SimplePropertyTypeDTO:
type: object
properties:
dataType:
type: string
description: "The property's data type. Valid values:\n\n `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`,\n `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`,\n `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`."
primitiveType:
type: string
description: The primitive data type, such as String, Integer, or Boolean.
description: A simple property that provides single-level detail to an analytic object and contains one value at a time.
servicing.v2.objectconfiguration.AnalyticObjectResponseDTO:
type: object
properties:
analyticObjects:
type: array
items:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO'
description: The returned analytic objects.
description: The analytic objects in the response.
servicing.v2.objectconfiguration.CaptionListDTO:
type: object
properties:
captions:
type: array
items:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionDTO'
description: The list of captions for the subject or event.
description: A collection of captions used to identify subject members or event occurrences. Each caption specifies the analytic object and the property used for identification.
servicing.ExecutionContextDTO:
type: object
properties:
tenantCode:
type: string
description: The tenant code.
projectId:
type: string
description: The project ID.
description: The context of the API request, such as the tenant code and project ID.
servicing.v2.objectconfiguration.AnalyticObjectRequestDTO:
type: object
properties:
analyticObjects:
type: array
items:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO'
description: The analytic objects in the request.
description: The analytic objects to create or update.
servicing.v2.objectconfiguration.AnalyticObjectDefinitionDTO:
type: object
properties:
uuid:
type: string
description: The UUID identifying the analytic object.
objectName:
type: string
description: The object name of the analytic object.
basicInformation:
allOf:
- $ref: '#/components/schemas/servicing.BasicInformationDTO'
description: Fields that identify and describe the analytic object, such as its display name, description, and explanation.
details:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectDetailsDTO'
description: The analytic object type and its details.
tagList:
allOf:
- $ref: '#/components/schemas/servicing.TagReferenceListDTO'
description: A list of tags assigned to the object.
versionInformation:
allOf:
- $ref: '#/components/schemas/servicing.VersionInformationDTO'
description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
description: Information about the analytic object.
servicing.TagReferenceListDTO:
type: object
properties:
tags:
type: array
items:
$ref: '#/components/schemas/servicing.TagReferenceDTO'
description: A list of tags assigned to the object.
description: The tags assigned to the object.
servicing.ObjectIdDTO:
type: object
properties:
uuid:
type: string
description: The UUID identifying the object.
objectName:
type: string
description: The object name of the object.
description: The identifier for the object.
servicing.v2.objectconfiguration.LevelListDTO:
type: object
properties:
levels:
type: array
items:
$ref: '#/components/schemas/servicing.v2.objectconfiguration.LevelDTO'
description: The list of dimension levels.
description: The levels in a leveled dimension or parent-child dimension.
servicing.v2.objectconfiguration.EventDetailsDTO:
type: object
properties:
occurrenceCaption:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionDTO'
description: The property that labels occurrences. The occurrence caption displays the property in Detailed View and makes the event available in the Compare room.
secondaryCaptionList:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionListDTO'
description: Secondary captions for additional identification of event occurrences.
subject:
type: string
description: The subject that the event is associated with. Subjects are entities that evolve over time with attributes captured over time.
enableEndingEvent:
type: boolean
description: If `true`, this event causes the record to become nonactive.
defaultMetric:
type: string
description: The default metric associated with an analytic object for system alerts and preventing empty chart states.
dataCategory:
type: string
description: The data category for this analytic object. Options include Tenant (default) and Usage (processes Visier usage information).
enableEndData:
type: boolean
description: If `true`, the event's end date corresponds with the event table's metadata. If `false`, the event's end date is inherited from its associated subject.
includeWithVee:
type: boolean
description: If `true`, the object is available in Vee's responses.
propertyList:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyDefinitionListDTO'
description: The event's properties, such as event ID, name, and date.
dimensionList:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.LocalOrSharedDimensionListDTO'
description: The event's dimensions, such as event type, location, and time.
subjectReferenceList:
allOf:
- $ref: '#/components/schemas/servicing.v2.objectconfiguration.SubjectReferenceListDTO'
description: The analytic object's references.
description: Information about the event, such as its subject, default metric, and attributes.
servicing.FailedChangeDTO:
type: object
properties:
executionContext:
allOf:
- $ref: '#/components/schemas/servicing.ExecutionContextDTO'
description: The tenant and, optionally, project that change was attempted on.
objectName:
type: string
description: The object name of the object that was attempted to be changed.
uuid:
type: string
description: The UUID of the object that was attempted to be changed.
displayName:
type: string
description: The display name of the object that was attempted to be changed.
messages:
type: array
items:
type: string
description: The error messages.
servicing.v2.object
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visier/refs/heads/main/openapi/visier-analyticobjectsv2-api-openapi.yml