|
/cxf/bpc-core/storage/store/{storeId}
|
Get store items from the OpenSearch index bpc-store-<storeId>.
Returns an empty response when the store does not exist.
|
storeId-
the ID of the store to get the items from
|
timezoneOffset-
timezone offset like GMT+2 (optional). Is used if a date field is accessed in the filter 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 filter 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). Default is 0.
limit-
number of records to read (optional, default = 1000, max. 10.000). Default is 1000.
query-
simple search (optional). Example city:berlin. Additional information of the Lucene Query String Syntax.
filter-
complex filter format like done from the monitor endpoint (optional). Example: [{"property":"processid","operator":"gte","value":1000,"source":"raw","invert":false}]
sort-
determination by which field the entries should be sorted (optional). Format: fieldname|[ASC|DESC]. Example: processid|DESC. Multiple sorting instructions can be specified comma separated.
|
The requested store items as JSON
|
|
|
/cxf/bpc-core/storage/store/{storeId}/{itemId}
|
Get a specific store item from the OpenSearch index bpc-store-<storeId>.
|
storeId-
the ID of the store to get the data from
itemId-
the ID of the item
|
The requested store item as JSON
|
|
|
/cxf/bpc-core/storage/store/{storeId}
|
Creates a new store item.
Writes the provided store item data to the OpenSearch index bpc-store-<storeId>.
It uses a new ID for the store item and sets this also in the given store item data.
Not well known elements on root level are automatically saved to the field 'customFields' to avoid OpenSearch mapping problems.
all fields example
{
"id": "1f697af5-c147-3d94-c529-e06f3f15bb87",
"moduleId": "monitor",
"moduleInstanceId": "audit_log",
"name": "data_view",
"value": {
"foo": "bar"
},
"favorite": true,
"readRestriction" : {
"user": "hans_schmidt",
"organisations": [ "DEFAULT" ],
"roles": [ "expert", "advanced", "beginner" ],
"rights": [ "loadModule_monitor" ]
},
"writeRestriction" : {
"user": "hans_schmidt",
"organisations": [ "DEFAULT" ],
"roles": [ "expert" ],
"rights": [ "loadModule_monitor" ]
},
"customFields": {
"foo": "bar"
}
}
id (irrelevant) -
ID of the store item. A new random UUID gets set instead.
moduleId (optional) -
The ID of the module the store item belongs to. Can be used as a filter value while getting items.
moduleInstanceId (optional) -
The ID of the module instance the store item belongs to. Can be used as a filter value while getting items.
name (optional) -
The name of the store item (be creative). Can be used as a filter value while getting items.
value (required) -
The actual value/content/data of the store item.
favorite (optional) -
To flag the store item as a favorite. Defaults to false.
readRestriction (required) -
The read restrictions. Define who can read this item. At least one of the sub elements should be set.
readRestriction.user (optional) -
Only this username has read access to this store item. When set the other fields 'organizations', 'roles' and 'rights' are not saved.
readRestriction.organisations (optional) -
Anyone with one of these organizations has read access to this store item.
readRestriction.roles (optional) -
Anyone with one of these roles has read access to this store item.
readRestriction.rights (optional) -
Anyone with one of these rights has read access to this store item.
writeRestriction (required) -
The write restrictions. Define who can update and delete this item. At least one of the sub elements should be set.
writeRestriction.user (optional) -
Only this username has write access to this store item. When set the other fields 'organizations', 'roles' and 'rights' are not saved.
writeRestriction.organisations (optional) -
Anyone with one of these organizations has write access to this store item.
writeRestriction.roles (optional) -
Anyone with one of these roles has write access to this store item.
writeRestriction.rights (optional) -
Anyone with one of these rights has write access to this store item.
customFields (optional) -
Values that do not fit into the 'value' field.
|
|
storeId-
the ID of the store
|
The ID of the created store item
|
|
|
/cxf/bpc-core/storage/store/{storeId}/{itemId}
|
Creates or updates a store item.
Writes the provided store item data in the body to the OpenSearch index bpc-store-<storeId>.
An existing store item gets updated and a not existing one gets created.
Not well known elements on root level are automatically saved to the field 'customFields' to avoid OpenSearch mapping problems.
all fields example
{
"id": "1f697af5-c147-3d94-c529-e06f3f15bb87",
"moduleId": "monitor",
"moduleInstanceId": "audit_log",
"name": "data_view",
"value": {
"foo": "bar"
},
"favorite": true,
"readRestriction" : {
"user": "hans_schmidt",
"organisations": [ "DEFAULT" ],
"roles": [ "expert", "advanced", "beginner" ],
"rights": [ "loadModule_monitor" ]
},
"writeRestriction" : {
"user": "hans_schmidt",
"organisations": [ "DEFAULT" ],
"roles": [ "expert" ],
"rights": [ "loadModule_monitor" ]
},
"customFields": {
"foo": "bar"
}
}
id (irrelevant) -
ID of the store item. The path parameter get set in the given document instead.
moduleId (optional) -
The ID of the module the store item belongs to. Can be used as a filter value while getting items.
moduleInstanceId (optional) -
The ID of the module instance the store item belongs to. Can be used as a filter value while getting items.
name (optional) -
The name of the store item (be creative). Can be used as a filter value while getting items.
value (required) -
The actual value/content/data of the store item.
favorite (optional) -
To flag the store item as a favorite. Defaults to false.
readRestriction (required) -
The read restrictions. Define who can read this item. At least one of the sub elements should be set.
readRestriction.user (optional) -
Only this username has read access to this store item. When set the other fields 'organisations', 'roles' and 'rights' are not saved.
readRestriction.organisations (optional) -
Anyone with one of these organisations has read access to this store item.
readRestriction.roles (optional) -
Anyone with one of these roles has read access to this store item.
readRestriction.rights (optional) -
Anyone with one of these rights has read access to this store item.
writeRestriction (required) -
The write restrictions. Define who can update and delete this item. At least one of the sub elements should be set.
writeRestriction.user (optional) -
Only this username has write access to this store item. When set the other fields 'organisations', 'roles' and 'rights' are not saved.
writeRestriction.organisations (optional) -
Anyone with one of these organisations has write access to this store item.
writeRestriction.roles (optional) -
Anyone with one of these roles has write access to this store item.
writeRestriction.rights (optional) -
Anyone with one of these rights has write access to this store item.
customFields (optional) -
Values that do not fit into the 'value' field.
|
|
storeId-
the ID of the store
itemId-
the ID of the item
|
-
200 : OK
-
403 : Access rights not sufficient to update the store item
-
404 : Missing resource:
-
406 : Mandatory fields missing
-
500 : Failure due to one of the following reasons:
-
Store could not be created
-
Problem with the given JSON
-
Something went wrong while accessing OpenSearch
|
|
|
/cxf/bpc-core/storage/store/{storeId}/{itemId}
|
Deletes a specific store item from the OpenSearch index bpc-store-<storeId>.
|
storeId-
the ID of the store
itemId-
the ID of the item to delete
|
|
|
