Skip to content

Custom time_frame must be JSON body NOT parameter key value #87

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
pcg-nathaniel wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Custom time_frame must be JSON body NOT parameter key value #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fda62c4
Custom time_frame must be JSON body NOT parameter key value
pcg-nathaniel Apr 30, 2024
3847470
Update _custom-fields.md
pcg-nathaniel Jun 12, 2024
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
29 changes: 18 additions & 11 deletions source/includes/_custom-fields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ PUT /api/v1/custom_fields/<custom_field_id>
GET /api/v1/custom_fields
GET /api/v1/custom_fields/<custom_field_id>
```
##### Required parameters:

| **Parameter** | **Type** | **Description** |
| ------------- | -------- | --------------- |
| `namespace` | string | either `assignables` or `users` |

### Deleting Custom Fields
```
Expand Down Expand Up @@ -124,17 +129,6 @@ POST /api/v1/users/<user_id>/custom_field_values

**Note**: Only custom fields with a `data_type` of `multiple_choice_selection_list` can accept an array with multiple values as its `value` in a `POST` request. Note that this array is treated as the complete set of values for the given custom field and project/user. Subsequent `POST` requests for the same custom field and project/user will result in the deletion of previous values if those values are not also included in the `value` array. In other words, subsequent `POST` requests do not _append_ new values, but rather _replace_ the _set_ of values as a whole.

### Updating Custom Field Values
```
PUT /api/v1/projects/<project_id>/custom_field_values/<id>
PUT /api/v1/users/<user_id>/custom_field_values/<id>
```
##### Editable parameters:

| **Parameter** | **Type** | **Description** |
| ------------- | -------- | --------------- |
| `value` | string | the actual value |

### Getting Custom Field Values
```
GET /api/v1/projects/<project_id>/custom_field_values
Expand All @@ -145,6 +139,19 @@ In addition to getting custom field values directly, you can also include custom
GET /api/v1/projects/<project_id>?fields=custom_field_values
GET /api/v1/users/<user_id>?fields=custom_field_values
```
### Updating Custom Field Values
```
PUT /api/v1/projects/<project_id>/custom_field_values/<id>
PUT /api/v1/users/<user_id>/custom_field_values/<id>
```

**Note**: <id> here is the ID of the custom field ON THE PROJECT or USER, NOT THE GLOBAL ID of the custom field on your account. To get the project or user custom field id use Getting Custom Fields API above.

##### Editable parameters:

| **Parameter** | **Type** | **Description** |
| ------------- | -------- | --------------- |
| `value` | string | the actual value |

### Deleting Custom Field Values

Expand Down
20 changes: 14 additions & 6 deletions source/includes/_reports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ With the exception of `today` and `calc_incurred_using`, each of the following p
| param | data type | description | default |
| ----- | --------- | ----------- | ------- |
| [`view`](#view) | string | the name of the view (e.g. `time_fees_hours`, `utilization`, etc.) | `"time_fees_hours"` |
| [`time_frame`](#time_frame) | object or string | a custom time frame object or the name of the time frame | `"this_week"` |
| [`time_frame`](#time_frame) | object or string | a custom time frame object as JSON body, example in link OR the name of the time frame as Key-Value Parameter | `"this_week"` |
| [`group_by`](#group_by) | array of strings | the attributes to group rows by | `["project_id"]` (or `["user_id"]` for utilization) |
| [`filters`](#filters) | object of objects | the attributes and values to include or exclude | `null` |
| [`today`](#today) | string | the date on which "future scheduled" begins, in `YYYY-MM-DD` format | current UTC date |
Expand Down Expand Up @@ -100,16 +100,24 @@ There are currently ten supported views, which correspond to the reports availab

## `time_frame`

The time frame of a report is specified as an object with "from" and "to" attributes that each specify a date in the format YYYY-MM-DD.
There are two options for time_frame

1) as custom JSON post body object "from" and "to" attributes that each specify a date in the format YYYY-MM-DD

When submitting a custom time frame, REMOVE the time_frame parameter from your URL and add the following JSON to your post body JSON (this WILL NOT work as a parameter):

```js
"time_frame": {
"from": "2018-01-01",
"to": "2018-12-31"
{
"time_frame": {
"from": "2020-01-01",
"to": "2024-12-31"
}
}
```

There are also several shortcut strings for common time frames.
2) a URL parameter with a shortcut string.

When submitting a shortcut string for time_frame, use the URL parameter Key=time_frame and value = one of the options below:

- `this_week`
- `this_month`
Expand Down