sharepoint_tasks
Creates, updates, deletes, gets or lists a sharepoint_tasks resource.
Overview​
| Name | sharepoint_tasks |
| Type | Resource |
| Id | ovh.ms_services.sharepoint_tasks |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | Task id |
finish_date | string (date-time) | Completion date (wire: finishDate) |
function | string | Function name |
status | string | Task status (cancelled, doing, done, error, todo) |
todo_date | string (date-time) | Creation date (wire: todoDate) |
Sharepoint task details
| Name | Datatype | Description |
|---|---|---|
id | integer | Task id |
finish_date | string (date-time) | Completion date (wire: finishDate) |
function | string | Function name |
status | string | Task status (cancelled, doing, done, error, todo) |
todo_date | string (date-time) | Creation date (wire: todoDate) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id, service_name | Get a SharePoint task (Deprecated, will be removed) | |
list | select | service_name | function, status, x_pagination_mode | Pending actions (Deprecated, will be removed) |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
id | integer | Task id |
service_name | string | The internal name of your Active Directory organization (wire: serviceName) |
function | string | Filter the value of function property (like) |
status | string | Filter the value of status property (=) |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Get a SharePoint task (Deprecated, will be removed)
SELECT
id,
finish_date,
function,
status,
todo_date
FROM ovh.ms_services.sharepoint_tasks
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Pending actions (Deprecated, will be removed)
SELECT
id,
finish_date,
function,
status,
todo_date
FROM ovh.ms_services.sharepoint_tasks
WHERE service_name = '{{ service_name }}' -- required
AND function = '{{ function }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;