Skip to main content
Glama
PipelineStore-Metrics-RESTful-API-swagger.json69.1 kB
{"swagger":"2.0","info":{"description":"Provides API to manage pipelines in Control Hub","version":"1.0.0","title":"Pipeline Repository RESTful API"},"basePath":"/pipelinestore/rest","tags":[{"name":"pipelineStore"}],"paths":{"/v1/metrics/pipelines":{"get":{"tags":["pipelineStore"],"summary":"Returns all Pipelines created by users in a group between a start and end time","description":"","operationId":"getPipelinesCreatedByGroupFilteredByTime","produces":["application/json"],"parameters":[{"name":"group","in":"query","required":false,"type":"string"},{"name":"organization","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"NAME","enum":["NAME","COMMIT_MESSAGE","COMMIT_TIME","COMMITTER","VERSION","LAST_MODIFIED_ON","LAST_MODIFIED_BY"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"system","in":"query","required":false,"type":"boolean","default":false},{"name":"filterText","in":"query","required":false,"type":"string"},{"name":"onlyPublished","in":"query","required":false,"type":"boolean","default":true},{"name":"executionModes","in":"query","required":false,"type":"string"},{"name":"startTime","in":"query","required":false,"type":"integer","default":-1,"format":"int64"},{"name":"endTime","in":"query","required":false,"type":"integer","default":-1,"format":"int64"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJson"}}}}},"/v1/pipelineCI/configureMultipleCI":{"post":{"tags":["pipelineStore"],"summary":"Configure CI for multiple pipelines","description":"","operationId":"configureMultipleCI","parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"ciEnabled","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelineCI/{commitId}/ciHistory":{"get":{"tags":["pipelineStore"],"summary":"Returns CI Status history of a pipeline commit","description":"","operationId":"getBuildHistory","produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/ExternalCIStatusJson"}}}}}},"/v1/pipelineCI/{pipelineId}/configureCI":{"post":{"tags":["pipelineStore"],"summary":"Configure CI for a given pipeline","description":"","operationId":"configure","parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CIConfigJson"}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelineCI/{commitId}/updateBuildStatus":{"post":{"tags":["pipelineStore"],"summary":"Update CI Build Status","description":"","operationId":"updateBuildStatus","produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CIBuildJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CIBuildJson"}}}}},"/v1/pipelineCI/{pipelineId}/latestVerifiedCommit":{"get":{"tags":["pipelineStore"],"summary":"Returns latest CI verified pipeline commit for a given pipeline ","description":"","operationId":"getLatestVerifiedPipeline","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"name":"user","in":"query","required":false,"type":"string"},{"name":"onlyPublished","in":"query","required":false,"type":"boolean","default":true}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PipelineJson"}}}}},"/v1/pipelineCommit":{"post":{"tags":["pipelineStore"],"summary":"Returns Pipelines Commit ","description":"","operationId":"getMultiplePipelineCommit","produces":["application/json"],"parameters":[{"name":"includeLibraryDefinitions","in":"query","required":false,"type":"boolean","default":true},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PipelineJson"}}}}}},"/v1/pipelineCommit/{commitId}":{"get":{"tags":["pipelineStore"],"summary":"Returns Pipeline Commit ","description":"","operationId":"getPipelineCommit","produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"},{"name":"includeLibraryDefinitions","in":"query","required":false,"type":"boolean","default":true}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PipelineJson"}}}},"post":{"tags":["pipelineStore"],"summary":"Save Pipeline Commit ","description":"","operationId":"savePipelineCommit","produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"},{"name":"validate","in":"query","required":false,"type":"boolean","default":true},{"name":"includeLibraryDefinitions","in":"query","required":false,"type":"boolean","default":false},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PipelineJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PipelineJson"}}}},"delete":{"tags":["pipelineStore"],"summary":"Delete Pipeline Commit ","description":"","operationId":"deletePipelineCommit","produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelineCommit/{commitId}/rules":{"get":{"tags":["pipelineStore"],"summary":"Returns all Pipeline rules for given Pipeline Commit ID","description":"","operationId":"getAllRules","produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/RulesJson"}}}}},"put":{"tags":["pipelineStore"],"summary":"Add Pipeline rules to commit ","description":"","operationId":"addRules","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CommitRulesJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RulesJson"}}}}},"/v1/pipelineCommit/{fragmentCommitId}/pipelinesUsingFragment":{"get":{"tags":["pipelineStore"],"summary":"Get Latest Committed Pipeline using given fragment Commit ID","description":"","operationId":"getPipelinesUsingFragmentCommitId","produces":["application/json"],"parameters":[{"name":"fragmentCommitId","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"NAME","enum":["NAME","COMMIT_MESSAGE","COMMIT_TIME","COMMITTER","VERSION","LAST_MODIFIED_ON","LAST_MODIFIED_BY"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PipelineJson"}}}}}},"/v1/pipelineCommit/{commitId}/tag":{"put":{"tags":["pipelineStore"],"summary":"Create tag for Pipeline Commit","description":"","operationId":"createTag","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateTagJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagJson"}}}}},"/v1/pipelineCommit/{commitId}/changeCurrentRules":{"post":{"tags":["pipelineStore"],"summary":"Change current Pipeline rules for Pipelines Commit ","description":"","operationId":"changeCurrentRules","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"},{"name":"rulesCommitId","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RulesJson"}}}}},"/v1/pipelineCommit/{commitId}/publish":{"post":{"tags":["pipelineStore"],"summary":"Publish Pipeline","description":"","operationId":"publishPipeline","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"},{"name":"commitMessage","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PipelineJson"}}}}},"/v1/pipelineCommit/{commitId}/createDraft":{"post":{"tags":["pipelineStore"],"summary":"Create draft copy of pipeline","description":"","operationId":"createDraft","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"},{"name":"authoringSdcId","in":"query","required":false,"type":"string"},{"name":"authoringSdcVersion","in":"query","required":false,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PipelineJson"}}}}},"/v1/pipelineCommit/{commitId}/duplicate":{"post":{"tags":["pipelineStore"],"summary":"Duplicate Pipeline","description":"","operationId":"duplicatePipeline","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"commitId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DuplicatePipelineJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RulesJson"}}}}},"/v1/pipelineLabels/deleteLabels":{"post":{"tags":["pipelineStore"],"summary":"Delete Pipelines Labels ","description":"","operationId":"deletePipelineLabelsById","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelineLabels":{"get":{"tags":["pipelineStore"],"summary":"Returns all available Pipeline Labels","description":"","operationId":"getPipelineLabels","produces":["application/json"],"parameters":[{"name":"organization","in":"query","required":false,"type":"string"},{"name":"parentId","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PipelineLabel"}}}}},"put":{"tags":["pipelineStore"],"summary":"Create New Pipeline Label","description":"","operationId":"createPipelineLabel","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PipelineLabelJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PipelineLabelJson"}}}}},"/v1/saql/pipelines/search":{"get":{"tags":["pipelineStore"],"summary":"Pipeline search using Advanced Query Language (RSQL support)","description":"","operationId":"searchPipelines","produces":["application/json"],"parameters":[{"name":"organization","in":"query","required":false,"type":"string"},{"name":"search","in":"query","required":false,"type":"string"},{"name":"orderBy","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":0,"format":"int32"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJson"}}}}},"/v1/saql/pipelines/search/fragments":{"get":{"tags":["pipelineStore"],"summary":"Fragment search using Advanced Query Language (RSQL support)","description":"","operationId":"searchFragments","produces":["application/json"],"parameters":[{"name":"organization","in":"query","required":false,"type":"string"},{"name":"search","in":"query","required":false,"type":"string"},{"name":"orderBy","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":0,"format":"int32"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJson"}}}}},"/v1/pipeline/{pipelineId}/importPipelineNewVersion":{"post":{"tags":["pipelineStore"],"summary":"Import a pipeline as a new version of an existing Pipeline Id.","description":"","operationId":"importPipelineNewVersion","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"name":"commitMessage","in":"query","required":false,"type":"string"},{"in":"body","name":"pipelineEnvelope","required":true,"schema":{"$ref":"#/definitions/PipelineEnvelopeJson"}}],"security":[{"basic":[]}],"deprecated":true,"responses":{"default":{"description":"successful operation"}}}},"/v1/pipeline/{pipelineId}/importPipelineNewVersionById":{"post":{"tags":["pipelineStore"],"summary":"Import a pipeline as a new version of an existing Pipeline Id.","description":"","operationId":"importPipelineNewVersionById","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"name":"commitMessage","in":"query","required":false,"type":"string"},{"in":"body","name":"commitPipelineWithConnectionsMetadataJson","required":true,"schema":{"$ref":"#/definitions/CommitPipelineWithConnectionsMetadataJson"}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipeline/{pipelineId}/importFragmentNewVersion":{"post":{"tags":["pipelineStore"],"summary":"Import a pipeline fragment as a new version of an existing Pipeline Fragment Id.","description":"","operationId":"importFragmentNewVersion","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"name":"commitMessage","in":"query","required":false,"type":"string"},{"in":"body","name":"fragmentEnvelope","required":true,"schema":{"$ref":"#/definitions/PipelineFragmentEnvelopeJson"}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipeline/deleteSubjectFromAcl/{subjectId}":{"delete":{"tags":["pipelineStore"],"summary":"Delete subject from ACL","description":"","operationId":"deleteSubjectFromACL","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipeline/{pipelineId}":{"delete":{"tags":["pipelineStore"],"summary":"Delete all Pipeline Commits for given Pipeline ID","description":"","operationId":"deletePipeline","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipeline/{pipelineId}/acl":{"get":{"tags":["pipelineStore"],"summary":"Get ACL for a given pipeline","description":"","operationId":"getAcl","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AclJson"}}}},"post":{"tags":["pipelineStore"],"summary":"Update ACL for a given pipeline","description":"","operationId":"updatePipelineAcl","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AclJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AclJson"}}}}},"/v1/pipeline/{pipelineId}/tags":{"get":{"tags":["pipelineStore"],"summary":"Returns all tags for given Pipeline ID","description":"","operationId":"getTags","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/TagJson"}}}}}},"/v1/pipeline/{pipelineId}/permissions/{subjectId}":{"get":{"tags":["pipelineStore"],"summary":"Get permissions on a given pipeline for a given subject","description":"","operationId":"getPermission","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"name":"subjectId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AclJson"}}}},"post":{"tags":["pipelineStore"],"summary":"Update permissions on a given Pipeline for a given subject","description":"","operationId":"updatePermissions","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"name":"subjectId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PermissionJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AclJson"}}}}},"/v1/pipeline/{pipelineId}/log":{"get":{"tags":["pipelineStore"],"summary":"Returns all Pipeline Commits for given Pipeline ID","description":"","operationId":"getLog","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"name":"organization","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"onlyPublished","in":"query","required":false,"type":"boolean","default":true},{"name":"withWrapper","in":"query","required":false,"type":"boolean","default":false}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PipelineJson"}}}}}},"/v1/pipeline/{pipelineId}/latest":{"get":{"tags":["pipelineStore"],"summary":"Returns latest pipeline commit for a given pipeline ","description":"","operationId":"getLatestPipeline","produces":["application/json"],"parameters":[{"name":"pipelineId","in":"path","required":true,"type":"string"},{"name":"user","in":"query","required":false,"type":"string"},{"name":"onlyPublished","in":"query","required":false,"type":"boolean","default":true}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PipelineJson"}}}}},"/v1/pipeline/commitsNewerThan":{"get":{"tags":["pipelineStore"],"summary":"Get commits newer than given base commit for pipeline ID","description":"","operationId":"getCommitsNewerThan","produces":["application/json"],"parameters":[{"name":"baseCommit","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","format":"int32"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJson"}}}}},"/v1/pipeline/detachedstage":{"post":{"tags":["pipelineStore"],"summary":"Validates given detached stage and performs any necessary upgrade.","description":"","operationId":"validateDetachedStage","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DetachedStageConfigurationJson"}},{"name":"executorType","in":"query","required":false,"type":"string","default":"COLLECTOR","enum":["COLLECTOR","TRANSFORMER","EDGE","SNOWPARK"]}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DetachedStageConfigurationJson"}}}}},"/v1/pipelines/deletePipelines":{"post":{"tags":["pipelineStore"],"summary":"Delete Pipelines","description":"","operationId":"deletePipelines","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines":{"get":{"tags":["pipelineStore"],"summary":"Returns all Pipeline","description":"","operationId":"getPipelines","produces":["application/json"],"parameters":[{"name":"organization","in":"query","required":false,"type":"string"},{"name":"pipelineLabelId","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"NAME","enum":["NAME","COMMIT_MESSAGE","COMMIT_TIME","COMMITTER","VERSION","LAST_MODIFIED_ON","LAST_MODIFIED_BY"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"system","in":"query","description":"This parameter has been deprecated and has no effect","required":false,"type":"boolean","default":false},{"name":"filterText","in":"query","required":false,"type":"string"},{"name":"onlyPublished","in":"query","required":false,"type":"boolean","default":true},{"name":"executionModes","in":"query","required":false,"type":"string"},{"name":"startTime","in":"query","required":false,"type":"integer","default":-1,"format":"int64"},{"name":"endTime","in":"query","required":false,"type":"integer","default":-1,"format":"int64"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"draft","in":"query","required":false,"type":"boolean"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJson"}}}},"put":{"tags":["pipelineStore"],"summary":"Commit Pipeline","description":"","operationId":"commitPipeline","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"organization","in":"query","required":false,"type":"string"},{"name":"newPipeline","in":"query","required":false,"type":"boolean"},{"name":"executionMode","in":"query","required":false,"type":"string","default":"STANDALONE","enum":["STANDALONE","CLUSTER_BATCH","CLUSTER_YARN_STREAMING","CLUSTER_MESOS_STREAMING","SECONDARY","EDGE","EMR_BATCH","BATCH","STREAMING","SNOWPARK"]},{"name":"templateCommitId","in":"query","required":false,"type":"string"},{"name":"importPipeline","in":"query","required":false,"type":"boolean"},{"name":"fragment","in":"query","required":false,"type":"boolean","default":false},{"name":"pipelineType","in":"query","required":false,"type":"string","default":"DATA_COLLECTOR"},{"name":"removeMissingConnection","in":"query","required":false,"type":"boolean","default":false},{"in":"body","name":"body","required":false,"schema":{"type":"string"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PipelineJson"}}}}},"/v1/pipelines/templates":{"get":{"tags":["pipelineStore"],"summary":"Returns all template Pipelines","description":"","operationId":"getTemplatePipelines","produces":["application/json"],"parameters":[{"name":"pipelineLabelId","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"NAME","enum":["NAME","COMMIT_MESSAGE","COMMIT_TIME","COMMITTER","VERSION","LAST_MODIFIED_ON","LAST_MODIFIED_BY"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"system","in":"query","description":"This parameter has been deprecated and has no effect","required":false,"type":"boolean","default":false},{"name":"filterText","in":"query","required":false,"type":"string"},{"name":"executionModes","in":"query","required":false,"type":"string"},{"name":"startTime","in":"query","required":false,"type":"integer","default":-1,"format":"int64"},{"name":"endTime","in":"query","required":false,"type":"integer","default":-1,"format":"int64"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJson"}}}}},"/v1/pipelines/deletePipelineCommits":{"post":{"tags":["pipelineStore"],"summary":"Delete Pipeline Versions","description":"","operationId":"deletePipelineCommits","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines/exportAllPublishedPipelineCommits":{"post":{"tags":["pipelineStore"],"summary":"Export all published Pipelines and Pipeline Fragments","description":"","operationId":"exportAllPublishedPipelineCommits","produces":["application/octet-stream"],"parameters":[{"name":"fragments","in":"query","required":false,"type":"boolean","default":false},{"name":"includePlainTextCredentials","in":"query","required":false,"type":"boolean","default":false}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines/importPipelineCommitsV2":{"post":{"tags":["pipelineStore"],"summary":"Import Pipelines from ImportPipelineJson","description":"","operationId":"importPipelinesV2","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ImportPipelineJson"}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines/latestCommit":{"post":{"tags":["pipelineStore"],"summary":"Get Latest Committed Pipeline for the given list of pipeline IDs","description":"","operationId":"getLatestCommitPipelines","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PipelineJson"}}}}}},"/v1/pipelines/exportPipelineCommits":{"post":{"tags":["pipelineStore"],"summary":"Export Pipelines and Pipeline Fragments","description":"","operationId":"exportPipelineCommits","produces":["application/octet-stream"],"parameters":[{"name":"fragments","in":"query","required":false,"type":"boolean","default":false},{"name":"includePlainTextCredentials","in":"query","required":false,"type":"boolean","default":false},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines/fragments":{"get":{"tags":["pipelineStore"],"summary":"Returns all Fragments","description":"","operationId":"getFragments","produces":["application/json"],"parameters":[{"name":"organization","in":"query","required":false,"type":"string"},{"name":"pipelineLabelId","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"orderBy","in":"query","required":false,"type":"string","default":"NAME","enum":["NAME","COMMIT_MESSAGE","COMMIT_TIME","COMMITTER","VERSION","LAST_MODIFIED_ON","LAST_MODIFIED_BY"]},{"name":"order","in":"query","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"system","in":"query","description":"This parameter has been deprecated and has no effect","required":false,"type":"boolean","default":false},{"name":"filterText","in":"query","required":false,"type":"string"},{"name":"onlyPublished","in":"query","required":false,"type":"boolean","default":true},{"name":"executionModes","in":"query","required":false,"type":"string"},{"name":"startTime","in":"query","required":false,"type":"integer","default":-1,"format":"int64"},{"name":"endTime","in":"query","required":false,"type":"integer","default":-1,"format":"int64"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"draft","in":"query","required":false,"type":"boolean"},{"name":"loadPipelineDefinition","in":"query","required":false,"type":"boolean","default":false}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJson"}}}}},"/v1/pipelines/count":{"get":{"tags":["pipelineStore"],"summary":"Returns Pipelines count ","description":"","operationId":"getOrgPipelinesCount","produces":["application/json"],"parameters":[{"name":"organization","in":"query","required":false,"type":"string"},{"name":"system","in":"query","description":"This parameter has been deprecated and has no effect","required":false,"type":"boolean","default":false}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v1/pipelines/pipelinesNewerThan":{"get":{"tags":["pipelineStore"],"summary":"Get commits newer than a given timestamp","description":"","operationId":"getPipelinesNewerThan","produces":["application/json"],"parameters":[{"name":"commitTimestamp","in":"query","required":false,"type":"integer","format":"int64"},{"name":"draft","in":"query","required":false,"type":"boolean"},{"name":"offset","in":"query","required":false,"type":"integer","format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","format":"int32"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PaginationWrapperJson"}}}}},"/v1/pipelines/updateFragmentVersion/{fromFragmentCommitId}/{toFragmentCommitId}":{"post":{"tags":["pipelineStore"],"summary":"Update pipelines with latest pipeline fragment commit version","description":"","operationId":"updateFragmentVersion","produces":["application/json"],"parameters":[{"name":"fromFragmentCommitId","in":"path","required":true,"type":"string"},{"name":"toFragmentCommitId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines/verifyPipelineCommits":{"post":{"tags":["pipelineStore"],"summary":"Verify import Pipelines from compressed archive","description":"","operationId":"verifyImportPipelines","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"file","in":"formData","required":false,"type":"file"},{"name":"commitMessage","in":"query","required":false,"type":"string"},{"name":"fragments","in":"query","required":false,"type":"boolean","default":false},{"name":"failIfExists","in":"query","required":false,"type":"boolean","default":false},{"name":"importAsNew","in":"query","required":false,"type":"boolean","default":false}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines/importPipelineCommits":{"post":{"tags":["pipelineStore"],"summary":"Import Pipelines from compressed archive","description":"","operationId":"importPipelines","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"file","in":"formData","required":false,"type":"file"},{"name":"commitMessage","in":"query","required":false,"type":"string"},{"name":"fragments","in":"query","required":false,"type":"boolean","default":false},{"name":"failIfExists","in":"query","required":false,"type":"boolean","default":false},{"name":"importAsNew","in":"query","required":false,"type":"boolean","default":false},{"name":"removeMissingConnection","in":"query","required":false,"type":"boolean","default":false}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines/importPipelineCommit":{"post":{"tags":["pipelineStore"],"summary":"Import Pipeline from JSON.","description":"","operationId":"importPipeline","produces":["application/json"],"parameters":[{"name":"commitMessage","in":"query","required":false,"type":"string"},{"name":"importAsNew","in":"query","required":false,"type":"boolean","default":false},{"name":"removeMissingConnection","in":"query","required":false,"type":"boolean","default":false},{"in":"body","name":"pipelineEnvelope","required":true,"schema":{"$ref":"#/definitions/PipelineEnvelopeJson"}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines/importFragmentCommit":{"post":{"tags":["pipelineStore"],"summary":"Import Pipeline Fragment from JSON.","description":"","operationId":"importPipelineFragment","produces":["application/json"],"parameters":[{"name":"commitMessage","in":"query","required":false,"type":"string"},{"name":"importAsNew","in":"query","required":false,"type":"boolean","default":false},{"name":"removeMissingConnection","in":"query","required":false,"type":"boolean","default":false},{"in":"body","name":"fragmentEnvelope","required":true,"schema":{"$ref":"#/definitions/PipelineFragmentEnvelopeJson"}}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/pipelines/listAclAudits":{"get":{"tags":["pipelineStore"],"summary":"Get all user actions for given Organization ID","description":"","operationId":"listAclAuditsForOrg","produces":["application/json"],"parameters":[{"name":"organization","in":"query","required":false,"type":"string"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"},{"name":"len","in":"query","required":false,"type":"integer","default":-1,"format":"int32"},{"name":"sortField","in":"query","required":false,"type":"string","default":"TIME","enum":["TIME","ACTION","REQUESTER_ID","ACL_ID"]},{"name":"sortOrder","in":"query","required":false,"type":"string","default":"DESC","enum":["ASC","DESC"]},{"name":"withWrapper","in":"query","required":false,"type":"boolean","default":false}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AclAuditJson"}}}}}},"/v1/rules":{"post":{"tags":["pipelineStore"],"summary":"Returns Pipeline Rules for all given Pipeline Commit IDs","description":"","operationId":"getMultipleRules","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/RulesJson"}}}}}},"/v1/rules/{rulesId}":{"get":{"tags":["pipelineStore"],"summary":"Return Pipeline Rules for given Rule ID","description":"","operationId":"getRules","produces":["application/json"],"parameters":[{"name":"rulesId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RulesJson"}}}}},"/v1/defaults/snowflake":{"get":{"tags":["pipelineStore"],"summary":"Get the Snowflake pipeline defaults for this user (if it exists)","description":"","operationId":"get","consumes":["application/json"],"produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SnowparkPipelineDefaultsJson"}}}},"post":{"tags":["pipelineStore"],"summary":"Create or update the Snowflake pipeline defaults for this user","description":"","operationId":"createOrUpdate","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"defaults","required":true,"schema":{"$ref":"#/definitions/SnowparkPipelineDefaultsJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SnowparkPipelineDefaultsJson"}}}},"delete":{"tags":["pipelineStore"],"summary":"Delete the Snowflake pipeline defaults for this user","description":"","operationId":"delete","consumes":["application/json"],"produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/credential/snowflake":{"get":{"tags":["pipelineStore"],"summary":"Get the Snowflake user credential for this user (if it exists). It will be redacted.","description":"","operationId":"get_1","consumes":["application/json"],"produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SnowflakeUserCredentialJson"}}}},"post":{"tags":["pipelineStore"],"summary":"Create or update the Snowflake user credential for this user.","description":"","operationId":"createOrUpdate_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"snowflakeUserCredential","required":true,"schema":{"$ref":"#/definitions/SnowflakeUserCredentialJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SnowflakeUserCredentialJson"}}}},"delete":{"tags":["pipelineStore"],"summary":"Delete the Snowflake user credential for this user.","description":"","operationId":"delete_1","consumes":["application/json"],"produces":["application/json"],"parameters":[],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}},"/v1/credential/snowflake/validate":{"get":{"tags":["pipelineStore"],"operationId":"getValidateCredentials","parameters":[],"responses":{"default":{"description":"successful operation"}}},"post":{"tags":["pipelineStore"],"summary":"Validate given credentials","description":"","operationId":"validateCredentials","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"snowflakeUserCredential","required":true,"schema":{"$ref":"#/definitions/SnowparkUserCredentialWithURLJson"}}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SnowparkUserCredentialWithURLJson"}}}}},"/v1/tag/{tagId}":{"get":{"tags":["pipelineStore"],"summary":"Return Pipeline Commit for given Tag ID","description":"","operationId":"getTag","produces":["application/json"],"parameters":[{"name":"tagId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RulesJson"}}}},"delete":{"tags":["pipelineStore"],"summary":"Remove Tag","description":"","operationId":"removeTag","parameters":[{"name":"tagId","in":"path","required":true,"type":"string"}],"security":[{"basic":[]}],"responses":{"default":{"description":"successful operation"}}}}},"definitions":{"PaginationWrapperJson":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int64"},"len":{"type":"integer","format":"int64"},"data":{"type":"object"}}},"CIBuildJson":{"type":"object","properties":{"buildId":{"type":"string"},"commitId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"buildURL":{"type":"string"},"buildStatus":{"type":"string","enum":["RUNNING","SUCCESSFUL","FAILED"]},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"testInfos":{"type":"array","items":{"$ref":"#/definitions/TestInfoJson"}},"startTime":{"type":"integer","format":"int64"},"finishTime":{"type":"integer","format":"int64"}}},"ExternalCIStatusJson":{"type":"object","properties":{"ciBuild":{"$ref":"#/definitions/CIBuildJson"},"status":{"type":"string","enum":["VERIFYING","VERIFIED","VERIFY_FAILED","ABORTED"]}}},"TestInfoJson":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"startTime":{"type":"integer","format":"int64"},"finishTime":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["PASSED","FAILED","SKIPPED"]},"message":{"type":"string"}}},"CIConfigJson":{"type":"object","properties":{"ciEnabled":{"type":"boolean"}}},"PipelineJson":{"type":"object","properties":{"commitId":{"type":"string"},"organization":{"type":"string"},"pipelineId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"parentVersion":{"type":"string"},"version":{"type":"string"},"committer":{"type":"string"},"commitMessage":{"type":"string"},"commitTime":{"type":"integer","format":"int64"},"pipelineDefinition":{"type":"string"},"libraryDefinitions":{"type":"string"},"currentRules":{"$ref":"#/definitions/RulesJson"},"definitionRemover":{"type":"string"},"definitionRemoveMessage":{"type":"string"},"definitionRemoveTime":{"type":"integer","format":"int64"},"pipelineLabels":{"type":"array","items":{"$ref":"#/definitions/PipelineLabelJson"}},"system":{"type":"boolean"},"sdcVersion":{"type":"string"},"sdcId":{"type":"string"},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"draft":{"type":"boolean"},"executionMode":{"type":"string","enum":["STANDALONE","CLUSTER_BATCH","CLUSTER_YARN_STREAMING","CLUSTER_MESOS_STREAMING","SECONDARY","EDGE","EMR_BATCH","BATCH","STREAMING","SNOWPARK"]},"provenanceMetaData":{"type":"object","additionalProperties":{"type":"string"}},"fragment":{"type":"boolean"},"currentExternalCIStatus":{"$ref":"#/definitions/ExternalCIStatusJson"},"externalCiStatuses":{"type":"array","items":{"$ref":"#/definitions/ExternalCIStatusJson"}},"fragmentCommitIds":{"type":"array","items":{"type":"string"}},"ciConfig":{"$ref":"#/definitions/CIConfigJson"},"executorType":{"type":"string","enum":["COLLECTOR","TRANSFORMER","EDGE","SNOWPARK"]},"projectId":{"type":"string"}}},"PipelineLabelJson":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"parentId":{"type":"string"},"organization":{"type":"string"},"projectId":{"type":"string"}}},"RulesJson":{"type":"object","properties":{"id":{"type":"string"},"commitId":{"type":"string"},"name":{"type":"string"},"rulesCommitter":{"type":"string"},"message":{"type":"string"},"rulesTime":{"type":"integer","format":"int64"},"rulesDefinition":{"type":"string"},"definitionRemover":{"type":"string"},"definitionRemoveMessage":{"type":"string"},"definitionRemoveTime":{"type":"integer","format":"int64"}}},"CommitRulesJson":{"type":"object","properties":{"name":{"type":"string"},"rulesMessage":{"type":"string"},"rulesDefinition":{"type":"string"},"makeCurrent":{"type":"boolean"}}},"TagJson":{"type":"object","properties":{"id":{"type":"string"},"commitId":{"type":"string"},"name":{"type":"string"},"message":{"type":"string"},"tagger":{"type":"string"},"tagTime":{"type":"integer","format":"int64"}}},"CreateTagJson":{"type":"object","properties":{"tagName":{"type":"string"},"tagMessage":{"type":"string"}}},"DuplicatePipelineJson":{"type":"object","properties":{"namePrefix":{"type":"string"},"description":{"type":"string"},"numberOfCopies":{"type":"integer","format":"int32"}}},"PipelineLabel":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"organization":{"type":"string"},"containerId":{"type":"string"},"parentId":{"type":"string"},"optimisticLockVersion":{"type":"integer","format":"int64"}}},"AtomJson":{"allOf":[{"$ref":"#/definitions/ElementJson"},{"type":"object","properties":{}}]},"CompositeConfigDefinitionJson":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"group":{"type":"string"},"displayPosition":{"type":"integer","format":"int32"},"configs":{"type":"array","items":{"$ref":"#/definitions/ConfigJson"}}}},"ConfigConfigurationJson":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}}},"ConfigDefinitionJson":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["BOOLEAN","NUMBER","STRING","LIST","MAP","MODEL","CHARACTER","TEXT","CREDENTIAL","RUNTIME"]},"upload":{"type":"string","enum":["NO","TEXT","BASE64"]},"defaultValue":{"type":"object"},"label":{"type":"string"},"placeholder":{"$ref":"#/definitions/PlaceholderBean"},"mode":{"type":"string"},"required":{"type":"boolean"},"elDefs":{"type":"array","items":{"type":"string"}},"elFunctionDefinitionsIdx":{"type":"array","items":{"type":"string"}},"elConstantDefinitionsIdx":{"type":"array","items":{"type":"string"}},"model":{"$ref":"#/definitions/ModelDefinitionJson"},"lines":{"type":"integer","format":"int32"},"displayPosition":{"type":"integer","format":"int32"},"dependsOnMap":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"excludesOnMap":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"description":{"type":"string"},"dependsOn":{"type":"string"},"triggeredByValues":{"type":"array","items":{"type":"object"}},"min":{"type":"integer"},"group":{"type":"string"},"displayMode":{"type":"string","enum":["BASIC","ADVANCED"]},"connectionType":{"type":"string"},"constraints":{"type":"array","items":{"$ref":"#/definitions/ConstraintBean"}},"readOnly":{"type":"boolean"},"evaluation":{"type":"string","enum":["IMPLICIT","EXPLICIT"]},"max":{"type":"integer"},"fieldName":{"type":"string"},"requiredForExplorerLoad":{"type":"boolean"},"explorerConfig":{"$ref":"#/definitions/ExplorerConfigDefinitionJson"}}},"ConfigGroupDefinitionJson":{"type":"object","properties":{"classNameToGroupsMap":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"groupNameToLabelMapList":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}}},"ConfigJson":{"type":"object","properties":{"name":{"type":"string"},"separator":{"type":"string"}}},"ConstraintBean":{"type":"object","properties":{"constraintSetting":{"type":"string"},"constraintValue":{"type":"string"},"permittedValues":{"type":"array","items":{"type":"string"}},"prohibitedValues":{"type":"array","items":{"type":"string"}}}},"DataRuleDefinitionJson":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"lane":{"type":"string"},"samplingPercentage":{"type":"number","format":"double"},"samplingRecordsToRetain":{"type":"integer","format":"int32"},"condition":{"type":"string"},"alertEnabled":{"type":"boolean"},"alertText":{"type":"string"},"thresholdType":{"type":"string","enum":["COUNT","PERCENTAGE"]},"thresholdValue":{"type":"string"},"minVolume":{"type":"integer","format":"int64"},"meterEnabled":{"type":"boolean"},"sendEmail":{"type":"boolean"},"enabled":{"type":"boolean"},"valid":{"type":"boolean"},"timestamp":{"type":"integer","format":"int64"}}},"DefinitionsJson":{"type":"object","properties":{"schemaVersion":{"type":"string"},"pipeline":{"type":"array","items":{"$ref":"#/definitions/PipelineDefinitionJson"}},"pipelineFragment":{"type":"array","items":{"$ref":"#/definitions/PipelineFragmentDefinitionJson"}},"pipelineRules":{"type":"array","items":{"$ref":"#/definitions/PipelineRulesDefinitionJson"}},"stages":{"type":"array","items":{"$ref":"#/definitions/StageDefinitionJson"}},"services":{"type":"array","items":{"$ref":"#/definitions/ServiceDefinitionJson"}},"rulesElMetadata":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"elCatalog":{"type":"object","additionalProperties":{"type":"object"}},"runtimeConfigs":{"type":"array","uniqueItems":true,"items":{"type":"object"}},"stageIcons":{"type":"object","additionalProperties":{"type":"string"}},"legacyStageLibs":{"type":"array","items":{"type":"string"}},"eventDefinitions":{"type":"object","additionalProperties":{"$ref":"#/definitions/EventDefinitionJson"}},"version":{"type":"string"},"executorVersion":{"type":"string"},"category":{"type":"string"},"categoryLabel":{"type":"string"}}},"DriftRuleDefinitionJson":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"lane":{"type":"string"},"samplingPercentage":{"type":"number","format":"double"},"samplingRecordsToRetain":{"type":"integer","format":"int32"},"condition":{"type":"string"},"alertEnabled":{"type":"boolean"},"alertText":{"type":"string"},"meterEnabled":{"type":"boolean"},"sendEmail":{"type":"boolean"},"enabled":{"type":"boolean"},"timestamp":{"type":"integer","format":"int64"},"valid":{"type":"boolean"}}},"ElementJson":{"type":"object","discriminator":"type","properties":{"name":{"type":"string"},"icon":{"type":"string"},"additionalNamesIcons":{"type":"object","additionalProperties":{"type":"string"}}}},"EventDefinitionJson":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","format":"int32"},"fields":{"type":"array","items":{"$ref":"#/definitions/EventFieldDefinitionJson"}}}},"EventFieldDefinitionJson":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"optional":{"type":"boolean"}}},"ExplorerConfigDefinitionJson":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"explorerType":{"type":"string"},"nextExplorer":{"type":"string"},"binding":{"type":"string"},"setConfigsWith":{"type":"object","additionalProperties":{"type":"string"}},"fixSearchWith":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"positionAt":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"schemaElement":{"type":"string"},"location":{"type":"string"},"locationPath":{"type":"string"},"upTruncate":{"type":"boolean"},"additionalDepth":{"type":"integer","format":"int32"},"configSchemaAttributes":{"type":"array","items":{"type":"string"}},"explorerSchemaAttributes":{"type":"array","items":{"type":"string"}}}},"ExplorerDefinitionJson":{"type":"object","properties":{"type":{"type":"string"},"explorerSchemaJson":{"$ref":"#/definitions/ExplorerSchemaJson"}}},"ExplorerSchemaJson":{"type":"object","properties":{"schema":{"type":"array","items":{"$ref":"#/definitions/ElementJson"}},"elementIconMap":{"type":"object","additionalProperties":{"type":"string"}}}},"IssueJson":{"type":"object","properties":{"message":{"type":"string"},"level":{"type":"string"},"instanceName":{"type":"string"},"serviceName":{"type":"string"},"configGroup":{"type":"string"},"configName":{"type":"string"},"additionalInfo":{"type":"object","additionalProperties":{"type":"object"}},"count":{"type":"integer","format":"int64"}}},"IssuesJson":{"type":"object","properties":{"pipelineIssues":{"type":"array","items":{"$ref":"#/definitions/IssueJson"}},"stageIssues":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/IssueJson"}}},"issueCount":{"type":"integer","format":"int32"}}},"MetricsRuleDefinitionJson":{"type":"object","properties":{"id":{"type":"string"},"alertText":{"type":"string"},"metricId":{"type":"string"},"metricType":{"type":"string","enum":["GAUGE","COUNTER","HISTOGRAM","METER","TIMER"]},"metricElement":{"type":"string","enum":["COUNTER_COUNT","HISTOGRAM_COUNT","HISTOGRAM_MAX","HISTOGRAM_MIN","HISTOGRAM_MEAN","HISTOGRAM_MEDIAN","HISTOGRAM_P50","HISTOGRAM_P75","HISTOGRAM_P95","HISTOGRAM_P98","HISTOGRAM_P99","HISTOGRAM_P999","HISTOGRAM_STD_DEV","METER_COUNT","METER_M1_RATE","METER_M5_RATE","METER_M15_RATE","METER_M30_RATE","METER_H1_RATE","METER_H6_RATE","METER_H12_RATE","METER_H24_RATE","METER_MEAN_RATE","TIMER_COUNT","TIMER_MAX","TIMER_MIN","TIMER_MEAN","TIMER_P50","TIMER_P75","TIMER_P95","TIMER_P98","TIMER_P99","TIMER_P999","TIMER_STD_DEV","TIMER_M1_RATE","TIMER_M5_RATE","TIMER_M15_RATE","TIMER_MEAN_RATE","CURRENT_BATCH_AGE","TIME_IN_CURRENT_STAGE","TIME_OF_LAST_RECEIVED_RECORD","LAST_BATCH_INPUT_RECORDS_COUNT","LAST_BATCH_OUTPUT_RECORDS_COUNT","LAST_BATCH_ERROR_RECORDS_COUNT","LAST_BATCH_ERROR_MESSAGES_COUNT"]},"condition":{"type":"string"},"sendEmail":{"type":"boolean"},"enabled":{"type":"boolean"},"valid":{"type":"boolean"},"timestamp":{"type":"integer","format":"int64"}}},"ModelDefinitionJson":{"type":"object","properties":{"labels":{"type":"array","items":{"type":"string"}},"valuesProviderClass":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"configDefinitions":{"type":"array","items":{"$ref":"#/definitions/ConfigDefinitionJson"}},"compositeConfigDefinitions":{"type":"array","items":{"$ref":"#/definitions/CompositeConfigDefinitionJson"}},"filteringConfig":{"type":"string"},"fieldTemplate":{"type":"string"},"modelType":{"type":"string","enum":["FIELD_SELECTOR_MULTI_VALUE","FIELD_SELECTOR","FIELD_VALUE_CHOOSER","VALUE_CHOOSER","MULTI_VALUE_CHOOSER","PREDICATE","LIST_BEAN","FIELD_SELECTOR_TEMPLATE"]}}},"PipelineConfigurationJson":{"type":"object","properties":{"schemaVersion":{"type":"integer","format":"int32"},"version":{"type":"integer","format":"int32"},"pipelineId":{"type":"string"},"uuid":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"configuration":{"type":"array","items":{"$ref":"#/definitions/ConfigConfigurationJson"}},"uiInfo":{"type":"object","additionalProperties":{"type":"object"}},"stages":{"type":"array","items":{"$ref":"#/definitions/StageConfigurationJson"}},"errorStage":{"$ref":"#/definitions/StageConfigurationJson"},"testOriginStage":{"$ref":"#/definitions/StageConfigurationJson"},"info":{"$ref":"#/definitions/PipelineInfoJson"},"issues":{"$ref":"#/definitions/IssuesJson"},"valid":{"type":"boolean"},"previewable":{"type":"boolean"},"statsAggregatorStage":{"$ref":"#/definitions/StageConfigurationJson"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"startEventStages":{"type":"array","items":{"$ref":"#/definitions/StageConfigurationJson"}},"stopEventStages":{"type":"array","items":{"$ref":"#/definitions/StageConfigurationJson"}},"fragments":{"type":"array","items":{"$ref":"#/definitions/PipelineFragmentConfigurationJson"}}}},"PipelineDefinitionJson":{"type":"object","properties":{"configGroupDefinition":{"$ref":"#/definitions/ConfigGroupDefinitionJson"},"configDefinitions":{"type":"array","items":{"$ref":"#/definitions/ConfigDefinitionJson"}},"compositeConfigDefinitions":{"type":"array","items":{"$ref":"#/definitions/CompositeConfigDefinitionJson"}},"explorerDefinitions":{"type":"array","items":{"$ref":"#/definitions/ExplorerDefinitionJson"}},"explorerSchema":{"$ref":"#/definitions/ExplorerSchemaJson"}}},"PipelineEnvelopeJson":{"type":"object","properties":{"pipelineConfig":{"$ref":"#/definitions/PipelineConfigurationJson"},"pipelineRules":{"$ref":"#/definitions/RuleDefinitionsJson"},"libraryDefinitions":{"$ref":"#/definitions/DefinitionsJson"}}},"PipelineFragmentConfigurationJson":{"type":"object","properties":{"schemaVersion":{"type":"integer","format":"int32"},"version":{"type":"integer","format":"int32"},"fragmentId":{"type":"string"},"fragmentInstanceId":{"type":"string"},"uuid":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"configuration":{"type":"array","items":{"$ref":"#/definitions/ConfigConfigurationJson"}},"uiInfo":{"type":"object","additionalProperties":{"type":"object"}},"stages":{"type":"array","items":{"$ref":"#/definitions/StageConfigurationJson"}},"info":{"$ref":"#/definitions/PipelineInfoJson"},"issues":{"$ref":"#/definitions/IssuesJson"},"valid":{"type":"boolean"},"previewable":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"fragments":{"type":"array","items":{"$ref":"#/definitions/PipelineFragmentConfigurationJson"}},"testOriginStage":{"$ref":"#/definitions/StageConfigurationJson"}}},"PipelineFragmentDefinitionJson":{"type":"object","properties":{"configGroupDefinition":{"$ref":"#/definitions/ConfigGroupDefinitionJson"},"configDefinitions":{"type":"array","items":{"$ref":"#/definitions/ConfigDefinitionJson"}}}},"PipelineInfoJson":{"type":"object","properties":{"name":{"type":"string"},"pipelineId":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"creator":{"type":"string"},"lastModifier":{"type":"string"},"lastRev":{"type":"string"},"uuid":{"type":"string"},"valid":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"object"}},"sdcVersion":{"type":"string"},"sdcId":{"type":"string"}}},"PipelineRulesDefinitionJson":{"type":"object","properties":{"configGroupDefinition":{"$ref":"#/definitions/ConfigGroupDefinitionJson"},"configDefinitions":{"type":"array","items":{"$ref":"#/definitions/ConfigDefinitionJson"}}}},"PlaceholderBean":{"type":"object","properties":{"text":{"type":"string"}}},"RawSourceDefinitionJson":{"type":"object","properties":{"rawSourcePreviewerClass":{"type":"string"},"mimeType":{"type":"string"},"configDefinitions":{"type":"array","items":{"$ref":"#/definitions/ConfigDefinitionJson"}}}},"RuleDefinitionsJson":{"type":"object","properties":{"schemaVersion":{"type":"string"},"version":{"type":"string"},"metricsRuleDefinitions":{"type":"array","items":{"$ref":"#/definitions/MetricsRuleDefinitionJson"}},"dataRuleDefinitions":{"type":"array","items":{"$ref":"#/definitions/DataRuleDefinitionJson"}},"driftRuleDefinitions":{"type":"array","items":{"$ref":"#/definitions/DriftRuleDefinitionJson"}},"emailIds":{"type":"array","items":{"type":"string"}},"uuid":{"type":"string"},"ruleIssues":{"type":"array","items":{"$ref":"#/definitions/RuleIssueJson"}},"configuration":{"type":"array","items":{"$ref":"#/definitions/ConfigConfigurationJson"}},"configIssues":{"type":"array","items":{"$ref":"#/definitions/IssueJson"}}}},"RuleIssueJson":{"type":"object","properties":{"message":{"type":"string"},"additionalInfo":{"type":"object","additionalProperties":{"type":"object"}},"ruleId":{"type":"string"}}},"ServiceConfigurationJson":{"type":"object","properties":{"service":{"type":"string","readOnly":true},"serviceVersion":{"type":"integer","format":"int32"},"configuration":{"type":"array","items":{"$ref":"#/definitions/ConfigConfigurationJson"}}}},"ServiceDefinitionJson":{"type":"object","properties":{"className":{"type":"string"},"version":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"},"library":{"type":"string"},"libraryLabel":{"type":"string"},"configGroupDefinition":{"$ref":"#/definitions/ConfigGroupDefinitionJson"},"privateClassLoader":{"type":"boolean"},"provides":{"type":"string"},"configDefinitions":{"type":"array","items":{"$ref":"#/definitions/ConfigDefinitionJson"}}}},"ServiceDependencyDefinitionJson":{"type":"object","properties":{"service":{"type":"string"},"configuration":{"type":"object","additionalProperties":{"type":"string"}}}},"SetJson":{"allOf":[{"$ref":"#/definitions/ElementJson"},{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/ElementJson"}}}}]},"StageConfigurationJson":{"type":"object","properties":{"instanceName":{"type":"string"},"library":{"type":"string"},"stageName":{"type":"string"},"stageVersion":{"type":"string"},"configuration":{"type":"array","items":{"$ref":"#/definitions/ConfigConfigurationJson"}},"services":{"type":"array","items":{"$ref":"#/definitions/ServiceConfigurationJson"}},"uiInfo":{"type":"object","additionalProperties":{"type":"object"}},"inputLanes":{"type":"array","items":{"type":"string"}},"outputLanes":{"type":"array","items":{"type":"string"}},"eventLanes":{"type":"array","items":{"type":"string"}}}},"StageDefinitionJson":{"type":"object","properties":{"eventDefs":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"type":{"type":"string","enum":["SOURCE","PROCESSOR","EXECUTOR","TARGET"]},"className":{"type":"string"},"label":{"type":"string"},"libraryLabel":{"type":"string"},"configGroupDefinition":{"$ref":"#/definitions/ConfigGroupDefinitionJson"},"rawSourceDefinition":{"$ref":"#/definitions/RawSourceDefinitionJson"},"errorStage":{"type":"boolean"},"statsAggregatorStage":{"type":"boolean"},"connectionVerifierStage":{"type":"boolean"},"pipelineLifecycleStage":{"type":"boolean"},"offsetCommitTrigger":{"type":"boolean"},"variableOutputStreams":{"type":"boolean"},"outputStreams":{"type":"integer","format":"int32"},"outputStreamLabelProviderClass":{"type":"string"},"outputStreamLabels":{"type":"array","items":{"type":"string"}},"outputStreamsDrivenByConfig":{"type":"string"},"services":{"type":"array","items":{"$ref":"#/definitions/ServiceDependencyDefinitionJson"}},"hideStage":{"type":"array","items":{"type":"string"}},"executionModes":{"type":"array","items":{"type":"string","enum":["STANDALONE","CLUSTER_BATCH","CLUSTER_YARN_STREAMING","CLUSTER_MESOS_STREAMING","SECONDARY","EDGE","EMR_BATCH","BATCH","STREAMING","SNOWPARK"]}},"description":{"type":"string"},"privateClassLoader":{"type":"boolean"},"library":{"type":"string"},"configDefinitions":{"type":"array","items":{"$ref":"#/definitions/ConfigDefinitionJson"}},"version":{"type":"string"},"icon":{"type":"string"},"onRecordError":{"type":"boolean"},"preconditions":{"type":"boolean"},"resetOffset":{"type":"boolean"},"producingEvents":{"type":"boolean"},"onlineHelpRefUrl":{"type":"string"},"sendsResponse":{"type":"boolean"},"beta":{"type":"boolean"},"inputStreams":{"type":"integer","format":"int32"},"inputStreamLabelProviderClass":{"type":"string"},"inputStreamLabels":{"type":"array","items":{"type":"string"}},"bisectable":{"type":"boolean"},"yamlUpgrader":{"type":"string"},"explorerSchema":{"$ref":"#/definitions/ExplorerSchemaJson"},"explorerDefinitions":{"type":"array","items":{"$ref":"#/definitions/ExplorerDefinitionJson"}},"compositeConfigDefinitions":{"type":"array","items":{"$ref":"#/definitions/CompositeConfigDefinitionJson"}},"dynamicLabel":{"type":"string"}}},"CommitPipelineWithConnectionsMetadataJson":{"type":"object","properties":{"name":{"type":"string"},"commitMessage":{"type":"string"},"pipelineDefinition":{"type":"string"},"libraryDefinitions":{"type":"string"},"rulesDefinition":{"type":"string"},"fragment":{"type":"boolean"},"sdcId":{"type":"string"},"failIfExists":{"type":"boolean"},"executorType":{"type":"string","enum":["COLLECTOR","TRANSFORMER","EDGE","SNOWPARK"]},"connectionsMetadata":{"type":"object","additionalProperties":{"$ref":"#/definitions/ExportedConnectionMetadata"}}}},"ExportedConnectionMetadata":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"PipelineFragmentEnvelopeJson":{"type":"object","properties":{"pipelineFragmentConfig":{"$ref":"#/definitions/PipelineFragmentConfigurationJson"},"pipelineRules":{"$ref":"#/definitions/RuleDefinitionsJson"},"libraryDefinitions":{"$ref":"#/definitions/DefinitionsJson"}}},"AclJson":{"type":"object","properties":{"resourceId":{"type":"string"},"organization":{"type":"string"},"resourceOwner":{"type":"string"},"resourceCreatedTime":{"type":"integer","format":"int64"},"resourceType":{"type":"string","enum":["JOB","LOCAL_PIPELINE","PIPELINE","SDC","TOPOLOGY","SLA","ALERT","DEPLOYMENT","DPM_AGENT","SCHEDULER_JOB","EVENT_SUBSCRIPTION","REPORT_DEFINITION","CONNECTION","CSP_ENVIRONMENT","CSP_DEPLOYMENT","STAGE_DESTINATION","MIGRATION","JOB_SEQUENCE"]},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"permissions":{"type":"array","items":{"$ref":"#/definitions/PermissionJson"}}}},"PermissionJson":{"type":"object","properties":{"resourceId":{"type":"string"},"subjectId":{"type":"string"},"subjectType":{"type":"string","enum":["USER","GROUP"]},"lastModifiedBy":{"type":"string"},"lastModifiedOn":{"type":"integer","format":"int64"},"actions":{"type":"array","items":{"type":"string","enum":["READ","WRITE","EXECUTE"]}}}},"DetachedStageConfigurationJson":{"type":"object","properties":{"schemaVersion":{"type":"integer","format":"int32"},"stageConfiguration":{"$ref":"#/definitions/StageConfigurationJson"},"issues":{"$ref":"#/definitions/IssuesJson"}}},"CommitPipelineJson":{"type":"object","properties":{"name":{"type":"string"},"commitMessage":{"type":"string"},"pipelineDefinition":{"type":"string"},"libraryDefinitions":{"type":"string"},"rulesDefinition":{"type":"string"},"fragment":{"type":"boolean"},"sdcId":{"type":"string"},"failIfExists":{"type":"boolean"},"executorType":{"type":"string","enum":["COLLECTOR","TRANSFORMER","EDGE","SNOWPARK"]}}},"ConnectionNameTypeJson":{"type":"object","properties":{"id":{"type":"string"},"connectionType":{"type":"string"},"name":{"type":"string"},"typeLabel":{"type":"string"},"missing":{"type":"boolean"}}},"ConnectionUsageJson":{"type":"object","properties":{"stageTypes":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["SOURCE","PROCESSOR","TARGET","EXECUTOR","PIPELINE"]}},"pipelineName":{"type":"string"}}},"ImportConnectionJson":{"type":"object","properties":{"original":{"$ref":"#/definitions/ConnectionNameTypeJson"},"action":{"type":"string","enum":["REMOVE_CONNECTION","CREATE_PLACEHOLDER","REPLACE_CONNECTION"]},"replacement":{"$ref":"#/definitions/ConnectionNameTypeJson"},"usages":{"type":"object","additionalProperties":{"$ref":"#/definitions/ConnectionUsageJson"}}}},"ImportPipelineJson":{"type":"object","properties":{"commitPipelineJsons":{"type":"array","readOnly":true,"items":{"$ref":"#/definitions/CommitPipelineJson"}},"importConnectionJsons":{"type":"array","readOnly":true,"items":{"$ref":"#/definitions/ImportConnectionJson"}},"availableConnections":{"type":"array","readOnly":true,"items":{"$ref":"#/definitions/ConnectionNameTypeJson"}}}},"AclAuditJson":{"type":"object","properties":{"subjectId":{"type":"string"},"resourceId":{"type":"string"},"resourceType":{"type":"string"},"action":{"type":"string"},"fieldType":{"type":"string"},"oldValue":{"type":"string"},"newValue":{"type":"string"},"requesterId":{"type":"string"},"orgId":{"type":"string"},"time":{"type":"integer","format":"int64"},"ipAddress":{"type":"string"}}},"SnowparkPipelineDefaultsJson":{"type":"object","properties":{"accountUrl":{"type":"string"},"warehouse":{"type":"string"},"database":{"type":"string"},"schema":{"type":"string"},"role":{"type":"string"}}},"SnowflakeUserCredentialJson":{"type":"object","properties":{"username":{"type":"string"},"snowflakeLoginType":{"type":"string","enum":["PASSWORD","PRIVATE_KEY"]},"password":{"type":"string"},"privateKey":{"type":"string"},"role":{"type":"string"}}},"SnowparkUserCredentialWithURLJson":{"type":"object","properties":{"username":{"type":"string"},"snowflakeLoginType":{"type":"string","enum":["PASSWORD","PRIVATE_KEY"]},"password":{"type":"string"},"privateKey":{"type":"string"},"role":{"type":"string"},"mode":{"type":"string"},"accountUrl":{"type":"string"}}}}}

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bracta/streamsets-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server