| Method | HTTP request | Description |
|---|---|---|
| getByPath | GET /timerules | Retrieve a Time Rule by path. |
| get | GET /timerules/{webId} | Retrieve a Time Rule. |
| update | PATCH /timerules/{webId} | Update a Time Rule by replacing items in its definition. |
| delete | DELETE /timerules/{webId} | Delete a Time Rule. |
getByPath(String path, String selectedFields, String webIdType)
Retrieve a Time Rule by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the Time Rule.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get(String webId, String selectedFields, String webIdType)
Retrieve a Time Rule.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Time Rule.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
update(String webId, PITimeRule timeRule)
Update a Time Rule by replacing items in its definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Time Rule.. | [required] |
| timeRule | PITimeRule | A partial Time Rule containing the desired changes.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete(String webId)
Delete a Time Rule.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the Time Rule.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]