Performs an Output Module query and exports the results immediately in CSV format.\
\Please note that the TableViewConfig’s syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
\For long-running queries consider using the async equivalent.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/outputModule/export/csv":{"post":{"tags":["Output Module"],"summary":"Exports results in CSV format, returns the results immediately.","description":"Performs an Output Module query and exports the results immediately in CSV format.
Please note that the TableViewConfig’s syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
For long-running queries consider using the async equivalent.
","operationId":"exportCSV","parameters":[{"name":"validationEnabled","in":"query","description":"Determines if the TableViewConfig’s syntax should be validated (true) or not (false). Default value is false for backward compatibility reasons but it is strongly advised to always enable this validation.","schema":{"type":"boolean","default":false}},{"name":"separator","in":"query","description":"The delimiter character used to separate entries. Default value is ';'.","schema":{"type":"string"}},{"name":"quote","in":"query","description":"The delimiter character used for quoted entries. Default value is '\"'.","schema":{"type":"string"}},{"name":"escape","in":"query","description":"The delimiter character used to escape separator or quote character. Default value is '\\\\'.","schema":{"type":"string"}},{"name":"headerRow","in":"query","description":"Whether a response should include a header (true) or not (false). Default value is true.","schema":{"type":"boolean","default":true}}],"requestBody":{"description":"The JSON representation of TableViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The string response in CSV format.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"The parameter is invalid JSON TableViewConfig.","content":{"application/json":{}}},"408":{"description":"Query execution time exceeded.","content":{"application/json":{}}}}}}}}
```
## Exports results in CSV format, returns JSON representation of the async Job.
> \Starts a job that performs an Output Module query and stores the results in a file in CSV format. Id of the file can be retrieved from the \message.id\ property of the job once the job is finished.\
Please note that the TableViewConfig’s syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Job":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"type":{"type":"string","description":"The type of the job."},"userId":{"type":"string","description":"The ID of the user that initiated this job.","format":"uuid"},"visibility":{"type":"integer","description":"The visibility of the job.","format":"int32"},"progressPercentage":{"type":"number","description":"The progress percentage of the job.","format":"double"},"cancelable":{"type":"boolean","description":"Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted."},"startDate":{"type":"integer","description":"The start date of the job.","format":"int64"},"endDate":{"type":"integer","description":"The end date of the job.","format":"int64"},"state":{"type":"string","description":"The state of the job.","enum":["WAITING","RUNNING","CANCELING","COMPLETED","CANCELED","ERROR"]},"result":{"type":"string","description":"The result of the job.","enum":["NOT_SET","SUCCESS","COMPLETED_WITH_ERROR","FAILURE","ABORTED"]},"message":{"type":"string","description":"The message of the job."}},"description":"Represents a job. Job is a single atomic task that is to be performed asynchronously"}}},"paths":{"/outputModule/export/csv-job":{"post":{"tags":["Output Module"],"summary":"Exports results in CSV format, returns JSON representation of the async Job.","description":"Starts a job that performs an Output Module query and stores the results in a file in CSV format. Id of the file can be retrieved from the message.id property of the job once the job is finished.
Please note that the TableViewConfig’s syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
","operationId":"exportCSVInJob","parameters":[{"name":"validationEnabled","in":"query","description":"Determines if the TableViewConfig’s syntax should be validated (true) or not (false). Validation is then performed immediately instead of only when the job is started. Please note that the validation will always take place during the Job execution, regardless of this parameter. Default value is false.","schema":{"type":"boolean","default":false}},{"name":"fileName","in":"query","description":"The name of the file. By default the file name will be generated","schema":{"type":"string"}},{"name":"separator","in":"query","description":"The delimiter character used to separate entries. Default value is ';'.","schema":{"type":"string"}},{"name":"quote","in":"query","description":"The delimiter character used for quoted entries. Default value is '\"'.","schema":{"type":"string"}},{"name":"escape","in":"query","description":"The delimiter character used to escape separator or quote character. Default value is '\\\\'.","schema":{"type":"string"}},{"name":"headerRow","in":"query","description":"Whether a response should include a header (true) or not (false). Default value is true.","schema":{"type":"boolean","default":true}},{"name":"sendNotification","in":"query","description":"Whether an e-mail must be sent on completion of the job.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The JSON representation of TableViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The JSON representation of the job that performs an Output Module query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}}}}}}}
```
## Exports results in CSV format, returns information about created file.
> \Performs an Output Module query and stores the query results in a file in CSV format. The id of the file is returned in the response.\
\Please note that the TableViewConfig’s syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
\For long-running queries consider using the async equivalent.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FileInfoImpl":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the file.","format":"uuid"},"name":{"type":"string","description":"The name of the file."},"contentType":{"type":"string","description":"The MIME type of the file content."},"size":{"type":"integer","description":"The size of the file.","format":"int64"},"extension":{"type":"string","description":"The extension of the file."}}}}},"paths":{"/outputModule/export/csv-file":{"post":{"tags":["Output Module"],"summary":"Exports results in CSV format, returns information about created file.","description":"Performs an Output Module query and stores the query results in a file in CSV format. The id of the file is returned in the response.
Please note that the TableViewConfig’s syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
For long-running queries consider using the async equivalent.
","operationId":"exportCSVToFile","parameters":[{"name":"validationEnabled","in":"query","description":"Determines if the TableViewConfig’s syntax should be validated (true) or not (false). Default value is false for backward compatibility reasons but it is strongly advised to always enable this validation.","schema":{"type":"boolean","default":false}},{"name":"fileName","in":"query","description":"The name of the file. By default the file name will be generated","schema":{"type":"string"}},{"name":"separator","in":"query","description":"The delimiter character used to separate entries. Default value is ';'","schema":{"type":"string"}},{"name":"quote","in":"query","description":"The delimiter character used for quoted entries. Default value is '\"'","schema":{"type":"string"}},{"name":"escape","in":"query","description":"The delimiter character used to escape separator or quote character. Default value is '\\\\'","schema":{"type":"string"}},{"name":"headerRow","in":"query","description":"Whether a response should include a header (true) or not (false). Default value is true","schema":{"type":"boolean","default":true}}],"requestBody":{"description":"The JSON representation of TableViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The information about the file where the results are stored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfoImpl"}}}},"400":{"description":"The parameter is invalid JSON TableViewConfig.","content":{"application/json":{}}},"408":{"description":"Query execution time exceeded.","content":{"application/json":{}}}}}}}}
```
## Exports results in Excel format, returns JSON representation of the async Job.
> \Starts a job that performs an Output Module query and stores the results in a file in Excel format. Id of the file can be retrieved from the \message.id\ property of the job once the job is finished.\
validationEnabled\\\DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Job":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"type":{"type":"string","description":"The type of the job."},"userId":{"type":"string","description":"The ID of the user that initiated this job.","format":"uuid"},"visibility":{"type":"integer","description":"The visibility of the job.","format":"int32"},"progressPercentage":{"type":"number","description":"The progress percentage of the job.","format":"double"},"cancelable":{"type":"boolean","description":"Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted."},"startDate":{"type":"integer","description":"The start date of the job.","format":"int64"},"endDate":{"type":"integer","description":"The end date of the job.","format":"int64"},"state":{"type":"string","description":"The state of the job.","enum":["WAITING","RUNNING","CANCELING","COMPLETED","CANCELED","ERROR"]},"result":{"type":"string","description":"The result of the job.","enum":["NOT_SET","SUCCESS","COMPLETED_WITH_ERROR","FAILURE","ABORTED"]},"message":{"type":"string","description":"The message of the job."}},"description":"Represents a job. Job is a single atomic task that is to be performed asynchronously"}}},"paths":{"/outputModule/export/excel-job":{"post":{"tags":["Output Module"],"summary":"Exports results in Excel format, returns JSON representation of the async Job.","description":"Starts a job that performs an Output Module query and stores the results in a file in Excel format. Id of the file can be retrieved from the message.id property of the job once the job is finished.
validationEnabledDGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
","operationId":"exportExcelInJob","parameters":[{"name":"sendNotification","in":"query","description":"Whether an e-mail must be sent on completion of the job.","schema":{"type":"boolean","default":false}},{"name":"validationEnabled","in":"query","description":"Determines if the TableViewConfig’s syntax should be validated (true) or not (false). Validation is then performed immediately instead of only when the job is started. Please note that the validation will always take place during the Job execution, regardless of this parameter. Default value is false.","schema":{"type":"boolean","default":false}},{"name":"fileName","in":"query","description":"The name of the file. By default the file name will be generated.","schema":{"type":"string"}},{"name":"sheetName","in":"query","description":"The name of the sheet. By default no sheet name is set.","schema":{"type":"string"}},{"name":"useXLSX","in":"query","description":"Whether the Excel file to export will be '.xlsx' file (true) or a '.xls' file (false. Default value is true.true) or not (false). Default value is true.","schema":{"type":"boolean","default":true}},{"name":"truncateLongValues","in":"query","description":"Whether cell values exceeding Excel limit should be truncated. Default value is false.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The JSON/YAML representation of TableViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The JSON representation of the job that performs an Output Module query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}}}}}}}
```
## Exports results in Excel format, returns information about created file.
> \Performs an Output Module query and stores the query results in a file in Excel format. The id of the file is returned in the response.\
\Please note that the TableViewConfig’s syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
\For long-running queries consider using the async equivalent.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FileInfoImpl":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the file.","format":"uuid"},"name":{"type":"string","description":"The name of the file."},"contentType":{"type":"string","description":"The MIME type of the file content."},"size":{"type":"integer","description":"The size of the file.","format":"int64"},"extension":{"type":"string","description":"The extension of the file."}}}}},"paths":{"/outputModule/export/excel-file":{"post":{"tags":["Output Module"],"summary":"Exports results in Excel format, returns information about created file.","description":"Performs an Output Module query and stores the query results in a file in Excel format. The id of the file is returned in the response.
Please note that the TableViewConfig’s syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
For long-running queries consider using the async equivalent.
","operationId":"exportExcelToFile","parameters":[{"name":"validationEnabled","in":"query","description":"Determines if the TableViewConfig’s syntax should be validated (true) or not (false). Default value is false for backward compatibility reasons but it is strongly advised to always enable this validation.","schema":{"type":"boolean","default":false}},{"name":"fileName","in":"query","description":"The name of the file. By default the file name will be generated.","schema":{"type":"string"}},{"name":"sheetName","in":"query","description":"The name of the sheet. By default no sheet name is set.","schema":{"type":"string"}},{"name":"useXLSX","in":"query","description":"Whether the Excel file to export will be '.xlsx' file (true) or a '.xls' file (false. Default value is true.true) or not (false). Default value is true.","schema":{"type":"boolean","default":true}},{"name":"truncateLongValues","in":"query","description":"Whether cell values exceeding Excel limit should be truncated. Default value is false.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The JSON/YAML representation of TableViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The information about the file where the results are stored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfoImpl"}}}},"400":{"description":"The parameter is invalid JSON TableViewConfig.","content":{"application/json":{}}},"408":{"description":"Query execution time exceeded.","content":{"application/json":{}}}}}}}}
```
## Exports results in JSON format, returns the results immediately.
> \Performs an Output Module query and exports the returns results immediately in JSON format.\
\Please note that the ViewConfig/TableViewConfig’s syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
\For long-running queries consider using the async equivalent.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/outputModule/export/json":{"post":{"tags":["Output Module"],"summary":"Exports results in JSON format, returns the results immediately.","description":"Performs an Output Module query and exports the returns results immediately in JSON format.
Please note that the ViewConfig/TableViewConfig’s syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
For long-running queries consider using the async equivalent.
","operationId":"exportJSON","parameters":[{"name":"validationEnabled","in":"query","description":"Determines if the ViewConfig’s syntax should be validated (true) or not (false). Default value is false for backward compatibility reasons but it is strongly advised to always enable this validation.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The JSON/YAML representation of ViewConfig/TableViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The string response in JSON format.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"The parameter is invalid JSON ViewConfig/TableViewConfig.","content":{"application/json":{}}},"408":{"description":"Query execution time exceeded.","content":{"application/json":{}}}}}}}}
```
## Exports results in JSON format, returns JSON representation of the async Job.
> \Starts a job that performs an Output Module query and stores the results in a file in JSON format. Id of the file can be retrieved from the \message.id\ property of the job once the job is finished.\
Please note that the ViewConfig/TableViewConfig’s syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Job":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"type":{"type":"string","description":"The type of the job."},"userId":{"type":"string","description":"The ID of the user that initiated this job.","format":"uuid"},"visibility":{"type":"integer","description":"The visibility of the job.","format":"int32"},"progressPercentage":{"type":"number","description":"The progress percentage of the job.","format":"double"},"cancelable":{"type":"boolean","description":"Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted."},"startDate":{"type":"integer","description":"The start date of the job.","format":"int64"},"endDate":{"type":"integer","description":"The end date of the job.","format":"int64"},"state":{"type":"string","description":"The state of the job.","enum":["WAITING","RUNNING","CANCELING","COMPLETED","CANCELED","ERROR"]},"result":{"type":"string","description":"The result of the job.","enum":["NOT_SET","SUCCESS","COMPLETED_WITH_ERROR","FAILURE","ABORTED"]},"message":{"type":"string","description":"The message of the job."}},"description":"Represents a job. Job is a single atomic task that is to be performed asynchronously"}}},"paths":{"/outputModule/export/json-job":{"post":{"tags":["Output Module"],"summary":"Exports results in JSON format, returns JSON representation of the async Job.","description":"Starts a job that performs an Output Module query and stores the results in a file in JSON format. Id of the file can be retrieved from the message.id property of the job once the job is finished.
Please note that the ViewConfig/TableViewConfig’s syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
","operationId":"exportJSONInJob","parameters":[{"name":"sendNotification","in":"query","description":"Whether an e-mail must be sent on completion of the job.","schema":{"type":"boolean","default":false}},{"name":"validationEnabled","in":"query","description":"Determines if the ViewConfig’s syntax should be validated (true) or not (false). Validation is then performed immediately instead of only when the job is started. Please note that the validation will always take place during the Job execution, regardless of this parameter. Default value is false.","schema":{"type":"boolean","default":false}},{"name":"fileName","in":"query","description":"The name of the file. By default the file name will be generated.","schema":{"type":"string"}}],"requestBody":{"description":"The JSON/YAML representation of ViewConfig/TableViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The JSON representation of the job that performs an Output Module query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"400":{"description":"The parameter is invalid JSON ViewConfig/TableViewConfig.","content":{"application/json":{}}}}}}}}
```
## Exports results in JSON format, returns information about created file.
> \Performs an Output Module query and stores the query results in a file in JSON format. The id of the file is returned in the response.\
\Please note that the ViewConfig/TableViewConfig’s syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
\For long-running queries consider using the async equivalent.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FileInfoImpl":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the file.","format":"uuid"},"name":{"type":"string","description":"The name of the file."},"contentType":{"type":"string","description":"The MIME type of the file content."},"size":{"type":"integer","description":"The size of the file.","format":"int64"},"extension":{"type":"string","description":"The extension of the file."}}}}},"paths":{"/outputModule/export/json-file":{"post":{"tags":["Output Module"],"summary":"Exports results in JSON format, returns information about created file.","description":"Performs an Output Module query and stores the query results in a file in JSON format. The id of the file is returned in the response.
Please note that the ViewConfig/TableViewConfig’s syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
For long-running queries consider using the async equivalent.
","operationId":"exportJSONToFile","parameters":[{"name":"validationEnabled","in":"query","description":"Determines if the ViewConfig’s syntax should be validated (true) or not (false). Default value is false for backward compatibility reasons but it is strongly advised to always enable this validation.","schema":{"type":"boolean","default":false}},{"name":"fileName","in":"query","description":"The name of the file. By default the file name will be generated.","schema":{"type":"string"}}],"requestBody":{"description":"The JSON/YAML representation of ViewConfig/TableViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The information about the file where the results are stored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfoImpl"}}}},"400":{"description":"The parameter is invalid JSON ViewConfig/TableViewConfig.","content":{"application/json":{}}},"408":{"description":"Query execution time exceeded.","content":{"application/json":{}}}}}}}}
```
## Exports results in XML format, returns the results immediately.
> \Performs an Output Module query and exports the returns results immediately in XML format.\
\Please note that the ViewConfig’s syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results).For details please consult output module documentation.\
\For long-running queries consider using the async equivalent.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/outputModule/export/xml":{"post":{"tags":["Output Module"],"summary":"Exports results in XML format, returns the results immediately.","description":"Performs an Output Module query and exports the returns results immediately in XML format.
Please note that the ViewConfig’s syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results).For details please consult output module documentation.
For long-running queries consider using the async equivalent.
","operationId":"exportXML","parameters":[{"name":"validationEnabled","in":"query","description":"Determines if the ViewConfig’s syntax should be validated (true) or not (false). Default value is false for backward compatibility reasons but it is strongly advised to always enable this validation.","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The JSON/YAML representation of ViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The string response in XML format.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"The parameter is invalid JSON ViewConfig.","content":{"application/json":{}}},"408":{"description":"Query execution time exceeded.","content":{"application/json":{}}}}}}}}
```
## Exports results in XML format, returns JSON representation of the async Job.
> \Starts a job that performs an Output Module query and stores the results in a file in XML format. Id of the file can be retrieved from the \message.id\ property of the job once the job is finished.\
Please note that the ViewConfig's syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Job":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"type":{"type":"string","description":"The type of the job."},"userId":{"type":"string","description":"The ID of the user that initiated this job.","format":"uuid"},"visibility":{"type":"integer","description":"The visibility of the job.","format":"int32"},"progressPercentage":{"type":"number","description":"The progress percentage of the job.","format":"double"},"cancelable":{"type":"boolean","description":"Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted."},"startDate":{"type":"integer","description":"The start date of the job.","format":"int64"},"endDate":{"type":"integer","description":"The end date of the job.","format":"int64"},"state":{"type":"string","description":"The state of the job.","enum":["WAITING","RUNNING","CANCELING","COMPLETED","CANCELED","ERROR"]},"result":{"type":"string","description":"The result of the job.","enum":["NOT_SET","SUCCESS","COMPLETED_WITH_ERROR","FAILURE","ABORTED"]},"message":{"type":"string","description":"The message of the job."}},"description":"Represents a job. Job is a single atomic task that is to be performed asynchronously"}}},"paths":{"/outputModule/export/xml-job":{"post":{"tags":["Output Module"],"summary":"Exports results in XML format, returns JSON representation of the async Job.","description":"Starts a job that performs an Output Module query and stores the results in a file in XML format. Id of the file can be retrieved from the message.id property of the job once the job is finished.
Please note that the ViewConfig's syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
","operationId":"exportXMLInJob","parameters":[{"name":"validationEnabled","in":"query","description":"Determines if the ViewConfig’s syntax should be validated (true) or not (false). Validation is then performed immediately instead of only when the job is started. Please note that the validation will always take place during the Job execution, regardless of this parameter. Default value is false.","schema":{"type":"boolean","default":false}},{"name":"fileName","in":"query","description":"The name of the file. By default the file name will be generated.","schema":{"type":"string"}}],"requestBody":{"description":"The JSON/YAML representation of ViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The JSON representation of the job that performs an Output Module query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}}}}}}}
```
## Exports results in XML format, returns information about created file.
> \Performs an Output Module query and stores the query results in a file in XML format. The id of the file is returned in the response.\
\Please note that the ViewConfig's syntax validation is not executed by default, see \validationEnabled\\
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.\
\For long-running queries consider using the async equivalent.\
```json {"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FileInfoImpl":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the file.","format":"uuid"},"name":{"type":"string","description":"The name of the file."},"contentType":{"type":"string","description":"The MIME type of the file content."},"size":{"type":"integer","description":"The size of the file.","format":"int64"},"extension":{"type":"string","description":"The extension of the file."}}}}},"paths":{"/outputModule/export/xml-file":{"post":{"tags":["Output Module"],"summary":"Exports results in XML format, returns information about created file.","description":"Performs an Output Module query and stores the query results in a file in XML format. The id of the file is returned in the response.
Please note that the ViewConfig's syntax validation is not executed by default, see validationEnabled
DGC admin console settings may impact the execution of the query (especially in terms of timeout and a limit on the number of results). For details please consult output module documentation.
For long-running queries consider using the async equivalent.
","operationId":"exportXMLToFile","parameters":[{"name":"validationEnabled","in":"query","description":"Determines if the ViewConfig’s syntax should be validated (true) or not (false). Default value is false for backward compatibility reasons but it is strongly advised to always enable this validation.","schema":{"type":"boolean","default":false}},{"name":"fileName","in":"query","description":"The name of the file. By default the file name will be generated.","schema":{"type":"string"}}],"requestBody":{"description":"The JSON/YAML representation of ViewConfig that describes the query to be performed.","content":{"application/json":{"schema":{"type":"string"}},"application/x-yaml":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"The information about the file where the results are stored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfoImpl"}}}},"400":{"description":"The parameter is invalid JSON ViewConfig.","content":{"application/json":{}}},"408":{"description":"Query execution time exceeded.","content":{"application/json":{}}}}}}}}
```
## Returns TableViewConfig based on id of given View and its Location.
> \EXPERIMENTAL\ Returns Table View Config based on id of given View and its Location. This Table View Config can be used by Output Module to export data as visible in Collibra Data Governance Center User Interface.\This endpoint does not guarantee a one-to-one relation between what is visible in the User Interface and what will be exported by using the provided Table View Config. Due to the possibility of adding additional filters through User Interface the result can contain more rows then are visible in the User Interface. In such case the Table View Config produced by this endpoint should be manually adjusted. \
\Because obtaining the correct results needs a human intervention, this endpoint should not be used in any kind of automatic processing.\\
Example: given page under url This endpoint does not guarantee a one-to-one relation between what is visible in the User Interface and what will be exported by using the provided Table View Config. Due to the possibility of adding additional filters through User Interface the result can contain more rows then are visible in the User Interface. In such case the Table View Config produced by this endpoint should be manually adjusted. Because obtaining the correct results needs a human intervention, this endpoint should not be used in any kind of automatic processing. Example: given page under url https://dgc.collibra.com/glossary?view=133f7f30-033c-4e38-acc2-2c1ac599d19e the view id\ is \133f7f30-033c-4e38-acc2-2c1ac599d19e\.
```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/outputModule/tableViewConfigs/viewId/{viewId}":{"get":{"tags":["Output Module"],"summary":"Returns TableViewConfig based on id of given View and its Location.","description":"EXPERIMENTAL Returns Table View Config based on id of given View and its Location. This Table View Config can be used by Output Module to export data as visible in Collibra Data Governance Center User Interface.id is 133f7f30-033c-4e38-acc2-2c1ac599d19e.","operationId":"getTableViewConfigByViewId","parameters":[{"name":"viewLocation","in":"query","description":"The Location for which the view shall be generated.Views in Collibra Data Governance Center are available under specific locations.Each location is associated with set of filters that are automatically applied to given view.Setting appropriate View Location will produce Table View Config that describes the data seen under desired location and given View in the best way possible.If this field is not provided then the returned Table View Config is going to have additional filters applied based on viewLocation extracted from database.`\n\n
","schema":{"type":"string","enum":["GLOBAL_VIEW","DOMAIN_DOMAIN_ASSETS","COMMUNITY_COMMUNITY_ASSETS","BUSINESS_GLOSSARY_BUSINESS_ASSETS","BUSINESS_GLOSSARY_GLOSSARIES","REFERENCE_DATA_CODEVALUES_AND_SETS","REFERENCE_DATA_HIERARCHIES","CATALOG_DATA_SETS","CATALOG_DATA_SOURCES","CATALOG_DATA_DICTIONARY","CATALOG_TECHNOLOGY_ASSETS","CATALOG_REPORTS","DATA_HELPDESK_ISSUES","DATA_HELPDESK_DATA_QUALITY","STEWARDSHIP_BUSINESS_DIMENSIONS","POLICY_MANAGER_GOVERNANCE_ASSETS"]}},{"name":"viewId","in":"path","description":"The viewLocation value Corresponding view in Collibra Data Governance Center User Interface BUSINESS_GLOSSARY_BUSINESS_ASSETS Business Glossary Subpages: Business Assets (/glossary)Glossaries (/glossary/glossaries) REFERENCE_DATA_CODEVALUES_AND_SETS Reference Data > Code Values/Sets (/reference-data) CATALOG_DATA_SETS Catalog > Data Sets (/catalog/data-sets) CATALOG_DATA_DICTIONARY Catalog > Data Dictionary (/catalog/data-dictionary) CATALOG_TECHNOLOGY_ASSETS Catalog > Technology Assets (/catalog/technology-assets) DATA_HELPDESK_ISSUES Data Helpdesk Subpages: Issues(/data-helpdesk)>Data Quality (/data-helpdesk/data-quality) STEWARDSHIP_BUSINESS_DIMENSIONS Stewardship > Business Dimensions (/stewardship/business-dimensions) POLICY_MANAGER_GOVERNANCE_ASSETS Policy Manager > Governance Assets (/policy-manager) id of given View. Can be obtained from Collibra Data Governance Center User Interface","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"View config generated.","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"View not found."}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://developer.collibra.com/api/references/data-governance/output-module.md?ask=