Sumário



Objetivo


Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.

Para mais informações sobre consumo de Licença, Veja Aqui.


1 - Métodos


Serão apresentados 4 métodos, os quais foram implementados na API de Arquivos, são eles:

  • GET ALL
  • GET (download do arquivo)
  • POST (upload do arquivo)
  • DELETE

1.1 - GET


1.1.1 - Get All (Recuperar todos os arquivos do conector específico)


1.1.1 GetAll

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/filerepo/connectors/{{connectorId}}/files

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/filerepo/connectors/1/files

Exemplo de Resultado

Resultado (JSON)
{
    "hasNext": false,
    "items": [
		{
    		"id": 20,
    		"connectorId": 1,
    		"fileName": "arquivo.txt",
    		"fileIdentifier": "fds8DFASdas9jw"
		},
		{
    		"id": 21,
    		"connectorId": 1,
    		"fileName": "arquivo2.txt",
    		"fileIdentifier": "fdfdss8DFASdas9jdasw"
		}      
	]
}

1.1.2 - Download (Baixar arquivo pelo identificador)



1.1.2 GetOne

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/filerepo/files/{{id}}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 20

Url Utilizada: http://localhost:8051/api/framework/v1/filerepo/files/20

Resultado (JSON)
FILECONTENT


1.2 - POST


1.2.1 - Post (Fazer upload de um arquivo)


1.2.1 Post

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/filerepo/files

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/filerepo/files

Exemplo de Entrada

Resultado (JSON)
MULTIFORM-DATA:
	connectorId: 1
	file: arquivo.txt

Exemplo de Resultado Positivo

Resultado (JSON)
{
    "id": 20,
    "connectorId": 1,
    "fileName": "arquivo.txt",
    "fileIdentifier": "fds8DFASdas9jw"
}

1.3 - DELETE


1.3.1 - Delete (Deletar um arquivo)


1.3.1 Delete

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/filerepo/files/{id}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 20

Url Utilizada: http://localhost:8051/api/framework/v1/filerepo/files/20

Resultado esperado

Será retornado o respondeCode = 204 e a resposta em branco.