Histórico da Página
...
Modelagem do InternalId
Conforme descrito no item Funcionamento deste documento, os atributos relativos ao InternalId devem ser modelados, independentemente do contexto de uso.
O exemplo a seguir mostra como modelar a modelagem da transação CostCenter, versão 2.000, usando o padrão OpenAPI (Swagger), considerando a obrigatoriedade da definição de InternalIds, mas não o seu uso. Ou seja, os campos de InternalId não são marcados como requeridos.
| Bloco de código | ||
|---|---|---|
| ||
openapi: 3.0.0
info:
description: Centro de Custo
version: '2.000'
title: CostCenter
contact:
name: T-Talk
paths: {}
servers:
- url: 'http://api.totvs.com.br/'
components:
schemas:
CostCenter:
type: object
required:
- Code
- Name
- ShortCode
properties:
CompanyId:
type: string
description: Código da empresa
BranchId:
type: string
description: Código da filial/estabelecimento/coligada
CompanyInternalId:
type: string
description: InternalId da empresa
Code:
type: string
description: Código do centro de custo
InternalId:
type: string
description: InternalId do centro de custo
RegisterSituation:
type: string
description: Indica se o centro de custo está ativo ou não.
enum:
- Active
- Inactive
Name:
type: string
description: Descrição do centro de custo
ShortCode:
type: string
description: Descrição breve do centro de custo
SPED:
type: boolean
Class:
type: number |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas