Modify Object

patch https://customer.my.onetrust.com/api/custom-entity/v1/entities/{entityId}

Use this API to partially update an existing object record.

🗒
Things to Know

This API only supports objects created via Object Manager, including Projects, Models, and Datasets.

Responses

Response body

object

attributes

object

Custom Attributes

auditFields

object

createdBy

object

createdDate

date-time

required

Entity record created date and time.

lastModifiedBy

object

lastUpdatedDate

date-time

Last updated date.

entityType

object

required

uuid

required

Unique Identifier of an Entity Type.

moduleName

string

Module Name.

name

string

required

Name of an Entity Type.

schemaName

string

Attribute Schema name.

seeded

boolean

The flag to check if the entity tyoe is seeded or not.

uuid

required

Unique Identifier (GUID) of an Entity.

name

string

Name of an Entity.

number

int64

required

Auto generated positive real number.

orgGroupId

uuid

Organization Identifier.

schemaId

uuid

required

Attribute Schema Identifier.

workflowAndStage

object

uuid

required

Workflow Identifier.

name

string

required

Workflow Name. Unique by Workflow Type and Name.

stageId

uuid

required

Workflow Stage Identifier.

stageName

string

required

Workflow Stage Name.

type

string

required

Workflow type. Many workflow can be categorize by type.

workflowMode

string

Workflow Mode.

ADVANCED BASIC

401

Unauthorized

403

Forbidden

Language


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://customer.my.onetrust.com/api/custom-entity/v1/entities/entityId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
48
}
1
{
2
  "attributes": {
3
    "optionBasedAttributeName": [
4
      {
5
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
6
      }
7
    ],
8
    "textAttributeName": [
9
      {
10
        "value": "Text"
11
      }
12
    ]
13
  },
14
  "auditFields": {
15
    "createdBy": {
16
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
17
      "initials": "FL",
18
      "name": "First Last"
19
    },
20
    "createdDate": "2021-05-13 13:06:49.853803",
21
    "lastModifiedBy": {
22
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
23
      "initials": "FL",
24
      "name": "First Last"
25
    },

OneTrust Internal Users: DO NOT MAKE ANY DIRECT CHANGES!

Modify Object

🗒
Things to Know

OneTrust Internal Users: DO NOT MAKE ANY DIRECT CHANGES!

200OK

429Too Many Requests For more information, see API Rate Limits.