0% found this document useful (0 votes)
17 views31 pages

Dados Swagger

Uploaded by

jotalopesbarbosa
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
17 views31 pages

Dados Swagger

Uploaded by

jotalopesbarbosa
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 31

nocodb

2.0 OAS3

Servers

https://nocodb.nexusnerds.com.br Authorize

AUTENTICAÇÃO ADMIN
GET /api/v2/tables/m9nt31mn5ao0csp/records AUTENTICAÇÃO ADMIN list

List of all rows from AUTENTICAÇÃO ADMIN table and response data fields can be filtered based
on query params.

Parameters Try it out

Name Description

viewId
string Allows you to fetch records that are currently visible within a specific view.
(query)
Views:

vwq6ldu713dqd3p1 - Default view

Available values : vwq6ldu713dqd3p1

--

fields
string Array of field names or comma separated filed names to include in the
(query) response objects. In array syntax pass it like
fields[]=field1&fields[]=field2 or alternately
fields=field1,field2 .

fields

sort
string Comma separated field names to sort rows, rows will sort in ascending
(query) order based on provided columns. To sort in descending order provide -
prefix along with column name, like -field . Example : sort=field1,-
field2
Name Description

sort

where
string This can be used for filtering rows, which accepts complicated where
(query) conditions. For more info visit here. Example : where=(field1,eq,value)

where

limit
number The limit parameter used for pagination, the response collection size
(query) depends on limit value with default value 25 and maximum value 1000 ,
which can be overridden by environment variables
DB_QUERY_LIMIT_DEFAULT and DB_QUERY_LIMIT_MAX respectively.

Example : 25

25

shuffle
number The shuffle parameter used for pagination, the response will be
(query) shuffled if it is set to 1.

Example : 0

offset
number The offset parameter used for pagination, the value helps to select
(query) collection from a certain index.

Example : 0

Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.
Code Description Links
Example Value Schema

{
"list": [
{
"Id": 0,
"Email Administração": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Senha": "string"
}
],
"PageInfo": {
"pageSize": 0,
"totalRows": 0,
"isFirstPage": true,
"isLastPage": true,
"page": 0
}
}

POST /api/v2/tables/m9nt31mn5ao0csp/records AUTENTICAÇÃO ADMIN create

Insert a new row in table by providing a key value pair object where key refers to the column alias.
All the required fields should be included with payload excluding autoincrement and column with
default value.

Parameters Try it out

No parameters

Request body application/json

Example Value Schema

{
"Email Administração": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Senha": "string"
}

Responses

Code Description Links

200 No links
OK
Code Description Links

Media type

application/json
Controls Accept header.

Example Value Schema

{
"Id": 0,
"Email Administração": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Senha": "string"
}

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

PATCH /api/v2/tables/m9nt31mn5ao0csp/records AUTENTICAÇÃO ADMIN update

Partial update row in table by providing a key value pair object where key refers to the column alias.
You need to only include columns which you want to update.

Parameters Try it out

No parameters

Request body application/json

Example Value Schema

{
"Email Administração": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Senha": "string"
}
Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

"string"

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

DELETE /api/v2/tables/m9nt31mn5ao0csp/records AUTENTICAÇÃO ADMIN delete

Delete a row by using the primary key column value.

Parameters Try it out

No parameters

Request body application/json

Example Value Schema


{
"Id": 0
}

Responses

Code Description Links

200 No links
OK

/api/v2/tables/m9nt31mn5ao0csp/records
GET /{recordId}
AUTENTICAÇÃO ADMIN read

Read a row data by using the primary key column value.

Parameters Try it out

Name Description

recordId
* required Primary key of the record you want to read. If the table have composite
string primary key then combine them by using ___ and pass it as primary key.
(path)
Example : 1

fields
string Array of field names or comma separated filed names to include in the
(query) response objects. In array syntax pass it like
fields[]=field1&fields[]=field2 or alternately
fields=field1,field2 .

fields

Responses
Code Description Links

201 No links
Created

Media type

application/json
Controls Accept header.

Example Value Schema

{
"Id": 0,
"Email Administração": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Senha": "string"
}

/api/v2/tables/m9nt31mn5ao0csp/records
GET /count AUTENTICAÇÃO ADMIN count

Get rows count of a table by applying optional filters.

Parameters Try it out

Name Description

where
string This can be used for filtering rows, which accepts complicated where
(query) conditions. For more info visit here. Example : where=(field1,eq,value)

where

viewId
string Allows you to fetch records that are currently visible within a specific view.
(query)
Views:

vwq6ldu713dqd3p1 - Default view

Available values : vwq6ldu713dqd3p1

--

Responses
Code Description Links

200 No links
OK

Media type Examples

application/json Example 1
Controls Accept header.

Example Value Schema

{
"count": 3
}

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

COMISSÃO

GET /api/v2/tables/m21oavwguouzwej/records COMISSÃO list

List of all rows from COMISSÃO table and response data fields can be filtered based on query
params.

Parameters Try it out

Name Description

viewId
string Allows you to fetch records that are currently visible within a specific view.
(query)
Views:

vw7u5vrbui8t1vaq - Default view

Available values : vw7u5vrbui8t1vaq


Name Description

--

fields
string Array of field names or comma separated filed names to include in the
(query) response objects. In array syntax pass it like
fields[]=field1&fields[]=field2 or alternately
fields=field1,field2 .

fields

sort
string Comma separated field names to sort rows, rows will sort in ascending
(query) order based on provided columns. To sort in descending order provide -
prefix along with column name, like -field . Example : sort=field1,-
field2

sort

where
string This can be used for filtering rows, which accepts complicated where
(query) conditions. For more info visit here. Example : where=(field1,eq,value)

where

limit
number The limit parameter used for pagination, the response collection size
(query) depends on limit value with default value 25 and maximum value 1000 ,
which can be overridden by environment variables
DB_QUERY_LIMIT_DEFAULT and DB_QUERY_LIMIT_MAX respectively.

Example : 25

25

shuffle
number The shuffle parameter used for pagination, the response will be
(query) shuffled if it is set to 1.

Example : 0

offset
number The offset parameter used for pagination, the value helps to select
(query) collection from a certain index.

Example : 0

0
Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

{
"list": [
{
"Id": 0,
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Valores_Comissão": {}
}
],
"PageInfo": {
"pageSize": 0,
"totalRows": 0,
"isFirstPage": true,
"isLastPage": true,
"page": 0
}
}

POST /api/v2/tables/m21oavwguouzwej/records COMISSÃO create

Insert a new row in table by providing a key value pair object where key refers to the column alias.
All the required fields should be included with payload excluding autoincrement and column with
default value.

Parameters Try it out

No parameters

Request body application/json

Example Value Schema

{
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Valores_Comissão": {}
}

Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

{
"Id": 0,
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Valores_Comissão": {}
}

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

PATCH /api/v2/tables/m21oavwguouzwej/records COMISSÃO update

Partial update row in table by providing a key value pair object where key refers to the column alias.
You need to only include columns which you want to update.

Parameters Try it out

No parameters

Request body application/json


Example Value Schema

{
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Valores_Comissão": {}
}

Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

"string"

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

DELETE /api/v2/tables/m21oavwguouzwej/records COMISSÃO delete

Delete a row by using the primary key column value.

Parameters Try it out


No parameters

Request body application/json

Example Value Schema

{
"Id": 0
}

Responses

Code Description Links

200 No links
OK

/api/v2/tables/m21oavwguouzwej/records
GET COMISSÃO read
/{recordId}

Read a row data by using the primary key column value.

Parameters Try it out

Name Description

recordId
* required Primary key of the record you want to read. If the table have composite
string primary key then combine them by using ___ and pass it as primary key.
(path)
Example : 1

fields
string Array of field names or comma separated filed names to include in the
(query) response objects. In array syntax pass it like
fields[]=field1&fields[]=field2 or alternately
fields=field1,field2 .

fields
Responses

Code Description Links

201 No links
Created

Media type

application/json
Controls Accept header.

Example Value Schema

{
"Id": 0,
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Valores_Comissão": {}
}

/api/v2/tables/m21oavwguouzwej/records
GET /count
COMISSÃO count

Get rows count of a table by applying optional filters.

Parameters Try it out

Name Description

where
string This can be used for filtering rows, which accepts complicated where
(query) conditions. For more info visit here. Example : where=(field1,eq,value)

where

viewId
string Allows you to fetch records that are currently visible within a specific view.
(query)
Views:

vw7u5vrbui8t1vaq - Default view

Available values : vw7u5vrbui8t1vaq

--
Responses

Code Description Links

200 No links
OK

Media type Examples

application/json Example 1
Controls Accept header.

Example Value Schema

{
"count": 3
}

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

CONTROLE DE VENDAS

GET /api/v2/tables/myyj60ek0dxwpbh/records CONTROLE DE VENDAS list

List of all rows from CONTROLE DE VENDAS table and response data fields can be filtered based
on query params.

Parameters Try it out

Name Description

viewId
string Allows you to fetch records that are currently visible within a specific view.
Name Description

(query) Views:

vwd7cnlhei5hvhnu - Default view

Available values : vwd7cnlhei5hvhnu

--

fields
string Array of field names or comma separated filed names to include in the
(query) response objects. In array syntax pass it like
fields[]=field1&fields[]=field2 or alternately
fields=field1,field2 .

fields

sort
string Comma separated field names to sort rows, rows will sort in ascending
(query) order based on provided columns. To sort in descending order provide -
prefix along with column name, like -field . Example : sort=field1,-
field2

sort

where
string This can be used for filtering rows, which accepts complicated where
(query) conditions. For more info visit here. Example : where=(field1,eq,value)

where

limit
number The limit parameter used for pagination, the response collection size
(query) depends on limit value with default value 25 and maximum value 1000 ,
which can be overridden by environment variables
DB_QUERY_LIMIT_DEFAULT and DB_QUERY_LIMIT_MAX respectively.

Example : 25

25

shuffle
number The shuffle parameter used for pagination, the response will be
(query) shuffled if it is set to 1.

Example : 0

offset
number The offset parameter used for pagination, the value helps to select
(query) collection from a certain index.
Name Description

Example : 0

Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

{
"list": [
{
"Id": 0,
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"DadosClientesVendedores": {}
}
],
"PageInfo": {
"pageSize": 0,
"totalRows": 0,
"isFirstPage": true,
"isLastPage": true,
"page": 0
}
}

POST /api/v2/tables/myyj60ek0dxwpbh/records CONTROLE DE VENDAS create

Insert a new row in table by providing a key value pair object where key refers to the column alias.
All the required fields should be included with payload excluding autoincrement and column with
default value.

Parameters Try it out

No parameters

Request body
application/json

Example Value Schema

{
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"DadosClientesVendedores": {}
}

Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

{
"Id": 0,
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"DadosClientesVendedores": {}
}

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

PATCH /api/v2/tables/myyj60ek0dxwpbh/records CONTROLE DE VENDAS update

Partial update row in table by providing a key value pair object where key refers to the column alias.
You need to only include columns which you want to update.

Parameters Try it out

No parameters

Request body application/json

Example Value Schema

{
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"DadosClientesVendedores": {}
}

Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

"string"

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}
DELETE /api/v2/tables/myyj60ek0dxwpbh/records CONTROLE DE VENDAS delete

Delete a row by using the primary key column value.

Parameters Try it out

No parameters

Request body application/json

Example Value Schema

{
"Id": 0
}

Responses

Code Description Links

200 No links
OK

/api/v2/tables/myyj60ek0dxwpbh/records
GET CONTROLE DE VENDAS read
/{recordId}

Read a row data by using the primary key column value.

Parameters Try it out

Name Description

recordId
* required Primary key of the record you want to read. If the table have composite
string primary key then combine them by using ___ and pass it as primary key.
(path)
Example : 1
Name Description

fields
string Array of field names or comma separated filed names to include in the
(query) response objects. In array syntax pass it like
fields[]=field1&fields[]=field2 or alternately
fields=field1,field2 .

fields

Responses

Code Description Links

201 No links
Created

Media type

application/json
Controls Accept header.

Example Value Schema

{
"Id": 0,
"Title": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"DadosClientesVendedores": {}
}

/api/v2/tables/myyj60ek0dxwpbh/records
GET /count
CONTROLE DE VENDAS count

Get rows count of a table by applying optional filters.

Parameters Try it out

Name Description

where
string This can be used for filtering rows, which accepts complicated where
(query) conditions. For more info visit here. Example : where=(field1,eq,value)
Name Description

where

viewId
string Allows you to fetch records that are currently visible within a specific view.
(query)
Views:

vwd7cnlhei5hvhnu - Default view

Available values : vwd7cnlhei5hvhnu

--

Responses

Code Description Links

200 No links
OK

Media type Examples

application/json Example 1
Controls Accept header.

Example Value Schema

{
"count": 3
}

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

INDICAÇÕES VENDAS
GET /api/v2/tables/m1k63kk7jhrg4rx/records INDICAÇÕES VENDAS list

List of all rows from INDICAÇÕES VENDAS table and response data fields can be filtered based on
query params.

Parameters Try it out

Name Description

viewId
string Allows you to fetch records that are currently visible within a specific view.
(query)
Views:

vwot5v0m4u8ugvl9 - Default view

Available values : vwot5v0m4u8ugvl9

--

fields
string Array of field names or comma separated filed names to include in the
(query) response objects. In array syntax pass it like
fields[]=field1&fields[]=field2 or alternately
fields=field1,field2 .

fields

sort
string Comma separated field names to sort rows, rows will sort in ascending
(query) order based on provided columns. To sort in descending order provide -
prefix along with column name, like -field . Example : sort=field1,-
field2

sort

where
string This can be used for filtering rows, which accepts complicated where
(query) conditions. For more info visit here. Example : where=(field1,eq,value)

where

limit
number The limit parameter used for pagination, the response collection size
(query) depends on limit value with default value 25 and maximum value 1000 ,
which can be overridden by environment variables
DB_QUERY_LIMIT_DEFAULT and DB_QUERY_LIMIT_MAX respectively.

Example : 25
Name Description

25

shuffle
number The shuffle parameter used for pagination, the response will be
(query) shuffled if it is set to 1.

Example : 0

offset
number The offset parameter used for pagination, the value helps to select
(query) collection from a certain index.

Example : 0

Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

{
"list": [
{
"Id": 0,
"Vendedor": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Json_Indicações": {},
"UnicID": "string",
"ContadorCliques": "string",
"emailVendedor": "string"
}
],
"PageInfo": {
"pageSize": 0,
"totalRows": 0,
"isFirstPage": true,
"isLastPage": true,
"page": 0
Code Description Links
}
}

POST /api/v2/tables/m1k63kk7jhrg4rx/records INDICAÇÕES VENDAS create

Insert a new row in table by providing a key value pair object where key refers to the column alias.
All the required fields should be included with payload excluding autoincrement and column with
default value.

Parameters Try it out

No parameters

Request body application/json

Example Value Schema

{
"Vendedor": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Json_Indicações": {},
"UnicID": "string",
"ContadorCliques": "string",
"emailVendedor": "string"
}

Responses

Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

{
"Id": 0,
"Vendedor": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Json_Indicações": {},
Code Description Links
"UnicID": "string",
"ContadorCliques": "string",
"emailVendedor": "string"
}

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

PATCH /api/v2/tables/m1k63kk7jhrg4rx/records INDICAÇÕES VENDAS update

Partial update row in table by providing a key value pair object where key refers to the column alias.
You need to only include columns which you want to update.

Parameters Try it out

No parameters

Request body application/json

Example Value Schema

{
"Vendedor": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Json_Indicações": {},
"UnicID": "string",
"ContadorCliques": "string",
"emailVendedor": "string"
}

Responses
Code Description Links

200 No links
OK

Media type

application/json
Controls Accept header.

Example Value Schema

"string"

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

DELETE /api/v2/tables/m1k63kk7jhrg4rx/records INDICAÇÕES VENDAS delete

Delete a row by using the primary key column value.

Parameters Try it out

No parameters

Request body application/json

Example Value Schema

{
"Id": 0
}
Responses

Code Description Links

200 No links
OK

/api/v2/tables/m1k63kk7jhrg4rx/records
GET /{recordId}
INDICAÇÕES VENDAS read

Read a row data by using the primary key column value.

Parameters Try it out

Name Description

recordId
* required Primary key of the record you want to read. If the table have composite
string primary key then combine them by using ___ and pass it as primary key.
(path)
Example : 1

fields
string Array of field names or comma separated filed names to include in the
(query) response objects. In array syntax pass it like
fields[]=field1&fields[]=field2 or alternately
fields=field1,field2 .

fields

Responses

Code Description Links

201 No links
Created

Media type

application/json
Code Description Links

Controls Accept header.

Example Value Schema

{
"Id": 0,
"Vendedor": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Json_Indicações": {},
"UnicID": "string",
"ContadorCliques": "string",
"emailVendedor": "string"
}

/api/v2/tables/m1k63kk7jhrg4rx/records
GET /count INDICAÇÕES VENDAS count

Get rows count of a table by applying optional filters.

Parameters Try it out

Name Description

where
string This can be used for filtering rows, which accepts complicated where
(query) conditions. For more info visit here. Example : where=(field1,eq,value)

where

viewId
string Allows you to fetch records that are currently visible within a specific view.
(query)
Views:

vwot5v0m4u8ugvl9 - Default view

Available values : vwot5v0m4u8ugvl9

--

Responses

Code Description Links

200 No links
OK
Code Description Links

Media type Examples

application/json Example 1
Controls Accept header.

Example Value Schema

{
"count": 3
}

400 No links
BadRequest

Media type Examples

application/json Example 1

Example Value Schema

{
"msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

Schemas

Paginated

Attachment

Groupby

AUTENTICAÇÃO ADMIN Response

AUTENTICAÇÃO ADMIN Request

AUTENTICAÇÃO ADMIN Id Request


COMISSÃO Response

COMISSÃO Request

COMISSÃO Id Request

CONTROLE DE VENDAS Response

CONTROLE DE VENDAS Request

CONTROLE DE VENDAS Id Request

INDICAÇÕES VENDAS Response

INDICAÇÕES VENDAS Request

INDICAÇÕES VENDAS Id Request

You might also like