{ "opencollection": "1.0.0", "info": { "name": "Alteryx Server API V3 Collections Schedules API", "version": "3.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{serverHostname}/webapi/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Schedules", "type": "folder" }, "items": [ { "info": { "name": "Retrieve All Schedules", "type": "http" }, "http": { "method": "GET", "url": "https://{serverHostname}/webapi/v3/schedules", "params": [ { "name": "view", "value": "", "type": "query", "description": "Level of detail in the response" }, { "name": "ownerId", "value": "", "type": "query", "description": "Filter by schedule owner" }, { "name": "workflowId", "value": "", "type": "query", "description": "Filter by associated workflow" }, { "name": "runsAfter", "value": "", "type": "query", "description": "Filter schedules that run after this date (ISO 8601, max 45-day range)" }, { "name": "runsBefore", "value": "", "type": "query", "description": "Filter schedules that run before this date (ISO 8601, max 45-day range)" } ] }, "docs": "Retrieve information about all schedules with optional filtering." }, { "info": { "name": "Create a New Schedule", "type": "http" }, "http": { "method": "POST", "url": "https://{serverHostname}/webapi/v3/schedules", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new execution schedule for a workflow." }, { "info": { "name": "Retrieve a Specific Schedule", "type": "http" }, "http": { "method": "GET", "url": "https://{serverHostname}/webapi/v3/schedules/:scheduleId", "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "Unique identifier of the schedule" } ] }, "docs": "Retrieve detailed information about a specific schedule." }, { "info": { "name": "Update a Schedule", "type": "http" }, "http": { "method": "PUT", "url": "https://{serverHostname}/webapi/v3/schedules/:scheduleId", "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "Unique identifier of the schedule" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update all properties of an existing schedule. All required fields must be provided." }, { "info": { "name": "Partially Update a Schedule", "type": "http" }, "http": { "method": "PATCH", "url": "https://{serverHostname}/webapi/v3/schedules/:scheduleId", "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "Unique identifier of the schedule" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update specific properties of an existing schedule without requiring all fields." }, { "info": { "name": "Delete a Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://{serverHostname}/webapi/v3/schedules/:scheduleId", "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "Unique identifier of the schedule" } ] }, "docs": "Remove a schedule from the system." } ] } ], "bundled": true }