ONonetrust
Attribute Management

Get List of Schemas

Use this API to retrieve all AI Governance schema definitions.

🗒 Things to Know

  • This API only supports AI Governance Entities (Models, Datasets, AI Systems and AI Agents).
get/api/ai-governance/v1/aig-schemas

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/ai-governance/v1/aig-schemas
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: AI_GOVERNANCE, AI_GOVERNANCE_READ, AI_GOVERNANCE_WRITE

Response

OK

idstring uuid

Schema GUID

namestring required

Schema name

nameKeystring

Schema name key

descriptionstring

Schema description

descriptionKeystring

Schema description key

seededboolean required

Seeded schema indicator

enabledboolean required

Enabled

Example response

[
  {
    "attributes": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Type of the Record",
        "nameKey": "IM.Name",
        "description": "Gather Type for the record - provide some value related to nature of record",
        "descriptionKey": "IM.Name.Description",
        "fieldName": "nameOfRecord",
        "mappedFieldName": "name",
        "enabled": true,
        "responseType": "Text",
        "formula": "Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)",
        "optionType": "None",
        "schemaId": "550e8400-e29b-41d4-a716-446655440000",
        "schemaName": "vendors",
        "options": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "option": "TypeA",
            "optionKey": "IM.TypeA",
            "colorCode": "#FF5733",
            "sequence": 1,
            "enabled": true
          }
        ],
        "referenceCategories": [
          {
            "name": "Financial Category",
            "nameKey": "IM.FinancialCategoryName"
          }
        ],
        "responseMaxLength": 4000,
        "responseSubType": "STANDARD",
        "associatedAttributeInformation": [
          {
            "name": "Count of members",
            "nameKey": "IM.CountOfMembersName",
            "description": "Provide details about count associated with this attribute",
            "descriptionKey": "IM.CountOfMembersDesc",
            "schemaName": "risk",
            "fieldName": "countOfMembers",
            "mappedFieldName": "count",
            "formula": "sum(1, 3)",
            "options": [
              {
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "option": "TypeA",
                "optionKey": "IM.TypeA",
                "colorCode": "#FF5733",
                "sequence": 1,
                "enabled": true
              }
            ]
          }
        ],
        "multiSelectMaxOptionValues": 10,
        "optionUrl": "/api/risk-v2/risk-categories",
        "deleteMarker": "MARKED_FOR_DELETE",
        "optionMetadata": {
          "entityTypeName": "Location",
          "basicServiceContextPath": "/api/location",
          "optionUrl": "/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details/pages",
          "optionListUrl": "/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details",
          "optionType": "BusinessLocations",
          "applicationUrl": "/settings/location-management/location/Location"
        },
        "validationRuleId": "email",
        "abacBasicAssignmentInfo": [
          {
            "assignmentId": "550e8400-e29b-41d4-a716-446655440000",
            "assignmentName": "Assignment1",
            "policyStatus": "ACTIVE"
          }
        ],
        "displayResponseType": "SingleSelect"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.