Skip to content

Two-argument expressions: no spaces allowed, and brackets needed in GET #94

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
BjarteMell wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Two-argument expressions: no spaces allowed, and brackets needed in GET #94

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
13 changes: 6 additions & 7 deletions docs/PxWebApi/documentation/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -921,8 +921,7 @@ valueCodes[variable-id]=value-code1, value-code2
```

You need to specify value codes for each variable that is not eliminable. The
value codes are given in a comma separated list. If the value code should be
surrounded by square brackets like `3,[1,2],4+5`. See bellow on how to specify
value codes are given in a comma separated list. If a value code or a selection expression contains a comma, wrap it in square brackets, e.g. `valueCodes[Tid]=[range(2002,2005)]` or `[top(5,1)]`. In a POST body, write the expression without brackets: `"range(2002,2005)"`. A bracketed string in POST is looked up as a value code and fails with `Non-existent value`. See bellow on how to specify

@runejo runejo Oct 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a workarroud for a bug. Wrapping with [] does not make sense to me 🤔

@runejo runejo Oct 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be clear these look wrong

  • [range(2002,2005)]
  • [top(5,1)]

value codes.

You change can specify a different codelist for a variable the possible once
Expand Down Expand Up @@ -1018,14 +1017,14 @@ as specified in the metadata.
The syntax of the experssion is:

```sh
top(numberOfValues, offset)
top(numberOfValues,offset)
```

where `numberOfValues` specifies the number of values codes that should be
selected from the top and `offset` is an optional offset from the top. E.g.

- `top(5)` will select the first 5 values.
- `top(5, 1)` will skip the first value and select the next 5 values.
- `top(5,1)` will skip the first value and select the next 5 values.

##### bottom

Expand All @@ -1036,14 +1035,14 @@ as specified in the metadata.
The syntax of the experssion is:

```sh
bottom(numberOfValues, offset)
bottom(numberOfValues,offset)

@runejo runejo Oct 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removing spaces for the examples are good, but this also sounds like at bug we should fix in the API

```

where `numberOfValues` specifies the number of values codes that should be
selected from the bottom and `offset` is an optional offset from the bottom. E.g.

- `bottom(5)` will select the last 5 values.
- `bottom(5, 1)` will skip the last value and select the next 5 values counting
- `bottom(5,1)` will skip the last value and select the next 5 values counting
from the bottom.

##### range
Expand All @@ -1054,7 +1053,7 @@ in the metadata.
The syntax is in the form

```sh
range(value-code1, value-code2)
range(value-code1,value-code2)
```

Example if you have a time variable that have codes from the year 2000 to 2025
Expand Down
Loading