{ "info": { "name": "PBRS Public REST API", "description": "# PBRS API Collection\n\nUse this collection with the PBRS Environment Template.\n\n## Setup\n\n1. Import the collection and environment into Postman.\n \n2. Select the environment.\n \n3. Set baseUrl to your PBRS API address, including protocol and port, without a trailing slash or /api suffix.\n \n4. Enter your enabled PBRS API client's client_id and client_secret in your local environment values.\n \n\nKeep credentials and tokens out of shared or exported files.\n\n## Authenticate\n\nSend Authenticate an API client. Its After response script stores the returned token in access_token.\n\nAuthenticated requests should use Inherit auth from parent. The collection uses Bearer Token authentication with {{access_token}}. Token requests and Ping require No Auth.\n\nTokens expire after 60 minutes. Authenticate again to obtain a new token.\n\n## Execute and monitor a schedule\n\n1. Set schedule_id to an existing schedule's numeric identifier.\n \n2. Set schedule_type to report for a single-report schedule or package for a report package.\n \n3. Send Queue a schedule asynchronously. Its After response script stores execution_id.\n \n4. Send GetExecutionStatus to inspect that execution.\n \n\nInspect the execution result and confirm delivery. A Completed status alone does not establish success.\n\n## Other requests\n\nReplace example identifiers, report paths, recipients, and configuration values before sending other requests. They are not automatically populated by the environment.\n\nRun requests individually. Running the entire collection can create, modify, execute, or delete schedules and change service settings.\n\n## Documentation\n\n[https://christiansteven.readme.io/docs/pbrs-rest-api-overview](https://christiansteven.readme.io/docs/pbrs-rest-api-overview)\n\n## Environment variables\n\n| Variable | Purpose |\n| --- | --- |\n| baseUrl | PBRS API origin, without /api or a trailing slash |\n| client_id | Enabled API client ID |\n| client_secret | API client secret |\n| access_token | Populated by client authentication |\n| schedule_id | Numeric identifier of an existing schedule |\n| schedule_type | report or package for this workflow |\n| execution_id | Populated by asynchronous execution |\n\nLeave credentials, tokens, and identifiers empty in the distributed environment template. The request bodies contain numeric variable substitutions that become valid JSON after a schedule ID is provided. Authentication and execution scripts clear the previous stored result before capturing a new successful response.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "api", "item": [ { "name": "Folder", "item": [ { "name": "Createfolder", "item": [ { "name": "Create a folder", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"foldername\": \"API Reports\",\n \"parentid\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Folder/Createfolder", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "Createfolder" ] }, "description": "Create a child folder using lowercase foldername and parentid. The response is a boolean, not the new folder identifier. Resolve the resulting path to obtain FolderId. Duplicate names and invalid parents can fail." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"foldername\": \"API Reports\",\n \"parentid\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Folder/Createfolder", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "Createfolder" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "true" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"foldername\": \"API Reports\",\n \"parentid\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Folder/Createfolder", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "Createfolder" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Get", "item": [ { "name": "Get a folder", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Folder/Get?id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "Get" ], "query": [ { "key": "id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Retrieve one folder by numeric identifier. Subfolders and schedules are separate operations." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Folder/Get?id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "Get" ], "query": [ { "description": "Identifier of the selected resource.", "key": "id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"FolderId\": 12,\n \"FolderName\": \"API Reports\",\n \"FolderParent\": 0,\n \"SubFolders\": [],\n \"NumberOfChildren\": 0,\n \"FullPath\": \"/API Reports\",\n \"Schedules\": []\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Folder/Get?id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "Get" ], "query": [ { "description": "Identifier of the selected resource.", "key": "id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetFolderFromPath", "item": [ { "name": "Resolve a folder path", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"/API Reports\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Folder/GetFolderFromPath", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetFolderFromPath" ] }, "description": "Resolve an existing PBRS folder path into its folder representation." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"/API Reports\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Folder/GetFolderFromPath", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetFolderFromPath" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"FolderId\": 12,\n \"FolderName\": \"API Reports\",\n \"FolderParent\": 0,\n \"SubFolders\": [],\n \"NumberOfChildren\": 0,\n \"FullPath\": \"/API Reports\",\n \"Schedules\": []\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"/API Reports\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Folder/GetFolderFromPath", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetFolderFromPath" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetSchedules", "item": [ { "name": "List schedules in a folder", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Folder/GetSchedules?id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetSchedules" ], "query": [ { "key": "id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "List schedules visible to the authenticated user in the selected PBRS folder." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Folder/GetSchedules?id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetSchedules" ], "query": [ { "description": "Identifier of the selected resource.", "key": "id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"uniqueid\": 101,\n \"Name\": \"Daily sales\",\n \"ScheduleType\": \"report\",\n \"IsDataDriven\": false,\n \"IsEnabled\": true,\n \"NextRunEpoch\": 1789549200,\n \"ScheduleId\": 501,\n \"LastResult\": {\n \"Id\": 8001,\n \"ScheduleId\": 101,\n \"ExecutionDateEpoch\": 1789462800,\n \"Result\": \"true\",\n \"ResultMessage\": \"\",\n \"ScheduleName\": null,\n \"StartedAtUtc\": null,\n \"FinishedAtUtc\": null\n },\n \"DestinationsTypes\": \"Email\",\n \"ReportType\": \"PowerBI\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"Keywords\": \"api,sales\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Folder/GetSchedules?id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetSchedules" ], "query": [ { "description": "Identifier of the selected resource.", "key": "id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetSubFolders", "item": [ { "name": "List subfolders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Folder/GetSubFolders?id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetSubFolders" ], "query": [ { "key": "id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Retrieve the subfolders beneath the supplied PBRS folder identifier." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Folder/GetSubFolders?id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetSubFolders" ], "query": [ { "description": "Identifier of the selected resource.", "key": "id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"FolderId\": 12,\n \"FolderName\": \"API Reports\",\n \"FolderParent\": 0,\n \"SubFolders\": [],\n \"NumberOfChildren\": 0,\n \"FullPath\": \"/API Reports\",\n \"Schedules\": []\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Folder/GetSubFolders?id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetSubFolders" ], "query": [ { "description": "Identifier of the selected resource.", "key": "id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetUniqueIdFromPath", "item": [ { "name": "Resolve a schedule identifier", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"/API Reports\",\n \"scheduleName\": \"Daily sales\",\n \"scheduleType\": \"report\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Folder/GetUniqueIdFromPath", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetUniqueIdFromPath" ] }, "description": "Resolve a folder path, schedule name and schedule type into uniqueid. Use this identifier with the corresponding schedule operations." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"/API Reports\",\n \"scheduleName\": \"Daily sales\",\n \"scheduleType\": \"report\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Folder/GetUniqueIdFromPath", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetUniqueIdFromPath" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uniqueid\": 101\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"/API Reports\",\n \"scheduleName\": \"Daily sales\",\n \"scheduleType\": \"report\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Folder/GetUniqueIdFromPath", "host": [ "{{baseUrl}}" ], "path": [ "api", "Folder", "GetUniqueIdFromPath" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "Login", "item": [ { "name": "token", "item": [ { "name": "Authenticate a PBRS user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"api.integration\",\n \"password\": \"ExamplePassword-92!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Login/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "Login", "token" ] }, "description": "Authenticate using username or email and password. A completed login returns token and ExpiryDateEpoch. Tokens expire after 60 minutes. Send Authorization: bearer followed by the returned token. RequiresMfa=true indicates a challenge rather than an authenticated session; do not treat the challenge response as an authenticated session. Incorrect credentials return HTTP 401.", "auth": { "type": "noauth" } }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"api.integration\",\n \"password\": \"ExamplePassword-92!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Login/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "Login", "token" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"sessionId\": \"b2ad1236-e4f9-43d5-9593-993347fa4792\",\n \"UserId\": \"api.integration\",\n \"FirstName\": \"API\",\n \"LastName\": \"Integration\",\n \"role\": \"Administrator\",\n \"ExpiryDateEpoch\": 1789466400,\n \"token\": \"DemonstrationTokenValueNotACredential\",\n \"token_type\": \"custom\",\n \"RequiresMfa\": false,\n \"MfaChallengeToken\": null\n}" }, { "name": "Authentication rejected. No JSON payload is promised by this Unauthorized result.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"api.integration\",\n \"password\": \"ExamplePassword-92!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Login/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "Login", "token" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "Package", "item": [ { "name": "Clone", "item": [ { "name": "Clone a package", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Package/Clone?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "Clone" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Create a copy of the package. Returns the new package identifier as a JSON integer. This GET changes persisted data; automatic retries can create duplicate copies." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Package/Clone?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "Clone" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "202" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Package/Clone?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "Clone" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Create", "item": [ { "name": "Create a package through Package", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Package/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "Create" ] }, "description": "Create a package using the Package controller. This is a separate public operation from PackageSchedule/Create and has different controller validation. Supply ScheduleName, Schedule, report collections and intended destinations. Include both EmailDestinations and DiskDestinations as non-null arrays. Use [] for an unused collection; use JSON when an empty collection is needed. Form examples include both an email destination and a disk destination. Replace the example recipients and paths with your intended destinations." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Package/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "Create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uniqueid\": 201\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Package/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "Create" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Get", "item": [ { "name": "Get a package through Package", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Package/Get?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "Get" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Read a package definition. A read projection is not a lossless backup of every setting; preserve source definitions for migration and updates." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Package/Get?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "Get" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": [],\n \"uniqueid\": 201\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Package/Get?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "Get" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetReportsInPackage", "item": [ { "name": "List reports in a package", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Package/GetReportsInPackage?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "GetReportsInPackage" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Return schedule summaries for the reports belonging to a package." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Package/GetReportsInPackage?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "GetReportsInPackage" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"uniqueid\": 101,\n \"Name\": \"Daily sales\",\n \"ScheduleType\": \"report\",\n \"IsDataDriven\": false,\n \"IsEnabled\": true,\n \"NextRunEpoch\": 1789549200,\n \"ScheduleId\": 501,\n \"LastResult\": {\n \"Id\": 8001,\n \"ScheduleId\": 101,\n \"ExecutionDateEpoch\": 1789462800,\n \"Result\": \"true\",\n \"ResultMessage\": \"\",\n \"ScheduleName\": null,\n \"StartedAtUtc\": null,\n \"FinishedAtUtc\": null\n },\n \"DestinationsTypes\": \"Email\",\n \"ReportType\": \"PowerBI\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"Keywords\": \"api,sales\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Package/GetReportsInPackage?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "Package", "GetReportsInPackage" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "PackageSchedule", "item": [ { "name": "Create", "item": [ { "name": "Create a package", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Create" ] }, "description": "Create a package with the selected report collections, recurrence, destinations and optional data driver. For data-driven packages provide ValuesJson or Query. SQL validation can contact the configured data source. Do not retry blindly after an ambiguous outcome. Include both EmailDestinations and DiskDestinations as non-null arrays. Use [] for an unused collection; use JSON when an empty collection is needed. Form examples include both an email destination and a disk destination. Replace the example recipients and paths with your intended destinations." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uniqueid\": 201\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Create", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Create" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Delete", "item": [ { "name": "Delete a package", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Delete?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Delete" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Delete the package identified by Id. Requires an account permitted to modify schedules. Returns a JSON boolean." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Delete?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Delete" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "true" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Delete?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Delete" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Get", "item": [ { "name": "Get a package", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Get?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Get" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Retrieve the package definition and populated report collections. Read-back omissions must not be interpreted as instructions to clear settings." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Get?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Get" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": [],\n \"uniqueid\": 201\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Get?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Get" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetAll", "item": [ { "name": "Search packages by keywords", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/PackageSchedule/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "GetAll" ] }, "description": "Search package schedules using an explicit keyword request body. Missing or empty filters trigger a generated value; default LIKE normally matches nothing, while negative operators can behave differently.\n\nThis GET binds a JSON body. OpenAPI 3.0 API explorers cannot reliably send it. Use the cURL example.\n\n| Body field | Type | Meaning |\n|---|---|---|\n| FilterValues | array | Explicit keyword values to match. Omitting the body or sending an empty collection triggers a generated search value; default LIKE normally returns no matches. Negative operators can behave differently. |\n| FilterOperator | string | Keyword comparison operator. |\n| MatchType | string | Combine keyword comparisons using ALL or ANY. |\n\nBody schema: `KeywordSearchInput`. The complete schema is retained in components and x-pbrs-request-body." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PackageSchedule/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "GetAll" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": [],\n \"uniqueid\": 201\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PackageSchedule/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "GetAll" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Update", "item": [ { "name": "Update a package", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": [],\n \"uniqueid\": 201\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Update", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Update" ] }, "description": "Update an existing package using uniqueid. Submit the full intended definition, including report and destination collections. Data-driver changes can trigger SQL validation; the masked existing password is handled specially by this update path. The response echoes the submitted model and is not an independent database read-back. Include both EmailDestinations and DiskDestinations as non-null arrays. Use [] for an unused collection; use JSON when an empty collection is needed. Form examples include both an email destination and a disk destination. Replace the example recipients and paths with your intended destinations. Preserve the complete intended destination lists and their existing DestinationId values. Omitting an existing destination from a list removes it. For a SQL data driver, Password=\"*****\" reuses the stored password for this package; an existing data-driver record must be available or the request fails. The marker is not a new credential. Changing DSN, UserId or Query triggers validation using the retained password. To change the password, supply the new value. This preservation rule applies to this update operation and must not be assumed for creation or unrelated endpoints." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": [],\n \"uniqueid\": 201\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Update", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Update" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": [],\n \"uniqueid\": 201\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales package\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"GroupByEmail\": false,\n \"PowerBIReports\": [\n {\n \"ReportName\": \"Sales overview\",\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OrderNumber\": 0,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n }\n ],\n \"PowerBiPaginatedReports\": [],\n \"SsrsReports\": [],\n \"PBIRSReports\": [],\n \"uniqueid\": 201\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/PackageSchedule/Update", "host": [ "{{baseUrl}}" ], "path": [ "api", "PackageSchedule", "Update" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "PowerBiAccount", "item": [ { "name": "GetDashboards", "item": [ { "name": "List Power BI dashboards", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetDashboards", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetDashboards" ] }, "description": "List dashboards for a configured Power BI account and workspace. Account permissions are checked. Obtain the account identifier from your PBRS administrator.\n\nThis GET binds a JSON body. OpenAPI 3.0 API explorers cannot reliably send it. Use the cURL example.\n\n| Body field | Type | Meaning |\n|---|---|---|\n| AccountId | string | Request body property. |\n| WorkspaceId | string | Request body property. |\n\nBody schema: `ReportQueryInput`. The complete schema is retained in components and x-pbrs-request-body." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetDashboards", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetDashboards" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"Name\": \"Sales dashboard\",\n \"Url\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/dashboards/64e25062-4786-43be-bfea-56ec8b9aaeca\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetDashboards", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetDashboards" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetPaginatedReports", "item": [ { "name": "List Power BI paginated reports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetPaginatedReports", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetPaginatedReports" ] }, "description": "List paginated reports for the supplied account and workspace. The actual controller action is GetPaginatedReports; it does not use the scheduler-stop route shown in older documentation.\n\nThis GET binds a JSON body. OpenAPI 3.0 API explorers cannot reliably send it. Use the cURL example.\n\n| Body field | Type | Meaning |\n|---|---|---|\n| AccountId | string | Request body property. |\n| WorkspaceId | string | Request body property. |\n\nBody schema: `ReportQueryInput`. The complete schema is retained in components and x-pbrs-request-body." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetPaginatedReports", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetPaginatedReports" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"Name\": \"Sales detail\",\n \"Url\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetPaginatedReports", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetPaginatedReports" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetReports", "item": [ { "name": "List Power BI reports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetReports", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetReports" ] }, "description": "List Power BI reports for the supplied account and workspace. Returned values contain Name and Url.\n\nThis GET binds a JSON body. OpenAPI 3.0 API explorers cannot reliably send it. Use the cURL example.\n\n| Body field | Type | Meaning |\n|---|---|---|\n| AccountId | string | Request body property. |\n| WorkspaceId | string | Request body property. |\n\nBody schema: `ReportQueryInput`. The complete schema is retained in components and x-pbrs-request-body." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetReports", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetReports" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"Name\": \"Sales overview\",\n \"Url\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetReports", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetReports" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetVisualsForReport", "item": [ { "name": "Discover report visuals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetVisualsForReport", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetVisualsForReport" ] }, "description": "Return visual strings grouped by page index. JSON property names encode the integer page indexes. Use the returned values with visual-data export settings.\n\nThis GET binds a JSON body. OpenAPI 3.0 API explorers cannot reliably send it. Use the cURL example.\n\n| Body field | Type | Meaning |\n|---|---|---|\n| AccountId | string | Request body property. |\n| ReportUrl | string | Request body property. |\n\nBody schema: `VisualQueryInput`. The complete schema is retained in components and x-pbrs-request-body." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetVisualsForReport", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetVisualsForReport" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"0\": [\n \"Sales by region\",\n \"Monthly revenue\"\n ]\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetVisualsForReport", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetVisualsForReport" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetWorkspaces", "item": [ { "name": "List Power BI workspaces", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetWorkspaces?Id=7f320302-7ccb-4aba-a052-56197424ab36", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetWorkspaces" ], "query": [ { "key": "Id", "value": "7f320302-7ccb-4aba-a052-56197424ab36", "description": "Configured Power BI account identifier." } ] }, "description": "List workspaces accessible through the configured Power BI account. Id is the account identifier, not a workspace identifier." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetWorkspaces?Id=7f320302-7ccb-4aba-a052-56197424ab36", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetWorkspaces" ], "query": [ { "description": "Configured Power BI account identifier.", "key": "Id", "value": "7f320302-7ccb-4aba-a052-56197424ab36" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"Name\": \"Sales\",\n \"Id\": \"7f320302-7ccb-4aba-a052-56197424ab36\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/PowerBiAccount/GetWorkspaces?Id=7f320302-7ccb-4aba-a052-56197424ab36", "host": [ "{{baseUrl}}" ], "path": [ "api", "PowerBiAccount", "GetWorkspaces" ], "query": [ { "description": "Configured Power BI account identifier.", "key": "Id", "value": "7f320302-7ccb-4aba-a052-56197424ab36" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "Schedule", "item": [ { "name": "CancelExecution", "item": [ { "name": "Terminate an execution process", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/CancelExecution?ExecutionId=b2ad1236-e4f9-43d5-9593-993347fa4792", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "CancelExecution" ], "query": [ { "key": "ExecutionId", "value": "b2ad1236-e4f9-43d5-9593-993347fa4792", "description": "Execution identifier returned by asynchronous submission." } ] }, "description": "Terminate the process associated with ExecutionId. The service looks up the execution record, resolves ProcessId and kills that process, then records Terminated by user with a failed result. A waiting execution without a live associated process may fail; this is not a general guarantee that any queued job can be removed. This GET changes execution state. Already rendered or delivered outputs are not undone. The recorded result has ErrorMessage=\"Execution cancelled by user\", ErrorNumber=-102562911 and Result=false. Poll status after cancellation to reconcile the result." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/CancelExecution?ExecutionId=b2ad1236-e4f9-43d5-9593-993347fa4792", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "CancelExecution" ], "query": [ { "description": "Execution identifier returned by asynchronous submission.", "key": "ExecutionId", "value": "b2ad1236-e4f9-43d5-9593-993347fa4792" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Result\": \"Execution cancelled successfully\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/CancelExecution?ExecutionId=b2ad1236-e4f9-43d5-9593-993347fa4792", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "CancelExecution" ], "query": [ { "description": "Execution identifier returned by asynchronous submission.", "key": "ExecutionId", "value": "b2ad1236-e4f9-43d5-9593-993347fa4792" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "DisableSchedule", "item": [ { "name": "Disable a schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/DisableSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "DisableSchedule" ] }, "description": "Disable future scheduled execution for the supplied schedule. This does not promise cancellation of an already running job." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/DisableSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "DisableSchedule" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/DisableSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "DisableSchedule" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "DispatchScheduleAsync", "item": [ { "name": "Dispatch a schedule asynchronously", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/DispatchScheduleAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "DispatchScheduleAsync" ] }, "description": "Dispatch an execution through the collaboration-aware path and return an ExecutionId. Collaboration configuration and participating servers affect where work runs. A returned identifier acknowledges dispatch, not successful delivery." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/DispatchScheduleAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "DispatchScheduleAsync" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ExecutionId\": \"b2ad1236-e4f9-43d5-9593-993347fa4792\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/DispatchScheduleAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "DispatchScheduleAsync" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "EnableSchedule", "item": [ { "name": "Enable a schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/EnableSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "EnableSchedule" ] }, "description": "Enable the supplied schedule for scheduled execution." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/EnableSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "EnableSchedule" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/EnableSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "EnableSchedule" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "ExecuteSchedule", "item": [ { "name": "Execute a schedule synchronously", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteSchedule" ] }, "description": "Execute the selected schedule and wait for the execution result. Check Result as well as the HTTP status; a successful HTTP response can carry Result=false." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteSchedule" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Result\": true,\n \"ErrorMessage\": \"\",\n \"ErrorNumber\": 0\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteSchedule" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "ExecuteScheduleAsync", "item": [ { "name": "Queue a schedule asynchronously", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.environment.unset(\"execution_id\");", "if (pm.response.code === 200) {", " const response = pm.response.json();", " if (typeof response.ExecutionId === \"string\" && response.ExecutionId.length > 0) {", " pm.environment.set(\"execution_id\", response.ExecutionId);", " }", "}" ] } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"{{schedule_type}}\",\n \"uniqueid\": {{schedule_id}},\n \"RunBy\": \"API\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleAsync" ] }, "description": "Queue an execution and return its ExecutionId. Poll GetExecutionStatus, inspect ResultJson, and confirm output delivery. Use bounded polling and reconcile ambiguous submission outcomes before retrying; no idempotency-key contract is exposed." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleAsync" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ExecutionId\": \"b2ad1236-e4f9-43d5-9593-993347fa4792\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleAsync" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "ExecuteScheduleByEventAsync", "item": [ { "name": "Execute with event context", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"event\",\n \"uniqueid\": 301,\n \"RunBy\": \"API\",\n \"EventName\": \"Sales file received\",\n \"EventId\": 401,\n \"AsyncData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleByEventAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleByEventAsync" ] }, "description": "Queue an event-triggered execution carrying EventName, EventId and string AsyncData. Context content depends on the triggering event and is not a common structured JSON body. Retain ExecutionId for monitoring." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"event\",\n \"uniqueid\": 301,\n \"RunBy\": \"API\",\n \"EventName\": \"Sales file received\",\n \"EventId\": 401,\n \"AsyncData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleByEventAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleByEventAsync" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ExecutionId\": \"b2ad1236-e4f9-43d5-9593-993347fa4792\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"event\",\n \"uniqueid\": 301,\n \"RunBy\": \"API\",\n \"EventName\": \"Sales file received\",\n \"EventId\": 401,\n \"AsyncData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleByEventAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleByEventAsync" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "ExecuteScheduleInstant", "item": [ { "name": "Start an immediate execution process", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleInstant", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleInstant" ] }, "description": "Start the immediate execution path and return ProcessId. This is a process identifier, not an ExecutionId. Use process-oriented monitoring and recovery appropriately." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleInstant", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleInstant" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ProcessId\": 4820\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleInstant", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleInstant" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "ExecuteScheduleOnTimeAsync", "item": [ { "name": "Execute and advance the schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleOnTimeAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleOnTimeAsync" ] }, "description": "Queue execution through the scheduled-time path. This mode advances NextRun after completion. Do not use it interchangeably with on-demand execution when preserving the next scheduled run matters." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleOnTimeAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleOnTimeAsync" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ExecutionId\": \"b2ad1236-e4f9-43d5-9593-993347fa4792\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"RunBy\": \"API\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/ExecuteScheduleOnTimeAsync", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "ExecuteScheduleOnTimeAsync" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetExecutionQueue", "item": [ { "name": "Read the API execution queue", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/GetExecutionQueue", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "GetExecutionQueue" ] }, "description": "Return waiting, executing and retained API queue records. The queue includes completed entries whose completion age is less than 120000 seconds (33 hours 20 minutes). That selection window is not a guarantee of durable retention or a universal deletion schedule. Store execution history separately when durable retention is required. Inspect ResultJson to distinguish successful and failed completion." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/GetExecutionQueue", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "GetExecutionQueue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"ExecutionId\": \"b2ad1236-e4f9-43d5-9593-993347fa4792\",\n \"uniqueid\": 101,\n \"ProcessId\": 4820,\n \"Status\": \"Completed\",\n \"EntryDateEpoch\": 1789462800,\n \"CompletionDateEpoch\": 1789462812,\n \"RunBy\": \"API\",\n \"ResultJson\": \"{\\\"Result\\\":true,\\\"ErrorMessage\\\":\\\"\\\",\\\"ErrorNumber\\\":0}\",\n \"ServerName\": \"PBRS-SERVER\",\n \"ScheduleType\": \"report\",\n \"ScheduleName\": \"Daily sales\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/GetExecutionQueue", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "GetExecutionQueue" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetExecutionStatus", "item": [ { "name": "Get an execution status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/GetExecutionStatus?ExecutionId={{execution_id}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "GetExecutionStatus" ], "query": [ { "key": "ExecutionId", "value": "{{execution_id}}", "description": "Execution identifier returned by asynchronous submission." } ] }, "description": "Read one queue entry using ExecutionId. Parse ResultJson separately. Completed can contain a failed result; a timeout can report ErrorNumber=1041226. An empty result on a stale entry is not success. The configured cleanup timeout defaults to 36000 seconds (10 hours). Cleanup can mark an overdue entry Completed with a failed ResultJson; its message says 10 hours even if the configured timeout differs. This is distinct from retained queue history and client polling deadlines." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/GetExecutionStatus?ExecutionId=b2ad1236-e4f9-43d5-9593-993347fa4792", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "GetExecutionStatus" ], "query": [ { "description": "Execution identifier returned by asynchronous submission.", "key": "ExecutionId", "value": "b2ad1236-e4f9-43d5-9593-993347fa4792" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ExecutionId\": \"b2ad1236-e4f9-43d5-9593-993347fa4792\",\n \"uniqueid\": 101,\n \"ProcessId\": 4820,\n \"Status\": \"Completed\",\n \"EntryDateEpoch\": 1789462800,\n \"CompletionDateEpoch\": 1789462812,\n \"RunBy\": \"API\",\n \"ResultJson\": \"{\\\"Result\\\":true,\\\"ErrorMessage\\\":\\\"\\\",\\\"ErrorNumber\\\":0}\",\n \"ServerName\": \"PBRS-SERVER\",\n \"ScheduleType\": \"report\",\n \"ScheduleName\": \"Daily sales\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/GetExecutionStatus?ExecutionId=b2ad1236-e4f9-43d5-9593-993347fa4792", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "GetExecutionStatus" ], "query": [ { "description": "Execution identifier returned by asynchronous submission.", "key": "ExecutionId", "value": "b2ad1236-e4f9-43d5-9593-993347fa4792" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetNumberOfFreeThreads", "item": [ { "name": "Get available execution threads", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/GetNumberOfFreeThreads", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "GetNumberOfFreeThreads" ] }, "description": "Return available capacity for the current server. The default capacity is four; configuration can change it, and the result is clamped to zero. The calculation can clean up old execution entries. This is a snapshot, not a capacity reservation. Schedule-process concurrency, per-schedule page-renderer processes and data-driver row threads are different capacities. The number returned here does not describe all three and does not reserve capacity." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/GetNumberOfFreeThreads", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "GetNumberOfFreeThreads" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Result\": 2\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/GetNumberOfFreeThreads", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "GetNumberOfFreeThreads" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "importScheduleJSON", "item": [ { "name": "Import a schedule definition", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleAttr\": {\n \"ScheduleID\": 501,\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15T00:00:00Z\",\n \"EndDate\": \"2076-09-15T00:00:00Z\",\n \"NextRun\": \"2026-09-16T09:00:00Z\",\n \"StartTime\": \"09:00\",\n \"Repeat\": 0,\n \"RepeatInterval\": \"0\",\n \"RepeatUntil\": \"23:00\",\n \"Status\": 0,\n \"ReportID\": 0,\n \"PackID\": 0,\n \"AutoID\": 301,\n \"Description\": \"Disabled automation import example\",\n \"KeyWord\": \"api,import\",\n \"EventPackID\": 0,\n \"RepeatUnit\": \"hour\"\n },\n \"AutomationAttr\": {\n \"AutoID\": 301,\n \"AutoName\": \"Imported automation example\",\n \"Parent\": 0,\n \"Owner\": \"api.integration\",\n \"IsDataDriven\": 0,\n \"IsMultiThreaded\": 0,\n \"MaxThreads\": 1\n },\n \"Tasks\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/importScheduleJSON", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "importScheduleJSON" ] }, "description": "Import a PBRS-exported definition. The import family is selected from exported attributes, in this order: event package when ScheduleAttr.EventPackID and EventPackageAttr are populated; event-based when event definitions or conditions are present; package when ScheduleAttr.PackID and PackageAttr are populated; automation when ScheduleAttr.AutoID and AutomationAttr are populated; otherwise report. There is no single ScheduleType discriminator property on the import request. Preserve compatible exported collections and external prerequisites. The response wraps a string in returnModel; it is not a fixed nested object. Do not assume import is transactional or idempotent. Verify created objects and reconcile before retrying. For automation imports, returnModel contains JSON-encoded diagnostics for the imported attributes, with Value and Type entries. The example corresponds to an automation import with no tasks. Destination IDs are assigned during import. Diagnostic fields can vary with the exported collections." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleAttr\": {\n \"ScheduleID\": 501,\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15T00:00:00Z\",\n \"EndDate\": \"2076-09-15T00:00:00Z\",\n \"NextRun\": \"2026-09-16T09:00:00Z\",\n \"StartTime\": \"09:00\",\n \"Repeat\": 0,\n \"RepeatInterval\": \"0\",\n \"RepeatUntil\": \"23:00\",\n \"Status\": 0,\n \"ReportID\": 0,\n \"PackID\": 0,\n \"AutoID\": 301,\n \"Description\": \"Disabled automation import example\",\n \"KeyWord\": \"api,import\",\n \"EventPackID\": 0,\n \"RepeatUnit\": \"hour\"\n },\n \"AutomationAttr\": {\n \"AutoID\": 301,\n \"AutoName\": \"Imported automation example\",\n \"Parent\": 0,\n \"Owner\": \"api.integration\",\n \"IsDataDriven\": 0,\n \"IsMultiThreaded\": 0,\n \"MaxThreads\": 1\n },\n \"Tasks\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/importScheduleJSON", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "importScheduleJSON" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"returnModel\": \"{\\\"ScheduleAttr\\\":{\\\"scheduleid\\\":{\\\"Value\\\":1501,\\\"Type\\\":\\\"Int64\\\"},\\\"frequency\\\":{\\\"Value\\\":\\\"Daily\\\",\\\"Type\\\":\\\"String\\\"},\\\"startdate\\\":{\\\"Value\\\":\\\"2026-09-15T00:00:00Z\\\",\\\"Type\\\":\\\"DateTime\\\"},\\\"enddate\\\":{\\\"Value\\\":\\\"2076-09-15T00:00:00Z\\\",\\\"Type\\\":\\\"DateTime\\\"},\\\"nextrun\\\":{\\\"Value\\\":\\\"2026-09-16T09:00:00Z\\\",\\\"Type\\\":\\\"DateTime\\\"},\\\"starttime\\\":{\\\"Value\\\":\\\"09:00\\\",\\\"Type\\\":\\\"String\\\"},\\\"repeat\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"repeatinterval\\\":{\\\"Value\\\":\\\"0\\\",\\\"Type\\\":\\\"String\\\"},\\\"repeatuntil\\\":{\\\"Value\\\":\\\"23:00\\\",\\\"Type\\\":\\\"String\\\"},\\\"status\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"reportid\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"packid\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"autoid\\\":{\\\"Value\\\":1501,\\\"Type\\\":\\\"Int64\\\"},\\\"description\\\":{\\\"Value\\\":\\\"Disabled automation import example\\\",\\\"Type\\\":\\\"String\\\"},\\\"keyword\\\":{\\\"Value\\\":\\\"api,import\\\",\\\"Type\\\":\\\"String\\\"},\\\"calendarname\\\":{\\\"Value\\\":null,\\\"Type\\\":\\\"DBNull\\\"},\\\"disableddate\\\":{\\\"Value\\\":null,\\\"Type\\\":\\\"DBNull\\\"},\\\"smartid\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"useexception\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"exceptioncalendar\\\":{\\\"Value\\\":null,\\\"Type\\\":\\\"DBNull\\\"},\\\"eventpackid\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"repeatunit\\\":{\\\"Value\\\":\\\"hour\\\",\\\"Type\\\":\\\"String\\\"},\\\"bzipname\\\":{\\\"Value\\\":null,\\\"Type\\\":\\\"DBNull\\\"},\\\"bpath\\\":{\\\"Value\\\":null,\\\"Type\\\":\\\"DBNull\\\"},\\\"locked\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"collaborationserver\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"nextrunepoch\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"starttimeepoch\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"}},\\\"AutomationAttr\\\":{\\\"autoid\\\":{\\\"Value\\\":1501,\\\"Type\\\":\\\"Int64\\\"},\\\"autoname\\\":{\\\"Value\\\":\\\"Imported automation example - IMPORTED\\\",\\\"Type\\\":\\\"String\\\"},\\\"parent\\\":{\\\"Value\\\":42,\\\"Type\\\":\\\"Int32\\\"},\\\"owner\\\":{\\\"Value\\\":\\\"api.integration\\\",\\\"Type\\\":\\\"String\\\"},\\\"isdatadriven\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"ismultithreaded\\\":{\\\"Value\\\":0,\\\"Type\\\":\\\"Int32\\\"},\\\"maxthreads\\\":{\\\"Value\\\":1,\\\"Type\\\":\\\"Int32\\\"}}}\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleAttr\": {\n \"ScheduleID\": 501,\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15T00:00:00Z\",\n \"EndDate\": \"2076-09-15T00:00:00Z\",\n \"NextRun\": \"2026-09-16T09:00:00Z\",\n \"StartTime\": \"09:00\",\n \"Repeat\": 0,\n \"RepeatInterval\": \"0\",\n \"RepeatUntil\": \"23:00\",\n \"Status\": 0,\n \"ReportID\": 0,\n \"PackID\": 0,\n \"AutoID\": 301,\n \"Description\": \"Disabled automation import example\",\n \"KeyWord\": \"api,import\",\n \"EventPackID\": 0,\n \"RepeatUnit\": \"hour\"\n },\n \"AutomationAttr\": {\n \"AutoID\": 301,\n \"AutoName\": \"Imported automation example\",\n \"Parent\": 0,\n \"Owner\": \"api.integration\",\n \"IsDataDriven\": 0,\n \"IsMultiThreaded\": 0,\n \"MaxThreads\": 1\n },\n \"Tasks\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/importScheduleJSON", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "importScheduleJSON" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "RenameSchedule", "item": [ { "name": "Rename a schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"ScheduleName\": \"Daily sales updated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/RenameSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "RenameSchedule" ] }, "description": "Rename an existing schedule. Supply ScheduleName with the new name, ScheduleType and uniqueid." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"ScheduleName\": \"Daily sales updated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/RenameSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "RenameSchedule" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleType\": \"report\",\n \"uniqueid\": 101,\n \"ScheduleName\": \"Daily sales updated\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Schedule/RenameSchedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "RenameSchedule" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "TerminateSchedule", "item": [ { "name": "Terminate a schedule process", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/TerminateSchedule?ProcessId=4820", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "TerminateSchedule" ], "query": [ { "key": "ProcessId", "value": "4820", "description": "Operating-system process identifier returned by immediate execution or monitoring." } ] }, "description": "Terminate the process identified by ProcessId. This GET changes server state. Termination does not reverse outputs already delivered and is distinct from cancelling an ExecutionId." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/TerminateSchedule?ProcessId=4820", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "TerminateSchedule" ], "query": [ { "description": "Operating-system process identifier returned by immediate execution or monitoring.", "key": "ProcessId", "value": "4820" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "true" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Schedule/TerminateSchedule?ProcessId=4820", "host": [ "{{baseUrl}}" ], "path": [ "api", "Schedule", "TerminateSchedule" ], "query": [ { "description": "Operating-system process identifier returned by immediate execution or monitoring.", "key": "ProcessId", "value": "4820" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "Scheduleinfo", "item": [ { "name": "GetFailedSchedules", "item": [ { "name": "List recently failed schedules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Scheduleinfo/GetFailedSchedules?id=reportid", "host": [ "{{baseUrl}}" ], "path": [ "api", "Scheduleinfo", "GetFailedSchedules" ], "query": [ { "key": "id", "value": "reportid", "description": "Schedule family selector, not a numeric identifier." } ] }, "description": "Return failed history records for the selector id: reportid, packid or autoid. This id is a type selector, not a numeric schedule identifier. The history selection uses a calendar-day difference of at most one day; it is not a rolling 24-hour window. StartedAtUtc and FinishedAtUtc are not populated by this operation. Use ExecutionDateEpoch for the recorded execution time." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Scheduleinfo/GetFailedSchedules?id=reportid", "host": [ "{{baseUrl}}" ], "path": [ "api", "Scheduleinfo", "GetFailedSchedules" ], "query": [ { "description": "Schedule family selector, not a numeric identifier.", "key": "id", "value": "reportid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"Id\": 8001,\n \"ScheduleId\": 101,\n \"ExecutionDateEpoch\": 1789462800,\n \"Result\": \"false\",\n \"ResultMessage\": \"Report execution failed\",\n \"ScheduleName\": \"Daily sales\",\n \"StartedAtUtc\": null,\n \"FinishedAtUtc\": null\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Scheduleinfo/GetFailedSchedules?id=reportid", "host": [ "{{baseUrl}}" ], "path": [ "api", "Scheduleinfo", "GetFailedSchedules" ], "query": [ { "description": "Schedule family selector, not a numeric identifier.", "key": "id", "value": "reportid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "getScheduleHistory", "item": [ { "name": "Read paginated schedule history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Scheduleinfo/getScheduleHistory?id=101&page=1&pageSize=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "Scheduleinfo", "getScheduleHistory" ], "query": [ { "key": "id", "value": "101", "description": "Identifier of the selected resource." }, { "key": "page", "value": "1", "description": "One-based history page." }, { "key": "pageSize", "value": "50", "description": "Number of history items requested per page." } ] }, "description": "Return Items, TotalCount, Page and PageSize for a schedule. Defaults are page=1 and pageSize=50. Empty or out-of-range results can return TotalCount=0. Paging is not a stable snapshot and does not promise a deterministic tie-breaker for simultaneous timestamps." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Scheduleinfo/getScheduleHistory?id=101&page=1&pageSize=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "Scheduleinfo", "getScheduleHistory" ], "query": [ { "description": "Identifier of the selected resource.", "key": "id", "value": "101" }, { "description": "One-based history page.", "key": "page", "value": "1" }, { "description": "Number of history items requested per page.", "key": "pageSize", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Items\": [\n {\n \"Id\": 8001,\n \"ScheduleId\": 101,\n \"ExecutionDateEpoch\": 1789462800,\n \"Result\": \"true\",\n \"ResultMessage\": \"\",\n \"ScheduleName\": \"Daily sales\",\n \"StartedAtUtc\": \"2026-09-15T09:00:00Z\",\n \"FinishedAtUtc\": \"2026-09-15T09:00:12Z\"\n }\n ],\n \"TotalCount\": 1,\n \"Page\": 1,\n \"PageSize\": 50\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Scheduleinfo/getScheduleHistory?id=101&page=1&pageSize=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "Scheduleinfo", "getScheduleHistory" ], "query": [ { "description": "Identifier of the selected resource.", "key": "id", "value": "101" }, { "description": "One-based history page.", "key": "page", "value": "1" }, { "description": "Number of history items requested per page.", "key": "pageSize", "value": "50" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "LastRunResult", "item": [ { "name": "Get the most recent run result", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Id\": 101,\n \"ScheduleType\": \"report\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Scheduleinfo/LastRunResult", "host": [ "{{baseUrl}}" ], "path": [ "api", "Scheduleinfo", "LastRunResult" ] }, "description": "Retrieve the latest stored run result for a schedule. Result is the string true or false when history exists. This operation does not populate ScheduleName, StartedAtUtc or FinishedAtUtc. With no matching history, numeric fields are zero and the result and text fields are null; this does not establish success or failure. Do not use ScheduleType=package to determine a package execution outcome. Retain the ExecutionId returned by package execution and use GetExecutionStatus, checking ResultJson and delivery separately." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"Id\": 101,\n \"ScheduleType\": \"report\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Scheduleinfo/LastRunResult", "host": [ "{{baseUrl}}" ], "path": [ "api", "Scheduleinfo", "LastRunResult" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Id\": 8001,\n \"ScheduleId\": 101,\n \"ExecutionDateEpoch\": 1789462800,\n \"Result\": \"true\",\n \"ResultMessage\": \"\",\n \"ScheduleName\": null,\n \"StartedAtUtc\": null,\n \"FinishedAtUtc\": null\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"Id\": 101,\n \"ScheduleType\": \"report\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Scheduleinfo/LastRunResult", "host": [ "{{baseUrl}}" ], "path": [ "api", "Scheduleinfo", "LastRunResult" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "Service", "item": [ { "name": "GetConfigPath", "item": [ { "name": "Get the configuration path", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Service/GetConfigPath", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "GetConfigPath" ] }, "description": "Return the PBRS configuration path as a JSON string when Accept is application/json. The value can be a network path; it is not a downloadable configuration document." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Service/GetConfigPath", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "GetConfigPath" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\\\\PBRS-SERVER\\PBRS\\config" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Service/GetConfigPath", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "GetConfigPath" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "IsSchedulerRunning", "item": [ { "name": "Check scheduler state", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Service/IsSchedulerRunning", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "IsSchedulerRunning" ] }, "description": "Return a JSON boolean indicating whether the scheduler is running. This is service state, not the health of every reporting dependency." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Service/IsSchedulerRunning", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "IsSchedulerRunning" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "true" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Service/IsSchedulerRunning", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "IsSchedulerRunning" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Ping", "item": [ { "name": "Ping the API service", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Service/Ping", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "Ping" ] }, "description": "Unauthenticated connectivity check. Returns the JSON number 1. A successful ping does not verify authentication, report rendering or scheduler readiness.", "auth": { "type": "noauth" } }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Service/Ping", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "Ping" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "1" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Service/Ping", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "Ping" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "StartScheduler", "item": [ { "name": "Start the scheduler", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Service/StartScheduler", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "StartScheduler" ] }, "description": "Start the configured PBRS scheduler service or process. This GET changes server state and should be invoked deliberately by an administrator." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Service/StartScheduler", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "StartScheduler" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Service/StartScheduler", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "StartScheduler" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "StopScheduler", "item": [ { "name": "Stop the scheduler", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Service/StopScheduler", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "StopScheduler" ] }, "description": "Stop the configured scheduler service or process. This GET changes server state and can affect scheduled reporting." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Service/StopScheduler", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "StopScheduler" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/Service/StopScheduler", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "StopScheduler" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "UpdateCollaborationSettings", "item": [ { "name": "Update collaboration settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"IsCollaborationEnabled\": false,\n \"CollaborationId\": 0,\n \"CollaborationLeader\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Service/UpdateCollaborationSettings", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "UpdateCollaborationSettings" ] }, "description": "Apply collaboration settings, terminate relevant system processes and rewrite configuration. Nonempty connection fields replace stored values; local database connection fields are cleared by the operation. Coordinate the change across participating servers before invoking it." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"IsCollaborationEnabled\": false,\n \"CollaborationId\": 0,\n \"CollaborationLeader\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Service/UpdateCollaborationSettings", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "UpdateCollaborationSettings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"IsCollaborationEnabled\": false,\n \"CollaborationId\": 0,\n \"CollaborationLeader\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Service/UpdateCollaborationSettings", "host": [ "{{baseUrl}}" ], "path": [ "api", "Service", "UpdateCollaborationSettings" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "SingleSchedule", "item": [ { "name": "AddEmailDestination", "item": [ { "name": "Add an email destination", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"ParentId\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/AddEmailDestination?clearExisting=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "AddEmailDestination" ], "query": [ { "key": "clearExisting", "value": "false", "description": "Delete existing email destinations for ParentId before adding this one. Other destination types are preserved." } ] }, "description": "Add an email destination to an existing single-report schedule. ParentId is the report identifier. clearExisting=true deletes only existing email destinations for that report before insertion; it does not delete disk or other destination types. Retain the returned DestinationId for subsequent changes." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"ParentId\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/AddEmailDestination?clearExisting=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "AddEmailDestination" ], "query": [ { "description": "Delete existing email destinations for ParentId before adding this one. Other destination types are preserved.", "key": "clearExisting", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"DestinationId\": 701\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"ParentId\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/AddEmailDestination?clearExisting=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "AddEmailDestination" ], "query": [ { "description": "Delete existing email destinations for ParentId before adding this one. Other destination types are preserved.", "key": "clearExisting", "value": "false" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Clone", "item": [ { "name": "Clone a single schedule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/Clone?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "Clone" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Copy the selected single schedule and return the new schedule identifier as a JSON integer. This GET changes stored data; repeating it can create duplicate copies." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/Clone?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "Clone" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "102" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/Clone?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "Clone" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "CreateForPowerBI", "item": [ { "name": "Create a Power BI schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"ApplyBookmark\": false,\n \"ApplyBookmarkState\": false,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateForPowerBI", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateForPowerBI" ] }, "description": "Create a Power BI single-report schedule with recurrence and at least one supported destination. Supply RenderingSettings and filter collections intentionally. For data-only Excel use the exact output label MS Excel - Data Only (*.xlsx); template and workbook options reside in PowerBIDataOnlyExportSettings." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"ApplyBookmark\": false,\n \"ApplyBookmarkState\": false,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateForPowerBI", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateForPowerBI" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uniqueid\": 101\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"ApplyBookmark\": false,\n \"ApplyBookmarkState\": false,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateForPowerBI", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateForPowerBI" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "CreateForSSRS", "item": [ { "name": "Create an SSRS schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateForSSRS", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateForSSRS" ] }, "description": "Create an SSRS single schedule using a configured account or the exposed server connection fields. Provide recurrence and at least one destination. Parameters use string-valued dictionaries and their own null/multi-value flags." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateForSSRS", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateForSSRS" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uniqueid\": 101\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": []\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateForSSRS", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateForSSRS" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "CreateMultipleForPaginated", "item": [ { "name": "Create multiple paginated schedules", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n },\n {\n \"ScheduleName\": \"Daily sales regional detail\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateMultipleForPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateMultipleForPaginated" ] }, "description": "Validate the list and then create schedules sequentially. A later failure can leave earlier schedules persisted; failure does not return a complete rollback or reliable partial-ID list. Success returns ordered numeric identifiers. Reconcile persisted schedules before retrying a batch." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n },\n {\n \"ScheduleName\": \"Daily sales regional detail\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateMultipleForPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateMultipleForPaginated" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n 101,\n 102\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n },\n {\n \"ScheduleName\": \"Daily sales regional detail\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateMultipleForPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateMultipleForPaginated" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "CreateMultipleForSSRS", "item": [ { "name": "Create multiple SSRS schedules", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": []\n },\n {\n \"ScheduleName\": \"Daily sales regional detail\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": []\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateMultipleForSSRS", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateMultipleForSSRS" ] }, "description": "Create SSRS schedules from an array of complete definitions. Validation precedes sequential creation, but later failures can leave earlier items saved. Success returns identifiers in input order. Avoid blind retries after partial or ambiguous failures." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": []\n },\n {\n \"ScheduleName\": \"Daily sales regional detail\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": []\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateMultipleForSSRS", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateMultipleForSSRS" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n 101,\n 102\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": []\n },\n {\n \"ScheduleName\": \"Daily sales regional detail\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": []\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreateMultipleForSSRS", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreateMultipleForSSRS" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "CreatePaginated", "item": [ { "name": "Create a paginated Power BI schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreatePaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreatePaginated" ] }, "description": "Create a schedule for a Power BI paginated report. Supply Parameters, recurrence, configured Power BI account and supported destinations. ParameterValue remains a string even for numeric, date and boolean parameter types." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreatePaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreatePaginated" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uniqueid\": 101\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreatePaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreatePaginated" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "CreatePbirs", "item": [ { "name": "Create a PBIRS schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SqlServerAccountId\": 1,\n \"ObjectType\": \"PBIRSITEM\",\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"ReportTitle\": \"Daily Sales\",\n \"Parameters\": [],\n \"VirtualDirectory\": \"reports\",\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreatePbirs", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreatePbirs" ] }, "description": "Create a Power BI Report Server schedule using the configured SQL Server account identifier, report path, recurrence, rendering settings and destinations." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SqlServerAccountId\": 1,\n \"ObjectType\": \"PBIRSITEM\",\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"ReportTitle\": \"Daily Sales\",\n \"Parameters\": [],\n \"VirtualDirectory\": \"reports\",\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreatePbirs", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreatePbirs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uniqueid\": 101\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SqlServerAccountId\": 1,\n \"ObjectType\": \"PBIRSITEM\",\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"ReportTitle\": \"Daily Sales\",\n \"Parameters\": [],\n \"VirtualDirectory\": \"reports\",\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/CreatePbirs", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "CreatePbirs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Delete", "item": [ { "name": "Delete a single schedule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/Delete?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "Delete" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Delete the selected single schedule through the controller lifecycle operation. The caller must have schedule-modification permission. Returns a JSON boolean." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/Delete?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "Delete" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "true" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/Delete?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "Delete" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "DeleteEmailDestination", "item": [ { "name": "Delete an email destination", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/DeleteEmailDestination?destinationId=701", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "DeleteEmailDestination" ], "query": [ { "key": "destinationId", "value": "701", "description": "Existing email destination identifier." } ] }, "description": "Delete a destination by destinationId. Returns a message and the identifier on success; a failed delete can return HTTP 400." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/DeleteEmailDestination?destinationId=701", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "DeleteEmailDestination" ], "query": [ { "description": "Existing email destination identifier.", "key": "destinationId", "value": "701" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"Email destination deleted successfully\",\n \"DestinationId\": 701\n}" }, { "name": "The operation rejected the request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/DeleteEmailDestination?destinationId=701", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "DeleteEmailDestination" ], "query": [ { "description": "Existing email destination identifier.", "key": "destinationId", "value": "701" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"Failed to delete email destination\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/DeleteEmailDestination?destinationId=701", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "DeleteEmailDestination" ], "query": [ { "description": "Existing email destination identifier.", "key": "destinationId", "value": "701" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "Get", "item": [ { "name": "Get a Power BI schedule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/Get?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "Get" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Retrieve the Power BI schedule read projection. ClientRenderingSettings and destination summaries differ from the complete write models. Do not use this response as a lossless migration backup." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/Get?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "Get" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"ApplyBookmark\": false,\n \"ApplyBookmarkState\": false,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": [],\n \"uniqueid\": 101\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/Get?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "Get" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetAll", "item": [ { "name": "Search Power BI schedules (GET)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAll" ] }, "description": "Search schedules by explicit keywords. POST carries the same search model as GET and is preferable for clients that cannot send GET bodies. Missing filters do not mean list all.\n\nThis GET binds a JSON body. OpenAPI 3.0 API explorers cannot reliably send it. Use the cURL example.\n\n| Body field | Type | Meaning |\n|---|---|---|\n| FilterValues | array | Explicit keyword values to match. Omitting the body or sending an empty collection triggers a generated search value; default LIKE normally returns no matches. Negative operators can behave differently. |\n| FilterOperator | string | Keyword comparison operator. |\n| MatchType | string | Combine keyword comparisons using ALL or ANY. |\n\nBody schema: `KeywordSearchInput`. The complete schema is retained in components and x-pbrs-request-body." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAll" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"ApplyBookmark\": false,\n \"ApplyBookmarkState\": false,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": [],\n \"uniqueid\": 101\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAll" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] }, { "name": "Search Power BI schedules (POST)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"FilterValues\": [\n \"sales\"\n ],\n \"FilterOperator\": \"LIKE\",\n \"MatchType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAll" ] }, "description": "Search schedules by explicit keywords. POST carries the same search model as GET and is preferable for clients that cannot send GET bodies. Missing filters do not mean list all." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"FilterValues\": [\n \"sales\"\n ],\n \"FilterOperator\": \"LIKE\",\n \"MatchType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAll" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"ApplyBookmark\": false,\n \"ApplyBookmarkState\": false,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": [],\n \"uniqueid\": 101\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"FilterValues\": [\n \"sales\"\n ],\n \"FilterOperator\": \"LIKE\",\n \"MatchType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAll" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetAllPaginated", "item": [ { "name": "Search paginated schedules (GET)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAllPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAllPaginated" ] }, "description": "Search paginated schedules by explicit keywords. GET and POST are both implemented. Use POST where GET bodies are unsupported. Missing filters do not mean list all.\n\nThis GET binds a JSON body. OpenAPI 3.0 API explorers cannot reliably send it. Use the cURL example.\n\n| Body field | Type | Meaning |\n|---|---|---|\n| FilterValues | array | Explicit keyword values to match. Omitting the body or sending an empty collection triggers a generated search value; default LIKE normally returns no matches. Negative operators can behave differently. |\n| FilterOperator | string | Keyword comparison operator. |\n| MatchType | string | Combine keyword comparisons using ALL or ANY. |\n\nBody schema: `KeywordSearchInput`. The complete schema is retained in components and x-pbrs-request-body." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAllPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAllPaginated" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ],\n \"uniqueid\": 101\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAllPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAllPaginated" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] }, { "name": "Search paginated schedules (POST)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"FilterValues\": [\n \"sales\"\n ],\n \"FilterOperator\": \"LIKE\",\n \"MatchType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAllPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAllPaginated" ] }, "description": "Search paginated schedules by explicit keywords. GET and POST are both implemented. Use POST where GET bodies are unsupported. Missing filters do not mean list all." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"FilterValues\": [\n \"sales\"\n ],\n \"FilterOperator\": \"LIKE\",\n \"MatchType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAllPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAllPaginated" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ],\n \"uniqueid\": 101\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"FilterValues\": [\n \"sales\"\n ],\n \"FilterOperator\": \"LIKE\",\n \"MatchType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetAllPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetAllPaginated" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetForSSRS", "item": [ { "name": "Get an SSRS schedule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetForSSRS?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetForSSRS" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Retrieve the SSRS schedule, datasource overrides and parameter representation. Preserve credential masking and collection semantics when preparing updates." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetForSSRS?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetForSSRS" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": [],\n \"uniqueid\": 101\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetForSSRS?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetForSSRS" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetPaginated", "item": [ { "name": "Get a paginated schedule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetPaginated?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetPaginated" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Read the paginated Power BI schedule and its stored parameters." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetPaginated?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetPaginated" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ],\n \"uniqueid\": 101\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetPaginated?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetPaginated" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetPBirs", "item": [ { "name": "Get a PBIRS schedule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetPBirs?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetPBirs" ], "query": [ { "key": "Id", "value": "101", "description": "Identifier of the selected resource." } ] }, "description": "Read the Power BI Report Server schedule definition and populated rendering projection." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetPBirs?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetPBirs" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\"\n }\n ],\n \"DiskDestinations\": [],\n \"DataDriven\": false,\n \"SqlServerAccountId\": 1,\n \"ObjectType\": \"PBIRSITEM\",\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"ReportTitle\": \"Daily Sales\",\n \"Parameters\": [],\n \"VirtualDirectory\": \"reports\",\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"uniqueid\": 101\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetPBirs?Id=101", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetPBirs" ], "query": [ { "description": "Identifier of the selected resource.", "key": "Id", "value": "101" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetSample", "item": [ { "name": "Get a serialized sample definition", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetSample", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetSample" ] }, "description": "Return sample Power BI schedule JSON as a string. With application/json negotiation the outer response is a JSON string containing serialized JSON; parse twice to obtain the embedded definition. Replace the sample dates and account values with values appropriate for your installation." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetSample", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetSample" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\"ScheduleName\":\"Daily sales\",\"FolderPath\":\"/API Reports\",\"Description\":\"Daily sales reporting\",\"Keywords\":\"api,sales\",\"Schedule\":{\"Frequency\":\"Daily\",\"StartDate\":\"2026-09-15\",\"ExecutionTime\":\"09:00\",\"HasEndDate\":false,\"Repeat\":false,\"Enabled\":true,\"DailyRepeatInterval\":1},\"EmailDestinations\":[{\"DestinationName\":\"Operations email\",\"DestinationType\":\"Email\",\"Enabled\":true,\"OutputFormat\":\"Acrobat Format (*.pdf)\",\"To\":[\"operations@example.com\"],\"Cc\":[],\"Bcc\":[],\"Subject\":\"Daily sales report\",\"Body\":\"Attached is the daily sales report.\",\"BodyFormat\":\"TEXT\"}],\"DiskDestinations\":[],\"DataDriven\":false,\"PowerBiAccountId\":\"7f320302-7ccb-4aba-a052-56197424ab36\",\"ObjectType\":\"REPORT\",\"ReportUrl\":\"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\"PowerBiReportName\":\"Sales overview\",\"WorkspaceName\":\"Sales\",\"ApplyBookmark\":false,\"ApplyBookmarkState\":false,\"RenderingSettings\":{\"MinLoadingTime\":10,\"MaxLoadingTime\":60,\"PageWidth\":1300,\"PageHeight\":800,\"PagesToRender\":\"1\",\"RenderingMethod\":1},\"BasicFilters\":[],\"AdvancedFilters\":[]}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SingleSchedule/GetSample", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "GetSample" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "UpdateEmailDestination", "item": [ { "name": "Update an email destination", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"DestinationId\": 701,\n \"To\": null,\n \"Cc\": null,\n \"Bcc\": null,\n \"Subject\": \"Revised daily sales subject\",\n \"BodyFormat\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateEmailDestination", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateEmailDestination" ] }, "description": "Selectively update an email destination by DestinationId. A nonempty To array replaces To recipients; null or an empty To array preserves them. For Cc and Bcc, null preserves existing recipients and an empty array clears them. Omitting Cc or Bcc initializes an empty array and can therefore clear recipients. Nonempty Subject, Body, BodyFormat, CustomSenderName and CustomerSenderAddress replace their stored values; null or empty strings preserve them. Omitted BodyFormat defaults to TEXT, so send null to preserve the stored format. Output, naming, enabled and embedding settings are not changed by this operation." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"DestinationId\": 701,\n \"To\": null,\n \"Cc\": null,\n \"Bcc\": null,\n \"Subject\": \"Revised daily sales subject\",\n \"BodyFormat\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateEmailDestination", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateEmailDestination" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"Email destination updated successfully\",\n \"DestinationId\": 701\n}" }, { "name": "The operation rejected the request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"DestinationId\": 701,\n \"To\": null,\n \"Cc\": null,\n \"Bcc\": null,\n \"Subject\": \"Revised daily sales subject\",\n \"BodyFormat\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateEmailDestination", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateEmailDestination" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"DestinationId is required for update operations\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"DestinationId\": 701,\n \"To\": null,\n \"Cc\": null,\n \"Bcc\": null,\n \"Subject\": \"Revised daily sales subject\",\n \"BodyFormat\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateEmailDestination", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateEmailDestination" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "UpdateForPaginated", "item": [ { "name": "Update a paginated schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ],\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForPaginated" ] }, "description": "Update a complete paginated schedule using uniqueid. Include recurrence, destinations and the intended parameters. This operation returns an empty HTTP 200, not an updated model. Include both EmailDestinations and DiskDestinations as complete, non-null arrays. Existing destinations absent from these lists are removed. Retain DestinationId for entries to keep. Use application/json when a collection should be empty." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ],\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForPaginated" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"PAGINATEDREPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/groups/7f320302-7ccb-4aba-a052-56197424ab36/rdlreports/64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales detail\",\n \"WorkspaceName\": \"Sales\",\n \"UseNativeAPIForRendering\": true,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ],\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForPaginated" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "UpdateForPbirs", "item": [ { "name": "Update a PBIRS schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"SqlServerAccountId\": 1,\n \"ObjectType\": \"PBIRSITEM\",\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"ReportTitle\": \"Daily Sales\",\n \"Parameters\": [],\n \"VirtualDirectory\": \"reports\",\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForPbirs", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForPbirs" ] }, "description": "Update the Power BI Report Server schedule. Send the intended complete definition; a read projection does not necessarily preserve every write setting. Include both EmailDestinations and DiskDestinations as complete, non-null arrays. Existing destinations absent from these lists are removed. Retain DestinationId for entries to keep. Use application/json when a collection should be empty." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"SqlServerAccountId\": 1,\n \"ObjectType\": \"PBIRSITEM\",\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"ReportTitle\": \"Daily Sales\",\n \"Parameters\": [],\n \"VirtualDirectory\": \"reports\",\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForPbirs", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForPbirs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"SqlServerAccountId\": 1,\n \"ObjectType\": \"PBIRSITEM\",\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"ReportTitle\": \"Daily Sales\",\n \"Parameters\": [],\n \"VirtualDirectory\": \"reports\",\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForPbirs", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForPbirs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "UpdateForPowerBI", "item": [ { "name": "Update a Power BI schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"ApplyBookmark\": false,\n \"ApplyBookmarkState\": false,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": [],\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForPowerBI", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForPowerBI" ] }, "description": "Update the selected schedule using uniqueid. The update clears and rebuilds filters and reconciles destination collections, removing omitted entries. Preserve wanted filters, destinations and destination IDs. ClientRenderingSettings is not a substitute for RenderingSettings. Supply both EmailDestinations and DiskDestinations as complete arrays, using [] for a collection that should be empty. The update compares DestinationId against existing destinations and deletes entries absent from the supplied lists. Preserve existing destination IDs when retaining them. Omission is not a preserve instruction and can fail during collection processing. Use JSON when either required collection must be empty. The paired examples retain email destination 701 and disk destination 702; replace these example IDs with the destination IDs retrieved for the schedule." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"ApplyBookmark\": false,\n \"ApplyBookmarkState\": false,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": [],\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForPowerBI", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForPowerBI" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"PowerBiAccountId\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"ObjectType\": \"REPORT\",\n \"ReportUrl\": \"https://app.powerbi.com/reportEmbed?reportId=64e25062-4786-43be-bfea-56ec8b9aaeca\",\n \"PowerBiReportName\": \"Sales overview\",\n \"WorkspaceName\": \"Sales\",\n \"ApplyBookmark\": false,\n \"ApplyBookmarkState\": false,\n \"RenderingSettings\": {\n \"MinLoadingTime\": 10,\n \"MaxLoadingTime\": 60,\n \"PageWidth\": 1300,\n \"PageHeight\": 800,\n \"PagesToRender\": \"1\",\n \"RenderingMethod\": 1\n },\n \"BasicFilters\": [],\n \"AdvancedFilters\": [],\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForPowerBI", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForPowerBI" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "UpdateForSSRS", "item": [ { "name": "Update an SSRS schedule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": [],\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForSSRS", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForSSRS" ] }, "description": "Update the SSRS definition using uniqueid. Include the intended recurrence, destinations, datasource overrides and parameters. Preserve existing credentials correctly instead of treating masked read-back values as new passwords. Include both EmailDestinations and DiskDestinations as complete, non-null arrays. Existing destinations absent from these lists are removed. Retain DestinationId for entries to keep. Use application/json when a collection should be empty." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": [],\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForSSRS", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForSSRS" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"ScheduleName\": \"Daily sales\",\n \"FolderPath\": \"/API Reports\",\n \"Description\": \"Daily sales reporting\",\n \"Keywords\": \"api,sales\",\n \"Schedule\": {\n \"Frequency\": \"Daily\",\n \"StartDate\": \"2026-09-15\",\n \"ExecutionTime\": \"09:00\",\n \"HasEndDate\": false,\n \"Repeat\": false,\n \"Enabled\": true,\n \"DailyRepeatInterval\": 1\n },\n \"EmailDestinations\": [\n {\n \"DestinationName\": \"Operations email\",\n \"DestinationType\": \"Email\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"To\": [\n \"operations@example.com\"\n ],\n \"Cc\": [],\n \"Bcc\": [],\n \"Subject\": \"Daily sales report\",\n \"Body\": \"Attached is the daily sales report.\",\n \"BodyFormat\": \"TEXT\",\n \"DestinationId\": 701\n }\n ],\n \"DiskDestinations\": [\n {\n \"DestinationId\": 702,\n \"DestinationName\": \"Sales archive\",\n \"DestinationType\": \"Disk\",\n \"Enabled\": true,\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"OutputPath\": \"C:\\\\PBRSExports\\\\Sales\"\n }\n ],\n \"DataDriven\": false,\n \"SSRSAccountName\": \"Reporting Server\",\n \"UseSSRSAccount\": true,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"VirtualDirectory\": \"reports\",\n \"Datasources\": [],\n \"Parameters\": [],\n \"uniqueid\": 101\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateForSSRS", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateForSSRS" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "UpdateParametersPaginated", "item": [ { "name": "Update paginated report parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"uniqueid\": 101,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateParametersPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateParametersPaginated" ] }, "description": "Modify parameters on an existing paginated schedule. uniqueid must be nonzero; supply the intended Parameters collection. This dedicated operation returns SuccessMessage, uniqueid and Parameters without requiring a complete schedule replacement." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"uniqueid\": 101,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateParametersPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateParametersPaginated" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"SuccessMessage\": \"Parameters updated successfully\",\n \"uniqueid\": 101,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"uniqueid\": 101,\n \"Parameters\": [\n {\n \"ParameterName\": \"Region\",\n \"ParameterValue\": \"West\",\n \"ParameterType\": 0,\n \"IsNull\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SingleSchedule/UpdateParametersPaginated", "host": [ "{{baseUrl}}" ], "path": [ "api", "SingleSchedule", "UpdateParametersPaginated" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "SSRSAccount", "item": [ { "name": "GetAll", "item": [ { "name": "List SSRS accounts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SSRSAccount/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "SSRSAccount", "GetAll" ] }, "description": "List configured SSRS accounts using AccountId and AccountName. The identifier is numeric, unlike configured Power BI account identifiers." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SSRSAccount/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "SSRSAccount", "GetAll" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"AccountId\": 1,\n \"AccountName\": \"Reporting Server\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SSRSAccount/GetAll", "host": [ "{{baseUrl}}" ], "path": [ "api", "SSRSAccount", "GetAll" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "SsrsReport", "item": [ { "name": "GetReportDatasources", "item": [ { "name": "Discover SSRS report datasources", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ReportPath\": \"/Sales/Daily Sales\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SsrsReport/GetReportDatasources", "host": [ "{{baseUrl}}" ], "path": [ "api", "SsrsReport", "GetReportDatasources" ] }, "description": "Read datasource definitions from the configured SSRS server for a report path. Availability depends on the upstream reporting service and account." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ReportPath\": \"/Sales/Daily Sales\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SsrsReport/GetReportDatasources", "host": [ "{{baseUrl}}" ], "path": [ "api", "SsrsReport", "GetReportDatasources" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"DatasourceName\": \"SalesDatabase\",\n \"UserId\": \"report_reader\",\n \"Password\": \"\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ReportPath\": \"/Sales/Daily Sales\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SsrsReport/GetReportDatasources", "host": [ "{{baseUrl}}" ], "path": [ "api", "SsrsReport", "GetReportDatasources" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetReportParameters", "item": [ { "name": "Discover SSRS report parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ReportPath\": \"/Sales/Daily Sales\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SsrsReport/GetReportParameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "SsrsReport", "GetReportParameters" ] }, "description": "Retrieve the report parameter definitions through the configured SSRS server. ParameterValues is a string-to-string dictionary, not an array." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ReportPath\": \"/Sales/Daily Sales\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SsrsReport/GetReportParameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "SsrsReport", "GetReportParameters" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"ParameterName\": \"Region\",\n \"ParameterValues\": {\n \"West\": \"West\"\n },\n \"IsMultiValue\": false,\n \"IsNull\": false,\n \"ParameterIndex\": 0,\n \"ParentId\": 0,\n \"Prompt\": \"Region\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ReportPath\": \"/Sales/Daily Sales\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SsrsReport/GetReportParameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "SsrsReport", "GetReportParameters" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetReportParametersWithValues", "item": [ { "name": "Resolve dependent SSRS parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"CurrentValues\": [\n {\n \"Name\": \"Region\",\n \"Value\": \"West\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SsrsReport/GetReportParametersWithValues", "host": [ "{{baseUrl}}" ], "path": [ "api", "SsrsReport", "GetReportParametersWithValues" ] }, "description": "Retrieve parameter definitions using CurrentValues for dependent or cascading parameters. Each current value has Name and Value. The response uses the same parameter representation as GetReportParameters." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"CurrentValues\": [\n {\n \"Name\": \"Region\",\n \"Value\": \"West\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SsrsReport/GetReportParametersWithValues", "host": [ "{{baseUrl}}" ], "path": [ "api", "SsrsReport", "GetReportParametersWithValues" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"ParameterName\": \"Region\",\n \"ParameterValues\": {\n \"West\": \"West\"\n },\n \"IsMultiValue\": false,\n \"IsNull\": false,\n \"ParameterIndex\": 0,\n \"ParentId\": 0,\n \"Prompt\": \"Region\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ReportPath\": \"/Sales/Daily Sales\",\n \"CurrentValues\": [\n {\n \"Name\": \"Region\",\n \"Value\": \"West\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/SsrsReport/GetReportParametersWithValues", "host": [ "{{baseUrl}}" ], "path": [ "api", "SsrsReport", "GetReportParametersWithValues" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "SystemMonitor", "item": [ { "name": "AllDue", "item": [ { "name": "List due schedules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SystemMonitor/AllDue", "host": [ "{{baseUrl}}" ], "path": [ "api", "SystemMonitor", "AllDue" ] }, "description": "Return due schedule summaries sorted by NextRunEpoch. This operation returns the Due Today - All monitor view; this is not the API execution queue." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SystemMonitor/AllDue", "host": [ "{{baseUrl}}" ], "path": [ "api", "SystemMonitor", "AllDue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"uniqueid\": 101,\n \"Name\": \"Daily sales\",\n \"ScheduleType\": \"report\",\n \"IsDataDriven\": false,\n \"IsEnabled\": true,\n \"NextRunEpoch\": 1789549200,\n \"ScheduleId\": 501,\n \"LastResult\": {\n \"Id\": 8001,\n \"ScheduleId\": 101,\n \"ExecutionDateEpoch\": 1789462800,\n \"Result\": \"true\",\n \"ResultMessage\": \"\",\n \"ScheduleName\": null,\n \"StartedAtUtc\": null,\n \"FinishedAtUtc\": null\n },\n \"DestinationsTypes\": \"Email\",\n \"ReportType\": \"PowerBI\",\n \"OutputFormat\": \"Acrobat Format (*.pdf)\",\n \"Keywords\": \"api,sales\"\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SystemMonitor/AllDue", "host": [ "{{baseUrl}}" ], "path": [ "api", "SystemMonitor", "AllDue" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetCurrentlyExecuting", "item": [ { "name": "List currently executing schedules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/SystemMonitor/GetCurrentlyExecuting", "host": [ "{{baseUrl}}" ], "path": [ "api", "SystemMonitor", "GetCurrentlyExecuting" ] }, "description": "Read the task monitor for currently executing schedules. Records contain process identifiers and server names, distinct from API queue ExecutionId records." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SystemMonitor/GetCurrentlyExecuting", "host": [ "{{baseUrl}}" ], "path": [ "api", "SystemMonitor", "GetCurrentlyExecuting" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"EntryDateEpoch\": 1789462800,\n \"ScheduleName\": \"Daily sales\",\n \"ScheduleType\": \"report\",\n \"Status\": \"Executing\",\n \"ServerName\": \"PBRS-SERVER\",\n \"ProcessId\": 4820,\n \"uniqueid\": 101\n }\n]" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/SystemMonitor/GetCurrentlyExecuting", "host": [ "{{baseUrl}}" ], "path": [ "api", "SystemMonitor", "GetCurrentlyExecuting" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "UserGroups", "item": [ { "name": "Get", "item": [ { "name": "List user groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/Get", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "Get" ] }, "description": "Return user-group summaries. Requires the User Manager group permission; an authenticated caller without it receives an empty HTTP 403." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/Get", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "Get" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"groupID\": 1,\n \"groupName\": \"Report viewers\",\n \"groupDesc\": \"Users who view reporting schedules\",\n \"destinationAccessType\": \"\",\n \"customTaskAccessType\": \"\",\n \"folderAccessType\": 0,\n \"CanAccessAllContentsInFolder\": false\n }\n]" }, { "name": "Authentication failed; the controller returns an empty Unauthorized result.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/Get", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "Get" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The authenticated user lacks User Manager permission. Empty response.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/Get", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "Get" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/Get", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "Get" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetCustomTaskTypes", "item": [ { "name": "List custom-task categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetCustomTaskTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetCustomTaskTypes" ] }, "description": "Return categories usable in the user-group permission interface. This catalogue does not imply that public APIs exist to create every task type. Requires User Manager permission." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetCustomTaskTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetCustomTaskTypes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n \"General\",\n \"Files and Folders\",\n \"Internet\",\n \"Database\",\n \"Registry\"\n]" }, { "name": "Authentication failed; the controller returns an empty Unauthorized result.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetCustomTaskTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetCustomTaskTypes" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The authenticated user lacks User Manager permission. Empty response.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetCustomTaskTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetCustomTaskTypes" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetCustomTaskTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetCustomTaskTypes" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] }, { "name": "GetDestinationTypes", "item": [ { "name": "List destination categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetDestinationTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetDestinationTypes" ] }, "description": "Return destination categories for permission configuration. This list does not establish a public creation endpoint or request model for every category. Requires User Manager permission." }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetDestinationTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetDestinationTypes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n \"Disk\",\n \"Email\",\n \"Printer\",\n \"FTP\",\n \"SMS\",\n \"SharePoint\",\n \"Google Drive\",\n \"Google Sheets\",\n \"Dropbox\",\n \"Slack\",\n \"OneDrive\",\n \"Amazon S3\",\n \"MS Teams\"\n]" }, { "name": "Authentication failed; the controller returns an empty Unauthorized result.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetDestinationTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetDestinationTypes" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The authenticated user lacks User Manager permission. Empty response.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetDestinationTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetDestinationTypes" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{baseUrl}}/api/UserGroups/GetDestinationTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserGroups", "GetDestinationTypes" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] }, { "name": "UserManager", "item": [ { "name": "ShareSchedulesToUsers", "item": [ { "name": "Share a schedule with users", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Id\": 101,\n \"Type\": \"report\",\n \"Users\": [\n \"report.viewer\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/UserManager/ShareSchedulesToUsers", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserManager", "ShareSchedulesToUsers" ] }, "description": "Share a schedule with the listed PBRS users. Type must identify the schedule family. This is schedule sharing, not user provisioning or group administration." }, "response": [ { "name": "Operation completed. The response body is empty.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"Id\": 101,\n \"Type\": \"report\",\n \"Users\": [\n \"report.viewer\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/UserManager/ShareSchedulesToUsers", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserManager", "ShareSchedulesToUsers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "The operation rejected the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"Id\": 101,\n \"Type\": \"report\",\n \"Users\": [\n \"report.viewer\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/UserManager/ShareSchedulesToUsers", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserManager", "ShareSchedulesToUsers" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"Invalid schedule type\"\n}" }, { "name": "The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"Id\": 101,\n \"Type\": \"report\",\n \"Users\": [\n \"report.viewer\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/UserManager/ShareSchedulesToUsers", "host": [ "{{baseUrl}}" ], "path": [ "api", "UserManager", "ShareSchedulesToUsers" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"Message\": \"An error has occurred.\",\n \"ExceptionMessage\": \"The requested operation could not be completed.\"\n}" } ] } ] } ] } ] }, { "name": "oauth2", "item": [ { "name": "token", "item": [ { "name": "Authenticate an API client", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/oauth2/token", "host": [ "{{baseUrl}}" ], "path": [ "oauth2", "token" ] }, "description": "Exchange a configured API client ID and secret for an access token. This route is /oauth2/token, without /api. Tokens expire after 60 minutes. Send the returned access_token in Authorization with the bearer prefix. Incorrect credentials return HTTP 401.", "auth": { "type": "noauth" } }, "response": [ { "name": "Successful operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"client_secret\": \"ExampleClientSecret-92!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/oauth2/token", "host": [ "{{baseUrl}}" ], "path": [ "oauth2", "token" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"access_token\": \"DemonstrationTokenValueNotACredential\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600\n}" }, { "name": "Authentication rejected. No JSON payload is promised by this Unauthorized result.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"7f320302-7ccb-4aba-a052-56197424ab36\",\n \"client_secret\": \"ExampleClientSecret-92!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/oauth2/token", "host": [ "{{baseUrl}}" ], "path": [ "oauth2", "token" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.environment.unset(\"access_token\");", "if (pm.response.code === 200) {", " const response = pm.response.json();", " if (typeof response.access_token === \"string\" && response.access_token.length > 0) {", " pm.environment.set(\"access_token\", response.access_token);", " }", "}" ] } } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "http://localhost:9000", "type": "string" } ] }