{"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/open-data:visier-data-intake/data-intake-get-sources":{"get":{"operationId":"open_data_visier_data_intake_data_intake_get_sources","summary":"Retrieve a list of sources","description":"GET /v1/op/data-sources","tags":["open-data"],"parameters":[],"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/open-data:visier-data-intake/data-intake-start-transfer":{"post":{"operationId":"open_data_visier_data_intake_data_intake_start_transfer","summary":"Start a transfer session","description":"POST /v1/op/data-transfer-sessions","tags":["open-data"],"parameters":[],"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/open-data:visier-data-intake/data-intake-push-data":{"post":{"operationId":"open_data_visier_data_intake_data_intake_push_data","summary":"Transfer data to sources via JSON","description":"PUT /v1/op/data-transfer-sessions/{transferSessionId}/add","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transferSessionId","body"],"properties":{"transferSessionId":{"type":"string","description":"The transfer session ID returned after the data transfer session starts."},"sourceId":{"type":"string","description":"The unique identifier associated with the source you want to transfer data to."},"sequence":{"type":"integer","description":"The unique sequence number associated with a batch of records."},"tenantCode":{"type":"string","description":"The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o."},"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/open-data:visier-data-intake/data-intake-push-data-cancel":{"post":{"operationId":"open_data_visier_data_intake_data_intake_push_data_cancel","summary":"Cancel a transfer session","description":"PUT /v1/op/data-transfer-sessions/{transferSessionId}/cancel","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transferSessionId"],"properties":{"transferSessionId":{"type":"string","description":"The transfer session ID to cancel."}}}}}},"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/open-data:visier-data-intake/data-intake-upload-data":{"post":{"operationId":"open_data_visier_data_intake_data_intake_upload_data","summary":"Transfer data to sources via file upload","description":"PUT /v1/op/data-transfer-sessions/{transferSessionId}/upload","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transferSessionId","body"],"properties":{"transferSessionId":{"type":"string","description":"The transfer session ID returned after the data transfer session starts."},"sourceId":{"type":"string","description":"The unique identifier associated with the source you want to transfer data to."},"sequence":{"type":"string","description":"The unique sequence number associated with a batch of records."},"tenantCode":{"type":"string","description":"The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o."},"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/open-data:visier-data-intake/data-intake-get-processing-jobs-by-parent-receiving-job-id":{"get":{"operationId":"open_data_visier_data_intake_data_intake_get_processing_jobs_by_parent_receiving_job_id","summary":"Retrieve processing job statuses by receiving job ID","description":"GET /v1/op/jobs/processing-jobs/{receivingJobId}","tags":["open-data"],"parameters":[{"name":"receivingJobId","in":"query","required":true,"description":"The receiving job ID.","schema":{"type":"string","description":"The receiving job ID."}},{"name":"tenantCode","in":"query","required":false,"description":"The tenant code of the tenant you want to retrieve the processing jobs for. Use this if you are only interested in the results for one…","schema":{"type":"string","description":"The tenant code of the tenant you want to retrieve the processing jobs for. Use this if you are only interested in the results for one…"}},{"name":"limit","in":"query","required":false,"description":"The limit of processing jobs to retrieve per page.","schema":{"type":"integer","description":"The limit of processing jobs to retrieve per page."}},{"name":"start","in":"query","required":false,"description":"The index to start retrieving results from, also known as offset. The index begins at 0.","schema":{"type":"integer","description":"The index to start retrieving results from, also known as offset. The index begins at 0."}}],"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/open-data:visier-data-intake/data-intake-push-data-complete":{"post":{"operationId":"open_data_visier_data_intake_data_intake_push_data_complete","summary":"Complete a transfer session","description":"POST /v1/op/jobs/receiving-jobs","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/open-data:visier-data-intake/data-intake-receiving-job-status":{"get":{"operationId":"open_data_visier_data_intake_data_intake_receiving_job_status","summary":"Retrieve a receiving job’s status","description":"GET /v1/op/jobs/receiving-jobs/{receivingJobId}","tags":["open-data"],"parameters":[{"name":"receivingJobId","in":"query","required":true,"description":"The **dataReceivingJobId** provided after a data transfer session completes. See **`/v1/op/jobs/receiving-jobs`**.","schema":{"type":"string","description":"The **dataReceivingJobId** provided after a data transfer session completes. See **`/v1/op/jobs/receiving-jobs`**."}},{"name":"jobs","in":"query","required":false,"description":"If true, returns the status of receiving jobs spawned by the receiving job specified by receivingJobId.","schema":{"type":"boolean","description":"If true, returns the status of receiving jobs spawned by the receiving job specified by receivingJobId."}},{"name":"tenantCode","in":"query","required":false,"description":"The tenant code of the tenant you want to retrieve the receiving jobs for. Use this if you are only interested in the results for one…","schema":{"type":"string","description":"The tenant code of the tenant you want to retrieve the receiving jobs for. Use this if you are only interested in the results for one…"}},{"name":"start","in":"query","required":false,"description":"The index to start retrieving results from, also known as offset. The index begins at 0.","schema":{"type":"integer","description":"The index to start retrieving results from, also known as offset. The index begins at 0."}},{"name":"limit","in":"query","required":false,"description":"The number of job statuses to return per page.","schema":{"type":"integer","description":"The number of job statuses to return per page."}}],"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/open-data:visier-data-intake/data-upload-file-to-visier":{"post":{"operationId":"open_data_visier_data_intake_data_upload_file_to_visier","summary":"Upload a data file to Visier","description":"PUT /v1alpha/data/upload/files/{filename}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filename"],"properties":{"filename":{"type":"string","description":"The filename of the data file to upload, including the file extension (such as .zip or .csv)."}}}}}},"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"}}}}}}}