|
/cxf/bpc-logservice/log/instances
|
Get a compact overview of the available log service instances.
Only the following data is returned for each instance:
|
The log service instances as JSON.
|
|
|
/cxf/bpc-logservice/log/instances/{instanceIdOrName}
|
Get the current configuration of the log service instance.
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
|
The requested config as JSON.
-
200 : OK
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
503 : BPC is currently in maintenance mode
|
|
|
/cxf/bpc-logservice/log/{instanceIdOrName}
|
Gets the data of a log service instance.
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
|
timezoneOffset-
timezone offset like GMT+2 (optional). Is used if a date field is accessed in the parentFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
timezoneName-
timezone name like Europe/Berlin (optional). Is used if a date field is accessed in the parentFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
start-
first record to be read (optional, default = 0)
limit-
number of records to read (optional, default = 100, max. 10.000)
parentQuery-
simple search (optional). Example city:berlin. Additional information of the Lucene Query String Syntax.
parentFilter-
complex filter format like done from the monitor endpoint (optional). Example: [{"property":"processid","operator":"gte","value":1000,"source":"raw","invert":false}]
parentSort-
determination by which field the parent entries should be sorted (optional, default = parent key descending). Format: fieldname|[ASC|DESC]. Example: processid|DESC. Multiple sorting instructions can be specified comma separated.
childSort-
determination by which field the child entries should be sorted (optional, default = child key ascending). Format: fieldname|[ASC|DESC]. Example: childid|ASC. Multiple sorting instructions can be specified comma separated.
addChilds-
should the response contain the log service child entries?. Default is true.
|
The requested data as JSON.
-
200 : OK
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
503 : BPC or instance are currently in maintenance mode
|
|
|
/cxf/bpc-logservice/log/{instanceIdOrName}/{parentId}
|
Get the data of a log service entry with its child entries.
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
parentId-
the ID of the requested log service entry
|
timezoneOffset-
timezone offset like GMT+2 (optional). Is used if a date field is accessed in the childFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
timezoneName-
timezone name like Europe/Berlin (optional). Is used if a date field is accessed in the childFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
childQuery-
simple search (optional). Example city:berlin. Additional information of the Lucene Query String Syntax.
childFilter-
complex filter format like done from the monitor endpoint (optional). Example: [{"property":"processid","operator":"gte","value":1000,"source":"raw","invert":false}]
|
The requested data as JSON.
-
200 : OK
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
503 : BPC or instance are currently in maintenance mode
|
|
|
/cxf/bpc-logservice/log/{instanceIdOrName}/{parentId}/{childId}
|
Get the data of a log service child entry.
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
parentId-
the ID of the requested log service entry
childId-
the ID of the requested child entry
|
The requested data as JSON.
-
200 : OK
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
503 : BPC or instance are currently in maintenance mode
|
|
|
/cxf/bpc-logservice/log/{instanceIdOrName}
|
Writes the data provided in the body to OpenSearch and/or the database.
For calls from Iguasu the following HTTP headers are used and their values written to the following 'externalReference' object fields of all 'parent' related documents:
| HTTP Header |
'externalReference' field |
IGUASU-System-ID |
externalReference.system |
IGUASU-Instance-ID |
externalReference.instance |
IGUASU-Processor-ID |
externalReference.processor |
IGUASU-Service-ID |
externalReference.service |
|
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
|
async-
'true' to perform the log asynchronously. 'false' to perform synchronously. Default is false.
|
-
200 : Data has been written
-
400 : None or invalid data to log given
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
500 : Failed to write the data
-
503 : Maintenance mode is active or OpenSearch and database are not activated
|
|
|
/cxf/bpc-logservice/log/{instanceIdOrName}/{parentId}
|
Deletes log service entries and their child entries from OpenSearch and the database.
Attention: When you use 'childQuery' and/or 'childFilter' only those children get deleted, not the parent itself.
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
parentId-
the ID of the log service entry to delete, multiple entries can be provided and must be separated by comma
|
timezoneOffset-
timezone offset like GMT+2 (optional). Is used if a date field is accessed in the childFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
timezoneName-
timezone name like Europe/Berlin (optional). Is used if a date field is accessed in the childFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
childQuery-
simple search (optional). Example city:berlin. Additional information of the Lucene Query String Syntax.
childFilter-
complex filter format like done from the monitor endpoint (optional). Example: [{"property":"processid","operator":"gte","value":1000,"source":"raw","invert":false}]
|
-
200 : Data has been deleted
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
500 : Delete failed
-
503 : Maintenance mode is active or OpenSearch and database are not activated
|
|
|
/cxf/bpc-logservice/log/{instanceIdOrName}/{parentId}/{childId}
|
Deletes log service child entries from OpenSearch and the database.
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
parentId-
the ID of the log service entry to delete the child entries from
childId-
the ID of the child entry to delete, multiple entries can be provided and must be separated by comma
|
-
200 : Data has been deleted
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
500 : Delete failed
-
503 : Maintenance mode is active or OpenSearch and database are not activated
|
|
|
/cxf/bpc-logservice/log/{instanceIdOrName}
|
Deletes log service entries and their child entries from OpenSearch by query. Deletion from database is not supported.
|
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
|
timezoneOffset-
timezone offset like GMT+2 (optional). Is used if a date field is accessed in the parentFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
timezoneName-
timezone name like Europe/Berlin (optional). Is used if a date field is accessed in the parentFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
parentQuery-
simple search (optional). Example city:berlin. Additional information of the Lucene Query String Syntax.
parentFilter-
complex filter format like done from the monitor endpoint (optional). Example: [{"property":"processid","operator":"gte","value":1000,"source":"raw","invert":false}]
|
-
200 : Data has been deleted
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
500 : Delete failed
-
503 : Maintenance mode is active or OpenSearch and database are not activated
|
|
|
/cxf/bpc-logservice/log/{instanceIdOrName}/children
|
Deletes only log service child entries from OpenSearch by query. Deletion from database is not supported.
|
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
|
timezoneOffset-
timezone offset like GMT+2 (optional). Is used if a date field is accessed in the childFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
timezoneName-
timezone name like Europe/Berlin (optional). Is used if a date field is accessed in the childFilter with a range operator like "gt", "gte", "lt", "lte", ">", ">=", ",<,", ",<,=". UTC is the default. timezoneName is used before timezoneOffset if both are set.
childQuery-
simple search (optional). Example city:berlin. Additional information of the Lucene Query String Syntax.
childFilter-
complex filter format like done from the monitor endpoint (optional). Example: [{"property":"processid","operator":"gte","value":1000,"source":"raw","invert":false}]
|
-
200 : Data has been deleted
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
500 : Delete failed
-
503 : Maintenance mode is active or OpenSearch and database are not activated
|
|
|
/cxf/bpc-logservice/log/drop/indices/{instanceIdOrName}
|
Deletes/drops the parent and child indices of a log service instance.
|
instanceIdOrName-
this can be either the ID or a unique name of the module instance
|
-
200 : Indices deleted
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
500 : Delete failed
-
503 : Maintenance mode is active or OpenSearch and database are not activated
|
|
|
/cxf/bpc-logservice/{instanceIdOrName}/open/logservice
|
Creates a BPC deeplink to redirect the caller to the admin page of a log service instance.
|
instanceIdOrName-
this can be either the ID or a unique name of the log service module instance
|
The requested data as JSON.
-
200 : OK
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
503 : BPC or instance are currently in maintenance mode
|
Can be used without a user session.
|
|
/cxf/bpc-logservice/{instanceIdOrName}/open/monitor
|
Redirects the user to the monitor using the OpenSearch indices of the log service instance.
All provided query params are used to build a monitor filter on fields of the 'externalReference' object.
For Iguasu the following query parameters can be used to access the HTTP header values when the entry has been created.
| Query parameter |
HTTP header |
system |
IGUASU-System-ID |
instance |
IGUASU-Instance-ID |
processor |
IGUASU-Processor-ID |
service |
IGUASU-Service-ID |
|
instanceIdOrName-
this can be either the ID or a unique name of the log service module instance
|
title-
optional URL parameter. Text or language key for window title
promptText-
optional URL parameter. Text or language key for prompt text
|
The requested data as JSON.
-
200 : OK
-
401 : Authentication could not be performed
-
404 : Module instance was not found
-
500 : BPC deeplink could not be created
-
503 : BPC or instance are currently in maintenance mode
|
Can be used without a user session.
|
