The schedule API provides functionality that allows a administrator to add, delete or update schedules
List schedules
Lists all the schedules configured in the Aspire
GET /aspire_api/schedule
Query String Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | Optional | Filter returned schedules to only those with the given type |
| description | string | Optional | Filter returned schedules to only those whose description matches the given expression |
Response
{
"schedule": [{
"id": "AAABcID5GBc=",
"type": "filesystem",
...
},
{
"id": "AAABcIueWUc=",
"type": "filesystem",
...
}],
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
Get a single schedule
Get information about a single schedule configured in Aspire
GET /aspire_api/schedule?id=:id
GET /aspire_api/schedule/:id
Query String and Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The id of the schedule to return |
Response
{
"schedule": {
"id": "AAABcID5GBc=",
"type": "filesystem",
...
},
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | The given schedules id was not found |
Add schedule(s)
Add one or more schedules to Aspire
POST /aspire_api/schedule
Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | Required | The type of schedule to add |
| description | string | Optional | An optional description of the schedule |
Other parameters passed in the request body will depend on the type of schedule being created - those required by Documentum will be different from those required by SharePoint. Some candidates are shown below
| Name | Description |
|---|---|
| domain | An Active Directory/LDAP domain |
| username | A username |
| password | A password |
| A user email address | |
| APIkey | An API key |
| token | an access token |
Examples
Add a single schedule
{
"type": "filesystem"
"description": "Europe Net Appliance"
...
}
Add multiple schedules
[{
"type": "filesystem"
"description": "Europe Net Appliance"
...
},
{
"type": "sharepoint"
"description": "SP Online"
...
}]
Response
{
"schedule": [{
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "Europe Net Appliance"
...
},
{
"id": "AAABcIueWUc=",
"type": "sharepoint"
"description": "SP Online"
...
}],
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 201 | Created |
| 406 | Not acceptable - there was an issue validating the input |
Update schedule(s)
Update one or more schedules in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null
PUT /aspire_api/schedule
Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier of the schedule to update |
| type | string | Required | The type of schedule |
| description | string | Optional | An optional description of the schedule |
Other parameters passed in the request body will depend on the type of schedule being created - see Add schedule(s) above
Examples
Update a single schedule
{
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "Europe Net Appliance"
...
}
Update multiple schedules
[{
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "Europe Net Appliance"
...
},
{
"id": "AAABcIueWUc=",
"type": "sharepoint"
"description": "SP Online"
...
}]
Response
{
"schedule": [{
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "Europe Net Appliance"
...
},
{
"id": "AAABcIueWUc=",
"type": "sharepoint"
"description": "SP Online"
...
}],
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 201 | Created |
| 404 | Not found - a given schedule identifier was not found |
| 406 | Not acceptable - there was an issue validating the input |
Delete schedule(s)
Delete one or more schedules from Aspire.
DELETE /aspire_api/schedule?id=:id
DELETE /aspire_api/schedule/:id
DELETE /aspire_api/schedule
Query String, Path and Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier(s) of the schedule(s) to delete |
Examples
Delete a single schedule
{
"id": "AAABcID5GBc="
}
Delete multiple schedules
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}]
Delete multiple schedules (alternative form)
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
}
Response
{
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | Not found - a given schedule identifier was not found |
| 406 | Not acceptable - there was an issue validating the input |
Overview
Content Tools
Copyright © 2024 Accenture
