Update request by ID

HOM

https://hom.roit.ai

PUT

/roit-data-integration/v1/requests/{process_unique_id}

Updates the status of a specific request by its process unique ID

Request

Path Params

process_unique_id

string

Process Unique Id

required

Header Params

Authorization

string

required

token generated

Body Params application/json

processUniqueId

string

Processuniqueid

required

Unique ID of the request

processStatus

required

Status of the request

Allowed values:

PENDINGSTARTPROCESSINGAUDITCONSOLIDATIONFINISHEDFAILED

callbackUrl

string

Callbackurl

optional

Callback URL to send the result of the request

callbackAuthToken

string

Callbackauthtoken

optional

Authentication token to send the result of the request

operationType

string

Operationtype

optional

Type of operation to be processed

documentType

optional

Type of document to be processed

Allowed values:

ECFECDEFDFEFDCNFSENFECTE

dataBaseDest

object

Databasedest

optional

Database destination configuration

secret

string

Secret

required

Database secret

tables

array[object (Table) {3}]

Tables

required

List of tables

nationalRegister

string

Nationalregister

optional

National register

metadata

object

Metadata

optional

Additional metadata about the request

Example

{
    "processUniqueId": "string",
    "processStatus": "PENDING",
    "callbackUrl": "string",
    "callbackAuthToken": "string",
    "operationType": "string",
    "documentType": "ECF",
    "dataBaseDest": {
        "secret": "string",
        "tables": [
            {
                "name": "string",
                "dataset": "string",
                "metadata": {}
            }
        ]
    },
    "nationalRegister": "string",
    "metadata": {}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://hom.roit.ai/roit-data-integration/v1/requests/' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "processUniqueId": "string",
    "processStatus": "PENDING",
    "callbackUrl": "string",
    "callbackAuthToken": "string",
    "operationType": "string",
    "documentType": "ECF",
    "dataBaseDest": {
        "secret": "string",
        "tables": [
            {
                "name": "string",
                "dataset": "string",
                "metadata": {}
            }
        ]
    },
    "nationalRegister": "string",
    "metadata": {}
}'

Responses

🟢200OK

application/json

Request status updated successfully

Body

status_code

integer

Status Code

optional

>= 200<= 599

Default:

200

message

string

Message

optional

Default:

data

object

Data

optional

Response data

processUniqueId

string

Processuniqueid

required

Unique ID of the request

createdAt

string

Createdat

required

Date and time the request was created

updatedAt

string

Updatedat

required

Date and time the request was updated

error

object

Error

optional

Error message

status

string

Status

optional

Default:

success

Example

{
    "status": "success",
    "message": "Request status updated successfully",
    "data": {
        "processUniqueId": "bb0c892a-9695-414d-966b-c3cd66959067",
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-15T11:00:00Z"
    }
}

🟠400Bad Request

🔴500Server Error

Modified at 2025-07-16 23:37:48

List Requests

Delete request by ID