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 RiscosArquivos, são eles:

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

1.1 - GET

...

1.1.1 - Get All (Recuperar todos os

...

arquivos do conector específico)

...

...

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

Padrão scim:

SortBy: define o campo que será ordenado.

SortOrder: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente.

Exemplo 1: ?sortBy=campo1&sortOrder=ascending (Ascendente)

Exemplo 2: ?sortBy=campo1&sortOrder=descending (Descendente)

{
    "hasNext": false,
    "items": [
        {
            "id": 5,
            "companyId": 0,
            "name": "Risco-alto",
            "alertId": 5
        },
        {
            "id": 6,
            "companyId": 1,
            "name": "Risco-medio",
            "alertId": 3
        },
        {
            "id": 7,
            "companyId": 1,
            "name": "Risco-medio-baixo",
            "alertId": 2
        },
        {
            "id": 9,
            "companyId": 1,
            "name": "Risco-baixo",
            "alertId": 2
        },
        {
            "id": 10,
            "companyId": 1,
            "name": "Risco-medio-alto",
            "alertId": 4
        },
        {
            "id": 12,
            "companyId": 1,
            "name": "Risco-baixissmo",
            "alertId": 0
        }
    ]
}

...

{
    "hasNext": false,
    "items": [ 
        
		{
            		"id": 520,
            "companyId": 0,
            "name": "Risco-alto",
            "alertId": 5
        }, 
        {
            "id": 10,
            "companyId": 		"connectorId": 1,
            "name		"fileName": "Risco-medio-altoarquivo.txt",
            "alertId": 4
        }, 
        {
            "id": 6,
            "companyId": 1,
            "name": "Risco-medio",
            "alertId": 3
        },
        		"fileIdentifier": "fds8DFASdas9jw"
		},
		{
            		"id": 721,
            "companyId		"connectorId": 1,
            "name		"fileName": "Risco-medio-baixoarquivo2.txt",
            "alertId": 2
        },
        {
            "id": 9,
            "companyId": 1,
            "name": "Risco-baixo",
            "alertId": 1
        },
        {
            "id": 12,
            "companyId": 1,
            "name": "Risco-baixissmo",
            "alertId": 0
        }
    		"fileIdentifier": "fdfdss8DFASdas9jdasw"
		}      
	]
}

1.1.2 -

...

Download (

...

Baixar arquivo pelo

...

identificador)

...

{
    "id": 20,
    "companyId": 1,
    "name": "Risk-Teste",
    "alertId": 0
}FILECONTENT

1.2 - POST

...

1.2.1 - Post (

...

Fazer upload de um

...

arquivo)

...

{
    "companyId"MULTIFORM-DATA:
	connectorId: 1,
    "name": "Risk-Teste",
    "alertId": 0
}
	file: arquivo.txt

{
    "id": 20,
    "companyIdconnectorId": 1,
    "namefileName": "Risk-Teste",
    "alertId": 0
}

1.3 - PUT

1.3.1 - Put (Atualizar um risco)

{
    "companyId": 1arquivo.txt",
    "alertIdfileIdentifier": 2,
    "name": "Risco-Alterado"
}

{
    "id": 20,
    "companyId": 1,
    "alertId": 2,
    "name": "Risco-Alterado"fds8DFASdas9jw"
}

1.

...

3 - DELETE

...

1.

...

3.1 - Delete (Deletar um

...

arquivo)

...