Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Object Management

Create Object

Use this API to create a new object record.

🗒 Things to Know

  • This API only supports creating Projects, Models, and Datasets objects via Object Manager.
post/v1/entities

Query parameters

entityTypeIdentifierstring uuid

Identifier of the object type

The unique identifier of the object type.

entityTypeNamestring

Name of the object type

The name of the object type.

Request body

namestring required

The name of the entity. Required field used as the primary identifier for users.

attributesobject

The custom attributes for the entity defined by its schema. Contains attribute paths mapped to their values.

Example request

{
  "name": "OneTrust",
  "organization": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
  },
  "attributes": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ]
  }
}

Response

Created - The object was successfully created

idstring uuid required

The unique identifier of the entity.

numberinteger required

The numerical order in which the entity was created.

namestring

The name of the entity.

orgGroupIdstring uuid

The unique identifier of the organization.

schemaIdstring uuid required

The unique identifier of the schema.

attributesobject

Example response

{
  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "number": 1,
  "name": "OneTrust",
  "orgGroupId": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
  "entityType": {
    "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46",
    "name": "Asset"
  },
  "workflowAndStage": {
    "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
    "name": "Vendor On-Boarding Workflow",
    "type": "Vendor",
    "workflowMode": "BASIC",
    "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
    "stageName": "Start On-Boarding"
  },
  "attributes": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ],
    "optionBasedAttributeName": [
      {
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
      }
    ]
  },
  "auditFields": {
    "createdBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    },
    "lastModifiedBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    }
  }
}