Export schedule(s)Export one or more schedule from Aspire, this endpoint needs at least the OPERATOR role to be executed. Panel |
---|
borderColor | black |
---|
bgColor | #fafafb |
---|
| GET /aspire/_api/schedule/export
GET /aspire/_api/schedules/export/:id
POST /aspire/_api/schedules/exportAll
|
Info |
---|
Every configuration item has the option to export from the UI, using the single menu or by the bulk actions: Image Added Image Added
|
Note |
---|
Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies. |
Note |
---|
Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again. |
Path Parameters and Query parameters
Name | Type | Required | Description |
---|
id | string | Required | The identifier(s) of the schedule(s) to export |
Body Parameter Name | Type | Required | Description |
---|
ids | string | Required | The identifier(s) of the schedule(s) to export |
Examples Code Block |
---|
| GET /aspire/_api/schedules/export/AAABcID5GBc
DELETE /aspire/_api/schedules/export?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/schedules/export
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response Code Block |
---|
| {
"export": {
"schedules": {
"schedule": {
"id": "<schedule_id>",
"type": "time",
"description": "test",
"enabled": "false",
"scheduleTimeType": "daily",
"stopOnFail": false,
"schedule": "0 0 0 1\/1 * ?",
"after": null,
"seeds": "<seed_id>",
"crawlMode": "full",
"completeThreshold": 1.0,
"action": "pause"
},
...
},
"seeds": {
"seed": [
{
"id": "<seed_id>",
"type": "rest-api",
"description": "RestSeed",
"connector": "<connector_id>",
"seed": "N\/A",
"priority": "medium",
"connection": "<connectio_id>",
"workflows": [
"<workflow_id>"
],
"properties": {
"seed": "N\/A",
"crawlRules": [
...
],
"stopOnScannerError": true
}
},
...
]
},
"connectors": {
"connector": [
{
"id": "<connector_id>",
"artifact": "com.accenture.aspire:aspire-rest-source",
"type": "rest-api",
"description": "RestConnector",
"properties": {
"debug": false,
"wDebug": false,
...
}
},
...
]
},
"connections": {
"connection": [
{
"id": "<connection_id>",
"type": "rest-api",
"description": "RestConnection",
"properties": {
....
}
},
...
]
},
"workflows": {
"workflow": [
{
"id": "<workflow_id>",
"type": "connector",
"description": "myWorkFlow",
"templates": {
...
},
"events": {
"event": [
...
]
},
"rules": {
"rule": [
...
]
}
},
...
]
}
}
} |
Status: 200, 404, 406
Section |
---|
Export multiple schedules, filteredExport multiple schedules from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed. Panel |
---|
borderColor | black |
---|
bgColor | #fafafb |
---|
| POST /aspire/_api/schedules/exportAll
|
Filters: The connection filter definition here Response Code Block |
---|
| {
"export": {
"schedules": {
"schedule": {
"id": "<schedule_id>",
"type": "time",
"description": "test",
"enabled": "false",
"scheduleTimeType": "daily",
"stopOnFail": false,
"schedule": "0 0 0 1\/1 * ?",
"after": null,
"seeds": "<seed_id>",
"crawlMode": "full",
"completeThreshold": 1.0,
"action": "pause"
},
...
},
"seeds": {
"seed": [
{
"id": "<seed_id>",
"type": "rest-api",
"description": "RestSeed",
"connector": "<connector_id>",
"seed": "N\/A",
"priority": "medium",
"connection": "<connectio_id>",
"workflows": [
"<workflow_id>"
],
"properties": {
"seed": "N\/A",
"crawlRules": [
...
],
"stopOnScannerError": true
}
},
...
]
},
"connectors": {
"connector": [
{
"id": "<connector_id>",
"artifact": "com.accenture.aspire:aspire-rest-source",
"type": "rest-api",
"description": "RestConnector",
"properties": {
"debug": false,
"wDebug": false,
...
}
},
...
]
},
"connections": {
"connection": [
{
|
|
Update schedule(s)Update schedules in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed. Panel |
---|
borderColor | black |
---|
bgColor | #fafafb |
---|
| PUT /aspire/_api/schedules/:id
PUT /aspire/_api/schedules
|
Path Parameters |