2.0info: 0.2.0 Serviço de logs HCM. /bridge/rest/hcm – application/json – application/jsonpaths: /logging/queries/searchLogs: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca os logs que estão entre as datas. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – initDate – finalDate properties: initDate: type: string format: date-time description: Data inicio para filtragem. finalDate: type: string format: date-time description: Data final para filtragem. page: type: integer format: int64 description: Página a buscar(Iniando em 0) size: type: integer format: int64 description: Tamanho da página responses: 200: description: Ok schema: type: object required: – logs – totalSize properties: logs: type: array items: type: object allOf: – #/definitions/auditingLog minimum: 1 description: Lista de logs retornados. totalSize: type: integer format: int64 description: Quantidade total de registros. default: description: Error response schema: #/definitions/genericError get: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca os logs que estão entre as datas. tags: – Queries parameters: – name: initDate in: query required: true type: string format: date-time – name: finalDate in: query required: true type: string format: date-time – name: page in: query type: integer format: int64 – name: size in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – logs – totalSize properties: logs: type: array items: type: object allOf: – #/definitions/auditingLog minimum: 1 description: Lista de logs retornados. totalSize: type: integer format: int64 description: Quantidade total de registros. default: description: Error response schema: #/definitions/genericError /logging/queries/searchLogsByTable: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca os logs que estão entre as datas. tags: – Queries parameters: – name: input in: body required: true schema: type: object required: – initDate – finalDate – tableName properties: initDate: type: string format: date-time description: Data inicio para filtragem. finalDate: type: string format: date-time description: Data final para filtragem. tableName: type: string description: Nome da tabela page: type: integer format: int64 description: Página a buscar(Iniando em 0) size: type: integer format: int64 description: Tamanho da página responses: 200: description: Ok schema: type: object required: – logs – totalSize properties: logs: type: array items: type: object allOf: – #/definitions/auditingLog minimum: 1 description: Lista de logs retornados. totalSize: type: integer format: int64 description: Quantidade total de registros. default: description: Error response schema: #/definitions/genericError get: description: Warning: this operation is private and may have its behavior changed at any time without notice. Busca os logs que estão entre as datas. tags: – Queries parameters: – name: initDate in: query required: true type: string format: date-time – name: finalDate in: query required: true type: string format: date-time – name: tableName in: query required: true type: string – name: page in: query type: integer format: int64 – name: size in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – logs – totalSize properties: logs: type: array items: type: object allOf: – #/definitions/auditingLog minimum: 1 description: Lista de logs retornados. totalSize: type: integer format: int64 description: Quantidade total de registros. default: description: Error response schema: #/definitions/genericError /logging/queries/getMetadata: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: Warning: this operation is private and may have its behavior changed at any time without notice. Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries parameters: – name: metadataFormat in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /logging/queries/exportAuditingLog: post: description: This operation is public. tags: – Queries 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: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. tags: – Queries parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /logging/queries/getDependencies: post: description: This operation is public. Returns a list with all dependencies from this service, along with their respective versions tags: – Queries 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 default: description: Error response schema: #/definitions/genericError get: description: This operation is public. Returns a list with all dependencies from this service, along with their respective versions tags: – Queries 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 default: description: Error response schema: #/definitions/genericError /logging/actions/importAuditingLog: post: description: This operation is public. tags: – Actions 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: default: description: Error response schema: #/definitions/genericError /logging/signals/addAuditingLog: post: description: Warning: this operation is private and may have its behavior changed at any time without notice. Inclui um novo log de auditoria tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/auditingLog responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /logging/entities/auditingLog: post: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/auditingLog responses: 201: description: Ok headers: Location: description: The created resource type: string default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/auditingLog responses: 200: description: The created resource schema: #/definitions/auditingLog default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/auditingLog default: description: Error response schema: #/definitions/genericError /logging/entities/auditingLog/{id}: put: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/auditingLog responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/auditingLog responses: 200: description: Ok schema: #/definitions/auditingLog default: description: Error response schema: #/definitions/genericError get: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/auditingLog default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError definitions: userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR auditingLog: description: Representa os logs do HCM. type: object required: – userName – remoteAddr – dateWhen – operation – tableName – alteredFields – originalValues – newValues properties: id: type: string maxLength: 32 description: Identificador do log. userName: type: string maxLength: 255 description: Nome do usuário remoteAddr: type: string maxLength: 50 description: Endereço de origem da requisição. dateWhen: type: string format: date-time description: Instante em que ocorreu a requisição. operation: type: string maxLength: 3 description: Operação executada (INS/UPD/DEL). tableName: type: string maxLength: 255 description: Nome da entidade envolvida na operação. primaryKey: type: string maxLength: 32 description: Chave primária do registro alteredFields: type: string maxLength: 1000 description: Lista de campos alterados. originalValues: type: string maxLength: 2000 description: Lista dos valores originais (acompanhando a ordem dos campos alterados). newValues: type: string maxLength: 2000 description: Lista dos novos valores (acompanhando a ordem dos campos alterados). notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE