ONonetrust
Model Management

Create Model Object

Use this API to create a new Model object record.

🗒 Things to Know

  • This API only supports creating Model objects via Object Manager.
post/api/custom-entity/v2/models

Request

  • Base URL
    https://hostname/api/custom-entity
  • URL
    https://hostname/api/custom-entity/api/custom-entity/v2/models
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: object-manager, object-manager-write, integration

Request body

namestring required

The name of the object.

descriptionstring

The description of the object.

modelVersionstring

The version of the model.

limitationsstring

The limitations of the model.

biasesstring

The known biases of the model.

demographicParityDifferencestring decimal

The demographic parity difference measurement.

demographicParityRatiostring decimal

The demographic parity ratio measurement.

equalizedOddsDifferencestring decimal

The equalized odds difference measurement.

equalizedOddsRatiostring decimal

The equalized odds ratio measurement.

referenceLinkstring uri

The reference link or other URL.

hubReferenceIdstring

The hub reference identifier to cross-reference model repositories.

modelSource'Internal Development' | 'Vendor' | 'Open Source' | 'Third Party'

The source of the model.

additionalAttributesobject

This parameter can be used to store attribute details in key value pairs.

Example request

{
  "name": "Customer Sentiment Analysis Model",
  "description": "Model for analyzing customer feedback sentiment",
  "modelVersion": "1.0.0",
  "limitations": "Limited accuracy for non-English languages",
  "biases": "May have cultural bias based on training data",
  "modelSource": "Internal Development",
  "referenceLink": "https://docs.example.com/models/sentiment-analysis"
}

Response

Model entity created successfully

idstring uuid required

The unique identifier of the object.

numberinteger required

The sequential order in which the object was created.

namestring required

The name of the object.

orgGroupIdstring uuid

The unique identifier of the organization responsible for the object.

schemaIdstring uuid required

The unique identifier of the schema.

attributesobject

The details of the associated attributes.

Example response

{
  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "name": "OneTrust",
  "entityType": {
    "id": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
    "name": "Vendor"
  }
}

Changes

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