User Defined Objects (UDO)
This API retrieves list of all user defined objects created in the system.
Get User Defined Object
A system-generated compliance ID on creating or updating the policy
Name of the policy.
ID of the user who created the policy. Example: username@rightrev.com
Timestamp of the policy created by the user. This is a unix Epoch timestamp format.
ID of the user last modified by.
Timestamp of the policy last modified on. This is a unix Epoch timestamp format.
GET /apis/userdefinedobjects/v1/ HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get User Defined Object
[
{
"compliance_id": "c447c519-aecf-4d4a-9ab4-4ba85a0c60d1",
"compliance_name": "user-defined-objects",
"compliance_spec": [
{
"created_at": 1760014737,
"created_by": "raviteja.d@rightrev.com",
"guid": "d74c9ab7-66f9-4b4b-8b4f-30ead1e0bbed",
"object_description": "",
"object_freeze": true,
"object_name": "TEST_RRAPI_QA_CUSTOM10",
"total_fields": 1,
"updated_at": 1760014827,
"updated_by": "raviteja.d@rightrev.com"
}
],
"created_by": "RIGHTREV",
"created_on": 1772517485,
"last_modified_by": "RIGHTREV",
"last_modified_on": 1772517485
}
]This API used to create new user defined objects in the system.
Name of the obejct to be created. It should start with Tenant ID.
Description of the object.
Create User Defined Object
POST /apis/userdefinedobjects/v1/ HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"object_name": "TEST_RRAPI_QA_CUSTOM_06",
"description": "New object"
}Create User Defined Object
{}This API is used to retrieve all the field level details created in the object.
Provide name of the object.
A boolean field indicating object is freezed or not.
Get User Defined Object
A system-generated compliance ID on creating or updating the policy.
Name of the policy.
ID of the user who created the policy. Example: username@rightrev.com
Timestamp of the policy created by the user. This is a unix Epoch timestamp format.
ID of the user last modified by.
Timestamp of the policy last modified on. This is a unix Epoch timestamp format.
GET /apis/userdefinedobjects/v1/{object_name}?freeze=true HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get User Defined Object
[
{
"compliance_id": "ae3afc6c-4543-4371-9a6d-11e5ceeb7146",
"compliance_name": "user-defined-objects",
"compliance_spec": [
{
"created_at": 1748079523,
"created_by": "raviteja.d@rightrev.com",
"guid": "e78cb614-d6d4-4ef2-9a59-a8a98df79ed1",
"object_description": "",
"object_freeze": true,
"object_name": "TEST_RRAPI_QA_CUSTOM_05",
"object_structure": [
{
"data_type": "String / Character",
"description": "",
"field_name": "FIELD_01"
},
{
"data_type": "Boolean",
"description": "",
"field_name": "FIELD_02"
}
],
"total_fields": 2,
"updated_at": 1748079580,
"updated_by": "raviteja.d@rightrev.com"
}
],
"created_by": "RIGHTREV",
"created_on": 1772517985,
"last_modified_by": "RIGHTREV",
"last_modified_on": 1772517985
}
]This API is used to freeze the object.
Provide object name.
Freeze User Defined Object
Displays the outcome of the action. It is commonly used to provide success confirmations, error details, or other informational responses from the API after the operation is executed.
Name of the Object.
POST /apis/userdefinedobjects/v1/{object_name}/freeze HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 2
{}Freeze User Defined Object
{
"message": "object freezed",
"object_name": "TEST_RRAPI_QA_CUSTOM_06"
}This API is used to ceate new fileds in objects.
Name of the Object.
Provide field name to be added.
Data Type of the fields. For e.g. String Or Boolean Or Decimal etc.
Description of the field.
Create User Defined Object Fields
POST /apis/userdefinedobjects/v1/{object_name}/create_fields HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"field_name": "FILED_03",
"data_type": "String / Character",
"description": "test1"
}Create User Defined Object Fields
{}This API is used to delete the fields created in obejct.
Provide name of the Object.
Provide Name of the field to be deleted.
Delete User Defined Object Fields
DELETE /apis/userdefinedobjects/v1/{object_name}/field/{field_name} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Delete User Defined Object Fields
{}This API is to delete the CSV file uploaded in user defined objects.
Provide name of the object.
Provide file id. User can retrive file ID from GET call.
Delete User Defined Object File
DELETE /apis/userdefinedobjects/v1/{object_name}/file/{file_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Delete User Defined Object File
{}This API is used to download the uploaded CSV file in user defined object.
Provide name of the object.
Provide file id. User can retrive file ID from GET call.
Get User Defined Object File
GET /apis/userdefinedobjects/v1/{object_name}/file/{file_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get User Defined Object File
{}This API is used to upload CSV file in user defined object.
Provide name of the object.
Date Format
Attach CSV file to be uploaded.
Upload User Defined Object File
A system generated alpha-numeric number.
Displays the outcome of the action. It is commonly used to provide success confirmations, error details, or other informational responses from the API after the operation is executed.
POST /apis/userdefinedobjects/v1/{object_name}/file/upload HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: multipart/form-data
Accept: */*
Content-Length: 32
{
"date_format": null,
"file": null
}Upload User Defined Object File
{
"file_id": "828223ba-fce9-4328-bc90-5d8ed702bf87",
"message": "file uploaded"
}This API is used to download the CSV Template file created for specific user defined objects.
Provide name of the object.
Get User Defined Object File Template
GET /apis/userdefinedobjects/v1/{object_name}/template HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get User Defined Object File Template
{}This API is used to export CSV file uploaded with all the details of user defined objects.
Provide name of the obejct.
Export User Defined Object
A system-generated compliance ID on creating or updating the policy
Name of the policy.
ID of the user who created the policy. Example: username@rightrev.com
Timestamp of the policy created by the user. This is a unix Epoch timestamp format.
ID of the user last modified by.
Timestamp of the policy last modified on. This is a unix Epoch timestamp format.
GET /apis/userdefinedobjects/v1/{object_name}/export HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Export User Defined Object
[
{
"compliance_id": "bf00c65f-98f0-4db6-905e-f684b9a24d5b",
"compliance_name": "user-defined-objects",
"compliance_spec": [
{
"created_at": 1772532176,
"created_by": "svc@rightrev.com",
"file_id": "828223ba-fce9-4328-bc90-5d8ed702bf87",
"file_index": "0",
"file_name": "TEST_RRAPI_QA_CUSTOM_06_upload_template.csv",
"guid": "cb69dd46-dd12-417f-9b9b-0ebe47325f34",
"object_description": "New object",
"object_name": "TEST_RRAPI_QA_CUSTOM_06",
"process_status": "Success",
"source_data_json": {
"FILED_01": "test1",
"FILED_02": "test2"
},
"total_fields": 2,
"updated_at": 1772532176,
"updated_by": "svc@rightrev.com"
}
],
"created_by": "RIGHTREV",
"created_on": 1772532453,
"last_modified_by": "RIGHTREV",
"last_modified_on": 1772532453
}
]Last updated
Was this helpful?