> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/rest-api/data-source-apis-metadata-resource.md). # Data Source APIs Metadata Resource This service allows for listing, download, and removal of Metadata data sources in the BA Platform. ## Get Metadata datasource IDs > Get the Metadata datasource IDs.\ > \ > \*\*Example Request:\*\*\ > \`\`\`\ > GET pentaho/plugin/data-access/api/datasource/metadata/domain\ > \`\`\`\ > \ > \*\*cURL Example:\*\*\ > \`\`\`bash\ > curl -X GET \\\ > "" \\\ > -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \\\ > -H "Accept: application/json"\ > \`\`\`
````json {"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Data Source APIs - Metadata Resource","description":"This service allows for listing, download, and removal of Metadata data sources in the BA Platform."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}}},"paths":{"/data-access/api/datasource/metadata/domain":{"get":{"tags":["Data Source APIs - Metadata Resource"],"summary":"Get Metadata datasource IDs","description":"Get the Metadata datasource IDs.\n\n**Example Request:**\n```\nGET pentaho/plugin/data-access/api/datasource/metadata/domain\n```\n\n**cURL Example:**\n```bash\ncurl -X GET \\\n \"http://localhost:8080/pentaho/plugin/data-access/api/datasource/metadata/domain\" \\\n -H \"Authorization: Basic YWRtaW46cGFzc3dvcmQ=\" \\\n -H \"Accept: application/json\"\n```\n","responses":{"200":{"description":"Successfully retrieved the list of existing metadata IDs","content":{"application/xml":{"schema":{"type":"object","description":"List of metadata IDs in XML format"}},"application/json":{"schema":{"type":"object","description":"List of metadata IDs in JSON format"}}}}}}}}} ```` ## Export a metadata datasource > Export a metadata datasource.\ > \ > \*\*Example Request:\*\*\ > \`\`\`\ > GET pentaho/plugin/data-access/api/datasource/metadata/domain/SampleData2\ > \`\`\`\ > \ > \*\*cURL Example:\*\*\ > \`\`\`bash\ > curl -X GET \\\ > "" \\\ > -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \\\ > -H "Accept: application/octet-stream"\ > \`\`\`
````json {"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Data Source APIs - Metadata Resource","description":"This service allows for listing, download, and removal of Metadata data sources in the BA Platform."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}}},"paths":{"/data-access/api/datasource/metadata/domain/{domainId}":{"get":{"tags":["Data Source APIs - Metadata Resource"],"summary":"Export a metadata datasource","description":"Export a metadata datasource.\n\n**Example Request:**\n```\nGET pentaho/plugin/data-access/api/datasource/metadata/domain/SampleData2\n```\n\n**cURL Example:**\n```bash\ncurl -X GET \\\n \"http://localhost:8080/pentaho/plugin/data-access/api/datasource/metadata/domain/SampleData2\" \\\n -H \"Authorization: Basic YWRtaW46cGFzc3dvcmQ=\" \\\n -H \"Accept: application/octet-stream\"\n```\n","parameters":[{"name":"domainId","in":"path","required":true,"description":"The ID of the Metadata datasource to export","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata datasource export succeeded","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","description":"The metadata XMI file"}}}},"401":{"description":"User is not authorized to export the Metadata datasource","content":{"text/plain":{"schema":{"type":"string","description":"Unauthorized access error"}}}},"500":{"description":"Failure to export Metadata datasource","content":{"text/plain":{"schema":{"type":"string","description":"Internal server error"}}}}}}}}} ```` ## Import a Metadata datasource > Import a Metadata datasource.\ > \ > \*\*Example Request:\*\*\ > \`\`\`\ > PUT pentaho/plugin/data-access/api/datasource/metadata/domain/SampleData\ > \`\`\`\ > \ > \*\*cURL Example:\*\*\ > \`\`\`bash\ > curl -X PUT \\\ > "" \\\ > -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \\\ > -H "Content-Type: multipart/form-data" \\\ > -F "metadataFile=@SampleData2.xmi;type=text/xml" \\\ > -F "domainId=SampleData2" \\\ > -F "overwrite=true"\ > \`\`\`
````json {"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Data Source APIs - Metadata Resource","description":"This service allows for listing, download, and removal of Metadata data sources in the BA Platform."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}}},"paths":{"/data-access/api/datasource/metadata/domain/{domainId}":{"put":{"tags":["Data Source APIs - Metadata Resource"],"summary":"Import a Metadata datasource","description":"Import a Metadata datasource.\n\n**Example Request:**\n```\nPUT pentaho/plugin/data-access/api/datasource/metadata/domain/SampleData\n```\n\n**cURL Example:**\n```bash\ncurl -X PUT \\\n \"http://localhost:8080/pentaho/plugin/data-access/api/datasource/metadata/domain/SampleData\" \\\n -H \"Authorization: Basic YWRtaW46cGFzc3dvcmQ=\" \\\n -H \"Content-Type: multipart/form-data\" \\\n -F \"metadataFile=@SampleData2.xmi;type=text/xml\" \\\n -F \"domainId=SampleData2\" \\\n -F \"overwrite=true\"\n```\n","parameters":[{"name":"domainId","in":"path","required":true,"description":"Unique identifier for the metadata datasource","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Multipart form data containing the metadata file to upload","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"domainId":{"type":"string","description":"Domain identifier for the metadata datasource","required":false},"metadataFile":{"type":"string","format":"binary","description":"Input stream for the metadata.xmi file"},"metadataFileInfo":{"type":"string","description":"User selected name for the file (FormDataContentDisposition)","required":false},"localeFiles":{"type":"array","items":{"type":"string","format":"binary"},"description":"List of locale files","required":false},"localeFilesInfo":{"type":"array","items":{"type":"string"},"description":"List of FormDataContentDisposition for locale files","required":false},"overwrite":{"type":"boolean","description":"Flag for overwriting existing version of the file","default":false},"acl":{"type":"string","description":"Access control list data","required":false}}}}}},"responses":{"201":{"description":"Indicates successful import","content":{"text/plain":{"schema":{"type":"string","description":"Success message"}}}},"401":{"description":"Import failed because publish is prohibited","content":{"text/plain":{"schema":{"type":"string","description":"Unauthorized access error"}}}},"403":{"description":"Access Control Forbidden","content":{"text/plain":{"schema":{"type":"string","description":"Access Control Forbidden"}}}},"409":{"description":"Content already exists (use overwrite flag to force)","content":{"text/plain":{"schema":{"type":"string","description":"Error message"}}}},"412":{"description":"Metadata datasource import failed. Error code or message included in response entity","content":{"text/plain":{"schema":{"type":"string","description":"Metadata datasource import failed. Error code or message included in response entity"}}}},"500":{"description":"Unspecified general error has occurred","content":{"text/plain":{"schema":{"type":"string","description":"Internal server error"}}}}}}}}} ```` ## Remove metadata datasource > Remove the metadata for a given metadata ID.\ > \ > \*\*Example Request:\*\*\ > \`\`\`\ > DELETE pentaho/plugin/data-access/api/datasource/metadata/domain/SampleData2\ > \`\`\`\ > \ > \*\*cURL Example:\*\*\ > \`\`\`bash\ > curl -X DELETE \\\ > "" \\\ > -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="\ > \`\`\`
````json {"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"Data Source APIs - Metadata Resource","description":"This service allows for listing, download, and removal of Metadata data sources in the BA Platform."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}}},"paths":{"/data-access/api/datasource/metadata/domain/{domainId}":{"delete":{"tags":["Data Source APIs - Metadata Resource"],"summary":"Remove metadata datasource","description":"Remove the metadata for a given metadata ID.\n\n**Example Request:**\n```\nDELETE pentaho/plugin/data-access/api/datasource/metadata/domain/SampleData2\n```\n\n**cURL Example:**\n```bash\ncurl -X DELETE \\\n \"http://localhost:8080/pentaho/plugin/data-access/api/datasource/metadata/domain/SampleData2\" \\\n -H \"Authorization: Basic YWRtaW46cGFzc3dvcmQ=\"\n```\n","parameters":[{"name":"domainId","in":"path","required":true,"description":"The ID of the Metadata datasource to remove","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata datasource removed."},"401":{"description":"User is not authorized to delete the Metadata datasource.","content":{"text/plain":{"schema":{"type":"string","description":"Unauthorized access error"}}}}}}}}} ```` --- # 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, and the optional `goal` query parameter: ``` GET https://docs.pentaho.com/rest-api/data-source-apis-metadata-resource.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.