{ "uuid": "6c737f3a-27ff-4faa-907f-be34b6115ae3", "lastMigration": 29, "name": "BigQuery Data Transfer API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "7d58bb85-7223-46b0-8bd1-ec03a2dce8c6", "documentation": "Deletes the specified transfer run.", "method": "delete", "endpoint": "v1/:name", "responses": [ { "uuid": "da5a0177-fec5-4cff-acc5-ed31020de738", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "27cf3fd5-6692-47f6-a9e8-ee85964e01ce", "documentation": "Returns information about the particular transfer run.", "method": "get", "endpoint": "v1/:name", "responses": [ { "uuid": "e6719833-9842-4a93-9412-3c9f38970362", "body": "{\n \"dataSourceId\": \"\",\n \"destinationDatasetId\": \"\",\n \"emailPreferences\": {\n \"enableFailureEmail\": {{faker 'datatype.boolean'}}\n },\n \"endTime\": \"\",\n \"errorStatus\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"name\": \"\",\n \"notificationPubsubTopic\": \"\",\n \"params\": {},\n \"runTime\": \"\",\n \"schedule\": \"\",\n \"scheduleTime\": \"\",\n \"startTime\": \"\",\n \"state\": \"{{oneOf (array 'TRANSFER_STATE_UNSPECIFIED' 'PENDING' 'RUNNING' 'SUCCEEDED' 'FAILED' 'CANCELLED')}}\",\n \"updateTime\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d4824a90-b58a-4b02-8307-cd6ccd0859c3", "documentation": "Updates a data transfer configuration. All fields must be set, even if they are not updated.", "method": "patch", "endpoint": "v1/:name", "responses": [ { "uuid": "35ab90d7-ae62-4a81-891d-1d698432412e", "body": "{\n \"dataRefreshWindowDays\": {{faker 'number.int' max=99999}},\n \"dataSourceId\": \"\",\n \"datasetRegion\": \"\",\n \"destinationDatasetId\": \"\",\n \"disabled\": {{faker 'datatype.boolean'}},\n \"displayName\": \"\",\n \"emailPreferences\": {\n \"enableFailureEmail\": {{faker 'datatype.boolean'}}\n },\n \"name\": \"\",\n \"nextRunTime\": \"\",\n \"notificationPubsubTopic\": \"\",\n \"ownerInfo\": {\n \"email\": \"\"\n },\n \"params\": {},\n \"schedule\": \"\",\n \"scheduleOptions\": {\n \"disableAutoScheduling\": {{faker 'datatype.boolean'}},\n \"endTime\": \"\",\n \"startTime\": \"\"\n },\n \"state\": \"{{oneOf (array 'TRANSFER_STATE_UNSPECIFIED' 'PENDING' 'RUNNING' 'SUCCEEDED' 'FAILED' 'CANCELLED')}}\",\n \"updateTime\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "06b6d2ea-c64b-4cb2-b055-461cd549b2f0", "documentation": "Lists information about the supported locations for this service.", "method": "get", "endpoint": "v1/:name/locations", "responses": [ { "uuid": "ed70d938-aff9-4214-90cc-0f6b690c1ec1", "body": "{\n \"locations\": [\n {\n \"displayName\": \"\",\n \"labels\": {},\n \"locationId\": \"\",\n \"metadata\": {},\n \"name\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e55ad582-3322-4c85-af22-64175ef9f6f5", "documentation": "Returns true if valid credentials exist for the given data source and requesting user.", "method": "post", "endpoint": "v1/:name:checkValidCreds", "responses": [ { "uuid": "23b81158-01b0-4d8e-a524-3589739eea13", "body": "{\n \"hasValidCreds\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8bec7400-6d6f-4465-b863-3ace87e84c35", "documentation": "Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).", "method": "post", "endpoint": "v1/:name:enrollDataSources", "responses": [ { "uuid": "1dbb0334-e10a-45fd-8f98-ba813021d989", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "56223ee6-116a-479e-9048-06fb4eca1c29", "documentation": "Lists supported data sources and returns their settings.", "method": "get", "endpoint": "v1/:parent/dataSources", "responses": [ { "uuid": "56c45f8a-e621-4a6e-8740-f5130c168c97", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c1a9be3-819d-4c16-9da4-a13ef0a4b201", "documentation": "Returns information about running and completed transfer runs.", "method": "get", "endpoint": "v1/:parent/runs", "responses": [ { "uuid": "35b73a25-2445-4f6f-b08b-4796da4f92ea", "body": "{\n \"nextPageToken\": \"\",\n \"transferRuns\": [\n {\n \"dataSourceId\": \"\",\n \"destinationDatasetId\": \"\",\n \"emailPreferences\": {\n \"enableFailureEmail\": {{faker 'datatype.boolean'}}\n },\n \"endTime\": \"\",\n \"errorStatus\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"name\": \"\",\n \"notificationPubsubTopic\": \"\",\n \"params\": {},\n \"runTime\": \"\",\n \"schedule\": \"\",\n \"scheduleTime\": \"\",\n \"startTime\": \"\",\n \"state\": \"{{oneOf (array 'TRANSFER_STATE_UNSPECIFIED' 'PENDING' 'RUNNING' 'SUCCEEDED' 'FAILED' 'CANCELLED')}}\",\n \"updateTime\": \"\",\n \"userId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e9b4c563-3353-4e00-b365-3605d0b3d75c", "documentation": "Returns information about all transfer configs owned by a project in the specified location.", "method": "get", "endpoint": "v1/:parent/transferConfigs", "responses": [ { "uuid": "ebe59d20-23e6-44c7-bc6e-a68d5023b879", "body": "{\n \"nextPageToken\": \"\",\n \"transferConfigs\": [\n {\n \"dataRefreshWindowDays\": {{faker 'number.int' max=99999}},\n \"dataSourceId\": \"\",\n \"datasetRegion\": \"\",\n \"destinationDatasetId\": \"\",\n \"disabled\": {{faker 'datatype.boolean'}},\n \"displayName\": \"\",\n \"emailPreferences\": {\n \"enableFailureEmail\": {{faker 'datatype.boolean'}}\n },\n \"name\": \"\",\n \"nextRunTime\": \"\",\n \"notificationPubsubTopic\": \"\",\n \"ownerInfo\": {\n \"email\": \"\"\n },\n \"params\": {},\n \"schedule\": \"\",\n \"scheduleOptions\": {\n \"disableAutoScheduling\": {{faker 'datatype.boolean'}},\n \"endTime\": \"\",\n \"startTime\": \"\"\n },\n \"state\": \"{{oneOf (array 'TRANSFER_STATE_UNSPECIFIED' 'PENDING' 'RUNNING' 'SUCCEEDED' 'FAILED' 'CANCELLED')}}\",\n \"updateTime\": \"\",\n \"userId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "110f393c-49b6-427f-b56b-ecd244eed49d", "documentation": "Creates a new data transfer configuration.", "method": "post", "endpoint": "v1/:parent/transferConfigs", "responses": [ { "uuid": "8d94b86b-d455-4704-8c07-cf499a2fc6fb", "body": "{\n \"dataRefreshWindowDays\": {{faker 'number.int' max=99999}},\n \"dataSourceId\": \"\",\n \"datasetRegion\": \"\",\n \"destinationDatasetId\": \"\",\n \"disabled\": {{faker 'datatype.boolean'}},\n \"displayName\": \"\",\n \"emailPreferences\": {\n \"enableFailureEmail\": {{faker 'datatype.boolean'}}\n },\n \"name\": \"\",\n \"nextRunTime\": \"\",\n \"notificationPubsubTopic\": \"\",\n \"ownerInfo\": {\n \"email\": \"\"\n },\n \"params\": {},\n \"schedule\": \"\",\n \"scheduleOptions\": {\n \"disableAutoScheduling\": {{faker 'datatype.boolean'}},\n \"endTime\": \"\",\n \"startTime\": \"\"\n },\n \"state\": \"{{oneOf (array 'TRANSFER_STATE_UNSPECIFIED' 'PENDING' 'RUNNING' 'SUCCEEDED' 'FAILED' 'CANCELLED')}}\",\n \"updateTime\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "91b557d5-9467-4f05-bfc7-5682bd88ef54", "documentation": "Returns log messages for the transfer run.", "method": "get", "endpoint": "v1/:parent/transferLogs", "responses": [ { "uuid": "fa58cd63-9c41-4a68-88a2-cef9daf67f64", "body": "{\n \"nextPageToken\": \"\",\n \"transferMessages\": [\n {\n \"messageText\": \"\",\n \"messageTime\": \"\",\n \"severity\": \"{{oneOf (array 'MESSAGE_SEVERITY_UNSPECIFIED' 'INFO' 'WARNING' 'ERROR')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8925b94b-3066-43af-a3ff-e86ecd49d015", "documentation": "Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.", "method": "post", "endpoint": "v1/:parent:scheduleRuns", "responses": [ { "uuid": "43ecf428-2685-4b3a-bac9-f94d5bdbd830", "body": "{\n \"runs\": [\n {\n \"dataSourceId\": \"\",\n \"destinationDatasetId\": \"\",\n \"emailPreferences\": {\n \"enableFailureEmail\": {{faker 'datatype.boolean'}}\n },\n \"endTime\": \"\",\n \"errorStatus\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"name\": \"\",\n \"notificationPubsubTopic\": \"\",\n \"params\": {},\n \"runTime\": \"\",\n \"schedule\": \"\",\n \"scheduleTime\": \"\",\n \"startTime\": \"\",\n \"state\": \"{{oneOf (array 'TRANSFER_STATE_UNSPECIFIED' 'PENDING' 'RUNNING' 'SUCCEEDED' 'FAILED' 'CANCELLED')}}\",\n \"updateTime\": \"\",\n \"userId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "501f0be9-1241-4d49-a033-ec0561b9110e", "documentation": "Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.", "method": "post", "endpoint": "v1/:parent:startManualRuns", "responses": [ { "uuid": "5d4d9353-ea14-48af-912a-bbb9e40abeef", "body": "{\n \"runs\": [\n {\n \"dataSourceId\": \"\",\n \"destinationDatasetId\": \"\",\n \"emailPreferences\": {\n \"enableFailureEmail\": {{faker 'datatype.boolean'}}\n },\n \"endTime\": \"\",\n \"errorStatus\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"name\": \"\",\n \"notificationPubsubTopic\": \"\",\n \"params\": {},\n \"runTime\": \"\",\n \"schedule\": \"\",\n \"scheduleTime\": \"\",\n \"startTime\": \"\",\n \"state\": \"{{oneOf (array 'TRANSFER_STATE_UNSPECIFIED' 'PENDING' 'RUNNING' 'SUCCEEDED' 'FAILED' 'CANCELLED')}}\",\n \"updateTime\": \"\",\n \"userId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "7d58bb85-7223-46b0-8bd1-ec03a2dce8c6" }, { "type": "route", "uuid": "27cf3fd5-6692-47f6-a9e8-ee85964e01ce" }, { "type": "route", "uuid": "d4824a90-b58a-4b02-8307-cd6ccd0859c3" }, { "type": "route", "uuid": "06b6d2ea-c64b-4cb2-b055-461cd549b2f0" }, { "type": "route", "uuid": "e55ad582-3322-4c85-af22-64175ef9f6f5" }, { "type": "route", "uuid": "8bec7400-6d6f-4465-b863-3ace87e84c35" }, { "type": "route", "uuid": "56223ee6-116a-479e-9048-06fb4eca1c29" }, { "type": "route", "uuid": "3c1a9be3-819d-4c16-9da4-a13ef0a4b201" }, { "type": "route", "uuid": "e9b4c563-3353-4e00-b365-3605d0b3d75c" }, { "type": "route", "uuid": "110f393c-49b6-427f-b56b-ecd244eed49d" }, { "type": "route", "uuid": "91b557d5-9467-4f05-bfc7-5682bd88ef54" }, { "type": "route", "uuid": "8925b94b-3066-43af-a3ff-e86ecd49d015" }, { "type": "route", "uuid": "501f0be9-1241-4d49-a033-ec0561b9110e" } ] }