> For the complete documentation index, see [llms.txt](https://apis.rightrev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apis.rightrev.com/rightrev-rest-api/transactions-ingestion/user-defined-objects-udo.md).
# User Defined Objects (UDO)
## Udo Get
> This API retrieves list of all user defined objects created in the system.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/":{"get":{"description":"This API retrieves list of all user defined objects created in the system.\n","responses":{"200":{"description":"Get User Defined Object","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID on creating or updating the policy"},"compliance_name":{"type":"string","description":"Name of the policy."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"integer","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"guid":{"type":"string","description":"Globally unique identifier generated by the system."},"object_description":{"type":"string","description":"Description of the object created."},"object_freeze":{"type":"boolean","description":"A boolean field indicating object is freezed or not."},"object_name":{"type":"string","description":"Name of the Object. It starts with Tenant ID."},"total_fields":{"type":"integer","description":"Total number of fields available in the obejct table."},"updated_at":{"type":"integer","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"updated_by":{"type":"string","description":"ID of the user who updated the policy. Example: username@rightrev.com"}},"required":["created_at","created_by","guid","object_description","object_freeze","object_name","total_fields","updated_at","updated_by"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"created_on":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"last_modified_by":{"type":"string","description":"ID of the user last modified by."},"last_modified_on":{"type":"integer","description":"Timestamp of the policy last modified on. This is a unix Epoch timestamp format."}},"required":["compliance_id","compliance_name","compliance_spec","created_by","created_on","last_modified_by","last_modified_on"]}}}}}},"tags":["User Defined Objects"],"summary":"Udo Get","operationId":"udo_get_apis_userdefinedobjects_v1__get"}}}}
```
## Udo Post
> This API used to create new user defined objects in the system.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/":{"post":{"description":"This API used to create new user defined objects in the system.\n","responses":{"200":{"description":"Create User Defined Object","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"object_name":{"type":"string","description":"Name of the obejct to be created. It should start with Tenant ID."},"description":{"type":"string","description":"Description of the object."}},"required":["description","object_name"]}}},"required":true},"tags":["User Defined Objects"],"summary":"Udo Post","operationId":"udo_post_apis_userdefinedobjects_v1__post"}}}}
```
## Udo Object Get
> This API is used to retrieve all the field level details created in the object.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/{object_name}":{"get":{"description":"This API is used to retrieve all the field level details created in the object.\n","parameters":[{"name":"object_name","in":"path","required":true,"schema":{"type":"string","title":"Object Name"},"description":"Provide name of the object.\n"},{"name":"freeze","in":"query","required":true,"schema":{"type":"boolean","title":"Freeze"},"description":"A boolean field indicating object is freezed or not.\n"}],"responses":{"200":{"description":"Get User Defined Object","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID on creating or updating the policy."},"compliance_name":{"type":"string","description":"Name of the policy."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"integer","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"guid":{"type":"string","description":"Globally unique identifier generated by the system."},"object_description":{"type":"string","description":"Description of the Object."},"object_freeze":{"type":"boolean","description":"A boolean field indicating object is freezed or not."},"object_name":{"type":"string","description":"Name of the Object."},"object_structure":{"type":"array","items":{"type":"object","properties":{"data_type":{"type":"string","description":"Data type of the field. For e.g. String or Boolean or Decimal etc."},"description":{"type":"string","description":"Description of the field."},"field_name":{"type":"string","description":"Name of the field."}},"required":["data_type","description","field_name"]},"description":"Structual details of the object specifying total fields and updation details."},"total_fields":{"type":"integer","description":"Total fields created in the object."},"updated_at":{"type":"integer","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"updated_by":{"type":"string","description":"ID of the user who updated the policy. Example: username@rightrev.com"}},"required":["created_at","created_by","guid","object_description","object_freeze","object_name","object_structure","total_fields","updated_at","updated_by"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"created_on":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"last_modified_by":{"type":"string","description":"ID of the user last modified by."},"last_modified_on":{"type":"integer","description":"Timestamp of the policy last modified on. This is a unix Epoch timestamp format."}},"required":["compliance_id","compliance_name","compliance_spec","created_by","created_on","last_modified_by","last_modified_on"]}}}}}},"tags":["User Defined Objects"],"summary":"Udo Object Get","operationId":"udo_object_get_apis_userdefinedobjects_v1__object_name__get"}}}}
```
## Udo Freeze
> This API is used to freeze the object.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/{object_name}/freeze":{"post":{"description":"This API is used to freeze the object.\n","parameters":[{"name":"object_name","in":"path","required":true,"schema":{"type":"string","title":"Object Name"},"description":"Provide object name.\n"}],"responses":{"200":{"description":"Freeze User Defined Object","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"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."},"object_name":{"type":"string","description":"Name of the Object."}},"required":["message","object_name"]}}}}},"requestBody":{"description":"Request Body to be declared as empty json","content":{"application/json":{"schema":{}}},"required":true},"tags":["User Defined Objects"],"summary":"Udo Freeze","operationId":"udo_freeze_apis_userdefinedobjects_v1__object_name__freeze_post"}}}}
```
## Udo Fields Create
> This API is used to ceate new fileds in objects.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/{object_name}/create_fields":{"post":{"description":"This API is used to ceate new fileds in objects.\n","parameters":[{"name":"object_name","in":"path","required":true,"schema":{"type":"string","title":"Object Name"},"description":"Name of the Object.\n"}],"responses":{"200":{"description":"Create User Defined Object Fields","content":{"application/json":{"schema":{"type":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"field_name":{"type":"string","description":"Provide field name to be added."},"data_type":{"type":"string","description":"Data Type of the fields. For e.g. String Or Boolean Or Decimal etc."},"description":{"type":"string","description":"Description of the field."}},"required":["data_type","description","field_name"]}}},"required":true},"tags":["User Defined Objects"],"summary":"Udo Fields Create","operationId":"udo_fields_create_apis_userdefinedobjects_v1__object_name__create_fields_post"}}}}
```
## Udo Fields Delete
> This API is used to delete the fields created in obejct.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/{object_name}/field/{field_name}":{"delete":{"description":"This API is used to delete the fields created in obejct.\n","parameters":[{"name":"object_name","in":"path","required":true,"schema":{"type":"string","title":"Object Name"},"description":"Provide name of the Object.\n"},{"name":"field_name","in":"path","required":true,"schema":{"type":"string","title":"Field Name"},"description":"Provide Name of the field to be deleted.\n"}],"responses":{"200":{"description":"Delete User Defined Object Fields","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["User Defined Objects"],"summary":"Udo Fields Delete","operationId":"udo_fields_delete_apis_userdefinedobjects_v1__object_name__field__field_name__delete"}}}}
```
## Udo File Delete
> This API is to delete the CSV file uploaded in user defined objects.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/{object_name}/file/{file_id}":{"delete":{"description":"This API is to delete the CSV file uploaded in user defined objects.\n","parameters":[{"name":"object_name","in":"path","required":true,"schema":{"type":"string","title":"Object Name"},"description":"Provide name of the object.\n"},{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"},"description":"Provide file id. User can retrive file ID from GET call.\n"}],"responses":{"200":{"description":"Delete User Defined Object File","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["User Defined Objects"],"summary":"Udo File Delete","operationId":"udo_file_delete_apis_userdefinedobjects_v1__object_name__file__file_id__delete"}}}}
```
## Udo File Get
> This API is used to download the uploaded CSV file in user defined object.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/{object_name}/file/{file_id}":{"get":{"description":"This API is used to download the uploaded CSV file in user defined object.\n","parameters":[{"name":"object_name","in":"path","required":true,"schema":{"type":"string","title":"Object Name"},"description":"Provide name of the object.\n"},{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"},"description":"Provide file id. User can retrive file ID from GET call.\n"}],"responses":{"200":{"description":"Get User Defined Object File","content":{"application/json":{"schema":{}}}}},"tags":["User Defined Objects"],"summary":"Udo File Get","operationId":"udo_file_get_apis_userdefinedobjects_v1__object_name__file__file_id__get"}}}}
```
## Udo File Upload
> This API is used to upload CSV file in user defined object.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/{object_name}/file/upload":{"post":{"description":"This API is used to upload CSV file in user defined object.\n","parameters":[{"name":"object_name","in":"path","required":true,"schema":{"type":"string","title":"Object Name"},"description":"Provide name of the object.\n"}],"responses":{"200":{"description":"Upload User Defined Object File","content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"type":"string","description":"A system generated alpha-numeric number."},"message":{"type":"string","description":"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."}},"required":["file_id","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"date_format":{"type":"text","format":"%m/%d/%Y","description":"Date Format"},"file":{"type":"file","format":"binary","description":"Attach CSV file to be uploaded."}},"required":["date_format","file"]}}},"required":true},"tags":["User Defined Objects"],"summary":"Udo File Upload","operationId":"udo_file_upload_apis_userdefinedobjects_v1__object_name__file_upload_post"}}}}
```
## Udo File Template
> This API is used to download the CSV Template file created for specific user defined objects.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/{object_name}/template":{"get":{"description":"This API is used to download the CSV Template file created for specific user defined objects.\n","parameters":[{"name":"object_name","in":"path","required":true,"schema":{"type":"string","title":"Object Name"},"description":"Provide name of the object.\n"}],"responses":{"200":{"description":"Get User Defined Object File Template","content":{"application/json":{"schema":{}}}}},"tags":["User Defined Objects"],"summary":"Udo File Template","operationId":"udo_file_template_apis_userdefinedobjects_v1__object_name__template_get"}}}}
```
## Udo Export
> This API is used to export CSV file uploaded with all the details of user defined objects.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/userdefinedobjects/v1/{object_name}/export":{"get":{"description":"This API is used to export CSV file uploaded with all the details of user defined objects.\n","parameters":[{"name":"object_name","in":"path","required":true,"schema":{"type":"string","title":"Object Name"},"description":"Provide name of the obejct.\n"}],"responses":{"200":{"description":"Export User Defined Object","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID on creating or updating the policy"},"compliance_name":{"type":"string","description":"Name of the policy."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"file_id":{"type":"string","description":"A system generated alpha-numeric number."},"file_index":{"type":"string","description":"A system generated alpha-numeric number."},"file_name":{"type":"string","description":"Name of the CSV file exported. "},"guid":{"type":"string","description":"Globally unique identifier generated by the system."},"object_description":{"type":"string","description":"Description of the object."},"object_name":{"type":"string","description":"Name of the object."},"process_status":{"type":"string","description":"Status of the export process. Success or Failed."},"source_data_json":{"type":"object","properties":{"FILED_01":{"type":"string","description":"Name of the fields."},"FILED_02":{"type":"string","description":"Name of the fields"}},"required":["FILED_01","FILED_02"],"description":" Format of of the source data. For e.g. JSON"},"total_fields":{"type":"integer","description":"Total fields available in object."},"updated_at":{"type":"integer","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"updated_by":{"type":"string","description":"ID of the user who updated the policy. Example: username@rightrev.com"}},"required":["created_at","created_by","file_id","file_index","file_name","guid","object_description","object_name","process_status","source_data_json","total_fields","updated_at","updated_by"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"created_on":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"last_modified_by":{"type":"string","description":"ID of the user last modified by."},"last_modified_on":{"type":"integer","description":"Timestamp of the policy last modified on. This is a unix Epoch timestamp format."}},"required":["compliance_id","compliance_name","compliance_spec","created_by","created_on","last_modified_by","last_modified_on"]}}}}}},"tags":["User Defined Objects"],"summary":"Udo Export","operationId":"udo_export_apis_userdefinedobjects_v1__object_name__export_get"}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://apis.rightrev.com/rightrev-rest-api/transactions-ingestion/user-defined-objects-udo.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.