{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:visier-permission-management/permission-management-get-capabilities":{"get":{"operationId":"open_data_visier_permission_management_permission_management_get_capabilities","summary":"Retrieve a list of all permission capabilities","description":"GET /v1/admin/capabilities","tags":["open-data"],"parameters":[{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve the capabilities from.","schema":{"type":"string","description":"Specify the tenant to retrieve the capabilities from."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-permission-management/permission-management-get-capability":{"get":{"operationId":"open_data_visier_permission_management_permission_management_get_capability","summary":"Retrieve a permission capability's details","description":"GET /v1/admin/capabilities/{capabilityId}","tags":["open-data"],"parameters":[{"name":"capabilityId","in":"query","required":true,"description":"The unique identifier of the capability you want to retrieve.","schema":{"type":"string","description":"The unique identifier of the capability you want to retrieve."}},{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve a capability from.","schema":{"type":"string","description":"Specify the tenant to retrieve a capability from."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-permission-management/permission-management-get-content-packages":{"get":{"operationId":"open_data_visier_permission_management_permission_management_get_content_packages","summary":"Retrieve a list of all content packages","description":"GET /v1/admin/content-packages","tags":["open-data"],"parameters":[{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve the content packages from.","schema":{"type":"string","description":"Specify the tenant to retrieve the content packages from."}},{"name":"searchString","in":"query","required":false,"description":"Optional search string to return only content packages whose display name or description contains that search string. If searchString is…","schema":{"type":"string","description":"Optional search string to return only content packages whose display name or description contains that search string. If searchString is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-permission-management/permission-management-get-content-package":{"get":{"operationId":"open_data_visier_permission_management_permission_management_get_content_package","summary":"Retrieve a content package's details","description":"GET /v1/admin/content-packages/{contentPackageId}","tags":["open-data"],"parameters":[{"name":"contentPackageId","in":"query","required":true,"description":"The unique identifier of the content package you want to retrieve.","schema":{"type":"string","description":"The unique identifier of the content package you want to retrieve."}},{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve a content package from.","schema":{"type":"string","description":"Specify the tenant to retrieve a content package from."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-permission-management/permission-management-get-data-security-objects":{"get":{"operationId":"open_data_visier_permission_management_permission_management_get_data_security_objects","summary":"Retrieve a list of data security objects","description":"GET /v1/admin/data-security-objects","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":false,"description":"The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.","schema":{"type":"array","description":"The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects."}},{"name":"includeDetails","in":"query","required":false,"description":"If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and…","schema":{"type":"boolean","description":"If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and…"}},{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve data security objects from.","schema":{"type":"string","description":"Specify the tenant to retrieve data security objects from."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-permission-management/permission-management-get-permissions":{"get":{"operationId":"open_data_visier_permission_management_permission_management_get_permissions","summary":"Retrieve a list of all permissions","description":"GET /v1/admin/permissions","tags":["open-data"],"parameters":[{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve the permissions from.","schema":{"type":"string","description":"Specify the tenant to retrieve the permissions from."}},{"name":"includeDetails","in":"query","required":false,"description":"If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is…","schema":{"type":"boolean","description":"If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is…"}},{"name":"includeDetailsWithStatus","in":"query","required":false,"description":"If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension…","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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:visier-permission-management/permission-management-create-permissions":{"post":{"operationId":"open_data_visier_permission_management_permission_management_create_permissions","summary":"Create permissions","description":"POST /v1/admin/permissions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"tenantCode":{"type":"string","description":"Specify the tenant to create permissions in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-permission-management/permission-management-update-permissions":{"post":{"operationId":"open_data_visier_permission_management_permission_management_update_permissions","summary":"Update permissions","description":"PUT /v1/admin/permissions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"tenantCode":{"type":"string","description":"Specify the tenant to update permissions in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-permission-management/permission-management-delete-permissions":{"post":{"operationId":"open_data_visier_permission_management_permission_management_delete_permissions","summary":"Delete permissions","description":"DELETE /v1/admin/permissions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"tenantCode":{"type":"string","description":"Specify the tenant to delete permissions from."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:visier-permission-management/permission-management-get-permission":{"get":{"operationId":"open_data_visier_permission_management_permission_management_get_permission","summary":"Retrieve a permission's details","description":"GET /v1/admin/permissions/{permissionId}","tags":["open-data"],"parameters":[{"name":"permissionId","in":"query","required":true,"description":"The unique identifier of the permission you want to retrieve.","schema":{"type":"string","description":"The unique identifier of the permission you want to retrieve."}},{"name":"tenantCode","in":"query","required":false,"description":"Specify the tenant to retrieve a permission from.","schema":{"type":"string","description":"Specify the tenant to retrieve a permission from."}},{"name":"includeDetailsWithStatus","in":"query","required":false,"description":"If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension…","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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}