Skip to content
AveraAveraAvera Documentation

Overview

Configuration 1.0.0

Section titled “Configuration 1.0.0”

The configuration surface of the Avera REST API: Meta-model · Layouts · Widgets · Change requests · Configuration changes · Configuration versions · Configuration validation · Packages · Permissions · Roles · Access explorer.

Information

  • License: Proprietary
  • OpenAPI version: 3.1.0

Meta-model

Section titled “Meta-model”
GET
/api/v1/projects/{projectId}/schema/item-types/{itemTypeId}/attributes
GET
/api/v1/projects/{projectId}/schema/attributes/usage
GET
/api/v1/projects/{projectId}/schema/item-types/{itemTypeId}
GET
/api/v1/projects/{projectId}/schema/attributes
GET
/api/v1/projects/{projectId}/schema/item-type-categories
GET
/api/v1/projects/{projectId}/schema/item-types
GET
/api/v1/projects/{projectId}/schema/relationship-types

Layouts

Section titled “Layouts”
GET
/api/v1/projects/{projectId}/layouts/hubs
GET
/api/v1/projects/{projectId}/layouts
GET
/api/v1/projects/{projectId}/layouts/{subjectKind}/{subjectSlug}

Widgets

Section titled “Widgets”
POST
/api/v1/projects/{projectId}/widgets/{widgetId}/resolve

Change requests

Section titled “Change requests”
DELETE
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}
GET
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/changes/{changeId}/affected-items
POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/analyze
DELETE
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-types/{itemTypeId}
POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-type-attributes
POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/attributes
POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/form-layouts
POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-types
POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-type-categories
POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/relationship-types
POST
/api/v1/projects/{projectId}/schema/sandboxes
DELETE
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/attributes/{attributeId}
DELETE
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/form-layouts/{layoutId}
DELETE
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-type-categories/{categoryId}
DELETE
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/relationship-types/{relationshipTypeId}
GET
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}
GET
/api/v1/projects/{projectId}/schema/sandboxes/active
GET
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/changes
GET
/api/v1/projects/{projectId}/schema/sandboxes/mine
GET
/api/v1/projects/{projectId}/schema/sandboxes
POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/merge
PUT
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-type-attributes/{itemTypeId}/{attributeId}
DELETE
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/changes/{changeId}
DELETE
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-type-attributes/{itemTypeId}/{attributeId}
PUT
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/attributes/{attributeId}
PUT
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/form-layouts/{layoutId}
PUT
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-types/{itemTypeId}
PUT
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-type-categories/{categoryId}
PUT
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/relationship-types/{relationshipTypeId}
PUT
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}

Configuration changes

Section titled “Configuration changes”
POST
/api/v1/projects/{projectId}/config-actions/batches/{batchId}/accept
POST
/api/v1/projects/{projectId}/config-actions/{actionId}/dismiss
GET
/api/v1/projects/{projectId}/config-actions/batches/{batchId}
GET
/api/v1/projects/{projectId}/config-actions
GET
/api/v1/projects/{projectId}/config-actions/batches/{batchId}/preview

Configuration versions

Section titled “Configuration versions”
GET
/api/v1/projects/{projectId}/schema/versions/{versionId}
GET
/api/v1/projects/{projectId}/schema/versions
POST
/api/v1/projects/{projectId}/schema/versions/{versionId}/verify

Configuration validation

Section titled “Configuration validation”
POST
/api/v1/projects/{projectId}/schema/versions/{versionId}/findings/acknowledge
GET
/api/v1/projects/{projectId}/schema/findings/acknowledgments
GET
/api/v1/projects/{projectId}/schema/attribute-values
GET
/api/v1/projects/{projectId}/schema/drift
GET
/api/v1/projects/{projectId}/schema/versions/{versionId}/validation
POST
/api/v1/projects/{projectId}/schema/versions/{versionId}/validation
POST
/api/v1/projects/{projectId}/schema/validation/{statementId}/retire
GET
/api/v1/projects/{projectId}/schema/versions/{versionId}/traceability
POST
/api/v1/projects/{projectId}/schema/validation/{statementId}/validate
GET
/api/v1/projects/{projectId}/schema/validation-report
GET
/api/v1/projects/{projectId}/schema/validation-state
POST
/api/v1/projects/{projectId}/schema/findings/acknowledgments/{acknowledgmentId}/withdraw

Packages

Section titled “Packages”
GET
/api/v1/projects/{projectId}/export
POST
/api/v1/projects/import
POST
/api/v1/projects/{projectId}/config/import

Permissions

Section titled “Permissions”
POST
/api/v1/projects/{projectIdOrKey}/permission-rules/batch
POST
/api/v1/projects/{projectIdOrKey}/permission-rules
DELETE
/api/v1/projects/{projectIdOrKey}/permission-rules/{ruleId}
GET
/api/v1/projects/{projectIdOrKey}/permission-rules
PUT
/api/v1/projects/{projectIdOrKey}/permission-rules/{ruleId}
GET
/api/v1/projects/{projectIdOrKey}/permission-rules/verbs

Roles

Section titled “Roles”
POST
/api/v1/projects/{projectId}/roles
DELETE
/api/v1/projects/{projectId}/roles/{roleId}
GET
/api/v1/projects/{projectId}/roles
PATCH
/api/v1/projects/{projectId}/roles/{roleId}

Access explorer

Section titled “Access explorer”
GET
/api/v1/items/{itemId}/access
GET
/api/v1/users/me/access
GET
/api/v1/projects/{projectIdOrKey}/access/policy-matrix
GET
/api/v1/projects/{projectIdOrKey}/access/effective
GET
/api/v1/tenants/{tenantId}/access/effective

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

Every request carries a bearer token: the session token issued at sign-in, or an OAuth 2.1 access token from a connector grant. HTTP basic is disabled (see SecurityConfig), and the requirement is declared once here rather than on each operation, since it is the same for the whole API.

Security scheme type: http

Bearer format: JWT