Dataform API
Service to develop, version control, and operationalize SQL pipelines in BigQuery.
Data & analytics#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Service to develop, version control, and operationalize SQL pipelines in BigQuery.
Endpoints 54
projects.locations.teamFolders
- GETFetches a single TeamFolder.
/v1/:nameFetches a single TeamFolder. - DELETEDeletes a single TeamFolder.
/v1/:nameDeletes a single TeamFolder. - PATCHUpdates a single TeamFolder.
/v1/:name?updateMask=stringUpdates a single TeamFolder. - POSTDeletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
/v1/:name:deleteTreeDeletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs). - GETGets the access control policy for a resource
/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - POSTSets the access control policy on the specified resource
/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - POSTReturns permissions that a caller has on the specified resource
/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND… - POSTCreates a new TeamFolder in a given project and location.
/v1/:parent/teamFoldersCreates a new TeamFolder in a given project and location. - GETReturns the contents of a given TeamFolder.
/v1/:teamFolder:queryContents?filter=string&orderBy=string&pageSize=0&pageToken=stringReturns the contents of a given TeamFolder. - GETReturns all TeamFolders in a given location that the caller has access to and match the provided filter.
/v1/:location/teamFolders:search?filter=string&orderBy=string&pageSize=0&pageToken=stringReturns all TeamFolders in a given location that the caller has access to and match the provided filter.
projects.locations
- GETLists information about the supported locations for this service
/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the… - GETReturns the contents of a caller's root folder in a given location
/v1/:location:queryUserRootContents?filter=string&orderBy=string&pageSize=0&pageToken=stringReturns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in…
projects.locations.folders
- POSTCreates a new Folder in a given project and location.
/v1/:parent/foldersCreates a new Folder in a given project and location. - GETReturns the contents of a given Folder.
/v1/:folder:queryFolderContents?filter=string&orderBy=string&pageSize=0&pageToken=stringReturns the contents of a given Folder.
projects.locations.repositories
- POSTMoves a Repository to a new location.
/v1/:name:moveMoves a Repository to a new location. - GETComputes a Repository's Git access token status.
/v1/:name:computeAccessTokenStatusComputes a Repository's Git access token status. - GETLists Repositories in a given project and location
/v1/:parent/repositories?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Repositories in a given project and location. Note: *This method can return repositories not shown in the Dataform UI*. - POSTCreates a new Repository in a given project and location.
/v1/:parent/repositories?repositoryId=stringCreates a new Repository in a given project and location. - GETFetches a Repository's history of commits
/v1/:name:fetchHistory?pageSize=0&pageToken=stringFetches a Repository's history of commits. The Repository must not have a value for git_remote_settings.url. - GETFetches a Repository's remote branches.
/v1/:name:fetchRemoteBranchesFetches a Repository's remote branches. - GETReturns the contents of a given Repository directory
/v1/:name:queryDirectoryContents?commitSha=string&pageSize=0&pageToken=string&path=stringReturns the contents of a given Repository directory. The Repository must not have a value for git_remote_settings.url. - GETReturns the contents of a file (inside a Repository)
/v1/:name:readFile?commitSha=string&path=stringReturns the contents of a file (inside a Repository). The Repository must not have a value for git_remote_settings.url.
projects.locations.repositories.workflowInvocations
- POSTRequests cancellation of a running WorkflowInvocation.
/v1/:name:cancelRequests cancellation of a running WorkflowInvocation. - GETReturns WorkflowInvocationActions in a given WorkflowInvocation.
/v1/:name:query?pageSize=0&pageToken=stringReturns WorkflowInvocationActions in a given WorkflowInvocation. - GETLists WorkflowInvocations in a given Repository.
/v1/:parent/workflowInvocations?filter=string&orderBy=string&pageSize=0&pageToken=stringLists WorkflowInvocations in a given Repository. - POSTCreates a new WorkflowInvocation in a given Repository.
/v1/:parent/workflowInvocationsCreates a new WorkflowInvocation in a given Repository.
projects.locations.operations
- GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.locations.repositories.workspaces
- POSTApplies a Git commit for uncommitted files in a Workspace.
/v1/:name:commitApplies a Git commit for uncommitted files in a Workspace. - GETLists Workspaces in a given Repository.
/v1/:parent/workspaces?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Workspaces in a given Repository. - POSTCreates a new Workspace in a given Repository.
/v1/:parent/workspaces?workspaceId=stringCreates a new Workspace in a given Repository. - POSTCreates a new Workspace in a given Repository asynchronously.
/v1/:parent/workspaces:createLongRunning?workspaceId=stringCreates a new Workspace in a given Repository asynchronously. - GETFetches Git diff for an uncommitted file in a Workspace.
/v1/:workspace:fetchFileDiff?path=stringFetches Git diff for an uncommitted file in a Workspace. - GETFetches Git statuses for the files in a Workspace.
/v1/:name:fetchFileGitStatusesFetches Git statuses for the files in a Workspace. - GETFetches Git ahead/behind against a remote branch.
/v1/:name:fetchGitAheadBehind?remoteBranch=stringFetches Git ahead/behind against a remote branch. - POSTInstalls dependency NPM packages (inside a Workspace).
/v1/:workspace:installNpmPackagesInstalls dependency NPM packages (inside a Workspace). - POSTCreates a directory inside a Workspace.
/v1/:workspace:makeDirectoryCreates a directory inside a Workspace. - POSTMoves a directory (inside a Workspace), and all of its contents, to a new location.
/v1/:workspace:moveDirectoryMoves a directory (inside a Workspace), and all of its contents, to a new location. - POSTMoves a file (inside a Workspace) to a new location.
/v1/:workspace:moveFileMoves a file (inside a Workspace) to a new location. - POSTPulls Git commits from the Repository's remote into a Workspace.
/v1/:name:pullPulls Git commits from the Repository's remote into a Workspace. - POSTPushes Git commits from a Workspace to the Repository's remote.
/v1/:name:pushPushes Git commits from a Workspace to the Repository's remote. - GETReturns the contents of a given Workspace directory.
/v1/:workspace:queryDirectoryContents?pageSize=0&pageToken=string&path=string&view=DIRECTORY_CONTENTS_VIEW_UNSPECIFIEDReturns the contents of a given Workspace directory. - GETReturns the contents of a file (inside a Workspace).
/v1/:workspace:readFile?path=string&revision=stringReturns the contents of a file (inside a Workspace). - POSTDeletes a directory (inside a Workspace) and all of its contents.
/v1/:workspace:removeDirectoryDeletes a directory (inside a Workspace) and all of its contents. - POSTDeletes a file (inside a Workspace).
/v1/:workspace:removeFileDeletes a file (inside a Workspace). - POSTPerforms a Git reset for uncommitted files in a Workspace.
/v1/:name:resetPerforms a Git reset for uncommitted files in a Workspace. - GETFinds the contents of a given Workspace directory by filter.
/v1/:workspace:searchFiles?filter=string&pageSize=0&pageToken=stringFinds the contents of a given Workspace directory by filter. - POSTWrites to a file (inside a Workspace).
/v1/:workspace:writeFileWrites to a file (inside a Workspace).
projects.locations.repositories.compilationResults
- GETLists CompilationResults in a given Repository.
/v1/:parent/compilationResults?filter=string&orderBy=string&pageSize=0&pageToken=stringLists CompilationResults in a given Repository. - POSTCreates a new CompilationResult in a given project and location.
/v1/:parent/compilationResultsCreates a new CompilationResult in a given project and location. - POSTCreates a new CompilationResult in a given project and location asynchronously.
/v1/:parent/compilationResults:createLongRunningCreates a new CompilationResult in a given project and location asynchronously.
projects.locations.repositories.releaseConfigs
- GETLists ReleaseConfigs in a given Repository.
/v1/:parent/releaseConfigs?pageSize=0&pageToken=stringLists ReleaseConfigs in a given Repository. - POSTCreates a new ReleaseConfig in a given Repository.
/v1/:parent/releaseConfigs?releaseConfigId=stringCreates a new ReleaseConfig in a given Repository.
projects.locations.repositories.workflowConfigs
- GETLists WorkflowConfigs in a given Repository.
/v1/:parent/workflowConfigs?pageSize=0&pageToken=stringLists WorkflowConfigs in a given Repository. - POSTCreates a new WorkflowConfig in a given Repository.
/v1/:parent/workflowConfigs?workflowConfigId=stringCreates a new WorkflowConfig in a given Repository.
API details
- Base URL
https://dataform.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 54 operations on 46 pathsGET 26POST 26PATCH 1DELETE 1
- Main resources
- projects.locations.repositories.workspaces 20projects.locations.teamFolders 10projects.locations.repositories 8projects.locations.repositories.workflowInvocations 4projects.locations.repositories.compilationResults 3projects.locations 2projects.locations.folders 2projects.locations.repositories.releaseConfigs 2projects.locations.repositories.workflowConfigs 2projects.locations.operations 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Dataform API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Dataform API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Fetches a single TeamFolder.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Dataform API?
Service to develop, version control, and operationalize SQL pipelines in BigQuery. It is listed under Data & analytics and has 54 endpoints.
Who publishes the Dataform API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Dataform API?
Requests go to https://dataform.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Dataform API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Dataform API have?
54 operations on 46 paths (26 GET, 26 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.repositories.workspaces, projects.locations.teamFolders, projects.locations.repositories, projects.locations.repositories.workflowInvocations.
Is forking the Dataform API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.