{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:microsoft-fabric-deployment-plan/items-list-deployment-plans":{"get":{"operationId":"analytics_microsoft_fabric_deployment_plan_items_list_deployment_plans","summary":"Lists deployment plans in the specified workspace.","description":"GET /workspaces/{workspaceId}/deploymentPlans","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 the specified folder and its nested folders, or only in the specified folder. When set to `true`, all items in the folder…","schema":{"type":"boolean","description":"Lists items in the specified folder and its nested folders, or only in the specified folder. When set to `true`, all items in the folder…"}},{"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-deployment-plan/items-create-deployment-plan":{"post":{"operationId":"analytics_microsoft_fabric_deployment_plan_items_create_deployment_plan","summary":"Creates a deployment plan in the specified workspace.","description":"POST /workspaces/{workspaceId}/deploymentPlans","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-deployment-plan/items-get-deployment-plan":{"get":{"operationId":"analytics_microsoft_fabric_deployment_plan_items_get_deployment_plan","summary":"Gets the specified deployment plan.","description":"GET /workspaces/{workspaceId}/deploymentPlans/{deploymentPlanId}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"deploymentPlanId","in":"query","required":true,"description":"The deployment plan ID.","schema":{"type":"string","description":"The deployment plan 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-deployment-plan/items-update-deployment-plan":{"post":{"operationId":"analytics_microsoft_fabric_deployment_plan_items_update_deployment_plan","summary":"Updates the specified deployment plan.","description":"PATCH /workspaces/{workspaceId}/deploymentPlans/{deploymentPlanId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","deploymentPlanId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"deploymentPlanId":{"type":"string","description":"The deployment plan 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-deployment-plan/items-delete-deployment-plan":{"post":{"operationId":"analytics_microsoft_fabric_deployment_plan_items_delete_deployment_plan","summary":"Deletes the specified deployment plan.","description":"DELETE /workspaces/{workspaceId}/deploymentPlans/{deploymentPlanId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","deploymentPlanId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"deploymentPlanId":{"type":"string","description":"The deployment plan ID."},"hardDelete":{"type":"boolean","description":"Specifies whether to perform a hard delete. When set to `true`, the item is permanently deleted and cannot be recovered. When set to…"}}}}}},"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-deployment-plan/items-get-deployment-plan-definition":{"post":{"operationId":"analytics_microsoft_fabric_deployment_plan_items_get_deployment_plan_definition","summary":"Gets the deployment plan definition.","description":"POST /workspaces/{workspaceId}/deploymentPlans/{deploymentPlanId}/getDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","deploymentPlanId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"deploymentPlanId":{"type":"string","description":"The deployment plan ID."},"format":{"type":"string","description":"The format of the deployment plan 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-deployment-plan/items-update-deployment-plan-definition":{"post":{"operationId":"analytics_microsoft_fabric_deployment_plan_items_update_deployment_plan_definition","summary":"Updates the deployment plan definition.","description":"POST /workspaces/{workspaceId}/deploymentPlans/{deploymentPlanId}/updateDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","deploymentPlanId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"deploymentPlanId":{"type":"string","description":"The deployment plan 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…"},"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"}}}}}}}