Skip to main content
POST
Force a return-file generation

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

institutionId
string
obrigatório

The institution the return file is generated for (UUID). Authorized by the caller's RBAC role.

Exemplo:

"44444444-4444-4444-4444-444444444444"

Resposta

OK

failedGroups
integer<int64>
obrigatório

The number of response groups whose answer failed in this run. Non-zero with generated=true is a partial failure: the generated files stand and the failed groups are retried by the next run.

Exemplo:

0

generated
boolean
obrigatório

Whether this run created a new return file.

Exemplo:

true

generatedCount
integer<int64>
obrigatório

The number of return files created by this run. A remittance whose answer matches an existing file is stamped onto that file and creates none. The fields above describe the newest one.

Exemplo:

3

recordCount
integer<int64>
obrigatório

The number of records in the generated file.

Exemplo:

42

environment
string

The resolved SISBAJUD environment.

Exemplo:

"production"

fileHash
string

The file content hash.

Exemplo:

"sha256:abc123..."

fileName
string

The generated file name.

Exemplo:

"retorno-2026-07-14.txt"

fileType
string

The SISBAJUD file-type code.

Exemplo:

"RETORNO"

generationDate
string

The RFC3339 generation timestamp.

Exemplo:

"2026-07-14T12:00:00Z"

id
string

The generated file id.

Exemplo:

"dddddddd-dddd-dddd-dddd-dddddddddddd"

status
string

The file status.

Exemplo:

"GENERATED"