Skip to content

Time-enteries #6

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

Draft
zeman-j4 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Time-enteries #6

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
129 changes: 84 additions & 45 deletions docs/REST API Reference/Reference.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11473,18 +11473,23 @@ paths:
"$ref": "#/components/schemas/ErrorModel"
"/time_entries/{id}.{format}":
get:
summary: Get TimeEntry
summary: Get time entry
description: Use this method to get details about time entry. <br/>
To successfully call a method, specify the format of response (<i>format</i>) and ID of the time entry (id) in the <b>Path</b>.<br/>
An object with all possible details about time entry is returned in the API call response. <br/>
See the schema below.
operationId: GetTimeEntry
tags:
- Time entry
parameters:
- name: id
in: path
description: ID of TimeEntry
description: ID of the time entry.
required: true
schema:
type: integer
- name: format
description: specify format of response
description: Specify format of the response.
in: path
required: true
schema:
Expand Down Expand Up @@ -12534,16 +12539,17 @@ components:
properties:
id:
type: integer
description: "ID of the custom field."
readOnly: true
example: 1
name:
type: string
example: auta
description: Name of custom field
description: Name of the custom field.
field_format:
type: string
example: list
description: Format
description: Format of the custom field. Use one of allowed values.
enum:
- string
- text
Expand Down Expand Up @@ -12573,88 +12579,101 @@ components:
- flag
regexp:
type: string
description: Regular expression
description: Regular expression.
min_length:
type: integer
description: Minimum length
description: Minimum length of the custom field.
max_length:
type: integer
description: Maximum length
description: Maximum length of the custom field.
is_required:
type: boolean
description: Required
description: Custom field is required.
example: true
is_for_all:
type: boolean
description: For all projects
description: Custom field is for all projects.
example: true
is_filter:
type: boolean
description: Used as a filter
description: Custom field is used as a filter.
example: true
position:
type: integer
example: 2
description: Position of custom field in list
description: Position of the custom field in the list.
searchable:
type: boolean
description: is searchable ?
description: Custom field is searchable.
example: true
default_value:
type: string
description: Default value
description: Default value of the custom field.
editable:
type: boolean
description: Editable
description: Custom field is editable.
example: true
visible:
type: boolean
description: Visible
description: Custom field is visible.
example: true
multiple:
type: boolean
description: Multiple values
description: Custom field suports multiple values.
example: true
description:
type: string
description: Description
description: Description of the custom field.
example: "This is my description of custom field."
is_primary:
type: boolean
description: Primary
description: Custom field is primary.
example: true
show_empty:
type: boolean
description: Show with empty fields
description: Custom field is show with empty fields.
example: true
show_on_list:
type: boolean
description: Show in list
description: Custom field is show in the list.
example: true
settings:
type: string
description: Its Hash object
internal_name:
type: string
description: ''
description: Internal name of the custom field.
example: "My custom field."
show_on_more_form:
type: boolean
example: 'true'
description: Show as additional attribute
example: true
description: Custom field is show as an additional attribute.
easy_external_id:
type: string
description: ''
description: Custom field Easy external ID.
easy_min_value:
type: number
format: float
description: ''
description: Minimum value of the custom field.
easy_max_value:
type: number
format: float
description: ''
description: Maximum value of the custom field.
mail_notification:
type: boolean
example: 'true'
description: Email notifications
example: true
description: Custom field email notifications.
easy_group_id:
type: integer
description: ''
description: Custom field Easy group ID.
clear_when_anonymize:
type: boolean
description: Clear when anonymize
description: Custom field is clear when anonymize.
example: true
type:
type: string
example: IssueCustomField
description: Type
description: Type of the custom field.
readOnly: true
possible_values:
type: array
Expand All @@ -12678,26 +12697,28 @@ components:
readOnly: true
non_deletable:
type: boolean
example: 'false'
description: ''
example: true
description: Custom field is not deletable.
readOnly: true
non_editable:
type: boolean
example: 'false'
description: ''
example: false
description: Custom field is not editable.
readOnly: true
disabled:
type: boolean
example: 'false'
description: ''
description: Custom field is disabled.
readOnly: true
created_at:
type: string
format: date-time
description: Date and time when custom field was created.
readOnly: true
updated_at:
type: string
format: date-time
description: Date and time when custom field was updated.
re
readOnly: true
xml:
name: custom_field
Expand Down Expand Up @@ -19475,7 +19496,7 @@ components:
author_id:
type: integer
name:
type: string
string type: string
issue_ids:
type: array
items:
Expand Down Expand Up @@ -19595,6 +19616,7 @@ components:
properties:
id:
type: integer
description: "ID of the time entry."
readOnly: true
example: 1
project:
Expand All @@ -19603,10 +19625,12 @@ components:
properties:
id:
type: integer
description: "Project ID."
xml:
attribute: true
name:
type: string
description: "Name of the project."
xml:
attribute: true
issue:
Expand All @@ -19615,10 +19639,12 @@ components:
properties:
id:
type: integer
description: "Issue ID."
xml:
attribute: true
name:
type: string
description: "Name of the issue."
xml:
attribute: true
user:
Expand All @@ -19627,10 +19653,12 @@ components:
properties:
id:
type: integer
description: "User ID."
xml:
attribute: true
name:
type: string
description: "Name of the user."
xml:
attribute: true
priority:
Expand All @@ -19639,10 +19667,12 @@ components:
properties:
id:
type: integer
description: "Priority ID."
xml:
attribute: true
name:
type: string
description: "Name of the priority."
xml:
attribute: true
activity:
Expand All @@ -19651,30 +19681,37 @@ components:
properties:
id:
type: integer
description: "ID of the activity."
xml:
attribute: true
name:
type: string
description: "Name of the activity."
xml:
attribute: true
easy_external_id:
type: string
hours:
example: '8'
description: Amount of spent hours
description: Amount of spent hours.
type: string
spent_on:
format: date
example: '2019-07-09'
description: Date of spent time. It can be limited by global setting
type: string
comments:
example: I work very hard
description: "Use if you have notes you want to add."
example: I worked mostly at night.
type: string
easy_is_billable:
easy_is_billable:
type: boolean
description: "True/false decision if you want to invoice your work."
example: true
easy_billed:
type: boolean
description: "True/false decision if your work was billed by Easy."
example: false
custom_fields:
type: array
xml:
Expand All @@ -19683,23 +19720,25 @@ components:
"$ref": "#/components/schemas/CustomFieldValueApiResponse"
tag_list:
type: array
description: List of tags associated with entity
description: List of tags associate.d with entity
example:
- deployment
- gantt
- ldap
items:
type: string

created_on:
type: string
format: date-time
description: Date and time when time entry was created.
readOnly: true
updated_on:
type: string
format: date-time
description: Date and time when time entry was edited.
readOnly: true
xml:
name: time_entry
name: time_entrye: time_entry
UserApiRequest:
properties:
easy_external_id:
Expand Down