Generate Signed Url

HOM

POST

/roit-data-integration/v1/data/generate-signed-url

Data

Generate signed URL for file upload

Request

Header Params

Authorization

string

optional

token generated

Body Params application/json

nationalRegister

string

Nationalregister

required

processUniqueId

string

Processuniqueid

required

type

required

An enumeration.

Allowed values:

ECFECDEFDFEFDCNFSENFECTE

fileName

string

Filename

required

force

boolean

Force

optional

Default:

false

Example

{
  "nationalRegister": "string",
  "processUniqueId": "string",
  "type": "ECF",
  "fileName": "string",
  "force": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://hom.roit.ai/roit-data-integration/v1/data/generate-signed-url' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nationalRegister": "string",
    "processUniqueId": "string",
    "type": "ECF",
    "fileName": "string",
    "force": false
}'

Responses

🟢200OK

application/json

Successful Response

Body

status_code

integer

Status Code

optional

>= 200<= 599

Default:

200

message

string

Message

optional

Default:

data

string

Data

optional

error

null

Error

optional

status

string

Status

optional

Default:

success

Example

{
  "status_code": 200,
  "message": "",
  "data": "string",
  "error": null,
  "status": "success"
}

🟠400Bad Request

🔴500Server Error

Modified at 2025-02-13 00:43:09

Update Request Status

Reprocess a specific request