2.0info: 4.1.2 custom_form description: Formulários personalizados x-senior-domain: bi x-senior-domain-path: bi x-senior-service-path: custom_form contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/bisecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /custom_form/queries/getFormData: post: description: Retorna os dados de uma linha do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId – dataId properties: formId: type: string description: ID do formulário fieldId: type: string description: ID do campo dataId: type: string description: Um dado específico ou todos responses: 200: description: Ok schema: type: object allOf: – #/definitions/formData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de uma linha do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: formId description: ID do formulário in: query required: true type: string – name: fieldId description: ID do campo in: query type: string – name: dataId description: Um dado específico ou todos in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/formData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/queries/listFormData: post: description: Retorna os dados de um formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId properties: formId: type: string description: ID do formulário fieldId: type: string description: ID do campo fieldValue: type: string description: Valor do campo dataId: type: string description: Um dado específico ou todos filter: type: string description: Filtro offset: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade de registros orderby: type: string description: Ordenação de registros responses: 200: description: Ok schema: type: object required: – formId – formName – formTitle – totalPages – totalElements – permissions – access properties: formId: type: string description: ID do formulário formName: type: string description: Nome do formulário formTitle: type: string description: Título do formulário customFieldsData: type: array items: type: object allOf: – #/definitions/customFieldData description: Estrutura dos campos customFieldRows: type: array items: type: object allOf: – #/definitions/customFieldRow description: Dados do formulário contents: type: array items: type: string format: byte description: Dados em formato padrão totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos permissions: type: string format: byte description: Permissões access: type: string format: byte description: Acesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de um formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: formId description: ID do formulário in: query required: true type: string – name: fieldId description: ID do campo in: query type: string – name: fieldValue description: Valor do campo in: query type: string – name: dataId description: Um dado específico ou todos in: query type: string – name: filter description: Filtro in: query type: string – name: offset description: Página in: query type: integer format: int64 – name: size description: Quantidade de registros in: query type: integer format: int64 – name: orderby description: Ordenação de registros in: query type: string responses: 200: description: Ok schema: type: object required: – formId – formName – formTitle – totalPages – totalElements – permissions – access properties: formId: type: string description: ID do formulário formName: type: string description: Nome do formulário formTitle: type: string description: Título do formulário customFieldsData: type: array items: type: object allOf: – #/definitions/customFieldData description: Estrutura dos campos customFieldRows: type: array items: type: object allOf: – #/definitions/customFieldRow description: Dados do formulário contents: type: array items: type: string format: byte description: Dados em formato padrão totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos permissions: type: string format: byte description: Permissões access: type: string format: byte description: Acesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/queries/exportCustomForm: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/actions/prepare: post: description: Prepara a base de dados com os data marts nativos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sai como uma resposta, successo = true or false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/actions/persistFormData: post: description: Persiste os dados de um formulários tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId – customFieldValues properties: formId: type: string description: ID do formulário fieldId: type: string description: ID do campo fieldValue: type: string description: Valor do campo dataId: type: string description: ID do dado customFieldValues: type: array items: type: object allOf: – #/definitions/customFieldValue minimum: 1 description: Nome datamart responses: 200: description: Ok schema: type: object allOf: – #/definitions/formData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/actions/deleteFormData: post: description: Prepara a base de dados com os data marts nativos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId – dataId properties: formId: type: string description: ID do formulário fieldId: type: string description: ID do campo dataId: type: string description: Um dado específico ou todos responses: 200: description: Ok schema: type: object required: – rows properties: rows: type: integer format: int64 description: Linhas removidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/actions/migrateFromG5: post: description: Importa formulário customizados da base G5 tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tablesNames properties: tablesNames: type: array items: type: string minimum: 1 description: Nomes dos data marts a importar overrideCustomForms: type: boolean description: Substituir os formularios default: false ignorePk: type: boolean description: Não cria a coluna ID como PK default: false responses: 200: description: Ok schema: type: object required: – success – formCount properties: success: type: boolean description: Sai como uma resposta, successo = true or false formCount: type: integer format: int64 description: Quantidade de data marts importados customForm: type: array items: type: object allOf: – #/definitions/customForm description: Formulários importados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/actions/exporCF: post: description: Exportar formulários tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId properties: formId: type: string description: Identificador do formulário a exportar withData: type: boolean description: Incluir dados default: false responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/actions/importCFPrepare: post: description: Preparar importação de formulário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – id – url – version properties: id: type: string description: ID url: type: string description: URL para upload do arquivo type: string description: Versão da URL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/actions/importCF: post: description: Executar importação de formulário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – version properties: id: type: string description: ID type: string description: Versão da URL canRename: type: boolean description: Aceitar renomear em caso de duplicidade default: true recreate: type: boolean description: Recriar tabelas no banco default: false ignorePk: type: boolean description: Não cria a coluna ID como PK default: false responses: 200: description: Ok schema: type: object required: – datamartId properties: datamartId: type: string description: Identificador do formulário importado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/actions/importCustomForm: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/events/importCustomFormEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /custom_form/events/exportCustomFormEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /custom_form/events/importCustomFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /custom_form/events/exportCustomFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /custom_form/events/importExecutionCommandEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /custom_form/events/exportExecutionCommandEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /custom_form/entities/customForm: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customForm responses: 200: description: The created resource schema: #/definitions/customForm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customForm responses: 200: description: The created resource schema: #/definitions/customForm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/customForm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/customForm/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customForm responses: 200: description: Ok schema: #/definitions/customForm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customForm responses: 200: description: Ok schema: #/definitions/customForm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/customForm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/customForm/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/customForm responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/customField: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customField responses: 200: description: The created resource schema: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customField responses: 200: description: The created resource schema: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/customField/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customField responses: 200: description: Ok schema: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customField responses: 200: description: Ok schema: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/customForm/{parentId}/customFields: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/customField responses: 200: description: The created resources schema: type: array items: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/customField responses: 200: description: The created resources schema: type: array items: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/customForm/{parentId}/customFields/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customField responses: 200: description: Ok schema: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customField responses: 200: description: Ok schema: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/customField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/customField/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/customField responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/executionCommand: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/executionCommand responses: 200: description: The created resource schema: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/executionCommand responses: 200: description: The created resource schema: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/executionCommand/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/executionCommand responses: 200: description: Ok schema: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/executionCommand responses: 200: description: Ok schema: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/customForm/{parentId}/executionCommands: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/executionCommand responses: 200: description: The created resources schema: type: array items: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/executionCommand responses: 200: description: The created resources schema: type: array items: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/customForm/{parentId}/executionCommands/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/executionCommand responses: 200: description: Ok schema: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/executionCommand responses: 200: description: Ok schema: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/executionCommand 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /custom_form/entities/executionCommand/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/executionCommand responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: fieldTypeDef: description: Tipo de execução da atualização type: string enum: – UUID – String – Boolean – Integer – Double – Date – DateTime – TextArea – Lookup – Detail whenExecute: description: Definição de quando um comando deve ser executado type: string enum: – BeforeInsert – AfterInsert – BeforeUpdate – AfterUpdate – BeforeDelete – AfterDelete userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR formData: description: Dados de um formulário type: object required: – formId – formName – formTitle – dataId – contents – permissions – access properties: formId: type: string description: ID do formulário formName: type: string description: Nome do formulário formTitle: type: string description: Título do formulário dataId: type: string description: ID do dado customFieldsData: type: array items: type: object allOf: – #/definitions/customFieldData description: Estrutura dos campos customFieldValues: type: array items: type: object allOf: – #/definitions/customFieldValue description: Dados do formulário contents: type: string format: byte description: Dados em formato padrão permissions: type: string format: byte description: Permissões access: type: string format: byte description: Acesso customFieldData: description: Dados do campo type: object required: – fieldId – order – name – label – type – required – hidden – readOnly properties: fieldId: type: string description: ID do campo order: type: integer format: int64 description: Ordem do campo no formulário minimum: 0 name: type: string description: Nome do campo label: type: string description: Rótulo do campo type: type: string allOf: – #/definitions/fieldTypeDef description: Tipo do campo required: type: boolean description: Campo requerido hidden: type: boolean description: Campo oculto readOnly: type: boolean description: Campo somente leitura size: type: number format: double description: Tamanho do campo minimum: -1 originFormName: type: string description: Formulário de origem originFieldName: type: string description: Campo de origem displayFieldName: type: string description: Campo de exibição customFieldValue: description: Dados do campo type: object required: – name – value properties: name: type: string description: Nome do campo value: type: string description: Valor do campo customFieldRow: description: Linha de dados type: object properties: customFieldValues: type: array items: type: object allOf: – #/definitions/customFieldValue description: Dados do formulário customForm: description: Formulário cutomizado type: object required: – name – title – tableName – folder properties: id: type: string format: uuid description: PK name: type: string maxLength: 255 description: Nome do formulário type: string maxLength: 255 description: Título do formulário x-i18n: true description: type: string maxLength: 1000 description: Descrição x-i18n: true tableName: type: string maxLength: 255 description: Nome da tabela folder: type: string maxLength: 255 description: Caminho do Menu para o formulário. customFields: type: array items: type: object allOf: – #/definitions/customField description: Campos executionCommands: type: array items: type: object allOf: – #/definitions/executionCommand description: Comandos dropTable: type: boolean description: Apagar tabela ao salvar default: true migrated: type: boolean description: Formulário migrado default: false ignorePk: type: boolean description: Não cria a coluna ID como PK default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: type: string maxLength: 255 description: type: string maxLength: 1000 example: pt-BR: Exemplo de texto usando locale pt-BR.description: Exemplo de texto usando locale pt-BR. en-US: Text example using en-US locale.description: Text example using en-US locale. customField: description: Campo de formulário cutomizado type: object required: – order – name – fieldLabel – type – required – hidden properties: id: type: string format: uuid description: PK customForm: type: object allOf: – #/definitions/customForm description: Formulário order: type: integer format: int64 description: Ordem do campo no formulário minimum: 0 name: type: string maxLength: 255 description: Nome do campo fieldLabel: type: string maxLength: 255 description: Rótulo do campo x-i18n: true type: type: string allOf: – #/definitions/fieldTypeDef description: Tipo do campo. required: type: boolean description: Campo requerido hidden: type: boolean description: Campo oculto readOnly: type: boolean description: Campo somente leitura default: false size: type: number format: double description: Tamanho do campo minimum: -1 originForm: type: object allOf: – #/definitions/customForm description: Formulário de origem originField: type: object allOf: – #/definitions/customField description: Campo de origem displayField: type: object allOf: – #/definitions/customField description: Campo de exibição persisted: type: boolean description: Campo criado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: fieldLabel: type: string maxLength: 255 example: pt-BR: fieldLabel: Exemplo de texto usando locale pt-BR. en-US: fieldLabel: Text example using en-US locale. executionCommand: description: Comando a ser executado sobre os dados do formulário type: object required: – name – whenExecute – commandSQL properties: id: type: string format: uuid description: PK customForm: type: object allOf: – #/definitions/customForm description: Formulário name: type: string maxLength: 255 description: Nome do comando whenExecute: type: string allOf: – #/definitions/whenExecute description: Em que momento o comando deve ser executado commandSQL: type: string description: Select de carga createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE