Skip to content

Commit

Permalink
correction in Api Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@kanika2024
kanika2024 committed Jul 24, 2024
1 parent 22f0eab commit 1a0bdc7
Show file tree
Hide file tree
Showing 11 changed files with 48 additions and 41 deletions.
10 changes: 5 additions & 5 deletions source/includes/_booking.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ Name | Description
---: | :----
**resource_id** <br><span class="required">`required`</span> | ID of resource object which is being booked or scheduled.
**project_id** <br><span class="required">`required`</span> | ID of project object which this booking object is being created for.
**start_time** <br> <span class="required">`required`</span> | Represents start date and time for booking object. This field accepts value in ISO 8601 format for date-time i.e. yyyy-mm-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given).
**end_time** <br> <span class="required">`required`</span> | Represents end date and time for booking object. This field accepts value in ISO 8601 format for date-time i.e. yyyy-mm-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given). `end_time` must always be ahead of `start_time` by at least 15 minutes as a booking of less than 15 minutes is not allowed.
**start_time** <br> <span class="required">`required`</span> | Represents start date and time for booking object. This field accepts value in ISO 8601 format for date-time i.e. yyyy-MM-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given).
**end_time** <br> <span class="required">`required`</span> | Represents end date and time for booking object. This field accepts value in ISO 8601 format for date-time i.e. yyyy-MM-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given). `end_time` must always be ahead of `start_time` by at least 15 minutes as a booking of less than 15 minutes is not allowed.
**role_id**<br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | ID of role object which needs to be performed for this booking. This could be ID of a role which targeted resource performs (i.e "Performing Role") or any other role (i.e. "Non-Performing-Role").
**task_id**<br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | ID of task object which needs to be done in this booking. This could only be ID of a task which is listed in targeted project.
**effort** <br>`optional` | This defines how much effort is needed to complete the task. Effort value is a floating point number which could not be less than 0 and greater than 99999999.99. If effort value is not provided system will take default value 0.
Expand Down Expand Up @@ -444,10 +444,10 @@ Name | Description
---: | :----
**resource_id** <br><span class="required">`required`</span> | ID of resource object which is being booked or scheduled. This will throw an error if you post an empty value.
**project_id** <br><span class="required">`required`</span> | ID of project object which this booking object is being created for. This will throw an error if you post an empty value.
**start_time** <br> <span class="required">`required`</span> | Represents start date and time for booking object. This field accepts value in ISO 8601 format for date-time i.e. yyyy-mm-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given). This will throw an error if you post an empty value.
**end_time** <br> <span class="required">`required`</span> | Represents end date and time for booking object. This field accepts value in ISO 8601 format for date-time i.e. yyyy-mm-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given). `end_time` must always be ahead of `start_time` by at least 15 minutes as a booking of less than 15 minutes is not allowed. This will throw an error if you post an empty value.
**start_time** <br> <span class="required">`required`</span> | Represents start date and time for booking object. This field accepts value in ISO 8601 format for date-time i.e. yyyy-MM-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given). This will throw an error if you post an empty value.
**end_time** <br> <span class="required">`required`</span> | Represents end date and time for booking object. This field accepts value in ISO 8601 format for date-time i.e. yyyy-MM-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given). `end_time` must always be ahead of `start_time` by at least 15 minutes as a booking of less than 15 minutes is not allowed. This will throw an error if you post an empty value.
**role_id**<br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | ID of role object which needs to be performed for this booking. This could be ID of a role which targeted resource performs (i.e "Performing Role") or any other role (i.e. "Non-Performing-Role").
**task_id**<br><span class="removableFlag mln-2">&#9873;</span> | ID of task object which needs to be done in this booking. This could only be ID of a task which is listed in targeted project.
**task_id**<br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span>| ID of task object which needs to be done in this booking. This could only be ID of a task which is listed in targeted project.
**effort** <br>`optional` | This defines how much effort is needed to complete the task. Effort value is a floating point number which could not be less than 0 and greater than 99999999.99. If effort value is not provided system will take default value 0.
**unit**<br>`optional` | Integer number (1-5) representing unit in which effort is being defined. Unit value could be one of the following :<br><br><li>**1** for `Capacity %` : This is default unit for booking. This represents `effort` in percentage of capacity of intended resource for defined time range. </li> <li> **2** for `Total Booking Hours` : This defines `effort` value in fixed hours which doesn't change upon changes in booking.</li> <li> ~~**3** for `Hours Per day` : This could be used where a certain no of hours need to be spend for a booking. For example 4 hours per day (working day).~~</li> <li> **4** for `Full Time Equivalent` : Full time equivalent is calculated using FTE calendar defined in <a href="https://app.eresourcescheduler.cloud/#!/admin/calendars/settings" target="_blank" class="api-ref">Administrator calendar settings</a>. Capacity from FTE calendar for defined time in booking, is considered as 1 FTE.</li> <li> ~~**5** for `Time Per Day` : It is useful where `effort` needs to put in on a particular time of every working day i.e. 4:15 PM to 5:30 PM daily. Time portion of `start_time` argument is considered as per day start time, and Time portion of `end_time` argument is considered per day end time for this booking.~~</li><br>_**Note**: <span class="warning">Booking units **Hours per day** and **Time per day** are no longer supported.</span>_
**progress** <br>`optional` | This defines percentage completion of the booking. Progress is a integer number which could not be less than 0 and greater than 100. If progress is not provided, system will take default value 0.
Expand Down
2 changes: 1 addition & 1 deletion source/includes/_bookingprofile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,4 +190,4 @@ Name | Description
**options** <br> `array of objects` | Field types such as Dropdown Single Select, Dropdown Multi Select, Radio Group etc. ( See <a href="#user-defined-fields" class = "api-ref">User Defined Fields</a> to know more. ) Allows user to pick one or more from these available options.
**options.id** <br> `integer` | Represents unique identification number for the individual option object.
**options.name** <br> `string` | Represents name or content of option object.
**options.color** <br> `string` | Allows a user to store color code of option object. <span class="warning">It is only available for LABEL type fields</span>.
**options.color** <br> `string` | Allows a user to store color code of option object. <span class="warning">Only applicable for LABEL type fields</span>.
4 changes: 2 additions & 2 deletions source/includes/_calendars.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,13 @@ Name | Description
**holidays.id**<br>`integer` | Unique identifier for holiday object.
**holidays.name**<br>`string` | Name of holiday.
**holidays.description**<br>`string` | Description for this holiday object.
**holidays.date**<br>`string`| Represents date on which holiday occurs. This is a string value in ISO 8601 extended Date format i.e. yyyy-mm-dd.
**holidays.date**<br>`string`| Represents date on which holiday occurs. This is a string value in ISO 8601 extended Date format i.e. yyyy-MM-dd.
**holidays.tags**<br>`array of string` | Tags are the list of strings (labels) attached to this holiday object which could be used for the purpose of identification or other information.
**exceptions**<br>`array of objects`| List of exception objects that are applied on calendar object. Exceptions are used to override working timing of calendar for a specified day.
**exceptions.id**<br>`integer` | Unique identifier for exception object.
**exceptions.name**<br>`string` | Name of exception object (which is to be displayed wherever referred).
**exceptions.description**<br>`string` | Description for exception object.
**exceptions.date**<br>`string` | Represents date on which exception is to be applied. This is a string value in ISO 8601 extended Date format i.e. yyyy-mm-dd.
**exceptions.date**<br>`string` | Represents date on which exception is to be applied. This is a string value in ISO 8601 extended Date format i.e. yyyy-MM-dd.
**exceptions.is_working_exception**<br>`boolean` | Indicates whether this exception is working exception or non-working. A working exception is used to override timings of a working day and if applied on a non-working day, it turns it into working day. A non-working exception turns any working day into non-working.
**exceptions.timings**<br>`array of objects` | List of timing objects (or `timing_blocks`) for this exception. This defines working timings for this exception day. There are no timings if exception is a non-working exception.
**exceptions.timings.start_time** <br> `integer` | Represents start time for this timing block in minutes (since 12 AM) i.e. for 6:00 AM, value would be 6 * 60 = 360 and for 9:00 AM it would be 9 * 60 = 540.
Expand Down
40 changes: 23 additions & 17 deletions source/includes/_project.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"description": "Pacific/Honolulu",
"id": 316
},
"project_calendar": 1,
"disable_parallel_booking": false,
"is_archive": false,
"created_on": "2018-08-20T09:25:34.925474Z",
Expand Down Expand Up @@ -165,6 +166,7 @@ curl -v \
"description": "Pacific/Honolulu",
"id": 316
},
"project_calendar": 1,
"disable_parallel_booking": false,
"is_archive": false,
"created_on": "2018-08-20T09:25:34.925474Z",
Expand Down Expand Up @@ -243,6 +245,10 @@ curl -v "https://app.eresourcescheduler.cloud/rest/v1/projects/1" \
"description": "Pacific/Honolulu",
"id": 316
},
"project_calendar": {
"name": "blank",
"id": 2
},
"disable_parallel_booking": false,
"is_archive": false,
"created_on": "2018-08-20T09:25:34.925474Z",
Expand Down Expand Up @@ -520,11 +526,11 @@ curl -v -X GET \

Name | Description
---: | :----
**ID** <br>`Integer`| Auto generated unique identifier for task object.
**name** <br>`String`| Name of task object.
**start_time** <br>`String`| Represents start time of task object.
**end_time** <br>`String`| Represents end time of task object.
**project_id** <br>`Integer` | Unique ID of project object, which this task belongs to.
**ID** <br>`integer`| Auto generated unique identifier for task object.
**name** <br>`string`| Name of task object.
**start_time** <br>`string`| Represents start time of task object.
**end_time** <br>`string`| Represents end time of task object.
**project_id** <br>`integer` | Unique ID of project object, which this task belongs to.
**created_on** <br>`string` | Timestamp at which this task object was created.
**created_by** <br> `object` | Object representing user who created this task object.
**modified_on** <br>`string` | Represents latest modification timestamp.
Expand Down Expand Up @@ -705,12 +711,12 @@ curl -v -X GET \

Name | Description
---: | :----
**ID** <br>`Integer`| Auto generated unique identifier for phase object.
**name** <br>`String` | Name of phase object.
**description** <br> `String` | Any other information regarding this phase.
**start_date** <br>`String`| Represents start date of the phase object.
**end_date** <br>`String`| Represents end date of the phase object.
**project_id** <br>`Integer` | Unique ID of project object, which this phase belongs to.
**ID** <br>`integer`| Auto generated unique identifier for phase object.
**name** <br>`string` | Name of phase object.
**description** <br> `string` | Any other information regarding this phase.
**start_date** <br>`string`| Represents start date of the phase object.
**end_date** <br>`string`| Represents end date of the phase object.
**project_id** <br>`integer` | Unique ID of project object, which this phase belongs to.
**created_on** <br>`string` | Timestamp at which this phase object was created.
**created_by** <br> `object` | Object representing user who created this phase object.
**modified_on** <br>`string` | Represents latest modification timestamp.
Expand Down Expand Up @@ -884,12 +890,12 @@ curl -v -X GET \

Name | Description
---: | :----
**ID** <br>`Integer` | Auto-generated unique identifier for milestone object.
**project_id** <br>`Integer` | Unique ID of project object, which this milestone belongs to.
**name** <br>`String` | Name of milestone object.
**description** <br> `String` | Any information regarding this milestone.
**date** <br>`String`| Represents date of the milestone object.
**color** <br>`String`| String representing hexadecimal color code assigned to the milestone.
**ID** <br>`integer` | Auto-generated unique identifier for milestone object.
**project_id** <br>`integer` | Unique ID of project object, which this milestone belongs to.
**name** <br>`string` | Name of milestone object.
**description** <br> `string` | Any information regarding this milestone.
**date** <br>`string`| Represents date of the milestone object.
**color** <br>`string`| String representing hexadecimal color code assigned to the milestone.
**created_on** <br>`string` | Timestamp at which this milestone object was created.
**created_by** <br> `object` | Object representing user who created this milestone object.
**modified_on** <br>`string` | Represents latest modification timestamp.
Expand Down
4 changes: 2 additions & 2 deletions source/includes/_projecttypes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Name | Description
**id** <br>`integer` |Unique identification number for the object, which allows referring to this object and can be used to search a particular project type.
**name** <br>`string` | Represents name for this object. This is used to identify object by using some meaningful phrase to describe type of projects like `Standard`, `Education` etc.
**description** <br>`string` | Description for project type object.
**color** <br>`String`| String representing hexadecimal color code assigned to the project type.
**color** <br>`string`| String representing hexadecimal color code assigned to the project type.
**fields** <br>`array of objects` |Represents collection of fields (or attributes) that are available for this project type. Each <a href = "#project" class="api-ref">Project</a> object of this project type can store / update values for these field. While creating or updating a <a href = "#project" class="api-ref">Project</a> user must pass arguments which are available for intended project type object.
**fields.id**<br>`integer` | Represents unique identification number of this field, which can be used to refer or search it.
**fields.display_name** <br>`string` |Name of this field to identify it.
Expand All @@ -122,7 +122,7 @@ Name | Description
**fields.options** <br>`string` |Field types such as Dropdown Single Select, Dropdown Multi Select, Radio Group etc. ( See <a href = "#user-defined-fields" class="api-ref">User Defined Fields</a> to know more. ) Allows user to pick one or more from these available options.
**fields.options.id** <br>`integer` | Represents unique identification number for the individual option object.
**fields.options.name** <br>`string` | Represents name or content of option object.
**fields.options.color** <br> `string` | Allows a user to store color code of option object. <span class="warning">It is only available for LABEL type fields</span>.
**fields.options.color** <br> `string` | Allows a user to store color code of option object. <span class="warning">Only applicable for LABEL type fields</span>.



Expand Down
Loading

0 comments on commit 1a0bdc7

Please sign in to comment.