-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
1008 lines (998 loc) · 34.5 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Visier Permission Management APIs
description: Visier APIs for managing permissions within an organization
version: 22222222.99201.1256
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
x-api-status-urls: false
servers:
- url: https://{vanity-name}.api.visier.io
variables:
vanity-name:
default: vanity
tags:
- name: PermissionManagement
paths:
/v1/admin/capabilities:
get:
tags:
- PermissionManagement
summary: Retrieve a list of all permission capabilities
operationId: PermissionManagement_GetCapabilities
description: >-
This API allows you to retrieve all the permission capabilities in your
tenant.
You can use the returned capabilities in other API calls when creating or updating permissions to assign the capability to the permission.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: Specify the tenant to retrieve the capabilities from.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetCapabilitiesAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/capabilities/{capabilityId}:
get:
tags:
- PermissionManagement
summary: Retrieve a permission capability's details
operationId: PermissionManagement_GetCapability
description: |-
This API allows you to retrieve the details of a specific capability.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: The unique identifier of the capability you want to retrieve.
name: capabilityId
in: path
required: true
schema:
type: string
- description: Specify the tenant to retrieve a capability from.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CapabilityDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/content-packages:
get:
tags:
- PermissionManagement
summary: Retrieve a list of all content packages
operationId: PermissionManagement_GetContentPackages
description: |-
This API allows you to retrieve the list of available content packages.
You can use the returned content packages in other API calls when creating or updating permissions to add the content package to the permission.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: Specify the tenant to retrieve the content packages from.
name: tenantCode
in: query
schema:
type: string
- description: >-
Optional search string to return only content packages whose display
name or description contains that search string.
If searchString is empty or not provided, the response returns a list of all content packages.
name: searchString
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetContentPackagesAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/content-packages/{contentPackageId}:
get:
tags:
- PermissionManagement
summary: Retrieve a content package's details
operationId: PermissionManagement_GetContentPackage
description: >-
This API allows you to retrieve the details of a specific content
package.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: The unique identifier of the content package you want to retrieve.
name: contentPackageId
in: path
required: true
schema:
type: string
- description: Specify the tenant to retrieve a content package from.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContentPackageDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/data-security-objects:
get:
tags:
- PermissionManagement
summary: Retrieve a list of data security objects
operationId: PermissionManagement_GetDataSecurityObjects
description: >-
This API allows you to retrieve the list of available data security
objects.
Data security objects are analytic objects and their related objects that are available to define
permissions’ data security profiles.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The unique identifiers of the data security objects (analytic
objects) to retrieve.
Default is all data security objects.
name: id
in: query
schema:
type: array
items:
type: string
- description: >-
If `true`, the response includes the analytic objects (display name,
ID, and object type), related objects,
securable properties, and securable dimensions. If `false`, the response only includes analytic objects
(display name, ID, and object type). Default is `false`.
name: includeDetails
in: query
schema:
type: boolean
- description: Specify the tenant to retrieve data security objects from.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetDataSecurityObjectsAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/permissions:
get:
tags:
- PermissionManagement
summary: Retrieve a list of all permissions
operationId: PermissionManagement_GetPermissions
description: >-
This API allows you to retrieve the full list of user permissions in
your tenant.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: Specify the tenant to retrieve the permissions from.
name: tenantCode
in: query
schema:
type: string
- description: >-
If `true`, returns the permission's details. If `false`, only
returns the permissions' ID, display name,
and description. Default is `false`.
name: includeDetails
in: query
schema:
type: boolean
- description: >-
If `true`, returns the validity statuses for the permission's
properties in data access sets and the
permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`,
doesn't return validity status information. Default is `false`.
name: includeDetailsWithStatus
in: query
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetPermissionsAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
put:
tags:
- PermissionManagement
summary: Update permissions
operationId: PermissionManagement_UpdatePermissions
description: |-
This API allows you to update existing permissions.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: Specify the tenant to update permissions in.
name: tenantCode
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsListDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionBulkOperationResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
post:
tags:
- PermissionManagement
summary: Create permissions
operationId: PermissionManagement_CreatePermissions
description: >-
This API allows you to create new permissions. Administrating tenant
users can specify the tenant in which to add these permissions.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: Specify the tenant to create permissions in.
name: tenantCode
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsListDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionBulkOperationResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
delete:
tags:
- PermissionManagement
summary: Delete permissions
operationId: PermissionManagement_DeletePermissions
description: |-
This API allows you to delete existing permissions.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: Specify the tenant to delete permissions from.
name: tenantCode
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePermissionsRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionBulkOperationResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/permissions/{permissionId}:
get:
tags:
- PermissionManagement
summary: Retrieve a permission's details
operationId: PermissionManagement_GetPermission
description: |-
This API allows you to retrieve the details for a specified permission.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: The unique identifier of the permission you want to retrieve.
name: permissionId
in: path
required: true
schema:
type: string
- description: Specify the tenant to retrieve a permission from.
name: tenantCode
in: query
schema:
type: string
- description: >-
If `true`, returns the validity statuses for the permission's
properties in data access sets and the
permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`,
doesn't return validity status information. Default is `false`.
name: includeDetailsWithStatus
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
AdminCapabilityConfigDTO:
type: object
properties:
allCapabilitiesAccess:
description: >-
If true, this capability configuration grant access to all
capabilities.
type: boolean
capabilities:
description: A list of capabilities associated with the capability configuration.
type: array
items:
type: string
AnalyticObjectDTO:
type: object
properties:
analyticObjectId:
description: The unique ID of the analytic object.
type: string
displayName:
description: An identifiable name to display in Visier, such as "Employee".
type: string
objectType:
description: The analytic object type.
enum:
- Event
- Subject
- BusinessOutcomeOverlay
- PlanOrBudgetOverlay
- ExternalBenchmark
- VisierBenchmark
- UsageOverlay
- OtherOverlay
- InternalComparison
- PlanAnalyticObject
type: string
format: enum
relatedObjects:
description: The analytic objects related to the data security object.
type: array
items:
$ref: '#/components/schemas/RelatedAnalyticObjectDTO'
securableProperties:
description: >-
All available properties from the data security object and its
related analytic objects that you can configure data access for.
type: array
items:
$ref: '#/components/schemas/SecurablePropertyDTO'
securableDimensions:
description: >-
A list of dimensions that are available to define population access
filters in the permission.
type: array
items:
$ref: '#/components/schemas/SecurableDimensionDTO'
CapabilityDTO:
type: object
properties:
description:
description: A description of the capability.
type: string
name:
description: The unique name of the capability.
type: string
displayName:
description: >-
An identifiable capability name to display in Visier, such as
"Schedule Analysis".
type: string
ContentPackageDTO:
type: object
properties:
description:
description: A description of the content package.
type: string
contentPackageId:
description: The unique ID of the content package.
type: string
displayName:
description: >-
An identifiable content package name to display in Visier, such as
"Talent Acquisition Core Content".
type: string
DataSecurityProfileDTO:
type: object
properties:
analyticObjectId:
description: The analytic object ID associated with the data security profile.
type: string
propertySetConfig:
$ref: '#/components/schemas/PropertySetConfigDTO'
allDataPointAccess:
description: >-
The flag for giving all access to data points when creating a
population.
type: boolean
memberFilterConfigs:
description: The member filter configurations that defines the population.
type: array
items:
$ref: '#/components/schemas/MemberFilterConfigDTO'
inheritedAccessConfigs:
description: >-
A list of objects representing the inherited access configurations
associated with the data security profile.
By default all related objects of a top level analytic object will inherit access.
To remove access to a related analytic object, add it to the list of inherited access configurations with removeAccess: true.
To add custom filters to a related analytic object, add the analytic object to the list of inherited access configurations and then add the custom filters to its list of member filter configurations.
type: array
items:
$ref: '#/components/schemas/InheritedAccessConfigDTO'
x-konfig-properties:
propertySetConfig:
description: >-
The property set configuration that defines which properties and
access level to allow for each filtered record.
DeletePermissionsRequestDTO:
type: object
properties:
permissionIds:
description: The identifiers of the permissions to delete.
type: array
items:
type: string
DimensionFilterDTO:
type: object
properties:
staticDimensionFilter:
$ref: '#/components/schemas/StaticDimensionFilterDTO'
dynamicDimensionFilter:
$ref: '#/components/schemas/DynamicDimensionFilterDTO'
DynamicDimensionFilterDTO:
type: object
properties:
dimensionId:
description: The dimension ID associated with the dynamic dimension filter.
type: string
subjectReferencePath:
description: The subject reference path.
type: array
items:
type: string
dynamicPropertyMappings:
description: >-
A list of objects representing the dynamic property mappings
associated with the dynamic dimension filter.
type: array
items:
$ref: '#/components/schemas/DynamicPropertyMappingDTO'
dimensionStatus:
description: >-
The dimension's validity status. Valid values: Valid, NoData,
NotFound.
* **Valid**: The object exists and has loaded data.
* **NoData**: The object exists but doesn't have loaded data.
* **NotFound**: The object doesn't exist.
enum:
- Unset
- Valid
- NoData
- NotFound
type: string
format: enum
DynamicPropertyMappingDTO:
type: object
properties:
hierarchyPropertyId:
description: The hierarchy property ID.
type: string
userProperty:
$ref: '#/components/schemas/UserPropertyDTO'
hierarchyPropertyStatus:
description: >-
The hierarchy property's validity status. Valid values: Valid,
NotFound.
* **Valid**: The object exists and has loaded data.
* **NotFound**: The object doesn't exist.
enum:
- Unset
- Valid
- NoData
- NotFound
type: string
format: enum
x-konfig-properties:
userProperty:
description: The user property.
GetCapabilitiesAPIResponseDTO:
type: object
properties:
capabilities:
description: A list of objects representing the available capabilities.
type: array
items:
$ref: '#/components/schemas/CapabilityDTO'
GetContentPackagesAPIResponseDTO:
type: object
properties:
contentPackages:
description: A list of objects representing the available content packages.
type: array
items:
$ref: '#/components/schemas/ContentPackageDTO'
GetDataSecurityObjectsAPIResponseDTO:
type: object
properties:
analyticObjects:
description: >-
A list of analytic objects and their related objects that are
available to define data access to.
type: array
items:
$ref: '#/components/schemas/AnalyticObjectDTO'
GetPermissionsAPIResponseDTO:
description: List of available permissions
type: object
properties:
permissions:
description: A list of objects representing the available permissions.
type: array
items:
$ref: '#/components/schemas/PermissionDTO'
GoogleProtobufAny:
description: >-
Contains an arbitrary serialized message along with a @type that
describes the type of the serialized message.
type: object
properties:
'@type':
description: The type of the serialized message.
type: string
additionalProperties: true
HierarchyPropertyDTO:
type: object
properties:
hierarchyPropertyId:
description: The hierarchy property ID.
type: string
displayName:
description: >-
An identifiable hierarchy property name to display in Visier, such
as "Name Property".
type: string
InheritedAccessConfigDTO:
type: object
properties:
analyticObjectId:
description: >-
The analytic object ID associated with the inherited access
configuration.
type: string
removeAccess:
description: The flag for removing access to the inherited analytic object.
type: boolean
memberFilterConfigs:
description: >-
The member filter configurations that defines the population in the
inherited analytic object.
type: array
items:
$ref: '#/components/schemas/MemberFilterConfigDTO'
MemberFilterConfigDTO:
type: object
properties:
dimensionFilters:
description: >-
A list of objects representing the dimension filters associated with
the member filter configuration.
A dimension filter can be either a static or dynamic dimension filter.
type: array
items:
$ref: '#/components/schemas/DimensionFilterDTO'
MemberSelectionDTO:
type: object
properties:
namePath:
description: The member name path.
type: array
items:
type: string
excluded:
description: The flag for excluding the member.
type: boolean
dimensionMemberStatus:
description: >-
The dimension member's validity status. Valid values: Valid,
NotFound.
* **Valid**: The object exists and has loaded data.
* **NotFound**: The object doesn't exist.
enum:
- Unset
- Valid
- NoData
- NotFound
type: string
format: enum
PermissionBulkOperationResponseDTO:
type: object
properties:
successes:
description: The successfully processed permissions.
type: array
items:
$ref: '#/components/schemas/PermissionSuccessDTO'
failures:
description: >-
The permissions that did not process and any relevant error
information.
type: array
items:
$ref: '#/components/schemas/PermissionFailureDTO'
PermissionDTO:
type: object
properties:
description:
description: A user-defined description of the permission.
type: string
permissionId:
description: The unique identifier associated with the permission.
type: string
displayName:
description: >-
An identifiable permission name to display in Visier, such as
"Diversity Access".
type: string
dataSecurityProfiles:
description: >-
A list of objects representing the data security profile
configurations associated with the permission.
type: array
items:
$ref: '#/components/schemas/DataSecurityProfileDTO'
adminCapabilityConfig:
$ref: '#/components/schemas/AdminCapabilityConfigDTO'
roleModulesConfig:
$ref: '#/components/schemas/RoleModulesConfigDTO'
x-konfig-properties:
adminCapabilityConfig:
description: The capability configuration associated with the permission.
roleModulesConfig:
description: The role modules configuration associated with the permission.
PermissionErrorDTO:
type: object
properties:
message:
description: Error message
type: string
rci:
description: >-
A root cause identifier that allows Visier to determine the source
of the problem.
type: string
PermissionFailureDTO:
type: object
properties:
permissionId:
description: The unique identifier associated with the permission.
type: string
displayName:
description: >-
An identifiable permission name to display in Visier, such as
"Diversity Access".
type: string
error:
$ref: '#/components/schemas/PermissionErrorDTO'
x-konfig-properties:
error:
description: The error associated with the failure.
PermissionSuccessDTO:
type: object
properties:
permissionId:
description: The unique identifier associated with the permission.
type: string
displayName:
description: >-
An identifiable permission name to display in Visier, such as
"Diversity Access".
type: string
PermissionsListDTO:
type: object
properties:
permissions:
description: The list of permissions that will be created or updated
type: array
items:
$ref: '#/components/schemas/PermissionDTO'
PropertyAccessConfigDTO:
type: object
properties:
propertyId:
description: The property ID associated with the property access configuration.
type: string
analyticObjectId:
description: The analytic object ID of the property.
type: string
analyticObjectReferencePaths:
description: >-
The path to the analytic object reference or empty if the
configuration is not a reference.
type: array
items:
type: string
accessLevel:
description: >-
The access level of the property. Valid values are: Aggregate,
Sensitive
enum:
- None
- Aggregate
- Detailed
type: string
format: enum
propertyStatus:
description: >-
The property's validity status. Valid values: Valid, NoData,
NotFound.
* **Valid**: The object exists and has loaded data.
* **NoData**: The object exists but doesn't have loaded data.
* **NotFound**: The object doesn't exist.
enum:
- Unset
- Valid
- NoData
- NotFound
type: string
format: enum
PropertySetConfigDTO:
type: object
properties:
propertyAccessConfigs:
description: >-
A list of objects representing the property access configuration
associated with the property set configuration.
type: array
items:
$ref: '#/components/schemas/PropertyAccessConfigDTO'
RelatedAnalyticObjectDTO:
type: object
properties:
analyticObjectId:
description: The analytic object ID.
type: string
displayName:
description: >-
An identifiable analytic object name to display in Visier, such as
"Recognition".
type: string
RoleModulesConfigDTO:
type: object
properties:
contentPackageIds:
description: >-
A list of content packages IDs associated with the role modules
configuration.
type: array
items:
type: string
SecurableDimensionDTO:
type: object
properties:
dimensionId:
description: The dimension ID.
type: string
displayName:
description: >-
An identifiable dimension name to display in Visier, such as
"Contract Type".
type: string
analyticObjectIds:
description: A list of analytic object IDs.
type: array
items:
type: string
hierarchyProperties:
description: >-
The list of hierarchies you can map to a user in a permission's
dynamic filter.
type: array
items:
$ref: '#/components/schemas/HierarchyPropertyDTO'
SecurablePropertyDTO:
type: object
properties:
propertyId:
description: The property ID.
type: string
displayName:
description: >-
An identifiable property name to display in Visier, such as "Job Pay
Level".
type: string
analyticObjectId:
description: The property's analytic object ID.
type: string
isPrimaryKey:
description: If true, this property is the analytic object's primary key.
type: boolean
referenceSymbolName:
description: The reference symbol name.
type: string
StaticDimensionFilterDTO:
type: object
properties:
dimensionId:
description: The dimension ID associated with the static dimension filter.
type: string
subjectReferencePath:
description: The subject reference path.
type: array
items:
type: string
memberSelections:
description: >-
A list of objects representing the member selections associated with
the static dimension filter.
type: array
items:
$ref: '#/components/schemas/MemberSelectionDTO'
dimensionStatus:
description: >-
The dimension's validity status. Valid values: Valid, NoData,
NotFound.
* **Valid**: The object exists and has loaded data.
* **NoData**: The object exists but doesn't have loaded data.
* **NotFound**: The object doesn't exist.
enum:
- Unset
- Valid
- NoData
- NotFound
type: string
format: enum
Status:
description: >-
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It
is used by [gRPC](https://github.com/grpc). Each `Status` message
contains three pieces of data: error code, error message, and error
details. You can find out more about this error model and how to work
with it in the [API Design
Guide](https://cloud.google.com/apis/design/errors).
type: object
properties:
code:
description: >-
The status code, which should be an enum value of
[google.rpc.Code][google.rpc.Code].
type: integer
format: int32
message:
description: >-
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
[google.rpc.Status.details][google.rpc.Status.details] field, or
localized by the client.
type: string
details:
description: >-
A list of messages that carry the error details. There is a common
set of message types for APIs to use.
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
UserPropertyDTO:
type: object
properties:
name:
description: The user property name.
type: string
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