Mais pesquisados:Customização, Tutorial, Documentação

scheduler

391 views 0 12/11/2018 Atualizado em 17/06/2025 integrador

2.0info: 3.15.14 scheduler description: Serviço responsável pelo agendamento e execução de tarefas (Jobs).\nEle permite a criação, configuração, monitoramento e execução de processos\nque precisam ocorrer em horários específicos ou de forma recorrente.\nEste serviço é crucial para automatizar rotinas e otimizar operações na plataforma.\nExemplos de uso incluem a emissão de relatórios periódicos, sincronização de dados\nou execução de cálculos em batch. x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: scheduler 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/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /scheduler/queries/healthcheck: post: description: Query destinada à equipe de SRE (Site Reliability Engineering) ou administradores\npara verificar a disponibilidade e saúde operacional do serviço de agendamento.\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query destinada à equipe de SRE (Site Reliability Engineering) ou administradores\npara verificar a disponibilidade e saúde operacional do serviço de agendamento.\n tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /scheduler/queries/listJobByTag: post: description: Lista Jobs (tarefas agendadas) filtrando-os com base em um conjunto de tags.\nUm Job será incluído no resultado se possuir pelo menos uma das tags fornecidas na lista de entrada.\nSuporta paginação para lidar com um grande número de Jobs.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tags properties: tags: type: array items: type: string maxLength: 255 minimum: 1 description: Lista de tags a serem usadas como critério de filtro. Jobs com qualquer uma destas tags serão retornados. page: type: integer format: int64 description: Índice da página a ser retornada, iniciando em 0 (zero). Se omitido, assume o padrão do sistema. size: type: integer format: int64 description: Número de Jobs a serem retornados por página. Se omitido, assume o padrão do sistema. responses: 200: description: Ok schema: type: object required: – jobs – total properties: jobs: type: array items: type: object allOf: – #/definitions/job minimum: 1 description: Lista dos Jobs que correspondem aos critérios de filtro e paginação. total: type: integer format: int64 description: Número total de Jobs encontrados que correspondem às tags fornecidas, desconsiderando a paginação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /scheduler/queries/searchJobs: post: description: API DEPRECIADA: Este endpoint está obsoleto. Para uma funcionalidade mais completa e atualizada, utilize platform/scheduler/listJobs. | DATA: 2024-05-29 | (Depreciado desde 2024-05-29) Realiza uma busca por Jobs com base em um termo.\nA busca é efetuada na descrição do Job e em suas tags associadas.\nRecomenda-se utilizar a query platform/scheduler/listJobs para funcionalidades de listagem e filtro mais robustas.\n tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – searchTerm properties: searchTerm: type: string maxLength: 255 description: Termo de texto que será usado para buscar Jobs. A busca ocorre nos campos de descrição e tags. page: type: integer format: int64 description: Índice da página a ser retornada. Opcional; se omitido, pode retornar todos os resultados ou uma página padrão. size: type: integer format: int64 description: Tamanho da página (quantidade de Jobs por página). responses: 200: description: Ok schema: type: object required: – jobs – total properties: jobs: type: array items: type: object allOf: – #/definitions/job minimum: 1 description: Lista dos Jobs encontrados que correspondem ao termo de busca e aos parâmetros de paginação. total: type: integer format: int64 description: Número total de Jobs encontrados que correspondem ao termo de busca, antes da aplicação da paginação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Este endpoint está obsoleto. Para uma funcionalidade mais completa e atualizada, utilize platform/scheduler/listJobs. | DATA: 2024-05-29 | (Depreciado desde 2024-05-29) Realiza uma busca por Jobs com base em um termo.\nA busca é efetuada na descrição do Job e em suas tags associadas.\nRecomenda-se utilizar a query platform/scheduler/listJobs para funcionalidades de listagem e filtro mais robustas.\n tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: searchTerm description: Termo de texto que será usado para buscar Jobs. A busca ocorre nos campos de descrição e tags. in: query required: true type: string maxLength: 255 – name: page description: Índice da página a ser retornada. Opcional; se omitido, pode retornar todos os resultados ou uma página padrão. in: query type: integer format: int64 – name: size description: Tamanho da página (quantidade de Jobs por página). in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – jobs – total properties: jobs: type: array items: type: object allOf: – #/definitions/job minimum: 1 description: Lista dos Jobs encontrados que correspondem ao termo de busca e aos parâmetros de paginação. total: type: integer format: int64 description: Número total de Jobs encontrados que correspondem ao termo de busca, antes da aplicação da paginação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /scheduler/queries/getExecutionHistory: post: description: Recupera a lista de execuções já finalizadas de Jobs agendados.\nPermite filtrar os resultados por uma lista de IDs de Job, um termo de busca\n(que será aplicado à descrição e tags dos Jobs correspondentes) e/ou pelo status da execução.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – size properties: page: type: integer format: int64 description: Número da página a ser recuperada (base 0). size: type: integer format: int64 description: Quantidade de registros de execução por página. jobIds: type: array items: type: string maxLength: 255 description: Lista opcional de identificadores de Job para filtrar o histórico. Serão retornadas execuções apenas destes Jobs. searchTerm: type: string maxLength: 255 description: Termo opcional para filtrar pela descrição e tags dos Jobs associados às execuções. status: type: string allOf: – #/definitions/executionStatus description: Status opcional para filtrar as execuções (ex: Success para ver apenas execuções bem-sucedidas). responses: 200: description: Ok schema: type: object required: – executions – total properties: executions: type: array items: type: object allOf: – #/definitions/execution minimum: 1 description: Lista das execuções encontradas que correspondem aos critérios de filtro e paginação. total: type: integer format: int64 description: Número total de execuções encontradas para os filtros aplicados, desconsiderando a paginação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /scheduler/queries/listJobs: post: description: Lista os Jobs agendados com opções de paginação e filtros.\nPermite filtrar por um termo de busca na descrição do Job,\npelo nome do domínio e/ou pelo nome do serviço da primitiva associada ao Job.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Número da página a ser retornada. O valor padrão é 0. default: 0 size: type: integer format: int64 description: Tamanho da página (quantidade de Jobs por página). O valor padrão é 10. default: 10 searchTerm: type: string maxLength: 255 description: Termo de busca opcional para filtrar na descrição dos Jobs. domainName: type: string maxLength: 255 description: Nome do domínio opcional para filtrar Jobs que pertencem a este domínio. serviceName: type: string maxLength: 255 description: Nome do serviço opcional para filtrar Jobs que pertencem a este serviço. responses: 200: description: Ok schema: type: object required: – jobs – listInformation properties: jobs: type: array items: type: object allOf: – #/definitions/jobDto minimum: 1 description: Lista de Jobs (no formato DTO) que correspondem aos critérios de filtro e paginação. listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre a paginação dos resultados, como total de páginas e total de elementos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os Jobs agendados com opções de paginação e filtros.\nPermite filtrar por um termo de busca na descrição do Job,\npelo nome do domínio e/ou pelo nome do serviço da primitiva associada ao Job.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página a ser retornada. O valor padrão é 0. in: query type: integer format: int64 – name: size description: Tamanho da página (quantidade de Jobs por página). O valor padrão é 10. in: query type: integer format: int64 – name: searchTerm description: Termo de busca opcional para filtrar na descrição dos Jobs. in: query type: string maxLength: 255 – name: domainName description: Nome do domínio opcional para filtrar Jobs que pertencem a este domínio. in: query type: string maxLength: 255 – name: serviceName description: Nome do serviço opcional para filtrar Jobs que pertencem a este serviço. in: query type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – jobs – listInformation properties: jobs: type: array items: type: object allOf: – #/definitions/jobDto minimum: 1 description: Lista de Jobs (no formato DTO) que correspondem aos critérios de filtro e paginação. listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre a paginação dos resultados, como total de páginas e total de elementos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /scheduler/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 maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 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 maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /scheduler/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 /scheduler/actions/toggleActive: post: description: Ativa ou desativa a execução de um Job agendado.\nUm Job marcado como inativo não será disparado pelo scheduler,\nmesmo que seu horário de agendamento programado seja atingido.\nEsta ação permite controlar o ciclo de vida operacional de um Job.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – active properties: id: type: string maxLength: 255 description: Identificador único do Job cujo estado de ativação será modificado. active: type: boolean description: O novo estado de ativação para o Job (true para ativar, false para desativar). responses: 200: description: Ok schema: type: object required: – previousState properties: previousState: type: boolean description: O estado de ativação anterior do Job, antes da execução desta ação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /scheduler/signals/handleJobResponse: post: description: Processa a resposta (retorno) da execução de uma primitiva que foi disparada por um Job.\nEste sinal é para uso interno do sistema de agendamento. É utilizado para atualizar o status da execução do Job.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – isError – content properties: isError: type: boolean description: Indica se a execução da primitiva resultou em erro (true) ou sucesso (false). content: type: string maxLength: 255 description: Conteúdo da resposta da primitiva. Em caso de sucesso, usualmente um JSON. Em caso de erro, uma mensagem de erro. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /scheduler/events/jobScheduled: post: description: Evento publicado para notificar que um Job foi agendado no sistema.\nIsso ocorre quando um novo Job é criado ou quando um Job existente é\natualizado e, como resultado, (re)agendado para execução.\n x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – jobId – jobDescription properties: jobId: type: string maxLength: 255 description: Identificador único do Job que foi agendado. jobDescription: type: string maxLength: 255 description: Descrição do Job que foi agendado, para facilitar a identificação. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /scheduler/events/jobDeleted: post: description: Evento publicado para notificar que um Job foi excluído do sistema de agendamento.\n x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – jobId properties: jobId: type: string maxLength: 255 description: Identificador único do Job que foi excluído. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /scheduler/events/scheduleDone: post: description: Evento publicado para notificar que um agendamento (Schedule) específico\nconcluiu todas as suas repetições programadas ou atingiu sua data/hora de término definida.\n x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – jobId properties: jobId: type: string maxLength: 255 description: Identificador único do Job cujo Schedule foi marcado como concluído. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /scheduler/entities/job: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/job responses: 200: description: The created resource schema: #/definitions/job 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/job responses: 200: description: The created resource schema: #/definitions/job 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/job 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /scheduler/entities/job/{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/editJob responses: 200: description: Ok schema: #/definitions/editJob 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/job responses: 200: description: Ok schema: #/definitions/job 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/job 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 /scheduler/entities/job/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/job responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: executionStatus: description: Enumera os possíveis status de finalização de uma execução de Job.\n- Success: Indica que a tarefa agendada foi executada com êxito.\n- Error: Indica que ocorreu uma falha durante a execução da tarefa agendada.\n type: string enum: – Success – Error primitiveType: description: Define o tipo da primitiva (endpoint do serviço) que será executada pelo Job.\nEsta informação é geralmente obtida dos metadados do serviço ao qual a primitiva pertence.\n- ACTION: Representa uma primitiva que executa uma ação e tipicamente retorna uma resposta.\n- LIST: Representa uma primitiva que realiza uma consulta e retorna uma coleção de dados.\n- SIGNAL: Representa uma primitiva que envia uma mensagem (sinal) e não espera uma resposta direta.\n type: string enum: – ACTION – LIST – SIGNAL upDown: description: Enumera o estado de disponibilidade de um serviço ou componente.\nUtilizado principalmente na query healthcheck.\n- UP: Indica que o serviço ou componente está operacional e respondendo normalmente.\n- DOWN: Indica que o serviço ou componente está indisponível ou apresentando falhas.\n type: string enum: – UP – DOWN 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 schedule: description: Representa a configuração de agendamento para um Job.\nPode definir uma execução única em um momento específico ou uma série de\nexecuções recorrentes baseadas em um período.\n type: object required: – start properties: start: type: string format: date-time description: Data e hora (em formato UTC 0) em que a execução deste agendamento deve iniciar.\nSe o agendamento não for recorrente (ou seja, period não for definido),\nesta será a única data e hora de execução.\n period: type: object allOf: – #/definitions/period description: Define o período e a frequência de repetição para agendamentos recorrentes.\nEste campo é opcional; se não for informado, o Job será executado apenas uma vez na data/hora start.\n timezoneOffset: type: integer format: int64 description: Deslocamento de fuso horário em relação ao UTC, expresso em horas (ex: -3 para Brasília, 2 para UTC+2).\nEste valor é utilizado para calcular corretamente as repetições do period\nconsiderando o fuso horário desejado. O valor deve estar entre -12 e 12.\n minimum: -12 maximum: 12 period: description: Define o período de repetição para um agendamento (Schedule).\nCada campo é opcional e, quando presente, contribui para definir a recorrência\n(diária, mensal, etc.). Os campos suportam expressões no formato Cron,\npermitindo repetições como a cada n unidades (ex: para a cada 5 minutos).\n type: object properties: repetitions: type: integer format: int64 description: Número de vezes que este período de agendamento deve se repetir.\nEste valor é ignorado se o campo end (data de término da repetição) for informado.\n end: type: string format: date-time description: Data e hora em que este período de repetição deve parar de ser executado.\nSe informado, o valor de repetitions é ignorado.\n minute: type: string maxLength: 255 description: O minuto da hora (valores de 0 a 59) em que o Job deve executar.\nSe não especificado, o padrão é 0 (no início da hora). Suporta expressões Cron.\n hour: type: string maxLength: 255 description: A hora do dia (valores de 0 a 23) em que o Job deve executar.\nSe não especificado, o padrão é 0 (meia-noite). Suporta expressões Cron.\n dayOfMonth: type: string maxLength: 255 description: O dia do mês (valores de 1 a 31) para execução. Usado para agendamentos mensais.\nSuporta expressões Cron.\n month: type: string maxLength: 255 description: O mês do ano (valores de 1 a 12) para execução.\nSuporta expressões Cron.\n dayOfWeek: type: string maxLength: 255 description: O dia da semana para execução (valores de 0 a 6, onde 0 representa Domingo).\nSuporta expressões Cron.\n log: description: Registro de auditoria para modificações em entidades dentro do serviço de agendamento,\ncomo a criação ou atualização de um Job. Captura quem fez a alteração e quando.\n type: object required: – user – when properties: user: type: string maxLength: 255 description: Identificador do usuário ou sistema que realizou a alteração. when: type: string format: date-time description: Data e hora em que a alteração ocorreu. execution: description: Representa o status e os detalhes de uma execução passada de um Job agendado.\nContém informações cruciais para o monitoramento e diagnóstico de Jobs.\n type: object required: – id – job – status – start – finish – duration – response properties: id: type: string maxLength: 255 description: Identificador único desta instância de execução do Job. job: type: object allOf: – #/definitions/jobHeader description: Informações de cabeçalho (resumidas) do Job que foi executado. status: type: string allOf: – #/definitions/executionStatus description: Status final da execução (Success ou Error). start: type: string format: date-time description: Data e hora em que a execução do Job foi efetivamente iniciada. finish: type: string format: date-time description: Data e hora em que a execução do Job foi concluída (com sucesso ou erro). duration: type: integer format: int64 description: Duração total da execução do Job, medida em segundos. response: type: string maxLength: 255 description: Resposta (payload) retornada pela primitiva que foi executada.\nEm caso de sucesso, geralmente é um JSON. Em caso de erro, pode conter uma mensagem de erro. jobHeader: description: Representação concisa (cabeçalho) de um Job agendado.\nUtilizada em listagens ou em contextos onde apenas informações básicas do Job são necessárias,\nevitando o carregamento de todos os detalhes (como payload completo ou scripts).\n type: object required: – id – description – primitiveDomain – primitiveService – primitiveName – active properties: id: type: string maxLength: 255 description: Identificador único do Job. description: type: string maxLength: 255 description: Descrição textual do Job, para fácil identificação e entendimento. primitiveDomain: type: string maxLength: 255 description: Domínio ao qual a primitiva (endpoint) a ser executada pertence. primitiveService: type: string maxLength: 255 description: Serviço ao qual a primitiva (endpoint) a ser executada pertence. primitiveName: type: string maxLength: 255 description: Nome da primitiva (endpoint) que o Job está configurado para executar. primitiveVersion: type: integer format: int64 description: Versão da primitiva a ser executada (opcional). Se não especificada, a versão padrão ou mais recente pode ser utilizada. active: type: boolean description: Indica se o Job está atualmente ativo (true) e, portanto, elegível para execução, ou inativo (false). checkData: description: Estrutura para armazenar os dados de uma verificação de saúde específica,\ncomo parte da resposta da query healthcheck.\n type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome descritivo da verificação realizada (ex: database_connection, message_broker_ping). status: type: string allOf: – #/definitions/upDown description: Status da verificação (UP se o componente está saudável, DOWN caso contrário). jobDto: description: Data Transfer Object (DTO) que representa um Job agendado.\nUtilizado principalmente como tipo de retorno na primitiva listJobs.\nContém os campos essenciais de um Job para listagem e visualização.\n type: object required: – id – description – primitiveDomain – primitiveService – primitiveName – primitiveType properties: id: type: string maxLength: 255 description: Identificador único do Job. description: type: string maxLength: 100 description: Descrição textual do Job. primitiveDomain: type: string maxLength: 255 description: Domínio da primitiva que o Job executa. primitiveService: type: string maxLength: 255 description: Serviço da primitiva que o Job executa. primitiveName: type: string maxLength: 255 description: Nome da primitiva que o Job executa. primitiveVersion: type: integer format: int64 description: Versão da primitiva a ser executada (opcional). payloadContent: type: string maxLength: 50000 description: Payload de entrada (JSON fixo) para a execução da primitiva.\nEste campo é usado se o payload não for gerado dinamicamente por um script.\n payloadScript: type: string maxLength: 50000 description: Script (JavaScript) que gera o payload (JSON) para a execução da primitiva.\nO script deve retornar uma string JSON válida.\n active: type: boolean description: Indica se o Job está ativo e, portanto, elegível para execução.\n tags: type: array items: type: string maxLength: 255 description: Lista de tags (strings) para classificar e facilitar a busca do Job.\n schedule: type: object allOf: – #/definitions/schedule description: Informações de agendamento (data de início, período de repetição) para este Job.\n created: type: object allOf: – #/definitions/log description: Log de informações sobre a criação do Job (usuário e data/hora).\n updated: type: object allOf: – #/definitions/log description: Log de informações sobre a última modificação do Job, se houver.\n primitiveType: type: string allOf: – #/definitions/primitiveType description: O tipo da primitiva a ser executada.\n immutable: type: boolean description: Indica se o Job não pode ser atualizado após a criação.\nO valor padrão é false (ou seja, o Job é mutável por padrão).\n default: false factory: type: boolean description: Indica se o Job é um agendamento de fábrica, com restrições de manipulação.\nO valor padrão é false.\n default: false listInformation: description: Estrutura para fornecer informações sobre a paginação dos resultados de uma lista.\nUsado em conjunto com a primitiva listJobs.\n type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Número total de páginas disponíveis para os critérios de listagem. totalElements: type: integer format: int64 description: Número total de elementos (Jobs) encontrados para os critérios de listagem, desconsiderando a paginação. job: description: Define a entidade persistente para um Job agendado.\nEsta entidade armazena todas as informações necessárias para\na configuração, execução e gerenciamento de uma tarefa agendada.\nÉ marcada como fixed, indicando que sua estrutura é estável.\n type: object required: – id – description – primitiveDomain – primitiveService – primitiveName – primitiveType properties: id: type: string maxLength: 255 description: Identificador único do Job. Chave primária da entidade. description: type: string maxLength: 100 description: Descrição textual do Job, para fácil identificação. primitiveDomain: type: string maxLength: 64 description: Domínio da primitiva a ser executada. primitiveService: type: string maxLength: 64 description: Serviço da primitiva a ser executada. primitiveName: type: string maxLength: 255 description: Nome da primitiva (endpoint) a ser executada. primitiveVersion: type: integer format: int64 description: Versão da primitiva a ser executada (opcional). Permite direcionar a execução para uma versão específica da API. payloadContent: type: string maxLength: 50000 description: Conteúdo do payload em formato JSON fixo a ser enviado para a primitiva.\nUsado quando o payload é estático. Exclusivo com payloadScript.\n payloadScript: type: string maxLength: 50000 description: Script Javascript que gera dinamicamente o conteúdo do payload em formato JSON.\nO script deve retornar uma string JSON válida. Exclusivo com payloadContent.\n active: type: boolean description: Indica se o Job está ativo e deve ser considerado para execução pelo scheduler.\n tags: type: array items: type: string maxLength: 255 description: Lista de tags para categorização e busca facilitada do Job.\n schedule: type: object allOf: – #/definitions/schedule description: Configuração de agendamento para este Job (data de início, recorrência).\nSe não fornecido, o Job pode não ser executável ou requerer disparo manual (não suportado diretamente por esta SDL).\n created: type: object allOf: – #/definitions/log description: Informações de auditoria sobre a criação do Job (quem criou e quando).\n updated: type: object allOf: – #/definitions/log description: Informações de auditoria sobre a última atualização do Job (quem atualizou e quando), se houver.\n primitiveType: type: string allOf: – #/definitions/primitiveType description: Define o tipo da primitiva a ser executada.\nImportante para determinar como o scheduler interage com a primitiva (ex: esperar resposta).\n immutable: type: boolean description: Indica se o Job é imutável após sua criação. Se true, alterações subsequentes (exceto active) são prevenidas.\nO valor padrão é false (mutável).\n default: false factory: type: boolean description: Indica se o Job é um agendamento de fábrica, geralmente pré-configurado e com restrições de manipulação\n(ex: apenas o tenant master pode alterar/excluir).\nO valor padrão é false.\n default: false editJob: type: object required: – id allOf: – #/definitions/job 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 maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 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 maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 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 maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação