2.0info: 1.2.0 Agenda description: Serviço responsável pelo módulo de Agenda do CRMX x-senior-domain: Gestão Relacionamento | CRMX x-senior-domain-path: crmx x-senior-service-path: schedule 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/crmxsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /schedule/queries/healthcheck: post: description: Healthcheck do serviço de exportação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/statusHealthcheckEnum description: Status geral do serviço checks: type: object allOf: – #/definitions/checkRecord description: Checagens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Healthcheck do serviço de exportação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/statusHealthcheckEnum description: Status geral do serviço checks: type: object allOf: – #/definitions/checkRecord description: Checagens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/queries/getRecurrencesByDate: post: description: Pegar recorrências por data tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getRecurrencesByDateFilterRecord responses: 200: description: Ok schema: type: object required: – dates – schedules properties: dates: type: array items: type: object allOf: – #/definitions/recurrenceDatesRecord minimum: 1 description: Datas das Recorrências schedules: type: array items: type: object allOf: – #/definitions/scheduleSummaryByDateRecord minimum: 1 description: Agendamentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/queries/generateRecurrenceDescription: post: description: Gerar descrição da recorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recurrenceDescriptionRecord responses: 200: description: Ok schema: type: object required: – description properties: description: type: string description: Descrição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/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 /schedule/queries/exportJobTitle: 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 /schedule/queries/exportCollaborator: 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 /schedule/queries/exportAccount: 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 /schedule/queries/exportAccountContact: 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 /schedule/queries/exportScheduleType: 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 /schedule/queries/exportSchedule: 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 /schedule/queries/exportScheduleRecurrence: 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 /schedule/queries/exportScheduleExternalParticipant: 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 /schedule/queries/exportScheduleParticipant: 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 /schedule/queries/exportScheduleParticipantRecurrence: 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 /schedule/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 /schedule/actions/acceptSchedule: post: description: Aceitar Recorrência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – scheduleId properties: scheduleId: type: string description: Identificador da Recorrência participantId: type: string description: Identificador do Participante date: type: string format: date description: Data da Recorrência responses: 200: description: Ok schema: type: object required: – accepted properties: accepted: type: boolean description: Indica se foi aceito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/actions/rejectSchedule: post: description: Rejeitar Recorrência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – scheduleId properties: scheduleId: type: string description: Identificador da Recorrência participantId: type: string description: Identificador do Participante date: type: string format: date description: Data da Recorrência responses: 200: description: Ok schema: type: object required: – rejected properties: rejected: type: boolean description: Indica se foi rejeitado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/actions/cancelSchedule: post: description: Cancelar Recorrência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – scheduleId properties: scheduleId: type: string description: Identificador da Recorrência date: type: string format: date description: Data da Recorrência responses: 200: description: Ok schema: type: object required: – accepted properties: accepted: type: boolean description: Indica se foi cancelado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/actions/importJobTitle: 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 /schedule/actions/importCollaborator: 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 /schedule/actions/importAccount: 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 /schedule/actions/importAccountContact: 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 /schedule/actions/importScheduleType: 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 /schedule/actions/importSchedule: 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 /schedule/actions/importScheduleRecurrence: 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 /schedule/actions/importScheduleExternalParticipant: 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 /schedule/actions/importScheduleParticipant: 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 /schedule/actions/importScheduleParticipantRecurrence: 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 /schedule/signals/manageScheduleParticipants: post: description: Gerenciar participants da agenda tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – scheduleId properties: scheduleId: type: string description: Identificador da Agenda accountsId: type: array items: type: string description: Contas accountContactsId: type: array items: type: string description: Contatos da Conta collaboratorsId: type: array items: type: string description: Colaboradores externalParticipantsId: type: array items: type: string description: Participantes Externos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /schedule/events/scheduleParticipantDeletedCustom: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – scheduleId – scheduleName – unlinkedAccountIds properties: scheduleId: type: string description: Identificador da Agenda scheduleName: type: string description: Nome da Agenda unlinkedAccountIds: type: array items: type: string minimum: 1 description: Contas desvinculadas das Agendas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /schedule/events/scheduleParticipantCreatedCustom: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – scheduleId – scheduleName – linkedAccountIds properties: scheduleId: type: string description: Identificador da Agenda scheduleName: type: string description: Nome da Agenda linkedAccountIds: type: array items: type: string minimum: 1 description: Contas vinculadas as Agendas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /schedule/events/importJobTitleEvent: 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 /schedule/events/exportJobTitleEvent: 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 /schedule/events/importCollaboratorEvent: 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 /schedule/events/exportCollaboratorEvent: 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 /schedule/events/importAccountEvent: 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 /schedule/events/exportAccountEvent: 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 /schedule/events/importAccountContactEvent: 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 /schedule/events/exportAccountContactEvent: 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 /schedule/events/importScheduleTypeEvent: 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 /schedule/events/exportScheduleTypeEvent: 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 /schedule/events/importScheduleEvent: 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 /schedule/events/exportScheduleEvent: 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 /schedule/events/importScheduleRecurrenceEvent: 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 /schedule/events/exportScheduleRecurrenceEvent: 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 /schedule/events/importScheduleExternalParticipantEvent: 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 /schedule/events/exportScheduleExternalParticipantEvent: 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 /schedule/events/importScheduleParticipantEvent: 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 /schedule/events/exportScheduleParticipantEvent: 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 /schedule/events/importScheduleParticipantRecurrenceEvent: 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 /schedule/events/exportScheduleParticipantRecurrenceEvent: 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 /schedule/entities/jobTitle: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/jobTitle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/jobTitle/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobTitle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/collaborator: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/collaborator 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/collaborator/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/collaborator 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/account: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/account/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/accountContact: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/accountContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/accountContact/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleType: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleType responses: 200: description: The created resource schema: #/definitions/scheduleType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleType responses: 200: description: The created resource schema: #/definitions/scheduleType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/scheduleType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleType/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editScheduleType responses: 200: description: Ok schema: #/definitions/editScheduleType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/scheduleType responses: 200: description: Ok schema: #/definitions/scheduleType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/scheduleType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /schedule/entities/scheduleType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/scheduleType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/schedule: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/schedule responses: 200: description: The created resource schema: #/definitions/schedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/schedule responses: 200: description: The created resource schema: #/definitions/schedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/schedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/schedule/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editSchedule responses: 200: description: Ok schema: #/definitions/editSchedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/schedule responses: 200: description: Ok schema: #/definitions/schedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/schedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /schedule/entities/schedule/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/schedule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleRecurrence: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleRecurrence responses: 200: description: The created resource schema: #/definitions/scheduleRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleRecurrence responses: 200: description: The created resource schema: #/definitions/scheduleRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/scheduleRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleRecurrence/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editScheduleRecurrence responses: 200: description: Ok schema: #/definitions/editScheduleRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/scheduleRecurrence responses: 200: description: Ok schema: #/definitions/scheduleRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/scheduleRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /schedule/entities/scheduleRecurrence/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/scheduleRecurrence responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleExternalParticipant: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleExternalParticipant responses: 200: description: The created resource schema: #/definitions/scheduleExternalParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleExternalParticipant responses: 200: description: The created resource schema: #/definitions/scheduleExternalParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/scheduleExternalParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleExternalParticipant/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editScheduleExternalParticipant responses: 200: description: Ok schema: #/definitions/editScheduleExternalParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/scheduleExternalParticipant responses: 200: description: Ok schema: #/definitions/scheduleExternalParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/scheduleExternalParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /schedule/entities/scheduleExternalParticipant/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/scheduleExternalParticipant responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleParticipant: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleParticipant responses: 200: description: The created resource schema: #/definitions/scheduleParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleParticipant responses: 200: description: The created resource schema: #/definitions/scheduleParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/scheduleParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleParticipant/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editScheduleParticipant responses: 200: description: Ok schema: #/definitions/editScheduleParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/scheduleParticipant responses: 200: description: Ok schema: #/definitions/scheduleParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/scheduleParticipant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /schedule/entities/scheduleParticipant/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/scheduleParticipant responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleParticipantRecurrence: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleParticipantRecurrence responses: 200: description: The created resource schema: #/definitions/scheduleParticipantRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduleParticipantRecurrence responses: 200: description: The created resource schema: #/definitions/scheduleParticipantRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/scheduleParticipantRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /schedule/entities/scheduleParticipantRecurrence/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editScheduleParticipantRecurrence responses: 200: description: Ok schema: #/definitions/editScheduleParticipantRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/scheduleParticipantRecurrence responses: 200: description: Ok schema: #/definitions/scheduleParticipantRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/scheduleParticipantRecurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /schedule/entities/scheduleParticipantRecurrence/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/scheduleParticipantRecurrence responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: statusHealthcheckEnum: type: string enum: – UP – DOWN description: UP ou DOWN: * `UP` – Up * `DOWN` – Down statusEnum: type: string enum: – ACTIVE – INACTIVE description: Situação: * `ACTIVE` – Ativo * `INACTIVE` – Inativo weekDayEnum: type: string enum: – SUNDAY – MONDAY – TUESDAY – WEDNESDAY – THURSDAY – FRIDAY – SATURDAY description: Dias da Semana: * `SUNDAY` – Domingo * `MONDAY` – Segunda * `TUESDAY` – Terça * `WEDNESDAY` – Quarta * `THURSDAY` – Quinta * `FRIDAY` – Sexta * `SATURDAY` – Sábado monthEnum: type: string enum: – JANUARY – FEBRUARY – MARCH – APRIL – MAY – JUNE – JULY – AUGUST – SEPTEMBER – OCTOBER – NOVEMBER – DECEMBER description: Meses: * `JANUARY` – Janeiro * `FEBRUARY` – Fevereiro * `MARCH` – Março * `APRIL` – Abril * `MAY` – Maio * `JUNE` – Junho * `JULY` – Julho * `AUGUST` – Agosto * `SEPTEMBER` – Setembro * `OCTOBER` – Outubro * `NOVEMBER` – Novembro * `DECEMBER` – Dezembro schedulePriorityEnum: type: string enum: – LOW – MEDIUM – HIGH – CRITICAL description: Prioridade da Agenda: * `LOW` – Baixa * `MEDIUM` – Média * `HIGH` – Alta * `CRITICAL` – Critica scheduleRecurrenceEnum: type: string enum: – DAILY – WEEKLY – MONTHLY – YEARLY description: Recorrência: * `DAILY` – Diária * `WEEKLY` – Semanal * `MONTHLY` – Mensal * `YEARLY` – Anual scheduleRepeatWhenEnum: type: string enum: – IN_DAY – IN_ORDINAL_WEEK_DAY description: Repetir Quando: * `IN_DAY` – No Dia * `IN_ORDINAL_WEEK_DAY` – No Dia Ordinal da Semana scheduleOrdinalWeekDayEnum: type: string enum: – FIRST – SECOND – THIRD – FOURTH – LAST description: Dia da semana ordinal: * `FIRST` – Primeiro * `SECOND` – Segunda * `THIRD` – Terceira * `FOURTH` – Quarta * `LAST` – Última typeTaskStatusEnum: type: string enum: – PENDING – IN_PROGRESS – DONE description: Tipo de status da tarefa: * `PENDING` – Pendente * `IN_PROGRESS` – Em andamento * `DONE` – Feito scheduleParticipantConfirmationEnum: type: string enum: – YES – PENDING – NO description: Confirmação: * `YES` – Sim * `PENDING` – Pendente * `NO` – Não userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkRecord: description: Checagens type: object required: – name – status properties: name: type: string description: Nome status: type: string allOf: – #/definitions/statusHealthcheckEnum description: Status getRecurrencesByDateFilterRecord: description: Filtro da query getRecurrencesByDate type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data de Início endDate: type: string format: date description: Data de Término organizer: type: boolean description: Organizador name: type: string description: Nome priority: type: string allOf: – #/definitions/schedulePriorityEnum description: Prioridade participant: type: object allOf: – #/definitions/scheduleParticipantRecord description: Participante scheduleType: type: object allOf: – #/definitions/scheduleTypeRecord description: Tipo scheduleParticipantRecord: description: Record da entidade scheduleParticipant type: object properties: id: type: string description: Identificador scheduleTypeRecord: description: Record da entidade scheduleType type: object properties: id: type: string description: Identificador recurrenceDatesRecord: description: Horários do Agendamento type: object required: – date – schedulesId properties: date: type: string format: date description: Data schedulesId: type: array items: type: string minimum: 1 description: Identificadores da Agenda scheduleSummaryByDateRecord: description: Resumo do agendamento por data type: object required: – id – name – scheduleType – withRecurrence – whenOccurs – allDay – priority – recurrences – participantOrganizer – currentParticipant properties: id: type: string description: Identificador name: type: string description: Nome scheduleType: type: object allOf: – #/definitions/scheduleType description: Tipo withRecurrence: type: boolean description: Com Recorrência whenOccurs: type: string description: Ocorre quando allDay: type: boolean description: Dia inteiro startTime: type: string description: Hora de Início endTime: type: string description: Hora de Término priority: type: string allOf: – #/definitions/schedulePriorityEnum description: Prioridade recurrences: type: array items: type: object allOf: – #/definitions/scheduleRecurrence minimum: 1 description: Participantes participantOrganizer: type: object allOf: – #/definitions/scheduleParticipant description: Participante Organizador currentParticipant: type: object allOf: – #/definitions/scheduleParticipant description: Participante Atual recurrenceDescriptionRecord: description: Agenda type: object required: – startDate – allDay – withRecurrence – recurrenceInterval – recurrence properties: startDate: type: string format: date description: Data de Início endDate: type: string format: date description: Data de Término startTime: type: string description: Hora de Inicio endTime: type: string description: Hora de Término allDay: type: boolean description: Dia inteiro withRecurrence: type: boolean description: Com Recorrência recurrenceInterval: type: integer format: int64 description: Intervalo minimum: 1 recurrence: type: string allOf: – #/definitions/scheduleRecurrenceEnum description: Recorrência weekDays: type: array items: type: string allOf: – #/definitions/weekDayEnum description: Dias da Semana repeatWhen: type: string allOf: – #/definitions/scheduleRepeatWhenEnum description: Repetir Quando repeatWhenDay: type: integer format: int64 description: Repetir no dia do mês minimum: 1 maximum: 31 repeatWhenOrdinalWeekDay: type: string allOf: – #/definitions/scheduleOrdinalWeekDayEnum description: Dia da Semana ordinal repeatWhenWeekMonth: type: string allOf: – #/definitions/weekDayEnum description: Semana do Mês repeatWhenMonth: type: string allOf: – #/definitions/monthEnum description: Repetir no mês jobTitle: description: Cargo type: object required: – name properties: id: type: string format: uuid description: Identificador name: type: string maxLength: 255 description: Nome createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: collaborator: description: Colaborador type: object required: – name – email – active – visible properties: id: type: string format: uuid description: Identificador name: type: string maxLength: 255 description: Nome email: type: string maxLength: 255 description: E-mail photo: type: string maxLength: 255 description: Foto active: type: boolean description: Ativo visible: type: boolean description: Visível consolidatedLevel: type: string maxLength: 255 description: Nível da Hierarquia jobTitle: type: object allOf: – #/definitions/jobTitle description: Cargo leader: type: object allOf: – #/definitions/collaborator description: Líder createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: account: description: Conta type: object required: – code – name – status properties: id: type: string format: uuid description: Identificador code: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Nome email: type: string description: E-mail status: type: string allOf: – #/definitions/statusEnum description: Situação createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: accountContact: description: Contatos da Conta type: object required: – account – name – status properties: id: type: string format: uuid description: Identificador account: type: object allOf: – #/definitions/account description: Conta name: type: string maxLength: 255 description: Nome email: type: string description: E-mail leader: type: object allOf: – #/definitions/accountContact description: Líder hierarchyLevel: type: string maxLength: 255 description: Nível Hierárquico jobTitle: type: object allOf: – #/definitions/jobTitle description: Cargo status: type: string allOf: – #/definitions/statusEnum description: Situação createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: scheduleType: description: Tipo de Agenda type: object required: – name – status properties: id: type: string format: uuid description: Identificador name: type: string maxLength: 255 description: Nome status: type: string allOf: – #/definitions/statusEnum description: Situação createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: editScheduleType: type: object required: – id allOf: – #/definitions/scheduleType schedule: description: Agenda type: object required: – name – priority – allDay – withRecurrence – startDate – recurrence properties: id: type: string format: uuid description: Identificador name: type: string maxLength: 255 description: Nome type: type: object allOf: – #/definitions/scheduleType description: Tipo priority: type: string allOf: – #/definitions/schedulePriorityEnum description: Prioridade allDay: type: boolean description: Dia inteiro withRecurrence: type: boolean description: Com Recorrência startDate: type: string format: date description: Data Inicial endDate: type: string format: date description: Data Final startTime: type: string description: Hora de inicio endTime: type: string description: Hora de término whenOccurs: type: string maxLength: 255 description: Ocorre quando recurrence: type: string allOf: – #/definitions/scheduleRecurrenceEnum description: Recorrência recurrenceInterval: type: integer format: int64 description: Intervalo de recorrência weekDays: type: array items: type: string allOf: – #/definitions/weekDayEnum description: Dias da Semana repeatWhen: type: string allOf: – #/definitions/scheduleRepeatWhenEnum description: Repetir Quando repeatWhenDay: type: integer format: int64 description: Repetir no dia do mês minimum: 1 maximum: 31 repeatWhenOrdinalWeekDay: type: string allOf: – #/definitions/scheduleOrdinalWeekDayEnum description: Dia da Semana ordinal repeatWhenWeekMonth: type: string allOf: – #/definitions/weekDayEnum description: Semana do Mês repeatWhenMonth: type: string allOf: – #/definitions/monthEnum description: Repetir no mês comments: type: string description: Observações createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: editSchedule: type: object required: – id allOf: – #/definitions/schedule scheduleRecurrence: description: Recorrência da Agenda type: object required: – schedule – atDate – canceled properties: id: type: string format: uuid description: Identificador schedule: type: object allOf: – #/definitions/schedule description: Agenda atDate: type: string format: date description: Data startTime: type: string description: Hora de inicio endTime: type: string description: Hora de término canceled: type: boolean description: Cancelada createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: editScheduleRecurrence: type: object required: – id allOf: – #/definitions/scheduleRecurrence scheduleExternalParticipant: description: Participantes externo da Agenda type: object required: – name properties: id: type: string format: uuid description: Identificador name: type: string maxLength: 255 description: Nome email: type: string description: E-mail comments: type: string description: Observações createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: editScheduleExternalParticipant: type: object required: – id allOf: – #/definitions/scheduleExternalParticipant scheduleParticipant: description: Participante da Agenda type: object required: – schedule – confirmation properties: id: type: string format: uuid description: Identificador schedule: type: object allOf: – #/definitions/schedule description: Agenda collaborator: type: object allOf: – #/definitions/collaborator description: Colaborador account: type: object allOf: – #/definitions/account description: Conta accountContact: type: object allOf: – #/definitions/accountContact description: Contato da Conta externalParticipant: type: object allOf: – #/definitions/scheduleExternalParticipant description: Externo atDate: type: string format: date description: Data sentIn: type: string format: date description: Enviado sentNote: type: string maxLength: 255 description: Observação do envio confirmedIn: type: string format: date description: Confirmado confirmation: type: string allOf: – #/definitions/scheduleParticipantConfirmationEnum description: Confirmação optional: type: boolean description: Opcional default: false organizer: type: boolean description: Organizador default: false createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: editScheduleParticipant: type: object required: – id allOf: – #/definitions/scheduleParticipant scheduleParticipantRecurrence: description: Participante da Agenda – Recorrência type: object required: – id – participant – confirmation properties: id: type: string format: uuid description: Identificador participant: type: object allOf: – #/definitions/scheduleParticipant description: Participante atDate: type: string format: date description: Data sentIn: type: string format: date description: Enviado sentNote: type: string maxLength: 255 description: Observação do envio confirmedIn: type: string format: date description: Confirmado confirmation: type: string allOf: – #/definitions/scheduleParticipantConfirmationEnum description: Confirmação createdBy: type: string description: createdAt: type: string format: date-time description: changedBy: type: string description: changedAt: type: string format: date-time description: editScheduleParticipantRecurrence: type: object required: – id allOf: – #/definitions/scheduleParticipantRecurrence 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage