{ "opencollection": "1.0.0", "info": { "name": "UiPath Automation Hub Alerts Jobs API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Jobs", "type": "folder" }, "items": [ { "info": { "name": "UiPath List Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/odata/Jobs", "headers": [ { "name": "X-UIPATH-OrganizationUnitId", "value": "" } ], "params": [ { "name": "$filter", "value": "", "type": "query", "description": "OData filter expression to narrow results (e.g., State eq 'Running')" }, { "name": "$orderby", "value": "", "type": "query", "description": "OData orderby clause (e.g., CreationTime desc)" }, { "name": "$top", "value": "", "type": "query", "description": "Maximum number of records to return (default 100, max 1000)" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of records to skip for pagination" }, { "name": "$select", "value": "", "type": "query", "description": "Comma-separated list of property names to include in the response" } ] }, "docs": "Retrieves a list of jobs in the current folder. Supports OData query options including $filter, $orderby, $top, $skip, and $select to control the result set. Jobs represent individual executions of automation processes by robots." }, { "info": { "name": "UiPath Get a Job by ID", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/odata/Jobs(:key)", "headers": [ { "name": "X-UIPATH-OrganizationUnitId", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The unique integer identifier of the entity" } ] }, "docs": "Retrieves a single job by its unique integer identifier. Returns full job details including state, start and end times, robot information, and associated process." }, { "info": { "name": "UiPath Start Jobs", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs", "headers": [ { "name": "X-UIPATH-OrganizationUnitId", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts one or more automation jobs for a specified process. Allows specifying the strategy for robot allocation (e.g., ModernJobsCount, All, RobotIds), input arguments for the process, job priority, and the target folder. Returns details of the created jobs." }, { "info": { "name": "UiPath Stop a Job", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/odata/Jobs/UiPath.Server.Configuration.OData.StopJob", "headers": [ { "name": "X-UIPATH-OrganizationUnitId", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends a stop signal to a running job. The strategy can be SoftStop (waits for the current activity to finish) or Kill (forcefully terminates the job immediately). Requires the job ID." } ] } ], "bundled": true }