{"components":{"parameters":{"outbox.OutboxQueryParams.createdFrom":{"description":"Start timestamp (inclusive) for filtering by the creation time of the outbox entry.","explode":false,"in":"query","name":"createdFrom","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"outbox.OutboxQueryParams.createdTo":{"description":"End timestamp (inclusive) for filtering by the creation time of the outbox entry.","explode":false,"in":"query","name":"createdTo","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"outbox.OutboxQueryParams.from":{"description":"Start timestamp (inclusive) for filtering outbox entries based on the status timestamp.","explode":false,"in":"query","name":"from","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"outbox.OutboxQueryParams.to":{"description":"End timestamp (inclusive) for filtering outbox entries based on the status timestamp.","explode":false,"in":"query","name":"to","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}},"schemas":{"ClientError":{"allOf":[{"$ref":"#/components/schemas/CommonError"}],"description":"Client error","type":"object"},"CommonError":{"description":"Common error","properties":{"errors":{"description":"Optional list of multiple errors occurred.\nMust not be null.","items":{"type":"object"},"type":"array"},"message":{"description":"Message describing the error.\nMust not be null.","type":"string"},"path":{"description":"URL path where the error occurred.\nMust not be null.","type":"string"},"status":{"description":"Textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400.\nMust not be null.","type":"string"},"timestamp":{"description":"Timestamp in UTC when the error occurred.\nMust not be null.","format":"date-time","type":"string"},"uuid":{"description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries.\nMust not be null.","type":"string"}},"required":["status","message","timestamp","path","uuid","errors"],"type":"object"},"Page":{"description":"Pagination metadata","properties":{"number":{"description":"Page number of total pages available.\nMust not be null.","format":"uint32","type":"integer"},"size":{"description":"Size of the page as specified by the query.\nMust not be null.","format":"uint32","type":"integer"},"totalElements":{"description":"Total count of all elements available for the query.\nMust not be null.","format":"uint32","type":"integer"},"totalPages":{"description":"Total count of all pages available for the query.\nMust not be null.","format":"uint32","type":"integer"}},"required":["size","number","totalElements","totalPages"],"type":"object"},"ServerError":{"allOf":[{"$ref":"#/components/schemas/CommonError"}],"description":"Server error","type":"object"},"entity_name.Response":{"description":"Existing entity names","properties":{"entityNames":{"description":"Entity names as mentioned in the API reference.\nMust not be null.","items":{"type":"string"},"type":"array"}},"required":["entityNames"],"type":"object"},"entry.Action":{"description":"Describes how and by whom a change was initiated.","properties":{"agentIdent":{"description":"The direct performer or driver of the action (animate or inanimate). Either of 'system', keycloak userId, keycload clientId.\nMust not be null.","type":"string"},"client":{"allOf":[{"$ref":"#/components/schemas/entry.Client"}],"description":"Client which initiated the action.\nMust not be null."},"description":{"description":"Description of the action.\nMust not be null.","type":"string"}},"required":["agentIdent","description","client"],"type":"object"},"entry.Change":{"description":"Describes a change to an entity.","properties":{"entityIdent":{"description":"Ident of the entity.\nMust not be null.","type":"string"},"entityName":{"description":"Entity name as mentioned in the API reference.\nMust not be null.","type":"string"},"recordedAt":{"description":"Date and time when the change was recorded. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"type":{"description":"Type of change.\nMust not be null.\nOne of:\n|        |                    |\n| ------ | ------------------ |\n| CREATE | Entity was created |\n| UPDATE | Entity was updated |\n| DELETE | Entity was deleted |","type":"string"}},"required":["entityName","entityIdent","type","recordedAt"],"type":"object"},"entry.ChangeType":{"description":"One of:\n|        |                    |\n| ------ | ------------------ |\n| CREATE | Entity was created |\n| UPDATE | Entity was updated |\n| DELETE | Entity was deleted |","type":"string"},"entry.ChangeWithModifications":{"description":"Entity change including modified properties","properties":{"entityIdent":{"description":"Ident of the entity.\nMust not be null.","type":"string"},"entityName":{"description":"Entity name as mentioned in the API reference.\nMust not be null.","type":"string"},"modifications":{"description":"Modified properties.\nMust not be null.","items":{"$ref":"#/components/schemas/entry.Modification"},"type":"array"},"recordedAt":{"description":"Date and time when the change was recorded. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"type":{"description":"Type of change.\nMust not be null.\nOne of:\n|        |                    |\n| ------ | ------------------ |\n| CREATE | Entity was created |\n| UPDATE | Entity was updated |\n| DELETE | Entity was deleted |","type":"string"}},"required":["entityName","entityIdent","type","recordedAt","modifications"],"type":"object"},"entry.Client":{"description":"Client used by the agent to perform the action","properties":{"description":{"description":"Describes the client","type":["string","null"]},"ipAddress":{"description":"Unique numerical label assigned to the device (such as a computer, smartphone, or tablet) that initiated the action","type":["string","null"]}},"required":["description","ipAddress"],"type":"object"},"entry.Modification":{"description":"Describes a modified property","properties":{"newValue":{"description":"New value, if any","type":["string","null"]},"oldValue":{"description":"Previous value, if any","type":["string","null"]},"propertyName":{"description":"Name of the property.\nMust not be null.","type":"string"},"propertyPath":{"description":"Path of the property e.g. '/nested/propertyName'.\nMust not be null.","type":"string"}},"required":["propertyName","propertyPath","oldValue","newValue"],"type":"object"},"entry.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/entry.QueryResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Paged audit trail entries","type":"object"},"entry.QueryResponse":{"description":"Audit trail entry","properties":{"action":{"anyOf":[{"$ref":"#/components/schemas/entry.Action"},{"type":"null"}],"description":"The action which initiated the change"},"change":{"allOf":[{"$ref":"#/components/schemas/entry.Change"}],"description":"Describes the change.\nMust not be null."},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"ident":{"description":"Ident of the audit entry.\nMust not be null.","type":"string"},"traceId":{"description":"Identifies an entire request flow across multiple services. Links all changes triggered by a single action.\nMust not be null.","type":"string"}},"required":["ident","traceId","change","action","createdAt"],"type":"object"},"entry.Response":{"description":"Audit trail entry","properties":{"action":{"anyOf":[{"$ref":"#/components/schemas/entry.Action"},{"type":"null"}],"description":"Describes how and by whom a change was initiated. null if no initiating action is known"},"change":{"allOf":[{"$ref":"#/components/schemas/entry.ChangeWithModifications"}],"description":"Describes what and when the entity was changed including the modification of properties.\nMust not be null."},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"ident":{"description":"Ident of the audit entry.\nMust not be null.","type":"string"},"traceId":{"description":"Identifies an entire request flow across multiple services. Links all changes triggered by a single action.\nMust not be null.","type":"string"}},"required":["ident","traceId","change","action","createdAt"],"type":"object"},"outbox.OutboxEntryResponse":{"description":"Outbox Entry","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"deleteAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"The delete timestamp"},"failures":{"description":"Number of failures.\nMust not be null.","format":"int32","minimum":0,"type":"integer"},"id":{"description":"The ID of the outbox entry.\nMust not be null.","type":"string"},"ident":{"description":"The ident of the outbox entry. An entry does not necessarily require an ident. It serves as a convenience feature only.","type":["string","null"]},"lastFailureMessage":{"description":"Last failure message","type":["string","null"]},"nextRetryAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"The next retry timestamp"},"payload":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"The payload"},"status":{"description":"The status of the outbox entry.\nMust not be null.\nOne of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"statusHistory":{"description":"The status history.\nMust not be null.","items":{"$ref":"#/components/schemas/outbox.StatusHistory"},"type":"array"},"statusTimestamp":{"description":"The timestamp of the last status change.\nMust not be null.","format":"date-time","type":"string"},"tracingAttributes":{"description":"Tracing attributes.\nMust not be null.","type":"object","unevaluatedProperties":{"type":"string"}}},"required":["id","status","statusTimestamp","failures","createdAt","statusHistory","tracingAttributes"],"type":"object"},"outbox.QueueStatus":{"description":"One of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"outbox.StatusHistory":{"description":"Status history entry","properties":{"status":{"description":"The status.\nMust not be null.\nOne of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"timestamp":{"description":"The timestamp when the status occurred.\nMust not be null.","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"},"outbox.entry.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/outbox.OutboxEntryResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Page of Outbox Entries","type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"nbx-internal":"","nbx-tenant-management-read":""},"tokenUrl":"https://api.isx-stage-westeurope.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for the audit trail","title":"Audit Trail API","version":"v2-preview-1.2.8"},"openapi":"3.1.0","paths":{"/v2/audit-trail/entity-names":{"get":{"description":"Retrieve existing entity names sorted alphabetically. Entities are Objects tracked by the audit trail. The usually represent an object that can be fetched using our API","operationId":"retrieveAuditTrailEntityNames","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/entity_name.Response"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Retrieve entity names","tags":["Audit Trail Entity Name"]}},"/v2/audit-trail/entries":{"get":{"description":"The RSQL query may contain\n- ident\n- traceId\n- action.agentIdent\n- action.client.ipAddress\n- change.recordedAt\n- change.entityName\n- change.type","operationId":"queryAuditTrailEntries","parameters":[{"description":"Use RSQL query language.\nSee: https://aboullaite.me/rsql/.","explode":false,"in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Must be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100. Must be greater than or equal to 1.","in":"query","name":"size","schema":{"default":100,"minimum":1,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.","in":"query","name":"sort","schema":{"default":"recordedAt,asc","items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/entry.PagedResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Query audit trail entries","tags":["Audit Trail Entry"]}},"/v2/audit-trail/entries/{ident}":{"get":{"description":"Retrieve a single audit trail entry","operationId":"retrieveAuditTrailEntry","parameters":[{"description":"Ident of an audit trail entry","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/entry.Response"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Retrieve audit trail entry","tags":["Audit Trail Entry"]}}},"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"tags":[{"description":"Audit Trail Entries API","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Audit Trail Entry"},{"description":"Audit Trail Entity Names API","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Audit Trail Entity Name"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}