Search our Wiki
REST API Schedules Get Schedules
Below you see an example on how to list schedules. Examples both in JSON and JSONAPI are provided.
NOTE: Remember to substitute the token (after Bearer) and the service id (the [SERVICE ID] below) to your own token and service id.
JSON:
curl -H "Authorization: Bearer [API SECURITY TOKEN]" -H "Content-Type: application/json" -H "Accept: application/json" -X GET https://api.myrapidi.com/api/v2/service/[SERVICE ID]/schedules
The out-put for this example would be:
[
{
"code": "G_CUST4494",
"description": "Group CUST4494",
"transfer": "",
"group": "CUST4494",
"interval": 1,
"interval_unit": "Hour",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": null,
"next_datetime": "2016-12-23T18:00:00Z",
"error_interval": 1,
"error_interval_unit": "Hour",
"notify_interval": 1,
"notify_interval_unit": "Hour",
"notify_datetime": null,
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
"tags": [],
"comments": []
},
{
"code": "G_INVOICE",
"description": "Group INVOICE",
"transfer": "",
"group": "INVOICE",
"interval": 5,
"interval_unit": "Minutes",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": null,
"next_datetime": "2015-09-29T16:32:00Z",
"error_interval": 0,
"error_interval_unit": "Minutes",
"notify_interval": 0,
"notify_interval_unit": "Minutes",
"notify_datetime": null,
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
"tags": [],
"comments": []
},
{
"code": "G_TEST22",
"description": "Group TEST22",
"transfer": "",
"group": "TEST22",
"interval": 1,
"interval_unit": "Week",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": "2014-03-30T15:59:07Z",
"next_datetime": "2016-09-29T17:27:00Z",
"error_interval": 1,
"error_interval_unit": "Day",
"notify_interval": 2,
"notify_interval_unit": "Hours",
"notify_datetime": "2014-03-30T17:01:00Z",
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
"tags": [],
"comments": []
},
{
"code": "G_TEST22_NAV356001",
"description": "Group TEST22 NAV356001",
"transfer": "",
"group": "TEST22",
"interval": 1,
"interval_unit": "Day",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": null,
"next_datetime": "2015-10-01T00:00:00Z",
"error_interval": 0,
"error_interval_unit": "Hours",
"notify_interval": 0,
"notify_interval_unit": "Hours",
"notify_datetime": null,
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
"tags": [
{
"code": "NAV300",
"value": "NAV356001"
}
],
"comments": []
},
{
"code": "T_A0_TEST_READ_LONG_FILTER_FROM_NAV",
"description": "Transfer A0_TEST_READ_LONG_FILTER_FROM_NAV",
"transfer": "A0_TEST_READ_LONG_FILTER_FROM_NAV",
"group": "",
"interval": 1,
"interval_unit": "Hour",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": "2016-12-23T12:00:08Z",
"next_datetime": "2016-12-23T18:00:00Z",
"error_interval": 1,
"error_interval_unit": "Hour",
"notify_interval": 1,
"notify_interval_unit": "Hour",
"notify_datetime": "2016-12-23T14:00:00Z",
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": false,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
"tags": [
{
"code": "NEWTAG",
"value": null
}
],
"comments": []
},
{
"code": "T_A4_CRM2013_READ",
"description": "Transfer A4_CRM2013_READ",
"transfer": "A4_CRM2013_READ",
"group": "",
"interval": 19,
"interval_unit": "Minutes",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": null,
"next_datetime": "2015-09-16T00:02:00Z",
"error_interval": 11,
"error_interval_unit": "Minutes",
"notify_interval": 22,
"notify_interval_unit": "Minutes",
"notify_datetime": null,
"start_time": "00:00:00Z",
"end_time": "01:00:00Z",
"monday": true,
"tuesday": false,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
"tags": [
{
"code": "NEWTAG",
"value": null
}
],
"comments": []
},
...
]
JSONAPI:
Get Schedules:
curl -H "Authorization: Bearer [API SECURITY TOKEN]" -H "Content-Type: application/vnd.api+json" -H "Accept: application/vnd.api+json" -X GET https://api.myrapidi.com/api/v2/service/[SERVICE ID]/schedules
The out-put for this example would be:
{
"data": [
{
"id": "17",
"type": "schedules",
"attributes": {
"code": "G_CUST4494",
"description": "Group CUST4494",
"transfer": "",
"group": "CUST4494",
"interval": 1,
"interval_unit": "Hour",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": null,
"next_datetime": "2016-12-23T18:00:00Z",
"error_interval": 1,
"error_interval_unit": "Hour",
"notify_interval": 1,
"notify_interval_unit": "Hour",
"notify_datetime": null,
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
},
"relationships": {
"tags": {
"data": []
},
"comments": {
"data": []
}
}
},
{
"id":"18",
"type": "schedules",
"attributes": {
"code": "G_INVOICE",
"description": "Group INVOICE",
"transfer": "",
"group": "INVOICE",
"interval": 5,
"interval_unit": "Minutes",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": null,
"next_datetime": "2015-09-29T16:32:00Z",
"error_interval": 0,
"error_interval_unit": "Minutes",
"notify_interval": 0,
"notify_interval_unit": "Minutes",
"notify_datetime": null,
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"relationships": {
"tags": {
"data": []
},
"comments": {
"data": []
}
}
},
{
"id": "15",
"type": "schedules",
"attributes": {
"code": "G_TEST22",
"description": "Group TEST22",
"transfer": "",
"group": "TEST22",
"interval": 1,
"interval_unit": "Week",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": "2014-03-30T15:59:07Z",
"next_datetime": "2016-09-29T17:27:00Z",
"error_interval": 1,
"error_interval_unit": "Day",
"notify_interval": 2,
"notify_interval_unit": "Hours",
"notify_datetime": "2014-03-30T17:01:00Z",
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"relationships": {
"tags": {
"data": [
{
"id": "2",
"type": "schedule-tags"
}
]
},
"comments": {
"data": []
}
}
},
{
"id": "19",
"type": "schedules",
"attributes": {
"code": "G_TEST22_NAV356001",
"description": "Group TEST22 NAV356001",
"transfer": "",
"group": "TEST22",
"interval": 1,
"interval_unit": "Day",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": null,
"next_datetime": "2015-10-01T00:00:00Z",
"error_interval": 0,
"error_interval_unit": "Hours",
"notify_interval": 0,
"notify_interval_unit": "Hours",
"notify_datetime": null,
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"relationships": {
"tags": {
"data": [
{
"id": "7",
"type": "schedule_tags"
}
]
},
"comments": {
"data": []
}
}
},
{
"id": "20",
"type": "schedules",
"attributes": {
"code": "T_A0_TEST_READ_LONG_FILTER_FROM_NAV",
"description": "Transfer A0_TEST_READ_LONG_FILTER_FROM_NAV",
"transfer": "A0_TEST_READ_LONG_FILTER_FROM_NAV",
"group": "",
"interval": 1,
"interval_unit": "Hour",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": "2016-12-23T12:00:08Z",
"next_datetime": "2016-12-23T18:00:00Z",
"error_interval": 1,
"error_interval_unit": "Hour",
"notify_interval": 1,
"notify_interval_unit": "Hour",
"notify_datetime": "2016-12-23T14:00:00Z",
"start_time": "00:00:00Z",
"end_time": "00:00:00Z",
"monday": false,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"relationships": {
"tags": {
"data": [
{
"id": "11",
"type": "schedule_tags"
}
]
},
"comments": {
"data": []
}
}
},
{
"id": "16",
"type": "schedules",
"attributes": {
"code": "T_A4_CRM2013_READ",
"description": "Transfer A4_CRM2013_READ",
"transfer": "A4_CRM2013_READ",
"group": "",
"interval": 19,
"interval_unit": "Minutes",
"status": "Stopped",
"error_handling": "Skip",
"last_datetime": null,
"next_datetime": "2015-09-16T00:02:00Z",
"error_interval": 11,
"error_interval_unit": "Minutes",
"notify_interval": 22,
"notify_interval_unit": "Minutes",
"notify_datetime": null,
"start_time": "00:00:00Z",
"end_time": "01:00:00Z",
"monday": true,
"tuesday": false,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"relationships: {
"tags": {
"data": [
{
"id": "3",
"type": "schedule_tags"
}
]
},
"comments": {
"data": [
{
"id": "51",
"type": "comments"
}
]
}
}
}
],
included": [
{
"id": "2",
"type": "schedule_tags",
"attributes": {
"code": "NAV212",
"value": "NAV356001"
}
},
{
"id": "7",
"type": "schedule_tags",
"attributes": {
"code": "NEWTAG",
"value": null
}
},
{
"id": "11",
"type": "schedule_tags",
"attributes: {
"code": "NEWTAG",
"value": null
}
},
{
"id": "3",
"type": "schedule_tags",
"attributes": {
"code": "NEWTAG",
"value": null
}
},
{
"id": "51",
"type": "comments",
"attributes": {
"created_at": "2017-08-15T20:41:54Z",
"created_by": "mibock",
"comment": "<p>ready to be set live</p>"
}
}
]
}