{ "opencollection": "1.0.0", "info": { "name": "UiPath Automation Hub Alerts Entities API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Entities", "type": "folder" }, "items": [ { "info": { "name": "UiPath List Records for an Entity", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/:entityName", "params": [ { "name": "entityName", "value": "", "type": "path", "description": "Name of the custom entity type as defined in the tenant's Data Service schema. Entity names are case-sensitive." }, { "name": "$filter", "value": "example-value", "type": "query", "description": "Filter expression to narrow results by field values" }, { "name": "$orderby", "value": "example-value", "type": "query", "description": "Field name and direction to sort results (e.g., CreatedOn desc)" }, { "name": "$top", "value": "1", "type": "query", "description": "Maximum number of records to return" }, { "name": "$skip", "value": "1", "type": "query", "description": "Number of records to skip for pagination" }, { "name": "$select", "value": "example-value", "type": "query", "description": "Comma-separated list of field names to include in the response" }, { "name": "$expand", "value": "example-value", "type": "query", "description": "Related entity references to expand inline in the response" } ] }, "docs": "Retrieves a list of records for the specified custom entity type. Supports filtering with query expressions, ordering, pagination via skip and top, and field selection. The available entity names and their fields depend on the schema configured within the tenant's Data Service instance. Requires the DataService.Data.Read or DataService.Data scope." }, { "info": { "name": "UiPath Create an Entity Record", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/:entityName", "params": [ { "name": "entityName", "value": "", "type": "path", "description": "Name of the custom entity type as defined in the tenant's Data Service schema. Entity names are case-sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new record for the specified custom entity type. The request body must conform to the entity's schema definition. System-generated fields such as Id, CreatedOn, and CreatedBy are populated automatically and should not be included in the request body. Requires the DataService.Data scope." }, { "info": { "name": "UiPath Get an Entity Record by ID", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/:entityName/:recordId", "params": [ { "name": "entityName", "value": "", "type": "path", "description": "Name of the custom entity type as defined in the tenant's Data Service schema. Entity names are case-sensitive." }, { "name": "recordId", "value": "", "type": "path", "description": "Unique identifier of the entity record" }, { "name": "$select", "value": "example-value", "type": "query", "description": "Comma-separated list of field names to include in the response" }, { "name": "$expand", "value": "example-value", "type": "query", "description": "Related entity references to expand inline in the response" } ] }, "docs": "Retrieves a single entity record by its unique identifier. Returns all fields of the record including system fields. Supports the $select parameter to limit the fields returned. Requires the DataService.Data.Read or DataService.Data scope." }, { "info": { "name": "UiPath Update an Entity Record", "type": "http" }, "http": { "method": "PUT", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/:entityName/:recordId", "params": [ { "name": "entityName", "value": "", "type": "path", "description": "Name of the custom entity type as defined in the tenant's Data Service schema. Entity names are case-sensitive." }, { "name": "recordId", "value": "", "type": "path", "description": "Unique identifier of the entity record" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing entity record by its unique identifier. The request body should include only the fields to update. System-managed fields such as Id, CreatedOn, and CreatedBy cannot be modified. ModifiedOn and ModifiedBy are updated automatically. Requires the DataService.Data scope." }, { "info": { "name": "UiPath Delete an Entity Record", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/:entityName/:recordId", "params": [ { "name": "entityName", "value": "", "type": "path", "description": "Name of the custom entity type as defined in the tenant's Data Service schema. Entity names are case-sensitive." }, { "name": "recordId", "value": "", "type": "path", "description": "Unique identifier of the entity record" } ] }, "docs": "Permanently deletes an entity record by its unique identifier. This action cannot be undone. Requires the DataService.Data scope." }, { "info": { "name": "UiPath Query Entity Records with Advanced Filtering", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1/:entityName/query", "params": [ { "name": "entityName", "value": "", "type": "path", "description": "Name of the custom entity type as defined in the tenant's Data Service schema. Entity names are case-sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs an advanced query against the entity using a structured filter expression in the request body. Supports complex conditions, nested field filtering, and joining conditions with AND and OR operators. Returns a paginated list of matching records. Requires the DataService.Data.Read or DataService.Data scope." } ] } ], "bundled": true }