Get all documents attached to a request

Request

Header Params

Authorization

string

required

token generated

Body Params application/json

requestId

string

required

ID of the request

Example:

1234a5b6-cd78-9012-3456-789e012345fg

integrationId

string

required

ID of the integration registered at ROIT ADMIN

Example:

9876c5d4-ba32-1098-7654-321f98765432

Example

Get Attached Files to a Request

{
  "requestId": "1234a5b6-cd78-9012-3456-789e012345fg",
  "integrationId": "9876c5d4-ba32-1098-7654-321f98765432"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://hom.roit.ai/ibs-core-entrypoint/api/v1/entrypoint/requests/attachs' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "1234a5b6-cd78-9012-3456-789e012345fg",
    "integrationId": "9876c5d4-ba32-1098-7654-321f98765432"
}'

Responses

🟢201Created

application/json

Document attachments

Body

displayName

string

required

The display name of the file

Example:

NFE.xml

original

object

required

The file that started the process

url

string

required

The URL of the file

Example:

https://example.com/file.xml

extension

string

required

The extension of the file

Example:

xml

type

string

required

The type of the file

Example:

NFE

displayName

string

optional

The display name of the file

Example:

NFE.xml

generatedFiles

object

optional

The file generated by the process. Example: the pdf generated to a NFE XML

Example:

NFE.pdf

url

string

required

The URL of the file

Example:

https://example.com/file.xml

extension

string

required

The extension of the file

Example:

xml

type

string

required

The type of the file

Example:

NFE

displayName

string

optional

The display name of the file

Example:

NFE.xml

linkedFiles

array[object (FileDto) {4}]

required

The linked files of the file

url

string

required

The URL of the file

Example:

https://example.com/file.xml

extension

string

required

The extension of the file

Example:

xml

type

string

required

The type of the file

Example:

NFE

displayName

string

optional

The display name of the file

Example:

NFE.xml

Example

{
  "displayName": "NFE.xml",
  "original": {
    "url": "https://example.com/nfe.xml",
    "extension": "xml",
    "type": "NFE",
    "displayName": "NFE.xml"
  },
  "generatedFile": {
    "url": "https://example.com/nfe.pdf",
    "extension": "pdf",
    "type": "NFE",
    "displayName": "NFE.pdf"
  },
  "linkedFiles": [
    {
      "url": "https://example.com/cte.xml",
      "extension": "xml",
      "type": "CTE",
      "displayName": "CTE.xml"
    }
  ]
}

🟠400Bad Request

🟠403Forbidden