Skip to content

CON-9995 Improve Time Interval documentation #870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
horczech wants to merge 1 commit into
base: master
Choose a base branch
from
Open

CON-9995 Improve Time Interval documentation #870

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions operations/_objects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,28 @@ These are JSON object definitions and other JSON entities shared by operations a

### Time interval

When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply:

- **Start equals End (equality mode)**
If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:

```
CreatedUtc == StartUtc
```

This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.

- **Start differs from End (interval mode)**
If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:

```
StartUtc <= CreatedUtc < EndUtc
```

In other words, the start is inclusive and the end is exclusive.

> **Note:** When designing integrations (especially accounting or incremental syncs), make sure your time ranges take this inclusive Start / exclusive End behavior into account so that no records at the boundaries are unintentionally omitted.

```javascript
{
"StartUtc": "2020-01-05T00:00:00Z",
Expand Down