Sorting
Sort descending by creation_time:
/api/shared_spaces/<space_ID>/sessions?fields=creation_time,end_time,user&query="(creation_time>%272026-01-28T20:59:59.427Z%27;creation_time<%272026-02-26T20:59:59.427Z%27)"&order_by=-creation_time
Sorting ascending by end_time:
https://qa8.almoctane.com/api/shared_spaces/1001/sessions?fields=creation_time,end_time,user,user&query="(creation_time>%272026-01-28T20:59:59.427Z%27;creation_time<%272026-02-26T20:59:59.427Z%27)"&order_by=end_time
session_identifier
After this section, before the Terminate sessions, Export section needs to be added with the 2 examples: -export to excel into a specified file /api/shared_spaces/<space_ID>/sessions/exports/file.xlsx?fields=id,user,client_type,session_identifier,client_ip,access_type,creation_time,end_time,license_edition&query="(creation_time>'2026-01-28T20:59:59.427Z')"&timezone=UTC+03:00
-export to CSV file: https://qa8.almoctane.com/api/shared_spaces/1001/sessions/csv_exports?fields=id,user,client_type,session_identifier,client_ip,access_type,creation_time,end_time,license_edition&query="(creation_time>'2026-01-28T20:59:59.427Z')"
Grouping
Example for grouping by license type: /api/shared_spaces/<space_ID>/sessions/groups?group_by=license_edition&query="(creation_time>%272026-01-28T20:59:59.427Z%27;creation_time<%272026-02-26T20:59:59.427Z%27)"
start_time
creation_time
end_time
creation_time
start_time
creation_time
Filtering
example for filtering by the user ID: api/shared_spaces/<space_ID>/sessions?fields=session_identifier,client_type,user,creation_time,access_type,license_edition,end_time,client_ip,id&query="(creation_time>'2026-01-28T20:59:59.427Z';creation_time<'2025-11-27T20:59:59Z';(user={id=220001}))"
./api/shared_spaces/1001/sessions?fields=end_time,user,client_type&query="(end_time=null)"&order_by=start_time
api/shared_spaces/<space_ID>/sessions?fields=creation_time,end_time,user,client_type&query="(creation_time GE ^2026-01-01T00:00:00Z^);(creation_time LE ^2026-01-30T23:59:59Z^)"
Hidden fields can be included in emails sent by release process auto actions to disallowed users.
If I remember correctly this is happening when hidden fields are passed as variables in add comment or send mail auto actions. I have tagged you in the comment I left on the correspondent US.
Hidden field configuration is not applicable in Quality Criteria (QC) entities. Admin should not use fields that are hidden for other users, as the field label and value is displayed in the QC setting.
This is a major gap in this functionality. Can we highlight it somehow? Not mandatory, but among the other limitations, this is the most dangerous one, as it affects the security of the hidden udf.
Users with the Update Risk Settings permission can still override the original configuration, even if it contains hidden fields.
Here we have a high defect. Let me know if the statement will make admin not grant edit permission on risk after reading this: When a user with the Update Risk Settings permission accesses the configuration, the original settings are automatically overridden.
Users with the Shared Entities Management role can view and manage hidden fields in shared entities, regardless of other role restrictions.
This statement is not correct.
A user is required by the system to be assigned a workspace role in addition to the Shared Entities Management role.
This is relevant to the hidden-field use case because of how field visibility is evaluated across roles:
If a user has multiple roles and a UDF is hidden in some roles but visible in at least one role, the user will see the field.
However, if a UDF is configured to be shown only for the Shared Entities Management role, the field will not be visible to any user.
The reason is that Shared Entities Management alone is not sufficient to grant field visibility in the workspace context. To make the field visible, at least one workspace role must be selected in the “Show only” configuration.
In short, field visibility must be granted through a workspace role; otherwise, the field remains hidden even if Shared Entities Management is selected.
API access
Could we rename the name of this section? It's about the api to retrieve info about the hidden fields. Maybe "Retrieve hidden user defined fields by role (API)"?
fields
custom
fields
custom fields
Hide field
We need a link for details about Hide field ability, same as we have for Searchable or Treandable fields. It will be used in a tooltip in the application, so admin can directly access it. Same for the limitations section.
Query hidden fields
It's important to document also the query to find the hidden user defined fields for a specific role. These udfs are not visible for role with id 8001. https://qa8.almoctane.com/api/shared_spaces/1001/workspaces/1002/metadata_fields?fields=is_user_defined,subtype,id,hide_field,label,show_for_roles,entity_type,name,field_type,shared,entity_type&query="(is_user_defined=true;hide_field=true;!(show_for_roles={id='8001'}))"
metadata/fields?
This api is not working. This is the good one: https://qa8.almoctane.com/api/shared_spaces/1001/workspaces/1002/metadata_fields?fields=is_user_defined,subtype,id,hide_field,label,show_for_roles,entity_type,name,field_type,shared,entity_type&query="(is_user_defined=true;hide_field=true;show_for_roles={id='8001'})"
Retrieve hidden fields per role
I wonder if this is the correct page for this section. Because currently we support the hide property only for user defined fields. Perhaps here? https://docs-staging.docs.admlabs.aws.swinfra.net/adm-octane-staging-lab/en/ValueEdge_MainHelp/Content/API/Create_UDF.htm
of the administrator initiating the action.
The endpoint validates that the target session belongs to the same tenant as the one from which the request is initiated.
Asynchronous execution:
This is the reason why we opted for async execution. Do we state this type of reason in other places? I wonder if we need to document this.
Endpoint
We need to note here that sessions must be filtered either by specific session IDs or by their creation date within a 30-day interval.
ALM-OCTANE-TECH-PREVIEW header is mandatory
Export
These parameters are not directly linked to this feature. These are generic parameters, available for all exports. We should display the examples for the APIs for exports.
DateUtils.
please remove "DateUtils." from this line. It's only the name of the function here
Referencing properties References to field properties can follow either of these syntaxes: entity.<property> or entity['<property>'] Example: entity.story_points, entity['story_points']
We need to drop this and change in the entire page the examples for the formula; instead of entity['field_label'] we need to replace it with entity.field_label
Get month as a number (0-11)
Returns the year of a date as an integer relative to 1900.
toString()
Please remove the entire line. This function is not implemented.
f])
missing ' f'])
e
missing "(" (entity..
’]
missing ")"
'])
f])
missing ' <entity['udf'])
e
missing "("
(entity['bucket_rank_udf']< entity['udf'])
’]
missing ")" '])
Percent
Returns the integer remainder of dividing the two operands.
Ex: 12 % 5 returns 2
bucket_rank
actual_story_points
bucket_rank
bucket_rank_udf
bucket_rank
bucket_rank_udf
bucket_rank
bucket_rank_udf
Mathceil
Math.ceil "." is missing
The result of the expression must match the value type of the field
Here we can state that the client doesn't verify the match, it's the admin who must ensure this.
))
Please add another line below this one:
isEqual(date1, date 2) DateUtils.isEqual(entity['done_date'], entity['last_modified']) Verifies if the values of 2 date fields are equal. '==' and '!=' are not supported for date fields.
entiy[‘date_udf1’].Value!=entiy[‘date_udf2’].Value; entiy[‘date_udf’].Value==(new Date())
Please replace the example with: Date.current() <= DateUtils.addWeeksToDate(entity['creation_time'], 2)
==, !=,
Please remove == and !=
3)
Please add before this line: DateUtils.addSecondsToDate(date, seconds) DateUtils.addSecondsToDate(entity['creation_time'],55) Adds the seconds to the date field value. Example and Description for this line: DateUtils.addMinutesToDate(entity['creation_time'], 30) Adds the minutes to the date field value.
add
For all add functions we need to add ToDate to the function name: addMinutesToDate addHoursToDate . . .
)
Example and Description: DateUtils.subtractMinutes(entity['last_modified'],55) Subtracts a specified number of minutes from a date field value.
Please add a line for DateUtils.subtractYears(date, years)
subtractWorkDays(date,days)
Replace the line with: subtractMonths(date, months) DateUtils.subtractMonths(entity['last_modified'],2) Subtracts a specified number of months from a date field value.
)
Example and Description: DateUtils.subtractWeeks(entity['last_modified'],2) Subtracts a specified number of weeks from a date field value.
DateUtils.addMinutesToDate(new Date(),2)
Example and Description: DateUtils.subtractDays(entity['last_modified'],3) Subtracts a specified number of days from a date field value.
)
Example and Description: DateUtils.subtractHours(entity['last_modified'],2) Subtracts a specified number of hours from a date field value.
Substracts
Please add before this line: DateUtils.subtractSeconds(date, seconds) DateUtils.subtractSeconds(entity['last_modified'],55) Subtracts a specified number of seconds from a date field value.
ad
Please add after this line: DateUtils.addYearsToDate(date, seconds) DateUtils.addYearsToDate(entity['creation_time'],2) Adds years to the date field value.
)
Example and Description: DateUtils.addMonthsToDate(entity['creation_time'], 2) Add months to the date field value.
)
Example and Description: DateUtils.addDaysToDate(entity['creation_time'], 2) <br /> Adds days to the date field value.
)
Example and Description: DateUtils.addHoursToDate(entity['creation_time'], 2) Adds weeks to the date field value.
)
Example and Description: DateUtils.addHoursToDate(entity['creation_time'], 2) Adds hours to the date field value.
2)
Description: Difference between 2 date fields in years.
2)
Description: Difference between 2 date fields in months.
2)
Description: Difference between 2 date fields in weeks.
2)
Description: Difference between 2 date fields in days.
2)
Description: Difference between 2 date fields in hours.
2)
Description for this line: Difference between 2 date fields in minutes.
Entiy[‘date_udf’] == now()
remove the line. We documented it above
Date1 – Date2
Please remove this line
toLocaleDateString([locales[, options]])
Please remove. Not implemented
getTimezoneOffset()
Please remove. Not implemented
)
In the Description column: Parses a string representation of a date, and returns the date's timestamp.
Static instantiation of a new Date
Replace with: Creates a new object representing the current date and time.
new epoch / timestamp (long)
replace with: Returns the number of milliseconds since January 1, 1970, UTC (the Unix epoch).
(entity[‘udf’] > entity[‘udf’].originalValue) ? entity[‘udf’] : entity[‘udf’].originalValue)
originalValue is not implemented for Verve release. Let' replace with this one: (entity['story_points'] > entity['actual_story_points']) ? entity['story_points'] : entity['actual_story_points']
Same as slice(), but the negative indexes are treated as 0.
Extracts a substring starting from the first parameter index up to the second parameter.
Gets the new value of the field
It is used for integer and string types, in equality and inequality operators
originalValue
not yet implemented. Only in Westlife
count(enity.children
CollectionUtils.count(entity.product_areas)
we dont support yet children. But we support other fields that are Collections: application modules, multi value lists, teams, etc
count()
count(collection)
entity's child items.
items in the collection
==
" == " - let's add space before and after
V
small v
]
.value
Both equality and inequality operators are not supported without ".value"
]
.value
V
small v
V
v - small
avg
MathUtils.avg(entity....)
Let's put in the example column the exact syntax that needs to be used.
All the above examples use Math class: Math.min(a,b,);.. Math.pow(x,y)
sum(collection) sum(entity.children.int_udf) Returns the sum of all entity's children's int value. avg(epression) avg(enity.children.story_points) Returns the average value calculated from all the entity’s children. count() count(enity.children)
to be removed - all 3. Not implemented
round(expression,nr_of_digits)
not implemented - to be removed
r
R - capital
entity[‘x’]
entity.udf1/entity.udf2
max(collection)
Not implemented yet. We should add this in Westlife release
min(collection)
Not implemented yet. We should add this for Westlife release
entity[‘story_points’],entity[‘actual_story_points’],entity[‘udf’],..
Currently, we support also these annotations for calling the properties of the entities: entity.story_points; entity.actual_story_points. We should document both
on
I would emphasize that the dynamic values comes from the values of other fields. maybe "...based on other field values using JavaScript expressions"