{"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-sparkjobdefinition/items-list-spark-job-definitions":{"get":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_items_list_spark_job_definitions","summary":"Returns a list of spark job definitions from the specified workspace.","description":"GET /workspaces/{workspaceId}/sparkJobDefinitions","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-sparkjobdefinition/items-create-spark-job-definition":{"post":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_items_create_spark_job_definition","summary":"Creates a spark job definition in the specified workspace.","description":"POST /workspaces/{workspaceId}/sparkJobDefinitions","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-sparkjobdefinition/items-get-spark-job-definition":{"get":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_items_get_spark_job_definition","summary":"Returns properties of the specified spark job definition.","description":"GET /workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"sparkJobDefinitionId","in":"query","required":true,"description":"The spark job definition ID.","schema":{"type":"string","description":"The spark job definition 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-sparkjobdefinition/items-update-spark-job-definition":{"post":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_items_update_spark_job_definition","summary":"Updates the properties of the specified spark job definition.","description":"PATCH /workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sparkJobDefinitionId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"sparkJobDefinitionId":{"type":"string","description":"The spark job definition 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-sparkjobdefinition/items-delete-spark-job-definition":{"post":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_items_delete_spark_job_definition","summary":"Deletes the specified spark job definition.","description":"DELETE /workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sparkJobDefinitionId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"sparkJobDefinitionId":{"type":"string","description":"The spark job definition 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-sparkjobdefinition/items-get-spark-job-definition-definition":{"post":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_items_get_spark_job_definition_definition","summary":"Returns the specified spark job definition public definition.","description":"POST /workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/getDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sparkJobDefinitionId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"sparkJobDefinitionId":{"type":"string","description":"The spark job definition ID."},"format":{"type":"string","enum":["SparkJobDefinitionV1","SparkJobDefinitionV2"],"description":"The format of the request. Can be either `SparkJobDefinitionV1` or `SparkJobDefinitionV2`. Additional Format types may be added over time."}}}}}},"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-sparkjobdefinition/items-update-spark-job-definition-definition":{"post":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_items_update_spark_job_definition_definition","summary":"Overrides the definition for the specified spark job definition.","description":"POST /workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/updateDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sparkJobDefinitionId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"sparkJobDefinitionId":{"type":"string","description":"The spark job definition 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-sparkjobdefinition/background-jobs-run-on-demand-spark-job-definition":{"post":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_background_jobs_run_on_demand_spark_job_definition","summary":"Run on-demand [Spark job definition](/fabric/data-engineering/run-spark-job-definition) job instance.","description":"POST /workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/jobs/sparkjob/instances","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","sparkJobDefinitionId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"sparkJobDefinitionId":{"type":"string","description":"The Spark job definition item 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-sparkjobdefinition/livy-sessions-list-livy-sessions":{"get":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_livy_sessions_list_livy_sessions","summary":"Returns a list of livy sessions from the specified item identifier.","description":"GET /workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/livySessions","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace identifier.","schema":{"type":"string","description":"The workspace identifier."}},{"name":"sparkJobDefinitionId","in":"query","required":true,"description":"The sparkJobDefinition ID.","schema":{"type":"string","description":"The sparkJobDefinition ID."}},{"name":"continuationToken","in":"query","required":false,"description":"Token to retrieve the next page of results, if available.","schema":{"type":"string","description":"Token to retrieve the next page of results, if available."}}],"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-sparkjobdefinition/livy-sessions-list-livy-sessions-beta":{"get":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_livy_sessions_list_livy_sessions_beta","summary":"Returns a list of livy sessions from the specified item identifier (beta).","description":"GET /workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/livySessions?beta=true","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace identifier.","schema":{"type":"string","description":"The workspace identifier."}},{"name":"sparkJobDefinitionId","in":"query","required":true,"description":"The sparkJobDefinition ID.","schema":{"type":"string","description":"The sparkJobDefinition ID."}},{"name":"beta","in":"query","required":true,"description":"This required parameter must be set to `true` to access this API, which is currently in beta.","schema":{"type":"boolean","description":"This required parameter must be set to `true` to access this API, which is currently in beta."}},{"name":"submittedDateTime","in":"query","required":false,"description":"Submitted date time filter. Filter the sessions based on the submitted date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.","schema":{"type":"string","description":"Submitted date time filter. Filter the sessions based on the submitted date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."}},{"name":"endDateTime","in":"query","required":false,"description":"Ended date time filter. Filter the sessions based on the ended date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.","schema":{"type":"string","description":"Ended date time filter. Filter the sessions based on the ended date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format."}},{"name":"submitter.Id","in":"query","required":false,"description":"The GUID value of the user who submitted the session.","schema":{"type":"string","description":"The GUID value of the user who submitted the session."}},{"name":"state","in":"query","required":false,"description":"The state of the session. Possible values are: `NotStarted`, `InProgress`, `Cancelled`, `Failed`, `Succeeded`, `Unknown`. This value maps…","schema":{"type":"string","description":"The state of the session. Possible values are: `NotStarted`, `InProgress`, `Cancelled`, `Failed`, `Succeeded`, `Unknown`. This value maps…"}},{"name":"continuationToken","in":"query","required":false,"description":"Token to retrieve the next page of results, if available.","schema":{"type":"string","description":"Token to retrieve the next page of results, if available."}}],"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-sparkjobdefinition/livy-sessions-get-livy-session":{"get":{"operationId":"analytics_microsoft_fabric_sparkjobdefinition_livy_sessions_get_livy_session","summary":"Returns properties of the specified livy session.","description":"GET /workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/livySessions/{livyId}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace identifier.","schema":{"type":"string","description":"The workspace identifier."}},{"name":"sparkJobDefinitionId","in":"query","required":true,"description":"The sparkJobDefinition ID.","schema":{"type":"string","description":"The sparkJobDefinition ID."}},{"name":"livyId","in":"query","required":true,"description":"The session identifier.","schema":{"type":"string","description":"The session identifier."}}],"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"}}},"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"}}}}}}}