{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:microsoft-fabric-data-build-tool-job/items-list-data-build-tool-jobs":{"get":{"operationId":"analytics_microsoft_fabric_data_build_tool_job_items_list_data_build_tool_jobs","summary":"Returns a list of DataBuildToolJobs from the specified workspace.","description":"GET /workspaces/{workspaceId}/dataBuildToolJobs","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"recursive","in":"query","required":false,"description":"Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed,…","schema":{"type":"boolean","description":"Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed,…"}},{"name":"rootFolderId","in":"query","required":false,"description":"This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.","schema":{"type":"string","description":"This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder."}},{"name":"continuationToken","in":"query","required":false,"description":"A token for retrieving the next page of results.","schema":{"type":"string","description":"A token for retrieving the next page of results."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-data-build-tool-job/items-create-data-build-tool-job":{"post":{"operationId":"analytics_microsoft_fabric_data_build_tool_job_items_create_data_build_tool_job","summary":"Creates a DataBuildToolJob in the specified workspace.","description":"POST /workspaces/{workspaceId}/dataBuildToolJobs","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-data-build-tool-job/items-get-data-build-tool-job":{"get":{"operationId":"analytics_microsoft_fabric_data_build_tool_job_items_get_data_build_tool_job","summary":"Returns properties of the specified DataBuildToolJob.","description":"GET /workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"dataBuildToolJobId","in":"query","required":true,"description":"The DataBuildToolJob ID.","schema":{"type":"string","description":"The DataBuildToolJob ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-data-build-tool-job/items-update-data-build-tool-job":{"post":{"operationId":"analytics_microsoft_fabric_data_build_tool_job_items_update_data_build_tool_job","summary":"Updates the properties of the specified DataBuildToolJob.","description":"PATCH /workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataBuildToolJobId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataBuildToolJobId":{"type":"string","description":"The DataBuildToolJob ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-data-build-tool-job/items-delete-data-build-tool-job":{"post":{"operationId":"analytics_microsoft_fabric_data_build_tool_job_items_delete_data_build_tool_job","summary":"Deletes the specified DataBuildToolJob.","description":"DELETE /workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataBuildToolJobId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataBuildToolJobId":{"type":"string","description":"The DataBuildToolJob ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-data-build-tool-job/items-get-data-build-tool-job-definition":{"post":{"operationId":"analytics_microsoft_fabric_data_build_tool_job_items_get_data_build_tool_job_definition","summary":"Returns the specified DataBuildToolJob public definition.","description":"POST /workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}/getDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataBuildToolJobId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataBuildToolJobId":{"type":"string","description":"The DataBuildToolJob ID."},"format":{"type":"string","description":"The format of the DataBuildToolJob definition."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-data-build-tool-job/items-update-data-build-tool-job-definition":{"post":{"operationId":"analytics_microsoft_fabric_data_build_tool_job_items_update_data_build_tool_job_definition","summary":"Overrides the definition for the specified DataBuildToolJob.","description":"POST /workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}/updateDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataBuildToolJobId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataBuildToolJobId":{"type":"string","description":"The DataBuildToolJob ID."},"updateMetadata":{"type":"boolean","description":"When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-data-build-tool-job/background-jobs-run-on-demand-execute":{"post":{"operationId":"analytics_microsoft_fabric_data_build_tool_job_background_jobs_run_on_demand_execute","summary":"Run on-demand DataBuildToolJob execute job instance.","description":"POST /workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}/jobs/execute/instances","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataBuildToolJobId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataBuildToolJobId":{"type":"string","description":"The DataBuildToolJob item ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-data-build-tool-job/background-jobs-schedule-data-build-tool-job":{"post":{"operationId":"analytics_microsoft_fabric_data_build_tool_job_background_jobs_schedule_data_build_tool_job","summary":"Create a new execute schedule for a DataBuildToolJob.","description":"POST /workspaces/{workspaceId}/dataBuildToolJobs/{dataBuildToolJobId}/jobs/execute/schedules","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataBuildToolJobId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataBuildToolJobId":{"type":"string","description":"The DataBuildToolJob ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}