Histórico da Página
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
(...)
"paths": {
"/customerVendor": {
"get": {
"tags": [
"customerVendor"
],
"summary": "Retorna todos Clientes/Fornecedores",
"x-totvs": {
"productInformation": [
{
"product": "Protheus",
"available": true,
"note": "Este verbo não está diponível no protheus. Utilize a consulta CustomerVendorEntity",
"minimalVersion": "12.1.21"
}
]
},
"description": "Retorna todos clientes e/ou fornecedores",
"operationId": "getcustomerVendor",
"parameters": [
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page"
},
{
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize"
}
],
"responses": {
"200": {
"description": "Operação realizada com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/CustomerVendor_2_006.json#/definitions/PagedCustomerVendors"
}
}
}
},
"400": {
"description": "Erro na requisição!",
"content": {
"application/json": {
"schema": {
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
}
}
}
}
(...)
|
Utilizando os padrões fornecidos pela TTALK através do totvsApiTypesBase.json, o desenvolvedor não precisará criar na especificação os seguintes items:
Types:
- Paging:
- ErrorModel:
- ErrorModelBase:
- ErrorDetail:
- ExpandablesType:
Parameters:
- Authorization: Cabeçalho usado para autorização das requisições
- Order: utilizado para ordenação da coleção
- Page: paginação da coleção
- PageSize: utilizado para determinação de quantidade máxima de itens por página
- AcceptLanguage: campo que determina o idioma que o cliente compreenderá
- Fields:
- Expand:
| Aviso |
|---|
Ao referenciar qualquer arquivo do GitHub, tenha certeza que está obtendo o link apenas com o JSON e não o da árvore de arquivos. Para isso, ao entrar na página do arquivo desejado, clique em "Raw" e só então copie o link da página com o arquivo JSON. |
...
Import HTML Content
Visão Geral
Conteúdo das Ferramentas