#entidade
É a estrutura que representa a materialização do Documento no Campo em uma Instância de Campo (FieldInstance) no momento da sua criação em uma Operação (Operation). Os OrganizationDocumentOnFieldInstances estão relacionados com os Documento da Organização (OrganizationDocument), porém dentro do contexto de uma Instância de Campo (FieldInstance).
Caso a configuração definida no valor da Instância de Campo (FieldInstance) (document_folder) permita a inclusão de ‘novos documentos’, essa estrutura também serve para a inclusão de novos itens (que também serão materializados como Documento da Organização (OrganizationDocument).
Estrutura de Dados §
| Tipo | Nome do elemento | Restrições | Observações |
|---|
| string | ID | único | |
| bool | optional | | Caso verdadeiro, se esse elemento não for preenchido, a Instância de Campo (FieldInstance) do tipo document_folder vinculada não irá levá-lo em conta para se tornar VALID |
| bool | mustBeValid | | Se falso e o documento vinculado for inválido,a Instância de Campo (FieldInstance) do tipo document_folder vinculada não irá levá-lo em conta para se tornar VALID |
| int | daysBeforeDueToConsiderInvalid | opcional | É um número em dias a ser somado à dueDate do Documento da Organização (OrganizationDocument) vinculado para caracterizar esse item como ‘INVÁLIDO’. Obs. O Documento da Organização (OrganizationDocument) vinculado possui o seu próprio status e permanecerá VALID nesse caso. Ignorado caso não possua valor ou ele seja 0. |
| string | customDocumentTitle | opcional, 128 chars | Caso possua valor, é o título |
| string | customDocumentDescription | opcional, 8192 chars | Caso possua valor, é a descrição |
| enum | status | NEW, VALID, INVALID | É o status específico desta entidade. Mais informações em Funcionalidades - Documento da Organização na Instância de Campo |
| string | invalidReasons | opcional, 8192 chars | Caso o status seja inválido, é a mensagem que aparecerá com os motivos da invalidez. |
Restrições §
| Nome | Descrição | Chave única |
|---|
| fieldInstance - organizationDocument | Um OrganizationDocument so pode aparecer uma vez em uma FieldInstance. | fieldInstanceId, organizationDocumentId |
Vínculos §